org.cloudbees.literate.api.v1

Class Parameter

java.lang.Object

org.cloudbees.literate.api.v1.Parameter

All Implemented Interfaces:

Serializable

public class Parameter
extends Object
implements Serializable

This represents a parameter that should be exposed to some AbstractCommands

Since:

0.6

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Parameter(String name, String description, String defaultValue, Collection<String> validValues) Constructs a new parameter.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object o)
String	getDefaultValue() Returns an optional default value to use if no value is provided by the user or if no user is present to provide a value.
String	getDescription() Returns a human readable description of the parameter for use if prompting the user for a value.
String	getName() Returns the name of the parameter.
List<String>	getValidValues() Returns an optional list of valid values that the parameter may take, if null then there is no a restriction to a finite set.
int	hashCode()
static List<Parameter>	toList(Map<?,Parameter> parameters) Utility method to convert a Map of Parameters into a List.
static Map<String,Parameter>	toMap(Iterable<Parameter> parameters) Utility method to convert a collection of Parameter instances into a Map keyed by getName().
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Parameter

public Parameter(@NonNull
         String name,
         @CheckForNull
         String description,
         @CheckForNull
         String defaultValue,
         @CheckForNull
         Collection<String> validValues)

Constructs a new parameter.

Parameters:

name - the name of the parameter.

description - a human readable description of the parameter.

defaultValue - an optional default value.

Method Detail

toMap

@NonNull
public static Map<String,Parameter> toMap(@CheckForNull
                                  Iterable<Parameter> parameters)

Utility method to convert a collection of Parameter instances into a Map keyed by getName(). If the supplied collection has multiple parameters with the same name, the first entry wins.

Parameters:

parameters - the collection of parameters.

Returns:

a Map keyed by getName()

toList

@NonNull
public static List<Parameter> toList(@CheckForNull
                             Map<?,Parameter> parameters)

Utility method to convert a Map of Parameters into a List.

Parameters:

parameters - the map of parameters.

Returns:

a List of Parameter instances.

getName

@NonNull
public String getName()

Returns the name of the parameter. An environment variable with this name will be set in the command context if a value is supplied or if there is a defaultValue.

Returns:

the name of the parameter. An environment variable with this name will be set in the command context if a value is supplied or if there is a defaultValue.

getDescription

@CheckForNull
public String getDescription()

Returns a human readable description of the parameter for use if prompting the user for a value.

Returns:

A human readable description of the parameter for use if prompting the user for a value.

getDefaultValue

@CheckForNull
public String getDefaultValue()

Returns an optional default value to use if no value is provided by the user or if no user is present to provide a value.

Returns:

An optional default value to use if no value is provided by the user or if no user is present to provide a value.

getValidValues

@CheckForNull
public List<String> getValidValues()

Returns an optional list of valid values that the parameter may take, if null then there is no a restriction to a finite set.

Returns:

an optional list of valid values that the parameter may take, if null then there is no a restriction to a finite set.

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object