com.openshift.restclient.model.template

Interface IParameter

All Superinterfaces:

Cloneable

All Known Implementing Classes:

Parameter

public interface IParameter
extends Cloneable

A parameter for a template

Author:

Jeff Cantrill

Method Summary

Modifier and Type	Method and Description
IParameter	clone()
String	getDescription() Returns the description
String	getFrom() Returns the input to the generator
String	getGeneratorName() Returns the generator name which will use the value from 'getFrom' if set
String	getName() Returns the name of the parameter that is substituted in the template
String	getValue() Returns the value to use
boolean	isRequired() Returns true if parameter is required; false otherwise
void	setValue(String value) Sets the value to use

Method Detail

getName

String getName()

Returns the name of the parameter that is substituted in the template

Returns:

getDescription

String getDescription()

Returns the description

Returns:

getValue

String getValue()

Returns the value to use

Returns:

setValue

void setValue(String value)

Sets the value to use

Parameters:

value -

getGeneratorName

String getGeneratorName()

Returns the generator name which will use the value from 'getFrom' if set

Returns:

getFrom

String getFrom()

Returns the input to the generator

Returns:

isRequired

boolean isRequired()

Returns true if parameter is required; false otherwise

Returns:

clone

IParameter clone()