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

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

public class FaceletFunctionMeta
extends Object

Since:
1.0.10
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
FaceletFunctionMeta()
           
FaceletFunctionMeta(FaceletFunctionMeta 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 getDeclaredSignature()
           
 String getDescription()
           
 String getLongDescription()
           
 String getModelId()
          Indicates which "group" of metadata this class belongs to.
 String getName()
           
 String getSignature()
           
 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(FaceletFunctionMeta other)
          Merge the data in the specified other property into this one, throwing an exception if there is an incompatibility.
 void setDeclaredSignature(String signature)
           
 void setDescription(String desc)
           
 void setLongDescription(String desc)
           
 void setModelId(String modelId)
           
 void setName(String name)
          Set the name that users refer to this property by.
 void setSignature(String signature)
           
 void setSourceClassName(String sourceClassName)
           
protected  void writeXml(XmlWriter out)
           
static void writeXml(XmlWriter out, FaceletFunctionMeta 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

FaceletFunctionMeta

public FaceletFunctionMeta()

FaceletFunctionMeta

public FaceletFunctionMeta(FaceletFunctionMeta pm)
Method Detail

writeXml

protected void writeXml(XmlWriter out)

writeXml

public static void writeXml(XmlWriter out,
                            FaceletFunctionMeta 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(FaceletFunctionMeta other)
Merge the data in the specified other property into this one, throwing an exception if there is an incompatibility.


getModelId

public String getModelId()
Indicates which "group" of metadata this class belongs to.

Projects can inherit metadata from other projects, in which case all the ClassMeta objects end up in one big collection. But for some purposes it is necessary to iterate over the objects belonging to only one project (eg when generating components). This return value can be tested to check which "group" (project) a particular instance belongs to.


setModelId

public void setModelId(String modelId)

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()

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)

setSignature

public void setSignature(String signature)

getSignature

public String getSignature()

setDeclaredSignature

public void setDeclaredSignature(String signature)

getDeclaredSignature

public String getDeclaredSignature()


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