Package com.kazforge.jsonapi.representation

Record Class FieldAllowance

java.lang.Object

java.lang.Record

com.kazforge.jsonapi.representation.FieldAllowance

public record FieldAllowance(String resourceType, String fieldName)
extends Record

Allowance key for field-policy checks: owner JSON:API resource type plus attribute or relationship member name.

resourceType and fieldName are JSON:API names, not Java names. fieldName is never type, id, or lid.

Constructor Summary

Constructors

Constructor	Description
FieldAllowance(String resourceType, String fieldName)	Creates an instance of a FieldAllowance record class.

Method Summary

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

FieldAllowance

public FieldAllowance(String resourceType,
 String fieldName)

Creates an instance of a FieldAllowance record class.

Parameters:

resourceType - the value for the resourceType record component

fieldName - the value for the fieldName record component

Method Details

of

public static FieldAllowance of(String resourceType,
 String fieldName)

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.

resourceType

public String resourceType()

Returns the value of the resourceType record component.

Returns:

the value of the resourceType record component

fieldName

public String fieldName()

Returns the value of the fieldName record component.

Returns:

the value of the fieldName record component