Package jmri.jmrit.symbolicprog

Enum AbstractValue.ValueState

java.lang.Object
java.lang.Enum<AbstractValue.ValueState>
jmri.jmrit.symbolicprog.AbstractValue.ValueState
All Implemented Interfaces:
Serializable, Comparable<AbstractValue.ValueState>, java.lang.constant.Constable
Enclosing class:
AbstractValue
public static enum AbstractValue.ValueState extends Enum<AbstractValue.ValueState>
States, hence colors, of Variables and CVs. Note that these as written and read by name in LocoFiles in the roster. Do not change the name of these values without putting a migration scheme in place.

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    DIFFERENT
    Defines state where value was read from a config file, and is the not the same as the decoder.
    EDITED
    Defines state where value has been edited, no longer same as in decoder or file.
    FROMDEFAULT
    Defines state where value was defined by the decoder definition default, and has never been edited or read from or written to the decoder.
    FROMFILE
    Defines state where value was read from a config file, but might not be the same as the decoder.
    FROMFILEUNKNOWN
    Defines state where value was read from a config file, but might not be the same as the decoder.
    READ
    Defines state where value has been read from (hence same as) decoder, but perhaps not same as in file.
    SAME
    Defines state where value was read from a config file, and is the same as the decoder.
    STORED
    Defines state where value has been written to (hence same as) decoder, but perhaps not same as in file.
    UNKNOWN
    Defines state when nothing is known about the real value.

  • Method Summary

    Modifier and Type
    Method
    Description
    Color
    getColor()
    Gets the color associated with this state value.
    String
    getName()
    Gets the name associated with this state value.
    static AbstractValue.ValueState
    valueOf(String name)
    Returns the enum constant of this type with the specified name.
    static AbstractValue.ValueState[]
    values()
    Returns an array containing the constants of this enum type, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • UNKNOWN

      public static final AbstractValue.ValueState UNKNOWN
      Defines state when nothing is known about the real value.

    • EDITED

      public static final AbstractValue.ValueState EDITED
      Defines state where value has been edited, no longer same as in decoder or file.

    • READ

      public static final AbstractValue.ValueState READ
      Defines state where value has been read from (hence same as) decoder, but perhaps not same as in file.

    • STORED

      public static final AbstractValue.ValueState STORED
      Defines state where value has been written to (hence same as) decoder, but perhaps not same as in file.

    • FROMFILE

      public static final AbstractValue.ValueState FROMFILE
      Defines state where value was read from a config file, but might not be the same as the decoder. It is known to have been edited/read/written at some point.

    • FROMFILEUNKNOWN

      public static final AbstractValue.ValueState FROMFILEUNKNOWN
      Defines state where value was read from a config file, but might not be the same as the decoder. It's unknown whether the item has been edited/read/written at some point.

    • FROMDEFAULT

      public static final AbstractValue.ValueState FROMDEFAULT
      Defines state where value was defined by the decoder definition default, and has never been edited or read from or written to the decoder.

    • SAME

      public static final AbstractValue.ValueState SAME
      Defines state where value was read from a config file, and is the same as the decoder.

    • DIFFERENT

      public static final AbstractValue.ValueState DIFFERENT
      Defines state where value was read from a config file, and is the not the same as the decoder.

  • Method Details

    • values

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

    • valueOf

      public static AbstractValue.ValueState valueOf(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name
      NullPointerException - if the argument is null

    • getColor

      public Color getColor()
      Gets the color associated with this state value.
      Returns:
      the color assigned to this state value or null if to use default for the component

    • getName

      public String getName()
      Gets the name associated with this state value.
      Returns:
      the name assigned to this state value