Package org.ametys.core.right

Record Class AccessExplanation

java.lang.Object

java.lang.Record

org.ametys.core.right.AccessExplanation

Record Components:

accessControllerId - the controller id

accessResult - the access result

explanation - The explanation as a I18nizableText

All Implemented Interfaces:

Comparable<AccessExplanation>

public record AccessExplanation(String accessControllerId, AccessController.AccessResult accessResult, I18nizableText explanation)
extends Record
implements Comparable<AccessExplanation>

Explanation of an AccessController.AccessResult provided by an AccessController

Constructor Summary

Constructors

Constructor	Description
AccessExplanation(String accessControllerId, AccessController.AccessResult accessResult, I18nizableText explanation)	Creates an instance of a AccessExplanation record class.

Method Summary

Modifier and Type	Method	Description
String	accessControllerId()	Returns the value of the accessControllerId record component.
AccessController.AccessResult	accessResult()	Returns the value of the accessResult record component.
int	compareTo(AccessExplanation o)
static I18nizableText	elementsToI18nizableText(List<String> elements)	Helper to build a I18nizableText for a list of String
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
I18nizableText	explanation()	Returns the value of the explanation record component.
static I18nizableText	groupsToI18nizableText(Set<Group> groups)	Helper to build a I18nizableText for groups
final int	hashCode()	Returns a hash code value for this object.
static I18nizableText	profilesToI18nizableText(Set<Profile> profiles)	Helper to build a I18nizableText for profiles
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

AccessExplanation

public AccessExplanation(String accessControllerId,
 AccessController.AccessResult accessResult,
 I18nizableText explanation)

Creates an instance of a AccessExplanation record class.

Parameters:

accessControllerId - the value for the accessControllerId record component

accessResult - the value for the accessResult record component

explanation - the value for the explanation record component

Method Details

profilesToI18nizableText

public static I18nizableText profilesToI18nizableText(Set<Profile> profiles)

Helper to build a I18nizableText for profiles

Parameters:

profiles - the profile

Returns:

the I18nizableText

groupsToI18nizableText

public static I18nizableText groupsToI18nizableText(Set<Group> groups)

Helper to build a I18nizableText for groups

Parameters:

groups - the profile

Returns:

the I18nizableText

elementsToI18nizableText

public static I18nizableText elementsToI18nizableText(List<String> elements)

Helper to build a I18nizableText for a list of String

Parameters:

elements - the strings

Returns:

the I18nizableText

compareTo

public int compareTo(AccessExplanation o)

Specified by:

compareTo in interface Comparable<AccessExplanation>

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.

accessControllerId

public String accessControllerId()

Returns the value of the accessControllerId record component.

Returns:

the value of the accessControllerId record component

accessResult

public AccessController.AccessResult accessResult()

Returns the value of the accessResult record component.

Returns:

the value of the accessResult record component

explanation

public I18nizableText explanation()

Returns the value of the explanation record component.

Returns:

the value of the explanation record component