Module io.jstach.rainbowgum

Package io.jstach.rainbowgum

Record Class LogProperty.Result.Success.PropertySuccess<T>

java.lang.Object

java.lang.Record

io.jstach.rainbowgum.LogProperty.Result.Success.PropertySuccess<T>

Type Parameters:

T - property type.

Record Components:

property - found property.

value - actual value.

All Implemented Interfaces:

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

Enclosing interface:

LogProperty.Result.Success<T>

public static record LogProperty.Result.Success.PropertySuccess<T>(LogProperties.FoundProperty property, T value)
extends Record
implements LogProperty.Result.Success<T>

A property that is present.

Nested Class Summary

Nested classes/interfaces inherited from interface io.jstach.rainbowgum.LogProperty.Result

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

Nested classes/interfaces inherited from interface io.jstach.rainbowgum.LogProperty.Result.Success

LogProperty.Result.Success.PropertySuccess<T>, LogProperty.Result.Success.ValueSuccess<T>

Constructor Summary

Constructors

Constructor	Description
PropertySuccess(LogProperties.FoundProperty property, T value)	Successfully found property value.

Method Summary

Modifier and Type	Method	Description
String	describe()	A description of the result for error messages.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
String	key()	Original property key where the value was derived from or was passed a fallback.
<U> LogProperty.Result<U>	map(LogProperty.PropertyFunction<T,U,? super Exception> mapper)	Map a result
LogProperties.FoundProperty	property()	Returns the value of the property record component.
final String	toString()	Returns a string representation of this record class.
T	value()	Returns the value of the value record component.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.jstach.rainbowgum.LogProperty.PropertyValue

override

Methods inherited from interface io.jstach.rainbowgum.LogProperty.Result

get, optional, value, valueOrNull

Methods inherited from interface io.jstach.rainbowgum.LogProperty.Result.Success

or, or, value, valueOrNull

Constructor Details

PropertySuccess

public PropertySuccess(LogProperties.FoundProperty property,
 T value)

Successfully found property value.

Parameters:

property - found property.

value - actual value should not be null.

Method Details

key

public String key()

Description copied from interface: LogProperty.Result.Success

Original property key where the value was derived from or was passed a fallback.

Specified by:

key in interface LogProperty.Result.Success<T>

Returns:

key.

map

public <U> LogProperty.Result<U> map(LogProperty.PropertyFunction<T,U,? super Exception> mapper)

Description copied from interface: LogProperty.Result

Map a result

Specified by:

map in interface LogProperty.PropertyValue<T>

Specified by:

map in interface LogProperty.Result<T>

Type Parameters:

U - result type

Parameters:

mapper - mapping function.

Returns:

mapped result.

describe

public String describe()

Description copied from interface: LogProperty.Result

A description of the result for error messages.

Specified by:

describe in interface LogProperty.Result<T>

Returns:

description.

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

property

public LogProperties.FoundProperty property()

Returns the value of the property record component.

Returns:

the value of the property record component

value

public T value()

Returns the value of the value record component.

Specified by:

value in interface LogProperty.PropertyValue<T>

Specified by:

value in interface LogProperty.Result<T>

Specified by:

value in interface LogProperty.Result.Success<T>

Returns:

the value of the value record component