org.spearce.jgit.pgm/src/org/spearce/jgit/pgm/opt/RefSpecHandler.java

   1 /*
   2  * Copyright (C) 2008, Shawn O. Pearce <spearce@spearce.org>
   3  *
   4  * All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or
   7  * without modification, are permitted provided that the following
   8  * conditions are met:
   9  *
  10  * - Redistributions of source code must retain the above copyright
  11  *   notice, this list of conditions and the following disclaimer.
  12  *
  13  * - Redistributions in binary form must reproduce the above
  14  *   copyright notice, this list of conditions and the following
  15  *   disclaimer in the documentation and/or other materials provided
  16  *   with the distribution.
  17  *
  18  * - Neither the name of the Git Development Community nor the
  19  *   names of its contributors may be used to endorse or promote
  20  *   products derived from this software without specific prior
  21  *   written permission.
  22  *
  23  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
  24  * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
  25  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  26  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  27  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
  28  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  29  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  30  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  31  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  32  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  33  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  34  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
  35  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  36  */
  37
  38 package org.spearce.jgit.pgm.opt;
  39
  40 import org.kohsuke.args4j.CmdLineException;
  41 import org.kohsuke.args4j.CmdLineParser;
  42 import org.kohsuke.args4j.OptionDef;
  43 import org.kohsuke.args4j.spi.OptionHandler;
  44 import org.kohsuke.args4j.spi.Parameters;
  45 import org.kohsuke.args4j.spi.Setter;
  46 import org.spearce.jgit.transport.RefSpec;
  47
  48 /**
  49  * Custom argument handler {@link RefSpec} from string values.
  50  * <p>
  51  * Assumes the parser has been initialized with a Repository.
  52  */
  53 public class RefSpecHandler extends OptionHandler<RefSpec> {
  54         /**
  55          * Create a new handler for the command name.
  56          * <p>
  57          * This constructor is used only by args4j.
  58          *
  59          * @param parser
  60          * @param option
  61          * @param setter
  62          */
  63         public RefSpecHandler(final CmdLineParser parser, final OptionDef option,
  64                         final Setter<? super RefSpec> setter) {
  65                 super(parser, option, setter);
  66         }
  67
  68         @Override
  69         public int parseArguments(final Parameters params) throws CmdLineException {
  70                 setter.addValue(new RefSpec(params.getParameter(0)));
  71                 return 1;
  72         }
  73
  74         @Override
  75         public String getDefaultMetaVariable() {
  76                 return "refspec";
  77         }
  78 }