com.fasterxml.jackson.databind.deser.std
Class StringCollectionDeserializer

java.lang.Object
  extended by com.fasterxml.jackson.databind.JsonDeserializer<T>
      extended by com.fasterxml.jackson.databind.deser.std.StdDeserializer<T>
          extended by com.fasterxml.jackson.databind.deser.std.ContainerDeserializerBase<Collection<String>>
              extended by com.fasterxml.jackson.databind.deser.std.StringCollectionDeserializer
All Implemented Interfaces:
ContextualDeserializer

public final class StringCollectionDeserializer
extends ContainerDeserializerBase<Collection<String>>
implements ContextualDeserializer

Specifically optimized version for Collections that contain String values; reason is that this is a very common type and we can make use of the fact that Strings are final.


Nested Class Summary
 
Nested classes/interfaces inherited from class com.fasterxml.jackson.databind.JsonDeserializer
JsonDeserializer.None
 
Field Summary
protected  JavaType _collectionType
           
protected  JsonDeserializer<Object> _delegateDeserializer
          Deserializer that is used iff delegate-based creator is to be used for deserializing from JSON Object.
protected  JsonDeserializer<String> _valueDeserializer
          Value deserializer to use, if NOT the standard one (if it is, will be null).
protected  ValueInstantiator _valueInstantiator
          Instantiator used in case custom handling is needed for creation.
 
Fields inherited from class com.fasterxml.jackson.databind.deser.std.StdDeserializer
_valueClass
 
Constructor Summary
  StringCollectionDeserializer(JavaType collectionType, JsonDeserializer<?> valueDeser, ValueInstantiator valueInstantiator)
           
protected StringCollectionDeserializer(JavaType collectionType, ValueInstantiator valueInstantiator, JsonDeserializer<?> delegateDeser, JsonDeserializer<?> valueDeser)
           
 
Method Summary
 JsonDeserializer<?> createContextual(DeserializationContext ctxt, BeanProperty property)
          Method called to see if a different (or differently configured) deserializer is needed to deserialize values of specified property.
 Collection<String> deserialize(com.fasterxml.jackson.core.JsonParser jp, DeserializationContext ctxt)
          Method that can be called to ask implementation to deserialize JSON content into the value type this serializer handles.
 Collection<String> deserialize(com.fasterxml.jackson.core.JsonParser jp, DeserializationContext ctxt, Collection<String> result)
          Alternate deserialization method (compared to the most commonly used, JsonDeserializer.deserialize(JsonParser, DeserializationContext)), which takes in initialized value instance, to be configured and/or populated by deserializer.
 Object deserializeWithType(com.fasterxml.jackson.core.JsonParser jp, DeserializationContext ctxt, TypeDeserializer typeDeserializer)
          Base implementation that does not assume specific type inclusion mechanism.
 JsonDeserializer<Object> getContentDeserializer()
          Accesor for deserializer use for deserializing content values.
 JavaType getContentType()
          Accessor for declared type of contained value elements; either exact type, or one of its supertypes.
protected  StringCollectionDeserializer withResolved(JsonDeserializer<?> delegateDeser, JsonDeserializer<?> valueDeser)
           
 
Methods inherited from class com.fasterxml.jackson.databind.deser.std.StdDeserializer
_parseBoolean, _parseBooleanFromNumber, _parseBooleanPrimitive, _parseByte, _parseDate, _parseDouble, _parseDoublePrimitive, _parseFloat, _parseFloatPrimitive, _parseInteger, _parseIntPrimitive, _parseLong, _parseLongPrimitive, _parseShort, _parseShortPrimitive, findDeserializer, getValueClass, getValueType, handleUnknownProperty, isDefaultDeserializer, isDefaultKeyDeserializer, parseDouble
 
Methods inherited from class com.fasterxml.jackson.databind.JsonDeserializer
getEmptyValue, getKnownPropertyNames, getNullValue, getObjectIdReader, isCachable, unwrappingDeserializer
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

_collectionType

protected final JavaType _collectionType

_valueDeserializer

protected final JsonDeserializer<String> _valueDeserializer
Value deserializer to use, if NOT the standard one (if it is, will be null).


_valueInstantiator

protected final ValueInstantiator _valueInstantiator
Instantiator used in case custom handling is needed for creation.


_delegateDeserializer

protected final JsonDeserializer<Object> _delegateDeserializer
Deserializer that is used iff delegate-based creator is to be used for deserializing from JSON Object.

Constructor Detail

StringCollectionDeserializer

public StringCollectionDeserializer(JavaType collectionType,
                                    JsonDeserializer<?> valueDeser,
                                    ValueInstantiator valueInstantiator)

StringCollectionDeserializer

protected StringCollectionDeserializer(JavaType collectionType,
                                       ValueInstantiator valueInstantiator,
                                       JsonDeserializer<?> delegateDeser,
                                       JsonDeserializer<?> valueDeser)
Method Detail

withResolved

protected StringCollectionDeserializer withResolved(JsonDeserializer<?> delegateDeser,
                                                    JsonDeserializer<?> valueDeser)

createContextual

public JsonDeserializer<?> createContextual(DeserializationContext ctxt,
                                            BeanProperty property)
                                     throws JsonMappingException
Description copied from interface: ContextualDeserializer
Method called to see if a different (or differently configured) deserializer is needed to deserialize values of specified property. Note that instance that this method is called on is typically shared one and as a result method should NOT modify this instance but rather construct and return a new instance. This instance should only be returned as-is, in case it is already suitable for use.

Specified by:
createContextual in interface ContextualDeserializer
Parameters:
ctxt - Deserialization context to access configuration, additional deserializers that may be needed by this deserializer
property - Method, field or constructor parameter that represents the property (and is used to assign deserialized value). Should be available; but there may be cases where caller can not provide it and null is passed instead (in which case impls usually pass 'this' deserializer as is)
Returns:
Deserializer to use for deserializing values of specified property; may be this instance or a new instance.
Throws:
JsonMappingException

getContentType

public JavaType getContentType()
Description copied from class: ContainerDeserializerBase
Accessor for declared type of contained value elements; either exact type, or one of its supertypes.

Specified by:
getContentType in class ContainerDeserializerBase<Collection<String>>

getContentDeserializer

public JsonDeserializer<Object> getContentDeserializer()
Description copied from class: ContainerDeserializerBase
Accesor for deserializer use for deserializing content values.

Specified by:
getContentDeserializer in class ContainerDeserializerBase<Collection<String>>

deserialize

public Collection<String> deserialize(com.fasterxml.jackson.core.JsonParser jp,
                                      DeserializationContext ctxt)
                               throws IOException,
                                      com.fasterxml.jackson.core.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<Collection<String>>
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
com.fasterxml.jackson.core.JsonProcessingException

deserialize

public Collection<String> deserialize(com.fasterxml.jackson.core.JsonParser jp,
                                      DeserializationContext ctxt,
                                      Collection<String> result)
                               throws IOException,
                                      com.fasterxml.jackson.core.JsonProcessingException
Description copied from class: JsonDeserializer
Alternate deserialization method (compared to the most commonly used, JsonDeserializer.deserialize(JsonParser, DeserializationContext)), which takes in initialized value instance, to be configured and/or populated by deserializer. Method is not necessarily used for all supported types; most commonly it is used for Collections and Maps.

Default implementation just throws UnsupportedOperationException, to indicate that types that do not explicitly add support do not necessarily support update-existing-value operation (esp. immutable types)

Overrides:
deserialize in class JsonDeserializer<Collection<String>>
Throws:
IOException
com.fasterxml.jackson.core.JsonProcessingException

deserializeWithType

public Object deserializeWithType(com.fasterxml.jackson.core.JsonParser jp,
                                  DeserializationContext ctxt,
                                  TypeDeserializer typeDeserializer)
                           throws IOException,
                                  com.fasterxml.jackson.core.JsonProcessingException
Description copied from class: StdDeserializer
Base implementation that does not assume specific type inclusion mechanism. Sub-classes are expected to override this method if they are to handle type information.

Overrides:
deserializeWithType in class StdDeserializer<Collection<String>>
typeDeserializer - Deserializer to use for handling type information
Throws:
IOException
com.fasterxml.jackson.core.JsonProcessingException


Copyright © 2012 fasterxml.com. All Rights Reserved.