MockCubit<S> class
Extend or mixin this class to mark the implementation as a MockCubit.
A mocked cubit 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 state types when extending MockCubit.
GOOD
class MockCounterCubit extends MockCubit<int>
implements CounterCubit {}
BAD
class MockCounterCubit extends MockBloc implements CounterCubit {}
Constructors
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
-
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 -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
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 -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited