public abstract class PropertyWriter extends Object
Map
serializers, and invoked
by filtering functionality.Constructor and Description |
---|
PropertyWriter() |
Modifier and Type | Method and Description |
---|---|
abstract void |
depositSchemaProperty(JsonObjectFormatVisitor objectVisitor)
Traversal method used for things like JSON Schema generation, or
POJO introspection.
|
abstract void |
depositSchemaProperty(ObjectNode propertiesNode,
SerializerProvider provider)
Deprecated.
Since 2.2
|
<A extends Annotation> |
findAnnotation(Class<A> acls)
Convenience method for accessing annotation that may be associated
either directly on property, or, if not, via enclosing class (context).
|
abstract <A extends Annotation> |
getAnnotation(Class<A> acls)
Method for accessing annotations directly declared for property that this
writer is associated with.
|
abstract <A extends Annotation> |
getContextAnnotation(Class<A> acls)
Method for accessing annotations declared in context of the property that this
writer is associated with; usually this means annotations on enclosing class
for property.
|
abstract PropertyName |
getFullName() |
abstract String |
getName() |
abstract void |
serializeAsElement(Object value,
com.fasterxml.jackson.core.JsonGenerator jgen,
SerializerProvider provider)
Serialization method called when output is to be done as an array,
that is, not using property names.
|
abstract void |
serializeAsField(Object value,
com.fasterxml.jackson.core.JsonGenerator jgen,
SerializerProvider provider)
The main serialization method called by filter when property is to be written normally.
|
abstract void |
serializeAsOmittedField(Object value,
com.fasterxml.jackson.core.JsonGenerator jgen,
SerializerProvider provider)
Serialization method that filter needs to call in cases where property is to be
filtered, but the underlying data format requires a placeholder of some kind.
|
abstract void |
serializeAsPlaceholder(Object value,
com.fasterxml.jackson.core.JsonGenerator jgen,
SerializerProvider provider)
Serialization method called when doing tabular (positional) output from databind,
but then value is to be omitted.
|
public abstract String getName()
public abstract PropertyName getFullName()
public <A extends Annotation> A findAnnotation(Class<A> acls)
This method is functionally equivalent to:
MyAnnotation ann = propWriter.getAnnotation(MyAnnotation.class); if (ann == null) { ann = propWriter.getContextAnnotation(MyAnnotation.class); }that is, tries to find a property annotation first, but if one is not found, tries to find context-annotation (from enclosing class) of same type.
public abstract <A extends Annotation> A getAnnotation(Class<A> acls)
public abstract <A extends Annotation> A getContextAnnotation(Class<A> acls)
public abstract void serializeAsField(Object value, com.fasterxml.jackson.core.JsonGenerator jgen, SerializerProvider provider) throws Exception
Exception
public abstract void serializeAsOmittedField(Object value, com.fasterxml.jackson.core.JsonGenerator jgen, SerializerProvider provider) throws Exception
Exception
public abstract void serializeAsElement(Object value, com.fasterxml.jackson.core.JsonGenerator jgen, SerializerProvider provider) throws Exception
Collection
, array) types,
or POJOs using tabular
("as array") output format.
Note that this mode of operation is independent of underlying data format; so it is typically NOT called for fully tabular formats such as CSV, where logical output is still as form of POJOs.
Exception
public abstract void serializeAsPlaceholder(Object value, com.fasterxml.jackson.core.JsonGenerator jgen, SerializerProvider provider) throws Exception
serializeAsOmittedField(java.lang.Object, com.fasterxml.jackson.core.JsonGenerator, com.fasterxml.jackson.databind.SerializerProvider)
.Exception
public abstract void depositSchemaProperty(JsonObjectFormatVisitor objectVisitor) throws JsonMappingException
JsonMappingException
@Deprecated public abstract void depositSchemaProperty(ObjectNode propertiesNode, SerializerProvider provider) throws JsonMappingException
JsonMappingException
Copyright © 2014-2015 FasterXML. All Rights Reserved.