Jakarta EE 11.0.0 · com.sun.faces.context.SessionMap

Modifier and Type	Class and Description
private static class	SessionMap.Mutex

Modifier and Type	Field and Description
private static final Logger	LOGGER
private static final String	MUTEX
private final HttpServletRequest	request
private final ProjectStage	stage

Access	Constructor and Description
public	SessionMap(HttpServletRequest request, ProjectStage stage)

Method Summary

Modifier and Type	Method and Description
public void	clear() Overrides com.sun.faces.context.BaseContextMap.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) Overrides java.util.AbstractMap.containsKey. Implements java.util.Map.containsKey. Returns `true` if this map contains a mapping for the specified key.
public static void	createMutex(HttpSession session)
public boolean	equals(Object object to be compared for equality with this map obj) Overrides java.util.AbstractMap.equals. Implements java.util.Map.equals. Compares the specified object with this map for equality.
public Object	get(Object the key whose associated value is to be returned key) Overrides java.util.AbstractMap.get. 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.
protected Iterator<Map.Entry<String, Object>>	getEntryIterator() Implements abstract com.sun.faces.context.BaseContextMap.getEntryIterator.
protected Iterator<String>	getKeyIterator() Implements abstract com.sun.faces.context.BaseContextMap.getKeyIterator.
public static Object	getMutex(Object session)
protected HttpSession	getSession(boolean createNew)
protected Iterator<Object>	getValueIterator() Implements abstract com.sun.faces.context.BaseContextMap.getValueIterator.
public int	hashCode() Overrides java.util.AbstractMap.hashCode. Implements java.util.Map.hashCode. Returns the hash code value for 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) Overrides java.util.AbstractMap.put. Implements java.util.Map.put. Associates the specified value with the specified key in this map (optional operation).
public void	putAll(Map<K, V> mappings to be stored in this map t) Overrides com.sun.faces.context.BaseContextMap.putAll. Implements java.util.Map.putAll. Copies all of the mappings from the specified map to this map (optional operation).
public Object	remove(Object key whose mapping is to be removed from the map key) Overrides com.sun.faces.context.BaseContextMap.remove. Implements java.util.Map.remove. Removes the mapping for a key from this map if it is present (optional operation).
public static void	removeMutex(HttpSession session)

Inherited from com.sun.faces.context.BaseContextMap:: entrySet keySet removeKey removeValue values

LOGGER	back to summary
private static final Logger LOGGER

MUTEX	back to summary
private static final String MUTEX

request	back to summary
private final HttpServletRequest request

stage	back to summary
private final ProjectStage stage

SessionMap	back to summary
public SessionMap(HttpServletRequest request, ProjectStage stage)

Method Detail

clear	back to summary
public void clear() Overrides com.sun.faces.context.BaseContextMap.clear. Implements java.util.Map.clear. Doc from java.util.AbstractMap.clear. Removes all of the mappings from this map (optional operation). The map will be empty after this call returns. Annotations @Override

clear

back to summary

public void clear()

Overrides com.sun.faces.context.BaseContextMap.clear.

Implements java.util.Map.clear.

Doc from java.util.AbstractMap.clear.

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

Annotations

@Override

containsKey back to summary

containsKey	back to summary
public boolean containsKey(Object key) Overrides java.util.AbstractMap.containsKey. Implements java.util.Map.containsKey. Doc from java.util.AbstractMap.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 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

public boolean containsKey(Object key)

Overrides java.util.AbstractMap.containsKey.

Implements java.util.Map.containsKey.

Doc from java.util.AbstractMap.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

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

createMutex	back to summary
public static void createMutex(HttpSession session)

equals back to summary

equals	back to summary
public boolean equals(Object obj) Overrides java.util.AbstractMap.equals. Implements java.util.Map.equals. Doc from java.util.AbstractMap.equals. Compares the specified object with this map for equality. Returns `true` if the given object is also a map and the two maps represent the same mappings. More formally, two maps `m1` and `m2` represent the same mappings if `m1.entrySet().equals(m2.entrySet())`. This ensures that the `equals` method works properly across different implementations of the `Map` interface. Parameters obj:Object object to be compared for equality with this map Returns:boolean `true` if the specified object is equal to this map Annotations @Override

public boolean equals(Object obj)

Overrides java.util.AbstractMap.equals.

Implements java.util.Map.equals.

Doc from java.util.AbstractMap.equals.

Compares the specified object with this map for equality. Returns true if the given object is also a map and the two maps represent the same mappings. More formally, two maps m1 and m2 represent the same mappings if m1.entrySet().equals(m2.entrySet()). This ensures that the equals method works properly across different implementations of the Map interface.

Parameters

obj:Object: object to be compared for equality with this map

Returns:boolean

true if the specified object is equal to this map

Annotations

@Override

get back to summary

get	back to summary
public Object get(Object key) Overrides java.util.AbstractMap.get. Implements java.util.Map.get. Doc from java.util.AbstractMap.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 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

public Object get(Object key)

Overrides java.util.AbstractMap.get.

Implements java.util.Map.get.

Doc from java.util.AbstractMap.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

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

getEntryIterator	back to summary
protected Iterator<Map.Entry<String, Object>> getEntryIterator() Implements abstract com.sun.faces.context.BaseContextMap.getEntryIterator. Annotations @Override

getEntryIterator

back to summary

protected Iterator<Map.Entry<String, Object>> getEntryIterator()

Implements abstract com.sun.faces.context.BaseContextMap.getEntryIterator.

Annotations

@Override

getKeyIterator	back to summary
protected Iterator<String> getKeyIterator() Implements abstract com.sun.faces.context.BaseContextMap.getKeyIterator. Annotations @Override

getKeyIterator

back to summary

protected Iterator<String> getKeyIterator()

Implements abstract com.sun.faces.context.BaseContextMap.getKeyIterator.

Annotations

@Override

getMutex	back to summary
public static Object getMutex(Object session)

getSession	back to summary
protected HttpSession getSession(boolean createNew)

getValueIterator	back to summary
protected Iterator<Object> getValueIterator() Implements abstract com.sun.faces.context.BaseContextMap.getValueIterator. Annotations @Override

getValueIterator

back to summary

protected Iterator<Object> getValueIterator()

Implements abstract com.sun.faces.context.BaseContextMap.getValueIterator.

Annotations

@Override

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.util.AbstractMap.hashCode. Implements java.util.Map.hashCode. Doc from java.util.AbstractMap.hashCode. Returns the hash code value for this map. The hash code of a map is defined to be the sum of the hash codes of each entry in the map's `entrySet()` view. This ensures that `m1.equals(m2)` implies that `m1.hashCode()==m2.hashCode()` for any two maps `m1` and `m2`, as required by the general contract of `Object#hashCode`. Returns:int the hash code value for this map Annotations @Override

public int hashCode()

Overrides java.util.AbstractMap.hashCode.

Implements java.util.Map.hashCode.

Doc from java.util.AbstractMap.hashCode.

Returns the hash code value for this map. The hash code of a map is defined to be the sum of the hash codes of each entry in the map's entrySet() view. This ensures that m1.equals(m2) implies that m1.hashCode()==m2.hashCode() for any two maps m1 and m2, as required by the general contract of Object#hashCode.

Returns:int

the hash code value for this map

Annotations

@Override

put back to summary

put	back to summary
public Object put(String key, Object value) Overrides java.util.AbstractMap.put. Implements java.util.Map.put. Doc from java.util.AbstractMap.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 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

public Object put(String key, Object value)

Overrides java.util.AbstractMap.put.

Implements java.util.Map.put.

Doc from java.util.AbstractMap.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

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

putAll back to summary

putAll	back to summary
public void putAll(Map<K, V> t) Overrides com.sun.faces.context.BaseContextMap.putAll. Implements java.util.Map.putAll. Doc from java.util.AbstractMap.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 t:Map<K, V> Doc from java.util.Map.putAll. mappings to be stored in this map Annotations @Override

public void putAll(Map<K, V> t)

Overrides com.sun.faces.context.BaseContextMap.putAll.

Implements java.util.Map.putAll.

Doc from java.util.AbstractMap.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

t:Map<K, V>

Doc from java.util.Map.putAll.

mappings to be stored in this map

Annotations

@Override

remove back to summary

remove	back to summary
public Object remove(Object key) Overrides com.sun.faces.context.BaseContextMap.remove. Implements java.util.Map.remove. Doc from java.util.AbstractMap.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 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

public Object remove(Object key)

Overrides com.sun.faces.context.BaseContextMap.remove.

Implements java.util.Map.remove.

Doc from java.util.AbstractMap.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

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

removeMutex	back to summary
public static void removeMutex(HttpSession session)

public Class SessionMap

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class SessionMap.Mutex

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail