Package org.forgerock.openig.heap

Record Class DefaultDeclarationProvider.Declaration

java.lang.Object
java.lang.Record
org.forgerock.openig.heap.DefaultDeclarationProvider.Declaration
Record Components:
name - The heaplet name, used to be referenced by other heaplets.
type - The type of the Heaplet to create
config - The configuration to pass to the heaplet on instanciation. (can be null)
Enclosing interface:
DefaultDeclarationProvider
public static record DefaultDeclarationProvider.Declaration(String name, String type, JsonValue config) extends Record
A Heaplet declaration definition.

  • Constructor Details

    • Declaration

      public Declaration(String name, String type, JsonValue config)
      Public constructor.

    • Declaration

      public Declaration(String name, String type)
      Alternative constructor when no config is needed.
      Parameters:
      name - The heaplet name
      type - The heaplet type

  • Method Details

    • toJson

      public JsonValue toJson()
      JSON version of this Declaration.
      Returns:
      The JSON view of this declaration.

    • 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.

    • name

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

    • type

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

    • config

      public JsonValue config()
      Returns the value of the config record component.
      Returns:
      the value of the config record component