Class CommandParameter

java.lang.Object

org.apache.maven.scm.CommandParameter

All Implemented Interfaces:

Serializable

public class CommandParameter
extends Object
implements Serializable

Author:

Trygve Laugstøl

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final CommandParameter	BINARY
static final CommandParameter	BRANCH
static final CommandParameter	BRANCH_NAME
static final CommandParameter	CHANGELOG_DATE_PATTERN
static final CommandParameter	END_DATE
static final CommandParameter	END_SCM_VERSION
static final CommandParameter	FILE
static final CommandParameter	FILES
static final CommandParameter	FORCE_ADD	Parameter to force add.
static final CommandParameter	IGNORE_WHITESPACE	Contains true or false.
static final CommandParameter	LIMIT
static final CommandParameter	MESSAGE
static final CommandParameter	NUM_DAYS
static final CommandParameter	OUTPUT_DIRECTORY
static final CommandParameter	OUTPUT_FILE
static final CommandParameter	RECURSIVE
static final CommandParameter	RUN_CHANGELOG_WITH_UPDATE
static final CommandParameter	SCM_BRANCH_PARAMETERS
static final CommandParameter	SCM_MKDIR_CREATE_IN_LOCAL
static final CommandParameter	SCM_SHORT_REVISION_LENGTH	Parameter used only for Git SCM to truncate the emitted hash to the given character length, simulates git rev-parse --short=length command.
static final CommandParameter	SCM_TAG_PARAMETERS
static final CommandParameter	SCM_VERSION
static final CommandParameter	SHALLOW
static final CommandParameter	SIGN_OPTION	Parameter to indicate whether the commit/tag should be signed or not.
static final CommandParameter	START_DATE
static final CommandParameter	START_SCM_VERSION
static final CommandParameter	TAG_NAME

Method Summary

Modifier and Type	Method	Description
String	getName()
String	toString()

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

BINARY

public static final CommandParameter BINARY

RECURSIVE

public static final CommandParameter RECURSIVE

SHALLOW

public static final CommandParameter SHALLOW

MESSAGE

public static final CommandParameter MESSAGE

BRANCH_NAME

public static final CommandParameter BRANCH_NAME

START_DATE

public static final CommandParameter START_DATE

END_DATE

public static final CommandParameter END_DATE

NUM_DAYS

public static final CommandParameter NUM_DAYS

LIMIT

public static final CommandParameter LIMIT

BRANCH

public static final CommandParameter BRANCH

START_SCM_VERSION

public static final CommandParameter START_SCM_VERSION

END_SCM_VERSION

public static final CommandParameter END_SCM_VERSION

CHANGELOG_DATE_PATTERN

public static final CommandParameter CHANGELOG_DATE_PATTERN

SCM_VERSION

public static final CommandParameter SCM_VERSION

TAG_NAME

public static final CommandParameter TAG_NAME

FILE

public static final CommandParameter FILE

FILES

public static final CommandParameter FILES

OUTPUT_FILE

public static final CommandParameter OUTPUT_FILE

OUTPUT_DIRECTORY

public static final CommandParameter OUTPUT_DIRECTORY

RUN_CHANGELOG_WITH_UPDATE

public static final CommandParameter RUN_CHANGELOG_WITH_UPDATE

SCM_TAG_PARAMETERS

public static final CommandParameter SCM_TAG_PARAMETERS

SCM_BRANCH_PARAMETERS

public static final CommandParameter SCM_BRANCH_PARAMETERS

SCM_MKDIR_CREATE_IN_LOCAL

public static final CommandParameter SCM_MKDIR_CREATE_IN_LOCAL

SCM_SHORT_REVISION_LENGTH

public static final CommandParameter SCM_SHORT_REVISION_LENGTH

Parameter used only for Git SCM to truncate the emitted hash to the given character length, simulates git rev-parse --short=length command.

Since:

1.7

FORCE_ADD

public static final CommandParameter FORCE_ADD

Parameter to force add.

Since:

1.7

IGNORE_WHITESPACE

public static final CommandParameter IGNORE_WHITESPACE

Contains true or false.

Since:

1.8

SIGN_OPTION

public static final CommandParameter SIGN_OPTION

Parameter to indicate whether the commit/tag should be signed or not. This is only applicable to Git for now. Possible values are outlined in CommandParameters.SignOption

Since:

2.2.1

Method Details

getName

public String getName()

Returns:

the parameter name

toString

public String toString()

Overrides:

toString in class Object