|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.myfaces.buildtools.maven2.plugin.builder.model.PropertyMeta
public class PropertyMeta
Store metadata about a bean property of a component, converter or other JSF artifact.
This metadata defines the attributes of JSP tags, among other things.
Constructor Summary | |
---|---|
PropertyMeta()
|
|
PropertyMeta(PropertyMeta pm)
|
Method Summary | |
---|---|
static void |
addXmlRules(org.apache.commons.digester.Digester digester,
String prefix)
Add digester rules to repopulate a Model instance from an xml file. |
String |
getClassName()
|
String |
getClientEvent()
|
String |
getDefaultValue()
Returns the default value of this attribute. |
String |
getDeferredValueType()
Indicate the type that values should be cast on tld. |
String |
getDescription()
|
String |
getFieldName()
Returns the field name of this property, when not generating Trinidad components |
String |
getJspName()
Returns the JSP name of this property. |
String |
getLocalMethodScope()
|
String |
getLongDescription()
|
MethodSignatureMeta |
getMethodBindingSignature()
Returns the method binding signature of this property. |
String |
getName()
|
String |
getSetMethodScope()
|
Boolean |
isFaceletsOnly()
|
Boolean |
isGenerated()
Indicates if the property should be generated or not. |
Boolean |
isInherited()
|
Boolean |
isInheritedTag()
Returns true if this property was inherited from an ancestor component which has no associated tag class. |
Boolean |
isLiteralOnly()
|
Boolean |
isLocalInheritedTag()
|
Boolean |
isLocalMethod()
|
boolean |
isMethodBinding()
Returns true if this property is a method binding. |
boolean |
isMethodExpression()
Returns true if this property is a method binding. |
Boolean |
isPartialStateHolder()
|
Boolean |
isRequired()
|
Boolean |
isRtexprvalue()
|
Boolean |
isSetMethod()
|
Boolean |
isStateHolder()
|
Boolean |
isTagExcluded()
|
Boolean |
isTransient()
|
void |
merge(PropertyMeta other)
Merge the data in the specified other property into this one, throwing an exception if there is an incompatibility. |
void |
setClassName(String className)
Set the fully-qualified name of the type of this property. |
void |
setClientEvent(String clientEvent)
|
void |
setDefaultValue(String defaultValue)
Sets the default value of this attribute. |
void |
setDeferredValueType(String deferredValueType)
|
void |
setDescription(String desc)
|
void |
setFaceletsOnly(Boolean faceletsOnly)
|
void |
setFieldName(String fieldName)
Sets the field name of this property, when not generating Trinidad components |
void |
setGenerated(Boolean generated)
|
void |
setInherited(Boolean inherited)
|
void |
setInheritedTag(Boolean inheritedTag)
|
void |
setJspName(String jspName)
Sets the JSP name of this property. |
void |
setLiteralOnly(Boolean literalOnly)
Specify whether this property accepts only literal (constant) values, or whether this property can be mapped to an EL expression. |
void |
setLocalMethod(Boolean localMethod)
|
void |
setLocalMethodScope(String localMethodScope)
|
void |
setLongDescription(String desc)
|
void |
setMethodBindingSignature(MethodSignatureMeta signature)
Sets the method binding signature of this property. |
void |
setName(String name)
Set the name that users refer to this property by. |
void |
setPartialStateHolder(Boolean partialStateHolder)
|
void |
setRequired(Boolean required)
Specify whether this property is required, ie whether it is a syntax error for someone to use a tag for a component with this property but not explicitly provide a value for this property. |
void |
setRtexprvalue(Boolean rtexprvalue)
|
void |
setSetMethod(Boolean setMethod)
|
void |
setSetMethodScope(String setMethodScope)
|
void |
setStateHolder(Boolean stateHolder)
|
void |
setTagExcluded(Boolean tagExcluded)
|
void |
setTransient(Boolean state)
Specify whether this property is transient or not. |
static void |
writeXml(XmlWriter out,
PropertyMeta pm)
Write this model out as xml. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public PropertyMeta()
public PropertyMeta(PropertyMeta pm)
Method Detail |
---|
public static void writeXml(XmlWriter out, PropertyMeta pm)
public static void addXmlRules(org.apache.commons.digester.Digester digester, String prefix)
public void merge(PropertyMeta other)
public void setName(String name)
This sets the name of xml tag attributes, and the base names of generated getter/setter methods.
public String getName()
public void setClassName(String className)
public String getClassName()
public void setTransient(Boolean state)
Transient properties are not saved in the view state and are not restored during the "restore view" phase.
public Boolean isTransient()
public void setRequired(Boolean required)
public Boolean isRequired()
public void setLiteralOnly(Boolean literalOnly)
public Boolean isLiteralOnly()
public void setDescription(String desc)
public String getDescription()
public void setLongDescription(String desc)
public String getLongDescription()
public void setDefaultValue(String defaultValue)
defaultValue
- the attribute default valuepublic String getDefaultValue()
public void setJspName(String jspName)
jspName
- the JSP property namepublic String getJspName()
public void setFieldName(String fieldName)
fieldName
- the field property namepublic String getFieldName()
public void setMethodBindingSignature(MethodSignatureMeta signature)
signature
- the method binding signature of this propertypublic MethodSignatureMeta getMethodBindingSignature()
public void setInherited(Boolean inherited)
public Boolean isInherited()
public void setInheritedTag(Boolean inheritedTag)
public Boolean isInheritedTag()
When a tag class is generated for this component, then the tag class will need to define a setter method to handle this property.
However properties which are inherited from an ancestor component that does have a tag class will not need
inheritedTag
- public Boolean isLocalInheritedTag()
public void setTagExcluded(Boolean tagExcluded)
public Boolean isTagExcluded()
public void setGenerated(Boolean generated)
public Boolean isGenerated()
public void setStateHolder(Boolean stateHolder)
public Boolean isStateHolder()
public void setLocalMethodScope(String localMethodScope)
public String getLocalMethodScope()
public void setLocalMethod(Boolean localMethod)
public Boolean isLocalMethod()
public void setSetMethodScope(String setMethodScope)
public String getSetMethodScope()
public void setSetMethod(Boolean setMethod)
public void setRtexprvalue(Boolean rtexprvalue)
public Boolean isRtexprvalue()
public Boolean isSetMethod()
public boolean isMethodBinding()
TODO: what is this for?
public boolean isMethodExpression()
TODO: what is this for?
public void setDeferredValueType(String deferredValueType)
public String getDeferredValueType()
public String getClientEvent()
public void setClientEvent(String clientEvent)
public void setPartialStateHolder(Boolean partialStateHolder)
public Boolean isPartialStateHolder()
public Boolean isFaceletsOnly()
public void setFaceletsOnly(Boolean faceletsOnly)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |