Package org.forgerock.secrets.credentials

Record Class PrincipalAndSecret<T extends Secret>

java.lang.Object
java.lang.Record
org.forgerock.secrets.credentials.PrincipalAndSecret<T>
Type Parameters:
T - the type of secret
Record Components:
principal - the principal value
secret - the secret value
public record PrincipalAndSecret<T extends Secret>(String principal, T extends Secret secret) extends Record
Container for a principal and secret.

  • Constructor Details

    • PrincipalAndSecret

      public PrincipalAndSecret(String principal, T secret)
      Creates an instance of a PrincipalAndSecret record class.
      Parameters:
      principal - the value for the principal record component
      secret - the value for the secret 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.

    • principal

      public String principal()
      Returns the value of the principal record component.
      Returns:
      the value of the principal record component

    • secret

      public T secret()
      Returns the value of the secret record component.
      Returns:
      the value of the secret record component