A C D E G I K P R S U W

A

actions(interceptor) - Method in class de.halfbit.knot.InterceptBuilder

A function for intercepting Action emissions.

actions(block) - Method in class de.halfbit.knot.KnotBuilder

A section for Action related declarations.

actions(block) - Method in class de.halfbit.knot.PrimeBuilder

A section for Action related declarations.

actions(watcher) - Method in class de.halfbit.knot.WatchBuilder

A function for watching Action emissions.

ActionsBuilder<Change,Action> - Class in de.halfbit.knot

addTo(composition) - Method in interface de.halfbit.knot.Prime

all(watcher) - Method in class de.halfbit.knot.WatchBuilder

A function for watching State mutations as well as Change and Action emissions.

C

changes(block) - Method in class de.halfbit.knot.CompositeKnotBuilder

A section for Change related declarations.

changes(interceptor) - Method in class de.halfbit.knot.InterceptBuilder

A function for intercepting Change emissions.

changes(block) - Method in class de.halfbit.knot.KnotBuilder

A section for Change related declarations.

changes(block) - Method in class de.halfbit.knot.PrimeBuilder

A section for Change related declarations.

changes(watcher) - Method in class de.halfbit.knot.WatchBuilder

A function for watching Change emissions.

compose(composition) - Method in interface de.halfbit.knot.CompositeKnot

CompositeKnot<State,Change,Action> - Interface in de.halfbit.knot

If your interface Knot becomes big and you want to improve its maintainability and extensibility you may consider to decompose it. You start decomposition by grouping related functionality into, in a certain sense, indecomposable pieces called Primes.

compositeKnot(block) - Static method in class de.halfbit.knot.CompositeKnotBuilderKt

CompositeKnotBuilder<State,Change,Action> - Class in de.halfbit.knot

CompositeKnotBuilder.ChangesBuilder<Change> - Class in de.halfbit.knot

CompositeKnotBuilderKt - Class in de.halfbit.knot

CompositeKnotKt - Class in de.halfbit.knot

Composition<State,Change,Action> - Class in de.halfbit.knot

Composition() - Constructor for class de.halfbit.knot.Composition

D

de.halfbit.knot - package de.halfbit.knot

E

Effect<State,Action> - Class in de.halfbit.knot

Convenience wrapper around State and optional Action.

Effect(state, action) - Constructor for class de.halfbit.knot.Effect

Convenience wrapper around State and optional Action.

events(block) - Method in class de.halfbit.knot.KnotBuilder

A section for Event related declarations.

events(block) - Method in class de.halfbit.knot.PrimeBuilder

A section for Event related declarations.

EventsBuilder<Change> - Class in de.halfbit.knot

G

getAction() - Method in class de.halfbit.knot.Effect

getActionInterceptors() - Method in class de.halfbit.knot.Composition

getActionTransformers() - Method in class de.halfbit.knot.Composition

getChange() - Method in interface de.halfbit.knot.Knot

getChangeInterceptors() - Method in class de.halfbit.knot.Composition

getDisposable() - Method in interface de.halfbit.knot.Knot

getEventSources() - Method in class de.halfbit.knot.Composition

getInitial() - Method in class de.halfbit.knot.StateBuilder

Mandatory initial State of the interface Knot.

getObserveOn() - Method in class de.halfbit.knot.StateBuilder

An optional Scheduler used for dispatching state changes.

getOnly($receiver) - Method in class de.halfbit.knot.KnotBuilder.ChangesBuilder

Turns State into an class Effect without Action.

getOnly($receiver) - Method in class de.halfbit.knot.PrimeBuilder.ChangesBuilder

Turns State into an class Effect without Action.

getReduceOn() - Method in class de.halfbit.knot.CompositeKnotBuilder.ChangesBuilder

An optional Scheduler used for reduce function.

getReduceOn() - Method in class de.halfbit.knot.KnotBuilder.ChangesBuilder

An optional Scheduler used for reduce function.

getReducers() - Method in class de.halfbit.knot.Composition

getState() - Method in class de.halfbit.knot.Effect

getState() - Method in interface de.halfbit.knot.Knot

getStateInterceptors() - Method in class de.halfbit.knot.Composition

getStateTriggers() - Method in class de.halfbit.knot.Composition

I

intercept(interceptor) - Method in class de.halfbit.knot.ActionsBuilder

A function for intercepting Action emissions.

intercept(interceptor) - Method in class de.halfbit.knot.CompositeKnotBuilder.ChangesBuilder

A function for intercepting Change emissions.

intercept(interceptor) - Method in class de.halfbit.knot.KnotBuilder.ChangesBuilder

A function for intercepting Change emissions.

intercept(block) - Method in class de.halfbit.knot.KnotBuilder

A section for declaring interceptors of State, Change or Action.

intercept(interceptor) - Method in class de.halfbit.knot.PrimeBuilder.ChangesBuilder

A function for intercepting Change emissions.

intercept(block) - Method in class de.halfbit.knot.PrimeBuilder

A section for declaring interceptors of State, Change or Action.

intercept(interceptor) - Method in class de.halfbit.knot.PrimeBuilder.StateBuilder

A function for intercepting State mutations.

intercept(interceptor) - Method in class de.halfbit.knot.StateBuilder

A function for intercepting State mutations.

InterceptBuilder<State,Change,Action> - Class in de.halfbit.knot

K

Knot<State,Change> - Interface in de.halfbit.knot

Knot helps managing application state by reacting on events and performing asynchronous actions in a structured way. There are five core concepts Knot defines: State, Change, Reducer, class Effect and Action.

knot(block) - Static method in class de.halfbit.knot.KnotBuilderKt

Creates a interface Knot instance.

KnotBuilder<State,Change,Action> - Class in de.halfbit.knot

KnotBuilder.ChangesBuilder<State,Change,Action> - Class in de.halfbit.knot

KnotBuilderKt - Class in de.halfbit.knot

KnotDsl - Interface in de.halfbit.knot

KnotKt - Class in de.halfbit.knot

P

plus($receiver, action) - Method in class de.halfbit.knot.KnotBuilder.ChangesBuilder

Combines State and Action into class Effect.

plus($receiver, action) - Method in class de.halfbit.knot.PrimeBuilder.ChangesBuilder

Combines State and Action into class Effect.

Prime<State,Change,Action> - Interface in de.halfbit.knot

prime(block) - Static method in class de.halfbit.knot.PrimeBuilderKt

PrimeBuilder<State,Change,Action> - Class in de.halfbit.knot

PrimeBuilder.ChangesBuilder<State,Change,Action> - Class in de.halfbit.knot

PrimeBuilder.StateBuilder<State,Change> - Class in de.halfbit.knot

PrimeBuilderKt - Class in de.halfbit.knot

R

reduce(reducer) - Method in class de.halfbit.knot.KnotBuilder.ChangesBuilder

Mandatory reduce function which receives the current State and a Change and must return class Effect with a new State and an optional Action.

reduce(changeType, reduce) - Method in class de.halfbit.knot.PrimeBuilder.ChangesBuilder

Mandatory reduce function which receives the current State and a Change and must return class Effect with a new State and an optional Action.

S

setInitial(p) - Method in class de.halfbit.knot.StateBuilder

Mandatory initial State of the interface Knot.

setObserveOn(p) - Method in class de.halfbit.knot.StateBuilder

An optional Scheduler used for dispatching state changes.

setReduceOn(p) - Method in class de.halfbit.knot.CompositeKnotBuilder.ChangesBuilder

An optional Scheduler used for reduce function.

setReduceOn(p) - Method in class de.halfbit.knot.KnotBuilder.ChangesBuilder

An optional Scheduler used for reduce function.

source(source) - Method in class de.halfbit.knot.EventsBuilder

A function used for turning an external observable Event into a Change.

state(block) - Method in class de.halfbit.knot.CompositeKnotBuilder

A section for State related declarations.

state(interceptor) - Method in class de.halfbit.knot.InterceptBuilder

A function for intercepting State mutations.

state(block) - Method in class de.halfbit.knot.KnotBuilder

A section for State and Change related declarations.

state(block) - Method in class de.halfbit.knot.PrimeBuilder

A section for State related declarations.

state(watcher) - Method in class de.halfbit.knot.WatchBuilder

A function for watching State mutations.

StateBuilder<State> - Class in de.halfbit.knot

U

unexpected($receiver, change) - Method in class de.halfbit.knot.KnotBuilder.ChangesBuilder

Throws IllegalStateException with current State and given Change in its message.

unexpected($receiver, change) - Method in class de.halfbit.knot.PrimeBuilder.ChangesBuilder

Throws IllegalStateException with current State and given Change in its message.

W

watch(block) - Method in class de.halfbit.knot.CompositeKnotBuilder

A section for declaring watchers for State, Change or Action.

watch(block) - Method in class de.halfbit.knot.KnotBuilder

A section for declaring watchers of State, Change or Action.

watch(watcher) - Method in class de.halfbit.knot.PrimeBuilder.ChangesBuilder

A function for watching Change emissions.

watch(block) - Method in class de.halfbit.knot.PrimeBuilder

A section for declaring watchers of State, Change or Action.

watchAll(watcher) - Method in class de.halfbit.knot.ActionsBuilder

A function for watching Action emissions.

watchAll(watcher) - Method in class de.halfbit.knot.CompositeKnotBuilder.ChangesBuilder

A function for watching Change emissions.

watchAll(watcher) - Method in class de.halfbit.knot.KnotBuilder.ChangesBuilder

A function for watching Change emissions.

watchAll(watcher) - Method in class de.halfbit.knot.PrimeBuilder.StateBuilder

A function for watching mutations of any State.

watchAll(watcher) - Method in class de.halfbit.knot.StateBuilder

A function for watching mutations of any State.

WatchBuilder<State,Change,Action> - Class in de.halfbit.knot

A C D E G I K P R S U W