|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.hivemind.impl.BaseLocatable
org.apache.tapestry.spec.ParameterSpecification
Defines a formal parameter to a component. A IParameterSpecification
is contained
by a IComponentSpecification
.
TBD: Identify arrays in some way.
Constructor Summary | |
ParameterSpecification()
|
Method Summary | |
boolean |
getCache()
Returns true if the parameter proeprty should cache the result of the binding. |
java.lang.String |
getDefaultBindingType()
|
java.lang.String |
getDefaultValue()
Returns the default value for the parameter (or null if the parameter has no default value). |
java.lang.String |
getDescription()
Returns the documentation for this parameter. |
java.lang.String |
getPropertyName()
Returns the name of the JavaBeans property to connect the parameter to. |
java.lang.String |
getType()
Returns the class name of the expected type of the parameter. |
boolean |
isRequired()
Returns true if the parameter is required by the component. |
void |
setCache(boolean cache)
|
void |
setDefaultBindingType(java.lang.String defaultBindingType)
Sets the default binding type, used when a parameter is bound without specifying an explicit binding prefix. |
void |
setDefaultValue(java.lang.String defaultValue)
Sets the default value of the JavaBeans property if no binding is provided |
void |
setDescription(java.lang.String description)
Sets the documentation for this parameter. |
void |
setPropertyName(java.lang.String propertyName)
Sets the property name (of the component class) to connect the parameter to. |
void |
setRequired(boolean value)
|
void |
setType(java.lang.String value)
Sets the type of value expected for the parameter. |
Methods inherited from class org.apache.hivemind.impl.BaseLocatable |
getLocation, setLocation |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.apache.hivemind.LocationHolder |
setLocation |
Methods inherited from interface org.apache.hivemind.Locatable |
getLocation |
Constructor Detail |
public ParameterSpecification()
Method Detail |
public java.lang.String getType()
java.lang.Object
which matches anything.
getType
in interface IParameterSpecification
public boolean isRequired()
isRequired
in interface IParameterSpecification
public void setRequired(boolean value)
setRequired
in interface IParameterSpecification
public void setType(java.lang.String value)
setType
in interface IParameterSpecification
public java.lang.String getDescription()
getDescription
in interface IParameterSpecification
public void setDescription(java.lang.String description)
setDescription
in interface IParameterSpecification
public void setPropertyName(java.lang.String propertyName)
setPropertyName
in interface IParameterSpecification
public java.lang.String getPropertyName()
getPropertyName
in interface IParameterSpecification
public java.lang.String getDefaultValue()
IParameterSpecification
getDefaultValue
in interface IParameterSpecification
IParameterSpecification.getDefaultValue()
public void setDefaultValue(java.lang.String defaultValue)
IParameterSpecification
setDefaultValue
in interface IParameterSpecification
IParameterSpecification.setDefaultValue(java.lang.String)
public java.lang.String getDefaultBindingType()
getDefaultBindingType
in interface IParameterSpecification
public void setDefaultBindingType(java.lang.String defaultBindingType)
IParameterSpecification
setDefaultBindingType
in interface IParameterSpecification
BindingConstants
,
BindingUtils.getDefaultBindingType(IComponentSpecification,
String, String)
public boolean getCache()
IParameterSpecification
getCache
in interface IParameterSpecification
public void setCache(boolean cache)
setCache
in interface IParameterSpecification
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |