org.jmolecules.architecture.hexagonal

Annotation Type Port

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

A Port defines an entry point into the Application that can either drive it (see PrimaryPort) or be driven by the application (see SecondaryPort). They are the interface with which the application interacts with the outside world. Ports are implemented by Adapter using particular integration technology.

Since:

1.5

Author:

Oliver Drotbohm, Stephan Pirnbaum

See Also:

Hexagonal Architecture, Adapter, Application, PrimaryPort, SecondaryPort

Optional Element Summary

Optional Elements

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

Element Detail

name

public abstract String name

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

Since:

1.8

Default:

""