com.github.therapi.runtimejavadoc

Class Comment

java.lang.Object

com.github.therapi.runtimejavadoc.Comment

All Implemented Interfaces:

java.lang.Iterable<CommentElement>

public class Comment
extends java.lang.Object
implements java.lang.Iterable<CommentElement>

Comment text that may contain inline tags.

Constructor Summary

Constructors

Constructor and Description
Comment(java.util.List<CommentElement> elements)

Method Summary

Modifier and Type	Method and Description
static Comment	createEmpty()
java.util.List<CommentElement>	getElements() Returns the elements this comment consists of.
java.util.Iterator<CommentElement>	iterator()
static Comment	nullToEmpty(Comment c)
java.lang.String	toString()
void	visit(CommentVisitor visitor)

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

Comment

public Comment(java.util.List<CommentElement> elements)

Method Detail

createEmpty

public static Comment createEmpty()

nullToEmpty

public static Comment nullToEmpty(Comment c)

getElements

public java.util.List<CommentElement> getElements()

Returns the elements this comment consists of.

Returns:

the elements this comment consists of.

iterator

public java.util.Iterator<CommentElement> iterator()

Specified by:

iterator in interface java.lang.Iterable<CommentElement>

visit

public void visit(CommentVisitor visitor)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object