com.diffplug.common.base

Interface Box.Nullable<T>

All Superinterfaces:

Consumer<T>, Supplier<T>

Enclosing interface:

Box<T>

public static interface Box.Nullable<T>
extends Supplier<T>, Consumer<T>

A Box which allows nulls.

Method Summary

Modifier and Type	Method and Description
default void	accept(T value) Deprecated. Provided to satisfy the Function interface; use set(T) instead.
static <T> Box.Nullable<T>	from(Supplier<T> getter, Consumer<T> setter) Creates a Box.Nullable from a Supplier and a Consumer.
default <R> Box.Nullable<R>	map(ConverterNullable<T,R> converter) Maps one Box.Nullable to another Box.Nullable, preserving any modify(Function) concurrency guarantees of the underlying Box.
default T	modify(Function<? super T,? extends T> mutator) Shortcut for doing a set() on the result of a get().
static <T> Box.Nullable<T>	of(T init) Creates a Box.Nullable holding the given possibly-null value in a non-volatile field.
static <T> Box.Nullable<T>	ofNull() Creates a Box.Nullable holding null value in a non-volatile field.
static <T> Box.Nullable<T>	ofVolatile(T init) Creates a Box holding the given value in a volatile field.
static <T> Box.Nullable<T>	ofVolatileNull() Creates a Box.Nullable holding the null value in a volatile field.
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(@Nullable
         T value)

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

accept

@Deprecated
default void accept(@Nullable
                                T value)

Deprecated. Provided to satisfy the Function interface; use set(T) instead.

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.Nullable<R> map(ConverterNullable<T,R> converter)

Maps one Box.Nullable to another Box.Nullable, preserving any modify(Function) concurrency guarantees of the underlying Box.

ofVolatile

static <T> Box.Nullable<T> ofVolatile(@Nullable
                                      T init)

Creates a Box holding the given value in a volatile field.

modify() is just a shortcut for set(function.apply(get())), use AtomicReference if you require atomic semantics.

ofVolatileNull

static <T> Box.Nullable<T> ofVolatileNull()

Creates a Box.Nullable holding the null value in a volatile field.

of

static <T> Box.Nullable<T> of(@Nullable
                              T init)

Creates a Box.Nullable holding the given possibly-null value in a non-volatile field.

ofNull

static <T> Box.Nullable<T> ofNull()

Creates a Box.Nullable holding null value in a non-volatile field.

from

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

Creates a Box.Nullable from a Supplier and a Consumer.