org.jmolecules.architecture.hexagonal

Annotation Type PrimaryAdapter

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

A PrimaryAdapter connects the outside of an application to an PrimaryPort exposed by the application's core. For example, it could be a component accepting HTTP requests or a listener for a message broker.

Since:

1.5

Author:

Oliver Drotbohm, Stephan Pirnbaum

See Also:

Hexagonal Architecture, PrimaryPort

Optional Element Summary

Optional Elements

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

Element Detail

name

public abstract String name

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

Since:

1.8

Default:

""