RefSpecHandler.java

  1. /*
  2.  * Copyright (C) 2008, Shawn O. Pearce <spearce@spearce.org>
  3.  * and other copyright owners as documented in the project's IP log.
  4.  *
  5.  * This program and the accompanying materials are made available
  6.  * under the terms of the Eclipse Distribution License v1.0 which
  7.  * accompanies this distribution, is reproduced below, and is
  8.  * available at http://www.eclipse.org/org/documents/edl-v10.php
  9.  *
  10.  * All rights reserved.
  11.  *
  12.  * Redistribution and use in source and binary forms, with or
  13.  * without modification, are permitted provided that the following
  14.  * conditions are met:
  15.  *
  16.  * - Redistributions of source code must retain the above copyright
  17.  *   notice, this list of conditions and the following disclaimer.
  18.  *
  19.  * - Redistributions in binary form must reproduce the above
  20.  *   copyright notice, this list of conditions and the following
  21.  *   disclaimer in the documentation and/or other materials provided
  22.  *   with the distribution.
  23.  *
  24.  * - Neither the name of the Eclipse Foundation, Inc. nor the
  25.  *   names of its contributors may be used to endorse or promote
  26.  *   products derived from this software without specific prior
  27.  *   written permission.
  28.  *
  29.  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
  30.  * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
  31.  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  32.  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  33.  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
  34.  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  35.  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  36.  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  37.  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  38.  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  39.  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  40.  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
  41.  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  42.  */

  43. package org.eclipse.jgit.pgm.opt;

  44. import org.eclipse.jgit.pgm.internal.CLIText;
  45. import org.eclipse.jgit.transport.RefSpec;
  46. import org.kohsuke.args4j.CmdLineException;
  47. import org.kohsuke.args4j.CmdLineParser;
  48. import org.kohsuke.args4j.OptionDef;
  49. import org.kohsuke.args4j.spi.OptionHandler;
  50. import org.kohsuke.args4j.spi.Parameters;
  51. import org.kohsuke.args4j.spi.Setter;

  52. /**
  53.  * Custom argument handler {@link org.eclipse.jgit.transport.RefSpec} from
  54.  * string values.
  55.  * <p>
  56.  * Assumes the parser has been initialized with a Repository.
  57.  */
  58. public class RefSpecHandler extends OptionHandler<RefSpec> {
  59.     /**
  60.      * Create a new handler for the command name.
  61.      * <p>
  62.      * This constructor is used only by args4j.
  63.      *
  64.      * @param parser
  65.      *            a {@link org.kohsuke.args4j.CmdLineParser} object.
  66.      * @param option
  67.      *            a {@link org.kohsuke.args4j.OptionDef} object.
  68.      * @param setter
  69.      *            a {@link org.kohsuke.args4j.spi.Setter} object.
  70.      */
  71.     public RefSpecHandler(final CmdLineParser parser, final OptionDef option,
  72.             final Setter<? super RefSpec> setter) {
  73.         super(parser, option, setter);
  74.     }

  75.     /** {@inheritDoc} */
  76.     @Override
  77.     public int parseArguments(Parameters params) throws CmdLineException {
  78.         setter.addValue(new RefSpec(params.getParameter(0)));
  79.         return 1;
  80.     }

  81.     /** {@inheritDoc} */
  82.     @Override
  83.     public String getDefaultMetaVariable() {
  84.         return CLIText.get().metaVar_refspec;
  85.     }
  86. }