Jackson 3.0.1 · tools.jackson.dataformat.ion.IonObjectMapper

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static class	IonObjectMapper.Builder Base implementation for "Vanilla" `ObjectMapper`, used with ION backend.
private static class	IonObjectMapper.SharedWrapper Helper class to contain dynamically constructed "shared" instance of mapper, should one be needed via `shared`.

Modifier and Type	Field and Description
private static final long	serialVersionUID Hides tools.jackson.databind.ObjectMapper.serialVersionUID.

Constructor Summary

Access	Constructor and Description
public	IonObjectMapper()
public	IonObjectMapper(IonFactory f)
public	IonObjectMapper(IonObjectMapper.Builder b)

Method Summary

Modifier and Type	Method and Description
public static IonObjectMapper.Builder	builder() A builder for a mapper that will use textual writers by default.
public static IonObjectMapper.Builder	builder(IonFactory streamFactory) A builder for a mapper that will use specified `streamFactory`, pre-configured.
public static IonObjectMapper.Builder	builder(IonSystem ionSystem) A builder for a mapper that will use textual writers by default and the provided `IonSystem`.
public static IonObjectMapper.Builder	builderForBinaryWriters() A builder for a mapper that will use binary writers by default.
public static IonObjectMapper.Builder	builderForBinaryWriters(IonSystem ionSystem) A builder for a mapper that will use binary writers by default and the provided `IonSystem`
public static IonObjectMapper.Builder	builderForTextualWriters() A builder for a mapper that will use textual writers by default.
public static IonObjectMapper.Builder	builderForTextualWriters(IonSystem ionSystem) A builder for a mapper that will use textual writers by default and the provided `IonSystem`.
public IonGenerator	createGenerator(IonWriter out)
public IonParser	createParser(IonReader src)
public IonParser	createParser(IonValue value)
public <T> T	readValue(IonReader r, Class<T> valueType) Deserialize an Ion value read from the supplied IonReader into a Java type.
public <T> T	readValue(IonReader r, TypeReference<T> valueTypeRef) Deserialize an Ion value read from the supplied IonReader into a Java type.
public <T> T	readValue(IonReader r, JavaType valueType) Deserialize an Ion value read from the supplied IonReader into a Java type.
public <T> T	readValue(IonValue value, Class<T> valueType) Convenience method for converting Ion value into given value type.
public <T> T	readValue(IonValue value, TypeReference<T> valueTypeRef) Convenience method for converting Ion value into given value type.
public <T> T	readValue(IonValue value, JavaType valueType) Convenience method for converting Ion value into given value type.
public IonObjectMapper.Builder	rebuild() Overrides tools.jackson.databind.ObjectMapper.rebuild. Method for creating a new `MapperBuilder` for constructing differently configured `ObjectMapper` instance, starting with current configuration including base settings and registered modules.
public static IonObjectMapper	shared() Accessor method for getting globally shared "default" `IonObjectMapper` instance: one that has default configuration, no modules registered, no config overrides.
public IonFactory	tokenStreamFactory() Overrides tools.jackson.databind.ObjectMapper.tokenStreamFactory. Method that can be used to get hold of `TokenStreamFactory` that this mapper uses if it needs to construct `JsonParser`s and/or `JsonGenerator`s.
public Version	version() Overrides tools.jackson.databind.ObjectMapper.version. Implements tools.jackson.core.Versioned.version. Method that will return version information stored in and read from jar that contains this class.
public void	writeValue(IonWriter w, Object value) Method that can be used to serialize any Java value as Ion output, using IonWriter provided.
public IonValue	writeValueAsIonValue(Object value) Method that can be used to map any Java value to an IonValue.

Inherited from tools.jackson.databind.ObjectMapper:: _assertNotNull _configAndWriteValue _convert _deserializationContext _deserializationContext _deserializationContext _findRootDeserializer _initForReading _newReader _newReader _newWriter _newWriter _newWriter _readMapAndClose _readTreeAndClose _readValue _serializationContext _serializationContext _verifyNoTrailingTokens _verifySchemaType _writeCloseableValue acceptJsonFormatVisitor acceptJsonFormatVisitor acceptJsonFormatVisitor booleanNode clearCaches constructType constructType convertValue convertValue convertValue createArrayNode createGenerator createGenerator createGenerator createGenerator createGenerator createGenerator createNonBlockingByteArrayParser createNonBlockingByteBufferParser createObjectNode createParser createParser createParser createParser createParser createParser createParser createParser createParser createParser deserializationConfig getInjectableValues getNodeFactory getTypeFactory isEnabled isEnabled isEnabled isEnabled isEnabled isEnabled isEnabled missingNode nullNode reader reader reader reader reader reader reader reader reader readerFor readerFor readerFor readerForArrayOf readerForListOf readerForMapOf readerForUpdating readerWithView readResolve readTree readTree readTree readTree readTree readTree readTree readTree readTree readValue readValue readValue readValue readValue readValue readValue readValue readValue readValue readValue readValue readValue readValue readValue readValue readValue readValue readValue readValue readValue readValue readValue readValue readValue readValue readValue readValue readValue readValue readValue readValues readValues readValues registeredModules serializationConfig stringNode treeAsTokens treeToValue treeToValue treeToValue updateValue valueToTree writer writer writer writer writer writer writer writer writer writer writeReplace writerFor writerFor writerFor writerWithDefaultPrettyPrinter writerWithView writeTree writeValue writeValue writeValue writeValue writeValue writeValue writeValueAsBytes writeValueAsString writeValueIntoBuffer

Field Detail

serialVersionUID	back to summary
private static final long serialVersionUID Hides tools.jackson.databind.ObjectMapper.serialVersionUID.

Constructor Detail

IonObjectMapper	back to summary
public IonObjectMapper()

IonObjectMapper	back to summary
public IonObjectMapper(IonFactory f)

IonObjectMapper	back to summary
public IonObjectMapper(IonObjectMapper.Builder b)

Method Detail

builder	back to summary
public static IonObjectMapper.Builder builder() A builder for a mapper that will use textual writers by default. Same as `builderForTextualWriters()`.

builder	back to summary
public static IonObjectMapper.Builder builder(IonFactory streamFactory) A builder for a mapper that will use specified `streamFactory`, pre-configured.

builder	back to summary
public static IonObjectMapper.Builder builder(IonSystem ionSystem) A builder for a mapper that will use textual writers by default and the provided `IonSystem`. Same as `builderForTextualWriters(IonSystem)`.

builderForBinaryWriters	back to summary
public static IonObjectMapper.Builder builderForBinaryWriters() A builder for a mapper that will use binary writers by default.

builderForBinaryWriters	back to summary
public static IonObjectMapper.Builder builderForBinaryWriters(IonSystem ionSystem) A builder for a mapper that will use binary writers by default and the provided `IonSystem`

builderForTextualWriters	back to summary
public static IonObjectMapper.Builder builderForTextualWriters() A builder for a mapper that will use textual writers by default.

builderForTextualWriters	back to summary
public static IonObjectMapper.Builder builderForTextualWriters(IonSystem ionSystem) A builder for a mapper that will use textual writers by default and the provided `IonSystem`.

createGenerator	back to summary
public IonGenerator createGenerator(IonWriter out) Since 3.0

createParser	back to summary
public IonParser createParser(IonReader src) Since 3.0

createParser	back to summary
public IonParser createParser(IonValue value) Since 3.0

readValue	back to summary
public <T> T readValue(IonReader r, Class<T> valueType) throws IOException Deserialize an Ion value read from the supplied IonReader into a Java type. Note method does not close the underlying reader Annotations @SuppressWarnings:unchecked

readValue

back to summary

public <T> T readValue(IonReader r, Class<T> valueType) throws IOException

Deserialize an Ion value read from the supplied IonReader into a Java type.

Note

method does not close the underlying reader

Annotations

@SuppressWarnings:unchecked

readValue	back to summary
public <T> T readValue(IonReader r, TypeReference<T> valueTypeRef) throws IOException Deserialize an Ion value read from the supplied IonReader into a Java type. Note method does not close the underlying reader Annotations @SuppressWarnings:unchecked, rawtypes

readValue

back to summary

public <T> T readValue(IonReader r, TypeReference<T> valueTypeRef) throws IOException

Deserialize an Ion value read from the supplied IonReader into a Java type.

Note

method does not close the underlying reader

Annotations

@SuppressWarnings:unchecked, rawtypes

readValue	back to summary
public <T> T readValue(IonReader r, JavaType valueType) throws IOException Deserialize an Ion value read from the supplied IonReader into a Java type. Note method does not close the underlying reader Annotations @SuppressWarnings:unchecked

readValue

back to summary

public <T> T readValue(IonReader r, JavaType valueType) throws IOException

Deserialize an Ion value read from the supplied IonReader into a Java type.

Note

method does not close the underlying reader

Annotations

@SuppressWarnings:unchecked

readValue	back to summary
public <T> T readValue(IonValue value, Class<T> valueType) throws IOException Convenience method for converting Ion value into given value type. Annotations @SuppressWarnings:unchecked

readValue

back to summary

public <T> T readValue(IonValue value, Class<T> valueType) throws IOException

Convenience method for converting Ion value into given value type.

Annotations

@SuppressWarnings:unchecked

readValue	back to summary
public <T> T readValue(IonValue value, TypeReference<T> valueTypeRef) throws IOException Convenience method for converting Ion value into given value type. Annotations @SuppressWarnings:unchecked, rawtypes

readValue

back to summary

public <T> T readValue(IonValue value, TypeReference<T> valueTypeRef) throws IOException

Convenience method for converting Ion value into given value type.

Annotations

@SuppressWarnings:unchecked, rawtypes

readValue	back to summary
public <T> T readValue(IonValue value, JavaType valueType) throws IOException Convenience method for converting Ion value into given value type. Annotations @SuppressWarnings:unchecked

readValue

back to summary

public <T> T readValue(IonValue value, JavaType valueType) throws IOException

Convenience method for converting Ion value into given value type.

Annotations

@SuppressWarnings:unchecked

rebuild back to summary

rebuild	back to summary
public IonObjectMapper.Builder rebuild() Overrides tools.jackson.databind.ObjectMapper.rebuild. Doc from tools.jackson.databind.ObjectMapper.rebuild. Method for creating a new `MapperBuilder` for constructing differently configured `ObjectMapper` instance, starting with current configuration including base settings and registered modules. Annotations @SuppressWarnings:unchecked @Override

public IonObjectMapper.Builder rebuild()

Overrides tools.jackson.databind.ObjectMapper.rebuild.

Doc from tools.jackson.databind.ObjectMapper.rebuild.

Method for creating a new MapperBuilder for constructing differently configured ObjectMapper instance, starting with current configuration including base settings and registered modules.

Annotations

@SuppressWarnings:unchecked
@Override

shared	back to summary
public static IonObjectMapper shared() Accessor method for getting globally shared "default" `IonObjectMapper` instance: one that has default configuration, no modules registered, no config overrides. Usable mostly when dealing "untyped" or Tree-style content reading and writing.

tokenStreamFactory back to summary

tokenStreamFactory	back to summary
public IonFactory tokenStreamFactory() Overrides tools.jackson.databind.ObjectMapper.tokenStreamFactory. Doc from tools.jackson.databind.ObjectMapper.tokenStreamFactory. Method that can be used to get hold of `TokenStreamFactory` that this mapper uses if it needs to construct `JsonParser`s and/or `JsonGenerator`s. Warning note that all `ObjectReader` and `ObjectWriter` instances created by this mapper usually share the same configured `TokenStreamFactory`, so changes to its configuration will "leak". To avoid such observed changes you should always use "with()" and "without()" method of `ObjectReader` and `ObjectWriter` for changing `StreamReadFeature` and `StreamWriteFeature` settings to use on per-call basis. Annotations @Override

public IonFactory tokenStreamFactory()

Overrides tools.jackson.databind.ObjectMapper.tokenStreamFactory.

Doc from tools.jackson.databind.ObjectMapper.tokenStreamFactory.

Method that can be used to get hold of TokenStreamFactory that this mapper uses if it needs to construct JsonParsers and/or JsonGenerators.

Warning

note that all ObjectReader and ObjectWriter instances created by this mapper usually share the same configured TokenStreamFactory, so changes to its configuration will "leak". To avoid such observed changes you should always use "with()" and "without()" method of ObjectReader and ObjectWriter for changing StreamReadFeature and StreamWriteFeature settings to use on per-call basis.

Annotations

@Override

version	back to summary
public Version version() Overrides tools.jackson.databind.ObjectMapper.version. Implements tools.jackson.core.Versioned.version. Doc from tools.jackson.databind.ObjectMapper.version. Method that will return version information stored in and read from jar that contains this class. Annotations @Override

version

back to summary

public Version version()

Overrides tools.jackson.databind.ObjectMapper.version.

Implements tools.jackson.core.Versioned.version.

Doc from tools.jackson.databind.ObjectMapper.version.

Method that will return version information stored in and read from jar that contains this class.

Annotations

@Override

writeValue	back to summary
public void writeValue(IonWriter w, Object value) throws IOException Method that can be used to serialize any Java value as Ion output, using IonWriter provided. Note method does not close the underlying writer explicitly

writeValueAsIonValue	back to summary
public IonValue writeValueAsIonValue(Object value) throws IOException Method that can be used to map any Java value to an IonValue.

Modifier and Type	Class and Description
protected static class	IonObjectMapper.Builder.StateImpl

Access	Constructor and Description
public	Builder(IonFactory f)
public	Builder(IonObjectMapper.Builder.StateImpl state)

Modifier and Type	Method and Description
protected MapperBuilderState	_saveState() Implements abstract tools.jackson.databind.cfg.MapperBuilder._saveState.
public IonObjectMapper	build() Implements abstract tools.jackson.databind.cfg.MapperBuilder.build. Method to call to create actual mapper instance.
public IonObjectMapper.Builder	configure(IonReadFeature feature, boolean state)
public IonObjectMapper.Builder	configure(IonWriteFeature feature, boolean state)
public IonObjectMapper.Builder	disable(IonReadFeature... features)
public IonObjectMapper.Builder	disable(IonWriteFeature... features)
public IonObjectMapper.Builder	enable(IonReadFeature... features)
public IonObjectMapper.Builder	enable(IonWriteFeature... features)

Builder	back to summary
public Builder(IonFactory f)

Builder	back to summary
public Builder(IonObjectMapper.Builder.StateImpl state)

_saveState	back to summary
protected MapperBuilderState _saveState() Implements abstract tools.jackson.databind.cfg.MapperBuilder._saveState. Annotations @Override

build	back to summary
public IonObjectMapper build() Implements abstract tools.jackson.databind.cfg.MapperBuilder.build. Doc from tools.jackson.databind.cfg.MapperBuilder.build. Method to call to create actual mapper instance. Implementation detail: usually construction occurs by passing `this` builder instance to constructor of specific mapper type builder builds. Annotations @Override

configure	back to summary
public IonObjectMapper.Builder configure(IonReadFeature feature, boolean state)

configure	back to summary
public IonObjectMapper.Builder configure(IonWriteFeature feature, boolean state)

disable	back to summary
public IonObjectMapper.Builder disable(IonReadFeature... features)

disable	back to summary
public IonObjectMapper.Builder disable(IonWriteFeature... features)

enable	back to summary
public IonObjectMapper.Builder enable(IonReadFeature... features)

enable	back to summary
public IonObjectMapper.Builder enable(IonWriteFeature... features)

Modifier and Type	Field and Description
private static final long	serialVersionUID Hides tools.jackson.databind.cfg.MapperBuilderState.serialVersionUID.

Access	Constructor and Description
public	StateImpl(IonObjectMapper.Builder src)

Modifier and Type	Method and Description
protected Object	readResolve() Implements abstract tools.jackson.databind.cfg.MapperBuilderState.readResolve. Method required to support JDK deserialization; made `abstract` here to ensure sub-classes must implement it.

serialVersionUID	back to summary
private static final long serialVersionUID Hides tools.jackson.databind.cfg.MapperBuilderState.serialVersionUID.

StateImpl	back to summary
public StateImpl(IonObjectMapper.Builder src)

readResolve	back to summary
protected Object readResolve() Implements abstract tools.jackson.databind.cfg.MapperBuilderState.readResolve. Doc from tools.jackson.databind.cfg.MapperBuilderState.readResolve. Method required to support JDK deserialization; made `abstract` here to ensure sub-classes must implement it. Annotations @Override

Modifier and Type	Field and Description
private static final IonObjectMapper	MAPPER

Method Summary

Modifier and Type	Method and Description
public static IonObjectMapper	wrapped()

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

Field Detail

MAPPER	back to summary
private static final IonObjectMapper MAPPER

Constructor Detail

SharedWrapper	back to summary
private SharedWrapper()

Method Detail

wrapped	back to summary
public static IonObjectMapper wrapped()

public Class IonObjectMapper

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class IonObjectMapper.Builder

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail

protected Class IonObjectMapper.Builder.StateImpl

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class IonObjectMapper.SharedWrapper

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail