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

A

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

A section for Action related declarations.

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.

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

A configuration builder for Action related declarations.

C

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

A section for Change related declarations.

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.

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

A function used for turning an external observable Event into a Change. In contrast to source function, coldSource function gets

component1() - Method in class de.halfbit.knot.Effect.WithAction

component1() - Method in class de.halfbit.knot.Effect.WithActions

component2() - Method in class de.halfbit.knot.Effect.WithAction

component2() - Method in class de.halfbit.knot.Effect.WithActions

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

Finishes composition of Primes and moves this knot into operational mode.

CompositeKnot<State> - Interface in de.halfbit.knot

If your interface Knot becomes big and you want to improve its readability and maintainability, 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

Creates a interface CompositeKnot.

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

A configuration builder for a interface CompositeKnot.

CompositeKnotBuilder.ActionsBuilder - Class in de.halfbit.knot

A configuration builder for Action related declarations.

CompositeKnotBuilder.ChangesBuilder - Class in de.halfbit.knot

A configuration builder for Changes.

CompositeKnotBuilderKt - Class in de.halfbit.knot

copy(state, action) - Method in class de.halfbit.knot.Effect.WithAction

copy(state, actions) - Method in class de.halfbit.knot.Effect.WithActions

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.WithAction<State,Action> - Class in de.halfbit.knot

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

equals(p) - Method in class de.halfbit.knot.Effect.WithAction

equals(p) - Method in class de.halfbit.knot.Effect.WithActions

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

A configuration builder for Events related declarations.

G

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

getAction() - Method in interface de.halfbit.knot.TestCompositeKnot

Actions observer to be used in tests.

getActionConsumer() - Method in interface de.halfbit.knot.TestCompositeKnot

Actions consumer to be used in tests.

getActions() - Method in class de.halfbit.knot.Effect.WithActions

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

Change emitter used for delivering changes to this knot.

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 observing State updates.

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.

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

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

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

Observable state.

getWatchOn() - Method in class de.halfbit.knot.ActionsBuilder

An optional Scheduler used for watching Actions.

getWatchOn() - Method in class de.halfbit.knot.CompositeKnotBuilder.ActionsBuilder

An optional Scheduler used for watching Actions.

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

An optional Scheduler used for watching Changes.

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

An optional Scheduler used for watching Changes.

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

An optional Scheduler used for watching Changes.

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

An optional Scheduler used for watching State updates.

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

An optional Scheduler used for watching State updates.

H

hashCode() - Method in class de.halfbit.knot.Effect.WithAction

hashCode() - Method in class de.halfbit.knot.Effect.WithActions

I

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

A function for intercepting Action emissions.

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

A function for intercepting Change emissions.

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.

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

A configuration builder for a interface 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(action) - Method in class de.halfbit.knot.Effect

Adds another action to class Effect.

plus(action) - Method in class de.halfbit.knot.Effect.WithAction

Adds another action to class Effect.

plus(action) - Method in class de.halfbit.knot.Effect.WithActions

Adds another action to class Effect.

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.

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

A configuration builder for a Prime.

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

A configuration builder for Change related declarations.

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

A configuration builder for State related declarations.

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.

registerPrime(block) - Method in interface de.halfbit.knot.CompositeKnot

Registers a new Prime at this composite knot.

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 observing State updates.

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.

setWatchOn(value) - Method in class de.halfbit.knot.ActionsBuilder

An optional Scheduler used for watching Actions.

setWatchOn(value) - Method in class de.halfbit.knot.CompositeKnotBuilder.ActionsBuilder

An optional Scheduler used for watching Actions.

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

An optional Scheduler used for watching Changes.

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

An optional Scheduler used for watching Changes.

setWatchOn(value) - Method in class de.halfbit.knot.PrimeBuilder.ChangesBuilder

An optional Scheduler used for watching Changes.

setWatchOn(value) - Method in class de.halfbit.knot.PrimeBuilder.StateBuilder

An optional Scheduler used for watching State updates.

setWatchOn(value) - Method in class de.halfbit.knot.StateBuilder

An optional Scheduler used for watching State updates.

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(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.

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

A configuration builder for State related declarations.

Store<State> - Interface in de.halfbit.knot

Store is a disposable container for a State.

T

TestCompositeKnot<State> - Interface in de.halfbit.knot

TestCompositeKnot is used for testing knot primes in isolation. Create test composition knot, add a knot Prime to it you want to test and start testing it. In addition to standard CompositeKnot functionality TestCompositeKnot lets you observe and emit actions.

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

Creates a interface TestCompositeKnot. This function should only be used in tests. For creating a productive composite knot use CompositeKnotBuilderKt.compositeKnot function.

TestCompositeKnotKt - Class in de.halfbit.knot

toString() - Method in class de.halfbit.knot.Effect.WithAction

toString() - Method in class de.halfbit.knot.Effect.WithActions

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

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

A function for watching Action emissions.

watchAll(watcher) - Method in class de.halfbit.knot.CompositeKnotBuilder.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.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.

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

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

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