Package dev.jaxydog.astral.utility.color

Record Class ImageMapper

java.lang.Object
java.lang.Record
dev.jaxydog.astral.utility.color.ImageMapper
Record Components:
color - The color converter.
image - The image consumer, for applying image-wide filters.
public record ImageMapper(ColorMapper color, Consumer<BufferedImage> image) extends Record
Converts an image into a new, adjusted form.
Since:
2.0.0

  • Constructor Details

    • ImageMapper

      public ImageMapper(ColorMapper color, Consumer<BufferedImage> image)
      Creates an instance of a ImageMapper record class.
      Parameters:
      color - the value for the color record component
      image - the value for the image record component

  • Method Details

    • convert

      public BufferedImage convert(BufferedImage image)
      Processes and converts the provided image into a new, adjusted image.
      Parameters:
      image - The base image.
      Returns:
      A new image.
      Since:
      2.0.0

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

    • color

      public ColorMapper color()
      Returns the value of the color record component.
      Returns:
      the value of the color record component

    • image

      public Consumer<BufferedImage> image()
      Returns the value of the image record component.
      Returns:
      the value of the image record component