Top Fields Constructors Methods
com.sun.faces.config.initfacescontext

public Class NoOpFlash

extends Flash
Class Inheritance
Static Imports
java.util.Collections.emptyList

Field Summary

Inherited from jakarta.faces.context.Flash:
NULL_VALUE

Constructor Summary

AccessConstructor and Description
public
NoOpFlash()

Method Summary

Modifier and TypeMethod and Description
public void
clear()

Implements java.util.Map.clear.

Removes all of the mappings from this map (optional operation).

public boolean
containsKey(Object
key whose presence in this map is to be tested
key)

Implements java.util.Map.containsKey.

Returns true if this map contains a mapping for the specified key.

public boolean
containsValue(Object
value whose presence in this map is to be tested
value)

Implements java.util.Map.containsValue.

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

public void
doPostPhaseActions(FacesContext
the FacesContext for this request.
ctx)

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

Called after the execution of every lifecycle phase, this method allows implementations to take the necessary actions to provide the Flash scope contract as it applies to the request procesing lifecycle.

public void
doPrePhaseActions(FacesContext
the FacesContext for this request.
ctx)

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

Called before the execution of every lifecycle phase, this method allows implementations to take the necessary actions to provide the Flash scope contract as it applies to the request procesing lifecycle.

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

Implements java.util.Map.entrySet.

Returns a Set view of the mappings contained in this map.

public Object
get(Object
the key whose associated value is to be returned
key)

Implements java.util.Map.get.

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

public boolean
isEmpty()

Implements java.util.Map.isEmpty.

Returns true if this map contains no key-value mappings.

public boolean
isKeepMessages()

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

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

public boolean
isRedirect()

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

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

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.

Causes a value stored with a previous call to putNow, its Jakarta Expression Language equivalent, or to the request Map, to be promoted to the flash so that is available on the next traversal through the lifecycle on this session.

public Set<String>
keySet()

Implements java.util.Map.keySet.

Returns a Set view of the keys contained in this map.

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.

Associates the specified value with the specified key in this map (optional operation).

public void
putAll(Map<? extends String, ? extends Object>
mappings to be stored in this map
m)

Implements java.util.Map.putAll.

Copies all of the mappings from the specified map to this map (optional operation).

public void
putNow(String
the key for this entry
key, Object
the value for this entry
value)

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

Puts a value in the flash so that it can be accessed on this traversal of the lifecycle, rather than on the next traversal.

public Object
remove(Object
key whose mapping is to be removed from the map
key)

Implements java.util.Map.remove.

Removes the mapping for a key from this map if it is present (optional operation).

public void
setKeepMessages(boolean
the new value for this property on this session.
newValue)

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

Setter for keepMessages JavaBeans property.

public void
setRedirect(boolean
the new value for this property on this session.
newValue)

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

Setting this property to true indicates that the next request on this session will be a redirect.

public int
size()

Implements java.util.Map.size.

Returns the number of key-value mappings in this map.

public Collection<Object>
values()

Implements java.util.Map.values.

Returns a Collection view of the values contained in this map.

Constructor Detail

NoOpFlashback to summary
public NoOpFlash()

Method Detail

clearback to summary
public void clear()

Implements java.util.Map.clear.

Doc from java.util.Map.clear.

Removes all of the mappings from this map (optional operation). The map will be empty after this call returns.

Annotations
@Override
containsKeyback to summary
public boolean containsKey(Object key)

Implements java.util.Map.containsKey.

Doc from java.util.Map.containsKey.

Returns true if this map contains a mapping for the specified key. More formally, returns true if and only if this map contains a mapping for a key k such that Objects.equals(key, k). (There can be at most one such mapping.)

Parameters
key:Object

key whose presence in this map is to be tested

Returns:boolean

true if this map contains a mapping for the specified key

Annotations
@Override
containsValueback to summary
public boolean containsValue(Object value)

Implements java.util.Map.containsValue.

Doc from java.util.Map.containsValue.

Returns true if this map maps one or more keys to the specified value. More formally, returns true if and only if this map contains at least one mapping to a value v such that Objects.equals(value, v). This operation will probably require time linear in the map size for most implementations of the Map interface.

Parameters
value:Object

value whose presence in this map is to be tested

Returns:boolean

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

Annotations
@Override
doPostPhaseActionsback to summary
public void doPostPhaseActions(FacesContext ctx)

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

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

Called after the execution of every lifecycle phase, this method allows implementations to take the necessary actions to provide the Flash scope contract as it applies to the request procesing lifecycle.

Parameters
ctx:FacesContext

the FacesContext for this request.

Annotations
@Override
doPrePhaseActionsback to summary
public void doPrePhaseActions(FacesContext ctx)

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

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

Called before the execution of every lifecycle phase, this method allows implementations to take the necessary actions to provide the Flash scope contract as it applies to the request procesing lifecycle.

Parameters
ctx:FacesContext

the FacesContext for this request.

Annotations
@Override
entrySetback to summary
public Set<Map.Entry<String, Object>> entrySet()

Implements java.util.Map.entrySet.

Doc from java.util.Map.entrySet.

Returns a Set view of the mappings contained in this map. The set is backed by the map, so changes to the map are reflected in the set, and vice-versa. If the map is modified while an iteration over the set is in progress (except through the iterator's own remove operation, or through the setValue operation on a map entry returned by the iterator) the results of the iteration are undefined. The set supports element removal, which removes the corresponding mapping from the map, via the Iterator.remove, Set.remove, removeAll, retainAll and clear operations. It does not support the add or addAll operations.

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

a set view of the mappings contained in this map

Annotations
@Override
getback to summary
public Object get(Object key)

Implements java.util.Map.get.

Doc from java.util.Map.get.

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

More formally, if this map contains a mapping from a key k to a value v such that Objects.equals(key, k), then this method returns v; otherwise it returns null. (There can be at most one such mapping.)

If this map permits null values, then a return value of null does not necessarily indicate that the map contains no mapping for the key; it's also possible that the map explicitly maps the key to null. The containsKey operation may be used to distinguish these two cases.

Parameters
key:Object

the key whose associated value is to be returned

Returns:Object

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

Annotations
@Override
isEmptyback to summary
public boolean isEmpty()

Implements java.util.Map.isEmpty.

Doc from java.util.Map.isEmpty.

Returns true if this map contains no key-value mappings.

Returns:boolean

true if this map contains no key-value mappings

Annotations
@Override
isKeepMessagesback to summary
public boolean isKeepMessages()

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

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

Return the value of this JavaBeans property for the flash for this session. This value determines whether or not any jakarta.faces.application.FacesMessage instances queued in the current jakarta.faces.context.FacesContext must be preserved so they are accessible on the next traversal of the lifecycle on this session, regardless of the request being a redirect after post, or a normal postback. Map accesses for the special key “keepMessages” must return the value of this JavaBeans property.

Jakarta Expression Language Usage Example

First page 


   <html xmlns="http://www.w3.org/1999/xhtml"
         xmlns:c="jakarta.tags.core">
   <!-- extra code removed -->
     <c:set target="#{flash}" property="keepMessages" value="true" />

Next page 


   <html xmlns="http://www.w3.org/1999/xhtml"
         xmlns:h="jakarta.faces.html">
   <!-- extra code removed -->
     <h:messages /> Any messages present on the first page must be displayed on
     this page.
Returns:boolean

the boolean flag whether keeping messages or not.

Annotations
@Override
isRedirectback to summary
public boolean isRedirect()

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

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

Return the value of this property for the flash for this session. This must be false unless:

  • setRedirect was called for the current lifecycle traversal with true as the argument.

  • The current lifecycle traversal for this session is in the “execute” phase and the previous traversal had setRedirect called with true as the argument.

Returns:boolean

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

Annotations
@Override
keepback to summary
public void keep(String key)

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

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

Causes a value stored with a previous call to putNow, its Jakarta Expression Language equivalent, or to the request Map, to be promoted to the flash so that is available on the next traversal through the lifecycle on this session.

Parameters
key: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.

Annotations
@Override
keySetback to summary
public Set<String> keySet()

Implements java.util.Map.keySet.

Doc from java.util.Map.keySet.

Returns a Set view of the keys contained in this map. The set is backed by the map, so changes to the map are reflected in the set, and vice-versa. If the map is modified while an iteration over the set is in progress (except through the iterator's own remove operation), the results of the iteration are undefined. The set supports element removal, which removes the corresponding mapping from the map, via the Iterator.remove, Set.remove, removeAll, retainAll, and clear operations. It does not support the add or addAll operations.

Returns:Set<String>

a set view of the keys contained in this map

Annotations
@Override
putback to summary
public Object put(String key, Object value)

Implements java.util.Map.put.

Doc from java.util.Map.put.

Associates the specified value with the specified key in this map (optional operation). If the map previously contained a mapping for the key, the old value is replaced by the specified value. (A map m is said to contain a mapping for a key k if and only if m.containsKey(k) would return true.)

Parameters
key:String

key with which the specified value is to be associated

value:Object

value to be associated with the specified key

Returns:Object

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
putAllback to summary
public void putAll(Map<? extends String, ? extends Object> m)

Implements java.util.Map.putAll.

Doc from java.util.Map.putAll.

Copies all of the mappings from the specified map to this map (optional operation). The effect of this call is equivalent to that of calling put(k, v) on this map once for each mapping from key k to value v in the specified map. The behavior of this operation is undefined if the specified map is modified while the operation is in progress. If the specified map has a defined encounter order, processing of its mappings generally occurs in that order.

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

mappings to be stored in this map

Annotations
@Override
putNowback to summary
public void putNow(String key, Object value)

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

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

Puts a value in the flash so that it can be accessed on this traversal of the lifecycle, rather than on the next traversal. This is simply an alias for putting a value in the request map.

Jakarta Expression Language Usage Example 


   <html xmlns="http://www.w3.org/1999/xhtml"
         xmlns:c="jakarta.tags.core">
   <!-- extra code removed -->
     <c:set target="#{flash.now}" property="bar" value="barValue" />

     <p>Value of \#{flash.now.bar}, should be barValue.</p>

     <h:outputText value="#{flash.now.bar}" />
Parameters
key:String

the key for this entry

value:Object

the value for this entry

Annotations
@Override
removeback to summary
public Object remove(Object key)

Implements java.util.Map.remove.

Doc from java.util.Map.remove.

Removes the mapping for a key from this map if it is present (optional operation). More formally, if this map contains a mapping from key k to value v such that Objects.equals(key, k), that mapping is removed. (The map can contain at most one such mapping.)

Returns the value to which this map previously associated the key, or null if the map contained no mapping for the key.

If this map permits null values, then a return value of null does not necessarily indicate that the map contained no mapping for the key; it's also possible that the map explicitly mapped the key to null.

The map will not contain a mapping for the specified key once the call returns.

Parameters
key:Object

key whose mapping is to be removed from the map

Returns:Object

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

Annotations
@Override
setKeepMessagesback to summary
public void setKeepMessages(boolean newValue)

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

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

Setter for keepMessages JavaBeans property. See isKeepMessages.

Parameters
newValue:boolean

the new value for this property on this session.

Annotations
@Override
setRedirectback to summary
public void setRedirect(boolean newValue)

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

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

Setting this property to true indicates that the next request on this session will be a redirect. Recall that on a redirect, the server sends a special response to the client instructing it to issue a new request to a specific URI. The implementation must insure that reading the value of this property on that request will return true.

Jakarta Expression Language Usage Example 


   <html xmlns="http://www.w3.org/1999/xhtml"
         xmlns:c="jakarta.tags.core">
   <!-- extra code removed -->
     <c:set target="#{flash}" property="redirect" value="true" />
Parameters
newValue:boolean

the new value for this property on this session.

Annotations
@Override
sizeback to summary
public int size()

Implements java.util.Map.size.

Doc from java.util.Map.size.

Returns the number of key-value mappings in this map. If the map contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE.

Returns:int

the number of key-value mappings in this map

Annotations
@Override
valuesback to summary
public Collection<Object> values()

Implements java.util.Map.values.

Doc from java.util.Map.values.

Returns a Collection view of the values contained in this map. The collection is backed by the map, so changes to the map are reflected in the collection, and vice-versa. If the map is modified while an iteration over the collection is in progress (except through the iterator's own remove operation), the results of the iteration are undefined. The collection supports element removal, which removes the corresponding mapping from the map, via the Iterator.remove, Collection.remove, removeAll, retainAll and clear operations. It does not support the add or addAll operations.

Returns:Collection<Object>

a collection view of the values contained in this map

Annotations
@Override