Top Description Inners Fields Constructors Methods
com.github.javaparser.javadoc

public Class JavadocBlockTag

extends Object
Class Inheritance
Imports
com.github.javaparser.javadoc.description.JavadocDescription, java.util.Optional

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 and Inner Type Summary

Modifier and TypeClass and Description
public static enum
JavadocBlockTag.Type

The type of tag: it could either correspond to a known tag (param, return, etc.) or represent an unknown tag.

Field Summary

Modifier and TypeField and Description
private JavadocDescription
private Optional<String>
private String
private JavadocBlockTag.Type

Constructor Summary

AccessConstructor and Description
public
public
JavadocBlockTag(String tagName, String content)

Method Summary

Modifier and TypeMethod and Description
public static JavadocBlockTag
createParamBlockTag(String paramName, String content)

public boolean
equals(Object
the reference object with which to compare.
o
)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.
public JavadocDescription
public Optional<String>
public String
public JavadocBlockTag.Type
public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.
public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.
public String
Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

contentback to summary
private JavadocDescription content
nameback to summary
private Optional<String> name
tagNameback to summary
private String tagName
typeback to summary
private JavadocBlockTag.Type type

Constructor Detail

JavadocBlockTagback to summary
public JavadocBlockTag(JavadocBlockTag.Type type, String content)
JavadocBlockTagback to summary
public JavadocBlockTag(String tagName, String content)

Method Detail

createParamBlockTagback to summary
public static JavadocBlockTag createParamBlockTag(String paramName, String content)
equalsback to summary
public boolean equals(Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
o:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
getContentback to summary
public JavadocDescription getContent()
getNameback to summary
public Optional<String> getName()
getTagNameback to summary
public String getTagName()
getTypeback to summary
public JavadocBlockTag.Type getType()
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object

Annotations
@Override
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object

Annotations
@Override
toTextback to summary
public String toText()
com.github.javaparser.javadoc back to summary

public final Enum JavadocBlockTag.Type

extends Enum<JavadocBlockTag.Type>
Class Inheritance

The type of tag: it could either correspond to a known tag (param, return, etc.) or represent an unknown tag.

Field Summary

Modifier and TypeField and Description
public static final JavadocBlockTag.Type
public static final JavadocBlockTag.Type
public static final JavadocBlockTag.Type
private String
public static final JavadocBlockTag.Type
public static final JavadocBlockTag.Type
public static final JavadocBlockTag.Type
public static final JavadocBlockTag.Type
public static final JavadocBlockTag.Type
public static final JavadocBlockTag.Type
public static final JavadocBlockTag.Type
public static final JavadocBlockTag.Type
public static final JavadocBlockTag.Type
public static final JavadocBlockTag.Type

Constructor Summary

AccessConstructor and Description
private
Type()

Method Summary

Modifier and TypeMethod and Description
pack-priv static JavadocBlockTag.Type
fromName(String tagName)

pack-priv boolean
public static JavadocBlockTag.Type
public static JavadocBlockTag.Type[]
Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

AUTHORback to summary
public static final JavadocBlockTag.Type AUTHOR
DEPRECATEDback to summary
public static final JavadocBlockTag.Type DEPRECATED
EXCEPTIONback to summary
public static final JavadocBlockTag.Type EXCEPTION
keywordback to summary
private String keyword
PARAMback to summary
public static final JavadocBlockTag.Type PARAM
RETURNback to summary
public static final JavadocBlockTag.Type RETURN
SEEback to summary
public static final JavadocBlockTag.Type SEE
SERIALback to summary
public static final JavadocBlockTag.Type SERIAL
SERIAL_DATAback to summary
public static final JavadocBlockTag.Type SERIAL_DATA
SERIAL_FIELDback to summary
public static final JavadocBlockTag.Type SERIAL_FIELD
SINCEback to summary
public static final JavadocBlockTag.Type SINCE
THROWSback to summary
public static final JavadocBlockTag.Type THROWS
UNKNOWNback to summary
public static final JavadocBlockTag.Type UNKNOWN
VERSIONback to summary
public static final JavadocBlockTag.Type VERSION

Constructor Detail

Typeback to summary
private Type()

Method Detail

fromNameback to summary
pack-priv static JavadocBlockTag.Type fromName(String tagName)
hasNameback to summary
pack-priv boolean hasName()
valueOfback to summary
public static JavadocBlockTag.Type valueOf(String name)
valuesback to summary
public static JavadocBlockTag.Type[] values()