org.jmolecules.ddd.annotation

Annotation Type Module

@Retention(value=RUNTIME)
 @Target(value={PACKAGE,ANNOTATION_TYPE})
 @Documented
public @interface Module

Identifies a DDD module.

Author:

Christian Stettler, Henning Schwentner, Stephan Pirnbaum, Martin Schimak, Oliver Drotbohm

See Also:

Domain-Driven Design Reference (Evans) - Modules

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	description A human readable description for the module.
String	id A stable identifier for the module.
String	name A human readable name for the module.
String	value An alias for name().

Element Detail

id

public abstract String id

A 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 with Module, tooling could use a resource bundle to lookup the keys com.acme.myapp.module._name and com.acme.myapp.module_description to resolve name and description respectively.

Returns:

Default:

""

name

public abstract String name

A human readable name for the module. Might be overridden by an external resolution mechanism via id(). Tooling should prevent both value() and name() from being configured at the same time. If in doubt, the value defined in name() will be preferred.

Returns:

See Also:

id()

Default:

""

value

public abstract String value

An alias for name(). Tooling should prevent both value() and name() from being configured at the same time. If in doubt, the value defined in name() will be preferred.

Returns:

See Also:

name()

Default:

""

description

public abstract String description

A human readable description for the module. Might be overridden by an external resolution mechanism via id().

Returns:

See Also:

id()

Default:

""