Class EnumTypeHandler

  • All Implemented Interfaces:
    TypeHandler

    public class EnumTypeHandler
    extends java.lang.Object
    implements TypeHandler
    Default Enum type handler that uses Enum.valueOf(Class, String) to parse a value and Enum.name() to format a value.
    Since:
    2.0.1
    • Field Summary

    • Constructor Summary

      Constructors 
      Constructor Description
      EnumTypeHandler​(java.lang.Class<java.lang.Enum> type)
      Constructs a new EnumTypeHandler.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String format​(java.lang.Object value)
      Formats a Java object into field text.
      java.lang.Class<?> getType()
      Returns the class type supported by this handler.
      java.lang.Object parse​(java.lang.String text)
      Parses field text into a Java object.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • EnumTypeHandler

        public EnumTypeHandler​(java.lang.Class<java.lang.Enum> type)
        Constructs a new EnumTypeHandler.
        Parameters:
        type - the Enum class
    • Method Detail

      • parse

        public java.lang.Object parse​(java.lang.String text)
                               throws TypeConversionException
        Description copied from interface: TypeHandler
        Parses field text into a Java object.
        Specified by:
        parse in interface TypeHandler
        Parameters:
        text - the field text to parse, which may be null if the field was not passed in the record
        Returns:
        the parsed Java object
        Throws:
        TypeConversionException - if the text cannot be parsed
      • format

        public java.lang.String format​(java.lang.Object value)
        Description copied from interface: TypeHandler
        Formats a Java object into field text.
        Specified by:
        format in interface TypeHandler
        Parameters:
        value - the Java object to format, which may be null
        Returns:
        the formatted field text, or null to indicate the value is not present, or TypeHandler.NIL for XML formatted streams
      • getType

        public java.lang.Class<?> getType()
        Description copied from interface: TypeHandler
        Returns the class type supported by this handler. Primitive types should not be returned by this method- use the object equivalent instead.
        Specified by:
        getType in interface TypeHandler
        Returns:
        the class type supported by this handler