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 push the implementation being wrapped to the constructor and use getWrapped()
to
access the instance being wrapped.
NULL_VALUE
Constructor and Description |
---|
FlashWrapper()
Deprecated.
Use the other constructor taking the implementation being wrapped.
|
FlashWrapper(Flash wrapped)
If this flash has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor. |
Modifier and Type | Method and Description |
---|---|
void |
clear()
The default behavior of this method is to call |
boolean |
containsKey(java.lang.Object key)
The default behavior of this method is to call |
boolean |
containsValue(java.lang.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 |
java.util.Set<java.util.Map.Entry<java.lang.String,java.lang.Object>> |
entrySet()
The default behavior of this method is to call |
java.lang.Object |
get(java.lang.Object key)
The default behavior of this method is to call |
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(java.lang.String key)
The default behavior of this method is to call |
java.util.Set<java.lang.String> |
keySet()
The default behavior of this method is to call |
java.lang.Object |
put(java.lang.String key,
java.lang.Object value)
The default behavior of this method is to call |
void |
putAll(java.util.Map<? extends java.lang.String,? extends java.lang.Object> m)
The default behavior of this method is to call |
void |
putNow(java.lang.String key,
java.lang.Object value)
The default behavior of this method is to call |
java.lang.Object |
remove(java.lang.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 |
java.util.Collection<java.lang.Object> |
values()
The default behavior of this method is to call |
@Deprecated public FlashWrapper()
public FlashWrapper(Flash wrapped)
If this flash 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 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(java.lang.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(java.lang.String key, java.lang.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.
clear
in interface java.util.Map<java.lang.String,java.lang.Object>
public boolean containsKey(java.lang.Object key)
The default behavior of this method is to call Map.containsKey(Object)
on the wrapped Flash
object.
containsKey
in interface java.util.Map<java.lang.String,java.lang.Object>
public boolean containsValue(java.lang.Object value)
The default behavior of this method is to call Map.containsValue(Object)
on the wrapped Flash
object.
containsValue
in interface java.util.Map<java.lang.String,java.lang.Object>
public java.util.Set<java.util.Map.Entry<java.lang.String,java.lang.Object>> entrySet()
The default behavior of this method is to call Map.entrySet()
on the wrapped Flash
object.
entrySet
in interface java.util.Map<java.lang.String,java.lang.Object>
public java.lang.Object get(java.lang.Object key)
The default behavior of this method is to call Map.get(Object)
on the wrapped Flash
object.
get
in interface java.util.Map<java.lang.String,java.lang.Object>
public boolean isEmpty()
The default behavior of this method is to call Map.isEmpty()
on the wrapped Flash
object.
isEmpty
in interface java.util.Map<java.lang.String,java.lang.Object>
public java.util.Set<java.lang.String> keySet()
The default behavior of this method is to call Map.keySet()
on the wrapped Flash
object.
keySet
in interface java.util.Map<java.lang.String,java.lang.Object>
public java.lang.Object put(java.lang.String key, java.lang.Object value)
The default behavior of this method is to call Map.put(K, V)
on the wrapped Flash
object.
put
in interface java.util.Map<java.lang.String,java.lang.Object>
public void putAll(java.util.Map<? extends java.lang.String,? extends java.lang.Object> m)
The default behavior of this method is to call Map.putAll(Map)
on the wrapped Flash
object.
putAll
in interface java.util.Map<java.lang.String,java.lang.Object>
public java.lang.Object remove(java.lang.Object key)
The default behavior of this method is to call Map.remove(Object)
on the wrapped Flash
object.
remove
in interface java.util.Map<java.lang.String,java.lang.Object>
public int size()
The default behavior of this method is to call Map.size()
on the wrapped Flash
object.
size
in interface java.util.Map<java.lang.String,java.lang.Object>
public java.util.Collection<java.lang.Object> values()
The default behavior of this method is to call Map.values()
on the wrapped Flash
object.
values
in interface java.util.Map<java.lang.String,java.lang.Object>