Record Class DocumentContent

java.lang.Object
java.lang.Record
com.blueriq.component.api.documents.extraction.DocumentContent
Record Components:
text - the text content of the document
images - the image content of the document
documentType - the type of content in the document
public record DocumentContent(String text, List<DocumentImage> images, DocumentType documentType) extends Record
Represents the content extracted from a document.

  • Constructor Details

    • DocumentContent

      public DocumentContent(String text, List<DocumentImage> images, DocumentType documentType)
      Creates a new DocumentContent instance.
      Parameters:
      text - the text content
      images - the image content
      documentType - the document type

    • DocumentContent

      public DocumentContent(String text)
      Creates a new DocumentContent instance for a text-only document.
      Parameters:
      text - the text content

    • DocumentContent

      public DocumentContent(List<DocumentImage> images)
      Creates a new DocumentContent instance for an image-only document.
      Parameters:
      images - the image content

    • DocumentContent

      public DocumentContent(String text, List<DocumentImage> images)
      Creates a new DocumentContent instance for a document containing both text and images.
      Parameters:
      text - the text content
      images - the image content

  • Method Details

    • images

      public List<DocumentImage> images()
      Returns an unmodifiable list of images.
      Returns:
      the images

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

    • text

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

    • documentType

      public DocumentType documentType()
      Returns the value of the documentType record component.
      Returns:
      the value of the documentType record component