Package org.forgerock.am.trees.api

Record Class TreeUsage.Response

java.lang.Object
java.lang.Record
org.forgerock.am.trees.api.TreeUsage.Response
Record Components:
inUse - true if the tree is in use.
message - a message describing the number of apps using the service.
appNames - a list of the names of the apps using the service.
Enclosing interface:
TreeUsage
public static record TreeUsage.Response(boolean inUse, String message, List<String> appNames) extends Record
Represents the result of a tree usage.

  • Constructor Details

    • Response

      public Response(boolean inUse, String message)
      Represents the result of a tree usage.
      Parameters:
      inUse - true if the tree is in use.
      message - a message describing the number of apps using the service.

    • Response

      public Response(boolean inUse, String message, List<String> appNames)
      Creates an instance of a Response record class.
      Parameters:
      inUse - the value for the inUse record component
      message - the value for the message record component
      appNames - the value for the appNames 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 '=='.
      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.

    • inUse

      public boolean inUse()
      Returns the value of the inUse record component.
      Returns:
      the value of the inUse record component

    • message

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

    • appNames

      public List<String> appNames()
      Returns the value of the appNames record component.
      Returns:
      the value of the appNames record component