ch.jalu.configme.properties.types

Class EnumPropertyType<E extends Enum<E>>

java.lang.Object

ch.jalu.configme.properties.types.EnumPropertyType<E>

All Implemented Interfaces:

PropertyType<E>

public class EnumPropertyType<E extends Enum<E>>
extends Object
implements PropertyType<E>

Constructor Summary

Constructors

Constructor and Description
EnumPropertyType(@NotNull Class<E> enumType)

Method Summary

Modifier and Type	Method and Description
E	convert(@Nullable Object object, @NotNull ConvertErrorRecorder errorRecorder) Converts the given object (typically read from a property resource) to the given type, if possible.
static <E extends Enum<E>> @NotNull EnumPropertyType<E>	of(@NotNull Class<E> type)
@NotNull Object	toExportValue(E value) Converts the given value to its export value.

Methods inherited from class java.lang.Object

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

Constructor Detail

EnumPropertyType

public EnumPropertyType(@NotNull
                        @NotNull Class<E> enumType)

Method Detail

of

@NotNull
public static <E extends Enum<E>> @NotNull EnumPropertyType<E> of(@NotNull
                                                                           @NotNull Class<E> type)

convert

@Nullable
public E convert(@Nullable
                           @Nullable Object object,
                           @NotNull
                           @NotNull ConvertErrorRecorder errorRecorder)

Description copied from interface: PropertyType

Converts the given object (typically read from a property resource) to the given type, if possible. Returns null otherwise.

Specified by:

convert in interface PropertyType<E extends Enum<E>>

Parameters:

object - the object to convert

errorRecorder - error recorder to register errors even if a valid value is returned

Returns:

the converted value, or null

toExportValue

@NotNull
public @NotNull Object toExportValue(@NotNull
                                              E value)

Description copied from interface: PropertyType

Converts the given value to its export value. (Converts in the opposite way of PropertyType.convert(java.lang.Object, ch.jalu.configme.properties.convertresult.ConvertErrorRecorder).)

Specified by:

toExportValue in interface PropertyType<E extends Enum<E>>

Parameters:

value - the value to convert

Returns:

the value to use in the property export