xdoclet.modules.jsf

Class FacesConfigXmlSubTask

Implemented Interfaces:
Serializable

public class FacesConfigXmlSubTask
extends xdoclet.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
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()
void
forAllSupportedLocales(String template)
String
getDefaultLocale()
String
getMessageBundle()
String
getSupportedLocale()
String
getSupportedLocales()
String
getVersion()
void
setDefaultLocale(String loc)
void
setMessageBundle(String bundle)
void
setSupportedLocales(String listOfLocales)
void
setVersion(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, copyAttributesFrom, engineFinished, engineStarted, execute, 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, startProcess, startProcessForAll, startProcessPerClass, validateOptions

Methods inherited from class xdoclet.SubTask

addConfigParam, copyAttributesFrom, execute, getConfigParams, getConfigParamsAsMap, getContext, getDestDir, getMergeDir, getSubTaskName, getXJavaDoc, init, setDestDir, setMergeDir, setSubTaskName, validateOptions

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

Constructor Details

FacesConfigXmlSubTask

public FacesConfigXmlSubTask()

Method Details

execute

public void execute()
            throws xdoclet.XDocletException
Overrides:
execute in interface xdoclet.TemplateSubTask

forAllSupportedLocales

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

getDefaultLocale

public String getDefaultLocale()

getMessageBundle

public String getMessageBundle()

getSupportedLocale

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

getSupportedLocales

public String getSupportedLocales()

getVersion

public String getVersion()

setDefaultLocale

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

setMessageBundle

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

setSupportedLocales

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

setVersion

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