Module me.linusdev.data

Package de.linusdev.data.container

Class NonExistentContainer<K,V,O>

java.lang.Object

de.linusdev.data.container.NonExistentContainer<K,V,O>

All Implemented Interfaces:

Container<K,V,O>, OptionalValue<O>

public class NonExistentContainer<K,V,O>
extends Object
implements Container<K,V,O>

Constructor Summary

Constructors

Constructor	Description
NonExistentContainer(@NotNull AbstractData<K,V> parentData, K key)

Method Summary

Modifier and Type	Method	Description
@NotNull ListContainer<Object>	asList()	Casts the value to List of Objects and returns a ListContainer with this list.
<C> @NotNull Container<K,V,C>	cast()	Casts the value to Container.
<C, R> @NotNull Container<K,V,R>	castAndConvert(@NotNull Converter<C,R> converter)	Casts the value to Container and converts it with given converter.
<C, R, E extends Throwable> @NotNull Container<K,V,R>	castAndConvertWithException(@NotNull ExceptionConverter<C,R,E> converter)	Casts the value to Container and converts it with given converter.
<N> @NotNull Container<K,V,N>	createNewContainer(N newValue)	Creates a new Container with given value.
<T> @NotNull ListContainer<T>	createNewListContainer(@Nullable List<T> newValue)	Creates a new ListContainer with given value.
boolean	exists()	If a OptionalValue exists, the value returned by OptionalValue.get() can still be null.
O	get()	The actual value of class OptionalValue represented by this OptionalValue.
K	getKey()
@NotNull AbstractData<K,V>	getParentData()
@NotNull Container<K,V,O>	ifExists()	If the value does not exist, a new NonExistentContainer will be returned.
boolean	isNull()
@NotNull Container<K,V,O>	process(@NotNull Consumer<O> consumer)	This method is especially useful in combination with Container.ifExists() and Container.requireNotNull().
@NotNull Container<K,V,O>	requireNotNull()
<E extends Throwable> @NotNull Container<K,V,O>	requireNotNull(ExceptionSupplier<K,AbstractData<K,V>,E> supplier)

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.linusdev.data.OptionalValue

getAs

Constructor Details

NonExistentContainer

public NonExistentContainer(@NotNull
 @NotNull AbstractData<K,V> parentData,
 @NotNull
 K key)

Method Details

get

public O get()

Description copied from interface: OptionalValue

The actual value of class OptionalValue represented by this OptionalValue.

Specified by:

get in interface OptionalValue<K>

Returns:

OptionalValue or null

isNull

public boolean isNull()

Specified by:

isNull in interface OptionalValue<K>

Returns:

true if OptionalValue.get() will return null.

exists

public boolean exists()

Description copied from interface: OptionalValue

If a OptionalValue exists, the value returned by OptionalValue.get() can still be null.

Specified by:

exists in interface OptionalValue<K>

Returns:

true if this OptionalValue exists in the AbstractData this OptionalValue is of.

getKey

@NotNull
public K getKey()

Specified by:

getKey in interface Container<K,V,O>

Returns:

key of the original values parent data.

getParentData

@NotNull
public @NotNull AbstractData<K,V> getParentData()

Specified by:

getParentData in interface Container<K,V,O>

Returns:

parent data.

createNewContainer

@NotNull
public <N> @NotNull Container<K,V,N> createNewContainer(@Nullable
 N newValue)

Description copied from interface: Container

Creates a new Container with given value.

Specified by:

createNewContainer in interface Container<K,V,O>

Type Parameters:

N - the type of the new value

Parameters:

newValue - the new value

Returns:

a new Container

createNewListContainer

@NotNull
public <T> @NotNull ListContainer<T> createNewListContainer(@Nullable
 @Nullable List<T> newValue)

Description copied from interface: Container

Creates a new ListContainer with given value.

Specified by:

createNewListContainer in interface Container<K,V,O>

Type Parameters:

T - the list-element type

Parameters:

newValue - the list value

Returns:

a new ListContainer

requireNotNull

@NotNull
public <E extends Throwable>
@NotNull Container<K,V,O> requireNotNull(ExceptionSupplier<K,AbstractData<K,V>,E> supplier)
                                  throws E

Specified by:

requireNotNull in interface Container<K,V,O>

Type Parameters:

E - exception thrown if the value is null.

Parameters:

supplier - ExceptionSupplier to supply an exception of your choice.

Returns:

this

Throws:

E - if the value is null (OptionalValue.get() returns null).

requireNotNull

@NotNull
public @NotNull Container<K,V,O> requireNotNull()
                                         throws NullPointerException

Specified by:

requireNotNull in interface Container<K,V,O>

Returns:

this

Throws:

NullPointerException - if the value is null (OptionalValue.get() returns null).

asList

@NotNull
public @NotNull ListContainer<Object> asList()

Description copied from interface: Container

Casts the value to List of Objects and returns a ListContainer with this list.

Specified by:

asList in interface Container<K,V,O>

Returns:

ListContainer as specified above.

castAndConvert

@NotNull
public <C,
R> @NotNull Container<K,V,R> castAndConvert(@NotNull
 @NotNull Converter<C,R> converter)

Description copied from interface: Container

Casts the value to Container and converts it with given converter.

Specified by:

castAndConvert in interface Container<K,V,O>

Type Parameters:

C - type to cast to.

R - type to Converter.convert(Object) to.

Parameters:

converter - the converter to Converter.convert(Object) from Container to Container.

Returns:

a new Container with the new cast and converted value.

cast

@NotNull
public <C> @NotNull Container<K,V,C> cast()

Description copied from interface: Container

Casts the value to Container.

Specified by:

cast in interface Container<K,V,O>

Type Parameters:

C - type to cast to.

Returns:

a new Container with the new cast value.

castAndConvertWithException

@NotNull
public <C,
R,
E extends Throwable>
@NotNull Container<K,V,R> castAndConvertWithException(@NotNull
 @NotNull ExceptionConverter<C,R,E> converter)

Description copied from interface: Container

Casts the value to Container and converts it with given converter. The converter can throw an exception.

Specified by:

castAndConvertWithException in interface Container<K,V,O>

Type Parameters:

C - type to cast to.

R - type to Converter.convert(Object) to.

E - exception your converter may throw.

Parameters:

converter - the converter to ExceptionConverter.convert(Object) from Container to Container.

Returns:

a new Container with the new cast and converted value.

ifExists

@NotNull
public @NotNull Container<K,V,O> ifExists()

Description copied from interface: Container

If the value does not exist, a new NonExistentContainer will be returned. All Operations on this container will have no effect. This means:

• OptionalValue.get() will throw a NonExistentException.
• Container.process(Consumer) will not execute the given Consumer.
• Container.requireNotNull() or Container.requireNotNull(ExceptionSupplier) will never throw an exception.

If the value does exist, the Container itself (this) is returned.

This method should be mainly used in combination with the Container.process(Consumer) method and then functions similar to AbstractData.processIfContained(Object, Consumer), but can be combined with all other container methods.

Specified by:

ifExists in interface Container<K,V,O>

Returns:

Container

process

@NotNull
public @NotNull Container<K,V,O> process(@NotNull
 @NotNull Consumer<O> consumer)

Description copied from interface: Container

This method is especially useful in combination with Container.ifExists() and Container.requireNotNull().

Specified by:

process in interface Container<K,V,O>

Parameters:

consumer - Consumer to process the value.

Returns:

this