MockStateController<S> class

Extend or mixin this class to mark the implementation as a MockStateController.

A mocked StateController 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.

Note: It is critical to explicitly provide the state types when extending MockStateController.

GOOD

class MockCounterStateController extends MockStateController<int>
  implements CounterStateController {}

BAD

class MockCounterStateController extends MockController implements CounterStateController {}
Inheritance
Implemented types
  • GetxController
Available Extensions

Constructors

MockStateController()

Properties

hashCode → int
The hash code for this object.
no setterinherited
hasListeners → bool
no setterinherited
initialized → bool
Checks whether the controller has already been initialized.
no setterinherited
isClosed → bool
Checks whether the controller has already been closed.
no setterinherited
listeners → int
no setterinherited
onDelete → InternalFinalCallback<void>
Internal callback that starts the cycle of this controller.
finalinherited
onStart → InternalFinalCallback<void>
Called at the exact moment the widget is allocated in memory. It uses an internal "callable" type, to avoid any @overrides in subclases. This method should be internal and is required to define the lifetime cycle of the subclass.
finalinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
rxState → Rx<S>
The current rxState.
latefinalinherited
state → S
The current state.
no setterinherited
stream → Stream<S>
The current state stream.
no setterinherited

Methods

$configureLifeCycle() → void
inherited
addError(Object error, [StackTrace? stackTrace]) → void
Reports an error which triggers onError with an optional StackTrace.
inherited
addListener(GetStateUpdate listener) → Disposer
Register a closure to be called when the object notifies its listeners.
inherited
addListenerId(Object? key, GetStateUpdate listener) → Disposer
inherited
dispose() → void
inherited
disposeId(Object id) → void
To dispose an id from future updates(), this ids are registered by GetBuilder() or similar, so is a way to unlink the state change with the Widget from the Controller.
inherited
emit(S state) → void
Updates the state to the provided state. emit does nothing if the instance has been closed or if the state being emitted is equal to the current state.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
notifyChildrens() → void
inherited
onChange(StateChange<S> change) → void
Called whenever a change occurs with the given change. A change occurs when a new state is emitted. onChange is called before the state of the StateController is updated. onChange is a great spot to add logging/analytics for a specific StateController.
inherited
onClose() → Future<void>
Closes the instance. This method should be called when the instance is no longer needed. Once onClose is called, the instance can no longer be used.
inherited
onError(Object error, StackTrace stackTrace) → void
Called whenever an error occurs and notifies ObserverController.onError.
inherited
onInit() → void
Called immediately after the widget is allocated in memory. You might use this to initialize something for the controller.
inherited
onReady() → void
Called 1 frame after onInit(). It is the perfect place to enter navigation events, like snackbar, dialogs, or a new route, or async request.
inherited
refresh() → void
inherited
refreshGroup(Object id) → void
inherited
removeListener(VoidCallback listener) → void
Remove a previously registered closure from the list of closures that the object notifies.
inherited
removeListenerId(Object id, VoidCallback listener) → void
inherited
toString() → String
A string representation of this object.
inherited
update([List<Object>? ids, bool condition = true]) → void
Rebuilds GetBuilder each time you call update(); Can take a List of ids, that will only update the matching GetBuilder( id: ), ids can be reused among GetBuilders like group tags. The update will only notify the Widgets, if condition is true.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited