Package org.forgerock.openig.heap

Record Class ReloadableResource

java.lang.Object
java.lang.Record
org.forgerock.openig.heap.ReloadableResource
Record Components:
id - the identifier of the resource.
resourceFile - the path to the resource file.
format - the format of the resource file.
public record ReloadableResource(String id, Path resourceFile, ReloadableResource.Format format) extends Record
A representation of a reloadable resource.

  • Constructor Details

    • ReloadableResource

      public ReloadableResource(String id, Path resourceFile, ReloadableResource.Format format)
      Constructs a new ReloadableResource.
      Parameters:
      id - the identifier of the resource.
      resourceFile - the path to the resource file.
      format - the format of the resource file.

  • Method Details

    • update

      public void update(JsonValue content) throws IOException
      Updates the content of the resource file.
      Parameters:
      content - the new content to write to the resource file.
      Throws:
      IOException - if there is a problem writing to the resource file.

    • read

      public JsonValue read() throws IOException
      Reads the content of the resource file.
      Returns:
      the content of the resource file as a JsonValue.
      Throws:
      IOException - if there is a problem reading the resource file.

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

    • id

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

    • resourceFile

      public Path resourceFile()
      Returns the value of the resourceFile record component.
      Returns:
      the value of the resourceFile record component

    • format

      public ReloadableResource.Format format()
      Returns the value of the format record component.
      Returns:
      the value of the format record component