Package org.jmolecules.ddd.annotation
Annotation Interface Module
Identifies a DDD module.
- See Also:
-
Optional Element Summary
Optional Elements
-
Element Details
-
id
String idA stable identifier for the module. If not defined, an identifier will be derived from the annotated element, usually a package. That allows tooling to derive name and description by applying some kind of convention to the identifier.Assuming a package
com.acme.myapp.module
annotated withModule
, tooling could use a resource bundle to lookup the keyscom.acme.myapp.module._name
andcom.acme.myapp.module_description
to resolve name and description respectively.- Returns:
- Default:
""
-
name
String nameA human readable name for the module. Might be overridden by an external resolution mechanism viaid()
. Tooling should prevent bothvalue()
andname()
from being configured at the same time. If in doubt, the value defined inname()
will be preferred.- Returns:
- See Also:
- Default:
""
-
value
String valueAn alias forname()
. Tooling should prevent bothvalue()
andname()
from being configured at the same time. If in doubt, the value defined inname()
will be preferred.- Returns:
- See Also:
- Default:
""
-
description
String descriptionA human readable description for the module. Might be overridden by an external resolution mechanism viaid()
.- Returns:
- See Also:
- Default:
""
-