Top Description Fields Constructors Methods
jakarta.data.metamodel.impl

public final Record TextAttributeRecord<T>

extends Record
implements TextAttribute<T>
Class Inheritance
All Implemented Interfaces
jakarta.data.metamodel.TextAttribute, jakarta.data.metamodel.SortableAttribute, jakarta.data.metamodel.Attribute
Record Components
name:String

Doc from jakarta.data.metamodel.Attribute.name. the name of the attribute

Imports
jakarta.data.Sort, jakarta.data.metamodel.TextAttribute

Record type implementing jakarta.data.metamodel.TextAttribute. This may be used to simplify implementation of the static metamodel.

Field Summary

Modifier and TypeField and Description
private final String
name

Record Component accessed by name().

the name of the attribute

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public Sort<T>
asc()

Implements jakarta.data.metamodel.SortableAttribute.asc.

Obtain a request for an ascending Sort based on the entity attribute.

public Sort<T>
ascIgnoreCase()

Implements jakarta.data.metamodel.TextAttribute.ascIgnoreCase.

Obtain a request for an ascending, case insensitive Sort based on the entity attribute.

public Sort<T>
desc()

Implements jakarta.data.metamodel.SortableAttribute.desc.

Obtain a request for a descending Sort based on the entity attribute.

public Sort<T>
descIgnoreCase()

Implements jakarta.data.metamodel.TextAttribute.descIgnoreCase.

Obtain a request for a descending, case insensitive Sort based on the entity attribute.

public final boolean
equals(Object
the reference object with which to compare.
o
)

Implements abstract java.lang.Record.equals.

Indicates whether some other object is "equal to" this one.

public final int
hashCode()

Implements abstract java.lang.Record.hashCode.

Returns a hash code value for the record.

public String
name()

Record Component getter of name.

Implements jakarta.data.metamodel.Attribute.name.

Obtain the entity attribute name, suitable for use wherever the specification requires an entity attribute name.

Record Component the name of the attribute

public final String
toString()

Implements abstract java.lang.Record.toString.

Returns a string representation of the record.

Field Detail

nameback to summary
private final String name

Record Component accessed by name().

the name of the attribute

Constructor Detail

TextAttributeRecordback to summary
public TextAttributeRecord(String name)

Method Detail

ascback to summary
public Sort<T> asc()

Implements jakarta.data.metamodel.SortableAttribute.asc.

Doc from jakarta.data.metamodel.SortableAttribute.asc.

Obtain a request for an ascending Sort based on the entity attribute.

Returns:Sort<T>

a request for an ascending sort on the entity attribute.

Annotations
@Override
ascIgnoreCaseback to summary
public Sort<T> ascIgnoreCase()

Implements jakarta.data.metamodel.TextAttribute.ascIgnoreCase.

Doc from jakarta.data.metamodel.TextAttribute.ascIgnoreCase.

Obtain a request for an ascending, case insensitive Sort based on the entity attribute.

Returns:Sort<T>

a request for an ascending, case insensitive sort on the entity attribute.

Annotations
@Override
descback to summary
public Sort<T> desc()

Implements jakarta.data.metamodel.SortableAttribute.desc.

Doc from jakarta.data.metamodel.SortableAttribute.desc.

Obtain a request for a descending Sort based on the entity attribute.

Returns:Sort<T>

a request for a descending sort on the entity attribute.

Annotations
@Override
descIgnoreCaseback to summary
public Sort<T> descIgnoreCase()

Implements jakarta.data.metamodel.TextAttribute.descIgnoreCase.

Doc from jakarta.data.metamodel.TextAttribute.descIgnoreCase.

Obtain a request for a descending, case insensitive Sort based on the entity attribute.

Returns:Sort<T>

a request for a descending, case insensitive sort on the entity attribute.

Annotations
@Override
equalsback to summary
public final boolean equals(Object o)

Implements abstract java.lang.Record.equals.

Doc from java.lang.Record.equals.

Indicates whether some other object is "equal to" this one. In addition to the general contract of Object.equals, record classes must further obey the invariant that when a record instance is "copied" by passing the result of the record component accessor methods to the canonical constructor, as follows:

    R copy = new R(r.c1(), r.c2(), ..., r.cn());
then it must be the case that r.equals(copy).
Parameters
o:Object

the reference object with which to compare.

Returns:boolean

true if this record is equal to the argument; false otherwise.

hashCodeback to summary
public final int hashCode()

Implements abstract java.lang.Record.hashCode.

Doc from java.lang.Record.hashCode.

Returns a hash code value for the record. Obeys the general contract of Object.hashCode. For records, hashing behavior is constrained by the refined contract of Record.equals, so that any two records created from the same components must have the same hash code.

Returns:int

a hash code value for this record.

nameback to summary
public String name()

Record Component getter of name.

Implements jakarta.data.metamodel.Attribute.name.

Doc from jakarta.data.metamodel.Attribute.name.

Obtain the entity attribute name, suitable for use wherever the specification requires an entity attribute name. For example, as the parameter to Sort#asc(String).

Record Component
the name of the attribute
Returns:String

the entity attribute name.

toStringback to summary
public final String toString()

Implements abstract java.lang.Record.toString.

Doc from java.lang.Record.toString.

Returns a string representation of the record. In accordance with the general contract of Object#toString(), the toString method returns a string that "textually represents" this record. The result should be a concise but informative representation that is easy for a person to read.

In addition to this general contract, record classes must further participate in the invariant that any two records which are equal must produce equal strings. This invariant is necessarily relaxed in the rare case where corresponding equal component values might fail to produce equal strings for themselves.

Returns:String

a string representation of the object.