Module qilletni.api

Package dev.qilletni.api.lang.docs.structure

Record Class DocFieldType

java.lang.Object

java.lang.Record

dev.qilletni.api.lang.docs.structure.DocFieldType

public record DocFieldType(DocFieldType.FieldType fieldType, String identifier)
extends Record

Documentation recording the type of a field, return value, etc.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	DocFieldType.FieldType

Constructor Summary

Constructors

Constructor	Description
DocFieldType(DocFieldType.FieldType fieldType, String identifier)	Creates an instance of a DocFieldType record class.

Method Summary

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

DocFieldType

public DocFieldType(DocFieldType.FieldType fieldType,
 String identifier)

Creates an instance of a DocFieldType record class.

Parameters:

fieldType - the value for the fieldType record component

identifier - the value for the identifier 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.

fieldType

public DocFieldType.FieldType fieldType()

Returns the value of the fieldType record component.

Returns:

the value of the fieldType record component

identifier

public String identifier()

Returns the value of the identifier record component.

Returns:

the value of the identifier record component