Package org.codehaus.jackson.map.ser.std
Class 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
- All Implemented Interfaces:
ResolvableSerializer
,SchemaAware
- Direct Known Subclasses:
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.
- Since:
- 1.9
-
Nested Class Summary
Nested classes/interfaces inherited from class org.codehaus.jackson.map.JsonSerializer
JsonSerializer.None
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected final AnyGetterWriter
Handler forJsonAnyGetter
annotated propertiesprotected final BeanPropertyWriter[]
Optional filters used to suppress output of properties that are only to be included in certain viewsprotected final Object
Id of the bean property filter to use, if any; null if none.protected final BeanPropertyWriter[]
Writers used for outputting actual property valuesprotected static final BeanPropertyWriter[]
Fields inherited from class org.codehaus.jackson.map.ser.std.SerializerBase
_handledType
-
Constructor Summary
ConstructorsModifierConstructorDescriptionBeanSerializerBase
(Class<?> rawType, BeanPropertyWriter[] properties, BeanPropertyWriter[] filteredProperties, AnyGetterWriter anyGetterWriter, Object filterId) protected
Copy-constructor that is useful for sub-classes that just want to copy all super-class properties without modifications.protected
BeanSerializerBase
(JavaType type, BeanPropertyWriter[] properties, BeanPropertyWriter[] filteredProperties, AnyGetterWriter anyGetterWriter, Object filterId) -
Method Summary
Modifier and TypeMethodDescriptionprotected BeanPropertyFilter
findFilter
(SerializerProvider provider) Helper method used to locate filter that is needed, based on filter id this serializer was constructed with.getSchema
(SerializerProvider provider, Type typeHint) Note: since Jackson 1.9, default implementation claims type is "string"void
resolve
(SerializerProvider provider) Method called afterSerializerProvider
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 aBeanPropertyFilter
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.Methods inherited from class org.codehaus.jackson.map.ser.std.SerializerBase
createObjectNode, createSchemaNode, createSchemaNode, handledType, isDefaultSerializer, wrapAndThrow, wrapAndThrow, wrapAndThrow, wrapAndThrow
Methods inherited from class org.codehaus.jackson.map.JsonSerializer
isUnwrappingSerializer, unwrappingSerializer
-
Field Details
-
NO_PROPS
-
_props
Writers used for outputting actual property values -
_filteredProps
Optional filters used to suppress output of properties that are only to be included in certain views -
_anyGetterWriter
Handler forJsonAnyGetter
annotated properties- Since:
- 1.6
-
_propertyFilterId
Id of the bean property filter to use, if any; null if none.
-
-
Constructor Details
-
BeanSerializerBase
protected BeanSerializerBase(JavaType type, BeanPropertyWriter[] properties, BeanPropertyWriter[] filteredProperties, AnyGetterWriter anyGetterWriter, Object filterId) - Parameters:
type
- Nominal type of values handled by this serializerproperties
- Property writers used for actual serialization
-
BeanSerializerBase
public BeanSerializerBase(Class<?> rawType, BeanPropertyWriter[] properties, BeanPropertyWriter[] filteredProperties, AnyGetterWriter anyGetterWriter, Object filterId) -
BeanSerializerBase
Copy-constructor that is useful for sub-classes that just want to copy all super-class properties without modifications.
-
-
Method Details
-
serialize
public abstract void serialize(Object bean, JsonGenerator jgen, SerializerProvider provider) throws IOException, JsonGenerationException Description copied from class:JsonSerializer
Method that can be called to ask implementation to serialize values of type this serializer handles.- Specified by:
serialize
in classSerializerBase<Object>
- Parameters:
bean
- Value to serialize; can not be null.jgen
- Generator used to output resulting Json contentprovider
- Provider that can be used to get serializers for serializing Objects value contains, if any.- Throws:
IOException
JsonGenerationException
-
serializeWithType
public void serializeWithType(Object bean, JsonGenerator jgen, SerializerProvider provider, TypeSerializer typeSer) throws IOException, JsonGenerationException Description copied from class: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);
- Overrides:
serializeWithType
in classJsonSerializer<Object>
- Parameters:
bean
- Value to serialize; can not be null.jgen
- Generator used to output resulting Json contentprovider
- Provider that can be used to get serializers for serializing Objects value contains, if any.typeSer
- Type serializer to use for including type information- Throws:
IOException
JsonGenerationException
-
serializeFields
protected void serializeFields(Object bean, JsonGenerator jgen, SerializerProvider provider) throws IOException, JsonGenerationException - Throws:
IOException
JsonGenerationException
-
serializeFieldsFiltered
protected void serializeFieldsFiltered(Object bean, JsonGenerator jgen, SerializerProvider provider) throws IOException, JsonGenerationException Alternative serialization method that gets called when there is aBeanPropertyFilter
that needs to be called to determine which properties are to be serialized (and possibly how)- Throws:
IOException
JsonGenerationException
- Since:
- 1.7
-
findFilter
Helper method used to locate filter that is needed, based on filter id this serializer was constructed with.- Throws:
JsonMappingException
- Since:
- 1.7
-
getSchema
Description copied from class:SerializerBase
Note: since Jackson 1.9, default implementation claims type is "string"- Specified by:
getSchema
in interfaceSchemaAware
- Overrides:
getSchema
in classSerializerBase<Object>
- Parameters:
provider
- The serializer provider.typeHint
- A hint about the type.- Returns:
- Json-schema for this serializer.
- Throws:
JsonMappingException
-
resolve
Description copied from interface:ResolvableSerializer
Method called afterSerializerProvider
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).- Specified by:
resolve
in interfaceResolvableSerializer
- Parameters:
provider
- Provider that has constructed serializer this method is called on.- Throws:
JsonMappingException
-