e-adr 2.0.0 · io.github.adr.embedded.MADR · APIdia, the JavaDoc alternative

Method Summary

Modifier and Type	Method and Description
public String[]	Returns: Considered alternatives alternatives() Considered alternatives.
public String	Returns: Chosen alternative chosenAlternative() The chosen alternative.
public String[]	consequences() Returns: Consequences.
public String	contextAndProblem() Returns: Context and problem statement
public String	justification() Returns: Justification.
public int[]	Returns: the ids of related decisions relatedDecisions() Decisions being related to this decision.
public String	Returns: title title() Short title of solved problem and solution
public String	Returns: User story as reference. userStory() The user story belonging to this ADR.
public int	Returns: The number of the ADR value() The number part of the ADR.

Inherited from java.lang.annotation.Annotation:: annotationType equals hashCode toString

alternatives	back to summary
public String[] alternatives() Considered alternatives. Returns:String[] Considered alternatives

alternatives

public String[] alternatives()

Considered alternatives.

chosenAlternative	back to summary
public String chosenAlternative() The chosen alternative. Invariant: alternatives().contains(chosenAlternative()) Returns:String Chosen alternative

chosenAlternative

public String chosenAlternative()

The chosen alternative. Invariant: alternatives().contains(chosenAlternative())

consequences	back to summary
public String[] consequences() Returns:String[] Consequences. e.g., negative impact on quality attribute, follow-up decisions required, ...

contextAndProblem	back to summary
public String contextAndProblem() Returns:String Context and problem statement

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

relatedDecisions	back to summary
public int[] relatedDecisions() Decisions being related to this decision. Returns:int[] the ids of related decisions

relatedDecisions

public int[] relatedDecisions()

Decisions being related to this decision.

title	back to summary
public String title() Short title of solved problem and solution Returns:String title

title

public String title()

Short title of solved problem and solution

userStory	back to summary
public String userStory() The user story belonging to this ADR. Typically, a reference to the ticket in the issue tracker. Returns:String User story as reference.

userStory

public String userStory()

The user story belonging to this ADR. Typically, a reference to the ticket in the issue tracker.

value back to summary

value	back to summary
public int value() The number part of the ADR. For instance, 1 gets expanded to the full id `ADR-0001`. Returns:int The number of the ADR

public int value()

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