Annotation Interface Region


Annotation declaring the Region in which the application persistent entity will be stored.
Author:
Oliver Gierke, John Blum
See Also:
  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    boolean
    Determines whether an entity annotated with this Region annotation will ignore any existing Region definition identified by the given name() for this entity.
    Name, or fully-qualified bean name of the Region in which the application persistent entity will be stored (e.g.
    Name, or fully-qualified bean name of the Region in which the application persistent entity will be stored (e.g.
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final List<Class<? extends Annotation>>
     
  • Field Details

    • REGION_ANNOTATION_TYPES

      static final List<Class<? extends Annotation>> REGION_ANNOTATION_TYPES
  • Element Details

    • name

      @AliasFor(attribute="value") String name
      Name, or fully-qualified bean name of the Region in which the application persistent entity will be stored (e.g. "Users", or "/Local/Admin/Users"). Defaults to simple name of the application persistent entity defined by Class.getSimpleName().
      Returns:
      the name or fully-qualified path of the Region in which the application persistent entity will be stored.
      Default:
      ""
    • value

      @AliasFor(attribute="name") String value
      Name, or fully-qualified bean name of the Region in which the application persistent entity will be stored (e.g. "Users", or "/Local/Admin/Users"). Defaults to simple name of the application persistent entity defined by Class.getSimpleName().
      Returns:
      the name or fully-qualified path of the Region in which the application persistent entity will be stored.
      Default:
      ""
    • ignoreIfExists

      boolean ignoreIfExists
      Determines whether an entity annotated with this Region annotation will ignore any existing Region definition identified by the given name() for this entity. Defaults to true.
      Default:
      true