View Javadoc
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  
44  package org.eclipse.jgit.pgm.opt;
45  
46  import org.eclipse.jgit.pgm.internal.CLIText;
47  import org.eclipse.jgit.transport.RefSpec;
48  import org.kohsuke.args4j.CmdLineException;
49  import org.kohsuke.args4j.CmdLineParser;
50  import org.kohsuke.args4j.OptionDef;
51  import org.kohsuke.args4j.spi.OptionHandler;
52  import org.kohsuke.args4j.spi.Parameters;
53  import org.kohsuke.args4j.spi.Setter;
54  
55  /**
56   * Custom argument handler {@link org.eclipse.jgit.transport.RefSpec} from
57   * string values.
58   * <p>
59   * Assumes the parser has been initialized with a Repository.
60   */
61  public class RefSpecHandler extends OptionHandler<RefSpec> {
62  	/**
63  	 * Create a new handler for the command name.
64  	 * <p>
65  	 * This constructor is used only by args4j.
66  	 *
67  	 * @param parser
68  	 *            a {@link org.kohsuke.args4j.CmdLineParser} object.
69  	 * @param option
70  	 *            a {@link org.kohsuke.args4j.OptionDef} object.
71  	 * @param setter
72  	 *            a {@link org.kohsuke.args4j.spi.Setter} object.
73  	 */
74  	public RefSpecHandler(final CmdLineParser parser, final OptionDef option,
75  			final Setter<? super RefSpec> setter) {
76  		super(parser, option, setter);
77  	}
78  
79  	/** {@inheritDoc} */
80  	@Override
81  	public int parseArguments(Parameters params) throws CmdLineException {
82  		setter.addValue(new RefSpec(params.getParameter(0)));
83  		return 1;
84  	}
85  
86  	/** {@inheritDoc} */
87  	@Override
88  	public String getDefaultMetaVariable() {
89  		return CLIText.get().metaVar_refspec;
90  	}
91  }