com.arsdigita.util.parameter
Interface ParameterInfo

public interface ParameterInfo

Subject to change. Metadata for a parameter that is of use for building documentation or user interfaces for parameters. The fields are not required and thus the methods of this class may return null.

Version:

$Id: //core-platform/dev/src/com/arsdigita/util/parameter/ParameterInfo.java#5 $

Author:

Justin Ross <jross@redhat.com>

See Also:

Parameter.setInfo(ParameterInfo), Parameter.getInfo()

Field Summary

static String

versionId

Method Summary

String	getExample() Gets an example value for the parameter.
String	getFormat() Gets a format description.
String	getPurpose() Gets the parameter's reason for being.
String	getTitle() Gets the pretty name of the parameter.

Field Detail

versionId

public static final String versionId

See Also:

Constant Field Values

Method Detail

getTitle

public String getTitle()

Gets the pretty name of the parameter.

Returns:

The String title of the parameter; it may be null

getPurpose

public String getPurpose()

Gets the parameter's reason for being.

Returns:

The String purpose of the parameter; it may be null

getExample

public String getExample()

Gets an example value for the parameter.

Returns:

A String example value; it may be null

getFormat

public String getFormat()

Gets a format description.

Returns:

A format String; it may be null