Module gov.nist.secauto.metaschema.core

Package gov.nist.secauto.metaschema.core.datatype.markup

Interface IMarkupString<TYPE extends IMarkupString<TYPE>>

All Superinterfaces:

ICustomJavaDataType<TYPE>

All Known Implementing Classes:

AbstractMarkupString, MarkupLine, MarkupMultiline

public interface IMarkupString<TYPE extends IMarkupString<TYPE>>
extends ICustomJavaDataType<TYPE>

Method Summary

Modifier and Type	Method	Description
com.vladsch.flexmark.util.ast.Document	getDocument()
FlexmarkFactory	getFlexmarkFactory()
default List<InsertAnchorExtension.InsertAnchorNode>	getInserts()
List<InsertAnchorExtension.InsertAnchorNode>	getInserts(Predicate<InsertAnchorExtension.InsertAnchorNode> filter)	Retrieve all insert statements that are contained within this markup text that match the provided filter.
Stream<com.vladsch.flexmark.util.ast.Node>	getNodesAsStream()	Retrieve all nodes contained within this markup text as a stream.
boolean	isBlock()	Determine if the Markup consists of block elements.
String	toHtml()
String	toMarkdown()
String	toMarkdown(com.vladsch.flexmark.formatter.Formatter formatter)
String	toXHtml(String namespace)
void	writeXHtml(String namespace, org.codehaus.stax2.evt.XMLEventFactory2 eventFactory, XMLEventWriter eventWriter)
void	writeXHtml(String namespace, org.codehaus.stax2.XMLStreamWriter2 streamWriter)

Methods inherited from interface gov.nist.secauto.metaschema.core.datatype.ICustomJavaDataType

copy

Method Detail

getFlexmarkFactory

@NonNull
FlexmarkFactory getFlexmarkFactory()

getDocument

@NonNull
com.vladsch.flexmark.util.ast.Document getDocument()

toHtml

@NonNull
String toHtml()

toXHtml

@NonNull
String toXHtml(@NonNull
               String namespace)
        throws XMLStreamException,
               IOException

Throws:

XMLStreamException

IOException

toMarkdown

@NonNull
String toMarkdown()

toMarkdown

@NonNull
String toMarkdown(@NonNull
                  com.vladsch.flexmark.formatter.Formatter formatter)

getNodesAsStream

@NonNull
Stream<com.vladsch.flexmark.util.ast.Node> getNodesAsStream()

Retrieve all nodes contained within this markup text as a stream.

Returns:

a depth first stream

getInserts

@NonNull
default List<InsertAnchorExtension.InsertAnchorNode> getInserts()

getInserts

@NonNull
List<InsertAnchorExtension.InsertAnchorNode> getInserts(@NonNull
                                                        Predicate<InsertAnchorExtension.InsertAnchorNode> filter)

Retrieve all insert statements that are contained within this markup text that match the provided filter.

Parameters:

filter - a filter used to identify matching insert statements

Returns:

the matching insert statements

isBlock

boolean isBlock()

Determine if the Markup consists of block elements.

Returns:

true if the markup consists of block elements, or false otherwise

writeXHtml

void writeXHtml(@NonNull
                String namespace,
                @NonNull
                org.codehaus.stax2.XMLStreamWriter2 streamWriter)
         throws XMLStreamException

Throws:

XMLStreamException

writeXHtml

void writeXHtml(@NonNull
                String namespace,
                @NonNull
                org.codehaus.stax2.evt.XMLEventFactory2 eventFactory,
                @NonNull
                XMLEventWriter eventWriter)
         throws XMLStreamException

Throws:

XMLStreamException