BaseArchBloc<S> class
abstract
Abstract class for a base architecture BLoC (Business Logic Component).
Constructors
- BaseArchBloc(S initialState)
- Constructor for the BaseArchBloc class.
Properties
- eventBus → EventBus
-
no setter
-
eventListeners
↔ Map<
Type, StreamSubscription> -
getter/setter pair
- hashCode → int
-
The hash code for this object.
no setterinherited
- isClosed → bool
-
Whether the bloc is closed.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- state → S
-
The current state.
no setterinherited
-
stream
→ Stream<
S> -
The current stream of states.
no setterinherited
Methods
-
add(
UpdateEvent event) → void -
Notifies the
Bloc
of a newevent
which triggers all correspondingEventHandler
instances.inherited -
addError(
Object error, [StackTrace? stackTrace]) → void -
Reports an
error
which triggersonError
with an optional StackTrace.inherited -
close(
) → Future< void> - Closes the bloc instance and performs necessary cleanup operations.
-
emit(
S state) → void -
emit
is only for internal use and should never be called directly outside of tests. TheEmitter
instance provided to eachEventHandler
should be used instead.inherited -
executeStartupEvents(
) → void - executeStartupEvents()
-
listen<
T> (dynamic callback(T)) → StreamSubscription< T> - Listens for events of a specific type and registers a callback function to handle them.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
on<
E extends Event> (EventHandler< E, S> handler, {EventTransformer<E> ? transformer}) → void -
Register event handler for an event of type
E
. There should only ever be one event handler per event typeE
.inherited -
onChange(
Change< S> change) → void -
Called whenever a
change
occurs with the givenchange
. Achange
occurs when a newstate
is emitted.onChange
is called before thestate
of thecubit
is updated.onChange
is a great spot to add logging/analytics for a specificcubit
.inherited -
onError(
Object error, StackTrace stackTrace) → void -
Called whenever an
error
occurs and notifiesBlocObserver.onError
.inherited -
onEvent(
UpdateEvent event) → void -
Called whenever an
event
isadd
ed to theBloc
. A great spot to add logging/analytics at the individualBloc
level.inherited -
onTransition(
Transition< UpdateEvent, S> transition) → void -
Called whenever a
transition
occurs with the giventransition
. Atransition
occurs when a newevent
is added and a new state isemitted
from a correspondingEventHandler
.inherited -
registerEvents(
) → void - registerEvents()
-
toString(
) → String -
A string representation of this object.
inherited
-
updateState(
S newState) → void - Updates the state of the bloc with a new state instance.
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited