javaparser-parent 3.14.14 · com.github.javaparser.javadoc.Javadoc

Modifier and Type	Field and Description
private List<JavadocBlockTag>	blockTags
private JavadocDescription	description

Access	Constructor and Description
public	Javadoc(JavadocDescription description)

Method Summary

Modifier and Type	Method and Description
public Javadoc	addBlockTag(JavadocBlockTag blockTag)
public Javadoc	addBlockTag(String tagName, String content) For tags like "@return good things" where tagName is "return", and the rest is content.
public Javadoc	addBlockTag(String tagName, String parameter, String content) For tags like "@param abc this is a parameter" where tagName is "param", parameter is "abc" and the rest is content.
public Javadoc	addBlockTag(String tagName)
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 List<JavadocBlockTag>	Returns: the current List of associated JavadocBlockTags getBlockTags()
public JavadocDescription	getDescription()
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public JavadocComment	toComment() Create a JavadocComment, by formatting the text of the Javadoc using no indentation (expecting the pretty printer to do the formatting.)
public JavadocComment	toComment(String indentation) Create a JavadocComment, by formatting the text of the Javadoc using the given indentation.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public String	toText() Return the text content of the document.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

blockTags	back to summary
private List<JavadocBlockTag> blockTags

description	back to summary
private JavadocDescription description

Javadoc	back to summary
public Javadoc(JavadocDescription description)

Method Detail

addBlockTag	back to summary
public Javadoc addBlockTag(JavadocBlockTag blockTag)

addBlockTag	back to summary
public Javadoc addBlockTag(String tagName, String content) For tags like "@return good things" where tagName is "return", and the rest is content.

addBlockTag	back to summary
public Javadoc addBlockTag(String tagName, String parameter, String content) For tags like "@param abc this is a parameter" where tagName is "param", parameter is "abc" and the rest is content.

addBlockTag	back to summary
public Javadoc addBlockTag(String tagName)

equals back to summary

equals	back 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

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

getBlockTags	back to summary
public List<JavadocBlockTag> getBlockTags() Returns:List<JavadocBlockTag> the current List of associated JavadocBlockTags

getDescription	back to summary
public JavadocDescription getDescription()

hashCode back to summary

hashCode	back 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

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

toComment	back to summary
public JavadocComment toComment() Create a JavadocComment, by formatting the text of the Javadoc using no indentation (expecting the pretty printer to do the formatting.)

toComment	back to summary
public JavadocComment toComment(String indentation) Create a JavadocComment, by formatting the text of the Javadoc using the given indentation.

toString	back 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

toString

back 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