Class JavadocSnippet

java.lang.Object

com.github.javaparser.javadoc.description.JavadocSnippet

All Implemented Interfaces:

JavadocDescriptionElement

public class JavadocSnippet
extends Object
implements JavadocDescriptionElement

A piece of text inside a Javadoc description.

For example in A class totally unrelated to String, I swear! we would have two snippets: one before and one after the inline tag (String).

Field Summary

Fields

Modifier and Type	Field	Description
private String	text

Constructor Summary

Constructors

Constructor	Description
JavadocSnippet(String text)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
int	hashCode()
String	toString()
String	toText()

Methods inherited from class Object

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

Field Details

text

private String text

Constructor Details

JavadocSnippet

public JavadocSnippet(String text)

Method Details

toText

public String toText()

Specified by:

toText in interface JavadocDescriptionElement

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object