net.officefloor.building.command.parameters

Class AbstractMultiplePathsOfficeFloorCommandParameter

java.lang.Object

net.officefloor.building.command.parameters.AbstractOfficeFloorCommandParameter

net.officefloor.building.command.parameters.AbstractMultiplePathsOfficeFloorCommandParameter

All Implemented Interfaces:

OfficeFloorCommandParameter

Direct Known Subclasses:

ClassPathOfficeFloorCommandParameter, JvmOptionOfficeFloorCommandParameter, PropertiesOfficeFloorCommandParameter, UploadArtifactsOfficeFloorCommandParameter

public abstract class AbstractMultiplePathsOfficeFloorCommandParameter
extends AbstractOfficeFloorCommandParameter

OfficeFloorCommandParameter allowing multiple paths.

Author:

Daniel Sagenschneider

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	addValue(String value) Adds a value for this parameter.
protected String[]	getPaths() Obtains the listing of paths.
protected static String	transformPathsToValue(String[] paths, String pathSeparator) Transforms the paths into a value.
protected static String[]	transformValueToPaths(String value, String pathSeparator) Transforms the value into its multiple paths.

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

AbstractMultiplePathsOfficeFloorCommandParameter

public AbstractMultiplePathsOfficeFloorCommandParameter(String name,
                                                        String shortName,
                                                        String pathSeparator,
                                                        String description)

Initiate.

Parameters:

name - Name.

shortName - Short name.

pathSeparator - Path separator.

description - Description.

Method Detail

getPaths

protected String[] getPaths()

Obtains the listing of paths.

Returns:

Listing of paths.

transformValueToPaths

protected static String[] transformValueToPaths(String value,
                                                String pathSeparator)

Transforms the value into its multiple paths.

Parameters:

value - Value to be transformed.

pathSeparator - Path separator.

Returns:

Multiple path entries in the value.

transformPathsToValue

protected static String transformPathsToValue(String[] paths,
                                              String pathSeparator)

Transforms the paths into a value.

Parameters:

paths - Paths to be transformed.

pathSeparator - Path separator.

Returns:

Value for the multiple paths. null if no paths.

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()