Package com.inductiveautomation.ignition.common.model.values

Record Class QualityLevelFilter

java.lang.Object
java.lang.Record
com.inductiveautomation.ignition.common.model.values.QualityLevelFilter
public record QualityLevelFilter(int levelMask) extends Record
A filter for quality levels.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    QualityLevelFilter.Builder
    A builder for creating a QualityLevelFilter.

  • Constructor Summary

    Constructors
    Constructor
    Description
    QualityLevelFilter(int levelMask)
    Creates an instance of a QualityLevelFilter record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    static QualityLevelFilter.Builder
    builder()
    Returns a new Builder for creating a QualityLevelFilter.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    int[]
    getAcceptedLevelValues()
    Returns the integer values (0, 1, 2, 3) of the levels that this filter represents.
    final int
    hashCode()
    Returns a hash code value for this object.
    boolean
    isAccepted(QualityCode.Level level)
    Returns true if the given level is accepted by this filter.
    int
    levelMask()
    Returns the value of the levelMask record component.
    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

    • QualityLevelFilter

      public QualityLevelFilter(int levelMask)
      Creates an instance of a QualityLevelFilter record class.
      Parameters:
      levelMask - the value for the levelMask record component

  • Method Details

    • builder

      public static QualityLevelFilter.Builder builder()
      Returns a new Builder for creating a QualityLevelFilter.
      Returns:
      A new Builder.

    • isAccepted

      public boolean isAccepted(QualityCode.Level level)
      Returns true if the given level is accepted by this filter.
      Parameters:
      level - The level to check.
      Returns:
      True if the level is accepted, false otherwise.

    • getAcceptedLevelValues

      public int[] getAcceptedLevelValues()
      Returns the integer values (0, 1, 2, 3) of the levels that this filter represents.
      Returns:
      An array of integers representing the values of the accepted levels.

    • toString

      public 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 '=='.
      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.

    • levelMask

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