|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.codehaus.jackson.map.ObjectWriter
public class ObjectWriter
Builder object that can be used for per-serialization configuration of
serialization parameters, such as JSON View and root type to use.
(and thus fully thread-safe with no external synchronization);
new instances are constructed for different configurations.
Instances are initially constructed by ObjectMapper
and can be
reused in completely thread-safe manner with no explicit synchronization
Field Summary | |
---|---|
protected SerializationConfig |
_config
General serialization configuration settings |
protected JsonFactory |
_jsonFactory
Factory used for constructing JsonGenerator s |
protected PrettyPrinter |
_prettyPrinter
To allow for dynamic enabling/disabling of pretty printing, pretty printer can be optionally configured for writer as well |
protected SerializerProvider |
_provider
|
protected JavaType |
_rootType
Specified root serialization type to use; can be same as runtime type, but usually one of its super types |
protected FormatSchema |
_schema
When using data format that uses a schema, schema is passed to generator. |
protected SerializerFactory |
_serializerFactory
|
protected static PrettyPrinter |
NULL_PRETTY_PRINTER
We need to keep track of explicit disabling of pretty printing; easiest to do by a token value. |
Constructor Summary | |
---|---|
protected |
ObjectWriter(ObjectMapper mapper,
SerializationConfig config)
Alternative constructor for initial instantiation. |
protected |
ObjectWriter(ObjectMapper mapper,
SerializationConfig config,
FormatSchema s)
Alternative constructor for initial instantiation. |
protected |
ObjectWriter(ObjectMapper mapper,
SerializationConfig config,
JavaType rootType,
PrettyPrinter pp)
Constructor used by ObjectMapper for initial instantiation |
protected |
ObjectWriter(ObjectWriter base,
SerializationConfig config)
Copy constructor used for building variations. |
protected |
ObjectWriter(ObjectWriter base,
SerializationConfig config,
JavaType rootType,
PrettyPrinter pp,
FormatSchema s)
Copy constructor used for building variations. |
Method Summary | |
---|---|
protected void |
_configAndWriteValue(JsonGenerator jgen,
Object value)
Method called to configure the generator as necessary and then call write functionality |
boolean |
canSerialize(Class<?> type)
|
Version |
version()
Method that will return version information stored in and read from jar that contains this class. |
ObjectWriter |
withDefaultPrettyPrinter()
Method that will construct a new instance that will use the default pretty printer for serialization. |
ObjectWriter |
withFilters(FilterProvider filterProvider)
Method that will construct a new instance that uses specified provider for resolving filter instances by id. |
ObjectWriter |
withPrettyPrinter(PrettyPrinter pp)
Method that will construct a new instance that will use specified pretty printer (or, if null, will not do any pretty-printing) |
ObjectWriter |
withSchema(FormatSchema schema)
|
ObjectWriter |
withType(Class<?> rootType)
Method that will construct a new instance that uses specific type as the root type for serialization, instead of runtime dynamic type of the root object itself. |
ObjectWriter |
withType(JavaType rootType)
Method that will construct a new instance that uses specific type as the root type for serialization, instead of runtime dynamic type of the root object itself. |
ObjectWriter |
withType(TypeReference<?> rootType)
|
ObjectWriter |
withView(Class<?> view)
Method that will construct a new instance that uses specified serialization view for serialization (with null basically disables view processing) |
void |
writeValue(File resultFile,
Object value)
Method that can be used to serialize any Java value as JSON output, written to File provided. |
void |
writeValue(JsonGenerator jgen,
Object value)
Method that can be used to serialize any Java value as JSON output, using provided JsonGenerator . |
void |
writeValue(OutputStream out,
Object value)
Method that can be used to serialize any Java value as JSON output, using output stream provided (using encoding JsonEncoding.UTF8 ). |
void |
writeValue(Writer w,
Object value)
Method that can be used to serialize any Java value as JSON output, using Writer provided. |
byte[] |
writeValueAsBytes(Object value)
Method that can be used to serialize any Java value as a byte array. |
String |
writeValueAsString(Object value)
Method that can be used to serialize any Java value as a String. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected static final PrettyPrinter NULL_PRETTY_PRINTER
protected final SerializationConfig _config
protected final SerializerProvider _provider
protected final SerializerFactory _serializerFactory
protected final JsonFactory _jsonFactory
JsonGenerator
s
protected final JavaType _rootType
protected final PrettyPrinter _prettyPrinter
protected final FormatSchema _schema
Constructor Detail |
---|
protected ObjectWriter(ObjectMapper mapper, SerializationConfig config, JavaType rootType, PrettyPrinter pp)
ObjectMapper
for initial instantiation
protected ObjectWriter(ObjectMapper mapper, SerializationConfig config)
protected ObjectWriter(ObjectMapper mapper, SerializationConfig config, FormatSchema s)
protected ObjectWriter(ObjectWriter base, SerializationConfig config, JavaType rootType, PrettyPrinter pp, FormatSchema s)
protected ObjectWriter(ObjectWriter base, SerializationConfig config)
Method Detail |
---|
public Version version()
version
in interface Versioned
public ObjectWriter withView(Class<?> view)
public ObjectWriter withType(JavaType rootType)
public ObjectWriter withType(Class<?> rootType)
public ObjectWriter withType(TypeReference<?> rootType)
public ObjectWriter withPrettyPrinter(PrettyPrinter pp)
public ObjectWriter withDefaultPrettyPrinter()
public ObjectWriter withFilters(FilterProvider filterProvider)
public ObjectWriter withSchema(FormatSchema schema)
public void writeValue(JsonGenerator jgen, Object value) throws IOException, JsonGenerationException, JsonMappingException
JsonGenerator
.
IOException
JsonGenerationException
JsonMappingException
public void writeValue(File resultFile, Object value) throws IOException, JsonGenerationException, JsonMappingException
IOException
JsonGenerationException
JsonMappingException
public void writeValue(OutputStream out, Object value) throws IOException, JsonGenerationException, JsonMappingException
JsonEncoding.UTF8
).
Note: method does not close the underlying stream explicitly
here; however, JsonFactory
this mapper uses may choose
to close the stream depending on its settings (by default,
it will try to close it when JsonGenerator
we construct
is closed).
IOException
JsonGenerationException
JsonMappingException
public void writeValue(Writer w, Object value) throws IOException, JsonGenerationException, JsonMappingException
Note: method does not close the underlying stream explicitly
here; however, JsonFactory
this mapper uses may choose
to close the stream depending on its settings (by default,
it will try to close it when JsonGenerator
we construct
is closed).
IOException
JsonGenerationException
JsonMappingException
public String writeValueAsString(Object value) throws IOException, JsonGenerationException, JsonMappingException
writeValue(Writer,Object)
with StringWriter
and constructing String, but more efficient.
IOException
JsonGenerationException
JsonMappingException
public byte[] writeValueAsBytes(Object value) throws IOException, JsonGenerationException, JsonMappingException
writeValue(Writer,Object)
with ByteArrayOutputStream
and getting bytes, but more efficient.
Encoding used will be UTF-8.
IOException
JsonGenerationException
JsonMappingException
public boolean canSerialize(Class<?> type)
protected final void _configAndWriteValue(JsonGenerator jgen, Object value) throws IOException, JsonGenerationException, JsonMappingException
IOException
JsonGenerationException
JsonMappingException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |