Top Description Fields Constructors Methods
com.sun.faces.config.manager

public Class FacesConfigInfo

extends Object
Class Inheritance
Static Imports
com.sun.faces.util.Util.isEmpty, java.util.Collections.unmodifiableList

Wrapper around the /WEB-INF/faces-config.xml, if present, to expose information relevant to the intialization of the runtime.

Field Summary

Modifier and TypeField and Description
private static final String
ABSOLUTE_ORDERING

private List<String>
absoluteOrdering

private boolean
isWebInfFacesConfig

private static final Logger
LOGGER

private boolean
metadataComplete

private static final String
NAME

private static final String
ORDERING

private static final String
OTHERS

private double
version

Constructor Summary

AccessConstructor and Description
public
FacesConfigInfo(DocumentInfo
DocumentInfo representing the /WEB-INF/faces-config.xml
documentInfo)

Creates a new WebInfFacesConfig document based on the provided Document.

Method Summary

Modifier and TypeMethod and Description
private void
extractOrdering(Document document)

public List<String>

Returns:

a List of document names that in the order that they should be processed. The presense of the keyword "others" indicates all documents not explicitly referenced by name in the list should be places in the final parsing order at same location. If there are multiple documents that aren't named and the others element is present, the order that these documents are inserted into the final list is unspecified at this time.
getAbsoluteOrdering()

private String
getNodeText(Node node)

Return the textual content, if any, of the provided Node.

private double

Returns:

return the value of the version attribute of the provided document. If no version attribute is specified, assume 1.1.
getVersion(Document
document representing WEB-INF/faces-config.xml
document)

public boolean

Returns:

true if the Document provided at construction time represents the /WEB-INF/faces-config.xml and is metadata complete.
isMetadataComplete()

private boolean
isMetadataComplete(Document document)

public boolean

Returns:

true if version is greater or equal to the version of the /WEB-INF/faces-config.xml
isVersionGreaterOrEqual(double
version to check
version)

public boolean

Returns:

true if the Document provided at construction time represents the /WEB-INF/faces-config.xml.
isWebInfFacesConfig()

private boolean

Returns:

true if the document represents the /WEB-INF/faces-config.xml
isWebinfFacesConfig(Document
the Document to inspect
document)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

ABSOLUTE_ORDERINGback to summary
private static final String ABSOLUTE_ORDERING
absoluteOrderingback to summary
private List<String> absoluteOrdering
isWebInfFacesConfigback to summary
private boolean isWebInfFacesConfig
LOGGERback to summary
private static final Logger LOGGER
metadataCompleteback to summary
private boolean metadataComplete
NAMEback to summary
private static final String NAME
ORDERINGback to summary
private static final String ORDERING
OTHERSback to summary
private static final String OTHERS
versionback to summary
private double version

Constructor Detail

FacesConfigInfoback to summary
public FacesConfigInfo(DocumentInfo documentInfo)

Creates a new WebInfFacesConfig document based on the provided Document. If the Document does not represent the WEB-INF/faces-config.xml the isWebInfFacesConfig() method will return false

Parameters
documentInfo:DocumentInfo

DocumentInfo representing the /WEB-INF/faces-config.xml

Method Detail

extractOrderingback to summary
private void extractOrdering(Document document)
getAbsoluteOrderingback to summary
public List<String> getAbsoluteOrdering()
Returns:List<String>

a List of document names that in the order that they should be processed. The presense of the keyword "others" indicates all documents not explicitly referenced by name in the list should be places in the final parsing order at same location. If there are multiple documents that aren't named and the others element is present, the order that these documents are inserted into the final list is unspecified at this time.

getNodeTextback to summary
private String getNodeText(Node node)

Return the textual content, if any, of the provided Node.

getVersionback to summary
private double getVersion(Document document)
Parameters
document:Document

document representing WEB-INF/faces-config.xml

Returns:double

return the value of the version attribute of the provided document. If no version attribute is specified, assume 1.1.

isMetadataCompleteback to summary
public boolean isMetadataComplete()
Returns:boolean

true if the Document provided at construction time represents the /WEB-INF/faces-config.xml and is metadata complete.

isMetadataCompleteback to summary
private boolean isMetadataComplete(Document document)
isVersionGreaterOrEqualback to summary
public boolean isVersionGreaterOrEqual(double version)
Parameters
version:double

version to check

Returns:boolean

true if version is greater or equal to the version of the /WEB-INF/faces-config.xml

isWebInfFacesConfigback to summary
public boolean isWebInfFacesConfig()
Returns:boolean

true if the Document provided at construction time represents the /WEB-INF/faces-config.xml.

isWebinfFacesConfigback to summary
private boolean isWebinfFacesConfig(Document document)
Parameters
document:Document

the Document to inspect

Returns:boolean

true if the document represents the /WEB-INF/faces-config.xml