Package io.fluxzero.tools.jsondoclet.model

Record Class PackageDocumentation

java.lang.Object

java.lang.Record

io.fluxzero.tools.jsondoclet.model.PackageDocumentation

public record PackageDocumentation(String name, String qualifiedName, String documentation)
extends Record

Minimal representation of package-level documentation.

Constructor Summary

Constructors

Constructor	Description
PackageDocumentation(String name, String qualifiedName, String documentation)	Creates an instance of a PackageDocumentation record class.

Method Summary

Modifier and Type	Method	Description
String	documentation()	Returns the value of the documentation record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
String	name()	Returns the value of the name record component.
String	qualifiedName()	Returns the value of the qualifiedName 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

PackageDocumentation

public PackageDocumentation(String name,
 String qualifiedName,
 String documentation)

Creates an instance of a PackageDocumentation record class.

Parameters:

name - the value for the name record component

qualifiedName - the value for the qualifiedName record component

documentation - the value for the documentation record component

Method Details

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.

name

public String name()

Returns the value of the name record component.

Returns:

the value of the name record component

qualifiedName

public String qualifiedName()

Returns the value of the qualifiedName record component.

Returns:

the value of the qualifiedName record component

documentation

public String documentation()

Returns the value of the documentation record component.

Returns:

the value of the documentation record component