public Class AvroFactory

Default constructor used to create factory instances. Creation of a factory instance is a light-weight operation, but it is still a good idea to reuse limited number of factory instances (and quite often just a single instance): factories are used as context for storing some reused processing objects (such as symbol tables parsers use) and this reuse only works within context of a single factory instance.

Hides com.fasterxml.jackson.core.JsonFactory.builder.

Main factory method to use for constructing a builder for creating AvroFactory instances with different configuration. Builder is initialized to defaults and this is equivalent to calling builderWithNativeDecoder.

Returns:AvroFactoryBuilder

Doc from com.fasterxml.jackson.core.JsonFactory.builder.

Builder instance to use

Main factory method to use for constructing a builder for creating AvroFactory instances with different configuration, initialized to use Apache Avro library codec for decoding content (instead of Jackson native decoder).

Main factory method to use for constructing a builder for creating AvroFactory instances with different configuration, initialized to use Jackson antive codec for decoding content (instead of Apache Avro library decoder).

Overrides com.fasterxml.jackson.core.JsonFactory.canHandleBinaryNatively.

Doc from com.fasterxml.jackson.core.JsonFactory.canHandleBinaryNatively.

Introspection method that higher-level functionality may call to see whether underlying data format can read and write binary data natively; that is, embeded it as-is without using encodings such as Base64.

Default implementation returns false as JSON does not support native access: all binary content must use Base64 encoding. Most binary formats (like Smile and Avro) support native binary content.

Returns:boolean

Whether format supported by this factory supports native binary content

Annotations

@Override

Overrides com.fasterxml.jackson.core.JsonFactory.canUseSchema.

Doc from com.fasterxml.jackson.core.JsonFactory.canUseSchema.

Method that can be used to quickly check whether given schema is something that parsers and/or generators constructed by this factory could use. Note that this means possible use, at the level of data format (i.e. schema is for same data format as parsers and generators this factory constructs); individual schema instances may have further usage restrictions.

Parameters

schema:FormatSchema

Schema instance to check

Returns:boolean

Whether parsers and generators constructed by this factory can use specified format schema instance

Annotations

@Override

Method for enabling or disabling specified parser feature (check AvroParser.Feature for list of features)

Method for enabling or disabling specified generator feature (check AvroGenerator.Feature for list of features)

Overrides com.fasterxml.jackson.core.JsonFactory.copy.

Doc from com.fasterxml.jackson.core.JsonFactory.copy.

Method for constructing a new JsonFactory that has the same settings as this instance, but is otherwise independent (i.e. nothing is actually shared, symbol tables are separate). Note that ObjectCodec reference is not copied but is set to null; caller typically needs to set it after calling this method. Reason for this is that the codec is used for callbacks, and assumption is that there is strict 1-to-1 mapping between codec, factory. Caller has to, then, explicitly set codec after making the copy.

Returns:AvroFactory

Copy of this factory instance

Annotations

@Override

Overrides com.fasterxml.jackson.core.JsonFactory.createGenerator.

Parameters

out:OutputStream

Doc from com.fasterxml.jackson.core.JsonFactory.createGenerator.

OutputStream to use for writing JSON content

enc:JsonEncoding

Doc from com.fasterxml.jackson.core.JsonFactory.createGenerator.

Character encoding to use

Annotations

@Override

Overrides com.fasterxml.jackson.core.JsonFactory.createGenerator.

Since Avro format always uses UTF-8 internally, no encoding need to be passed to this method.

Annotations

@Override

Overrides com.fasterxml.jackson.core.JsonFactory.createParser.

Doc from com.fasterxml.jackson.core.JsonFactory.createParser.

Method for constructing JSON parser instance to parse contents of specified file.

Encoding is auto-detected from contents according to JSON specification recommended mechanism. Json specification supports only UTF-8, UTF-16 and UTF-32 as valid encodings, so auto-detection implemented only for this charsets. For other charsets use createParser(java.io.Reader).

Underlying input stream (needed for reading contents) will be owned (and managed, i.e. closed as need be) by the parser, since caller has no access to it.

Parameters

f:File

File that contains JSON content to parse

Annotations

@SuppressWarnings:resource

@Override

Overrides com.fasterxml.jackson.core.JsonFactory.createParser.

Doc from com.fasterxml.jackson.core.JsonFactory.createParser.

Method for constructing JSON parser instance to parse contents of resource reference by given URL.

Encoding is auto-detected from contents according to JSON specification recommended mechanism. Json specification supports only UTF-8, UTF-16 and UTF-32 as valid encodings, so auto-detection implemented only for this charsets. For other charsets use createParser(java.io.Reader).

Underlying input stream (needed for reading contents) will be owned (and managed, i.e. closed as need be) by the parser, since caller has no access to it.

Parameters

url:URL

URL pointing to resource that contains JSON content to parse

Annotations

@Override

Overrides com.fasterxml.jackson.core.JsonFactory.createParser.

Doc from com.fasterxml.jackson.core.JsonFactory.createParser.

Method for constructing JSON parser instance to parse the contents accessed via specified input stream.

The input stream will not be owned by the parser, it will still be managed (i.e. closed if end-of-stream is reacher, or parser close method called) if (and only if) com.fasterxml.jackson.core.StreamReadFeature#AUTO_CLOSE_SOURCE is enabled.

Parameters

in:InputStream

InputStream to use for reading JSON content to parse

Annotations

@Override

Overrides com.fasterxml.jackson.core.JsonFactory.createParser.

Doc from com.fasterxml.jackson.core.JsonFactory.createParser.

Method for constructing parser for parsing the contents of given byte array.

Annotations

@Override

Overrides com.fasterxml.jackson.core.JsonFactory.createParser.

Doc from com.fasterxml.jackson.core.JsonFactory.createParser.

Method for constructing parser for parsing the contents of given byte array.

Parameters

data:byte[]

Buffer that contains data to parse

offset:int

Offset of the first data byte within buffer

len:int

Length of contents to parse within buffer

Annotations

@SuppressWarnings:resource

@Override

Method for disabling specified parser features (check AvroParser.Feature for list of features)

Method for disabling specified generator feature (check AvroGenerator.Feature for list of features)

Method for enabling specified parser feature (check AvroParser.Feature for list of features)

Method for enabling specified generator features (check AvroGenerator.Feature for list of features)

Overrides com.fasterxml.jackson.core.JsonFactory.getFormatGeneratorFeatures.

Annotations

@Override

Overrides com.fasterxml.jackson.core.JsonFactory.getFormatName.

Doc from com.fasterxml.jackson.core.JsonFactory.getFormatName.

Method that returns short textual id identifying format this factory supports.

Returns:String

Name of the format handled by parsers, generators this factory creates

Annotations

@Override

Overrides com.fasterxml.jackson.core.JsonFactory.getFormatParserFeatures.

Annotations

@Override

Overrides com.fasterxml.jackson.core.JsonFactory.hasFormat.

Sub-classes need to override this method

Annotations

@Override

Checked whether specified parser feature is enabled.

Check whether specified generator feature is enabled.

Overrides com.fasterxml.jackson.core.JsonFactory.rebuild.

Doc from com.fasterxml.jackson.core.JsonFactory.rebuild.

Method that allows construction of differently configured factory, starting with settings of this factory.

Returns:AvroFactoryBuilder

Builder instance to use

Annotations

@Override

Overrides com.fasterxml.jackson.core.JsonFactory.requiresPropertyOrdering.

Doc from com.fasterxml.jackson.core.JsonFactory.requiresPropertyOrdering.

Introspection method that higher-level functionality may call to see whether underlying data format requires a stable ordering of object properties or not. This is usually used for determining whether to force a stable ordering (like alphabetic ordering by name) if no ordering if explicitly specified.

Default implementation returns false as JSON does NOT require stable ordering. Formats that require ordering include positional textual formats like CSV, and schema-based binary formats like Avro.

Returns:boolean

Whether format supported by this factory requires Object properties to be ordered.

Annotations

@Override

Overrides com.fasterxml.jackson.core.JsonFactory.version.

Implements com.fasterxml.jackson.core.Versioned.version.

Doc from com.fasterxml.jackson.core.Versioned.version.

Method called to detect version of the component that implements this interface; returned version should never be null, but may return specific "not available" instance (see Version for details).

Returns:Version

Version of the component

Annotations

@Override