org.codehaus.jackson.map.deser
Class EnumDeserializer

java.lang.Object
  extended by org.codehaus.jackson.map.JsonDeserializer<T>
      extended by org.codehaus.jackson.map.deser.StdDeserializer<T>
          extended by org.codehaus.jackson.map.deser.StdScalarDeserializer<Enum<?>>
              extended by org.codehaus.jackson.map.deser.EnumDeserializer

public class EnumDeserializer
extends StdScalarDeserializer<Enum<?>>

Deserializer class that can deserialize instances of specified Enum class from Strings and Integers.


Nested Class Summary
protected static class EnumDeserializer.FactoryBasedDeserializer
          Deserializer that uses a single-String static factory method for locating Enum values by String id.
 
Nested classes/interfaces inherited from class org.codehaus.jackson.map.deser.StdDeserializer
StdDeserializer.AtomicBooleanDeserializer, StdDeserializer.AtomicReferenceDeserializer, StdDeserializer.BigDecimalDeserializer, StdDeserializer.BigIntegerDeserializer, StdDeserializer.BooleanDeserializer, StdDeserializer.ByteDeserializer, StdDeserializer.CalendarDeserializer, StdDeserializer.CharacterDeserializer, StdDeserializer.ClassDeserializer, StdDeserializer.DoubleDeserializer, StdDeserializer.FloatDeserializer, StdDeserializer.IntegerDeserializer, StdDeserializer.LongDeserializer, StdDeserializer.NumberDeserializer, StdDeserializer.PrimitiveOrWrapperDeserializer<T>, StdDeserializer.ShortDeserializer, StdDeserializer.SqlDateDeserializer, StdDeserializer.StackTraceElementDeserializer, StdDeserializer.StringDeserializer, StdDeserializer.TokenBufferDeserializer
 
Nested classes/interfaces inherited from class org.codehaus.jackson.map.JsonDeserializer
JsonDeserializer.None
 
Field Summary
 
Fields inherited from class org.codehaus.jackson.map.deser.StdDeserializer
_valueClass
 
Constructor Summary
EnumDeserializer(EnumResolver<?> res)
           
 
Method Summary
 Enum<?> deserialize(JsonParser jp, DeserializationContext ctxt)
          Method that can be called to ask implementation to deserialize json content into the value type this serializer handles.
static JsonDeserializer<?> deserializerForCreator(DeserializationConfig config, Class<?> enumClass, AnnotatedMethod factory)
          Factory method used when Enum instances are to be deserialized using a creator (static factory method)
 
Methods inherited from class org.codehaus.jackson.map.deser.StdScalarDeserializer
deserializeWithType
 
Methods inherited from class org.codehaus.jackson.map.deser.StdDeserializer
_parseBoolean, _parseBooleanPrimitive, _parseDate, _parseDouble, _parseDoublePrimitive, _parseFloat, _parseFloatPrimitive, _parseInteger, _parseIntPrimitive, _parseLong, _parseLongPrimitive, _parseShort, _parseShortPrimitive, findDeserializer, getValueClass, getValueType, handleUnknownProperty, isDefaultSerializer, parseDouble, reportUnknownProperty
 
Methods inherited from class org.codehaus.jackson.map.JsonDeserializer
deserialize, getNullValue
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

EnumDeserializer

public EnumDeserializer(EnumResolver<?> res)
Method Detail

deserializerForCreator

public static JsonDeserializer<?> deserializerForCreator(DeserializationConfig config,
                                                         Class<?> enumClass,
                                                         AnnotatedMethod factory)
Factory method used when Enum instances are to be deserialized using a creator (static factory method)

Returns:
Deserializer based on given factory method, if type was suitable; null if type can not be used
Since:
1.6

deserialize

public Enum<?> deserialize(JsonParser jp,
                           DeserializationContext ctxt)
                    throws IOException,
                           JsonProcessingException
Description copied from class: JsonDeserializer
Method that can be called to ask implementation to deserialize json content into the value type this serializer handles. Returned instance is to be constructed by method itself.

Pre-condition for this method is that the parser points to the first event that is part of value to deserializer (and which is never Json 'null' literal, more on this below): for simple types it may be the only value; and for structured types the Object start marker. Post-condition is that the parser will point to the last event that is part of deserialized value (or in case deserialization fails, event that was not recognized or usable, which may be the same event as the one it pointed to upon call).

Note that this method is never called for JSON null literal, and thus deserializers need (and should) not check for it.

Specified by:
deserialize in class JsonDeserializer<Enum<?>>
Parameters:
jp - Parsed used for reading Json content
ctxt - Context that can be used to access information about this deserialization activity.
Returns:
Deserializer value
Throws:
IOException
JsonProcessingException