EE4J 10.0.0 · jakarta.faces.context.FlashWrapper

Modifier and Type	Field and Description
private Flash	wrapped

Access	Constructor and Description
public	FlashWrapper() Deprecated Use the other constructor taking the implementation being wrapped.
public	FlashWrapper(Flash The implementation being wrapped. wrapped) If this flash has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor.

Method Summary

Modifier and Type	Method and Description
public void	clear() Implements java.util.Map.clear. The default behavior of this method is to call `Flash#clear()` on the wrapped `Flash` object.
public boolean	containsKey(Object key whose presence in this map is to be tested key) Implements java.util.Map.containsKey. The default behavior of this method is to call `Flash#containsKey(Object)` on the wrapped `Flash` object.
public boolean	containsValue(Object value whose presence in this map is to be tested value) Implements java.util.Map.containsValue. The default behavior of this method is to call `Flash#containsValue(Object)` on the wrapped `Flash` object.
public void	doPostPhaseActions(FacesContext the `FacesContext` for this request. ctx) Implements abstract jakarta.faces.context.Flash.doPostPhaseActions. The default behavior of this method is to call `Flash#doPostPhaseActions(FacesContext)` on the wrapped `Flash` object.
public void	doPrePhaseActions(FacesContext the `FacesContext` for this request. ctx) Implements abstract jakarta.faces.context.Flash.doPrePhaseActions. The default behavior of this method is to call `Flash#doPrePhaseActions(FacesContext)` on the wrapped `Flash` object.
public Set<Map.Entry<String, Object>>	entrySet() Implements java.util.Map.entrySet. The default behavior of this method is to call `Flash#entrySet()` on the wrapped `Flash` object.
public Object	get(Object the key whose associated value is to be returned key) Implements java.util.Map.get. The default behavior of this method is to call `Flash#get(Object)` on the wrapped `Flash` object.
public Flash	getWrapped() Implements jakarta.faces.FacesWrapper.getWrapped. A class that implements this interface uses this method to return an instance of the class being wrapped.
public boolean	isEmpty() Implements java.util.Map.isEmpty. The default behavior of this method is to call `Flash#isEmpty()` on the wrapped `Flash` object.
public boolean	isKeepMessages() Implements abstract jakarta.faces.context.Flash.isKeepMessages. The default behavior of this method is to call `Flash#isKeepMessages()` on the wrapped `Flash` object.
public boolean	isRedirect() Implements abstract jakarta.faces.context.Flash.isRedirect. The default behavior of this method is to call `Flash#isRedirect()` on the wrapped `Flash` object.
public void	keep(String if argument `key` is the name of an entry previously stored to the flash on this traversal through the lifecycle via a call to `putNow`, 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. key) Implements abstract jakarta.faces.context.Flash.keep. The default behavior of this method is to call `Flash#keep(String)` on the wrapped `Flash` object.
public Set<String>	keySet() Implements java.util.Map.keySet. The default behavior of this method is to call `Flash#keySet()` on the wrapped `Flash` object.
public Object	put(String key with which the specified value is to be associated key, Object value to be associated with the specified key value) Implements java.util.Map.put. The default behavior of this method is to call `Flash#put` on the wrapped `Flash` object.
public void	putAll(Map<? extends String, ? extends Object> mappings to be stored in this map m) Implements java.util.Map.putAll. The default behavior of this method is to call `Flash#putAll(Map)` on the wrapped `Flash` object.
public void	putNow(String the key for this entry key, Object the value for this entry value) Implements abstract jakarta.faces.context.Flash.putNow. The default behavior of this method is to call `Flash#putNow(String, Object)` on the wrapped `Flash` object.
public Object	remove(Object key whose mapping is to be removed from the map key) Implements java.util.Map.remove. The default behavior of this method is to call `Flash#remove(Object)` on the wrapped `Flash` object.
public void	setKeepMessages(boolean the new value for this property on this session. newValue) Implements abstract jakarta.faces.context.Flash.setKeepMessages. The default behavior of this method is to call `Flash#setKeepMessages(boolean)` on the wrapped `Flash` object.
public void	setRedirect(boolean the new value for this property on this session. newValue) Implements abstract jakarta.faces.context.Flash.setRedirect. The default behavior of this method is to call `Flash#setRedirect(boolean)` on the wrapped `Flash` object.
public int	size() Implements java.util.Map.size. The default behavior of this method is to call `Flash#size()` on the wrapped `Flash` object.
public Collection<Object>	values() Implements java.util.Map.values. The default behavior of this method is to call `Flash#values()` on the wrapped `Flash` object.

wrapped	back to summary
private Flash wrapped

FlashWrapper	back to summary
public FlashWrapper() Deprecated Use the other constructor taking the implementation being wrapped. Annotations @Deprecated

FlashWrapper	back to summary
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. Parameters wrapped:Flash The implementation being wrapped. Since 2.3

Method Detail

clear back to summary

clear	back to summary
public void clear() Implements java.util.Map.clear. The default behavior of this method is to call `Flash#clear()` on the wrapped `Flash` object. Annotations @Override Since 2.2

public void clear()

Implements java.util.Map.clear.

The default behavior of this method is to call Flash#clear() on the wrapped Flash object.

Annotations

@Override

Since

2.2

containsKey back to summary

containsKey	back to summary
public boolean containsKey(Object key) Implements java.util.Map.containsKey. The default behavior of this method is to call `Flash#containsKey(Object)` on the wrapped `Flash` object. Parameters key:Object Doc from java.util.Map.containsKey. key whose presence in this map is to be tested Returns:boolean Doc from java.util.Map.containsKey. `true` if this map contains a mapping for the specified key Annotations @Override Since 2.2

public boolean containsKey(Object key)

Implements java.util.Map.containsKey.

The default behavior of this method is to call Flash#containsKey(Object) on the wrapped Flash object.

Parameters

key:Object

Doc from java.util.Map.containsKey.

key whose presence in this map is to be tested

Returns:boolean

Doc from java.util.Map.containsKey.

true if this map contains a mapping for the specified key

Annotations

@Override

Since

2.2

containsValue back to summary

containsValue	back to summary
public boolean containsValue(Object value) Implements java.util.Map.containsValue. The default behavior of this method is to call `Flash#containsValue(Object)` on the wrapped `Flash` object. Parameters value:Object Doc from java.util.Map.containsValue. value whose presence in this map is to be tested Returns:boolean Doc from java.util.Map.containsValue. `true` if this map maps one or more keys to the specified value Annotations @Override Since 2.2

public boolean containsValue(Object value)

Implements java.util.Map.containsValue.

The default behavior of this method is to call Flash#containsValue(Object) on the wrapped Flash object.

Parameters

value:Object

Doc from java.util.Map.containsValue.

value whose presence in this map is to be tested

Returns:boolean

Doc from java.util.Map.containsValue.

true if this map maps one or more keys to the specified value

Annotations

@Override

Since

2.2

doPostPhaseActions back to summary

doPostPhaseActions	back to summary
public void doPostPhaseActions(FacesContext ctx) Implements abstract jakarta.faces.context.Flash.doPostPhaseActions. The default behavior of this method is to call `Flash#doPostPhaseActions(FacesContext)` on the wrapped `Flash` object. Parameters ctx:FacesContext Doc from jakarta.faces.context.Flash.doPostPhaseActions. the `FacesContext` for this request. Annotations @Override Since 2.2

public void doPostPhaseActions(FacesContext ctx)

Implements abstract jakarta.faces.context.Flash.doPostPhaseActions.

The default behavior of this method is to call Flash#doPostPhaseActions(FacesContext) on the wrapped Flash object.

Parameters

ctx:FacesContext

Doc from jakarta.faces.context.Flash.doPostPhaseActions.

the FacesContext for this request.

Annotations

@Override

Since

2.2

doPrePhaseActions back to summary

doPrePhaseActions	back to summary
public void doPrePhaseActions(FacesContext ctx) Implements abstract jakarta.faces.context.Flash.doPrePhaseActions. The default behavior of this method is to call `Flash#doPrePhaseActions(FacesContext)` on the wrapped `Flash` object. Parameters ctx:FacesContext Doc from jakarta.faces.context.Flash.doPrePhaseActions. the `FacesContext` for this request. Annotations @Override Since 2.2

public void doPrePhaseActions(FacesContext ctx)

Implements abstract jakarta.faces.context.Flash.doPrePhaseActions.

The default behavior of this method is to call Flash#doPrePhaseActions(FacesContext) on the wrapped Flash object.

Parameters

ctx:FacesContext

Doc from jakarta.faces.context.Flash.doPrePhaseActions.

the FacesContext for this request.

Annotations

@Override

Since

2.2

entrySet back to summary

entrySet	back to summary
public Set<Map.Entry<String, Object>> entrySet() Implements java.util.Map.entrySet. The default behavior of this method is to call `Flash#entrySet()` on the wrapped `Flash` object. Returns:Set<Map.Entry<String, Object>> Doc from java.util.Map.entrySet. a set view of the mappings contained in this map Annotations @Override Since 2.2

public Set<Map.Entry<String, Object>> entrySet()

Implements java.util.Map.entrySet.

The default behavior of this method is to call Flash#entrySet() on the wrapped Flash object.

Returns:Set<Map.Entry<String, Object>>

Doc from java.util.Map.entrySet.

a set view of the mappings contained in this map

Annotations

@Override

Since

2.2

get back to summary

get	back to summary
public Object get(Object key) Implements java.util.Map.get. The default behavior of this method is to call `Flash#get(Object)` on the wrapped `Flash` object. Parameters key:Object Doc from java.util.Map.get. the key whose associated value is to be returned Returns:Object Doc from java.util.Map.get. the value to which the specified key is mapped, or `null` if this map contains no mapping for the key Annotations @Override Since 2.2

public Object get(Object key)

Implements java.util.Map.get.

The default behavior of this method is to call Flash#get(Object) on the wrapped Flash object.

Parameters

key:Object

Doc from java.util.Map.get.

the key whose associated value is to be returned

Returns:Object

Doc from java.util.Map.get.

the value to which the specified key is mapped, or null if this map contains no mapping for the key

Annotations

@Override

Since

2.2

getWrapped	back to summary
public Flash getWrapped() Implements jakarta.faces.FacesWrapper.getWrapped. Doc from jakarta.faces.FacesWrapper.getWrapped. A class that implements this interface uses this method to return an instance of the class being wrapped. Returns:Flash the wrapped instance. Annotations @Override

getWrapped

back to summary

public Flash getWrapped()

Implements jakarta.faces.FacesWrapper.getWrapped.

Doc from jakarta.faces.FacesWrapper.getWrapped.

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

Returns:Flash

the wrapped instance.

Annotations

@Override

isEmpty back to summary

isEmpty	back to summary
public boolean isEmpty() Implements java.util.Map.isEmpty. The default behavior of this method is to call `Flash#isEmpty()` on the wrapped `Flash` object. Returns:boolean Doc from java.util.Map.isEmpty. `true` if this map contains no key-value mappings Annotations @Override Since 2.2

public boolean isEmpty()

Implements java.util.Map.isEmpty.

The default behavior of this method is to call Flash#isEmpty() on the wrapped Flash object.

Returns:boolean

Doc from java.util.Map.isEmpty.

true if this map contains no key-value mappings

Annotations

@Override

Since

2.2

isKeepMessages back to summary

isKeepMessages	back to summary
public boolean isKeepMessages() Implements abstract jakarta.faces.context.Flash.isKeepMessages. The default behavior of this method is to call `Flash#isKeepMessages()` on the wrapped `Flash` object. Returns:boolean Doc from jakarta.faces.context.Flash.isKeepMessages. the boolean flag whether keeping messages or not. Annotations @Override Since 2.2

public boolean isKeepMessages()

Implements abstract jakarta.faces.context.Flash.isKeepMessages.

The default behavior of this method is to call Flash#isKeepMessages() on the wrapped Flash object.

Returns:boolean

Doc from jakarta.faces.context.Flash.isKeepMessages.

the boolean flag whether keeping messages or not.

Annotations

@Override

Since

2.2

isRedirect back to summary

isRedirect	back to summary
public boolean isRedirect() Implements abstract jakarta.faces.context.Flash.isRedirect. The default behavior of this method is to call `Flash#isRedirect()` on the wrapped `Flash` object. Returns:boolean Doc from jakarta.faces.context.Flash.isRedirect. the value of this property for the flash for this session. Annotations @Override Since 2.2

public boolean isRedirect()

Implements abstract jakarta.faces.context.Flash.isRedirect.

The default behavior of this method is to call Flash#isRedirect() on the wrapped Flash object.

Returns:boolean

Doc from jakarta.faces.context.Flash.isRedirect.

the value of this property for the flash for this session.

Annotations

@Override

Since

2.2

keep back to summary

keep	back to summary
public void keep(String key) Implements abstract jakarta.faces.context.Flash.keep. The default behavior of this method is to call `Flash#keep(String)` on the wrapped `Flash` object. Parameters key:String Doc from jakarta.faces.context.Flash.keep. if argument `key` is the name of an entry previously stored to the flash on this traversal through the lifecycle via a call to `putNow`, 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. Annotations @Override Since 2.2

public void keep(String key)

Implements abstract jakarta.faces.context.Flash.keep.

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

Parameters

key:String

Doc from jakarta.faces.context.Flash.keep.

if argument key is the name of an entry previously stored to the flash on this traversal through the lifecycle via a call to putNow, 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.

Annotations

@Override

Since

2.2

keySet back to summary

keySet	back to summary
public Set<String> keySet() Implements java.util.Map.keySet. The default behavior of this method is to call `Flash#keySet()` on the wrapped `Flash` object. Returns:Set<String> Doc from java.util.Map.keySet. a set view of the keys contained in this map Annotations @Override Since 2.2

public Set<String> keySet()

Implements java.util.Map.keySet.

The default behavior of this method is to call Flash#keySet() on the wrapped Flash object.

Returns:Set<String>

Doc from java.util.Map.keySet.

a set view of the keys contained in this map

Annotations

@Override

Since

2.2

put back to summary

put	back to summary
public Object put(String key, Object value) Implements java.util.Map.put. The default behavior of this method is to call `Flash#put` on the wrapped `Flash` object. Parameters key:String Doc from java.util.Map.put. key with which the specified value is to be associated value:Object Doc from java.util.Map.put. value to be associated with the specified key Returns:Object Doc from java.util.Map.put. the previous value associated with `key`, or `null` if there was no mapping for `key`. (A `null` return can also indicate that the map previously associated `null` with `key`, if the implementation supports `null` values.) Annotations @Override Since 2.2

public Object put(String key, Object value)

Implements java.util.Map.put.

The default behavior of this method is to call Flash#put on the wrapped Flash object.

Parameters

key:String

Doc from java.util.Map.put.

key with which the specified value is to be associated

value:Object

Doc from java.util.Map.put.

value to be associated with the specified key

Returns:Object

Doc from java.util.Map.put.

the previous value associated with key, or null if there was no mapping for key. (A null return can also indicate that the map previously associated null with key, if the implementation supports null values.)

Annotations

@Override

Since

2.2

putAll back to summary

putAll	back to summary
public void putAll(Map<? extends String, ? extends Object> m) Implements java.util.Map.putAll. The default behavior of this method is to call `Flash#putAll(Map)` on the wrapped `Flash` object. Parameters m:Map<? extends String, ? extends Object> Doc from java.util.Map.putAll. mappings to be stored in this map Annotations @Override Since 2.2

public void putAll(Map<? extends String, ? extends Object> m)

Implements java.util.Map.putAll.

The default behavior of this method is to call Flash#putAll(Map) on the wrapped Flash object.

Parameters

m:Map<? extends String, ? extends Object>

Doc from java.util.Map.putAll.

mappings to be stored in this map

Annotations

@Override

Since

2.2

putNow back to summary

putNow	back to summary
public void putNow(String key, Object value) Implements abstract jakarta.faces.context.Flash.putNow. The default behavior of this method is to call `Flash#putNow(String, Object)` on the wrapped `Flash` object. Parameters key:String Doc from jakarta.faces.context.Flash.putNow. the key for this entry value:Object Doc from jakarta.faces.context.Flash.putNow. the value for this entry Annotations @Override Since 2.2

public void putNow(String key, Object value)

Implements abstract jakarta.faces.context.Flash.putNow.

The default behavior of this method is to call Flash#putNow(String, Object) on the wrapped Flash object.

Parameters

key:String

Doc from jakarta.faces.context.Flash.putNow.

the key for this entry

value:Object

Doc from jakarta.faces.context.Flash.putNow.

the value for this entry

Annotations

@Override

Since

2.2

remove back to summary

remove	back to summary
public Object remove(Object key) Implements java.util.Map.remove. The default behavior of this method is to call `Flash#remove(Object)` on the wrapped `Flash` object. Parameters key:Object Doc from java.util.Map.remove. key whose mapping is to be removed from the map Returns:Object Doc from java.util.Map.remove. the previous value associated with `key`, or `null` if there was no mapping for `key`. Annotations @Override Since 2.2

public Object remove(Object key)

Implements java.util.Map.remove.

The default behavior of this method is to call Flash#remove(Object) on the wrapped Flash object.

Parameters

key:Object

Doc from java.util.Map.remove.

key whose mapping is to be removed from the map

Returns:Object

Doc from java.util.Map.remove.

the previous value associated with key, or null if there was no mapping for key.

Annotations

@Override

Since

2.2

setKeepMessages back to summary

setKeepMessages	back to summary
public void setKeepMessages(boolean newValue) Implements abstract jakarta.faces.context.Flash.setKeepMessages. The default behavior of this method is to call `Flash#setKeepMessages(boolean)` on the wrapped `Flash` object. Parameters newValue:boolean Doc from jakarta.faces.context.Flash.setKeepMessages. the new value for this property on this session. Annotations @Override Since 2.2

public void setKeepMessages(boolean newValue)

Implements abstract jakarta.faces.context.Flash.setKeepMessages.

The default behavior of this method is to call Flash#setKeepMessages(boolean) on the wrapped Flash object.

Parameters

newValue:boolean

Doc from jakarta.faces.context.Flash.setKeepMessages.

the new value for this property on this session.

Annotations

@Override

Since

2.2

setRedirect back to summary

setRedirect	back to summary
public void setRedirect(boolean newValue) Implements abstract jakarta.faces.context.Flash.setRedirect. The default behavior of this method is to call `Flash#setRedirect(boolean)` on the wrapped `Flash` object. Parameters newValue:boolean Doc from jakarta.faces.context.Flash.setRedirect. the new value for this property on this session. Annotations @Override Since 2.2

public void setRedirect(boolean newValue)

Implements abstract jakarta.faces.context.Flash.setRedirect.

The default behavior of this method is to call Flash#setRedirect(boolean) on the wrapped Flash object.

Parameters

newValue:boolean

Doc from jakarta.faces.context.Flash.setRedirect.

the new value for this property on this session.

Annotations

@Override

Since

2.2

size back to summary

size	back to summary
public int size() Implements java.util.Map.size. The default behavior of this method is to call `Flash#size()` on the wrapped `Flash` object. Returns:int Doc from java.util.Map.size. the number of key-value mappings in this map Annotations @Override Since 2.2

public int size()

Implements java.util.Map.size.

The default behavior of this method is to call Flash#size() on the wrapped Flash object.

Returns:int

Doc from java.util.Map.size.

the number of key-value mappings in this map

Annotations

@Override

Since

2.2

values back to summary

values	back to summary
public Collection<Object> values() Implements java.util.Map.values. The default behavior of this method is to call `Flash#values()` on the wrapped `Flash` object. Returns:Collection<Object> Doc from java.util.Map.values. a collection view of the values contained in this map Annotations @Override Since 2.2

public Collection<Object> values()

Implements java.util.Map.values.

The default behavior of this method is to call Flash#values() on the wrapped Flash object.

Returns:Collection<Object>

Doc from java.util.Map.values.

a collection view of the values contained in this map

Annotations