Module jakarta.faces

Package com.sun.faces.config.manager

Class FacesConfigInfo

java.lang.Object

com.sun.faces.config.manager.FacesConfigInfo

public class FacesConfigInfo
extends Object

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

Constructor Summary

Constructors

Constructor	Description
FacesConfigInfo(DocumentInfo documentInfo)	Creates a new WebInfFacesConfig document based on the provided Document.

Method Summary

Modifier and Type	Method	Description
List<String>	getAbsoluteOrdering()
boolean	isMetadataComplete()
boolean	isVersionGreaterOrEqual(double version)
boolean	isWebInfFacesConfig()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

FacesConfigInfo

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 representing the /WEB-INF/faces-config.xml

Method Details

isVersionGreaterOrEqual

public boolean isVersionGreaterOrEqual(double version)

Parameters:

version - version to check

Returns:

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

isWebInfFacesConfig

public boolean isWebInfFacesConfig()

Returns:

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

isMetadataComplete

public boolean isMetadataComplete()

Returns:

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

getAbsoluteOrdering

public List<String> getAbsoluteOrdering()

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.