public abstract class ApplicationWrapper extends Application implements FacesWrapper<Application>
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.
Constructor and Description |
---|
ApplicationWrapper()
Deprecated.
Use the other constructor taking the implementation being wrapped.
|
ApplicationWrapper(Application wrapped)
If this application has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor. |
Modifier and Type | Method and Description |
---|---|
void |
addBehavior(java.lang.String behaviorId,
java.lang.String behaviorClass)
The default behavior of this method is to call |
void |
addComponent(java.lang.String componentType,
java.lang.String componentClass)
The default behavior of this method is to call |
void |
addConverter(java.lang.Class<?> targetClass,
java.lang.String converterClass)
The default behavior of this method is to call |
void |
addConverter(java.lang.String converterId,
java.lang.String converterClass)
The default behavior of this method is to call |
void |
addDefaultValidatorId(java.lang.String validatorId)
The default behavior of this method is to call |
void |
addELContextListener(ELContextListener listener)
The default behavior of this method is to call |
void |
addELResolver(ELResolver resolver)
The default behavior of this method is to call
|
void |
addSearchKeywordResolver(SearchKeywordResolver resolver)
Cause the argument |
void |
addValidator(java.lang.String validatorId,
java.lang.String validatorClass)
The default behavior of this method is to call |
Behavior |
createBehavior(java.lang.String behaviorId)
The default behavior of this method is to call |
UIComponent |
createComponent(FacesContext context,
Resource componentResource)
The default behavior of this method is to call
|
UIComponent |
createComponent(FacesContext context,
java.lang.String componentType,
java.lang.String rendererType)
The default behavior of this method is to call
|
UIComponent |
createComponent(java.lang.String componentType)
The default behavior of this method is to call |
UIComponent |
createComponent(ValueBinding componentBinding,
FacesContext context,
java.lang.String componentType)
Deprecated.
See superclass for alternative.
|
UIComponent |
createComponent(ValueExpression componentExpression,
FacesContext context,
java.lang.String componentType)
The default behavior of this method is to call
|
UIComponent |
createComponent(ValueExpression componentExpression,
FacesContext context,
java.lang.String componentType,
java.lang.String rendererType)
The default behavior of this method is to call
|
Converter |
createConverter(java.lang.Class<?> targetClass)
The default behavior of this method is to call |
Converter |
createConverter(java.lang.String converterId)
The default behavior of this method is to call |
MethodBinding |
createMethodBinding(java.lang.String ref,
java.lang.Class<?>[] params)
Deprecated.
See superclass for alternative.
|
Validator |
createValidator(java.lang.String validatorId)
The default behavior of this method is to call |
ValueBinding |
createValueBinding(java.lang.String ref)
The default behavior of this method is to call |
<T> T |
evaluateExpressionGet(FacesContext context,
java.lang.String expression,
java.lang.Class<? extends T> expectedType)
Deprecated.
See superclass for alternative.
|
ActionListener |
getActionListener()
The default behavior of this method is to call |
java.util.Iterator<java.lang.String> |
getBehaviorIds()
The default behavior of this method is to call |
java.util.Iterator<java.lang.String> |
getComponentTypes()
The default behavior of this method is to call |
java.util.Iterator<java.lang.String> |
getConverterIds()
The default behavior of this method is to call |
java.util.Iterator<java.lang.Class<?>> |
getConverterTypes()
The default behavior of this method is to call |
java.util.Locale |
getDefaultLocale()
The default behavior of this method is to call |
java.lang.String |
getDefaultRenderKitId()
The default behavior of this method is to call |
java.util.Map<java.lang.String,java.lang.String> |
getDefaultValidatorInfo()
The default behavior of this method is to call |
ELContextListener[] |
getELContextListeners()
The default behavior of this method is to call |
ELResolver |
getELResolver()
The default behavior of this method is to call |
ExpressionFactory |
getExpressionFactory()
The default behavior of this method is to call |
FlowHandler |
getFlowHandler()
Return the thread-safe singleton |
java.lang.String |
getMessageBundle()
The default behavior of this method is to call |
NavigationHandler |
getNavigationHandler()
The default behavior of this method is to call |
ProjectStage |
getProjectStage()
The default behavior of this method is to call |
PropertyResolver |
getPropertyResolver()
Deprecated.
See superclass for alternative.
|
java.util.ResourceBundle |
getResourceBundle(FacesContext ctx,
java.lang.String name)
The default behavior of this method is to call
|
ResourceHandler |
getResourceHandler()
The default behavior of this method is to call |
SearchExpressionHandler |
getSearchExpressionHandler()
Return the thread-safe singleton |
SearchKeywordResolver |
getSearchKeywordResolver()
Return the singleton |
StateManager |
getStateManager()
The default behavior of this method is to call |
java.util.Iterator<java.util.Locale> |
getSupportedLocales()
The default behavior of this method is to call |
java.util.Iterator<java.lang.String> |
getValidatorIds()
The default behavior of this method is to call |
VariableResolver |
getVariableResolver()
Deprecated.
See superclass for alternative.
|
ViewHandler |
getViewHandler()
The default behavior of this method is to call |
Application |
getWrapped()
A class that implements this interface uses this method to return an instance of the class being wrapped. |
void |
publishEvent(FacesContext context,
java.lang.Class<? extends SystemEvent> systemEventClass,
java.lang.Class<?> sourceBaseType,
java.lang.Object source)
The default behavior of this method is to call
|
void |
publishEvent(FacesContext context,
java.lang.Class<? extends SystemEvent> systemEventClass,
java.lang.Object source)
The default behavior of this method is to call
|
void |
removeELContextListener(ELContextListener listener)
The default behavior of this method is to call
|
void |
setActionListener(ActionListener listener)
The default behavior of this method is to call
|
void |
setDefaultLocale(java.util.Locale locale)
The default behavior of this method is to call |
void |
setDefaultRenderKitId(java.lang.String renderKitId)
The default behavior of this method is to call |
void |
setFlowHandler(FlowHandler newHandler)
Set the |
void |
setMessageBundle(java.lang.String bundle)
The default behavior of this method is to call |
void |
setNavigationHandler(NavigationHandler handler)
The default behavior of this method is to call |
void |
setPropertyResolver(PropertyResolver resolver)
Deprecated.
See superclass for alternative.
|
void |
setResourceHandler(ResourceHandler resourceHandler)
The default behavior of this method is to call
|
void |
setSearchExpressionHandler(SearchExpressionHandler searchExpressionHandler)
Set the |
void |
setStateManager(StateManager manager)
The default behavior of this method is to call
|
void |
setSupportedLocales(java.util.Collection<java.util.Locale> locales)
The default behavior of this method is to call |
void |
setVariableResolver(VariableResolver resolver)
Deprecated.
See superclass for alternative.
|
void |
setViewHandler(ViewHandler handler)
The default behavior of this method is to call
|
void |
subscribeToEvent(java.lang.Class<? extends SystemEvent> systemEventClass,
java.lang.Class<?> sourceClass,
SystemEventListener listener)
The default behavior of this method is to call
|
void |
subscribeToEvent(java.lang.Class<? extends SystemEvent> systemEventClass,
SystemEventListener listener)
The default behavior of this method is to call
|
void |
unsubscribeFromEvent(java.lang.Class<? extends SystemEvent> systemEventClass,
java.lang.Class<?> sourceClass,
SystemEventListener listener)
The default behavior of this method is to call
|
void |
unsubscribeFromEvent(java.lang.Class<? extends SystemEvent> systemEventClass,
SystemEventListener listener)
The default behavior of this method is to call
|
@Deprecated public ApplicationWrapper()
public ApplicationWrapper(Application wrapped)
If this application has been decorated, the implementation doing the decorating should push the implementation being
wrapped to this constructor. The getWrapped()
will then return the implementation being wrapped.
wrapped
- The implementation being wrapped.public Application getWrapped()
FacesWrapper
A class that implements this interface uses this method to return an instance of the class being wrapped.
getWrapped
in interface FacesWrapper<Application>
public ActionListener getActionListener()
The default behavior of this method is to call Application.getActionListener()
on the wrapped
Application
object.
getActionListener
in class Application
public void setActionListener(ActionListener listener)
The default behavior of this method is to call
Application.setActionListener(jakarta.faces.event.ActionListener)
on the wrapped Application
object.
setActionListener
in class Application
listener
- The new default ActionListener
public java.util.Locale getDefaultLocale()
The default behavior of this method is to call Application.getDefaultLocale()
on the wrapped
Application
object.
getDefaultLocale
in class Application
null
.public void setDefaultLocale(java.util.Locale locale)
The default behavior of this method is to call Application.setDefaultLocale(java.util.Locale)
on the wrapped
Application
object.
setDefaultLocale
in class Application
locale
- The new default Locale
public java.lang.String getDefaultRenderKitId()
The default behavior of this method is to call Application.getDefaultRenderKitId()
on the wrapped
Application
object.
getDefaultRenderKitId
in class Application
null
.public void addDefaultValidatorId(java.lang.String validatorId)
The default behavior of this method is to call Application.addDefaultValidatorId(String)
on the wrapped
Application
object.
addDefaultValidatorId
in class Application
validatorId
- the validator id.public java.util.Map<java.lang.String,java.lang.String> getDefaultValidatorInfo()
The default behavior of this method is to call Application.getDefaultValidatorInfo()
on the wrapped
Application
object.
getDefaultValidatorInfo
in class Application
public void setDefaultRenderKitId(java.lang.String renderKitId)
The default behavior of this method is to call Application.setDefaultRenderKitId(String)
on the wrapped
Application
object.
setDefaultRenderKitId
in class Application
renderKitId
- the render kit id to set.public java.lang.String getMessageBundle()
The default behavior of this method is to call Application.getMessageBundle()
on the wrapped
Application
object.
getMessageBundle
in class Application
null
.public void setMessageBundle(java.lang.String bundle)
The default behavior of this method is to call Application.setMessageBundle(String)
on the wrapped
Application
object.
setMessageBundle
in class Application
bundle
- Base name of the resource bundle to be usedpublic NavigationHandler getNavigationHandler()
The default behavior of this method is to call Application.getNavigationHandler()
on the wrapped
Application
object.
getNavigationHandler
in class Application
public void setNavigationHandler(NavigationHandler handler)
The default behavior of this method is to call Application.setNavigationHandler(NavigationHandler)
on the
wrapped Application
object.
setNavigationHandler
in class Application
handler
- The new NavigationHandler
instance@Deprecated public PropertyResolver getPropertyResolver()
The default behavior of this method is to call Application.getPropertyResolver()
on the wrapped
Application
object.
getPropertyResolver
in class Application
@Deprecated public void setPropertyResolver(PropertyResolver resolver)
The default behavior of this method is to call
Application.setPropertyResolver(jakarta.faces.el.PropertyResolver)
on the wrapped Application
object.
setPropertyResolver
in class Application
resolver
- The new PropertyResolver
instance@Deprecated public VariableResolver getVariableResolver()
The default behavior of this method is to call Application.getVariableResolver()
on the wrapped
Application
object.
getVariableResolver
in class Application
@Deprecated public void setVariableResolver(VariableResolver resolver)
The default behavior of this method is to call
Application.setVariableResolver(jakarta.faces.el.VariableResolver)
on the wrapped Application
object.
setVariableResolver
in class Application
resolver
- The new VariableResolver
instancepublic ViewHandler getViewHandler()
The default behavior of this method is to call Application.getViewHandler()
on the wrapped Application
object.
getViewHandler
in class Application
public void setViewHandler(ViewHandler handler)
The default behavior of this method is to call
Application.setViewHandler(ViewHandler)
on the wrapped Application
object.
setViewHandler
in class Application
handler
- The new ViewHandler
instancejava.lang.IllegalStateException
- if this method is called after at least one request
has been processed by the Lifecycle
instance for this application.java.lang.NullPointerException
- if manager
is null
public StateManager getStateManager()
The default behavior of this method is to call Application.getStateManager()
on the wrapped Application
object.
getStateManager
in class Application
public void setStateManager(StateManager manager)
The default behavior of this method is to call
Application.setStateManager(StateManager)
on the wrapped Application
object.
setStateManager
in class Application
manager
- The new StateManager
instancejava.lang.IllegalStateException
- if this method is called after at least one request has
been processed by the Lifecycle
instance for this application.java.lang.NullPointerException
- if manager
is null
public void addComponent(java.lang.String componentType, java.lang.String componentClass)
The default behavior of this method is to call Application.addComponent(String, String)
on the wrapped
Application
object.
addComponent
in class Application
componentType
- The component type to be registeredcomponentClass
- The fully qualified class name of the corresponding UIComponent
implementationpublic UIComponent createComponent(java.lang.String componentType) throws FacesException
The default behavior of this method is to call Application.createComponent(String)
on the wrapped
Application
object.
createComponent
in class Application
componentType
- The component type for which to create and return a new UIComponent
instanceFacesException
- if a UIComponent
of the specified type cannot be created@Deprecated public UIComponent createComponent(ValueBinding componentBinding, FacesContext context, java.lang.String componentType) throws FacesException
The default behavior of this method is to call
Application.createComponent(jakarta.faces.el.ValueBinding, jakarta.faces.context.FacesContext, String)
on the
wrapped Application
object.
createComponent
in class Application
componentBinding
- ValueBinding
representing a component value binding expression (typically specified
by the component
attribute of a custom tag)context
- FacesContext
for the current requestcomponentType
- Component type to create if the ValueBinding
does not return a component instanceFacesException
- if a UIComponent
cannot be createdpublic java.util.Iterator<java.lang.String> getComponentTypes()
The default behavior of this method is to call Application.getComponentTypes()
on the wrapped
Application
object.
getComponentTypes
in class Application
public void addConverter(java.lang.String converterId, java.lang.String converterClass)
The default behavior of this method is to call Application.addConverter(String, String)
on the wrapped
Application
object.
addConverter
in class Application
converterId
- The converter id to be registeredconverterClass
- The fully qualified class name of the corresponding Converter
implementationpublic void addConverter(java.lang.Class<?> targetClass, java.lang.String converterClass)
The default behavior of this method is to call Application.addConverter(Class, String)
on the wrapped
Application
object.
addConverter
in class Application
targetClass
- The class for which this converter is registeredconverterClass
- The fully qualified class name of the corresponding Converter
implementationpublic Converter createConverter(java.lang.String converterId)
The default behavior of this method is to call Application.createConverter(String)
on the wrapped
Application
object.
createConverter
in class Application
converterId
- The converter id for which to create and return a new Converter
instancepublic Converter createConverter(java.lang.Class<?> targetClass)
The default behavior of this method is to call Application.createConverter(Class)
on the wrapped
Application
object.
createConverter
in class Application
targetClass
- Target class for which to return a Converter
public java.util.Iterator<java.lang.String> getConverterIds()
The default behavior of this method is to call Application.getConverterIds()
on the wrapped Application
object.
getConverterIds
in class Application
public java.util.Iterator<java.lang.Class<?>> getConverterTypes()
The default behavior of this method is to call Application.getConverterTypes()
on the wrapped
Application
object.
getConverterTypes
in class Application
@Deprecated public MethodBinding createMethodBinding(java.lang.String ref, java.lang.Class<?>[] params) throws ReferenceSyntaxException
The default behavior of this method is to call Application.createMethodBinding(String, Class[])
on the
wrapped Application
object.
createMethodBinding
in class Application
ref
- Method binding expression for which to return a MethodBinding
instanceparams
- 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 parametersReferenceSyntaxException
- if the specified ref
has invalid syntaxpublic java.util.Iterator<java.util.Locale> getSupportedLocales()
The default behavior of this method is to call Application.getSupportedLocales()
on the wrapped
Application
object.
getSupportedLocales
in class Application
public void setSupportedLocales(java.util.Collection<java.util.Locale> locales)
The default behavior of this method is to call Application.setSupportedLocales(java.util.Collection)
on the
wrapped Application
object.
setSupportedLocales
in class Application
locales
- The set of supported Locale
s for this applicationpublic void addBehavior(java.lang.String behaviorId, java.lang.String behaviorClass)
The default behavior of this method is to call Application.addBehavior(String, String)
on the wrapped
Application
object.
addBehavior
in class Application
behaviorId
- The behavior id to be registeredbehaviorClass
- The fully qualified class name of the corresponding Behavior
implementationpublic Behavior createBehavior(java.lang.String behaviorId) throws FacesException
The default behavior of this method is to call Application.createBehavior(String)
on the wrapped
Application
object.
createBehavior
in class Application
behaviorId
- The behavior id for which to create and return a new Behavior
instanceFacesException
- if the Behavior
cannot be createdpublic java.util.Iterator<java.lang.String> getBehaviorIds()
The default behavior of this method is to call Application.getBehaviorIds()
on the wrapped Application
object.
getBehaviorIds
in class Application
public void addValidator(java.lang.String validatorId, java.lang.String validatorClass)
The default behavior of this method is to call Application.addValidator(String, String)
on the wrapped
Application
object.
addValidator
in class Application
validatorId
- The validator id to be registeredvalidatorClass
- The fully qualified class name of the corresponding Validator
implementationpublic Validator createValidator(java.lang.String validatorId) throws FacesException
The default behavior of this method is to call Application.createValidator(String)
on the wrapped
Application
object.
createValidator
in class Application
validatorId
- The validator id for which to create and return a new Validator
instanceFacesException
- if a Validator
of the specified id cannot be createdpublic java.util.Iterator<java.lang.String> getValidatorIds()
The default behavior of this method is to call Application.getValidatorIds()
on the wrapped Application
object.
getValidatorIds
in class Application
public ValueBinding createValueBinding(java.lang.String ref) throws ReferenceSyntaxException
The default behavior of this method is to call Application.createValueBinding(String)
on the wrapped
Application
object.
createValueBinding
in class Application
ref
- Value binding expression for which to return a ValueBinding
instanceReferenceSyntaxException
- if the specified ref
has invalid syntaxpublic ResourceHandler getResourceHandler()
The default behavior of this method is to call Application.getResourceHandler()
on the wrapped
Application
object.
getResourceHandler
in class Application
public void setResourceHandler(ResourceHandler resourceHandler)
The default behavior of this method is to call
Application.setResourceHandler(ResourceHandler)
on the wrapped Application
object.
setResourceHandler
in class Application
resourceHandler
- The new ResourceHandler
instancejava.lang.IllegalStateException
- if this method is called after at least one request has
been processed by the Lifecycle
instance for this application.java.lang.NullPointerException
- if resourceHandler
is null
public java.util.ResourceBundle getResourceBundle(FacesContext ctx, java.lang.String name)
The default behavior of this method is to call
Application.getResourceBundle(jakarta.faces.context.FacesContext, String)
on the wrapped Application
object.
getResourceBundle
in class Application
ctx
- the Faces context.name
- the name of the resource bundle.public ProjectStage getProjectStage()
The default behavior of this method is to call Application.getProjectStage()
on the wrapped Application
object.
getProjectStage
in class Application
public void addELResolver(ELResolver resolver)
The default behavior of this method is to call
Application.addELResolver(jakarta.el.ELResolver)
on the wrapped Application
object.
addELResolver
in class Application
resolver
- the Jakarta Expression Language resolver to add.java.lang.IllegalStateException
- if called after the first request to the
FacesServlet
has been serviced.public ELResolver getELResolver()
The default behavior of this method is to call Application.getELResolver()
on the wrapped Application
object.
getELResolver
in class Application
public UIComponent createComponent(ValueExpression componentExpression, FacesContext context, java.lang.String componentType) throws FacesException
The default behavior of this method is to call
Application.createComponent(jakarta.el.ValueExpression, jakarta.faces.context.FacesContext, String)
on the
wrapped Application
object.
createComponent
in class Application
componentExpression
- ValueExpression
representing a component value expression (typically specified by
the component
attribute of a custom tag)context
- FacesContext
for the current requestcomponentType
- Component type to create if the ValueExpression
does not return a component instanceFacesException
- if a UIComponent
cannot be createdpublic UIComponent createComponent(ValueExpression componentExpression, FacesContext context, java.lang.String componentType, java.lang.String rendererType)
The default behavior of this method is to call
Application.createComponent(jakarta.el.ValueExpression, jakarta.faces.context.FacesContext, String, String)
on the wrapped Application
object.
createComponent
in class Application
componentExpression
- ValueExpression
representing a component value expression (typically specified by
the component
attribute of a custom tag)context
- FacesContext
for the current requestcomponentType
- Component type to create if the ValueExpression
does not return a component instancerendererType
- The renderer-type of the Renderer
that will render this component. A
null
value must be accepted for this parameter.public UIComponent createComponent(FacesContext context, java.lang.String componentType, java.lang.String rendererType)
The default behavior of this method is to call
Application.createComponent(jakarta.faces.context.FacesContext, String, String)
on the wrapped
Application
object.
createComponent
in class Application
context
- FacesContext
for the current requestcomponentType
- Component type to createrendererType
- The renderer-type of the Renderer
that will render this component. A
null
value must be accepted for this parameter.public UIComponent createComponent(FacesContext context, Resource componentResource)
The default behavior of this method is to call
Application.createComponent(jakarta.faces.context.FacesContext, Resource)
on the wrapped Application
object.
createComponent
in class Application
context
- FacesContext
for the current requestcomponentResource
- A Resource
that points to a source file that provides an implementation of a
component.public ExpressionFactory getExpressionFactory()
The default behavior of this method is to call Application.getExpressionFactory()
on the wrapped
Application
object.
getExpressionFactory
in class Application
public FlowHandler getFlowHandler()
Application
Return the thread-safe singleton FlowHandler
for this application. For implementations declaring compliance
with version 2.2 of the specification, this method must never return null
, even if the application has no
flows. This is necessary to enable dynamic flow creation during the application's lifetime.
All implementations that declare compliance with version 2.2 of the specification must implement this method. For the
purpose of backward compatibility with environments that extend Application
but do not override this method, an implementation is provided that returns null
. Due to the
decoratable nature of Application
, code calling this method should always check for a null
return.
getFlowHandler
in class Application
public void setFlowHandler(FlowHandler newHandler)
Application
Set the FlowHandler
instance used by the NavigationHandler
to satisfy the requirements of the faces
flows feature.
setFlowHandler
in class Application
newHandler
- the flow handler to set.@Deprecated public <T> T evaluateExpressionGet(FacesContext context, java.lang.String expression, java.lang.Class<? extends T> expectedType) throws ELException
The default behavior of this method is to call
Application.evaluateExpressionGet(jakarta.faces.context.FacesContext, String, Class)
on the wrapped
Application
object.
evaluateExpressionGet
in class Application
T
- the return type.context
- the Faces context.expression
- the expression.expectedType
- the expected type.ELException
public void addELContextListener(ELContextListener listener)
The default behavior of this method is to call Application.addELContextListener(jakarta.el.ELContextListener)
on the wrapped Application
object.
addELContextListener
in class Application
listener
- the Jakarta Expression Language context listener to add.public void removeELContextListener(ELContextListener listener)
The default behavior of this method is to call
Application.removeELContextListener(jakarta.el.ELContextListener)
on the wrapped Application
object.
removeELContextListener
in class Application
listener
- the Jakarta Expression Language context listener to remove.public ELContextListener[] getELContextListeners()
The default behavior of this method is to call Application.getELContextListeners()
on the wrapped
Application
object.
getELContextListeners
in class Application
public void publishEvent(FacesContext context, java.lang.Class<? extends SystemEvent> systemEventClass, java.lang.Object source)
The default behavior of this method is to call
Application.publishEvent(jakarta.faces.context.FacesContext, Class, Object)
on the wrapped
Application
object.
publishEvent
in class Application
context
- the FacesContext
for the current requestsystemEventClass
- The Class
of event that is being published.source
- The source for the event of type systemEventClass
.public void publishEvent(FacesContext context, java.lang.Class<? extends SystemEvent> systemEventClass, java.lang.Class<?> sourceBaseType, java.lang.Object source)
The default behavior of this method is to call
Application.publishEvent(jakarta.faces.context.FacesContext, Class, Class, Object)
on the wrapped
Application
object.
publishEvent
in class Application
context
- the FacesContext
for the current requestsystemEventClass
- The Class
of event that is being published.sourceBaseType
- 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
.source
- The source for the event of type systemEventClass
.public void subscribeToEvent(java.lang.Class<? extends SystemEvent> systemEventClass, java.lang.Class<?> sourceClass, SystemEventListener listener)
The default behavior of this method is to call
Application.subscribeToEvent(Class, Class, jakarta.faces.event.SystemEventListener)
on the wrapped
Application
object.
subscribeToEvent
in class Application
systemEventClass
- the Class
of event for which listener
must be fired.sourceClass
- the Class
of the instance which causes events of type systemEventClass
to be fired. May be null
.listener
- the implementation of SystemEventListener
whose
SystemEventListener.processEvent(jakarta.faces.event.SystemEvent)
method must be called when events of type
systemEventClass
are fired.public void subscribeToEvent(java.lang.Class<? extends SystemEvent> systemEventClass, SystemEventListener listener)
The default behavior of this method is to call
Application.subscribeToEvent(Class, jakarta.faces.event.SystemEventListener)
on the wrapped
Application
object.
subscribeToEvent
in class Application
systemEventClass
- the Class
of event for which listener
must be fired.listener
- the implementation of SystemEventListener
whose
SystemEventListener.processEvent(jakarta.faces.event.SystemEvent)
method must be called when events of type
systemEventClass
are fired.
See Application.subscribeToEvent(java.lang.Class,java.lang.Class,jakarta.faces.event.SystemEventListener)
for an
additional requirement regarding when it is valid to call this method.
public void unsubscribeFromEvent(java.lang.Class<? extends SystemEvent> systemEventClass, java.lang.Class<?> sourceClass, SystemEventListener listener)
The default behavior of this method is to call
Application.unsubscribeFromEvent(Class, Class, jakarta.faces.event.SystemEventListener)
on the wrapped
Application
object.
unsubscribeFromEvent
in class Application
systemEventClass
- the Class
of event for which listener
must be fired.sourceClass
- the Class
of the instance which causes events of type systemEventClass
to be fired. May be null
.listener
- the implementation of SystemEventListener
to remove from the internal
data structure.public void unsubscribeFromEvent(java.lang.Class<? extends SystemEvent> systemEventClass, SystemEventListener listener)
The default behavior of this method is to call
Application.unsubscribeFromEvent(Class, jakarta.faces.event.SystemEventListener)
on the wrapped
Application
object.
unsubscribeFromEvent
in class Application
systemEventClass
- the Class
of event for which listener
must be fired.listener
- the implementation of SystemEventListener
to remove from the internal
data structure.public SearchExpressionHandler getSearchExpressionHandler()
Application
Return the thread-safe singleton SearchExpressionHandler
for this application.
getSearchExpressionHandler
in class Application
SearchExpressionHandler
.public void setSearchExpressionHandler(SearchExpressionHandler searchExpressionHandler)
Application
Set the SearchExpressionHandler
instance used by the application.
setSearchExpressionHandler
in class Application
searchExpressionHandler
- the SearchExpressionHandler
.public void addSearchKeywordResolver(SearchKeywordResolver resolver)
Application
Cause the argument resolver
to be added to the head of the resolver chain.
It is not possible to remove a SearchKeywordResolver
registered with this method, once it has been
registered.
The default implementation throws UnsupportedOperationException
and is provided for the sole purpose of
not breaking existing applications that extend Application
.
addSearchKeywordResolver
in class Application
resolver
- the SearchKeywordResolver to add.public SearchKeywordResolver getSearchKeywordResolver()
Application
Return the singleton SearchKeywordResolver
instance to be used for all search keyword resolution. This is
actually an instance of a composite SearchKeywordResolver that must contain the following
SearchKeywordResolver
instances in the following order:
SearchKeywordResolver
instances declared using the <search-keyword-resolver> element in the
application configuration resources.
Any SearchKeywordResolver
instances added by calls to Application.addSearchKeywordResolver(jakarta.faces.component.search.SearchKeywordResolver)
.
The SearchKeywordResolver
implementations for @all
, @child(n)
,
@form
, @id(...)
, @namingcontainer
, @next
, @none
,
@parent
, @previous
, @root
and @this
.
The default implementation throws UnsupportedOperationException
and is provided for the sole purpose of
not breaking existing applications that extend Application
.
getSearchKeywordResolver
in class Application
SearchKeywordResolver
.