final class EventHandlerBuilderByState[S <: State, State, Event] extends AnyRef

Source
EventHandler.scala
Linear Supertypes
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. EventHandlerBuilderByState
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new EventHandlerBuilderByState(stateClass: Class[S], statePredicate: Predicate[S])

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from EventHandlerBuilderByState[S, State, Event] toany2stringadd[EventHandlerBuilderByState[S, State, Event]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (EventHandlerBuilderByState[S, State, Event], B)
    Implicit
    This member is added by an implicit conversion from EventHandlerBuilderByState[S, State, Event] toArrowAssoc[EventHandlerBuilderByState[S, State, Event]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def build(): EventHandler[State, Event]

    Builds and returns a handler from the appended states.

    Builds and returns a handler from the appended states. The returned EventHandler will throw a scala.MatchError if applied to an event that has no defined case.

  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  9. def ensuring(cond: (EventHandlerBuilderByState[S, State, Event]) => Boolean, msg: => Any): EventHandlerBuilderByState[S, State, Event]
    Implicit
    This member is added by an implicit conversion from EventHandlerBuilderByState[S, State, Event] toEnsuring[EventHandlerBuilderByState[S, State, Event]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: (EventHandlerBuilderByState[S, State, Event]) => Boolean): EventHandlerBuilderByState[S, State, Event]
    Implicit
    This member is added by an implicit conversion from EventHandlerBuilderByState[S, State, Event] toEnsuring[EventHandlerBuilderByState[S, State, Event]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean, msg: => Any): EventHandlerBuilderByState[S, State, Event]
    Implicit
    This member is added by an implicit conversion from EventHandlerBuilderByState[S, State, Event] toEnsuring[EventHandlerBuilderByState[S, State, Event]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean): EventHandlerBuilderByState[S, State, Event]
    Implicit
    This member is added by an implicit conversion from EventHandlerBuilderByState[S, State, Event] toEnsuring[EventHandlerBuilderByState[S, State, Event]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  15. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  16. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  21. def onAnyEvent(handler: Function[Event, State]): EventHandler[State, Event]

    Match any event.

    Match any event.

    Use this when then State is not needed in the handler, otherwise there is an overloaded method that pass the state in a BiFunction.

    Note: event handlers are selected in the order they are added. Once a matching is found, it's selected for handling the event and no further lookup is done. Therefore you must make sure that their matching conditions don't overlap, otherwise you risk to 'shadow' part of your event handlers.

    Extra care should be taken when using onAnyEvent as it will match any event. This method builds and returns the event handler since this will not let through any states to subsequent match statements.

    returns

    An EventHandler from the appended states.

  22. def onAnyEvent(handler: BiFunction[State, Event, State]): EventHandler[State, Event]

    Match any event.

    Match any event.

    Note: event handlers are selected in the order they are added. Once a matching is found, it's selected for handling the event and no further lookup is done. Therefore you must make sure that their matching conditions don't overlap, otherwise you risk to 'shadow' part of your event handlers.

    Extra care should be taken when using onAnyEvent as it will match any event. This method builds and returns the event handler since this will not let through any states to subsequent match statements.

    returns

    An EventHandler from the appended states.

  23. def onEvent[E <: Event](eventClass: Class[E], handler: Supplier[State]): EventHandlerBuilderByState[S, State, Event]

    Match any event which is an instance of E or a subtype of E.

    Match any event which is an instance of E or a subtype of E.

    Use this when then State and the Event are not needed in the handler.

    Note: event handlers are selected in the order they are added. Once a matching is found, it's selected for handling the event and no further lookup is done. Therefore you must make sure that their matching conditions don't overlap, otherwise you risk to 'shadow' part of your event handlers.

  24. def onEvent[E <: Event](eventClass: Class[E], handler: Function[E, State]): EventHandlerBuilderByState[S, State, Event]

    Match any event which is an instance of E or a subtype of E.

    Match any event which is an instance of E or a subtype of E.

    Use this when then State is not needed in the handler, otherwise there is an overloaded method that pass the state in a BiFunction.

    Note: event handlers are selected in the order they are added. Once a matching is found, it's selected for handling the event and no further lookup is done. Therefore you must make sure that their matching conditions don't overlap, otherwise you risk to 'shadow' part of your event handlers.

  25. def onEvent[E <: Event](eventClass: Class[E], handler: BiFunction[S, E, State]): EventHandlerBuilderByState[S, State, Event]

    Match any event which is an instance of E or a subtype of E.

    Match any event which is an instance of E or a subtype of E.

    Note: event handlers are selected in the order they are added. Once a matching is found, it's selected for handling the event and no further lookup is done. Therefore you must make sure that their matching conditions don't overlap, otherwise you risk to 'shadow' part of your event handlers.

  26. def orElse[S2 <: State](other: EventHandlerBuilderByState[S2, State, Event]): EventHandlerBuilderByState[S2, State, Event]

    Compose this builder with another builder.

    Compose this builder with another builder. The handlers in this builder will be tried first followed by the handlers in other.

  27. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  28. def toString(): String
    Definition Classes
    AnyRef → Any
  29. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  30. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  31. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

  2. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from EventHandlerBuilderByState[S, State, Event] toStringFormat[EventHandlerBuilderByState[S, State, Event]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  3. def [B](y: B): (EventHandlerBuilderByState[S, State, Event], B)
    Implicit
    This member is added by an implicit conversion from EventHandlerBuilderByState[S, State, Event] toArrowAssoc[EventHandlerBuilderByState[S, State, Event]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromEventHandlerBuilderByState[S, State, Event] to any2stringadd[EventHandlerBuilderByState[S, State, Event]]

Inherited by implicit conversion StringFormat fromEventHandlerBuilderByState[S, State, Event] to StringFormat[EventHandlerBuilderByState[S, State, Event]]

Inherited by implicit conversion Ensuring fromEventHandlerBuilderByState[S, State, Event] to Ensuring[EventHandlerBuilderByState[S, State, Event]]

Inherited by implicit conversion ArrowAssoc fromEventHandlerBuilderByState[S, State, Event] to ArrowAssoc[EventHandlerBuilderByState[S, State, Event]]

Ungrouped