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

java.lang.Object
  extended by org.apache.myfaces.buildtools.maven2.plugin.builder.model.ClassMeta
      extended by org.apache.myfaces.buildtools.maven2.plugin.builder.model.ViewEntityMeta
          extended by org.apache.myfaces.buildtools.maven2.plugin.builder.model.BehaviorMeta
All Implemented Interfaces:
PropertyHolder
Direct Known Subclasses:
ClientBehaviorMeta

public class BehaviorMeta
extends ViewEntityMeta
implements PropertyHolder

Store metadata about a class that is either a JSF Behavior, or some base class or interface that a Behavior can be derived from.

A behavior can be used in two ways:

Since:
1.0.6

Constructor Summary
BehaviorMeta()
           
BehaviorMeta(String name)
           
 
Method Summary
 void addBehaviorClassModifier(int modifier)
          Adds a Java Language class modifier to the behavior class.
static void addXmlRules(org.apache.commons.digester.Digester digester, String prefix)
          Add digester rules to repopulate an instance of this type from an xml file.
 int getBehaviorClassModifiers()
          Returns the Java Language class modifiers for the behavior class.
 String getBehaviorId()
           
 String getBehaviorType()
           
 String getBodyContent()
           
 Collection getPropertyBehaviorList()
           
 Collection getPropertyTagList()
           
 String getTagHandler()
           
 Boolean isConfigExcluded()
           
 Boolean isEvaluateELOnExecution()
           
 Boolean isGeneratedComponentClass()
           
 void merge(BehaviorMeta other)
          Merge the data in the specified other property into this one, throwing an exception if there is an incompatibility.
 void setBehaviorId(String behaviorId)
          Sets the behavior identifer for this component.
 void setBodyContent(String bodyContent)
           
 void setConfigExcluded(Boolean configExcluded)
           
 void setEvaluateELOnExecution(Boolean evaluateELOnExecution)
           
 void setGeneratedComponentClass(Boolean generatedComponentClass)
           
 void setTagHandler(String tagHandler)
          Specifies the class of the Facelets tag handler (component handler) for this component.
protected  void writeXmlSimple(XmlWriter out)
          Write an instance of this class out as xml.
 
Methods inherited from class org.apache.myfaces.buildtools.maven2.plugin.builder.model.ViewEntityMeta
addProperty, getDescription, getLongDescription, getName, getProperties, getProperty, getPropertyList, hasProperties, merge, properties, propertiesSize, setDescription, setLongDescription, setName, writeXmlComplex
 
Methods inherited from class org.apache.myfaces.buildtools.maven2.plugin.builder.model.ClassMeta
addInterfaceClassName, getClassName, getInterfaceClassNames, getModelId, getPackageName, getParentClassName, getSourceClassName, getSourceClassParentClassName, merge, setClassName, setInterfaceClassNames, setModelId, setParentClassName, setSourceClassName, setSourceClassParentClassName, writeXml
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.apache.myfaces.buildtools.maven2.plugin.builder.model.PropertyHolder
addProperty, getProperties, getProperty, properties
 

Constructor Detail

BehaviorMeta

public BehaviorMeta()

BehaviorMeta

public BehaviorMeta(String name)
Method Detail

writeXmlSimple

protected void writeXmlSimple(XmlWriter out)
Write an instance of this class out as xml.

Overrides:
writeXmlSimple in class ViewEntityMeta

addXmlRules

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


merge

public void merge(BehaviorMeta other)
Merge the data in the specified other property into this one, throwing an exception if there is an incompatibility. Not used right now since theorically there is very few inheritance on behaviors


setBehaviorId

public void setBehaviorId(String behaviorId)
Sets the behavior identifer for this component.


getBehaviorId

public String getBehaviorId()

addBehaviorClassModifier

public void addBehaviorClassModifier(int modifier)
Adds a Java Language class modifier to the behavior class.

TODO: what is this for????


getBehaviorClassModifiers

public int getBehaviorClassModifiers()
Returns the Java Language class modifiers for the behavior class. By default, these modifiers include Modifier.PUBLIC.

Returns:
the Java Language class modifiers for the behavior class

setBodyContent

public void setBodyContent(String bodyContent)

getBodyContent

public String getBodyContent()

setConfigExcluded

public void setConfigExcluded(Boolean configExcluded)

isConfigExcluded

public Boolean isConfigExcluded()

getBehaviorType

public String getBehaviorType()

setTagHandler

public void setTagHandler(String tagHandler)
Specifies the class of the Facelets tag handler (component handler) for this component.

Note that a Facelets tag handler class is not needed for most components.

Since:
1.0.9

getTagHandler

public String getTagHandler()
Since:
1.0.9

setEvaluateELOnExecution

public void setEvaluateELOnExecution(Boolean evaluateELOnExecution)
Since:
1.0.9

isEvaluateELOnExecution

public Boolean isEvaluateELOnExecution()
Since:
1.0.9

setGeneratedComponentClass

public void setGeneratedComponentClass(Boolean generatedComponentClass)
Since:
1.0.9

isGeneratedComponentClass

public Boolean isGeneratedComponentClass()
Since:
1.0.9

getPropertyTagList

public Collection getPropertyTagList()

getPropertyBehaviorList

public Collection getPropertyBehaviorList()


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