org.springframework.hateoas.core

Annotation Type Relation

@Target(value={TYPE,ANNOTATION_TYPE})
 @Retention(value=RUNTIME)
public @interface Relation

Annotation to configure the relation to be used when embedding objects in HAL representations of Resources and Resources.

Author:

Alexander Baetz, Oliver Gierke

Field Summary

Fields

Modifier and Type	Fields and Description
static String	NO_RELATION

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	collectionRelation Defines the relation to be used when referring to a collection of resources.
String	value Defines the relation to be used when referring to a single resource.

Field Detail

NO_RELATION

public static final String NO_RELATION

Element Detail

value

public abstract String value

Defines the relation to be used when referring to a single resource.

Returns:

Default:

""

collectionRelation

public abstract String collectionRelation

Defines the relation to be used when referring to a collection of resources.

Returns:

Default:

""