Module org.seasar.doma.core
Package org.seasar.doma

Annotation Interface Returning

public @interface Returning
Indicates that specific properties of an entity should be included or excluded in the context of a Dao operation.

This annotation allows fine-grained control over which entity properties are processed during database operations.

  • These attributes are optional and can be used together.
  • When neither attribute is specified, all properties are included by default.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String[]
    exclude
    Specifies the names of properties to be explicitly excluded.
    String[]
    include
    Specifies the names of properties to be explicitly included.

  • Element Details

    • include

      String[] include
      Specifies the names of properties to be explicitly included. If specified, only the listed properties will be included.
      Returns:
      an array of property names to include
      Default:
      {}

    • exclude

      String[] exclude
      Specifies the names of properties to be explicitly excluded. If specified, all properties will be included except for those listed.
      Returns:
      an array of property names to exclude
      Default:
      {}