org.codehaus.jackson.map.ser.std

类 MapSerializer

java.lang.Object

org.codehaus.jackson.map.JsonSerializer<T>

org.codehaus.jackson.map.ser.std.SerializerBase<T>

org.codehaus.jackson.map.ser.std.ContainerSerializerBase<Map<?,?>>

org.codehaus.jackson.map.ser.std.MapSerializer

所有已实现的接口:

ResolvableSerializer, SchemaAware

直接已知子类:

MapSerializer

public class MapSerializer
extends ContainerSerializerBase<Map<?,?>>
implements ResolvableSerializer

Standard serializer implementation for serializing {link java.util.Map} types.

Note: about the only configurable setting currently is ability to filter out entries with specified names.

嵌套类概要

从类继承的嵌套类/接口 org.codehaus.jackson.map.JsonSerializer

JsonSerializer.None

字段概要

字段

限定符和类型	字段和说明
protected PropertySerializerMap	_dynamicValueSerializers If value type can not be statically determined, mapping from runtime value types to serializers are stored in this object.
protected HashSet<String>	_ignoredEntries Set of entries to omit during serialization, if any
protected JsonSerializer<Object>	_keySerializer Key serializer to use, if it can be statically determined
protected JavaType	_keyType Declared type of keys
protected BeanProperty	_property Map-valued property being serialized with this instance
protected JsonSerializer<Object>	_valueSerializer Value serializer to use, if it can be statically determined
protected JavaType	_valueType Declared type of contained values
protected boolean	_valueTypeIsStatic Whether static types should be used for serialization of values or not (if not, dynamic runtime type is used)
protected TypeSerializer	_valueTypeSerializer Type identifier serializer used for values, if any.
protected static JavaType	UNSPECIFIED_TYPE

从类继承的字段 org.codehaus.jackson.map.ser.std.SerializerBase

_handledType

构造器概要

构造器

限定符	构造器和说明
protected	MapSerializer()
protected	MapSerializer(HashSet<String> ignoredEntries, JavaType keyType, JavaType valueType, boolean valueTypeIsStatic, TypeSerializer vts, JsonSerializer<Object> keySerializer, JsonSerializer<Object> valueSerializer, BeanProperty property)

方法概要

方法

限定符和类型	方法和说明
protected JsonSerializer<Object>	_findAndAddDynamic(PropertySerializerMap map, Class<?> type, SerializerProvider provider)
protected JsonSerializer<Object>	_findAndAddDynamic(PropertySerializerMap map, JavaType type, SerializerProvider provider)
ContainerSerializerBase<?>	_withValueTypeSerializer(TypeSerializer vts)
static MapSerializer	construct(String[] ignoredList, JavaType mapType, boolean staticValueType, TypeSerializer vts, BeanProperty property) 已过时。 As of 1.8; use the variant with more arguments
static MapSerializer	construct(String[] ignoredList, JavaType mapType, boolean staticValueType, TypeSerializer vts, BeanProperty property, JsonSerializer<Object> keySerializer, JsonSerializer<Object> valueSerializer)
JsonNode	getSchema(SerializerProvider provider, Type typeHint) Note: since Jackson 1.9, default implementation claims type is "string"
void	resolve(SerializerProvider provider) Need to get callback to resolve value serializer, if static typing is used (either being forced, or because value type is final)
void	serialize(Map<?,?> value, JsonGenerator jgen, SerializerProvider provider) Method that can be called to ask implementation to serialize values of type this serializer handles.
void	serializeFields(Map<?,?> value, JsonGenerator jgen, SerializerProvider provider) Method called to serialize fields, when the value type is not statically known.
protected void	serializeFieldsUsing(Map<?,?> value, JsonGenerator jgen, SerializerProvider provider, JsonSerializer<Object> ser) Method called to serialize fields, when the value type is statically known, so that value serializer is passed and does not need to be fetched from provider.
protected void	serializeTypedFields(Map<?,?> value, JsonGenerator jgen, SerializerProvider provider)
void	serializeWithType(Map<?,?> value, JsonGenerator jgen, SerializerProvider provider, TypeSerializer typeSer) Method that can be called to ask implementation to serialize values of type this serializer handles, using specified type serializer for embedding necessary type information.

从类继承的方法 org.codehaus.jackson.map.ser.std.ContainerSerializerBase

withValueTypeSerializer

从类继承的方法 org.codehaus.jackson.map.ser.std.SerializerBase

createObjectNode, createSchemaNode, createSchemaNode, handledType, isDefaultSerializer, wrapAndThrow, wrapAndThrow, wrapAndThrow, wrapAndThrow

从类继承的方法 org.codehaus.jackson.map.JsonSerializer

isUnwrappingSerializer, unwrappingSerializer

从类继承的方法 java.lang.Object

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

字段详细资料

UNSPECIFIED_TYPE

protected static final JavaType UNSPECIFIED_TYPE

_property

protected final BeanProperty _property

Map-valued property being serialized with this instance

从以下版本开始:

1.7

_ignoredEntries

protected final HashSet<String> _ignoredEntries

Set of entries to omit during serialization, if any

_valueTypeIsStatic

protected final boolean _valueTypeIsStatic

Whether static types should be used for serialization of values or not (if not, dynamic runtime type is used)

_keyType

protected final JavaType _keyType

Declared type of keys

从以下版本开始:

1.7

_valueType

protected final JavaType _valueType

Declared type of contained values

_keySerializer

protected JsonSerializer<Object> _keySerializer

Key serializer to use, if it can be statically determined

从以下版本开始:

1.7

_valueSerializer

protected JsonSerializer<Object> _valueSerializer

Value serializer to use, if it can be statically determined

从以下版本开始:

1.5

_valueTypeSerializer

protected final TypeSerializer _valueTypeSerializer

Type identifier serializer used for values, if any.

_dynamicValueSerializers

protected PropertySerializerMap _dynamicValueSerializers

If value type can not be statically determined, mapping from runtime value types to serializers are stored in this object.

从以下版本开始:

1.8

构造器详细资料

MapSerializer

protected MapSerializer()

MapSerializer

protected MapSerializer(HashSet<String> ignoredEntries,
             JavaType keyType,
             JavaType valueType,
             boolean valueTypeIsStatic,
             TypeSerializer vts,
             JsonSerializer<Object> keySerializer,
             JsonSerializer<Object> valueSerializer,
             BeanProperty property)

方法详细资料

_withValueTypeSerializer

public ContainerSerializerBase<?> _withValueTypeSerializer(TypeSerializer vts)

指定者:

_withValueTypeSerializer 在类中 ContainerSerializerBase<Map<?,?>>

construct

@Deprecated
public static MapSerializer construct(String[] ignoredList,
                                 JavaType mapType,
                                 boolean staticValueType,
                                 TypeSerializer vts,
                                 BeanProperty property)

已过时。 As of 1.8; use the variant with more arguments

Factory method used to construct Map serializers.

参数:

ignoredList - Array of entry names that are to be filtered on serialization; null if none

mapType - Declared type information (needed for static typing)

staticValueType - Whether static typing should be used for the Map (which includes its contents)

vts - Type serializer to use for map entry values, if any

construct

public static MapSerializer construct(String[] ignoredList,
                      JavaType mapType,
                      boolean staticValueType,
                      TypeSerializer vts,
                      BeanProperty property,
                      JsonSerializer<Object> keySerializer,
                      JsonSerializer<Object> valueSerializer)

serialize

public void serialize(Map<?,?> value,
             JsonGenerator jgen,
             SerializerProvider provider)
               throws IOException,
                      JsonGenerationException

从类复制的说明: JsonSerializer

Method that can be called to ask implementation to serialize values of type this serializer handles.

指定者:

serialize 在类中 SerializerBase<Map<?,?>>

参数:

value - Value to serialize; can not be null.

jgen - Generator used to output resulting Json content

provider - Provider that can be used to get serializers for serializing Objects value contains, if any.

抛出:

IOException

JsonGenerationException

serializeWithType

public void serializeWithType(Map<?,?> value,
                     JsonGenerator jgen,
                     SerializerProvider provider,
                     TypeSerializer typeSer)
                       throws IOException,
                              JsonGenerationException

从类复制的说明: JsonSerializer

Method that can be called to ask implementation to serialize values of type this serializer handles, using specified type serializer for embedding necessary type information.

Default implementation will ignore serialization of type information, and just calls JsonSerializer.serialize(T, org.codehaus.jackson.JsonGenerator, org.codehaus.jackson.map.SerializerProvider): serializers that can embed type information should override this to implement actual handling. Most common such handling is done by something like:

  // note: method to call depends on whether this type is serialized as JSON scalar, object or Array!
  typeSer.writeTypePrefixForScalar(value, jgen);
  serialize(value, jgen, provider);
  typeSer.writeTypeSuffixForScalar(value, jgen);

覆盖:

serializeWithType 在类中 JsonSerializer<Map<?,?>>

参数:

value - Value to serialize; can not be null.

jgen - Generator used to output resulting Json content

provider - Provider that can be used to get serializers for serializing Objects value contains, if any.

typeSer - Type serializer to use for including type information

抛出:

IOException

JsonGenerationException

serializeFields

public void serializeFields(Map<?,?> value,
                   JsonGenerator jgen,
                   SerializerProvider provider)
                     throws IOException,
                            JsonGenerationException

Method called to serialize fields, when the value type is not statically known.

抛出:

IOException

JsonGenerationException

serializeFieldsUsing

protected void serializeFieldsUsing(Map<?,?> value,
                        JsonGenerator jgen,
                        SerializerProvider provider,
                        JsonSerializer<Object> ser)
                             throws IOException,
                                    JsonGenerationException

Method called to serialize fields, when the value type is statically known, so that value serializer is passed and does not need to be fetched from provider.

抛出:

IOException

JsonGenerationException

serializeTypedFields

protected void serializeTypedFields(Map<?,?> value,
                        JsonGenerator jgen,
                        SerializerProvider provider)
                             throws IOException,
                                    JsonGenerationException

抛出:

IOException

JsonGenerationException

getSchema

public JsonNode getSchema(SerializerProvider provider,
                 Type typeHint)

从类复制的说明: SerializerBase

Note: since Jackson 1.9, default implementation claims type is "string"

指定者:

getSchema 在接口中 SchemaAware

覆盖:

getSchema 在类中 SerializerBase<Map<?,?>>

参数:

provider - The serializer provider.

typeHint - A hint about the type.

返回:

Json-schema for this serializer.

resolve

public void resolve(SerializerProvider provider)
             throws JsonMappingException

Need to get callback to resolve value serializer, if static typing is used (either being forced, or because value type is final)

指定者:

resolve 在接口中 ResolvableSerializer

参数:

provider - Provider that has constructed serializer this method is called on.

抛出:

JsonMappingException

_findAndAddDynamic

protected final JsonSerializer<Object> _findAndAddDynamic(PropertySerializerMap map,
                                        Class<?> type,
                                        SerializerProvider provider)
                                                   throws JsonMappingException

抛出:

JsonMappingException

_findAndAddDynamic

protected final JsonSerializer<Object> _findAndAddDynamic(PropertySerializerMap map,
                                        JavaType type,
                                        SerializerProvider provider)
                                                   throws JsonMappingException

抛出:

JsonMappingException