public interface IoSessionAttributeMap
IoSession
.
All user-defined attribute accesses in IoSession
are forwarded to
the instance of IoSessionAttributeMap
.Modifier and Type | Method and Description |
---|---|
boolean |
containsAttribute(IoSession session,
Object key) |
void |
dispose(IoSession session)
Disposes any releases associated with the specified session.
|
Object |
getAttribute(IoSession session,
Object key,
Object defaultValue) |
Set<Object> |
getAttributeKeys(IoSession session) |
Object |
removeAttribute(IoSession session,
Object key)
Removes a user-defined attribute with the specified key.
|
boolean |
removeAttribute(IoSession session,
Object key,
Object value)
Removes a user defined attribute with the specified key if the current
attribute value is equal to the specified value.
|
boolean |
replaceAttribute(IoSession session,
Object key,
Object oldValue,
Object newValue)
Replaces a user defined attribute with the specified key if the
value of the attribute is equals to the specified old value.
|
Object |
setAttribute(IoSession session,
Object key,
Object value)
Sets a user-defined attribute.
|
Object |
setAttributeIfAbsent(IoSession session,
Object key,
Object value)
Sets a user defined attribute if the attribute with the specified key
is not set yet.
|
Object getAttribute(IoSession session, Object key, Object defaultValue)
session
- the session for which we want to get an attributekey
- The key we are looking fordefaultValue
- The default returned value if the attribute is not foundif (containsAttribute(key)) { return getAttribute(key); } else { setAttribute(key, defaultValue); return defaultValue; }
Object setAttribute(IoSession session, Object key, Object value)
session
- the session for which we want to set an attributekey
- the key of the attributevalue
- the value of the attributeObject setAttributeIfAbsent(IoSession session, Object key, Object value)
if (containsAttribute(key)) { return getAttribute(key); } else { return setAttribute(key, value); }
session
- the session for which we want to set an attributekey
- The key we are looking forvalue
- The value to injectObject removeAttribute(IoSession session, Object key)
session
- the session for which we want to remove an attributekey
- The key we are looking forboolean removeAttribute(IoSession session, Object key, Object value)
if (containsAttribute(key) && getAttribute(key).equals(value)) { removeAttribute(key); return true; } else { return false; }
session
- the session for which we want to remove a valuekey
- The key we are looking forvalue
- The value to removeboolean replaceAttribute(IoSession session, Object key, Object oldValue, Object newValue)
if (containsAttribute(key) && getAttribute(key).equals(oldValue)) { setAttribute(key, newValue); return true; } else { return false; }
session
- the session for which we want to replace an attributekey
- The key we are looking foroldValue
- The old value to replacenewValue
- The new value to setboolean containsAttribute(IoSession session, Object key)
session
- the session for which wa want to check if an attribute is presentkey
- The key we are looking forSet<Object> getAttributeKeys(IoSession session)
session
- the session for which we want the set of attributesCopyright © 2004–2018 Apache MINA Project. All rights reserved.