Class WSOptionChangedEvent


  • @API(type=NOT_EXTENDABLE,
         src=PUBLIC)
    public class WSOptionChangedEvent
    extends java.lang.Object
    Represents an event which indicates that the value of an option has been changed.
    • Constructor Summary

      Constructors 
      Constructor Description
      WSOptionChangedEvent​(java.lang.String optionKey, java.lang.Object oldValue, java.lang.Object newValue)
      The constructor of the option changed event.
      WSOptionChangedEvent​(java.lang.String optionKey, java.lang.String oldValue, java.lang.String newValue)
      The constructor of the option changed event.
    • Method Summary

      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      java.lang.String getNewValue()
      Deprecated.
      The value may not be a plain String, use the "getNewValueObject" instead
      java.lang.Object getNewValueObject()  
      java.lang.String getOldValue()
      Deprecated.
      The value may not be a plain String, use the "getOldValueObject" instead
      java.lang.Object getOldValueObject()  
      java.lang.String getOptionKey()  
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • WSOptionChangedEvent

        public WSOptionChangedEvent​(java.lang.String optionKey,
                                    java.lang.String oldValue,
                                    java.lang.String newValue)
        The constructor of the option changed event.
        Parameters:
        optionKey - The identification key of the option whose value modification generated this event.
        oldValue - The old value of the option.
        newValue - The new value of the option. When the entire set of Oxygen preferences is reset by the end user, the reported old value will be equal to the new value as the global reset no longer retains the state of the value before the reset...
      • WSOptionChangedEvent

        public WSOptionChangedEvent​(java.lang.String optionKey,
                                    java.lang.Object oldValue,
                                    java.lang.Object newValue)
        The constructor of the option changed event.
        Parameters:
        optionKey - The identification key of the option whose value modification generated this event.
        oldValue - The old value of the option.
        newValue - The new value of the option. When the entire set of Oxygen preferences is reset by the end user, the reported old value will be equal to the new value as the global reset no longer retains the state of the value before the reset...
    • Method Detail

      • getOptionKey

        public java.lang.String getOptionKey()
        Returns:
        Returns the identification key of the option associated with this event.
      • getOldValue

        @Deprecated
        public java.lang.String getOldValue()
        Deprecated.
        The value may not be a plain String, use the "getOldValueObject" instead
        Returns:
        Returns the old value of the option associated with this event.
      • getOldValueObject

        public java.lang.Object getOldValueObject()
        Returns:
        Returns the old value of the option associated with this event.
        Since:
        21.1
      • getNewValue

        @Deprecated
        public java.lang.String getNewValue()
        Deprecated.
        The value may not be a plain String, use the "getNewValueObject" instead
        Returns:
        Returns the new value of the option associated with this event.
      • getNewValueObject

        public java.lang.Object getNewValueObject()
        Returns:
        Returns the new value of the option associated with this event.
        Since:
        21.1