Package org.glassfish.jersey.internal

Class MapPropertiesDelegate

java.lang.Object

org.glassfish.jersey.internal.MapPropertiesDelegate

All Implemented Interfaces:

PropertiesDelegate

public final class MapPropertiesDelegate
extends Object
implements PropertiesDelegate

Properties delegate backed by a Map.

Author:

Marek Potociar

Constructor Summary

Constructors

Constructor	Description
MapPropertiesDelegate()	Create new map-based properties delegate.
MapPropertiesDelegate(Map<String,Object> store)	Create new map-based properties delegate.
MapPropertiesDelegate(PropertiesDelegate that)	Initialize new map-based properties delegate from another delegate.

Method Summary

Modifier and Type	Method	Description
Object	getProperty(String name)	Returns the property with the given name registered in the current request/response exchange context, or null if there is no property by that name.
Collection<String>	getPropertyNames()	Returns an immutable collection containing the property names available within the context of the current request/response exchange context.
boolean	hasProperty(String name)	Returns true if the property with the given name registered in the current request/response exchange context, or false if there is no property by that name.
void	removeProperty(String name)	Removes a property with the given name from the current request/response exchange context.
void	setProperty(String name, Object value)	Binds an object to a given property name in the current request/response exchange context.

Methods inherited from class java.lang.Object

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

Constructor Detail

MapPropertiesDelegate

public MapPropertiesDelegate()

Create new map-based properties delegate.

MapPropertiesDelegate

public MapPropertiesDelegate(Map<String,Object> store)

Create new map-based properties delegate.

Parameters:

store - backing property store.

MapPropertiesDelegate

public MapPropertiesDelegate(PropertiesDelegate that)

Initialize new map-based properties delegate from another delegate.

Parameters:

that - original properties delegate.

Method Detail

hasProperty

public boolean hasProperty(String name)

Description copied from interface: PropertiesDelegate

Returns true if the property with the given name registered in the current request/response exchange context, or false if there is no property by that name.

Use the PropertiesDelegate.getProperty(java.lang.String) method with a property name to get the value of a property.

Specified by:

hasProperty in interface PropertiesDelegate

Returns:

true if a property matching the given name exists, or false otherwise.

See Also:

PropertiesDelegate.getProperty(java.lang.String)

getProperty

public Object getProperty(String name)

Description copied from interface: PropertiesDelegate

Returns the property with the given name registered in the current request/response exchange context, or null if there is no property by that name.

A property allows a JAX-RS filters and interceptors to exchange additional custom information not already provided by this interface.

A list of supported properties can be retrieved using PropertiesDelegate.getPropertyNames(). Custom property names should follow the same convention as package names.

Specified by:

getProperty in interface PropertiesDelegate

Parameters:

name - a String specifying the name of the property.

Returns:

an Object containing the value of the property, or null if no property exists matching the given name.

See Also:

PropertiesDelegate.getPropertyNames()

getPropertyNames

public Collection<String> getPropertyNames()

Description copied from interface: PropertiesDelegate

Returns an immutable collection containing the property names available within the context of the current request/response exchange context.

Use the PropertiesDelegate.getProperty(java.lang.String) method with a property name to get the value of a property.

Specified by:

getPropertyNames in interface PropertiesDelegate

Returns:

an immutable collection of property names.

See Also:

PropertiesDelegate.getProperty(java.lang.String)

setProperty

public void setProperty(String name,
                        Object value)

Description copied from interface: PropertiesDelegate

Binds an object to a given property name in the current request/response exchange context. If the name specified is already used for a property, this method will replace the value of the property with the new value.

A property allows a JAX-RS filters and interceptors to exchange additional custom information not already provided by this interface.

A list of supported properties can be retrieved using PropertiesDelegate.getPropertyNames(). Custom property names should follow the same convention as package names.

If a null value is passed, the effect is the same as calling the PropertiesDelegate.removeProperty(String) method.

Specified by:

setProperty in interface PropertiesDelegate

Parameters:

name - a String specifying the name of the property.

value - an Object representing the property to be bound.

removeProperty

public void removeProperty(String name)

Description copied from interface: PropertiesDelegate

Removes a property with the given name from the current request/response exchange context. After removal, subsequent calls to PropertiesDelegate.getProperty(java.lang.String) to retrieve the property value will return null.

Specified by:

removeProperty in interface PropertiesDelegate

Parameters:

name - a String specifying the name of the property to be removed.