MockBloc<E, S> class
Extend or mixin this class to mark the implementation as a MockBloc.
A mocked bloc implements all fields and methods with a default
implementation that does not throw a NoSuchMethodError,
and may be further customized at runtime to define how it may behave using
when
and whenListen
.
Note: It is critical to explicitly provide the event and state types when extending MockBloc.
GOOD
class MockCounterBloc extends MockBloc<CounterEvent, int>
implements CounterBloc {}
BAD
class MockCounterBloc extends MockBloc implements CounterBloc {}
Properties
- 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 state stream.
no setterinherited
Methods
-
add(
E event) → void -
Notifies the
Bloc
of a newevent
which triggers all correspondingEventHandler
instances. If close has already been called, any subsequent calls to add will be ignored and will not result in any subsequent state changes.inherited -
addError(
Object error, [StackTrace? stackTrace]) → void -
Reports an
error
which triggers onError with an optional StackTrace.inherited -
close(
) → Future< void> -
Closes the instance.
This method should be called when the instance is no longer needed.
Once close is called, the instance can no longer be used.
inherited
-
emit(
S state) → void -
Updates the
state
to the providedstate
. emit does nothing if the instance has been closed or if thestate
being emitted is equal to the currentstate
.inherited -
listen(
void onData(S)?, {Function? onError, void onDone()?, bool? cancelOnError}) → StreamSubscription< S> -
Adds a subscription to the
Stream<State>
. Returns a StreamSubscription which handles events from theStream<State>
using the providedonData
,onError
andonDone
handlers.inherited -
mapEventToState(
E event) → Stream< S> -
@Deprecated - Use on
inherited
-
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(
E event) → void -
Called whenever an
event
is added to theBloc
. A great spot to add logging/analytics at the individualBloc
level.inherited -
onTransition(
Transition< E, 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
. executed. onTransition is called before aBloc
's state has been updated. A great spot to add logging/analytics at the individualBloc
level.inherited -
toString(
) → String -
A string representation of this object.
inherited
-
transformEvents(
Stream< E> events, TransitionFunction<E, S> transitionFn) → Stream<Transition< E, S> > -
@Deprecated - Use
on<Event>
with anEventTransformer
instead. Will be removed in v8.0.0inherited -
transformTransitions(
Stream< Transition< transitions) → Stream<E, S> >Transition< E, S> > -
@Deprecated - Override
Stream<State> get stream
instead. Will be removed in v8.0.0inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited