Interface LogProperty.ValidatedResult<T>

Type Parameters:

T - property type.

All Superinterfaces:

LogProperty.Result<T>

All Known Subinterfaces:

LogProperty.RequiredResult<T>, LogProperty.Result.Success<T>

All Known Implementing Classes:

LogProperty.Result.Error, LogProperty.Result.Missing

Enclosing interface:

LogProperty

public static sealed interface LogProperty.ValidatedResult<T>
extends LogProperty.Result<T>
permits LogProperty.Result.Missing<T>, LogProperty.Result.Error<T>, LogProperty.RequiredResult<T>

A LogProperty.Result that is safe to pull a value out of - either because it can never actually be missing (LogProperty.RequiredResult: a LogProperty.Result.Success or an LogProperty.Result.Error, both already resolved one way or the other) or because a caller has explicitly acknowledged the possibility of a still-LogProperty.Result.Missing result by running it through LogProperty.Result.validate(Validator), LogProperty.Result.validateIfError(Validator), or LogProperty.Result.validateNow(Class).

LogProperty.Result itself deliberately does not declare value()/ valueOrNull()/optional() - a bare LogProperty.Result returned by LogProperty.ofString() and friends forces a caller through one of those validation paths before it can pull a value out, instead of blindly calling value() on a result that might still be LogProperty.Result.Missing.

Nested Class Summary

Nested classes/interfaces inherited from interface LogProperty.Result

LogProperty.Result.Error<T>, LogProperty.Result.Missing<T>, LogProperty.Result.Success<T>

Modifier and Type	Interface	Description
static final record	LogProperty.Result.Error<T>	A property that was present but failed conversion.
static final record	LogProperty.Result.Missing<T>	A property that is missing (null).
static interface	LogProperty.Result.Success<T>	A property that is present.

Method Summary

Modifier and Type	Method	Description
default Optional<T>	optional()	Convenience that turns a value into an optional.
T	value()	Gets the value and will fail with NoSuchElementException if there is no value.
@Nullable T	valueOrNull()	Gets the value.
default @Nullable T	valueOrNull(@Nullable T fallback)	Gets a value if there is if not uses the fallback.

Methods inherited from interface LogProperty.Result

describe, map, or, or, validate, validateIfError, validateNow

Modifier and Type	Method	Description
String	describe()	A description of the result for error messages.
<U> LogProperty.Result<U>	map(LogProperty.PropertyFunction<T, U, ? super Exception> mapper)	Maps this result's value through mapper.
LogProperty.Result<T>	or(T fallback)	Returns the current result if fallback is null or returns fallback as a result if this result is missing.
LogProperty.Result<T>	or(Supplier<T> fallback)	Returns the current result if success or error otherwise fallback supplier is used.
default LogProperty.ValidatedResult<T>	validate(LogProperty.Validator validator)	Registers this result with validator via LogProperty.Validator.add(Result) (a still-LogProperty.Result.Missing result is treated as a real failure) and returns this result unchanged, so a chain that builds a required property can register itself with a shared LogProperty.Validator and keep going in one expression - properties.forKey(key).ofString().or(fallback).validate(v) - instead of a separate var x = ...; v.add(x); statement pair.
default LogProperty.ValidatedResult<T>	validateIfError(LogProperty.Validator validator)	Like LogProperty.Result.validate(Validator) but via LogProperty.Validator.addIfError(Result) instead of LogProperty.Validator.add(Result) - a LogProperty.Result.Missing result is expected and ignored, only a LogProperty.Result.Error is treated as a failure.
default T	validateNow(Class<?> component)	Convenience for a genuine one-off, single-property validation that does not need to participate in a larger batch: builds a single-use LogProperty.Validator, registers this result with it via LogProperty.Validator.add(Result), and validates immediately - instead of registering with a caller-managed LogProperty.Validator via LogProperty.Result.validate(Validator) and deferring to a later LogProperty.Validator.validate() call.

Method Details

value

T value()
 throws LogProperty.PropertyMissingException,
LogProperty.PropertyConvertException

Gets the value and will fail with NoSuchElementException if there is no value.

Returns:

value.

Throws:

LogProperty.PropertyMissingException - if there is no value.

LogProperty.PropertyConvertException - if the property failed conversion.

valueOrNull

@Nullable T valueOrNull()

Gets the value.

Returns:

value or null.

valueOrNull

default @Nullable T valueOrNull(@Nullable T fallback)

Gets a value if there is if not uses the fallback.

Parameters:

fallback - maybe null.

Returns:

value.

optional

default Optional<T> optional()

Convenience that turns a value into an optional.

Returns:

optional.