Package io.nosqlbench.nb.api.markdown.aggregator

Class ParsedMarkdown

java.lang.Object

io.nosqlbench.nb.api.markdown.aggregator.ParsedMarkdown

All Implemented Interfaces:

HasDiagnostics, MarkdownInfo, java.lang.Comparable<MarkdownInfo>

public class ParsedMarkdown
extends java.lang.Object
implements MarkdownInfo, HasDiagnostics

TODO: Make this a value type

Constructor Summary

Constructors

Constructor	Description
ParsedMarkdown(Content<?> content)

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object o)
java.lang.String	getBody()
java.util.List<java.lang.String>	getDiagnostics()	The buffer-less version of getDiagnostics(List)
java.util.List<java.lang.String>	getDiagnostics(java.util.List<java.lang.String> buffer)	Get a list of diagnostic warnings that might help users know of issues in their markdown content before publication.
FrontMatterInfo	getFrontmatter()
java.nio.file.Path	getPath()
boolean	hasAggregations()
int	hashCode()
java.lang.String	toString()
MarkdownInfo	withIncluded(java.util.List<java.lang.String> included)
MarkdownInfo	withTopics(java.util.List<java.lang.String> assigning)

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.nosqlbench.nb.api.markdown.types.MarkdownInfo

compareTo, getAggregators, getIncluded, getTopicGlobs, getTopics, hasAggregators, hasTopicGlobs, matchesTopicPattern

Constructor Details

ParsedMarkdown

public ParsedMarkdown(Content<?> content)

Method Details

getPath

public java.nio.file.Path getPath()

Specified by:

getPath in interface MarkdownInfo

getBody

public java.lang.String getBody()

Specified by:

getBody in interface MarkdownInfo

getFrontmatter

public FrontMatterInfo getFrontmatter()

Specified by:

getFrontmatter in interface MarkdownInfo

getDiagnostics

public java.util.List<java.lang.String> getDiagnostics(java.util.List<java.lang.String> buffer)

Get a list of diagnostic warnings that might help users know of issues in their markdown content before publication.

Specified by:

getDiagnostics in interface HasDiagnostics

Parameters:

buffer - A buffer object, for accumulating many lines of detail, if necessary.

Returns:

The buffer, with possible additions

getDiagnostics

public java.util.List<java.lang.String> getDiagnostics()

The buffer-less version of getDiagnostics(List)

Specified by:

getDiagnostics in interface HasDiagnostics

Returns:

a list of diagnostics lines, zero if there are none

hasAggregations

public boolean hasAggregations()

Specified by:

hasAggregations in interface MarkdownInfo

withTopics

public MarkdownInfo withTopics(java.util.List<java.lang.String> assigning)

Specified by:

withTopics in interface MarkdownInfo

withIncluded

public MarkdownInfo withIncluded(java.util.List<java.lang.String> included)

Specified by:

withIncluded in interface MarkdownInfo

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object