org.codehaus.jackson.map.ser.std

类 BeanSerializerBase

java.lang.Object

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

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

org.codehaus.jackson.map.ser.std.BeanSerializerBase

所有已实现的接口:

ResolvableSerializer, SchemaAware

直接已知子类:

BeanSerializer, UnwrappingBeanSerializer

public abstract class BeanSerializerBase
extends SerializerBase<Object>
implements ResolvableSerializer, SchemaAware

Base class both for the standard bean serializer, and couple of variants that only differ in small details. Can be used for custom bean serializers as well, although that is not the primary design goal.

从以下版本开始:

1.9

嵌套类概要

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

JsonSerializer.None

字段概要

字段

限定符和类型	字段和说明
protected AnyGetterWriter	_anyGetterWriter Handler for JsonAnyGetter annotated properties
protected BeanPropertyWriter[]	_filteredProps Optional filters used to suppress output of properties that are only to be included in certain views
protected Object	_propertyFilterId Id of the bean property filter to use, if any; null if none.
protected BeanPropertyWriter[]	_props Writers used for outputting actual property values
protected static BeanPropertyWriter[]	NO_PROPS

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

_handledType

构造器概要

构造器

限定符	构造器和说明
protected	BeanSerializerBase(BeanSerializerBase src) Copy-constructor that is useful for sub-classes that just want to copy all super-class properties without modifications.
	BeanSerializerBase(Class<?> rawType, BeanPropertyWriter[] properties, BeanPropertyWriter[] filteredProperties, AnyGetterWriter anyGetterWriter, Object filterId)
protected	BeanSerializerBase(JavaType type, BeanPropertyWriter[] properties, BeanPropertyWriter[] filteredProperties, AnyGetterWriter anyGetterWriter, Object filterId)

方法概要

方法

限定符和类型	方法和说明
protected BeanPropertyFilter	findFilter(SerializerProvider provider) Helper method used to locate filter that is needed, based on filter id this serializer was constructed with.
JsonNode	getSchema(SerializerProvider provider, Type typeHint) Note: since Jackson 1.9, default implementation claims type is "string"
void	resolve(SerializerProvider provider) Method called after SerializerProvider has registered the serializer, but before it has returned it to the caller.
abstract void	serialize(Object bean, JsonGenerator jgen, SerializerProvider provider) Method that can be called to ask implementation to serialize values of type this serializer handles.
protected void	serializeFields(Object bean, JsonGenerator jgen, SerializerProvider provider)
protected void	serializeFieldsFiltered(Object bean, JsonGenerator jgen, SerializerProvider provider) Alternative serialization method that gets called when there is a BeanPropertyFilter that needs to be called to determine which properties are to be serialized (and possibly how)
void	serializeWithType(Object bean, 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.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

字段详细资料

NO_PROPS

protected static final BeanPropertyWriter[] NO_PROPS

_props

protected final BeanPropertyWriter[] _props

Writers used for outputting actual property values

_filteredProps

protected final BeanPropertyWriter[] _filteredProps

Optional filters used to suppress output of properties that are only to be included in certain views

_anyGetterWriter

protected final AnyGetterWriter _anyGetterWriter

Handler for JsonAnyGetter annotated properties

从以下版本开始:

1.6

_propertyFilterId

protected final Object _propertyFilterId

Id of the bean property filter to use, if any; null if none.

构造器详细资料

BeanSerializerBase

protected BeanSerializerBase(JavaType type,
                  BeanPropertyWriter[] properties,
                  BeanPropertyWriter[] filteredProperties,
                  AnyGetterWriter anyGetterWriter,
                  Object filterId)

参数:

type - Nominal type of values handled by this serializer

properties - Property writers used for actual serialization

BeanSerializerBase

public BeanSerializerBase(Class<?> rawType,
                  BeanPropertyWriter[] properties,
                  BeanPropertyWriter[] filteredProperties,
                  AnyGetterWriter anyGetterWriter,
                  Object filterId)

BeanSerializerBase

protected BeanSerializerBase(BeanSerializerBase src)

Copy-constructor that is useful for sub-classes that just want to copy all super-class properties without modifications.

方法详细资料

serialize

public abstract void serialize(Object bean,
             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<Object>

参数:

bean - 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(Object bean,
                     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<Object>

参数:

bean - 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

protected void serializeFields(Object bean,
                   JsonGenerator jgen,
                   SerializerProvider provider)
                        throws IOException,
                               JsonGenerationException

抛出:

IOException

JsonGenerationException

serializeFieldsFiltered

protected void serializeFieldsFiltered(Object bean,
                           JsonGenerator jgen,
                           SerializerProvider provider)
                                throws IOException,
                                       JsonGenerationException

Alternative serialization method that gets called when there is a BeanPropertyFilter that needs to be called to determine which properties are to be serialized (and possibly how)

抛出:

IOException

JsonGenerationException

从以下版本开始:

1.7

findFilter

protected BeanPropertyFilter findFilter(SerializerProvider provider)
                                 throws JsonMappingException

Helper method used to locate filter that is needed, based on filter id this serializer was constructed with.

抛出:

JsonMappingException

从以下版本开始:

1.7

getSchema

public JsonNode getSchema(SerializerProvider provider,
                 Type typeHint)
                   throws JsonMappingException

从类复制的说明: SerializerBase

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

指定者:

getSchema 在接口中 SchemaAware

覆盖:

getSchema 在类中 SerializerBase<Object>

参数:

provider - The serializer provider.

typeHint - A hint about the type.

返回:

Json-schema for this serializer.

抛出:

JsonMappingException

resolve

public void resolve(SerializerProvider provider)
             throws JsonMappingException

从接口复制的说明: ResolvableSerializer

Method called after SerializerProvider has registered the serializer, but before it has returned it to the caller. Called object can then resolve its dependencies to other types, including self-references (direct or indirect).

指定者:

resolve 在接口中 ResolvableSerializer

参数:

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

抛出:

JsonMappingException