Package com.inductiveautomation.ignition.common.images

Record Class ImageRpc.ImageData

java.lang.Object
java.lang.Record
com.inductiveautomation.ignition.common.images.ImageRpc.ImageData
Enclosing interface:
ImageRpc
public static record ImageRpc.ImageData(String path, @Nullable ImageFormat type, String description, int width, int height, int size) extends Record

  • Constructor Summary

    Constructors
    Constructor
    Description
    ImageData(String path, @Nullable ImageFormat type, String description, int width, int height, int size)
    Creates an instance of a ImageData record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    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.
    final int
    hashCode()
    Returns a hash code value for this object.
    int
    height()
    Returns the value of the height record component.
    String
    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.
    @Nullable ImageFormat
    type()
    Returns the value of the type record component.
    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

  • Constructor Details

    • ImageData

      public ImageData(String path, @Nullable @Nullable ImageFormat type, String description, int width, int height, int size)
      Creates an instance of a ImageData record class.
      Parameters:
      path - the value for the path record component
      type - the value for the type 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 String path()
      Returns the value of the path record component.
      Returns:
      the value of the path record component

    • type

      @Nullable public @Nullable ImageFormat type()
      Returns the value of the type record component.
      Returns:
      the value of the type 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