Record Class FieldAccessDecision

java.lang.Object

java.lang.Record

com.kingsrook.qqq.backend.core.actions.permissions.fieldaccess.FieldAccessDecision

public record FieldAccessDecision(FieldAccessTier tier, FieldMaskStyle maskStyle, String reason, boolean exactMatchAllowed)
extends Record

A resolver decision; the reason must never contain a field value.

Field Summary

Fields

Modifier and Type	Field	Description
static final FieldAccessDecision	FULL

Constructor Summary

Constructors

Constructor	Description
FieldAccessDecision(FieldAccessTier tier, FieldMaskStyle maskStyle, String reason)	Compatibility constructor: exact-match searches are allowed by default.
FieldAccessDecision(FieldAccessTier tier, FieldMaskStyle maskStyle, String reason, boolean exactMatchAllowed)	Creates an instance of a FieldAccessDecision record class.

Method Summary

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

Field Details

FULL

public static final FieldAccessDecision FULL

Constructor Details

FieldAccessDecision

public FieldAccessDecision(FieldAccessTier tier,
 FieldMaskStyle maskStyle,
 String reason)

Compatibility constructor: exact-match searches are allowed by default.

FieldAccessDecision

public FieldAccessDecision(FieldAccessTier tier,
 FieldMaskStyle maskStyle,
 String reason,
 boolean exactMatchAllowed)

Creates an instance of a FieldAccessDecision record class.

Parameters:

tier - the value for the tier record component

maskStyle - the value for the maskStyle record component

reason - the value for the reason record component

exactMatchAllowed - the value for the exactMatchAllowed 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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.

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.

tier

public FieldAccessTier tier()

Returns the value of the tier record component.

Returns:

the value of the tier record component

maskStyle

public FieldMaskStyle maskStyle()

Returns the value of the maskStyle record component.

Returns:

the value of the maskStyle record component

reason

public String reason()

Returns the value of the reason record component.

Returns:

the value of the reason record component

exactMatchAllowed

public boolean exactMatchAllowed()

Returns the value of the exactMatchAllowed record component.

Returns:

the value of the exactMatchAllowed record component