facesconfigxml

Generate the faces.config.xml for Java Server Faces

Implementing Class

xdoclet.modules.jsf.FacesConfigXmlSubTask

Attributes

Attribute Description Required
destDir the target directory for the faces-config.xml file true
version No.Defaultis "1.0".
defaultLocale No.Ifnot specified,nobundle isused
messageBundle No.Ifnot specified,nobundle isused
supportedLocales No.Ifnot specified,nobundle supportedlocalesare used
useIds If this attribute is set to true, XDoclet will generate id attributes in the XML document. Note that this is only available in some subtasks. "No. Default is 'false'"
xmlencoding The encoding of the produced xml file. If your XML file uses international characters, you might want to set this to "ISO-8859-1". "No, default is 'UTF-8'"
schema The XML Schema to which the generated document should conform. No.
validateXML If this is set to true, the generated XML will be validated against its DTD or XML Schema. No,defaultis false.
acceptInterfaces Indicates whether or not to generate for interfaces. "No, default is 'true'"
acceptAbstractClasses Indicates whether or not to generate for abstract classes. "No, default is 'true'"
packageSubstitutions Sets the PackageSubstitutions attribute of the TemplateSubTask object No.
packageSubstitutionInheritanceSupported Indicates whether or not package substitution should be inherited "No, default is 'true'"
prefixWithPackageStructure Indicates whether or not to prefix with package structure. "No, default is 'true'"
destinationFile The destination file name. If a {0} is found it's assumed that a per class output generation is needed, so {0} is substituted with class name; otherwise a single file is generated with the specified name. No,defaultis determinedbythis task.
templateFile Sets the name of the template file to use for generation No,defaultis determinedbythis task.
havingClassTag Sets the HavingClassTag attribute of the TemplateSubTask object No.
ofType No.
subTaskName Sets an optional name for the subtask that will be seen in XDoclet's debug messages. No.
destDir Sets the directory where the generated file(s) will be written. No.
mergeDir Specifies the location of the merge directory. This is where XDoclet will look for merge files. No.

Merge Files

File name Description Relates to
jsf-beans.xml An XML document containing the optional backing beans. faces-config.xml
jsf-navigations.xml An XML document containing the additional navigation rules. faces-config.xml
jsf-validators.xml An XML document containing additional validator configurations. faces-config.xml
jsf-application.xml An XML document containing application level settings (language resources). faces-config.xml
jsf-converters.xml An XML document containing additional converters. faces-config.xml

Nested Elements

Element Description
configParam Specifies a configuration parameter for the subtask.
ofType
packageSubstitution Substitutes the package of the generated files.