Apache Groovy 3.0.20 · groovy.lang.groovydoc.Groovydoc

Modifier and Type	Field and Description
private final String	content
public static final Groovydoc	EMPTY_GROOVYDOC
private GroovydocHolder<T>	holder
private List<GroovydocTag>	tagList

Access	Constructor and Description
private	Groovydoc(String content)
public	Groovydoc(String content, GroovydocHolder<T> groovydocHolder)
public	Groovydoc(final String content, final AnnotatedElement annotatedElement)

Modifier and Type	Method 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 String	Returns: the text content getContent() Get the content of groovydoc
public GroovydocHolder<T>	Returns: the groovydoc holder getHolder() Get the holder of the groovydoc
public List<GroovydocTag>	Returns: a list of tags getTagList() TODO Get list of groovydoc tags
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for the object.
public boolean	Returns: `true` if groovydoc is present isPresent() Tests if groovydoc is present
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Field Detail

content	back to summary
private final String content

EMPTY_GROOVYDOC	back to summary
public static final Groovydoc EMPTY_GROOVYDOC

holder	back to summary
private GroovydocHolder<T> holder

tagList	back to summary
private List<GroovydocTag> tagList

Constructor Detail

Groovydoc	back to summary
private Groovydoc(String content)

Groovydoc	back to summary
public Groovydoc(String content, GroovydocHolder<T> groovydocHolder)

Groovydoc	back to summary
public Groovydoc(final String content, final AnnotatedElement annotatedElement)

Method Detail

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

getContent	back to summary
public String getContent() Get the content of groovydoc Returns:String the text content

getContent

back to summary

public String getContent()

Get the content of groovydoc

Returns:String: the text content

getHolder	back to summary
public GroovydocHolder<T> getHolder() Get the holder of the groovydoc Returns:GroovydocHolder<T> the groovydoc holder

getHolder

back to summary

public GroovydocHolder<T> getHolder()

Get the holder of the groovydoc

Returns:GroovydocHolder<T>: the groovydoc holder

getTagList	back to summary
public List<GroovydocTag> getTagList() TODO Get list of groovydoc tags Returns:List<GroovydocTag> a list of tags

getTagList

back to summary

public List<GroovydocTag> getTagList()

TODO Get list of groovydoc tags

Returns:List<GroovydocTag>: a list of tags

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 the 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 the 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

isPresent back to summary

isPresent	back to summary
public boolean isPresent() Tests if groovydoc is present Returns:boolean `true` if groovydoc is present

public boolean isPresent()

Tests if groovydoc is present

Returns:boolean: true if groovydoc is present

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

@Override

public Class Groovydoc

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail