Module io.github.eadr
Package io.github.adr.embedded

Annotation Interface MADR

@ADR(1) @ADR(2) @Target({ANNOTATION_TYPE,CONSTRUCTOR,FIELD,LOCAL_VARIABLE,METHOD,PACKAGE,PARAMETER,TYPE,TYPE_PARAMETER,TYPE_USE}) @Retention(RUNTIME) @Documented @Repeatable(MADRs.class) public @interface MADR

  • Element Details

    • value

      int value
      The number part of the ADR. For instance, 1 gets expanded to the full id ADR-0001.
      Returns:
      The number of the ADR

    • title

      String title
      Short title of solved problem and solution
      Returns:
      title

    • contextAndProblem

      String contextAndProblem
      Returns:
      Context and problem statement

    • chosenAlternative

      String chosenAlternative
      The chosen alternative. Invariant: alternatives().contains(chosenAlternative())
      Returns:
      Chosen alternative

    • justification

      String justification
      Returns:
      Justification. e.g., only alternative, which meets k.o. criterion decision driver | which resolves force | ... | comes out best (see below)

    • userStory

      String userStory
      The user story belonging to this ADR. Typically, a reference to the ticket in the issue tracker.
      Returns:
      User story as reference.
      Default:
      ""

    • alternatives

      String[] alternatives
      Considered alternatives.
      Returns:
      Considered alternatives
      Default:
      {}

    • consequences

      String[] consequences
      Returns:
      Consequences. e.g., negative impact on quality attribute, follow-up decisions required, ...
      Default:
      {}

    • relatedDecisions

      int[] relatedDecisions
      Decisions being related to this decision.
      Returns:
      the ids of related decisions
      Default:
      {}