public abstract class FlashWrapper extends Flash implements FacesWrapper<Flash>
Provides a simple implementation of
Flash
that can be subclassed by developers wishing
to provide specialized behavior to an existing Flash
instance. The default implementation of all methods
is to call through to the wrapped Flash
.
Usage: extend this class and override getWrapped()
to
return the instance we are wrapping.
NULL_VALUE
Constructor and Description |
---|
FlashWrapper() |
Modifier and Type | Method and Description |
---|---|
void |
clear()
The default behavior of this method
is to call |
boolean |
containsKey(Object key)
The default behavior of this method
is to call |
boolean |
containsValue(Object value)
The default behavior of this method
is to call |
void |
doPostPhaseActions(FacesContext ctx)
The default behavior of this method
is to call |
void |
doPrePhaseActions(FacesContext ctx)
The default behavior of this method
is to call |
Set<Map.Entry<String,Object>> |
entrySet()
The default behavior of this method
is to call |
Object |
get(Object key)
The default behavior of this method
is to call |
abstract Flash |
getWrapped()
A class that implements this interface uses this method to return an instance of the class being wrapped. |
boolean |
isEmpty()
The default behavior of this method
is to call |
boolean |
isKeepMessages()
The default behavior of this method
is to call |
boolean |
isRedirect()
The default behavior of this method
is to call |
void |
keep(String key)
The default behavior of this method
is to call |
Set<String> |
keySet()
The default behavior of this method
is to call |
Object |
put(String key,
Object value)
The default behavior of this method
is to call |
void |
putAll(Map<? extends String,? extends Object> m)
The default behavior of this method
is to call |
void |
putNow(String key,
Object value)
The default behavior of this method
is to call |
Object |
remove(Object key)
The default behavior of this method
is to call |
void |
setKeepMessages(boolean newValue)
The default behavior of this method
is to call |
void |
setRedirect(boolean newValue)
The default behavior of this method
is to call |
int |
size()
The default behavior of this method
is to call |
Collection<Object> |
values()
The default behavior of this method
is to call |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
compute, computeIfAbsent, computeIfPresent, equals, forEach, getOrDefault, hashCode, merge, putIfAbsent, remove, replace, replace, replaceAll
public abstract Flash getWrapped()
FacesWrapper
A class that implements this interface uses this method to return an instance of the class being wrapped.
getWrapped
in interface FacesWrapper<Flash>
public void doPostPhaseActions(FacesContext ctx)
The default behavior of this method
is to call Flash.doPostPhaseActions(FacesContext)
on the
wrapped Flash
object.
doPostPhaseActions
in class Flash
ctx
- the FacesContext
for this request.public void doPrePhaseActions(FacesContext ctx)
The default behavior of this method
is to call Flash.doPrePhaseActions(FacesContext)
on the
wrapped Flash
object.
doPrePhaseActions
in class Flash
ctx
- the FacesContext
for this request.public boolean isKeepMessages()
The default behavior of this method
is to call Flash.isKeepMessages()
on the wrapped
Flash
object.
isKeepMessages
in class Flash
public boolean isRedirect()
The default behavior of this method
is to call Flash.isRedirect()
on the wrapped Flash
object.
isRedirect
in class Flash
public void keep(String key)
The default behavior of this method
is to call Flash.keep(String)
on the wrapped Flash
object.
keep
in class Flash
key
- if argument key
is the name of an entry
previously stored to the flash on this traversal through the
lifecycle via a call to Flash.putNow(java.lang.String, java.lang.Object)
, or to a set to the EL
expression #{flash.now.<key>}
, or to the
request Map
, to be promoted to the flash as if a call
to put()
or a set to the expression
#{flash.<key>}
was being called.public void putNow(String key, Object value)
The default behavior of this method
is to call Flash.putNow(String, Object)
on the wrapped
Flash
object.
public void setKeepMessages(boolean newValue)
The default behavior of this method
is to call Flash.setKeepMessages(boolean)
on the wrapped
Flash
object.
setKeepMessages
in class Flash
newValue
- the new value for this property on this session.public void setRedirect(boolean newValue)
The default behavior of this method
is to call Flash.setRedirect(boolean)
on the wrapped
Flash
object.
setRedirect
in class Flash
newValue
- the new value for this property on this session.public void clear()
The default behavior of this method
is to call Map.clear()
on the wrapped Flash
object.
public boolean containsKey(Object key)
The default behavior of this method
is to call Map.containsKey(Object)
on the wrapped
Flash
object.
containsKey
in interface Map<String,Object>
public boolean containsValue(Object value)
The default behavior of this method
is to call Map.containsValue(Object)
on the wrapped
Flash
object.
containsValue
in interface Map<String,Object>
public Set<Map.Entry<String,Object>> entrySet()
The default behavior of this method
is to call Map.entrySet()
on the wrapped Flash
object.
public Object get(Object key)
The default behavior of this method
is to call Map.get(Object)
on the wrapped Flash
object.
public boolean isEmpty()
The default behavior of this method
is to call Map.isEmpty()
on the wrapped Flash
object.
public Set<String> keySet()
The default behavior of this method
is to call Map.keySet()
on the wrapped Flash
object.
public Object put(String key, Object value)
The default behavior of this method
is to call Map.put(K, V)
on the wrapped
Flash
object.
public void putAll(Map<? extends String,? extends Object> m)
The default behavior of this method
is to call Map.putAll(Map)
on the wrapped
Flash
object.
public Object remove(Object key)
The default behavior of this method
is to call Map.remove(Object)
on the wrapped
Flash
object.
public int size()
The default behavior of this method
is to call Map.size()
on the wrapped Flash
object.
public Collection<Object> values()
The default behavior of this method
is to call Map.values()
on the wrapped Flash
object.
Copyright © 2017 JBoss by Red Hat. All rights reserved.