io.permazen

Class EnumConverter<T extends Enum<T>>

java.lang.Object

com.google.common.base.Converter<T,EnumValue>

io.permazen.EnumConverter<T>

All Implemented Interfaces:

Function<T,EnumValue>

public class EnumConverter<T extends Enum<T>>
extends Converter<T,EnumValue>

Converts between core database EnumValue objects and the corresponding Java Enum model values.

Constructor Summary

Constructors

Constructor and Description
EnumConverter(Class<T> enumType) Constructor.

Method Summary

Modifier and Type	Method and Description
static Converter<?,?>	createEnumArrayConverter(Class<? extends Enum<?>> enumType, int dimensions) Create a Converter for arrays based on converting the base elements with an EnumConverter.
static EnumConverter<?>	createEnumConverter(Class<? extends Enum<?>> enumType) Convenience "constructor" allowing wildcard caller Enum types.
protected T	doBackward(EnumValue enumValue)
protected EnumValue	doForward(T value)
boolean	equals(Object obj)
Class<T>	getEnumType() Get the Enum type associated with this instance.
int	hashCode()
String	toString()

Methods inherited from class com.google.common.base.Converter

andThen, apply, convert, convertAll, from, identity, reverse

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.function.Function

andThen, compose

Constructor Detail

EnumConverter

public EnumConverter(Class<T> enumType)

Constructor.

Parameters:

enumType - Enum type

Throws:

IllegalArgumentException - if enumType is null

Method Detail

doForward

protected EnumValue doForward(T value)

Specified by:

doForward in class Converter<T extends Enum<T>,EnumValue>

doBackward

protected T doBackward(EnumValue enumValue)

Specified by:

doBackward in class Converter<T extends Enum<T>,EnumValue>

getEnumType

public Class<T> getEnumType()

Get the Enum type associated with this instance.

Returns:

associated Enum type

createEnumConverter

public static EnumConverter<?> createEnumConverter(Class<? extends Enum<?>> enumType)

Convenience "constructor" allowing wildcard caller Enum types.

Parameters:

enumType - type for the created converter

Returns:

new converter

createEnumArrayConverter

public static Converter<?,?> createEnumArrayConverter(Class<? extends Enum<?>> enumType,
                                                      int dimensions)

Create a Converter for arrays based on converting the base elements with an EnumConverter.

Parameters:

enumType - base enum type

dimensions - number of array dimensions

Returns:

new converter

Throws:

IllegalArgumentException - if enumType is null

IllegalArgumentException - if dimemsions is not between 1 and 255 (inclusive)

equals

public boolean equals(Object obj)

Overrides:

equals in class Converter<T extends Enum<T>,EnumValue>

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object