Top Description Fields Constructors Methods
javax.faces.application

public abstract Class ApplicationWrapper

extends Application
implements FacesWrapper<Application>
Class Inheritance
All Implemented Interfaces
javax.faces.FacesWrapper
Imports
java.util.Collection, .Iterator, .Locale, .Map, .ResourceBundle, javax.el.ELContextListener, .ELException, .ELResolver, .ExpressionFactory, .ValueExpression, javax.faces.FacesException, .FacesWrapper, javax.faces.component.UIComponent, javax.faces.component.behavior.Behavior, javax.faces.component.search.SearchExpressionHandler, .SearchKeywordResolver, javax.faces.context.FacesContext, javax.faces.convert.Converter, javax.faces.el.MethodBinding, .PropertyResolver, .ReferenceSyntaxException, .ValueBinding, .VariableResolver, javax.faces.event.ActionListener, .SystemEvent, .SystemEventListener, javax.faces.flow.FlowHandler, javax.faces.validator.Validator

Provides a simple implementation of Application that can be subclassed by developers wishing to provide specialized behavior to an existing Application instance. The default implementation of all methods is to call through to the wrapped Application.

Usage: extend this class and push the implementation being wrapped to the constructor and use getWrapped to access the instance being wrapped.

Since
2.0

Field Summary

Modifier and TypeField and Description
private Application

Constructor Summary

AccessConstructor and Description
public
ApplicationWrapper()

Deprecated Use the other constructor taking the implementation being wrapped.
public
ApplicationWrapper(Application
The implementation being wrapped.
wrapped
)

If this application has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor.

Method Summary

Modifier and TypeMethod and Description
public void
addBehavior(String
The behavior id to be registered
behaviorId
,
String
The fully qualified class name of the corresponding Behavior implementation
behaviorClass
)

Overrides javax.faces.application.Application.addBehavior.

The default behavior of this method is to call Application#addBehavior(String, String) on the wrapped Application object.

public void
addComponent(String
The component type to be registered
componentType
,
String
The fully qualified class name of the corresponding UIComponent implementation
componentClass
)

Implements abstract javax.faces.application.Application.addComponent.

The default behavior of this method is to call Application#addComponent(String, String) on the wrapped Application object.

public void
addConverter(String
The converter id to be registered
converterId
,
String
The fully qualified class name of the corresponding Converter implementation
converterClass
)

Implements abstract javax.faces.application.Application.addConverter.

The default behavior of this method is to call Application#addConverter(String, String) on the wrapped Application object.

public void
addConverter(Class<?>
The class for which this converter is registered
targetClass
,
String
The fully qualified class name of the corresponding Converter implementation
converterClass
)

Implements abstract javax.faces.application.Application.addConverter.

The default behavior of this method is to call Application#addConverter(Class, String) on the wrapped Application object.

public void
addDefaultValidatorId(String
the validator id.
validatorId
)

Overrides javax.faces.application.Application.addDefaultValidatorId.

The default behavior of this method is to call Application#addDefaultValidatorId(String) on the wrapped Application object.

public void
addELContextListener(ELContextListener
the EL context listener to add.
listener
)

Overrides javax.faces.application.Application.addELContextListener.

The default behavior of this method is to call Application#addELContextListener(javax.el.ELContextListener) on the wrapped Application object.

public void
addELResolver(ELResolver
the EL resolver to add.
resolver
)

Overrides javax.faces.application.Application.addELResolver.

The default behavior of this method is to call Application#addELResolver(javax.el.ELResolver) on the wrapped Application object.

public void
addSearchKeywordResolver(SearchKeywordResolver
the SearchKeywordResolver to add.
resolver
)

Overrides javax.faces.application.Application.addSearchKeywordResolver.

Cause the argument resolver to be added to the head of the resolver chain.

public void
addValidator(String
The validator id to be registered
validatorId
,
String
The fully qualified class name of the corresponding Validator implementation
validatorClass
)

Implements abstract javax.faces.application.Application.addValidator.

The default behavior of this method is to call Application#addValidator(String, String) on the wrapped Application object.

public Behavior
createBehavior(String
The behavior id for which to create and return a new Behavior instance
behaviorId
)

Overrides javax.faces.application.Application.createBehavior.

The default behavior of this method is to call Application#createBehavior(String) on the wrapped Application object.

public UIComponent
createComponent(String
The component type for which to create and return a new UIComponent instance
componentType
)

Implements abstract javax.faces.application.Application.createComponent.

The default behavior of this method is to call Application#createComponent(String) on the wrapped Application object.

public UIComponent
createComponent(ValueBinding
ValueBinding representing a component value binding expression (typically specified by the component attribute of a custom tag)
componentBinding
,
FacesContext
FacesContext for the current request
context
,
String
Component type to create if the ValueBinding does not return a component instance
componentType
)

Implements abstract javax.faces.application.Application.createComponent.

Deprecated See superclass for alternative.

The default behavior of this method is to call Application#createComponent(javax.faces.el.ValueBinding, javax.faces.context.FacesContext, String) on the wrapped Application object.

public UIComponent
createComponent(ValueExpression
ValueExpression representing a component value expression (typically specified by the component attribute of a custom tag)
componentExpression
,
FacesContext
FacesContext for the current request
context
,
String
Component type to create if the ValueExpression does not return a component instance
componentType
)

Overrides javax.faces.application.Application.createComponent.

The default behavior of this method is to call Application#createComponent(javax.el.ValueExpression, javax.faces.context.FacesContext, String) on the wrapped Application object.

public UIComponent
createComponent(ValueExpression
ValueExpression representing a component value expression (typically specified by the component attribute of a custom tag)
componentExpression
,
FacesContext
FacesContext for the current request
context
,
String
Component type to create if the ValueExpression does not return a component instance
componentType
,
String
The renderer-type of the Renderer that will render this component. A null value must be accepted for this parameter.
rendererType
)

Overrides javax.faces.application.Application.createComponent.

The default behavior of this method is to call Application#createComponent(javax.el.ValueExpression, javax.faces.context.FacesContext, String, String) on the wrapped Application object.

public UIComponent
createComponent(FacesContext
FacesContext for the current request
context
,
String
Component type to create
componentType
,
String
The renderer-type of the Renderer that will render this component. A null value must be accepted for this parameter.
rendererType
)

Overrides javax.faces.application.Application.createComponent.

The default behavior of this method is to call Application#createComponent(javax.faces.context.FacesContext, String, String) on the wrapped Application object.

public UIComponent
createComponent(FacesContext
FacesContext for the current request
context
,
Resource
A Resource that points to a source file that provides an implementation of a component.
componentResource
)

Overrides javax.faces.application.Application.createComponent.

The default behavior of this method is to call Application#createComponent(javax.faces.context.FacesContext, Resource) on the wrapped Application object.

public Converter<T>
createConverter(String
The converter id for which to create and return a new Converter instance
converterId
)

Implements abstract javax.faces.application.Application.createConverter.

The default behavior of this method is to call Application#createConverter(String) on the wrapped Application object.

public Converter<T>
createConverter(Class<?>
Target class for which to return a Converter
targetClass
)

Implements abstract javax.faces.application.Application.createConverter.

The default behavior of this method is to call Application#createConverter(Class) on the wrapped Application object.

public MethodBinding
createMethodBinding(String
Method binding expression for which to return a MethodBinding instance
ref
,
Class<?>[]
Parameter signatures that must be compatible with those of the method to be invoked, or a zero-length array or null for a method that takes no parameters
params
)

Implements abstract javax.faces.application.Application.createMethodBinding.

Deprecated See superclass for alternative.

The default behavior of this method is to call Application#createMethodBinding(String, Class[]) on the wrapped Application object.

public Validator<T>
createValidator(String
The validator id for which to create and return a new Validator instance
validatorId
)

Implements abstract javax.faces.application.Application.createValidator.

The default behavior of this method is to call Application#createValidator(String) on the wrapped Application object.

public ValueBinding
createValueBinding(String
Value binding expression for which to return a ValueBinding instance
ref
)

Implements abstract javax.faces.application.Application.createValueBinding.

Deprecated as a consequence of ValueBinding being deprecated.

The default behavior of this method is to call Application#createValueBinding(String) on the wrapped Application object.

public <T> T
evaluateExpressionGet(FacesContext
the Faces context.
context
,
String
the expression.
expression
,
Class<? extends T>
the expected type.
expectedType
)

Overrides javax.faces.application.Application.evaluateExpressionGet.

Deprecated See superclass for alternative.

The default behavior of this method is to call Application#evaluateExpressionGet(javax.faces.context.FacesContext, String, Class) on the wrapped Application object.

public ActionListener
getActionListener()

Implements abstract javax.faces.application.Application.getActionListener.

The default behavior of this method is to call Application#getActionListener on the wrapped Application object.

public Iterator<String>
getBehaviorIds()

Overrides javax.faces.application.Application.getBehaviorIds.

The default behavior of this method is to call Application#getBehaviorIds on the wrapped Application object.

public Iterator<String>
getComponentTypes()

Implements abstract javax.faces.application.Application.getComponentTypes.

The default behavior of this method is to call Application#getComponentTypes on the wrapped Application object.

public Iterator<String>
getConverterIds()

Implements abstract javax.faces.application.Application.getConverterIds.

The default behavior of this method is to call Application#getConverterIds on the wrapped Application object.

public Iterator<Class<?>>
getConverterTypes()

Implements abstract javax.faces.application.Application.getConverterTypes.

The default behavior of this method is to call Application#getConverterTypes on the wrapped Application object.

public Locale
getDefaultLocale()

Implements abstract javax.faces.application.Application.getDefaultLocale.

The default behavior of this method is to call Application#getDefaultLocale on the wrapped Application object.

public String
getDefaultRenderKitId()

Implements abstract javax.faces.application.Application.getDefaultRenderKitId.

The default behavior of this method is to call Application#getDefaultRenderKitId on the wrapped Application object.

public Map<String, String>
getDefaultValidatorInfo()

Overrides javax.faces.application.Application.getDefaultValidatorInfo.

The default behavior of this method is to call Application#getDefaultValidatorInfo on the wrapped Application object.

public ELContextListener[]
getELContextListeners()

Overrides javax.faces.application.Application.getELContextListeners.

The default behavior of this method is to call Application#getELContextListeners on the wrapped Application object.

public ELResolver
getELResolver()

Overrides javax.faces.application.Application.getELResolver.

The default behavior of this method is to call Application#getELResolver on the wrapped Application object.

public ExpressionFactory
getExpressionFactory()

Overrides javax.faces.application.Application.getExpressionFactory.

The default behavior of this method is to call Application#getExpressionFactory on the wrapped Application object.

public FlowHandler
getFlowHandler()

Overrides javax.faces.application.Application.getFlowHandler.

Return the thread-safe singleton FlowHandler for this application.

public String
getMessageBundle()

Implements abstract javax.faces.application.Application.getMessageBundle.

The default behavior of this method is to call Application#getMessageBundle on the wrapped Application object.

public NavigationHandler
getNavigationHandler()

Implements abstract javax.faces.application.Application.getNavigationHandler.

The default behavior of this method is to call Application#getNavigationHandler on the wrapped Application object.

public ProjectStage
getProjectStage()

Overrides javax.faces.application.Application.getProjectStage.

The default behavior of this method is to call Application#getProjectStage on the wrapped Application object.

public PropertyResolver
getPropertyResolver()

Implements abstract javax.faces.application.Application.getPropertyResolver.

Deprecated See superclass for alternative.

The default behavior of this method is to call Application#getPropertyResolver on the wrapped Application object.

public ResourceBundle
getResourceBundle(FacesContext
the Faces context.
ctx
,
String
the name of the resource bundle.
name
)

Overrides javax.faces.application.Application.getResourceBundle.

The default behavior of this method is to call Application#getResourceBundle(javax.faces.context.FacesContext, String) on the wrapped Application object.

public ResourceHandler
getResourceHandler()

Overrides javax.faces.application.Application.getResourceHandler.

The default behavior of this method is to call Application#getResourceHandler on the wrapped Application object.

public SearchExpressionHandler
public SearchKeywordResolver
getSearchKeywordResolver()

Overrides javax.faces.application.Application.getSearchKeywordResolver.

Return the singleton SearchKeywordResolver instance to be used for all search keyword resolution.

public StateManager
getStateManager()

Implements abstract javax.faces.application.Application.getStateManager.

The default behavior of this method is to call Application#getStateManager on the wrapped Application object.

public Iterator<Locale>
getSupportedLocales()

Implements abstract javax.faces.application.Application.getSupportedLocales.

The default behavior of this method is to call Application#getSupportedLocales on the wrapped Application object.

public Iterator<String>
getValidatorIds()

Implements abstract javax.faces.application.Application.getValidatorIds.

The default behavior of this method is to call Application#getValidatorIds on the wrapped Application object.

public VariableResolver
getVariableResolver()

Implements abstract javax.faces.application.Application.getVariableResolver.

Deprecated See superclass for alternative.

The default behavior of this method is to call Application#getVariableResolver on the wrapped Application object.

public ViewHandler
getViewHandler()

Implements abstract javax.faces.application.Application.getViewHandler.

The default behavior of this method is to call Application#getViewHandler on the wrapped Application object.

public Application
getWrapped()

Implements javax.faces.FacesWrapper.getWrapped.

A class that implements this interface uses this method to return an instance of the class being wrapped.

public void
publishEvent(FacesContext
the FacesContext for the current request
context
,
Class<? extends SystemEvent>
The Class of event that is being published.
systemEventClass
,
Object
The source for the event of type systemEventClass.
source
)

Overrides javax.faces.application.Application.publishEvent.

The default behavior of this method is to call Application#publishEvent(javax.faces.context.FacesContext, Class, Object) on the wrapped Application object.

public void
publishEvent(FacesContext
the FacesContext for the current request
context
,
Class<? extends SystemEvent>
The Class of event that is being published.
systemEventClass
,
Class<?>
The Class of the source event that must be used to lookup the listener to which this event must be published. If this argument is null the return from source.getClass() must be used as the sourceBaseType.
sourceBaseType
,
Object
The source for the event of type systemEventClass.
source
)

Overrides javax.faces.application.Application.publishEvent.

The default behavior of this method is to call Application#publishEvent(javax.faces.context.FacesContext, Class, Class, Object) on the wrapped Application object.

public void
removeELContextListener(ELContextListener
the EL context listener to remove.
listener
)

Overrides javax.faces.application.Application.removeELContextListener.

The default behavior of this method is to call Application#removeELContextListener(javax.el.ELContextListener) on the wrapped Application object.

public void
setActionListener(ActionListener
The new default ActionListener
listener
)

Implements abstract javax.faces.application.Application.setActionListener.

The default behavior of this method is to call Application#setActionListener(javax.faces.event.ActionListener) on the wrapped Application object.

public void
setDefaultLocale(Locale
The new default Locale
locale
)

Implements abstract javax.faces.application.Application.setDefaultLocale.

The default behavior of this method is to call Application#setDefaultLocale(java.util.Locale) on the wrapped Application object.

public void
setDefaultRenderKitId(String
the render kit id to set.
renderKitId
)

Implements abstract javax.faces.application.Application.setDefaultRenderKitId.

The default behavior of this method is to call Application#setDefaultRenderKitId(String) on the wrapped Application object.

public void
setFlowHandler(FlowHandler
the flow handler to set.
newHandler
)

Overrides javax.faces.application.Application.setFlowHandler.

Set the FlowHandler instance used by the NavigationHandler to satisfy the requirements of the faces flows feature.

public void
setMessageBundle(String
Base name of the resource bundle to be used
bundle
)

Implements abstract javax.faces.application.Application.setMessageBundle.

The default behavior of this method is to call Application#setMessageBundle(String) on the wrapped Application object.

public void
setNavigationHandler(NavigationHandler
The new NavigationHandler instance
handler
)

Implements abstract javax.faces.application.Application.setNavigationHandler.

The default behavior of this method is to call Application#setNavigationHandler(NavigationHandler) on the wrapped Application object.

public void
setPropertyResolver(PropertyResolver
The new PropertyResolver instance
resolver
)

Implements abstract javax.faces.application.Application.setPropertyResolver.

Deprecated See superclass for alternative.

The default behavior of this method is to call Application#setPropertyResolver(javax.faces.el.PropertyResolver) on the wrapped Application object.

public void
setResourceHandler(ResourceHandler
The new ResourceHandler instance
resourceHandler
)

Overrides javax.faces.application.Application.setResourceHandler.

The default behavior of this method is to call Application#setResourceHandler(ResourceHandler) on the wrapped Application object.

public void
public void
setStateManager(StateManager
The new StateManager instance
manager
)

Implements abstract javax.faces.application.Application.setStateManager.

The default behavior of this method is to call Application#setStateManager(StateManager) on the wrapped Application object.

public void
setSupportedLocales(Collection<Locale>
The set of supported Locales for this application
locales
)

Implements abstract javax.faces.application.Application.setSupportedLocales.

The default behavior of this method is to call Application#setSupportedLocales(java.util.Collection) on the wrapped Application object.

public void
setVariableResolver(VariableResolver
The new VariableResolver instance
resolver
)

Implements abstract javax.faces.application.Application.setVariableResolver.

Deprecated See superclass for alternative.

The default behavior of this method is to call Application#setVariableResolver(javax.faces.el.VariableResolver) on the wrapped Application object.

public void
setViewHandler(ViewHandler
The new ViewHandler instance
handler
)

Implements abstract javax.faces.application.Application.setViewHandler.

The default behavior of this method is to call Application#setViewHandler(ViewHandler) on the wrapped Application object.

public void
subscribeToEvent(Class<? extends SystemEvent>
the Class of event for which listener must be fired.
systemEventClass
,
Class<?>
the Class of the instance which causes events of type systemEventClass to be fired. May be null.
sourceClass
,
SystemEventListener
the implementation of javax.faces.event.SystemEventListener whose javax.faces.event.SystemEventListener#processEvent method must be called when events of type systemEventClass are fired.
listener
)

Overrides javax.faces.application.Application.subscribeToEvent.

The default behavior of this method is to call Application#subscribeToEvent(Class, Class, javax.faces.event.SystemEventListener) on the wrapped Application object.

public void
subscribeToEvent(Class<? extends SystemEvent>
the Class of event for which listener must be fired.
systemEventClass
,
SystemEventListener
the implementation of javax.faces.event.SystemEventListener whose javax.faces.event.SystemEventListener#processEvent method must be called when events of type systemEventClass are fired.

See subscribeToEvent(java.lang.Class, java.lang.Class, javax.faces.event.SystemEventListener) for an additional requirement regarding when it is valid to call this method.

listener
)

Overrides javax.faces.application.Application.subscribeToEvent.

The default behavior of this method is to call Application#subscribeToEvent(Class, javax.faces.event.SystemEventListener) on the wrapped Application object.

public void
unsubscribeFromEvent(Class<? extends SystemEvent>
the Class of event for which listener must be fired.
systemEventClass
,
Class<?>
the Class of the instance which causes events of type systemEventClass to be fired. May be null.
sourceClass
,
SystemEventListener
the implementation of javax.faces.event.SystemEventListener to remove from the internal data structure.
listener
)

Overrides javax.faces.application.Application.unsubscribeFromEvent.

The default behavior of this method is to call Application#unsubscribeFromEvent(Class, Class, javax.faces.event.SystemEventListener) on the wrapped Application object.

public void
unsubscribeFromEvent(Class<? extends SystemEvent>
the Class of event for which listener must be fired.
systemEventClass
,
SystemEventListener
the implementation of javax.faces.event.SystemEventListener to remove from the internal data structure.
listener
)

Overrides javax.faces.application.Application.unsubscribeFromEvent.

The default behavior of this method is to call Application#unsubscribeFromEvent(Class, javax.faces.event.SystemEventListener) on the wrapped Application object.