Module jakarta.faces

Package com.sun.faces.config.manager

Class Documents

java.lang.Object

com.sun.faces.config.manager.Documents

public class Documents
extends Object

Constructor Summary

Constructors

Constructor	Description
Documents()

Method Summary

Modifier and Type	Method	Description
static List<DocumentInfo>	getProgrammaticDocuments(List<ApplicationConfigurationPopulator> configPopulators)
static DocumentInfo[]	getXMLDocuments(ServletContext servletContext, List<ConfigurationResourceProvider> providers, ExecutorService executor, boolean validating)	Obtains an array of Documents to be processed
static DocumentInfo[]	mergeDocuments(DocumentInfo[] facesDocuments, List<DocumentInfo> programmaticDocuments)
static DocumentInfo[]	sortDocuments(DocumentInfo[] facesDocuments, FacesConfigInfo webInfFacesConfig)	Sort the faces-config documents found on the classpath and those specified by the jakarta.faces.CONFIG_FILES context init parameter.

Methods inherited from class java.lang.Object

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

Constructor Details

Documents

public Documents()

Method Details

getXMLDocuments

public static DocumentInfo[] getXMLDocuments(ServletContext servletContext,
 List<ConfigurationResourceProvider> providers,
 ExecutorService executor,
 boolean validating)

Obtains an array of Documents to be processed

Parameters:

servletContext - the ServletContext for the application to be processed

providers - List of ConfigurationResourceProvider instances that provide the URL of the documents to parse.

executor - the ExecutorService used to dispatch parse request to

validating - flag indicating whether or not the documents should be validated

Returns:

an array of DocumentInfos

getProgrammaticDocuments

public static List<DocumentInfo> getProgrammaticDocuments(List<ApplicationConfigurationPopulator> configPopulators)
                                                   throws ParserConfigurationException

Throws:

ParserConfigurationException

mergeDocuments

public static DocumentInfo[] mergeDocuments(DocumentInfo[] facesDocuments,
 List<DocumentInfo> programmaticDocuments)

sortDocuments

public static DocumentInfo[] sortDocuments(DocumentInfo[] facesDocuments,
 FacesConfigInfo webInfFacesConfig)

Sort the faces-config documents found on the classpath and those specified by the jakarta.faces.CONFIG_FILES context init parameter.

Parameters:

facesDocuments - an array of all faces-config documents

webInfFacesConfig - FacesConfigInfo representing the WEB-INF/faces-config.xml for this app

Returns:

the sorted documents