|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--gate.creole.Parameter
Models a resource parameter.
Field Summary | |
(package private) String |
comment
Comment for the parameter |
(package private) String |
defaultValueString
Default value string (unprocessed, from the metadata) for the parameter |
(package private) String |
itemClassName
The name of the item's class. |
(package private) String |
name
Name for the parameter |
(package private) boolean |
optional
Is the parameter optional? |
protected Class |
paramClass
The Class for the parameter type |
protected ResourceData |
resData
The resource data that this parameter is part of. |
(package private) boolean |
runtime
Is this a run-time parameter? |
(package private) Set |
suffixes
A set of strings representing suffixes for URL params |
(package private) String |
typeName
The type name of the parameter |
Constructor Summary | |
Parameter()
|
Method Summary | |
Object |
calculateDefaultValue()
Calculate and return the default value for this parameter |
Object |
calculateValueFromString(String stringValue)
Calculate and return the value for this parameter starting from a String |
String |
getComment()
Get the comment for this parameter |
Object |
getDefaultValue()
Get the default value for this parameter. |
String |
getDefaultValueString()
Get the default value string (unprocessed, from the metadata) for the parameter |
String |
getItemClassName()
If this parameter is a List type this will return the type of the items in the list. |
String |
getName()
Get the name for this parameter |
protected Class |
getParameterClass()
Find the class for this parameter type. |
Set |
getSuffixes()
Get the suffixes atached with this param. |
String |
getTypeName()
Get the type name for this parameter |
boolean |
isOptional()
Is the parameter optional? |
boolean |
isRuntime()
Is the parameter runtime? |
void |
setComment(String comment)
Set the comment for this parameter |
void |
setDefaultValueString(String defaultValueString)
Set the default value string (from the metadata) for the parameter |
void |
setName(String name)
Set the name for this parameter |
void |
setOptional(boolean optional)
Set optionality of this parameter |
void |
setRuntime(boolean runtime)
Set runtime status of this parameter |
void |
setTypeName(String typeName)
Set the type name for this parameter |
String |
toString()
String representation |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
String typeName
boolean optional
String itemClassName
Set suffixes
protected ResourceData resData
String defaultValueString
String comment
String name
boolean runtime
protected Class paramClass
Constructor Detail |
public Parameter()
Method Detail |
public void setTypeName(String typeName)
public String getTypeName()
public void setOptional(boolean optional)
public boolean isOptional()
public Object calculateDefaultValue() throws ParameterException
ParameterException
public Object calculateValueFromString(String stringValue) throws ParameterException
ParameterException
public Object getDefaultValue() throws ParameterException
ParameterException
calculateDefaultValue()
public void setDefaultValueString(String defaultValueString)
public String getDefaultValueString()
public void setComment(String comment)
public String getComment()
public void setName(String name)
public String getName()
public Set getSuffixes()
public void setRuntime(boolean runtime)
public boolean isRuntime()
protected Class getParameterClass() throws ParameterException
ParameterException
public String toString()
toString
in class Object
public String getItemClassName()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |