xdoclet.modules.jsf
Class FacesConfigXmlSubTask

java.lang.Object
  extended by xdoclet.DocletSupport
      extended by xdoclet.SubTask
          extended by xdoclet.TemplateSubTask
              extended by xdoclet.XmlSubTask
                  extended by xdoclet.modules.jsf.FacesConfigXmlSubTask
All Implemented Interfaces:
java.io.Serializable

public class FacesConfigXmlSubTask
extends XmlSubTask

Generate the faces.config.xml for Java Server Faces

Version:
$Revision: 1.2 $
Author:
Markus Plattner Date: 03.06.2004 Time: 14:15:27
See Also:
Serialized Form
ant.element
display-name = "Java Server Faces" name = "facesconfigxml" parent = "xdoclet.modules.web.WebDocletTask"
ant.attribute
name = "destDir" description = "the target directory for the faces-config.xml file" required = "true"
created
27. Juni 2004

Nested Class Summary
 
Nested classes/interfaces inherited from class xdoclet.TemplateSubTask
TemplateSubTask.ExtentTypes, TemplateSubTask.OfType
 
Field Summary
 
Fields inherited from class xdoclet.DocletSupport
currentClassTag, currentFieldTag, currentMethodTag
 
Constructor Summary
FacesConfigXmlSubTask()
           
 
Method Summary
 void execute()
          Describe what the method does
 void forAllSupportedLocales(java.lang.String template)
           
 java.lang.String getDefaultLocale()
           
 java.lang.String getMessageBundle()
           
 java.lang.String getSupportedLocale()
           
 java.lang.String getSupportedLocales()
           
 java.lang.String getVersion()
           
 void setDefaultLocale(java.lang.String loc)
           
 void setMessageBundle(java.lang.String bundle)
           
 void setSupportedLocales(java.lang.String listOfLocales)
           
 void setVersion(java.lang.String v)
           
 
Methods inherited from class xdoclet.XmlSubTask
copyAttributesFrom, engineFinished, getDtdURL, getPublicId, getSchema, getSchemaURL, getSystemId, getUseIds, getXmlencoding, isValidateXML, setDtdURL, setPublicId, setSchema, setSchemaURL, setSystemId, setUseIds, setValidateXML, setXmlencoding, startProcess
 
Methods inherited from class xdoclet.TemplateSubTask
addOfType, addOfType, addPackageSubstitution, engineStarted, generateForClass, getAcceptAbstractClasses, getAcceptInterfaces, getDestinationFile, getEngine, getExtent, getGeneratedFileName, getGenerationManager, getHavingClassTag, getOfType, getPackageSubstitutions, getSubTaskClassName, getTemplateURL, init, isPackageSubstitutionInheritanceSupported, isPrefixWithPackageStructure, javaFile, matchesGenerationRules, processInnerClasses, setAcceptAbstractClasses, setAcceptInterfaces, setDestinationFile, setEngine, setExtent, setExtentValue, setGenerationManager, setHavingClassTag, setOfType, setPackageSubstitutionInheritanceSupported, setPackageSubstitutions, setPrefixWithPackageStructure, setSubTaskClassName, setTemplateFile, setTemplateURL, startEngine, startProcessForAll, startProcessPerClass, validateOptions
 
Methods inherited from class xdoclet.SubTask
addConfigParam, getConfigParams, getConfigParamsAsMap, getContext, getDestDir, getMergeDir, getSubTaskName, getXJavaDoc, setDestDir, setMergeDir, setSubTaskName
 
Methods inherited from class xdoclet.DocletSupport
getCurrentClass, getCurrentClassTag, getCurrentConstructor, getCurrentField, getCurrentFieldTag, getCurrentMethod, getCurrentMethodTag, getCurrentPackage, getCurrentTag, isDocletGenerated, popCurrentClass, pushCurrentClass, setCurrentClass, setCurrentClassTag, setCurrentConstructor, setCurrentField, setCurrentFieldTag, setCurrentMethod, setCurrentMethodTag, setCurrentPackage
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

FacesConfigXmlSubTask

public FacesConfigXmlSubTask()
Method Detail

getVersion

public java.lang.String getVersion()

getDefaultLocale

public java.lang.String getDefaultLocale()

getMessageBundle

public java.lang.String getMessageBundle()

getSupportedLocales

public java.lang.String getSupportedLocales()

getSupportedLocale

public java.lang.String getSupportedLocale()
Returns:
doc.tag
type = "content"

setVersion

public void setVersion(java.lang.String v)
Parameters:
v -
ant.not-required
No.Defaultis "1.0".

setDefaultLocale

public void setDefaultLocale(java.lang.String loc)
Parameters:
loc -
ant.not-required
No.Ifnot specified,nobundle isused

setMessageBundle

public void setMessageBundle(java.lang.String bundle)
Parameters:
bundle -
ant.not-required
No.Ifnot specified,nobundle isused

setSupportedLocales

public void setSupportedLocales(java.lang.String listOfLocales)
Parameters:
listOfLocales -
ant.not-required
No.Ifnot specified,nobundle supportedlocalesare used

forAllSupportedLocales

public void forAllSupportedLocales(java.lang.String template)
                            throws XDocletException
Parameters:
template -
Throws:
XDocletException
doc.tag
type = "block"

execute

public void execute()
             throws XDocletException
Description copied from class: TemplateSubTask
Describe what the method does

Overrides:
execute in class TemplateSubTask
Throws:
XDocletException - Describe the exception

http://xdoclet.sourceforge.net/