Package com.io7m.calino.api

Record Class CLNCompressionMethodCustom

java.lang.Object
java.lang.Record
com.io7m.calino.api.CLNCompressionMethodCustom
Record Components:
descriptor - The compression descriptor
compressionSectionIdentifier - The identifier of the section containing data required to decompress data
blockSizeX - The size of a compressed block on the X axis
blockSizeY - The size of a compressed block on the Y axis
blockAlignment - The required alignment of a compressed block
All Implemented Interfaces:
CLNCompressionMethodType, CLNDescribableType
public record CLNCompressionMethodCustom(String descriptor, long compressionSectionIdentifier, int blockSizeX, int blockSizeY, int blockAlignment) extends Record implements CLNCompressionMethodType
A custom compression method.

  • Constructor Details

    • CLNCompressionMethodCustom

      public CLNCompressionMethodCustom(String descriptor, long compressionSectionIdentifier, int blockSizeX, int blockSizeY, int blockAlignment)
      A custom compression method.
      Parameters:
      descriptor - The compression descriptor
      compressionSectionIdentifier - The identifier of the section containing data required to decompress data
      blockSizeX - The size of a compressed block on the X axis
      blockSizeY - The size of a compressed block on the Y axis
      blockAlignment - The required alignment of a compressed block

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

    • descriptor

      public String descriptor()
      Returns the value of the descriptor record component.
      Specified by:
      descriptor in interface CLNDescribableType
      Returns:
      the value of the descriptor record component

    • compressionSectionIdentifier

      public long compressionSectionIdentifier()
      Returns the value of the compressionSectionIdentifier record component.
      Specified by:
      compressionSectionIdentifier in interface CLNCompressionMethodType
      Returns:
      the value of the compressionSectionIdentifier record component

    • blockSizeX

      public int blockSizeX()
      Returns the value of the blockSizeX record component.
      Specified by:
      blockSizeX in interface CLNCompressionMethodType
      Returns:
      the value of the blockSizeX record component

    • blockSizeY

      public int blockSizeY()
      Returns the value of the blockSizeY record component.
      Specified by:
      blockSizeY in interface CLNCompressionMethodType
      Returns:
      the value of the blockSizeY record component

    • blockAlignment

      public int blockAlignment()
      Returns the value of the blockAlignment record component.
      Specified by:
      blockAlignment in interface CLNCompressionMethodType
      Returns:
      the value of the blockAlignment record component