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

public Class JavadocInlineTag

extends Object
implements JavadocDescriptionElement
Class Inheritance
All Implemented Interfaces
com.github.javaparser.javadoc.description.JavadocDescriptionElement
Static Imports
com.github.javaparser.utils.Utils.nextWord, .Utils.screamingToCamelCase

An inline tag contained in a Javadoc description.

For example String

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static enum
JavadocInlineTag.Type

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

Field Summary

Modifier and TypeField and Description
private String
private String
private JavadocInlineTag.Type

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
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 static JavadocDescriptionElement
public String
public String
public JavadocInlineTag.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 String content
tagNameback to summary
private String tagName
typeback to summary
private JavadocInlineTag.Type type

Constructor Detail

JavadocInlineTagback to summary
public JavadocInlineTag(String tagName, JavadocInlineTag.Type type, String content)

Method Detail

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
fromTextback to summary
public static JavadocDescriptionElement fromText(String text)
getContentback to summary
public String getContent()
getNameback to summary
public String getName()
getTypeback to summary
public JavadocInlineTag.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()

Implements com.github.javaparser.javadoc.description.JavadocDescriptionElement.toText.

Annotations
@Override
com.github.javaparser.javadoc.description back to summary

public final Enum JavadocInlineTag.Type

extends Enum<JavadocInlineTag.Type>
Class Inheritance

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

Field Summary

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

Constructor Summary

AccessConstructor and Description
private
Type()

Method Summary

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

public static JavadocInlineTag.Type
public static JavadocInlineTag.Type[]
Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

CODEback to summary
public static final JavadocInlineTag.Type CODE
DOC_ROOTback to summary
public static final JavadocInlineTag.Type DOC_ROOT
INHERIT_DOCback to summary
public static final JavadocInlineTag.Type INHERIT_DOC
keywordback to summary
private String keyword
LINKPLAINback to summary
public static final JavadocInlineTag.Type LINKPLAIN
LITERALback to summary
public static final JavadocInlineTag.Type LITERAL
SYSTEM_PROPERTYback to summary
public static final JavadocInlineTag.Type SYSTEM_PROPERTY
UNKNOWNback to summary
public static final JavadocInlineTag.Type UNKNOWN
VALUEback to summary
public static final JavadocInlineTag.Type VALUE

Constructor Detail

Typeback to summary
private Type()

Method Detail

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