Enum Class SeriesInteger

java.lang.Object
java.lang.Enum<SeriesInteger>
com.iizix.prop.ui.chart.series.SeriesInteger
All Implemented Interfaces:
IPropCnrInteger, Serializable, Comparable<SeriesInteger>, Constable
public enum SeriesInteger extends Enum<SeriesInteger> implements IPropCnrInteger
The Series integer settings the can be set or retrieved: the window of a live series, see Series.appendLive(double...). Both are server-side settings, read when live points are appended; the client ignores them.
Author:
Christopher Mindus

  • Enum Constant Details

    • LIVE_MAX_POINTS

      public static final SeriesInteger LIVE_MAX_POINTS
      Live window size in points: when more points than this are present after an append, the oldest ones are removed. Zero means no limit by count.

      Default is 0.

    • LIVE_MAX_SECONDS

      public static final SeriesInteger LIVE_MAX_SECONDS
      Live window size in seconds: points appended longer ago than this are removed at the next append (or Series.applyLiveWindow()). A value not added by Series.appendLive(double...) has no append time and counts as older than any window. Zero means no limit by age.

      Default is 0.

  • Method Details

    • values

      public static SeriesInteger[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static SeriesInteger valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • getDefaultValue

      public int getDefaultValue()
      Gets the default value when the property is not set.
      Specified by:
      getDefaultValue in interface IPropCnrInteger

    • getPropName

      public String getPropName()
      Returns the name of the property, usually starting with '$'.
      Specified by:
      getPropName in interface IPropCnrInteger

    • validate

      public void validate(PropCnr pc, int value) throws PropValidateException
      Validates a new value.

      Overridden to provide validation for negative values.

      Specified by:
      validate in interface IPropCnrInteger
      Parameters:
      pc - The property container that will be set.
      value - The new value to validate.
      Throws:
      PropValidateException - If the value is negative.