Package org.kohsuke.stapler

Class AttributeKey<T>

java.lang.Object

org.kohsuke.stapler.AttributeKey<T>

public abstract class AttributeKey<T>
extends Object

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.

Author:

Kohsuke Kawaguchi

Field Summary

Fields

Modifier and Type	Field	Description
protected final String	name

Constructor Summary

Constructors

Constructor	Description
AttributeKey()
AttributeKey(String name)

Method Summary

Modifier and Type	Method	Description
static <T> AttributeKey<T>	appScoped()	Creates a new ServletContext-scoped AttributeKey.
final T	get()
abstract T	get(jakarta.servlet.http.HttpServletRequest req)
final void	remove()
abstract void	remove(jakarta.servlet.http.HttpServletRequest req)
static <T> AttributeKey<T>	requestScoped()	Creates a new request-scoped AttributeKey.
static <T> AttributeKey<T>	sessionScoped()	Creates a new session-scoped AttributeKey.
abstract void	set(jakarta.servlet.http.HttpServletRequest req, T value)
final void	set(T value)

Methods inherited from class java.lang.Object

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

Field Details

name

protected final String name

Constructor Details

AttributeKey

public AttributeKey()

AttributeKey

public AttributeKey(String name)

Method Details

get

public abstract T get(jakarta.servlet.http.HttpServletRequest req)

set

public abstract void set(jakarta.servlet.http.HttpServletRequest req,
 T value)

remove

public abstract void remove(jakarta.servlet.http.HttpServletRequest req)

get

public final T get()

set

public final void set(T value)

remove

public final void remove()

requestScoped

public static <T> AttributeKey<T> requestScoped()

Creates a new request-scoped AttributeKey.

sessionScoped

public static <T> AttributeKey<T> sessionScoped()

Creates a new session-scoped AttributeKey.

appScoped

public static <T> AttributeKey<T> appScoped()

Creates a new ServletContext-scoped AttributeKey.