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, for reference by other heaplets.
heaplet - The type of the Heaplet to create
config - The configuration to pass to the heaplet on instantiation. (can be null)
decorations - The decoration that applies to the heaplet in the form: 
 
 "decoratorName": decoratorConfigAsJsonValue
Enclosing interface:
DefaultDeclarationProvider
public static record DefaultDeclarationProvider.Declaration(String name, Heaplet heaplet, JsonValue config, Map<String,JsonValue> decorations) extends Record
A Heaplet declaration definition.

  • Constructor Details

    • Declaration

      public Declaration(String name, Heaplet heaplet, JsonValue config, Map<String,JsonValue> decorations)
      Public constructor.

    • Declaration

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

    • Declaration

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

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

    • name

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

    • heaplet

      public Heaplet heaplet()
      Returns the value of the heaplet record component.
      Returns:
      the value of the heaplet record component

    • config

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

    • decorations

      public Map<String,JsonValue> decorations()
      Returns the value of the decorations record component.
      Returns:
      the value of the decorations record component