|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.kohsuke.stapler.AttributeKey<T>
public abstract class AttributeKey<T>
Type-safe attribute accessor.
Servlet API has a bag of stuff in several scopes (such as request, session, ...) but the API is not type-safe. This object provides a convenient type-safe access to to such bags, as well as providing uniform API regardless of the actual scope.
Each instance of AttributeKey
gets an unique attribute name, which means
in the most typical case, these instances should be used as a singleton.
Field Summary | |
---|---|
protected String |
name
|
Constructor Summary | |
---|---|
AttributeKey()
|
|
AttributeKey(String name)
|
Method Summary | ||
---|---|---|
static
|
appScoped()
Creates a new ServletContext -scoped AttributeKey . |
|
T |
get()
|
|
abstract T |
get(javax.servlet.http.HttpServletRequest req)
|
|
void |
remove()
|
|
abstract void |
remove(javax.servlet.http.HttpServletRequest req)
|
|
static
|
requestScoped()
Creates a new request-scoped AttributeKey . |
|
static
|
sessionScoped()
Creates a new session-scoped AttributeKey . |
|
abstract void |
set(javax.servlet.http.HttpServletRequest req,
T value)
|
|
void |
set(T value)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected final String name
Constructor Detail |
---|
public AttributeKey()
public AttributeKey(String name)
Method Detail |
---|
public abstract T get(javax.servlet.http.HttpServletRequest req)
public abstract void set(javax.servlet.http.HttpServletRequest req, T value)
public abstract void remove(javax.servlet.http.HttpServletRequest req)
public final T get()
public final void set(T value)
public final void remove()
public static <T> AttributeKey<T> requestScoped()
AttributeKey
.
public static <T> AttributeKey<T> sessionScoped()
AttributeKey
.
public static <T> AttributeKey<T> appScoped()
ServletContext
-scoped AttributeKey
.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |