Class ParsedMarkdown
java.lang.Object
io.nosqlbench.nb.api.markdown.aggregator.ParsedMarkdown
- All Implemented Interfaces:
HasDiagnostics,MarkdownInfo,Comparable<MarkdownInfo>
TODO: Make this a value type
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbooleangetBody()The buffer-less version ofgetDiagnostics(List)getDiagnostics(List<String> buffer) Get a list of diagnostic warnings that might help users know of issues in their markdown content before publication.getPath()booleaninthashCode()toString()withIncluded(List<String> included) withTopics(List<String> assigning) Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface io.nosqlbench.nb.api.markdown.types.MarkdownInfo
compareTo, getAggregators, getIncluded, getTopicGlobs, getTopics, hasAggregators, hasTopicGlobs, matchesTopicPattern
-
Constructor Details
-
ParsedMarkdown
-
-
Method Details
-
getPath
- Specified by:
getPathin interfaceMarkdownInfo
-
getBody
- Specified by:
getBodyin interfaceMarkdownInfo
-
getFrontmatter
- Specified by:
getFrontmatterin interfaceMarkdownInfo
-
getDiagnostics
Get a list of diagnostic warnings that might help users know of issues in their markdown content before publication.- Specified by:
getDiagnosticsin interfaceHasDiagnostics- Parameters:
buffer- A buffer object, for accumulating many lines of detail, if necessary.- Returns:
- The buffer, with possible additions
-
getDiagnostics
The buffer-less version ofgetDiagnostics(List)- Specified by:
getDiagnosticsin interfaceHasDiagnostics- Returns:
- a list of diagnostics lines, zero if there are none
-
hasAggregations
public boolean hasAggregations()- Specified by:
hasAggregationsin interfaceMarkdownInfo
-
withTopics
- Specified by:
withTopicsin interfaceMarkdownInfo
-
withIncluded
- Specified by:
withIncludedin interfaceMarkdownInfo
-
toString
-
equals
-
hashCode
-