Package io.quarkus.annotation.processor.documentation.config.discovery

Record Class ParsedJavadoc

java.lang.Object

java.lang.Record

io.quarkus.annotation.processor.documentation.config.discovery.ParsedJavadoc

public record ParsedJavadoc(String description, JavadocFormat format, String since, String deprecated)
extends Record

Constructor Summary

Constructors

Constructor	Description
ParsedJavadoc(String description, JavadocFormat format, String since, String deprecated)	Creates an instance of a ParsedJavadoc record class.

Method Summary

Modifier and Type	Method	Description
String	deprecated()	Returns the value of the deprecated record component.
String	description()	Returns the value of the description record component.
static ParsedJavadoc	empty()
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
JavadocFormat	format()	Returns the value of the format record component.
final int	hashCode()	Returns a hash code value for this object.
boolean	isEmpty()
String	since()	Returns the value of the since record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

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

Constructor Details

ParsedJavadoc

public ParsedJavadoc(String description,
 JavadocFormat format,
 String since,
 String deprecated)

Creates an instance of a ParsedJavadoc record class.

Parameters:

description - the value for the description record component

format - the value for the format record component

since - the value for the since record component

deprecated - the value for the deprecated record component

Method Details

empty

public static ParsedJavadoc empty()

isEmpty

public boolean isEmpty()

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

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

description

public String description()

Returns the value of the description record component.

Returns:

the value of the description record component

format

public JavadocFormat format()

Returns the value of the format record component.

Returns:

the value of the format record component

since

public String since()

Returns the value of the since record component.

Returns:

the value of the since record component

deprecated

public String deprecated()

Returns the value of the deprecated record component.

Returns:

the value of the deprecated record component