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

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.ConverterMeta
All Implemented Interfaces:
PropertyHolder

public class ConverterMeta
extends ViewEntityMeta
implements PropertyHolder

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

A converter can be used in three ways:


Constructor Summary
ConverterMeta()
           
 
Method Summary
 void addConverterClassModifier(int modifier)
          Adds a Java Language class modifier to the converter 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.
 String getBodyContent()
           
 int getConverterClassModifiers()
          Returns the Java Language class modifiers for the converter class.
 String getConverterId()
           
 Collection getPropertyConverterList()
           
 Collection getPropertyTagList()
           
 String getSerialuidtag()
           
 String getTagClass()
           
 String getTagHandler()
           
 String getTagSuperclass()
           
 Boolean isConfigExcluded()
           
 Boolean isEvaluateELOnExecution()
           
 Boolean isGeneratedComponentClass()
           
 Boolean isGeneratedTagClass()
           
 void merge(ConverterMeta other)
          Merge the data in the specified other property into this one, throwing an exception if there is an incompatibility.
 void setBodyContent(String bodyContent)
           
 void setConfigExcluded(Boolean configExcluded)
           
 void setConverterId(String converterId)
          Sets the converter identifer for this component.
 void setEvaluateELOnExecution(Boolean evaluateELOnExecution)
           
 void setGeneratedComponentClass(Boolean generatedComponentClass)
           
 void setGeneratedTagClass(Boolean generatedTagClass)
           
 void setSerialuidtag(String serialuidtag)
           
 void setTagClass(String tagClass)
          Sets the JSP tag handler class for this component.
 void setTagHandler(String tagHandler)
          Specifies the class of the Facelets tag handler (component handler) for this component.
 void setTagSuperclass(String tagSuperclass)
          Sets the JSP tag handler superclass 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

ConverterMeta

public ConverterMeta()
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(ConverterMeta 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 converters


setConverterId

public void setConverterId(String converterId)
Sets the converter identifer for this component.


getConverterId

public String getConverterId()

addConverterClassModifier

public void addConverterClassModifier(int modifier)
Adds a Java Language class modifier to the converter class.

TODO: what is this for????


getConverterClassModifiers

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

Returns:
the Java Language class modifiers for the converter class

setBodyContent

public void setBodyContent(String bodyContent)

getBodyContent

public String getBodyContent()

setTagClass

public void setTagClass(String tagClass)
Sets the JSP tag handler class for this component.


getTagClass

public String getTagClass()

setTagSuperclass

public void setTagSuperclass(String tagSuperclass)
Sets the JSP tag handler superclass for this component.


getTagSuperclass

public String getTagSuperclass()

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

getTagHandler

public String getTagHandler()
Since:
1.0.8

setSerialuidtag

public void setSerialuidtag(String serialuidtag)

getSerialuidtag

public String getSerialuidtag()

setGeneratedComponentClass

public void setGeneratedComponentClass(Boolean generatedComponentClass)
Since:
1.0.8

isGeneratedComponentClass

public Boolean isGeneratedComponentClass()
Since:
1.0.8

setGeneratedTagClass

public void setGeneratedTagClass(Boolean generatedTagClass)

isGeneratedTagClass

public Boolean isGeneratedTagClass()

setConfigExcluded

public void setConfigExcluded(Boolean configExcluded)

isConfigExcluded

public Boolean isConfigExcluded()

setEvaluateELOnExecution

public void setEvaluateELOnExecution(Boolean evaluateELOnExecution)
Since:
1.0.8

isEvaluateELOnExecution

public Boolean isEvaluateELOnExecution()
Since:
1.0.8

getPropertyTagList

public Collection getPropertyTagList()

getPropertyConverterList

public Collection getPropertyConverterList()
Since:
1.0.8


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