net.lenni0451.commons.unchecked

Class FieldInitializer<T>

java.lang.Object

net.lenni0451.commons.unchecked.FieldInitializer<T>

Type Parameters:

T - The value type

public class FieldInitializer<T>
extends java.lang.Object

A utility to initialize fields with various strategies.

Constructor Summary

Constructors

Constructor and Description
FieldInitializer()

Method Summary

Modifier and Type	Method and Description
static <T> FieldInitializer<T>	attempt(ThrowingSupplier<T> supplier) Create a FieldInitializer that attempts to get the value from the supplier.
FieldInitializer<T>	ensure(java.util.function.Supplier<java.lang.Throwable> exceptionSupplier) Ensure that the value is not null, otherwise throw the provided exception.
static <T> FieldInitializer<T>	firstOf(ThrowingSupplier<T>... suppliers) Create a FieldInitializer that tries multiple suppliers and returns the first non-null value. If all suppliers throw an exception or return null, an IllegalStateException is thrown.
T	get() Get the value from this FieldInitializer. May return null or throw an exception.
FieldInitializer<T>	handleException(java.util.function.Function<java.lang.Throwable,java.lang.Throwable> exceptionMapper) Handle exceptions thrown by the supplier using the provided exception mapper.
<R> FieldInitializer<R>	map(ThrowingFunction<T,R> mapper) Map the value of this FieldInitializer.
static <T> FieldInitializer<T>	of(T value) Create a FieldInitializer with a constant value.
FieldInitializer<T>	onlyIf(boolean condition) Only get the value if the condition is true, otherwise return null.
FieldInitializer<T>	onlyIf(ThrowingSupplier<java.lang.Boolean> conditionSupplier) Only get the value if the condition supplier returns true, otherwise return null.
FieldInitializer<T>	or(ThrowingSupplier<T> supplier) Try to get the value from this FieldInitializer, if it is null or throws an exception, try the fallback supplier.
T	orElse(T other) Get the value from this FieldInitializer, if it is null, return the provided other value. May also throw exceptions from the supplier.
FieldInitializer<T>	peek(ThrowingConsumer<T> consumer) Peek at the value of this FieldInitializer without modifying it.
T	require(java.util.function.Supplier<java.lang.Throwable> exceptionSupplier) Get the value from this FieldInitializer, if it is null, throw the provided exception. May also throw exceptions from the supplier.
FieldInitializer<T>	silent() Silently catch any exceptions thrown by the supplier and return null instead.
<R> FieldInitializer<R>	uncheckedCast() Unchecked cast of this FieldInitializer to a different type. Beware of potential ClassCastExceptions when using this method.

Methods inherited from class java.lang.Object

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

Constructor Detail

FieldInitializer

public FieldInitializer()

Method Detail

of

public static <T> FieldInitializer<T> of(T value)

Create a FieldInitializer with a constant value.

Type Parameters:

T - The value type

Parameters:

value - The value

Returns:

The FieldInitializer

attempt

public static <T> FieldInitializer<T> attempt(ThrowingSupplier<T> supplier)

Create a FieldInitializer that attempts to get the value from the supplier.

Type Parameters:

T - The value type

Parameters:

supplier - The supplier

Returns:

The FieldInitializer

firstOf

@SafeVarargs
public static <T> FieldInitializer<T> firstOf(ThrowingSupplier<T>... suppliers)

Create a FieldInitializer that tries multiple suppliers and returns the first non-null value.
If all suppliers throw an exception or return null, an IllegalStateException is thrown.

Type Parameters:

T - The value type

Parameters:

suppliers - The suppliers to try

Returns:

The FieldInitializer

Throws:

java.lang.IllegalStateException - If all suppliers fail

map

public <R> FieldInitializer<R> map(ThrowingFunction<T,R> mapper)

Map the value of this FieldInitializer.

Type Parameters:

R - The new value type

Parameters:

mapper - The mapper function

Returns:

A new FieldInitializer with the mapped value

peek

public FieldInitializer<T> peek(ThrowingConsumer<T> consumer)

Peek at the value of this FieldInitializer without modifying it.

Parameters:

consumer - The consumer to accept the value

Returns:

A new FieldInitializer with the peeked value

or

public FieldInitializer<T> or(ThrowingSupplier<T> supplier)

Try to get the value from this FieldInitializer, if it is null or throws an exception, try the fallback supplier.

Parameters:

supplier - The fallback supplier

Returns:

A new FieldInitializer with the fallback

onlyIf

public FieldInitializer<T> onlyIf(boolean condition)

Only get the value if the condition is true, otherwise return null.

Parameters:

condition - The condition

Returns:

A new FieldInitializer with the condition

onlyIf

public FieldInitializer<T> onlyIf(ThrowingSupplier<java.lang.Boolean> conditionSupplier)

Only get the value if the condition supplier returns true, otherwise return null.

Parameters:

conditionSupplier - The condition supplier

Returns:

A new FieldInitializer with the condition

ensure

public FieldInitializer<T> ensure(java.util.function.Supplier<java.lang.Throwable> exceptionSupplier)

Ensure that the value is not null, otherwise throw the provided exception.

Parameters:

exceptionSupplier - The exception supplier

Returns:

A new FieldInitializer that ensures the value is not null

handleException

public FieldInitializer<T> handleException(java.util.function.Function<java.lang.Throwable,java.lang.Throwable> exceptionMapper)

Handle exceptions thrown by the supplier using the provided exception mapper.

Parameters:

exceptionMapper - The exception mapper

Returns:

A new FieldInitializer that handles exceptions

silent

public FieldInitializer<T> silent()

Silently catch any exceptions thrown by the supplier and return null instead.

Returns:

A new FieldInitializer that silently catches exceptions

uncheckedCast

public <R> FieldInitializer<R> uncheckedCast()

Unchecked cast of this FieldInitializer to a different type.
Beware of potential ClassCastExceptions when using this method.

Type Parameters:

R - The new value type

Returns:

A new FieldInitializer with the casted type

get

public T get()

Get the value from this FieldInitializer.
May return null or throw an exception.

Returns:

The value (may be null)

require

public T require(java.util.function.Supplier<java.lang.Throwable> exceptionSupplier)

Get the value from this FieldInitializer, if it is null, throw the provided exception.
May also throw exceptions from the supplier.

Parameters:

exceptionSupplier - The exception supplier

Returns:

The value

orElse

public T orElse(T other)

Get the value from this FieldInitializer, if it is null, return the provided other value.
May also throw exceptions from the supplier.

Parameters:

other - The other value

Returns:

The value or the other value