com.amazonaws.hal

Annotation Type Link

@Retention(value=RUNTIME)
 @Target(value=METHOD)
public @interface Link

This annotation corresponds to a resource's link relation within the underlying HAL representation.

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	relation The name of the relation that the link corresponds to.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
Link.KeyField	keyField If this Link produces a map, the key for each entry can be either the item's title or name.
com.amazonaws.http.HttpMethodName	method The HTTP method that is used when invoking this link.
UriValue[]	uriValues If the link relation is templated, these values are pre-specified values that will be substituted in.

Element Detail

relation

public abstract String relation

The name of the relation that the link corresponds to.

Returns:

relation name

method

public abstract com.amazonaws.http.HttpMethodName method

The HTTP method that is used when invoking this link. Defaults to GET.

Returns:

the HTTP method to use when invoking the link.

Default:

com.amazonaws.http.HttpMethodName.GET

keyField

public abstract Link.KeyField keyField

If this Link produces a map, the key for each entry can be either the item's title or name. By default, title is used.

Returns:

the field to use for map's keys.

Default:

com.amazonaws.hal.Link.KeyField.Title

uriValues

public abstract UriValue[] uriValues

If the link relation is templated, these values are pre-specified values that will be substituted in.

Returns:

an array of pre-defined URI template values.

Default:

{}