Record Class DocumentImage

java.lang.Object
java.lang.Record
com.blueriq.component.api.documents.extraction.DocumentImage
Record Components:
mediaType - the media type of the image
data - the raw binary data of the image
name - the name of the image
public record DocumentImage(org.springframework.http.MediaType mediaType, byte[] data, String name) extends Record
Represents an image extracted from a document.

  • Constructor Summary

    Constructors
    Constructor
    Description
    DocumentImage(org.springframework.http.MediaType mediaType, byte[] data)
     
    DocumentImage(org.springframework.http.MediaType mediaType, byte[] data, String name)
    Creates an instance of a DocumentImage record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    byte[]
    data()
    Returns the value of the data record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    org.springframework.http.MediaType
    mediaType()
    Returns the value of the mediaType record component.
    String
    name()
    Returns the value of the name record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class Object

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

  • Constructor Details

    • DocumentImage

      public DocumentImage(org.springframework.http.MediaType mediaType, byte[] data)

    • DocumentImage

      public DocumentImage(org.springframework.http.MediaType mediaType, byte[] data, String name)
      Creates an instance of a DocumentImage record class.
      Parameters:
      mediaType - the value for the mediaType record component
      data - the value for the data record component
      name - the value for the name 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. 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.

    • mediaType

      public org.springframework.http.MediaType mediaType()
      Returns the value of the mediaType record component.
      Returns:
      the value of the mediaType record component

    • data

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

    • name

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