org.omnifaces.config

Enum FacesConfigXml

java.lang.Object

java.lang.Enum<FacesConfigXml>

org.omnifaces.config.FacesConfigXml

All Implemented Interfaces:

Serializable, Comparable<FacesConfigXml>

public enum FacesConfigXml
extends Enum<FacesConfigXml>

This configuration enum parses the /WEB-INF/faces-config.xml and all /META-INF/faces-config.xml files found in the classpath and offers methods to obtain information from them which is not available by the standard JSF API.

Usage

Some examples:

 // Get a mapping of all <resource-bundle> vars and base names.
 Map<String, String> resourceBundles = FacesConfigXml.INSTANCE.getResourceBundles();
 

 // Get an ordered list of all <supported-locale> values with <default-locale> as first item.
 List<Locale> supportedLocales = FacesConfigXml.INSTANCE.getSupportedLocales();
 

Since:

2.1

Author:

Bauke Scholtz, Michele Mariotti

Enum Constant Summary

Enum Constants

Enum Constant and Description
INSTANCE Returns the lazily loaded enum singleton instance.

Method Summary

Modifier and Type	Method and Description
Map<String,String>	getResourceBundles() Returns a mapping of all resource bundle base names by var.
List<Locale>	getSupportedLocales() Returns an ordered list of all supported locales on this application, with the default locale as the first item, if any.
FacesConfigXml	init(ServletContext servletContext) Perform manual initialization with the given servlet context, if not null and not already initialized yet.
static FacesConfigXml	valueOf(String name) Returns the enum constant of this type with the specified name.
static FacesConfigXml[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INSTANCE

public static final FacesConfigXml INSTANCE

Returns the lazily loaded enum singleton instance.

Note: if this is needed in e.g. a Filter which is called before the FacesServlet is invoked, then it won't work if the INSTANCE hasn't been referenced before. Since JSF installs a special "init" FacesContext during startup, one option for doing this initial referencing is in a ServletContextListener. The data this enum encapsulates will then be available even where there is no FacesContext available. If there's no other option, then you need to manually invoke init(ServletContext) whereby you pass the desired ServletContext.

Method Detail

values

public static FacesConfigXml[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (FacesConfigXml c : FacesConfigXml.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static FacesConfigXml valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

init

public FacesConfigXml init(ServletContext servletContext)

Perform manual initialization with the given servlet context, if not null and not already initialized yet.

Parameters:

servletContext - The servlet context to obtain the faces-config.xml from.

Returns:

The current FacesConfigXml instance, initialized and all.

getResourceBundles

public Map<String,String> getResourceBundles()

Returns a mapping of all resource bundle base names by var.

Returns:

A mapping of all resource bundle base names by var.

getSupportedLocales

public List<Locale> getSupportedLocales()

Returns an ordered list of all supported locales on this application, with the default locale as the first item, if any. This will return an empty list if there are no locales definied in faces-config.xml.

Returns:

An ordered list of all supported locales on this application, with the default locale as the first item, if any.

Since:

2.2

See Also:

Application.getDefaultLocale(), Application.getSupportedLocales()