Package org.fuin.ddd4j.codegen

Annotation Type IntegerEntityIdVO

@Retention(RUNTIME)
@Target(TYPE)
public @interface IntegerEntityIdVO

Integer based entity 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 entity type.
String	name	Unique name of the type to generate.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
boolean	jaxb	Generate a JAXB adapter.
boolean	jpa	Generate a JPA converter.
boolean	jsonb	Generate a JSONB adapter.
int	maxValue	Sets the maximum value of the type.
int	minValue	Sets the minimum value of the type.
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 Detail

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 entity 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

minValue

int minValue

Sets the minimum value of the type.

Returns:

Minimum value (inclusive).

Default:

1

maxValue

int maxValue

Sets the maximum value of the type.

Returns:

Maximum value (inclusive).

Default:

2147483647

serialVersionUID

long serialVersionUID

Serial version UID to use.

Returns:

Version used for Java serialization.

Default:

1L