Package org.forgerock.secrets

Record Class SecretBuilder.SecretAndExpirer<T extends Secret>

java.lang.Object
java.lang.Record
org.forgerock.secrets.SecretBuilder.SecretAndExpirer<T>
Type Parameters:
T - the secret's type.
Record Components:
secret - the secret
expirer - its associated expirer
Enclosing class:
SecretBuilder
public static record SecretBuilder.SecretAndExpirer<T extends Secret>(T extends Secret secret, SecretBuilder.Expirer expirer) extends Record
A simple holder of a secret and its expirer.

  • Constructor Details

    • SecretAndExpirer

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

    • secret

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

    • expirer

      public SecretBuilder.Expirer expirer()
      Returns the value of the expirer record component.
      Returns:
      the value of the expirer record component