Package com.structurizr.documentation

Class Decision

java.lang.Object

com.structurizr.documentation.DocumentationContent

com.structurizr.documentation.Decision

public final class Decision
extends DocumentationContent

Represents a single (architecture) decision, as described at http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	Decision.Link	Represents a link between two decisions.

Constructor Summary

Constructors

Constructor	Description
Decision(String id)

Method Summary

Modifier and Type	Method	Description
void	addLink(Decision decision, String type)	Adds a link between this decision and another.
boolean	equals(Object object)
Date	getDate()	Gets the date of this decision.
String	getId()	Gets the ID of this decision.
Set<Decision.Link>	getLinks()	Gets the set of links from this decision.
String	getStatus()	Gets the status of this decision.
int	hashCode()
boolean	hasLinkTo(Decision decision)	Determines whether a decision already has a link to another decision
void	setDate(Date date)
void	setStatus(String status)

Methods inherited from class com.structurizr.documentation.DocumentationContent

getContent, getElementId, getFormat, getTitle, setContent, setFormat, setTitle

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Decision

public Decision(String id)

Method Details

getId

public String getId()

Gets the ID of this decision.

Returns:

the ID, as a String

getDate

public Date getDate()

Gets the date of this decision.

Returns:

a Date object

setDate

public void setDate(Date date)

getStatus

public String getStatus()

Gets the status of this decision.

Returns:

the status, as a String

setStatus

public void setStatus(String status)

getLinks

public Set<Decision.Link> getLinks()

Gets the set of links from this decision.

Returns:

a Set of Link objects

addLink

public void addLink(Decision decision,
 String type)

Adds a link between this decision and another.

Parameters:

decision - the Decision to link to

type - the "type" of the link (e.g. "superseded by")

hasLinkTo

public boolean hasLinkTo(Decision decision)

Determines whether a decision already has a link to another decision

Parameters:

decision - the Decision to check against

Returns:

true if a link exists, false otherwise

equals

public boolean equals(Object object)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object