org.apache.myfaces.buildtools.maven2.plugin.builder.model
Class PropertyMeta

java.lang.Object
  extended by org.apache.myfaces.buildtools.maven2.plugin.builder.model.PropertyMeta

public class PropertyMeta
extends Object

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

PropertyMeta

public PropertyMeta()

PropertyMeta

public PropertyMeta(PropertyMeta pm)
Method Detail

writeXml

public static void writeXml(XmlWriter out,
                            PropertyMeta pm)
Write this model out as xml.


addXmlRules

public static void addXmlRules(org.apache.commons.digester.Digester digester,
                               String prefix)
Add digester rules to repopulate a Model instance from an xml file.


merge

public void merge(PropertyMeta other)
Merge the data in the specified other property into this one, throwing an exception if there is an incompatibility.


setName

public void setName(String name)
Set the name that users refer to this property by.

This sets the name of xml tag attributes, and the base names of generated getter/setter methods.


getName

public String getName()

setClassName

public void setClassName(String className)
Set the fully-qualified name of the type of this property.


getClassName

public String getClassName()

setTransient

public void setTransient(Boolean state)
Specify whether this property is transient or not.

Transient properties are not saved in the view state and are not restored during the "restore view" phase.


isTransient

public Boolean isTransient()

setRequired

public 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.


isRequired

public Boolean isRequired()

setLiteralOnly

public void setLiteralOnly(Boolean literalOnly)
Specify whether this property accepts only literal (constant) values, or whether this property can be mapped to an EL expression.


isLiteralOnly

public Boolean isLiteralOnly()

setDescription

public void setDescription(String desc)

getDescription

public String getDescription()

setLongDescription

public void setLongDescription(String desc)

getLongDescription

public String getLongDescription()

setDefaultValue

public void setDefaultValue(String defaultValue)
Sets the default value of this attribute.

Parameters:
defaultValue - the attribute default value

getDefaultValue

public String getDefaultValue()
Returns the default value of this attribute.

Returns:
the attribute default value

setJspName

public void setJspName(String jspName)
Sets the JSP name of this property.

Parameters:
jspName - the JSP property name

getJspName

public String getJspName()
Returns the JSP name of this property.

Returns:
the JSP property name

setFieldName

public void setFieldName(String fieldName)
Sets the field name of this property, when not generating Trinidad components

Parameters:
fieldName - the field property name

getFieldName

public String getFieldName()
Returns the field name of this property, when not generating Trinidad components

Returns:
the field property name

setMethodBindingSignature

public void setMethodBindingSignature(MethodSignatureMeta signature)
Sets the method binding signature of this property.

Parameters:
signature - the method binding signature of this property

getMethodBindingSignature

public MethodSignatureMeta getMethodBindingSignature()
Returns the method binding signature of this property.

Returns:
the method binding signature of this property

setInherited

public void setInherited(Boolean inherited)

isInherited

public Boolean isInherited()

setInheritedTag

public void setInheritedTag(Boolean inheritedTag)

isInheritedTag

public Boolean isInheritedTag()
Returns true if this property was inherited from an ancestor component which has no associated tag class.

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

Parameters:
inheritedTag -

isLocalInheritedTag

public Boolean isLocalInheritedTag()

setTagExcluded

public void setTagExcluded(Boolean tagExcluded)

isTagExcluded

public Boolean isTagExcluded()

setGenerated

public void setGenerated(Boolean generated)

isGenerated

public Boolean isGenerated()
Indicates if the property should be generated or not.

Returns:

setStateHolder

public void setStateHolder(Boolean stateHolder)

isStateHolder

public Boolean isStateHolder()

setLocalMethodScope

public void setLocalMethodScope(String localMethodScope)

getLocalMethodScope

public String getLocalMethodScope()

setLocalMethod

public void setLocalMethod(Boolean localMethod)

isLocalMethod

public Boolean isLocalMethod()

setSetMethodScope

public void setSetMethodScope(String setMethodScope)

getSetMethodScope

public String getSetMethodScope()

setSetMethod

public void setSetMethod(Boolean setMethod)

setRtexprvalue

public void setRtexprvalue(Boolean rtexprvalue)

isRtexprvalue

public Boolean isRtexprvalue()

isSetMethod

public Boolean isSetMethod()

isMethodBinding

public boolean isMethodBinding()
Returns true if this property is a method binding.

TODO: what is this for?


isMethodExpression

public boolean isMethodExpression()
Returns true if this property is a method binding.

TODO: what is this for?


setDeferredValueType

public void setDeferredValueType(String deferredValueType)
Since:
1.0.3

getDeferredValueType

public String getDeferredValueType()
Indicate the type that values should be cast on tld. It is supposed that the className is javax.el.ValueExpression to apply it.

Since:
1.0.3

getClientEvent

public String getClientEvent()
Since:
1.0.4

setClientEvent

public void setClientEvent(String clientEvent)
Since:
1.0.4

setPartialStateHolder

public void setPartialStateHolder(Boolean partialStateHolder)
Since:
1.0.6

isPartialStateHolder

public Boolean isPartialStateHolder()
Since:
1.0.6

isFaceletsOnly

public Boolean isFaceletsOnly()
Since:
1.0.6

setFaceletsOnly

public void setFaceletsOnly(Boolean faceletsOnly)
Since:
1.0.6


Copyright © 2001-2011 The Apache Software Foundation. All Rights Reserved.