Package com.inductiveautomation.ignition.gateway.images

Record Class ImageResource

java.lang.Object
java.lang.Record
com.inductiveautomation.ignition.gateway.images.ImageResource
public record ImageResource(ResourcePath path, ImmutableBytes data, ImageFormat format, String description, int width, int height, int size) extends Record
Record type that represents an image resource.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    FORMAT_ATTRIBUTE
    The name of the attribute that contains the image's format, e.g.
    static final String
    HEIGHT_ATTRIBUTE
    The name of the attribute that contains the image's height.
    static final String
    SIZE_ATTRIBUTE
    The name of the attribute that contains the image's byte array length
    static final ResourceType
    TYPE
     
    static final String
    WIDTH_ATTRIBUTE
    The name of the attribute that contains the image's width.

  • Constructor Summary

    Constructors
    Constructor
    Description
    ImageResource(ResourcePath path, ImmutableBytes data, ImageFormat format, String description, int width, int height, int size)
    Creates an instance of a ImageResource record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    ImmutableBytes
    data()
    Returns the value of the data record component.
    String
    description()
    Returns the value of the description record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    ImageFormat
    format()
    Returns the value of the format record component.
    final int
    hashCode()
    Returns a hash code value for this object.
    int
    height()
    Returns the value of the height record component.
    ResourcePath
    path()
    Returns the value of the path record component.
    int
    size()
    Returns the value of the size record component.
    final String
    toString()
    Returns a string representation of this record class.
    int
    width()
    Returns the value of the width record component.

    Methods inherited from class java.lang.Object

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

  • Field Details

    • TYPE

      public static final ResourceType TYPE

    • WIDTH_ATTRIBUTE

      public static final String WIDTH_ATTRIBUTE
      The name of the attribute that contains the image's width.
      See Also:

    • HEIGHT_ATTRIBUTE

      public static final String HEIGHT_ATTRIBUTE
      The name of the attribute that contains the image's height.
      See Also:

    • SIZE_ATTRIBUTE

      public static final String SIZE_ATTRIBUTE
      The name of the attribute that contains the image's byte array length
      See Also:

    • FORMAT_ATTRIBUTE

      public static final String FORMAT_ATTRIBUTE
      The name of the attribute that contains the image's format, e.g. "PNG", "JPEG", etc.
      See Also:

  • Constructor Details

    • ImageResource

      public ImageResource(ResourcePath path, ImmutableBytes data, ImageFormat format, String description, int width, int height, int size)
      Creates an instance of a ImageResource record class.
      Parameters:
      path - the value for the path record component
      data - the value for the data record component
      format - the value for the format record component
      description - the value for the description record component
      width - the value for the width record component
      height - the value for the height record component
      size - the value for the size 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. 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.

    • path

      public ResourcePath path()
      Returns the value of the path record component.
      Returns:
      the value of the path record component

    • data

      public ImmutableBytes data()
      Returns the value of the data record component.
      Returns:
      the value of the data record component

    • format

      public ImageFormat format()
      Returns the value of the format record component.
      Returns:
      the value of the format record component

    • description

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

    • width

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

    • height

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

    • size

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