Top Description Fields Constructors Methods
org.eclipse.jgit.pgm.opt

public Class GpgSignHandler

extends StringOptionHandler
Class Inheritance
Imports
org.kohsuke.args4j.CmdLineException, .CmdLineParser, .OptionDef, org.kohsuke.args4j.spi.Parameters, .Setter, .StringOptionHandler

Special handler for the --gpg-sign option of the commit command. The following rules apply:
Since
5.3

Field Summary

Modifier and TypeField and Description
public static final String
DEFAULT

The value "default" which will be used when just the option is specified without any argument

Constructor Summary

AccessConstructor and Description
public
GpgSignHandler(CmdLineParser
The parser to which this handler belongs.
parser
,
OptionDef
The annotation.
option
,
Setter<? super String>
Object to be used for setting value.
setter
)

Constructor for GpgSignHandler.

Method Summary

Modifier and TypeMethod and Description
public int
parseArguments(Parameters
The rest of the arguments. This method can use this object to access the arguments of the option if necessary. The object is valid only during the method call.
params
)

Overrides org.kohsuke.args4j.spi.StringOptionHandler.parseArguments.

Called if the option that this owner recognizes is found.

Inherited from org.kohsuke.args4j.spi.StringOptionHandler:
getDefaultMetaVariable

Field Detail

DEFAULTback to summary
public static final String DEFAULT

The value "default" which will be used when just the option is specified without any argument

Constructor Detail

GpgSignHandlerback to summary
public GpgSignHandler(CmdLineParser parser, OptionDef option, Setter<? super String> setter)

Constructor for GpgSignHandler.

Parameters
parser:CmdLineParser

The parser to which this handler belongs.

option:OptionDef

The annotation.

setter:Setter<? super String>

Object to be used for setting value.

Method Detail

parseArgumentsback to summary
public int parseArguments(Parameters params) throws CmdLineException

Overrides org.kohsuke.args4j.spi.StringOptionHandler.parseArguments.

Doc from org.kohsuke.args4j.spi.OptionHandler.parseArguments.

Called if the option that this owner recognizes is found.

Parameters
params:Parameters

The rest of the arguments. This method can use this object to access the arguments of the option if necessary. The object is valid only during the method call.

Returns:int

The number of arguments consumed. (For example, returns 0 if this option doesn't take any parameters.)

Annotations
@Override