com.diffplug.common.base

Interface Box<T>

All Superinterfaces:

Consumer<T>, Supplier<T>

All Known Implementing Classes:

Box.Default

public interface Box<T>
extends Supplier<T>, Consumer<T>

Provides get/set access to a mutable non-null value.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Box.Dbl A Box for primitive doubles.
static class	Box.Default<T> A simple implementation of Box.
static interface	Box.Int A Box for primitive ints.
static interface	Box.Nullable<T> Provides get/set access to a mutable nullable value.

Method Summary

Modifier and Type	Method and Description
default void	accept(T value) Delegates to set().
static <T> Box<T>	from(Supplier<T> getter, Consumer<T> setter) Creates a Box from a Supplier and a Consumer.
static <T,V> Box<T>	from(V target, Function<V,T> getter, BiConsumer<V,T> setter) Creates a Box from an argument and two functions which operate on that argument.
default <R> Box<R>	map(Function<? super T,? extends R> getMapper, Function<? super R,? extends T> setMapper) Maps one Box to another Box.
default T	modify(Function<? super T,? extends T> mutator) Shortcut for doing a set() on the result of a get().
static <T> Box<T>	of(T value) Creates a Box holding the given value.
void	set(T value) Sets the value which will later be returned by get().

Methods inherited from interface java.util.function.Supplier

get

Methods inherited from interface java.util.function.Consumer

andThen

Method Detail

set

void set(T value)

Sets the value which will later be returned by get().

accept

default void accept(T value)

Delegates to set().

Specified by:

accept in interface Consumer<T>

modify

default T modify(Function<? super T,? extends T> mutator)

Shortcut for doing a set() on the result of a get().

map

default <R> Box<R> map(Function<? super T,? extends R> getMapper,
                       Function<? super R,? extends T> setMapper)

Maps one Box to another Box.

of

static <T> Box<T> of(T value)

Creates a Box holding the given value.

from

static <T> Box<T> from(Supplier<T> getter,
                       Consumer<T> setter)

Creates a Box from a Supplier and a Consumer.

from

static <T,V> Box<T> from(V target,
                         Function<V,T> getter,
                         BiConsumer<V,T> setter)

Creates a Box from an argument and two functions which operate on that argument.