Package org.springframework.hateoas.server.core

Annotation Interface Relation

@Target({TYPE,ANNOTATION_TYPE}) @Retention(RUNTIME) public @interface Relation
Annotation to configure the relation to be used when embedding objects in HAL representations of EntityModels and CollectionModel.
Author:
Alexander Baetz, Oliver Gierke

  • Optional Element Summary

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

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    NO_RELATION
     

  • Field Details

  • Element Details

    • value

      @AliasFor("itemRelation") String value
      Defines the relation to be used when referring to a single resource. Alias for itemRelation().
      Returns:
      Default:
      ""

    • itemRelation

      @AliasFor("value") String itemRelation
      Defines the relation to be used when referring to a single resource. Alias of value().
      Returns:
      Default:
      ""

    • collectionRelation

      String collectionRelation
      Defines the relation to be used when referring to a collection of resources.
      Returns:
      Default:
      ""