de.zib.gndms.common.rest.Specifier< T > Class Reference

* A specifier describes a resource in different ways. More...

Inherits java::io::Serializable.

List of all members.

Public Member Functions
final String	getUrl ()
	Returns the url of the specifier.
final void	setUrl (final String url)
	Sets the url of a specifier.
final Map< String, String >	getUriMap ()
	Returns the id map.
final void	setUriMap (final Map< String, String > uriMap)
	Sets the id map.
final void	addMapping (final String key, final String value)
	Adds a key-value pair to the id map.
final boolean	hasPayload ()
	Checks, if the specifier has a payload.
final T	getPayload ()
	Returns the payload of the specifier.
final void	setPayload (final T payload)
	Sets the payload of the specifier.
final Specifier	getSpecifier ()
	Returns the nested specifier of this specifier.
final void	setSpecifier (final Specifier specifier)
	Sets the nested specifier of this specifier.
Private Attributes
String	url
	The complete url of the resource.
Map< String, String >	uriMap
	An id map for the resource, used to fill url templates.
T	payload
	Some additional data for the resource, which is usually the result of a GET request.
Specifier	specifier
	Nesting of specifiers.
Static Private Attributes
static final long	serialVersionUID = 4907609464488528768L

---

Detailed Description

* A specifier describes a resource in different ways.

It may contain a global url to the resource together with more abstract id attributes.

Author:

try ma ik jo rr a zib

Parameters:

<T>	The result (payload) type of the specifier.

Date:

02.03.11 17:17 Specifier for a REST resource.

---

Member Function Documentation

final void de.zib.gndms.common.rest.Specifier< T >.addMapping	(	final String	key,
		final String	value
	)

Adds a key-value pair to the id map.

Parameters:

key	The key.
value	The value.

final T de.zib.gndms.common.rest.Specifier< T >.getPayload

(

)

Returns the payload of the specifier.

Returns:

The payload.

final Specifier de.zib.gndms.common.rest.Specifier< T >.getSpecifier

(

)

Returns the nested specifier of this specifier.

Returns:

The nested specifier.

final Map<String, String> de.zib.gndms.common.rest.Specifier< T >.getUriMap

(

)

Returns the id map.

Returns:

The map.

final String de.zib.gndms.common.rest.Specifier< T >.getUrl

(

)

Returns the url of the specifier.

Returns:

The url.

final boolean de.zib.gndms.common.rest.Specifier< T >.hasPayload

(

)

Checks, if the specifier has a payload.

Returns:

true, if the payload is not null.

final void de.zib.gndms.common.rest.Specifier< T >.setPayload

(

final T

payload

)

Sets the payload of the specifier.

Parameters:

payload

The payload.

final void de.zib.gndms.common.rest.Specifier< T >.setSpecifier

(

final Specifier< T >

specifier

)

Sets the nested specifier of this specifier.

Parameters:

specifier

The snested specifier.

final void de.zib.gndms.common.rest.Specifier< T >.setUriMap

(

final Map< String, String >

uriMap

)

Sets the id map.

Parameters:

uriMap

The map.

final void de.zib.gndms.common.rest.Specifier< T >.setUrl

(

final String

url

)

Sets the url of a specifier.

Parameters:

url

The url.

---

The documentation for this class was generated from the following file:

• common/src/de/zib/gndms/common/rest/Specifier.java