Package io.github.dornol.excelkit.excel

Record Class ExcelImage

java.lang.Object
java.lang.Record
io.github.dornol.excelkit.excel.ExcelImage
Record Components:
data - the image bytes (PNG, JPEG, etc.)
imageType - the image type constant from Workbook (e.g., Workbook.PICTURE_TYPE_PNG, Workbook.PICTURE_TYPE_JPEG)
public record ExcelImage(byte[] data, int imageType) extends Record
Represents image data to be embedded in an Excel cell.
Since:
0.6.0

  • Constructor Summary

    Constructors
    Constructor
    Description
    ExcelImage(byte[] data, int imageType)
    Validates that image data is not null or empty.

  • 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.
    int
    imageType()
    Returns the value of the imageType record component.
    static ExcelImage
    jpeg(byte[] data)
    Creates a JPEG image.
    static ExcelImage
    png(byte[] data)
    Creates a PNG image.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • ExcelImage

      public ExcelImage(byte[] data, int imageType)
      Validates that image data is not null or empty.

  • Method Details

    • png

      public static ExcelImage png(byte[] data)
      Creates a PNG image.
      Parameters:
      data - the PNG image bytes
      Returns:
      an ExcelImage with PNG type

    • jpeg

      public static ExcelImage jpeg(byte[] data)
      Creates a JPEG image.
      Parameters:
      data - the JPEG image bytes
      Returns:
      an ExcelImage with JPEG type

    • 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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      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.

    • data

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

    • imageType

      public int imageType()
      Returns the value of the imageType record component.
      Returns:
      the value of the imageType record component