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

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

public class WebConfigParamMeta
extends Object

Since:
1.0.4
Version:
$Revision: 796607 $ $Date: 2009-07-21 22:00:30 -0500 (mar, 21 jul 2009) $
Author:
Leonardo Uribe (latest modification by $Author: lu4242 $)

Constructor Summary
WebConfigParamMeta()
           
WebConfigParamMeta(WebConfigParamMeta 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 getDefaultValue()
          Returns the default value of this attribute.
 String getDescription()
           
 String getExpectedValues()
           
 String getFieldName()
           
 String getLongDescription()
           
 String getName()
           
 String getSince()
           
 String getSourceClassName()
          Return the className of the real java class from which this metadata was gathered.
 String getSourcePackageName()
          Utility method to return just the packagename part of the className attribute.
 void merge(WebConfigParamMeta other)
          Merge the data in the specified other property into this one, throwing an exception if there is an incompatibility.
 void setDefaultValue(String defaultValue)
          Sets the default value of this attribute.
 void setDescription(String desc)
           
 void setExpectedValues(String expectedValues)
           
 void setFieldName(String fieldName)
           
 void setLongDescription(String desc)
           
 void setName(String name)
          Set the name that users refer to this property by.
 void setSince(String since)
           
 void setSourceClassName(String sourceClassName)
           
static void writeXml(XmlWriter out, WebConfigParamMeta 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

WebConfigParamMeta

public WebConfigParamMeta()

WebConfigParamMeta

public WebConfigParamMeta(WebConfigParamMeta pm)
Method Detail

writeXml

public static void writeXml(XmlWriter out,
                            WebConfigParamMeta 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(WebConfigParamMeta 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()

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

setFieldName

public void setFieldName(String fieldName)

getFieldName

public String getFieldName()

setExpectedValues

public void setExpectedValues(String expectedValues)

getExpectedValues

public String getExpectedValues()

getSourcePackageName

public String getSourcePackageName()
Utility method to return just the packagename part of the className attribute.


getSourceClassName

public String getSourceClassName()
Return the className of the real java class from which this metadata was gathered.

This is mostly used for documentation. However when generating code in "template mode", this is used to locate the original class in order to find the source code to copy. It is also used for some reason in MakeComponentsMojo when determining whether to generate a class or not - this is probably wrong.


setSourceClassName

public void setSourceClassName(String sourceClassName)

getSince

public String getSince()

setSince

public void setSince(String since)


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