Module me.linusdev.data

Package de.linusdev.data.container

Interface ListContainer<T>

Type Parameters:

T -

All Superinterfaces:

OptionalValue<List<T>>

All Known Implementing Classes:

ListContainerImpl, NonExistentListContainer

public interface ListContainer<T>
extends OptionalValue<List<T>>

This class holds a List value from an AbstractData. It offers several methods to process the elements of this list and functions similar to it's single value counterpart: Container.

Method Summary

Modifier and Type	Method	Description
default <C> @NotNull ListContainer<C>	cast()	Casts each element of the list to ListContainer.
default <C, R> @NotNull ListContainer<R>	castAndConvert(@NotNull Converter<C,R> converter)	Casts each element of the list to ListContainer and then converts it with given converter.
default <C, R, E extends Throwable> @NotNull ListContainer<R>	castAndConvertWithException(@NotNull ExceptionConverter<C,R,E> converter)	Casts each element of the list to ListContainer and then converts it with given converter.
<N> @NotNull ListContainer<N>	createNew(@Nullable List<N> newValue)	Creates a new container with given value.
default @NotNull ListContainer<T>	process(@NotNull Consumer<List<T>> consumer)	Process this container's list with given Consumer.

Methods inherited from interface de.linusdev.data.OptionalValue

exists, get, getAs, isNull

Method Details

createNew

@Internal
@NotNull
<N> @NotNull ListContainer<N> createNew(@Nullable
 @Nullable List<N> newValue)

Creates a new container with given value.

Type Parameters:

N - the new value type.

Parameters:

newValue - the value for the new container

Returns:

a new ListContainer.

cast

@NotNull
default <C> @NotNull ListContainer<C> cast()

Casts each element of the list to ListContainer.

Type Parameters:

C - the type to cast to.

Returns:

a new ListContainer containing the List of ListContainer.

Throws:

ClassCastException - if any element inside this container's list cannot be cast to ListContainer.

castAndConvert

@NotNull
default <C,
R> @NotNull ListContainer<R> castAndConvert(@NotNull
 @NotNull Converter<C,R> converter)

Casts each element of the list to ListContainer and then converts it with given converter.

Type Parameters:

C - type to cast to.

R - type to convert to.

Parameters:

converter - Container to convert from ListContainer to ListContainer.

Returns:

a new ListContainer containing the List of ListContainer.

Throws:

ClassCastException - if any element inside this container's list cannot be cast to ListContainer,

castAndConvertWithException

@NotNull
default <C,
R,
E extends Throwable>
@NotNull ListContainer<R> castAndConvertWithException(@NotNull
 @NotNull ExceptionConverter<C,R,E> converter)
                                               throws E

Casts each element of the list to ListContainer and then converts it with given converter.

Type Parameters:

C - type to cast to.

R - type to convert to.

E - exception type of your ExceptionConverter.

Parameters:

converter - Container to convert from ListContainer to ListContainer.

Returns:

a new ListContainer containing the List of ListContainer.

Throws:

ClassCastException - if any element inside this container's list cannot be cast to ListContainer.

E - if your converter throws this exception.

process

@NotNull
default @NotNull ListContainer<T> process(@NotNull
 @NotNull Consumer<List<T>> consumer)

Process this container's list with given Consumer.

Parameters:

consumer - to consume this list.

Returns:

this