java.util.Map serializers, and invoked
by filtering functionality.
| Access | Constructor and Description |
|---|---|
| protected | |
| protected | |
| protected |
| Modifier and Type | Method and Description |
|---|---|
| public abstract void | depositSchemaProperty(JsonObjectFormatVisitor objectVisitor, SerializationContext provider)
Redeclares tools. Traversal method used for things like JSON Schema generation, or POJO introspection. |
| public <A extends Annotation> A | findAnnotation(Class<A> acls)
Convenience method for accessing annotation that may be associated either directly on property, or, if not, via enclosing class (context). |
| public abstract <A extends Annotation> A | getAnnotation(Class<A> acls)
Redeclares tools. Method for accessing annotations directly declared for property that this writer is associated with. |
| public abstract <A extends Annotation> A | getContextAnnotation(Class<A> acls)
Redeclares tools. 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. |
| public abstract PropertyName | |
| public abstract String | |
| public abstract void | serializeAsElement(Object value, JsonGenerator g, SerializationContext provider)
Serialization method called when output is to be done as an array, that is, not using property names. |
| public abstract void | serializeAsOmittedElement(Object value, JsonGenerator g, SerializationContext provider)
Serialization method called when doing tabular (positional) output from databind, but then value is to be omitted. |
| public abstract void | serializeAsOmittedProperty(Object value, JsonGenerator g, SerializationContext provider)
Serialization method that filter needs to call in cases where a property value (key, value) is to be filtered, but the underlying data format requires a placeholder of some kind. |
| public abstract void | serializeAsProperty(Object value, JsonGenerator g, SerializationContext provider)
The main serialization method called by filter when property is to be written as an Object property. |
| PropertyWriter | back to summary |
|---|---|
| protected PropertyWriter(PropertyMetadata md) | |
| PropertyWriter | back to summary |
|---|---|
| protected PropertyWriter(BeanPropertyDefinition propDef) | |
| PropertyWriter | back to summary |
|---|---|
| protected PropertyWriter(PropertyWriter base) | |
| depositSchemaProperty | back to summary |
|---|---|
| public abstract void depositSchemaProperty(JsonObjectFormatVisitor objectVisitor, SerializationContext provider) Redeclares tools. Traversal method used for things like JSON Schema generation, or POJO introspection.
| |
| findAnnotation | back to summary |
|---|---|
| public <A extends Annotation> A findAnnotation(Class<A> acls) Convenience method for accessing annotation that may be associated either directly on property, or, if not, via enclosing class (context). This allows adding baseline contextual annotations, for example, by adding an annotation for a given class and making that apply to all properties unless overridden by per-property annotations. 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.
| |
| getAnnotation | back to summary |
|---|---|
| public abstract <A extends Annotation> A getAnnotation(Class<A> acls) Redeclares tools. Method for accessing annotations directly declared for property that this writer is associated with.
| |
| getContextAnnotation | back to summary |
|---|---|
| public abstract <A extends Annotation> A getContextAnnotation(Class<A> acls) Redeclares tools. 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.
| |
| getFullName | back to summary |
|---|---|
| public abstract PropertyName getFullName() Redeclares tools.
| |
| getName | back to summary |
|---|---|
| public abstract String getName() Redeclares tools.
| |
| serializeAsElement | back to summary |
|---|---|
| public abstract void serializeAsElement(Object value, JsonGenerator g, SerializationContext provider) throws Exception Serialization method called when output is to be done as an array,
that is, not using property names. This is needed when serializing
container ( 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. | |
| serializeAsOmittedElement | back to summary |
|---|---|
| public abstract void serializeAsOmittedElement(Object value, JsonGenerator g, SerializationContext provider) throws Exception Serialization method called when doing tabular (positional) output from databind,
but then value is to be omitted. This requires output of a placeholder value
of some sort; often similar to | |
| serializeAsOmittedProperty | back to summary |
|---|---|
| public abstract void serializeAsOmittedProperty(Object value, JsonGenerator g, SerializationContext provider) throws Exception Serialization method that filter needs to call in cases where a property value (key, value) is to be filtered, but the underlying data format requires a placeholder of some kind. This is usually the case for tabular (positional) data formats such as CSV. | |
| serializeAsProperty | back to summary |
|---|---|
| public abstract void serializeAsProperty(Object value, JsonGenerator g, SerializationContext provider) throws Exception The main serialization method called by filter when property is to be written as an Object property. | |