Package org.apache.maven.scm

Enum CommandParameters.SignOption

java.lang.Object

java.lang.Enum<CommandParameters.SignOption>

org.apache.maven.scm.CommandParameters.SignOption

All Implemented Interfaces:

Serializable, Comparable<CommandParameters.SignOption>

Enclosing class:

CommandParameters

public static enum CommandParameters.SignOption
extends Enum<CommandParameters.SignOption>

The sign option for a commit or tag.

This is only relevant for SCM providers that support signing commits/tags, such as Git.

See Also:

Git Tools - Signing Your Work

Enum Constant Summary

Enum Constants

Enum Constant	Description
DEFAULT	Just uses the default value in the Git configuration for setting commit.gpgSign or tag.gpgSign.
FORCE_NO_SIGN	Does not sign the commit/tag irrespective of the Git configuration setting commit.gpgSign or tag.gpgSign.
FORCE_SIGN	Signs the commit/tag irrespective of the Git configuration setting commit.gpgSign or tag.gpgSign.

Method Summary

Modifier and Type	Method	Description
static CommandParameters.SignOption	valueOf(String name)	Returns the enum constant of this type with the specified name.
static CommandParameters.SignOption[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

FORCE_SIGN

public static final CommandParameters.SignOption FORCE_SIGN

Signs the commit/tag irrespective of the Git configuration setting commit.gpgSign or tag.gpgSign. Only has an effect for supported SCM providers. Others may be silently ignoring this setting.

DEFAULT

public static final CommandParameters.SignOption DEFAULT

Just uses the default value in the Git configuration for setting commit.gpgSign or tag.gpgSign. Only has an effect for supported SCM providers. Others may be silently ignoring this setting.

FORCE_NO_SIGN

public static final CommandParameters.SignOption FORCE_NO_SIGN

Does not sign the commit/tag irrespective of the Git configuration setting commit.gpgSign or tag.gpgSign.

Method Detail

values

public static CommandParameters.SignOption[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (CommandParameters.SignOption c : CommandParameters.SignOption.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static CommandParameters.SignOption valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null