org.apache.myfaces.buildtools.maven2.plugin.builder.trinidad.parse
Class PropertyBean

java.lang.Object
  extended by org.apache.myfaces.buildtools.maven2.plugin.builder.trinidad.parse.ObjectBean
      extended by org.apache.myfaces.buildtools.maven2.plugin.builder.trinidad.parse.AttributeBean
          extended by org.apache.myfaces.buildtools.maven2.plugin.builder.trinidad.parse.PropertyBean
All Implemented Interfaces:
Comparable

public class PropertyBean
extends AttributeBean

PropertyBean is a Java representation of the faces-config component property XML element.


Constructor Summary
PropertyBean()
           
 
Method Summary
 String getAliasOf()
          Returns the alias of this property.
 String getDeprecated()
          Value is provided through the deprecated extended property metadata.
 String getFieldPropertyName()
          Returns the field name of this property, when not generating Trinidad components
 String getJspPropertyName()
          Returns the JSP name of this property.
 String getPropertyClass()
          Returns the property class for this property.
 String[] getPropertyClassParameters()
          Returns the array of parameterized types for this property if it uses generics.
 String getPropertyName()
          Returns the name of this property.
 String[] getPropertyValues()
          Returns possible values for this property.
 String[] getUnsupportedAgents()
          Returns unsupported agents for this property.
 String[] getUnsupportedRenderKits()
          Returns unsupported RenderKits for this property.
 boolean getUseMaxTime()
           
 String getValueExpression()
          Value is provided through the valueExpression property metadata.
 boolean isEnum()
          Returns true if the property is an enumerated Java type.
 boolean isHidden()
          If the property should be hidden from documentation
 boolean isList()
          Returns list flag of this property.
 boolean isLiteralOnly()
          Returns literalOnly flag of this property.
 boolean isMethodBinding()
          Returns true if this property is a method binding.
 boolean isMethodExpression()
          Returns true if this property is a method binding.
 boolean isNoOp()
           
 boolean isOverride()
          Get if this property is overridding a property in an ancestor class.
 boolean isRequired()
          Returns required flag of this property.
 boolean isRtexprvalue()
          Return the rtexrvalue flag
 boolean isStateHolder()
          Returns stateHolder flag of this property.
 boolean isTagAttributeExcluded()
          Returns the tag attribute excluded flag for this property.
 boolean isTransient()
          Returns transient flag of this property.
 void makeNoOp()
          Invoked if the no-op extended property meta-data is provided for the component property.
 void parsePropertyValues(String propertyValues)
          Parses the possible values for this property into a String array using space as the separator between values.
 void parseUnsupportedAgents(String unsupportedAgents)
          Parses the unsupported agents for this property into a String array using space as the separator between values.
 void parseUnsupportedRenderKits(String unsupportedRenderKits)
          Parses the unsupported RenderKits for this property into a String array using space as the separator between values.
 void setAliasOf(String aliasOf)
          Sets the alias of this property.
 void setDeprecated(String deprecated)
          Sets the property deprecated flag
 void setEnum(boolean isEnum)
          Returns true if the property is an enumerated Java type.
 void setFieldPropertyName(String fieldPropertyName)
          Sets the field name of this property, when not generating Trinidad components
 void setHidden(boolean hidden)
          Set if this facet should be hidden from documentation
 void setJspPropertyName(String jspPropertyName)
          Sets the JSP name of this property.
 void setList(boolean list_)
          Sets the list flag of this property.
 void setLiteralOnly(boolean literalOnly)
          Sets the literalOnly flag of this property.
 void setOverride(boolean override)
          Set if this property is overridding a property in an ancestor class.
 void setPropertyClass(String propertyClass)
          Sets the property class for this property.
 void setPropertyName(String propertyName)
          Sets the name of this property.
 void setPropertyValues(String[] propertyValues)
          Sets the possible values for this property.
 void setRequired(boolean required)
          Sets the required flag of this property.
 void setRtexprvalue(boolean rtexprvalue)
          Set the property as allowing ${} syntax
 void setStateHolder(boolean stateHolder)
          Sets the stateHolder flag of this property.
 void setTagAttributeExcluded(boolean excluded)
          Sets the tag attribute excluded flag for this property.
 void setTransient(boolean transient_)
          Sets the transient flag of this property.
 void setUnsupportedAgents(String[] unsupportedAgents)
          Sets the unsupported agents for this property.
 void setUnsupportedRenderKits(String[] unsupportedRenderKits)
          Sets the unsupported RenderKits for this property.
 void setUseMaxTime(boolean _useMaxTime)
           
 void setValueExpression(String valueExpression)
          Sets the property valueExpression
 
Methods inherited from class org.apache.myfaces.buildtools.maven2.plugin.builder.trinidad.parse.AttributeBean
accessibilityGuidelines, addAccessibilityGuideline, compareTo, getAlternateClass, getAttributeClass, getAttributeClassParameters, getAttributeName, getDefaultValue, getDescription, getMethodBindingSignature, hasAccessibilityGuidelines, isVirtual, setAlternateClass, setAttributeClass, setAttributeName, setDefaultValue, setDescription, setMethodBindingSignature, setVirtual
 
Methods inherited from class org.apache.myfaces.buildtools.maven2.plugin.builder.trinidad.parse.ObjectBean
attach, getOwner, isModifiedSince
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PropertyBean

public PropertyBean()
Method Detail

setUseMaxTime

public void setUseMaxTime(boolean _useMaxTime)

getUseMaxTime

public boolean getUseMaxTime()

setPropertyName

public void setPropertyName(String propertyName)
Sets the name of this property.

Parameters:
propertyName - the property name

getPropertyName

public String getPropertyName()
Returns the name of this property.

Returns:
the property name

setPropertyClass

public void setPropertyClass(String propertyClass)
Sets the property class for this property.

Parameters:
propertyClass - the property class

getPropertyClass

public String getPropertyClass()
Returns the property class for this property.

Returns:
the property class

getPropertyClassParameters

public String[] getPropertyClassParameters()
Returns the array of parameterized types for this property if it uses generics.

Returns:
the array of parameterized types for this property

setPropertyValues

public void setPropertyValues(String[] propertyValues)
Sets the possible values for this property.

Parameters:
propertyValues - the property values

getPropertyValues

public String[] getPropertyValues()
Returns possible values for this property.

Returns:
the property values

setStateHolder

public void setStateHolder(boolean stateHolder)
Sets the stateHolder flag of this property.

Parameters:
stateHolder - the property stateHolder flag

isStateHolder

public boolean isStateHolder()
Returns stateHolder flag of this property.

Returns:
the property stateHolder flag

setTransient

public void setTransient(boolean transient_)
Sets the transient flag of this property.

Parameters:
transient_ - the property transient flag

isTransient

public boolean isTransient()
Returns transient flag of this property.

Returns:
the property transient flag

setList

public void setList(boolean list_)
Sets the list flag of this property.

Parameters:
list_ - the property list flag

isList

public boolean isList()
Returns list flag of this property.

Returns:
the property list flag

setRequired

public void setRequired(boolean required)
Sets the required flag of this property.

Parameters:
required - the property required flag

isRequired

public boolean isRequired()
Returns required flag of this property.

Returns:
the property required flag

setLiteralOnly

public void setLiteralOnly(boolean literalOnly)
Sets the literalOnly flag of this property.

Parameters:
literalOnly - the property literalOnly flag

isLiteralOnly

public boolean isLiteralOnly()
Returns literalOnly flag of this property.

Returns:
the property literalOnly flag

setRtexprvalue

public void setRtexprvalue(boolean rtexprvalue)
Set the property as allowing ${} syntax

Parameters:
rtexprvalue - the rtexrvalue value

isRtexprvalue

public boolean isRtexprvalue()
Return the rtexrvalue flag


setAliasOf

public void setAliasOf(String aliasOf)
Sets the alias of this property.

Parameters:
aliasOf - the property alias

getAliasOf

public String getAliasOf()
Returns the alias of this property.

Returns:
the property alias

setUnsupportedAgents

public void setUnsupportedAgents(String[] unsupportedAgents)
Sets the unsupported agents for this property.

Parameters:
unsupportedAgents - the unsupported agents

getUnsupportedAgents

public String[] getUnsupportedAgents()
Returns unsupported agents for this property.

Returns:
the unsupported agents

setUnsupportedRenderKits

public void setUnsupportedRenderKits(String[] unsupportedRenderKits)
Sets the unsupported RenderKits for this property.

Parameters:
unsupportedRenderKits - the unsupported RenderKits

getUnsupportedRenderKits

public String[] getUnsupportedRenderKits()
Returns unsupported RenderKits for this property.

Returns:
the unsupported RenderKits

setTagAttributeExcluded

public void setTagAttributeExcluded(boolean excluded)
Sets the tag attribute excluded flag for this property.

Parameters:
excluded - true, if the tag attribute should be excluded; false, otherwise

isTagAttributeExcluded

public boolean isTagAttributeExcluded()
Returns the tag attribute excluded flag for this property.

Returns:
true, if the tag attribute should be excluded; false, otherwise

isEnum

public boolean isEnum()
Returns true if the property is an enumerated Java type.


setEnum

public void setEnum(boolean isEnum)
Returns true if the property is an enumerated Java type.


isMethodBinding

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

Returns:
true if this property is a method binding, otherwise false

isMethodExpression

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

Returns:
true if this property is a method binding, otherwise false

parsePropertyValues

public void parsePropertyValues(String propertyValues)
Parses the possible values for this property into a String array using space as the separator between values.

Parameters:
propertyValues - the property values

parseUnsupportedAgents

public void parseUnsupportedAgents(String unsupportedAgents)
Parses the unsupported agents for this property into a String array using space as the separator between values.

Parameters:
unsupportedAgents - the unsupported agents

parseUnsupportedRenderKits

public void parseUnsupportedRenderKits(String unsupportedRenderKits)
Parses the unsupported RenderKits for this property into a String array using space as the separator between values.

Parameters:
unsupportedRenderKits - the unsupported RenderKits

setJspPropertyName

public void setJspPropertyName(String jspPropertyName)
Sets the JSP name of this property.

Parameters:
jspPropertyName - the JSP property name

getJspPropertyName

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

Returns:
the JSP property name

setFieldPropertyName

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

Parameters:
fieldPropertyName - the field property name

getFieldPropertyName

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

Returns:
the field property name

isHidden

public boolean isHidden()
If the property should be hidden from documentation

Returns:
If the facet should be hidden

setHidden

public void setHidden(boolean hidden)
Set if this facet should be hidden from documentation

Parameters:
hidden - If the facet should be hidden

setDeprecated

public void setDeprecated(String deprecated)
Sets the property deprecated flag

Parameters:
deprecated -

getDeprecated

public String getDeprecated()
Value is provided through the deprecated extended property metadata.

Returns:
deprecated description if the component property should be deprecated

isNoOp

public boolean isNoOp()
Returns:
true if the property should be generated with a no-op setter.

makeNoOp

public void makeNoOp()
Invoked if the no-op extended property meta-data is provided for the component property.


setValueExpression

public void setValueExpression(String valueExpression)
Sets the property valueExpression

Parameters:
valueExpression -

getValueExpression

public String getValueExpression()
Value is provided through the valueExpression property metadata.

Returns:
valueExpression of the property

setOverride

public void setOverride(boolean override)
Set if this property is overridding a property in an ancestor class.

Parameters:
override - if overridding a property

isOverride

public boolean isOverride()
Get if this property is overridding a property in an ancestor class.

Returns:
If the property is an overide


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