net.officefloor.building.command

Interface OfficeFloorCommandParameter

All Known Implementing Classes:

AbstractMultiplePathsOfficeFloorCommandParameter, AbstractOfficeFloorCommandParameter, AbstractSingleValueOfficeFloorCommandParameter, ClassPathOfficeFloorCommandParameter, IsIsolateProcessesOfficeFloorCommandParameter, JvmOptionOfficeFloorCommandParameter, KeyStoreOfficeFloorCommandParameter, KeyStorePasswordOfficeFloorCommandParameter, OfficeBuildingHostOfficeFloorCommandParameter, OfficeBuildingPortOfficeFloorCommandParameter, OfficeFloorLocationOfficeFloorCommandParameter, OfficeFloorSourceOfficeFloorCommandParameter, OfficeNameOfficeFloorCommandParameter, ParameterOfficeFloorCommandParameter, PasswordOfficeFloorCommandParameter, ProcessNameOfficeFloorCommandParameter, PropertiesOfficeFloorCommandParameter, StopMaxWaitTimeOfficeFloorCommandParameter, TaskNameOfficeFloorCommandParameter, UploadArtifactsOfficeFloorCommandParameter, UsernameOfficeFloorCommandParameter, WorkNameOfficeFloorCommandParameter, WorkspaceOfficeFloorCommandParameter

public interface OfficeFloorCommandParameter

Command parameter for an OfficeFloorCommand.

Author:

Daniel Sagenschneider

Method Summary

Modifier and Type	Method and Description
void	addValue(String value) Adds a value for this parameter.
String	getDescription() Obtains a description for this OfficeFloorCommandParameter.
String	getName() Obtains the name of this OfficeFloorCommandParameter.
String	getShortName() Provides an optional short name for easier typing.
boolean	isRequireValue() Flags if this OfficeFloorCommandParameter requires a value.

Method Detail

getName

String getName()

Obtains the name of this OfficeFloorCommandParameter.

This would be for example help for help.

Returns:

Name.

getShortName

String getShortName()

Provides an optional short name for easier typing.

This would be for example h for help.

Returns:

Short name or null if no short name.

getDescription

String getDescription()

Obtains a description for this OfficeFloorCommandParameter.

Returns:

Description for this OfficeFloorCommandParameter.

isRequireValue

boolean isRequireValue()

Flags if this OfficeFloorCommandParameter requires a value.

Should this return false then addValue(String) will be invoked with a null value. Also the OfficeFloorCommandParser will not expect a value following the option.

Returns:

true if requires value.

addValue

void addValue(String value)

Adds a value for this parameter.

Typically this should only be invoked once however is available to allow values to be provided multiple times (e.g. in the case of a OfficeFloor tag replacement).

Parameters:

value - Value for this argument.

See Also:

isRequireValue()