org.jmolecules.architecture.hexagonal

Annotation Type PrimaryPort

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

In Hexagonal Architecture an PrimaryPort describes an interface into an application's core that is exposed to the outside to drive the application. A PrimaryAdapter would refer to those ports in its implementation.

Since:

1.5

Author:

Oliver Drotbohm, Stephan Pirnbaum

See Also:

Hexagonal Architecture, PrimaryAdapter

Optional Element Summary

Optional Elements

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

Element Detail

name

public abstract String name

An identifier for the name of the PrimaryPort to identify and group multiple implementing classes of the same PrimaryPort. 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 PrimaryPort. If not set, external tooling may default this to the JavaDoc.

Since:

1.8

Default:

""