com.diffplug.common.rx

Class Breaker<T>

java.lang.Object

com.diffplug.common.rx.Breaker<T>

All Implemented Interfaces:

Box<T>, IObservable<T>, RxBox<T>, RxGetter<T>, ObservableSource<T>, Consumer<T>, Supplier<T>

public class Breaker<T>
extends Object

A mechanism for "turning off" an existing `RxBox`, much like a a circuit breaker. Useful for cases where some RxBox.enforce(java.util.function.Function) calls are causing a problem during a major change, and you'd like to be able to open the circuit, fix things up, then close it again to resume operation. A `Breaker` is an `RxBox` which wraps another `RxBox`. So long as the breaker is closed, calling `set` on either the `Breaker` or the wrapped box will set both of them. Once you call `setClosed(false)`, the two boxes are separate. You can still modify the `Breaker` and its wrapped box, but they will not affect each other. When you call `setClosed(true)`, the wrapped box will be set to the value of the `Breaker`, and all future changes will again be synchronized.

Nested Class Summary

Nested classes/interfaces inherited from interface com.diffplug.common.base.Box

Box.Dbl, Box.Int, Box.Lng, Box.Nullable<T>

Field Summary

Fields

Modifier and Type	Field and Description
protected RxBox<T>	delegate

Method Summary

Modifier and Type	Method and Description
Observable<T>	asObservable()
static <T> Breaker<T>	createClosed(RxBox<T> box) Creates a `Breaker` which is initially closed.
static <T> Breaker<T>	createOpen(RxBox<T> box) Creates a `Breaker` which is initially open.
T	get() Returns the value.
void	set(T newValue) Sets the value.
void	setClosed(boolean closed) Sets that this breaker is closed or open.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.diffplug.common.rx.RxBox

enforce, from, map, of, readOnly

Methods inherited from interface com.diffplug.common.rx.RxGetter

combineLatest, from, fromVolatile, map

Methods inherited from interface com.diffplug.common.rx.IObservable

subscribe, wrap

Methods inherited from interface com.diffplug.common.base.Box

accept, from, modify, ofVolatile

Methods inherited from interface java.util.function.Consumer

andThen

Field Detail

delegate

protected final RxBox<T> delegate

Method Detail

setClosed

public void setClosed(boolean closed)

Sets that this breaker is closed or open. - If the breaker is already in the given state, nothing happens. - If the breaker changes to closed, the wrapped box is to the value of `Breaker`, and future changes to either are synchronized. - If the breaker changes to open, all future changes to either box are not synchronized.

set

public void set(T newValue)

Sets the value.

Specified by:

set in interface Box<T>

get

public T get()

Returns the value.

Specified by:

get in interface Supplier<T>

createClosed

public static <T> Breaker<T> createClosed(RxBox<T> box)

Creates a `Breaker` which is initially closed.

createOpen

public static <T> Breaker<T> createOpen(RxBox<T> box)

Creates a `Breaker` which is initially open.

asObservable

public Observable<T> asObservable()

Specified by:

asObservable in interface IObservable<T>