Module org.fuin.ddd4j
Package org.fuin.ddd4j.codegen

Annotation Interface AggregateRootUuidVO

@Retention(RUNTIME) @Target(TYPE) public @interface AggregateRootUuidVO
UUID based aggregate root identifier value object.

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    description
    Description of the type.
    String
    entityType
    Unique identifier of the aggregate root type.
    String
    name
    Unique name of the type to generate.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    example
    Example value of the type.
    boolean
    jaxb
    Generate a JAXB adapter.
    boolean
    jpa
    Generate a JPA converter.
    boolean
    jsonb
    Generate a JSONB adapter.
    boolean
    openapi
    Generate a Eclipse Microprofile OpenAPI annotations.
    String
    pkg
    Name of the package for the type to generate.
    long
    serialVersionUID
    Serial version UID to use.

  • Element Details

    • name

      String name
      Unique name of the type to generate.
      Returns:
      Simple name of the target class.

    • description

      String description
      Description of the type.
      Returns:
      Human readable business driven description of what this type represents.

    • entityType

      String entityType
      Unique identifier of the aggregate root type.
      Returns:
      Name that is unique in the context and can be used to create a EntityType.

    • pkg

      String pkg
      Name of the package for the type to generate. If this value is not set, the package of the annotated type will be used.
      Returns:
      Package name.
      Default:
      ""

    • jpa

      boolean jpa
      Generate a JPA converter.
      Returns:
      TRUE generates a converter.
      Default:
      false

    • jaxb

      boolean jaxb
      Generate a JAXB adapter.
      Returns:
      TRUE generates an adapter.
      Default:
      false

    • jsonb

      boolean jsonb
      Generate a JSONB adapter.
      Returns:
      TRUE generates an adapter.
      Default:
      false

    • openapi

      boolean openapi
      Generate a Eclipse Microprofile OpenAPI annotations.
      Returns:
      TRUE generates annotations.
      Default:
      false

    • example

      String example
      Example value of the type.
      Returns:
      Example value.
      Default:
      "00000000-0000-0000-0000-000000000000"

    • serialVersionUID

      long serialVersionUID
      Serial version UID to use.
      Returns:
      Version used for Java serialization.
      Default:
      1L