ninja.session

Interface FlashScope

All Known Implementing Classes:

FlashScopeImpl

public interface FlashScope

Flash scope: A client side cookie that can be used to transfer information from one request to another. Stuff in a flash cookie gets deleted after the next request. Please note also that flash cookies are not signed.

Method Summary

Modifier and Type	Method and Description
void	clearCurrentFlashCookieData()
boolean	contains(String key)
void	discard()
void	discard(String key)
void	error(String value) Sets the error flash cookie value.
String	get(String key)
Map<String,String>	getCurrentFlashCookieData()
Map<String,String>	getOutgoingFlashCookieData()
void	init(Context context)
void	keep()
void	keep(String key)
void	now(String key, String value)
void	put(String key, Object value)
void	put(String key, String value)
boolean	remove(String key)
void	save(Context context, Result result)
void	success(String value) Sets the success flash cookie value.
String	toString()

Method Detail

init

void init(Context context)

save

void save(Context context,
          Result result)

put

void put(String key,
         String value)

put

void put(String key,
         Object value)

now

void now(String key,
         String value)

error

void error(String value)

Sets the error flash cookie value. Usually accessible via ${flash.error} in html templating engine.

Parameters:

value - The i18n key used to retrieve value of that message OR an already translated message that will be displayed right away.

success

void success(String value)

Sets the success flash cookie value. Usually accessible via ${flash.success} in html templating engine.

Parameters:

value - The i18n key used to retrieve value of that message OR an already translated message that will be displayed right away.

discard

void discard(String key)

discard

void discard()

keep

void keep(String key)

keep

void keep()

get

String get(String key)

remove

boolean remove(String key)

clearCurrentFlashCookieData

void clearCurrentFlashCookieData()

contains

boolean contains(String key)

toString

String toString()

Overrides:

toString in class Object

getCurrentFlashCookieData

Map<String,String> getCurrentFlashCookieData()

getOutgoingFlashCookieData

Map<String,String> getOutgoingFlashCookieData()