org.apache.myfaces.shared.context.flash

Class FlashImpl

java.lang.Object

javax.faces.context.Flash

org.apache.myfaces.shared.context.flash.FlashImpl

All Implemented Interfaces:

Map<String,Object>

public class FlashImpl
extends Flash

Implementation of Flash object

Version:

$Revision: 1533534 $ $Date: 2013-10-18 11:19:43 -0500 (Fri, 18 Oct 2013) $

Author:

Leonardo Uribe (latest modification by $Author: lu4242 $), Jakob Korherr

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
FlashImpl(ExternalContext externalContext)

Method Summary

Methods

Modifier and Type	Method and Description
void	clear()
boolean	containsKey(Object key)
boolean	containsValue(Object value)
void	doPostPhaseActions(FacesContext facesContext) Used to destroy the executeMap and to save all FacesMessages for the next request, but only if this is the last invocation of this method in the current lifecycle (if redirect phase 5, otherwise phase 6).
void	doPrePhaseActions(FacesContext facesContext) Used to restore the redirect value and the FacesMessages of the previous request and to manage the flashMap tokens for this request before phase restore view starts.
Set<Map.Entry<String,Object>>	entrySet()
Object	get(Object key)
static Flash	getCurrentInstance(ExternalContext context) Return a Flash instance from the application map
boolean	isEmpty()
boolean	isKeepMessages() Returns the value of a previous call to setKeepMessages() from this request.
boolean	isRedirect() Return the value of this property for the flash for this session.
void	keep(String key) Take a value from the requestMap, or if it does not exist from the execute FlashMap, and put it on the render FlashMap, so it is visible on the next request.
Set<String>	keySet()
Object	put(String key, Object value)
void	putAll(Map<? extends String,? extends Object> m)
void	putNow(String key, Object value) This is just an alias for the request scope map.
Object	remove(Object key)
void	setKeepMessages(boolean keepMessages) If this property is true, the messages should be kept for the next request, no matter if it is a normal postback case or a POST- REDIRECT-GET case.
void	setRedirect(boolean redirect)
int	size()
Collection<Object>	values()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.Map

equals, hashCode

Constructor Detail

FlashImpl

public FlashImpl(ExternalContext externalContext)

Method Detail

getCurrentInstance

public static Flash getCurrentInstance(ExternalContext context)

Return a Flash instance from the application map

Parameters:

context -

Returns:

doPrePhaseActions

public void doPrePhaseActions(FacesContext facesContext)

Used to restore the redirect value and the FacesMessages of the previous request and to manage the flashMap tokens for this request before phase restore view starts.

Specified by:

doPrePhaseActions in class Flash

doPostPhaseActions

public void doPostPhaseActions(FacesContext facesContext)

Used to destroy the executeMap and to save all FacesMessages for the next request, but only if this is the last invocation of this method in the current lifecycle (if redirect phase 5, otherwise phase 6).

Specified by:

doPostPhaseActions in class Flash

isRedirect

public boolean isRedirect()

Return the value of this property for the flash for this session. This must be false unless: - setRedirect(boolean) 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(boolean) called with true as the argument.

Specified by:

isRedirect in class Flash

setRedirect

public void setRedirect(boolean redirect)

Specified by:

setRedirect in class Flash

keep

public void keep(String key)

Take a value from the requestMap, or if it does not exist from the execute FlashMap, and put it on the render FlashMap, so it is visible on the next request.

Specified by:

keep in class Flash

putNow

public void putNow(String key,
          Object value)

This is just an alias for the request scope map.

Specified by:

putNow in class Flash

isKeepMessages

public boolean isKeepMessages()

Returns the value of a previous call to setKeepMessages() from this request. If there was no call yet, false is returned.

Specified by:

isKeepMessages in class Flash

setKeepMessages

public void setKeepMessages(boolean keepMessages)

If this property is true, the messages should be kept for the next request, no matter if it is a normal postback case or a POST- REDIRECT-GET case. Note that we don't have to store this value for the next request (like setRedirect()), because we will know if it was true on the next request, if we can find any stored messages in the FlashMap. (also see _saveMessages() and _restoreMessages()).

Specified by:

setKeepMessages in class Flash

clear

public void clear()

containsKey

public boolean containsKey(Object key)

containsValue

public boolean containsValue(Object value)

entrySet

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

get

public Object get(Object key)

isEmpty

public boolean isEmpty()

keySet

public Set<String> keySet()

put

public Object put(String key,
         Object value)

putAll

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

remove

public Object remove(Object key)

size

public int size()

values

public Collection<Object> values()