jmlparser-core/com.github.javaparser.ast.comments/MarkdownComment

MarkdownComment

open class MarkdownComment : JavadocComment(source)

https://openjdk.org/jeps/467 added support for markdown JavaDoc comments /// That are prefixed with /// /// Support `markdown` markup and references /// And supports substrings not allowed in regular block comments, e.g. *_no_space_here_/

While these comments could be seen as a series of single line comments, they are functionally block comments. The MarkdownComment class adds support for this, although special handling is required for the content of these comments, since the header is no longer only applied to the start of the comment, but rather to the start of each line.

Constructors

MarkdownComment

constructor()

constructor(content: String)

constructor(tokenRange: TokenRange, content: String)

This constructor is used by the parser and is considered private.

Properties

ABSOLUTE_BEGIN_LINE

val ~~ABSOLUTE_BEGIN_LINE~~: Int = -1

ABSOLUTE_END_LINE

val ~~ABSOLUTE_END_LINE~~: Int = -2

content

open var content: String

LINE_SEPARATOR_KEY

val LINE_SEPARATOR_KEY: DataKey<LineSeparator>

NODE_BY_BEGIN_POSITION

open var NODE_BY_BEGIN_POSITION: Comparator<NodeWithRange<out Any>>

This can be used to sort nodes on position.

parentNode

private open var parentNode: Node

parsed

open var parsed: Node.Parsedness

PRINTER_KEY

val PRINTER_KEY: DataKey<Printer>

range

private open var range: Range

SYMBOL_RESOLVER_KEY

val SYMBOL_RESOLVER_KEY: DataKey<SymbolResolver>

tokenRange

private open var tokenRange: TokenRange

Functions

open fun <R, A> accept(v: GenericVisitor<R, A>, arg: A): R

open fun <A> accept(v: VoidVisitor<A>, arg: A)

Accept method for visitor support.

addOrphanComment

open fun addOrphanComment(comment: Comment)

asBlockComment

open fun asBlockComment(): BlockComment

asJavadocComment

open fun asJavadocComment(): JavadocComment

asLineComment

open fun asLineComment(): LineComment

asMarkdownComment

open fun asMarkdownComment(): MarkdownComment

associatedSpecificationComments

@Nullable

open fun associatedSpecificationComments(): @Nullable NodeList<Comment>

asString

open fun asString(): String

asTraditionalJavadocComment

open fun asTraditionalJavadocComment(): TraditionalJavadocComment

clone

open fun clone(): Node

open fun clone(): Comment

open fun clone(): MarkdownComment

comment

@Nullable

open fun comment(): @Nullable Comment

containsData

open fun containsData(key: DataKey<out Any>): Boolean

containsWithin

open fun ~~containsWithin~~(other: Node): Boolean

containsWithinRange

open fun containsWithinRange(other: Node): Boolean

Checks whether the range of the given Node is contained within the range of this NodeWithRange.

content

@NonNull

open fun content(): @NonNull String

equals

open fun equals(obj: Any): Boolean

findAll

open fun <T : Node?> findAll(nodeType: Class<T>): List<T>

Walks the AST with pre-order traversal, returning all nodes of type "nodeType".

open fun <T : Node?> findAll(nodeType: Class<T>, traversal: Node.TreeTraversal): List<T>

Walks the AST with specified traversal order, returning all nodes of type "nodeType".

open fun <T : Node?> findAll(nodeType: Class<T>, predicate: Predicate<T>): List<T>

Walks the AST with pre-order traversal, returning all nodes of type "nodeType" that match the predicate.

findAncestor

open fun <N> findAncestor(types: Array<Class<N>>): Optional<N>

Walks the parents of this node and returns the first node of type type, or empty() if none is found.

open fun <N> ~~findAncestor~~(type: Class<N>, predicate: Predicate<N>): Optional<N>

Walks the parents of this node and returns the first node of type type that matches predicate, or empty() if none is found.

open fun <N> findAncestor(predicate: Predicate<N>, types: Array<Class<N>>): Optional<N>

Walks the parents of this node and returns the first node that matches one of types types, or empty() if none is found.

findByRange

open fun findByRange(range: Range): Optional<Node>

findCompilationUnit

open fun findCompilationUnit(): Optional<CompilationUnit>

findData

open fun <M> findData(key: DataKey<M>): Optional<M>

Gets data for this node using the given key or returns an Optional.empty().

findFirst

open fun <N : Node?> findFirst(nodeType: Class<N>): Optional<N>

Walks the AST with pre-order traversal, returning the first node of type "nodeType" or empty() if none is found.

open fun <T> findFirst(traversal: Node.TreeTraversal, consumer: (Node) -> Optional<T>): Optional<T>

Walks the AST, applying the function for every node, with traversal algorithm "traversal".

open fun <N : Node?> findFirst(nodeType: Class<N>, predicate: Predicate<N>): Optional<N>

Walks the AST with pre-order traversal, returning the first node of type "nodeType" that matches "predicate" or empty() if none is found.

findRootNode

open fun findRootNode(): Node

Finds the root node of this AST by finding the topmost parent.

getAllContainedComments

open fun getAllContainedComments(): List<Comment>

This is the list of Comment which are contained in the Node either because they are properly associated to one of its children or because they are floating around inside the Node

getAssociatedSpecificationComments

open fun getAssociatedSpecificationComments(): Optional<NodeList<Comment>>

This field is used by key to associated (JML) comments to this node.

getBegin

open fun getBegin(): Optional<Position>

The begin position of this node in the source file.

getChildNodes

open fun getChildNodes(): List<Node>

Contains all nodes that have this node set as their parent.

getChildNodesByType

open fun <N : Node?> ~~getChildNodesByType~~(clazz: Class<N>): List<N>

Recursively finds all nodes of a certain type.

getComment

open fun getComment(): Optional<Comment>

This is a comment associated with this node.

getCommentedNode

open fun getCommentedNode(): Optional<Node>

getData

open fun <M> getData(key: DataKey<M>): M

Gets data for this node using the given key.

getDataKeys

open fun getDataKeys(): Set<DataKey<out Any>>

This method was added to support the clone method.

getEnd

open fun getEnd(): Optional<Position>

The end position of this node in the source file.

getFooter

open fun getFooter(): String

Markdown comments are not terminated by a specific character sequence, so just use the empty string as a footer.

getHeader

open fun getHeader(): String

For other comment types, the header is the character sequence that starts the comment, i.e.

getLineEndingStyle

open fun getLineEndingStyle(): LineSeparator

getLineEndingStyleOrDefault

open fun getLineEndingStyleOrDefault(defaultLineSeparator: LineSeparator): LineSeparator

getMarkdownContent

open fun getMarkdownContent(): String

Returns the Markdown content of this comment as defined in JEP 467:

Because horizontal whitespace at the beginning and end of each line of Markdown text may be significant, the content of a Markdown documentation comment is determined as follows: -- Any leading whitespace and the three initial / characters are removed from each line.

getMetaModel

open fun getMetaModel(): NodeMetaModel

open fun getMetaModel(): CommentMetaModel

open fun getMetaModel(): MarkdownCommentMetaModel

getNodesByType