org.jmolecules.architecture.hexagonal

Annotation Type SecondaryPort

@Port
 @Retention(value=CLASS)
 @Target(value={PACKAGE,TYPE})
 @Documented
public @interface SecondaryPort

An SecondaryPort describes abstractions that describes interfaces to the outside that are driven by the application's core, like a repository (to interact with a database) or a message publisher. Usually SecondaryPorts are implemented by SecondaryAdapters.

Since:

1.5

Author:

Oliver Drotbohm, Stephan Pirnbaum

See Also:

Hexagonal Architecture, SecondaryAdapter

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	description A description of the SecondaryPort.
String	name An identifier for the name of the SecondaryPort to identify and group multiple implementing classes of the same SecondaryPort.

Element Detail

name

public abstract String name

An identifier for the name of the SecondaryPort to identify and group multiple implementing classes of the same SecondaryPort. If not set, external tooling may default this to the simple name of the annotated type or package.

Since:

1.8

Default:

""

description

public abstract String description

A description of the SecondaryPort. If not set, external tooling may default this to the JavaDoc.

Since:

1.8

Default:

""