Package com.github.javaparser.javadoc

Class JavadocBlockTag

java.lang.Object

com.github.javaparser.javadoc.JavadocBlockTag

public class JavadocBlockTag
extends java.lang.Object

A block tag.

Typically they are found at the end of Javadoc comments.

Examples: @see AnotherClass @since v0.0.1 @author Jim O'Java

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	JavadocBlockTag.Type	The type of tag: it could either correspond to a known tag (param, return, etc.) or represent an unknown tag.

Field Summary

Fields

Modifier and Type	Field	Description
private JavadocDescription	content
private java.util.Optional<java.lang.String>	name
private java.lang.String	tagName
private JavadocBlockTag.Type	type

Constructor Summary

Constructors

Constructor	Description
JavadocBlockTag(JavadocBlockTag.Type type, java.lang.String content)
JavadocBlockTag(java.lang.String tagName, java.lang.String content)

Method Summary

Modifier and Type	Method	Description
static JavadocBlockTag	createParamBlockTag(java.lang.String paramName, java.lang.String content)
boolean	equals(java.lang.Object o)
JavadocDescription	getContent()
java.util.Optional<java.lang.String>	getName()
java.lang.String	getTagName()
JavadocBlockTag.Type	getType()
int	hashCode()
java.lang.String	toString()
java.lang.String	toText()

Methods inherited from class java.lang.Object

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

Field Detail

type

private JavadocBlockTag.Type type

content

private JavadocDescription content

name

private java.util.Optional<java.lang.String> name

tagName

private java.lang.String tagName

Constructor Detail

JavadocBlockTag

public JavadocBlockTag(JavadocBlockTag.Type type,
                       java.lang.String content)

JavadocBlockTag

public JavadocBlockTag(java.lang.String tagName,
                       java.lang.String content)

Method Detail

createParamBlockTag

public static JavadocBlockTag createParamBlockTag(java.lang.String paramName,
                                                  java.lang.String content)

getType

public JavadocBlockTag.Type getType()

getContent

public JavadocDescription getContent()

getName

public java.util.Optional<java.lang.String> getName()

getTagName

public java.lang.String getTagName()

toText

public java.lang.String toText()

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object