Jackson 2.18.2 · com.fasterxml.jackson.databind.ObjectWriter

Modifier and Type	Class and Description
public static class	ObjectWriter.GeneratorSettings Helper class used for containing settings specifically related to (re)configuring `JsonGenerator` constructed for writing output.
public static class	ObjectWriter.Prefetch As a minor optimization, we will make an effort to pre-fetch a serializer, or at least relevant `TypeSerializer`, if given enough information.

Modifier and Type	Field and Description
protected final SerializationConfig	_config General serialization configuration settings
protected final JsonFactory	_generatorFactory Factory used for constructing `JsonGenerator`s
protected final ObjectWriter.GeneratorSettings	_generatorSettings Container for settings that need to be passed to `JsonGenerator` constructed for serializing values.
protected final ObjectWriter.Prefetch	_prefetch We may pre-fetch serializer if root type is known (has been explicitly declared), and if so, reuse it afterwards.
protected final SerializerFactory	_serializerFactory
protected final DefaultSerializerProvider	_serializerProvider
protected static final PrettyPrinter	NULL_PRETTY_PRINTER We need to keep track of explicit disabling of pretty printing; easiest to do by a token value.
private static final long	serialVersionUID

Access	Constructor and Description
protected	ObjectWriter(ObjectMapper mapper, SerializationConfig config, JavaType rootType, PrettyPrinter pp) Constructor used by `ObjectMapper` for initial instantiation
protected	ObjectWriter(ObjectMapper mapper, SerializationConfig config) Alternative constructor for initial instantiation by `ObjectMapper`
protected	ObjectWriter(ObjectMapper mapper, SerializationConfig config, FormatSchema s) Alternative constructor for initial instantiation by `ObjectMapper`
protected	ObjectWriter(ObjectWriter base, SerializationConfig config, ObjectWriter.GeneratorSettings genSettings, ObjectWriter.Prefetch prefetch) Copy constructor used for building variations.
protected	ObjectWriter(ObjectWriter base, SerializationConfig config) Copy constructor used for building variations.
protected	ObjectWriter(ObjectWriter base, JsonFactory f)

Method Summary

Modifier and Type	Method and Description
protected final void	_assertNotNull(String paramName, Object src)
protected final JsonGenerator	_configureGenerator(JsonGenerator gen) Helper method called to set or override settings of passed-in `JsonGenerator`
protected ObjectWriter	_new(ObjectWriter base, JsonFactory f) Overridable factory method called by various "withXxx()" methods
protected ObjectWriter	_new(ObjectWriter base, SerializationConfig config) Overridable factory method called by various "withXxx()" methods
protected ObjectWriter	_new(ObjectWriter.GeneratorSettings genSettings, ObjectWriter.Prefetch prefetch) Overridable factory method called by various "withXxx()" methods.
protected SequenceWriter	_newSequenceWriter(boolean wrapInArray, JsonGenerator gen, boolean managedInput) Overridable factory method called by `writeValues(OutputStream)` method (and its various overrides), and initializes it as necessary.
protected DefaultSerializerProvider	_serializerProvider() Overridable helper method used for constructing `SerializerProvider` to use for serialization.
protected void	_verifySchemaType(FormatSchema schema)
private final void	_writeCloseable(JsonGenerator gen, Object value) Helper method used when value to serialize is `Closeable` and its `close()` method is to be called right after serialization has been called
protected final void	_writeValueAndClose(JsonGenerator gen, Object value) Method called to configure the generator as necessary and then call write functionality
public void	acceptJsonFormatVisitor(JavaType Type to generate schema for (possibly with generic signature) type, JsonFormatVisitorWrapper visitor) Method for visiting type hierarchy for given type, using specified visitor.
public void	acceptJsonFormatVisitor(Class<?> type, JsonFormatVisitorWrapper visitor) Since 2.6
public boolean	canSerialize(Class<?> type) Deprecated Since 2.18 use discouraged; method to be removed from Jackson 3.0 Method that can be called to check whether `ObjectWriter` thinks it could serialize an instance of given Class.
public boolean	canSerialize(Class<?> type, AtomicReference<Throwable> cause) Deprecated Since 2.18 use discouraged; method to be removed from Jackson 3.0 Method for checking whether instances of given type can be serialized, and optionally why (as per `Throwable` returned).
public JsonGenerator	createGenerator(OutputStream out) Factory method for constructing properly initialized `JsonGenerator` to write content using specified `OutputStream`.
public JsonGenerator	createGenerator(OutputStream out, JsonEncoding enc) Factory method for constructing properly initialized `JsonGenerator` to write content using specified `OutputStream` and encoding.
public JsonGenerator	createGenerator(Writer w) Factory method for constructing properly initialized `JsonGenerator` to write content using specified `Writer`.
public JsonGenerator	createGenerator(File outputFile, JsonEncoding enc) Factory method for constructing properly initialized `JsonGenerator` to write content to specified `File`, using specified encoding.
public JsonGenerator	createGenerator(DataOutput out) Factory method for constructing properly initialized `JsonGenerator` to write content using specified `DataOutput`.
public ObjectWriter	forType(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.
public ObjectWriter	forType(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.
public ObjectWriter	forType(TypeReference<?> 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.
public ContextAttributes	getAttributes()
public SerializationConfig	getConfig()
public JsonFactory	getFactory()
public TypeFactory	getTypeFactory()
public boolean	hasPrefetchedSerializer() Diagnostics method that can be called to check whether this writer has pre-fetched serializer to use: pre-fetching improves performance when writer instances are reused as it avoids a per-call serializer lookup.
public boolean	isEnabled(SerializationFeature f)
public boolean	isEnabled(MapperFeature f)
public boolean	isEnabled(DatatypeFeature f)
public boolean	isEnabled(JsonParser.Feature f) Deprecated
public boolean	isEnabled(JsonGenerator.Feature f)
public boolean	isEnabled(StreamWriteFeature f)
public Version	version() Implements com.fasterxml.jackson.core.Versioned.version. Method that will return version information stored in and read from jar that contains this class.
public ObjectWriter	with(SerializationFeature feature) Method for constructing a new instance that is configured with specified feature enabled.
public ObjectWriter	with(SerializationFeature first, SerializationFeature... other) Method for constructing a new instance that is configured with specified features enabled.
public ObjectWriter	with(DatatypeFeature feature) Method for constructing a new instance that is configured with specified feature enabled.
public ObjectWriter	with(JsonGenerator.Feature feature)
public ObjectWriter	with(StreamWriteFeature feature)
public ObjectWriter	with(FormatFeature feature)
public ObjectWriter	with(DateFormat df) Fluent factory method that will construct a new writer instance that will use specified date format for serializing dates; or if null passed, one that will serialize dates as numeric timestamps.
public ObjectWriter	with(FilterProvider filterProvider) Method that will construct a new instance that uses specified provider for resolving filter instances by id.
public ObjectWriter	with(PrettyPrinter pp) Method that will construct a new instance that will use specified pretty printer (or, if null, will not do any pretty-printing)
public ObjectWriter	with(FormatSchema schema) Method that will construct a new instance that uses specific format schema for serialization.
public ObjectWriter	with(Locale l)
public ObjectWriter	with(TimeZone tz)
public ObjectWriter	with(Base64Variant b64variant) Method that will construct a new instance that uses specified default `Base64Variant` for base64 encoding
public ObjectWriter	with(CharacterEscapes escapes)
public ObjectWriter	with(JsonFactory f)
public ObjectWriter	with(ContextAttributes attrs)
public ObjectWriter	withAttribute(Object key, Object value)
public ObjectWriter	withAttributes(Map<?, ?> attrs) Mutant factory method that allows construction of a new writer instance that uses specified set of default attribute values.
public ObjectWriter	withDefaultPrettyPrinter() Method that will construct a new instance that will use the default pretty printer for serialization.
public ObjectWriter	withFeatures(SerializationFeature... features) Method for constructing a new instance that is configured with specified features enabled.
public ObjectWriter	withFeatures(DatatypeFeature... features) Method for constructing a new instance that is configured with specified features enabled.
public ObjectWriter	withFeatures(JsonGenerator.Feature... features)
public ObjectWriter	withFeatures(FormatFeature... features)
public ObjectWriter	without(SerializationFeature feature) Method for constructing a new instance that is configured with specified feature disabled.
public ObjectWriter	without(SerializationFeature first, SerializationFeature... other) Method for constructing a new instance that is configured with specified features disabled.
public ObjectWriter	without(DatatypeFeature feature) Method for constructing a new instance that is configured with specified feature disabled.
public ObjectWriter	without(JsonGenerator.Feature feature)
public ObjectWriter	without(StreamWriteFeature feature)
public ObjectWriter	without(FormatFeature feature)
public ObjectWriter	withoutAttribute(Object key)
public ObjectWriter	withoutFeatures(SerializationFeature... features) Method for constructing a new instance that is configured with specified features disabled.
public ObjectWriter	withoutFeatures(DatatypeFeature... features) Method for constructing a new instance that is configured with specified features disabled.
public ObjectWriter	withoutFeatures(JsonGenerator.Feature... features)
public ObjectWriter	withoutFeatures(FormatFeature... features)
public ObjectWriter	withoutRootName() Convenience method that is same as calling: `withRootName("")` which will forcibly prevent use of root name wrapping when writing values with this `ObjectWriter`.
public ObjectWriter	withRootName(String Root name to use, if non-empty; `null` for "use defaults", and empty String ("") for "do NOT add root wrapper" rootName) Method for constructing a new instance with configuration that specifies what root name to use for "root element wrapping".
public ObjectWriter	withRootName(PropertyName rootName)
public ObjectWriter	withRootValueSeparator(String sep)
public ObjectWriter	withRootValueSeparator(SerializableString sep)
public ObjectWriter	withSchema(FormatSchema schema) Deprecated Since 2.5 use `with(FormatSchema)` instead
public ObjectWriter	withType(JavaType rootType) Deprecated since 2.5 Use `forType(JavaType)` instead
public ObjectWriter	withType(Class<?> rootType) Deprecated since 2.5 Use `forType(Class)` instead
public ObjectWriter	withType(TypeReference<?> rootType) Deprecated since 2.5 Use `forType(TypeReference)` instead
public ObjectWriter	withView(Class<?> view) Method that will construct a new instance that uses specified serialization view for serialization (with null basically disables view processing) Note that the method does NOT change state of this reader, but rather construct and returns a newly configured instance.
public void	writeValue(JsonGenerator g, Object value) Method that can be used to serialize any Java value as JSON output, using provided `JsonGenerator`.
public void	writeValue(File resultFile, Object value) Method that can be used to serialize any Java value as JSON output, written to File provided.
public 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`).
public void	writeValue(Writer w, Object value) Method that can be used to serialize any Java value as JSON output, using Writer provided.
public void	writeValue(DataOutput out, Object value)
public byte[]	writeValueAsBytes(Object value) Method that can be used to serialize any Java value as a byte array.
public String	writeValueAsString(Object value) Method that can be used to serialize any Java value as a String.
public SequenceWriter	writeValues(File Target file to write value sequence to. out) Method for creating a `SequenceWriter` to write a sequence of root values using configuration of this `ObjectWriter`.
public SequenceWriter	writeValues(JsonGenerator Low-level generator caller has already constructed that will be used for actual writing of token stream. g) Method for creating a `SequenceWriter` to write a sequence of root values using configuration of this `ObjectWriter`.
public SequenceWriter	writeValues(Writer Target writer to use for writing the token stream out) Method for creating a `SequenceWriter` to write a sequence of root values using configuration of this `ObjectWriter`.
public SequenceWriter	writeValues(OutputStream Physical output stream to use for writing the token stream out) Method for creating a `SequenceWriter` to write a sequence of root values using configuration of this `ObjectWriter`.
public SequenceWriter	writeValues(DataOutput out)
public SequenceWriter	writeValuesAsArray(File File to write token stream to out) Method for creating a `SequenceWriter` to write an array of root-level values, using configuration of this `ObjectWriter`.
public SequenceWriter	writeValuesAsArray(JsonGenerator Underlying generator to use for writing the token stream gen) Method for creating a `SequenceWriter` to write an array of root-level values, using configuration of this `ObjectWriter`.
public SequenceWriter	writeValuesAsArray(Writer Writer to use for writing the token stream out) Method for creating a `SequenceWriter` to write an array of root-level values, using configuration of this `ObjectWriter`.
public SequenceWriter	writeValuesAsArray(OutputStream Physical output stream to use for writing the token stream out) Method for creating a `SequenceWriter` to write an array of root-level values, using configuration of this `ObjectWriter`.
public SequenceWriter	writeValuesAsArray(DataOutput out)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

public Class ObjectWriter

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary