org.xins.common.spec
Class ParameterSpec

java.lang.Object
  org.xins.common.spec.ParameterSpec

public final class ParameterSpec

extends Object

Specification of a parameter.

Since:

XINS 1.3.0

Version:

$Revision: 1.21 $ $Date: 2008/12/13 14:58:05 $

Author:

Anthony Goubard

Method Summary

String	getDefault() Gets the default value of the parameter if any.
String	getDescription() Gets the description of the parameter.
String	getName() Gets the name of the parameter.
Type	getType() Gets the type of the parameter.
boolean	isRequired() Returns whether the parameter is mandatory.

Methods inherited from class java.lang.Object

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

Method Detail

getName

public String getName()

Gets the name of the parameter.

Returns:

the name of the parameter, never null.

getDescription

public String getDescription()

Gets the description of the parameter.

Returns:

the description of the parameter, never null.

getDefault

public String getDefault()

Gets the default value of the parameter if any.

Returns:

the String representation of the default value of the parameter, can be null.

Since:

XINS 2.1.

isRequired

public boolean isRequired()

Returns whether the parameter is mandatory.

Returns:

true if the parameter is required, false otherwise.

getType

public Type getType()

Gets the type of the parameter.

Returns:

the type of the parameter, never null.