Package org.neo4j.ogm.typeconversion

Class EnumStringConverter

java.lang.Object

org.neo4j.ogm.typeconversion.EnumStringConverter

All Implemented Interfaces:

AttributeConverter<Enum,String>

public class EnumStringConverter
extends Object
implements AttributeConverter<Enum,String>

By default the OGM will map enum objects to and from the string value returned by enum.name() enum.name() is preferred to enum.ordinal() because it is (slightly) safer: a persisted enum have to be renamed to break its database mapping, whereas if its ordinal was persisted instead, the mapping would be broken simply by changing the declaration order of the enum constants.

Author:

Vince Bickers, Gerrit Meier, Róbert Papp

Constructor Summary

Constructors

Constructor	Description
EnumStringConverter(Class<? extends Enum> enumClass)
EnumStringConverter(Class<? extends Enum> enumClass, boolean lenient)

Method Summary

Modifier and Type	Method	Description
Enum	toEntityAttribute(String value)
String	toGraphProperty(Enum value)

Methods inherited from class java.lang.Object

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

Constructor Details

EnumStringConverter

public EnumStringConverter(Class<? extends Enum> enumClass)

EnumStringConverter

public EnumStringConverter(Class<? extends Enum> enumClass,
 boolean lenient)

Method Details

toGraphProperty

public String toGraphProperty(Enum value)

Specified by:

toGraphProperty in interface AttributeConverter<Enum,String>

toEntityAttribute

public Enum toEntityAttribute(String value)

Specified by:

toEntityAttribute in interface AttributeConverter<Enum,String>