Module com.aoapps.servlet.util

Package com.aoapps.servlet.attribute

Class AttributeEE.Session<T>

java.lang.Object

com.aoapps.lang.attribute.Attribute<HttpSession,T>

com.aoapps.servlet.attribute.AttributeEE<HttpSession,T>

com.aoapps.servlet.attribute.AttributeEE.Session<T>

Enclosing class:

AttributeEE<C,T>

public static final class AttributeEE.Session<T>
extends AttributeEE<HttpSession,T>

A session-scope attribute.

Nested Class Summary

Nested classes/interfaces inherited from class com.aoapps.servlet.attribute.AttributeEE

AttributeEE.Application<T>, AttributeEE.Jstl<T>, AttributeEE.Name<T>, AttributeEE.Page<T>, AttributeEE.Request<T>, AttributeEE.Session<T>

Nested classes/interfaces inherited from class com.aoapps.lang.attribute.Attribute

Attribute.OldValue

Field Summary

Fields inherited from class com.aoapps.lang.attribute.Attribute

name

Method Summary

Modifier and Type	Method	Description
<Ex extends Throwable> T	compute(BiFunctionE<? super String,? super T,? extends T,? extends Ex> remappingFunction)	Much like Map.compute(java.lang.Object, java.util.function.BiFunction), but for this session-scope attribute.
static <T, Ex extends Throwable> T	compute(HttpSession session, String name, BiFunctionE<? super String,? super T,? extends T,? extends Ex> remappingFunction)	Much like Map.compute(java.lang.Object, java.util.function.BiFunction), but for a session-scope attribute.
<Ex extends Throwable> T	computeIfAbsent(FunctionE<? super String,? extends T,? extends Ex> mappingFunction)	Much like Map.computeIfAbsent(java.lang.Object, java.util.function.Function), but for this session-scope attribute.
static <T, Ex extends Throwable> T	computeIfAbsent(HttpSession session, String name, FunctionE<? super String,? extends T,? extends Ex> mappingFunction)	Much like Map.computeIfAbsent(java.lang.Object, java.util.function.Function), but for a session-scope attribute.
<Ex extends Throwable> T	computeIfPresent(BiFunctionE<? super String,? super T,? extends T,? extends Ex> remappingFunction)	Much like Map.computeIfPresent(java.lang.Object, java.util.function.BiFunction), but for this session-scope attribute.
static <T, Ex extends Throwable> T	computeIfPresent(HttpSession session, String name, BiFunctionE<? super String,? super T,? extends T,? extends Ex> remappingFunction)	Much like Map.computeIfPresent(java.lang.Object, java.util.function.BiFunction), but for a session-scope attribute.
T	get()	Gets the value of this session-scope attribute.
static <T> T	get(HttpSession session, String name)	Gets a session-scope attribute.
ContextEE.Session	getContext()	Gets the session context for this attribute.
static <T> T	getOrDefault(HttpSession session, String name, T defaultValue)	Much like Map.getOrDefault(java.lang.Object, java.lang.Object), but for a session-scope attribute.
T	getOrDefault(T defaultValue)	Much like Map.getOrDefault(java.lang.Object, java.lang.Object), but for this session-scope attribute.
Attribute.OldValue	init(T value)	Initializes this session-scope attribute, returning a backup value, which must be closed to restore the old value.
static <T, Ex extends Throwable> T	merge(HttpSession session, String name, T value, BiFunctionE<? super T,? super T,? extends T,? extends Ex> remappingFunction)	Much like Map.merge(java.lang.Object, java.lang.Object, java.util.function.BiFunction), but for a session-scope attribute.
<Ex extends Throwable> T	merge(T value, BiFunctionE<? super T,? super T,? extends T,? extends Ex> remappingFunction)	Much like Map.merge(java.lang.Object, java.lang.Object, java.util.function.BiFunction), but for this session-scope attribute.
void	remove()	Removes the value from this session-scope attribute.
static void	remove(HttpSession session, String name)	Removes a session-scope attribute.
static <T> boolean	remove(HttpSession session, String name, T value)	Much like Map.remove(java.lang.Object, java.lang.Object), but for a session-scope attribute.
boolean	remove(T value)	Much like Map.remove(java.lang.Object, java.lang.Object), but for this session-scope attribute.
static <T> T	replace(HttpSession session, String name, T value)	Much like Map.replace(java.lang.Object, java.lang.Object), but for a session-scope attribute.
static <T> boolean	replace(HttpSession session, String name, T oldValue, T newValue)	Much like Map.replace(java.lang.Object, java.lang.Object, java.lang.Object), but for a session-scope attribute.
T	replace(T value)	Much like Map.replace(java.lang.Object, java.lang.Object), but for this session-scope attribute.
boolean	replace(T oldValue, T newValue)	Much like Map.replace(java.lang.Object, java.lang.Object, java.lang.Object), but for this session-scope attribute.
static <T> void	set(HttpSession session, String name, T value)	Sets a session-scope attribute.
void	set(T value)	Sets the value of this session-scope attribute.
static <T> T	setIfAbsent(HttpSession session, String name, T value)	Much like Map.putIfAbsent(java.lang.Object, java.lang.Object), but for a session-scope attribute.
T	setIfAbsent(T value)	Much like Map.putIfAbsent(java.lang.Object, java.lang.Object), but for this session-scope attribute.

Methods inherited from class com.aoapps.servlet.attribute.AttributeEE

attribute, jstl

Methods inherited from class com.aoapps.lang.attribute.Attribute

getName

Methods inherited from class java.lang.Object

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

Method Details

getContext

public ContextEE.Session getContext()

Gets the session context for this attribute.

Specified by:

getContext in class AttributeEE<HttpSession,T>

init

public Attribute.OldValue init(T value)

Initializes this session-scope attribute, returning a backup value, which must be closed to restore the old value. This is best used in try-with-resources.

Specified by:

init in class Attribute<HttpSession,T>

compute

public static <T,
Ex extends Throwable> T compute(HttpSession session,
 String name,
 BiFunctionE<? super String,? super T,? extends T,? extends Ex> remappingFunction)
                                           throws Ex

Much like Map.compute(java.lang.Object, java.util.function.BiFunction), but for a session-scope attribute. Synchronizes on session to ensure atomic operation.

Throws:

Ex

See Also:

• Map.compute(java.lang.Object, java.util.function.BiFunction)

compute

public <Ex extends Throwable> T compute(BiFunctionE<? super String,? super T,? extends T,? extends Ex> remappingFunction)
                                 throws Ex

Much like Map.compute(java.lang.Object, java.util.function.BiFunction), but for this session-scope attribute. Synchronizes on session to ensure atomic operation.

Specified by:

compute in class Attribute<HttpSession,T>

Throws:

Ex

See Also:

• Map.compute(java.lang.Object, java.util.function.BiFunction)

computeIfAbsent

public static <T,
Ex extends Throwable> T computeIfAbsent(HttpSession session,
 String name,
 FunctionE<? super String,? extends T,? extends Ex> mappingFunction)
                                                   throws Ex

Much like Map.computeIfAbsent(java.lang.Object, java.util.function.Function), but for a session-scope attribute. Synchronizes on session to ensure atomic operation.

Throws:

Ex

See Also:

• Map.computeIfAbsent(java.lang.Object, java.util.function.Function)

computeIfAbsent

public <Ex extends Throwable> T computeIfAbsent(FunctionE<? super String,? extends T,? extends Ex> mappingFunction)
                                         throws Ex

Much like Map.computeIfAbsent(java.lang.Object, java.util.function.Function), but for this session-scope attribute. Synchronizes on session to ensure atomic operation.

Specified by:

computeIfAbsent in class Attribute<HttpSession,T>

Throws:

Ex

See Also:

• Map.computeIfAbsent(java.lang.Object, java.util.function.Function)

computeIfPresent

public static <T,
Ex extends Throwable> T computeIfPresent(HttpSession session,
 String name,
 BiFunctionE<? super String,? super T,? extends T,? extends Ex> remappingFunction)
                                                    throws Ex

Much like Map.computeIfPresent(java.lang.Object, java.util.function.BiFunction), but for a session-scope attribute. Synchronizes on session to ensure atomic operation.

Throws:

Ex

See Also:

• Map.computeIfPresent(java.lang.Object, java.util.function.BiFunction)

computeIfPresent

public <Ex extends Throwable> T computeIfPresent(BiFunctionE<? super String,? super T,? extends T,? extends Ex> remappingFunction)
                                          throws Ex

Much like Map.computeIfPresent(java.lang.Object, java.util.function.BiFunction), but for this session-scope attribute. Synchronizes on session to ensure atomic operation.

Specified by:

computeIfPresent in class Attribute<HttpSession,T>

Throws:

Ex

See Also:

• Map.computeIfPresent(java.lang.Object, java.util.function.BiFunction)

get

public static <T> T get(HttpSession session,
 String name)

Gets a session-scope attribute.

Parameters:

session - may be null, which will return null

get

public T get()

Gets the value of this session-scope attribute.

Specified by:

get in class Attribute<HttpSession,T>

getOrDefault

public static <T> T getOrDefault(HttpSession session,
 String name,
 T defaultValue)

Much like Map.getOrDefault(java.lang.Object, java.lang.Object), but for a session-scope attribute.

Parameters:

session - may be null, which will return defaultValue

See Also:

• Map.getOrDefault(java.lang.Object, java.lang.Object)

getOrDefault

public T getOrDefault(T defaultValue)

Much like Map.getOrDefault(java.lang.Object, java.lang.Object), but for this session-scope attribute.

Specified by:

getOrDefault in class Attribute<HttpSession,T>

See Also:

• Map.getOrDefault(java.lang.Object, java.lang.Object)

merge

public static <T,
Ex extends Throwable> T merge(HttpSession session,
 String name,
 T value,
 BiFunctionE<? super T,? super T,? extends T,? extends Ex> remappingFunction)
                                         throws Ex

Much like Map.merge(java.lang.Object, java.lang.Object, java.util.function.BiFunction), but for a session-scope attribute. Synchronizes on session to ensure atomic operation.

Throws:

Ex

See Also:

• Map.merge(java.lang.Object, java.lang.Object, java.util.function.BiFunction)

merge

public <Ex extends Throwable> T merge(T value,
 BiFunctionE<? super T,? super T,? extends T,? extends Ex> remappingFunction)
                               throws Ex

Much like Map.merge(java.lang.Object, java.lang.Object, java.util.function.BiFunction), but for this session-scope attribute. Synchronizes on session to ensure atomic operation.

Specified by:

merge in class Attribute<HttpSession,T>

Throws:

Ex

See Also:

• Map.merge(java.lang.Object, java.lang.Object, java.util.function.BiFunction)

remove

public static void remove(HttpSession session,
 String name)

Removes a session-scope attribute.

Parameters:

session - may be null, which will skip removal

remove

public void remove()

Removes the value from this session-scope attribute.

Specified by:

remove in class Attribute<HttpSession,T>

remove

public static <T> boolean remove(HttpSession session,
 String name,
 T value)

Much like Map.remove(java.lang.Object, java.lang.Object), but for a session-scope attribute. Synchronizes on session to ensure atomic operation.

See Also:

• Map.remove(java.lang.Object, java.lang.Object)

remove

public boolean remove(T value)

Much like Map.remove(java.lang.Object, java.lang.Object), but for this session-scope attribute. Synchronizes on session to ensure atomic operation.

Specified by:

remove in class Attribute<HttpSession,T>

See Also:

• Map.remove(java.lang.Object, java.lang.Object)

replace

public static <T> T replace(HttpSession session,
 String name,
 T value)

Much like Map.replace(java.lang.Object, java.lang.Object), but for a session-scope attribute. Synchronizes on session to ensure atomic operation.

See Also:

• Map.replace(java.lang.Object, java.lang.Object)

replace

public T replace(T value)

Much like Map.replace(java.lang.Object, java.lang.Object), but for this session-scope attribute. Synchronizes on session to ensure atomic operation.

Specified by:

replace in class Attribute<HttpSession,T>

See Also:

• Map.replace(java.lang.Object, java.lang.Object)

replace

public static <T> boolean replace(HttpSession session,
 String name,
 T oldValue,
 T newValue)

Much like Map.replace(java.lang.Object, java.lang.Object, java.lang.Object), but for a session-scope attribute. Synchronizes on session to ensure atomic operation.

See Also:

• Map.replace(java.lang.Object, java.lang.Object, java.lang.Object)

replace

public boolean replace(T oldValue,
 T newValue)

Much like Map.replace(java.lang.Object, java.lang.Object, java.lang.Object), but for this session-scope attribute. Synchronizes on session to ensure atomic operation.

Specified by:

replace in class Attribute<HttpSession,T>

See Also:

• Map.replace(java.lang.Object, java.lang.Object, java.lang.Object)

set

public static <T> void set(HttpSession session,
 String name,
 T value)

Sets a session-scope attribute.

set

public void set(T value)

Sets the value of this session-scope attribute.

Specified by:

set in class Attribute<HttpSession,T>

setIfAbsent

public static <T> T setIfAbsent(HttpSession session,
 String name,
 T value)

Much like Map.putIfAbsent(java.lang.Object, java.lang.Object), but for a session-scope attribute. Synchronizes on session to ensure atomic operation.

See Also:

• Map.putIfAbsent(java.lang.Object, java.lang.Object)

setIfAbsent

public T setIfAbsent(T value)

Much like Map.putIfAbsent(java.lang.Object, java.lang.Object), but for this session-scope attribute. Synchronizes on session to ensure atomic operation.

Specified by:

setIfAbsent in class Attribute<HttpSession,T>

See Also:

• Map.putIfAbsent(java.lang.Object, java.lang.Object)