org.microbean.settings

Interface Converter<T>

Type Parameters:

T - the conversion type

All Superinterfaces:

Function<Value,T>, Serializable

All Known Implementing Classes:

BigDecimalConverter, BigIntegerConverter, BooleanConverter, ByteConverter, CalendarConverter, CharSequenceConverter, ClassConverter, CollectionConverter, DateConverter, DoubleConverter, DurationConverter, EntryConverter, EntryStringStringConverter, ExecutableBasedConverter, FloatConverter, InstantConverter, IntegerConverter, LevelConverter, ListBigDecimalConverter, ListBigIntegerConverter, ListBooleanConverter, ListByteConverter, ListCalendarConverter, ListCharSequenceConverter, ListClassConverter, ListConverter, ListDateConverter, ListDoubleConverter, ListDurationConverter, ListFloatConverter, ListInstantConverter, ListIntegerConverter, ListLevelConverter, ListLocalDateConverter, ListLocalDateTimeConverter, ListMonthDayConverter, ListOffsetDateTimeConverter, ListOffsetTimeConverter, ListPeriodConverter, ListShortConverter, ListStringBufferConverter, ListStringBuilderConverter, ListStringConverter, ListURIConverter, ListURLConverter, ListYearConverter, ListYearMonthConverter, ListZonedDateTimeConverter, LocalDateConverter, LocalDateTimeConverter, LocalTimeConverter, LongConverter, MapConverter, MapStringStringConverter, MonthDayConverter, ObjectConverter, OffsetDateTimeConverter, OffsetTimeConverter, OptionalConverter, OptionalStringConverter, PeriodConverter, PropertyEditorConverter, SerializableConverter, SetConverter, SetEntryStringStringConverter, ShortConverter, StringBufferConverter, StringBuilderConverter, StringConverter, URIConverter, URLConverter, YearConverter, YearMonthConverter, ZonedDateTimeConverter

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface Converter<T>
extends Function<Value,T>, Serializable

A Function that can convert a Value into some other kind of object.

Author:

Laird Nelson

See Also:

convert(Value)

Field Summary

Fields

Modifier and Type	Field and Description
static long	serialVersionUID The version of this interface for serialization purposes.

Method Summary

Modifier and Type	Method and Description
default T	apply(Value value) Calls the convert(Value) method and returns its result.
T	convert(Value value) Converts the supplied Value into the appropriate kind of object and returns the result.

Methods inherited from interface java.util.function.Function

andThen, compose, identity

Field Detail

serialVersionUID

static final long serialVersionUID

The version of this interface for serialization purposes.

See Also:

Constant Field Values

Method Detail

apply

default T apply(Value value)

Calls the convert(Value) method and returns its result.

Specified by:

apply in interface Function<Value,T>

Parameters:

value - the Value to convert; may be null

Returns:

the result of the conversion (possibly null)

Idempotency:

No guarantees with respect to idempotency are made about this method or its overrides.

Nullability:

This method and its overrides may return null.

Thread Safety:

This method is and its overrides must be safe for concurrent use by multiple threads.

convert

T convert(Value value)

Converts the supplied Value into the appropriate kind of object and returns the result.

Implementations of this method must not call the apply(Value) method.

Parameters:

value - the Value to convert; may be null

Returns:

the result of the conversion (possibly null)

Idempotency:

No guarantees with respect to idempotency are made about this method's implementations.

Nullability:

This method's implementations may return null.

Thread Safety:

This method is and its overrides must be safe for concurrent use by multiple threads.