Package org.pkl.core.resource

Record Class Resource

java.lang.Object
java.lang.Record
org.pkl.core.resource.Resource
public record Resource(URI uri, byte[] bytes) extends Record
An external (file, HTTP, etc.) resource.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Resource(URI uri, byte[] bytes)
    Creates an instance of a Resource record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    byte[]
    bytes()
    Returns the value of the bytes record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    String
    getBase64()
    Returns the content of this resource in Base64.
    byte[]
    getBytes()
    Deprecated, for removal: This API element is subject to removal in a future version.
    As of 0.28.0, replaced by bytes()
    String
    getText()
    Returns the text content of this resource.
    URI
    getUri()
    Deprecated, for removal: This API element is subject to removal in a future version.
    As of 0.28.0, replaced by uri()
    final int
    hashCode()
    Returns a hash code value for this object.
    final String
    toString()
    Returns a string representation of this record class.
    URI
    uri()
    Returns the value of the uri record component.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • Resource

      public Resource(URI uri, byte[] bytes)
      Creates an instance of a Resource record class.
      Parameters:
      uri - the value for the uri record component
      bytes - the value for the bytes record component

  • Method Details

    • getUri

      @Deprecated(forRemoval=true) public URI getUri()
      Deprecated, for removal: This API element is subject to removal in a future version.
      As of 0.28.0, replaced by uri()

    • getBytes

      @Deprecated(forRemoval=true) public byte[] getBytes()
      Deprecated, for removal: This API element is subject to removal in a future version.
      As of 0.28.0, replaced by bytes()

    • getText

      public String getText()
      Returns the text content of this resource.

    • getBase64

      public String getBase64()
      Returns the content of this resource in Base64.

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

    • uri

      public URI uri()
      Returns the value of the uri record component.
      Returns:
      the value of the uri record component

    • bytes

      public byte[] bytes()
      Returns the value of the bytes record component.
      Returns:
      the value of the bytes record component