Package jmri

Interface ExpectedState<T,​S>

  • Type Parameters:
    T - the type of object this contains the expected state for
    S - the type of expected state this contains
    All Known Implementing Classes:
    BeanSetting, LayoutTrackExpectedState, NamedBeanExpectedState, NamedBeanExpectedValue

    public interface ExpectedState<T,​S>
    Record an object and its expected state within a specific scenario. This can be used in collections, for example as a routing through a set of turnouts, where the turnouts and their state when all turnouts are routed for that routing can be iterated over in a single loop with reference to a single collection.
    • Method Detail

      • getExpectedState

        S getExpectedState()
        Get the expected state. This state should not change as the state of the NamedBean changes.
        the expected state
      • setExpectedState

        void setExpectedState​(S state)
                       throws java.lang.UnsupportedOperationException
        Set the expected state.

        If UnsupportedOperationException is not thrown, this must fire a PropertyChangeEvent with the name "expectedState"

        state - the new expected state
        java.lang.UnsupportedOperationException - if the implementing class does not allow states to be set
      • getObject

        T getObject()
        Get the Object this records the expected state for.
        the associated object