Annotation Type PrimaryPort


  • @Port
    @Retention(CLASS)
    @Target({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
    See Also:
    Hexagonal Architecture, PrimaryAdapter
    • Optional Element Summary

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

      • name

        java.lang.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

        java.lang.String description
        A description of the PrimaryPort. If not set, external tooling may default this to the JavaDoc.
        Since:
        1.8
        Default:
        ""