net.officefloor.building.command.parameters

Class AbstractSingleValueOfficeFloorCommandParameter

java.lang.Object

net.officefloor.building.command.parameters.AbstractOfficeFloorCommandParameter

net.officefloor.building.command.parameters.AbstractSingleValueOfficeFloorCommandParameter

All Implemented Interfaces:

OfficeFloorCommandParameter

Direct Known Subclasses:

IsIsolateProcessesOfficeFloorCommandParameter, KeyStoreOfficeFloorCommandParameter, KeyStorePasswordOfficeFloorCommandParameter, OfficeBuildingHostOfficeFloorCommandParameter, OfficeBuildingPortOfficeFloorCommandParameter, OfficeFloorLocationOfficeFloorCommandParameter, OfficeFloorSourceOfficeFloorCommandParameter, OfficeNameOfficeFloorCommandParameter, ParameterOfficeFloorCommandParameter, PasswordOfficeFloorCommandParameter, ProcessNameOfficeFloorCommandParameter, StopMaxWaitTimeOfficeFloorCommandParameter, TaskNameOfficeFloorCommandParameter, UsernameOfficeFloorCommandParameter, WorkNameOfficeFloorCommandParameter, WorkspaceOfficeFloorCommandParameter

public abstract class AbstractSingleValueOfficeFloorCommandParameter
extends AbstractOfficeFloorCommandParameter

OfficeFloorCommandParameter that provides only the first value specified.

Author:

Daniel Sagenschneider

Constructor Summary

Constructors

Constructor and Description
AbstractSingleValueOfficeFloorCommandParameter(String name, String shortName, String description) Initiate.

Method Summary

Modifier and Type	Method and Description
void	addValue(String value) Adds a value for this parameter.
protected String	getValue() Obtains the value for this parameter.

Methods inherited from class net.officefloor.building.command.parameters.AbstractOfficeFloorCommandParameter

getDescription, getName, getShortName, isRequireValue

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractSingleValueOfficeFloorCommandParameter

public AbstractSingleValueOfficeFloorCommandParameter(String name,
                                                      String shortName,
                                                      String description)

Initiate.

Parameters:

name - Name.

shortName - Short name.

description - Description.

Method Detail

getValue

protected String getValue()

Obtains the value for this parameter.

Returns:

Value for this parameter.

addValue

public void addValue(String value)

Description copied from interface: OfficeFloorCommandParameter

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:

OfficeFloorCommandParameter.isRequireValue()