Jakarta EE 11.0.0 · com.sun.faces.config.manager.Documents

Modifier and Type	Field and Description
private static final Logger	LOGGER

Access	Constructor and Description
public	Documents()

Method Summary

Modifier and Type	Method and Description
private static DOMImplementation	createDOMImplementation()
private static Document	createEmptyFacesConfigDocument(DOMImplementation domImpl)
public static List<DocumentInfo>	getProgrammaticDocuments(List<ApplicationConfigurationPopulator> configPopulators)
public static DocumentInfo[]	Returns: an array of `DocumentInfo`s getXMLDocuments(ServletContext the `ServletContext` for the application to be processed servletContext, List<ConfigurationResourceProvider> `List` of `ConfigurationResourceProvider` instances that provide the URL of the documents to parse. providers, ExecutorService the `ExecutorService` used to dispatch parse request to executor, boolean flag indicating whether or not the documents should be validated validating) Obtains an array of `Document`s to be processed
public static DocumentInfo[]	mergeDocuments(DocumentInfo[] facesDocuments, List<DocumentInfo> programmaticDocuments)
public static DocumentInfo[]	Returns: the sorted documents sortDocuments(DocumentInfo[] an array of all `faces-config` documents facesDocuments, FacesConfigInfo FacesConfigInfo representing the WEB-INF/faces-config.xml for this app webInfFacesConfig) Sort the `faces-config` documents found on the classpath and those specified by the `jakarta.faces.CONFIG_FILES` context init parameter.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

LOGGER	back to summary
private static final Logger LOGGER

Documents	back to summary
public Documents()

createDOMImplementation	back to summary
private static DOMImplementation createDOMImplementation() throws ParserConfigurationException

createEmptyFacesConfigDocument	back to summary
private static Document createEmptyFacesConfigDocument(DOMImplementation domImpl)

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

getXMLDocuments back to summary

getXMLDocuments	back to summary
public static DocumentInfo[] getXMLDocuments(ServletContext servletContext, List<ConfigurationResourceProvider> providers, ExecutorService executor, boolean validating) Obtains an array of `Document`s to be processed Parameters servletContext:ServletContext the `ServletContext` for the application to be processed providers:List<ConfigurationResourceProvider> `List` of `ConfigurationResourceProvider` instances that provide the URL of the documents to parse. executor:ExecutorService the `ExecutorService` used to dispatch parse request to validating:boolean flag indicating whether or not the documents should be validated Returns:DocumentInfo[] an array of `DocumentInfo`s

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

Obtains an array of Documents to be processed

Parameters

servletContext:ServletContext: the ServletContext for the application to be processed
providers:List<ConfigurationResourceProvider>: List of ConfigurationResourceProvider instances that provide the URL of the documents to parse.
executor:ExecutorService: the ExecutorService used to dispatch parse request to
validating:boolean: flag indicating whether or not the documents should be validated

an array of DocumentInfos

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

sortDocuments back to summary

sortDocuments	back to summary
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:DocumentInfo[] an array of all `faces-config` documents webInfFacesConfig:FacesConfigInfo FacesConfigInfo representing the WEB-INF/faces-config.xml for this app Returns:DocumentInfo[] the sorted documents

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:DocumentInfo[]: an array of all faces-config documents
webInfFacesConfig:FacesConfigInfo: FacesConfigInfo representing the WEB-INF/faces-config.xml for this app

the sorted documents