Package com.structurizr.documentation

Class DocumentationContent

java.lang.Object

com.structurizr.documentation.DocumentationContent

Direct Known Subclasses:

Decision, Section

public abstract class DocumentationContent
extends Object

Represents a piece of documentation content ... a section or a decision.

Method Summary

Modifier and Type	Method	Description
String	getContent()	Gets the content.
String	getElementId()	Gets the ID of the element that this documentation content is associated with.
Format	getFormat()	Gets the format of this content.
String	getTitle()	Gets the title.
void	setContent(String content)
void	setFormat(Format format)
void	setTitle(String title)

Methods inherited from class java.lang.Object

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

Method Details

getElementId

public String getElementId()

Gets the ID of the element that this documentation content is associated with. Please note this is unused, and only here for backwards compatibility.

Returns:

the element ID, as a String

getTitle

public String getTitle()

Gets the title.

Returns:

the title, as a String

setTitle

public void setTitle(String title)

getContent

public String getContent()

Gets the content.

Returns:

the content, as a String

setContent

public void setContent(String content)

getFormat

public Format getFormat()

Gets the format of this content.

Returns:

Markdown or AsciiDoc

setFormat

public void setFormat(Format format)