Jackson 2.18.2 · com.fasterxml.jackson.dataformat.cbor.CBORFactory

Modifier and Type	Field and Description
protected int	_formatGeneratorFeatures
protected int	_formatParserFeatures
pack-priv static final int	DEFAULT_CBOR_GENERATOR_FEATURE_FLAGS Bitfield (set of flags) of all generator features that are enabled by default.
pack-priv static final int	DEFAULT_CBOR_PARSER_FEATURE_FLAGS Bitfield (set of flags) of all parser features that are enabled by default.
public static final String	FORMAT_NAME Name used to identify CBOR format.
private static final long	serialVersionUID Hides com.fasterxml.jackson.core.JsonFactory.serialVersionUID.

Access	Constructor and Description
public	CBORFactory() Default constructor used to create factory instances.
public	CBORFactory(ObjectCodec oc)
public	CBORFactory(CBORFactory src, ObjectCodec oc) Note REQUIRES at least 2.2.1 -- unfortunate intra-patch dep but seems preferable to just leaving bug be as is
protected	CBORFactory(CBORFactoryBuilder b) Constructors used by `CBORFactoryBuilder` for instantiation.

Method Summary

Modifier and Type	Method and Description
private final CBORGenerator	_createCBORGenerator(IOContext ctxt, int stdFeat, int formatFeat, ObjectCodec codec, OutputStream out)
protected IOContext	_createContext(ContentReference Source/target reference to use for diagnostics, exception messages contentRef, boolean Whether input/output buffer is managed by this factory or not resourceManaged) Overrides com.fasterxml.jackson.core.JsonFactory._createContext. Overridable factory method that actually instantiates desired context object.
protected CBORGenerator	_createGenerator(Writer Writer underlying writer to write generated content to out, IOContext I/O context to use ctxt) Overrides com.fasterxml.jackson.core.JsonFactory._createGenerator. Overridable factory method that actually instantiates generator for given `Writer` and context object.
protected CBORParser	_createParser(InputStream InputStream to use for reading content to parse in, IOContext I/O context to use for parsing ctxt) Overrides com.fasterxml.jackson.core.JsonFactory._createParser. Overridable factory method that actually instantiates desired parser.
protected JsonParser	_createParser(Reader Reader to use for reading content to parse r, IOContext I/O context to use for parsing ctxt) Overrides com.fasterxml.jackson.core.JsonFactory._createParser. Overridable factory method that actually instantiates desired parser.
protected JsonParser	_createParser(char[] Buffer that contains content to parse data, int Offset to the first character of data to parse offset, int Number of characters within buffer to parse len, IOContext I/O context to use for parsing ctxt, boolean Whether input buffer is recycled by the factory recyclable) Overrides com.fasterxml.jackson.core.JsonFactory._createParser. Overridable factory method that actually instantiates parser using given `char[]` object for accessing content.
protected CBORParser	_createParser(byte[] Buffer that contains content to parse data, int Offset to the first character of data to parse offset, int Number of characters within buffer to parse len, IOContext I/O context to use for parsing ctxt) Overrides com.fasterxml.jackson.core.JsonFactory._createParser. Overridable factory method that actually instantiates desired parser.
protected CBORGenerator	_createUTF8Generator(OutputStream OutputStream underlying writer to write generated content to out, IOContext I/O context to use ctxt) Overrides com.fasterxml.jackson.core.JsonFactory._createUTF8Generator. Overridable factory method that actually instantiates generator for given `OutputStream` and context object, using UTF-8 encoding.
protected Writer	_createWriter(OutputStream out, JsonEncoding enc, IOContext ctxt) Overrides com.fasterxml.jackson.core.JsonFactory._createWriter.
protected <T> T	_nonByteSource()
protected <T> T	_nonByteTarget()
public static CBORFactoryBuilder	builder() Hides com.fasterxml.jackson.core.JsonFactory.builder. Main factory method to use for constructing `CBORFactory` instances with different configuration.
public boolean	canHandleBinaryNatively() Overrides 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.
public boolean	canUseCharArrays() Overrides com.fasterxml.jackson.core.JsonFactory.canUseCharArrays. Introspection method that can be used by base factory to check whether access using `char[]` is something that actual parser implementations can take advantage of, over having to use `java.io.Reader`.
public final CBORFactory	configure(CBORParser.Feature f, boolean state) Method for enabling or disabling specified parser feature (check `CBORParser.Feature` for list of features)
public final CBORFactory	configure(CBORGenerator.Feature f, boolean state) Method for enabling or disabling specified generator feature (check `CBORGenerator.Feature` for list of features)
public CBORFactory	copy() Overrides 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).
public CBORGenerator	createGenerator(OutputStream OutputStream to use for writing JSON content out, JsonEncoding Character encoding to use enc) Overrides com.fasterxml.jackson.core.JsonFactory.createGenerator. Method for constructing `JsonGenerator` for generating CBOR-encoded output.
public CBORGenerator	createGenerator(OutputStream out) Overrides com.fasterxml.jackson.core.JsonFactory.createGenerator. Method for constructing `JsonGenerator` for generating CBOR-encoded output.
public CBORParser	createParser(File File that contains JSON content to parse f) Overrides com.fasterxml.jackson.core.JsonFactory.createParser. Method for constructing JSON parser instance to parse contents of specified file.
public CBORParser	createParser(URL URL pointing to resource that contains JSON content to parse url) Overrides com.fasterxml.jackson.core.JsonFactory.createParser. Method for constructing JSON parser instance to parse contents of resource reference by given URL.
public CBORParser	createParser(InputStream InputStream to use for reading JSON content to parse in) Overrides com.fasterxml.jackson.core.JsonFactory.createParser. Method for constructing JSON parser instance to parse the contents accessed via specified input stream.
public CBORParser	createParser(byte[] data) Overrides com.fasterxml.jackson.core.JsonFactory.createParser. Method for constructing parser for parsing the contents of given byte array.
public CBORParser	createParser(byte[] Buffer that contains data to parse data, int Offset of the first data byte within buffer offset, int Length of contents to parse within buffer len) Overrides com.fasterxml.jackson.core.JsonFactory.createParser. Method for constructing parser for parsing the contents of given byte array.
public CBORFactory	disable(CBORParser.Feature f) Method for disabling specified parser features (check `CBORParser.Feature` for list of features)
public CBORFactory	disable(CBORGenerator.Feature f) Method for disabling specified generator feature (check `CBORGenerator.Feature` for list of features)
public CBORFactory	enable(CBORParser.Feature f) Method for enabling specified parser feature (check `CBORParser.Feature` for list of features)
public CBORFactory	enable(CBORGenerator.Feature f) Method for enabling specified generator features (check `CBORGenerator.Feature` for list of features)
public int	getFormatGeneratorFeatures() Overrides com.fasterxml.jackson.core.JsonFactory.getFormatGeneratorFeatures.
public String	getFormatName() Overrides com.fasterxml.jackson.core.JsonFactory.getFormatName. Method that returns short textual id identifying format this factory supports.
public int	getFormatParserFeatures() Overrides com.fasterxml.jackson.core.JsonFactory.getFormatParserFeatures.
public Class<CBORParser.Feature>	getFormatReadFeatureType() Overrides com.fasterxml.jackson.core.JsonFactory.getFormatReadFeatureType. Method for accessing kind of `FormatFeature` that a parser `JsonParser` produced by this factory would accept, if any; `null` returned if none.
public Class<CBORGenerator.Feature>	getFormatWriteFeatureType() Overrides com.fasterxml.jackson.core.JsonFactory.getFormatWriteFeatureType. Method for accessing kind of `FormatFeature` that a parser `JsonGenerator` produced by this factory would accept, if any; `null` returned if none.
public MatchStrength	hasFormat(InputAccessor acc) Overrides com.fasterxml.jackson.core.JsonFactory.hasFormat.
public final boolean	isEnabled(CBORParser.Feature f) Checked whether specified parser feature is enabled.
public final boolean	isEnabled(CBORGenerator.Feature f) Check whether specified generator feature is enabled.
protected Object	readResolve() Overrides com.fasterxml.jackson.core.JsonFactory.readResolve. Method that we need to override to actually make restoration go through constructors etc. Also: must be overridden by sub-classes as well.
public CBORFactoryBuilder	rebuild() Overrides com.fasterxml.jackson.core.JsonFactory.rebuild. Method that allows construction of differently configured factory, starting with settings of this factory.
public Version	version() Overrides com.fasterxml.jackson.core.JsonFactory.version. Implements 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).

Inherited from com.fasterxml.jackson.core.JsonFactory:: _checkInvalidCopy _copy _createContentReference _createContentReference _createContext _createNonBlockingContext _createParser _decorate _decorate _decorate _decorate _decorate _decorate _getBufferRecycler _getRecyclerPool canParseAsync canUseSchema configure configure configure createGenerator createGenerator createGenerator createGenerator createJsonGenerator createJsonGenerator createJsonGenerator createJsonParser createJsonParser createJsonParser createJsonParser createJsonParser createJsonParser createJsonParser createNonBlockingByteArrayParser createNonBlockingByteBufferParser createParser createParser createParser createParser createParser disable disable disable enable enable enable getCharacterEscapes getCodec getFactoryFeatures getGeneratorFeatures getInputDecorator getOutputDecorator getParserFeatures getRootValueSeparator hasJSONFormat isEnabled isEnabled isEnabled isEnabled isEnabled requiresCustomCodec requiresPropertyOrdering setCharacterEscapes setCodec setErrorReportConfiguration setInputDecorator setOutputDecorator setRecyclerPool setRootValueSeparator setStreamReadConstraints setStreamWriteConstraints streamReadConstraints streamWriteConstraints

_formatGeneratorFeatures	back to summary
protected int _formatGeneratorFeatures

_formatParserFeatures	back to summary
protected int _formatParserFeatures

DEFAULT_CBOR_GENERATOR_FEATURE_FLAGS	back to summary
pack-priv static final int DEFAULT_CBOR_GENERATOR_FEATURE_FLAGS Bitfield (set of flags) of all generator features that are enabled by default.

DEFAULT_CBOR_PARSER_FEATURE_FLAGS	back to summary
pack-priv static final int DEFAULT_CBOR_PARSER_FEATURE_FLAGS Bitfield (set of flags) of all parser features that are enabled by default.

FORMAT_NAME	back to summary
public static final String FORMAT_NAME Name used to identify CBOR format. (and returned by `getFormatName()`

serialVersionUID	back to summary
private static final long serialVersionUID Hides com.fasterxml.jackson.core.JsonFactory.serialVersionUID.

CBORFactory	back to summary
public CBORFactory() 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.

CBORFactory	back to summary
public CBORFactory(ObjectCodec oc)

CBORFactory	back to summary
public CBORFactory(CBORFactory src, ObjectCodec oc) Note REQUIRES at least 2.2.1 -- unfortunate intra-patch dep but seems preferable to just leaving bug be as is Since 2.2.1

CBORFactory	back to summary
protected CBORFactory(CBORFactoryBuilder b) Constructors used by `CBORFactoryBuilder` for instantiation. Since 3.0

Method Detail

_createCBORGenerator	back to summary
private final CBORGenerator _createCBORGenerator(IOContext ctxt, int stdFeat, int formatFeat, ObjectCodec codec, OutputStream out) throws IOException

_createContext	back to summary
protected IOContext _createContext(ContentReference contentRef, boolean resourceManaged) Overrides com.fasterxml.jackson.core.JsonFactory._createContext. Doc from com.fasterxml.jackson.core.JsonFactory._createContext. Overridable factory method that actually instantiates desired context object. Parameters contentRef:ContentReference Source/target reference to use for diagnostics, exception messages resourceManaged:boolean Whether input/output buffer is managed by this factory or not Returns:IOContext I/O context created Annotations @Override

_createContext

back to summary

protected IOContext _createContext(ContentReference contentRef, boolean resourceManaged)

Overrides com.fasterxml.jackson.core.JsonFactory._createContext.

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

Overridable factory method that actually instantiates desired context object.

Parameters

contentRef:ContentReference: Source/target reference to use for diagnostics, exception messages
resourceManaged:boolean: Whether input/output buffer is managed by this factory or not

Returns:IOContext

I/O context created

Annotations

@Override

_createGenerator back to summary

_createGenerator	back to summary
protected CBORGenerator _createGenerator(Writer out, IOContext ctxt) throws IOException Overrides com.fasterxml.jackson.core.JsonFactory._createGenerator. Doc from com.fasterxml.jackson.core.JsonFactory._createGenerator. Overridable factory method that actually instantiates generator for given `Writer` and context object. This method is specifically designed to remain compatible between minor versions so that sub-classes can count on it being called as expected. That is, it is part of official interface from sub-class perspective, although not a public method available to users of factory implementations. Parameters out:Writer Writer underlying writer to write generated content to ctxt:IOContext I/O context to use Returns:CBORGenerator This factory instance (to allow call chaining) Annotations @Override Exceptions IOException: if parser initialization fails due to I/O (write) problem

protected CBORGenerator _createGenerator(Writer out, IOContext ctxt) throws IOException

Overrides com.fasterxml.jackson.core.JsonFactory._createGenerator.

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

Overridable factory method that actually instantiates generator for given Writer and context object.

This method is specifically designed to remain compatible between minor versions so that sub-classes can count on it being called as expected. That is, it is part of official interface from sub-class perspective, although not a public method available to users of factory implementations.

Parameters

out:Writer: Writer underlying writer to write generated content to
ctxt:IOContext: I/O context to use

Returns:CBORGenerator

This factory instance (to allow call chaining)

Annotations

@Override

Exceptions

IOException:: if parser initialization fails due to I/O (write) problem

_createParser	back to summary
protected CBORParser _createParser(InputStream in, IOContext ctxt) throws IOException Overrides com.fasterxml.jackson.core.JsonFactory._createParser. Overridable factory method that actually instantiates desired parser. Parameters in:InputStream Doc from com.fasterxml.jackson.core.JsonFactory._createParser. InputStream to use for reading content to parse ctxt:IOContext Doc from com.fasterxml.jackson.core.JsonFactory._createParser. I/O context to use for parsing Returns:CBORParser Doc from com.fasterxml.jackson.core.JsonFactory._createParser. Parser constructed Annotations @Override Exceptions IOException: Doc from com.fasterxml.jackson.core.JsonFactory._createParser. if parser initialization fails due to I/O (read) problem

_createParser

back to summary

protected CBORParser _createParser(InputStream in, IOContext ctxt) throws IOException

Overrides com.fasterxml.jackson.core.JsonFactory._createParser.

Overridable factory method that actually instantiates desired parser.

Parameters

in:InputStream

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

InputStream to use for reading content to parse

ctxt:IOContext

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

I/O context to use for parsing

Returns:CBORParser

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

Parser constructed

Annotations

@Override

Exceptions

IOException:

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

if parser initialization fails due to I/O (read) problem

_createParser	back to summary
protected JsonParser _createParser(Reader r, IOContext ctxt) throws IOException Overrides com.fasterxml.jackson.core.JsonFactory._createParser. Overridable factory method that actually instantiates desired parser. Parameters r:Reader Doc from com.fasterxml.jackson.core.JsonFactory._createParser. Reader to use for reading content to parse ctxt:IOContext Doc from com.fasterxml.jackson.core.JsonFactory._createParser. I/O context to use for parsing Returns:JsonParser Doc from com.fasterxml.jackson.core.JsonFactory._createParser. Actual parser to use Annotations @Override Exceptions IOException: Doc from com.fasterxml.jackson.core.JsonFactory._createParser. if parser initialization fails due to I/O (read) problem

_createParser

back to summary

protected JsonParser _createParser(Reader r, IOContext ctxt) throws IOException

Overrides com.fasterxml.jackson.core.JsonFactory._createParser.

Overridable factory method that actually instantiates desired parser.

Parameters

r:Reader

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

Reader to use for reading content to parse

ctxt:IOContext

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

I/O context to use for parsing

Returns:JsonParser

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

Actual parser to use

Annotations

@Override

Exceptions

IOException:

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

if parser initialization fails due to I/O (read) problem

_createParser back to summary

_createParser	back to summary
protected JsonParser _createParser(char[] data, int offset, int len, IOContext ctxt, boolean recyclable) throws IOException Overrides com.fasterxml.jackson.core.JsonFactory._createParser. Doc from com.fasterxml.jackson.core.JsonFactory._createParser. Overridable factory method that actually instantiates parser using given `char[]` object for accessing content. Parameters data:char[] Buffer that contains content to parse offset:int Offset to the first character of data to parse len:int Number of characters within buffer to parse ctxt:IOContext I/O context to use for parsing recyclable:boolean Whether input buffer is recycled by the factory Returns:JsonParser Actual parser to use Annotations @Override Exceptions IOException: if parser initialization fails due to I/O (read) problem

protected JsonParser _createParser(char[] data, int offset, int len, IOContext ctxt, boolean recyclable) throws IOException

Overrides com.fasterxml.jackson.core.JsonFactory._createParser.

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

Overridable factory method that actually instantiates parser using given char[] object for accessing content.

Parameters

data:char[]: Buffer that contains content to parse
offset:int: Offset to the first character of data to parse
len:int: Number of characters within buffer to parse
ctxt:IOContext: I/O context to use for parsing
recyclable:boolean: Whether input buffer is recycled by the factory

Returns:JsonParser

Actual parser to use

Annotations

@Override

Exceptions

IOException:: if parser initialization fails due to I/O (read) problem

_createParser	back to summary
protected CBORParser _createParser(byte[] data, int offset, int len, IOContext ctxt) throws IOException Overrides com.fasterxml.jackson.core.JsonFactory._createParser. Overridable factory method that actually instantiates desired parser. Parameters data:byte[] Doc from com.fasterxml.jackson.core.JsonFactory._createParser. Buffer that contains content to parse offset:int Doc from com.fasterxml.jackson.core.JsonFactory._createParser. Offset to the first character of data to parse len:int Doc from com.fasterxml.jackson.core.JsonFactory._createParser. Number of characters within buffer to parse ctxt:IOContext Doc from com.fasterxml.jackson.core.JsonFactory._createParser. I/O context to use for parsing Returns:CBORParser Doc from com.fasterxml.jackson.core.JsonFactory._createParser. Actual parser to use Annotations @Override Exceptions IOException: Doc from com.fasterxml.jackson.core.JsonFactory._createParser. if parser initialization fails due to I/O (read) problem

_createParser

back to summary

protected CBORParser _createParser(byte[] data, int offset, int len, IOContext ctxt) throws IOException

Overrides com.fasterxml.jackson.core.JsonFactory._createParser.

Overridable factory method that actually instantiates desired parser.

Parameters

data:byte[]

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

Buffer that contains content to parse

offset:int

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

Offset to the first character of data to parse

len:int

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

Number of characters within buffer to parse

ctxt:IOContext

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

I/O context to use for parsing

Returns:CBORParser

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

Actual parser to use

Annotations

@Override

Exceptions

IOException:

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

if parser initialization fails due to I/O (read) problem

_createUTF8Generator back to summary

_createUTF8Generator	back to summary
protected CBORGenerator _createUTF8Generator(OutputStream out, IOContext ctxt) throws IOException Overrides com.fasterxml.jackson.core.JsonFactory._createUTF8Generator. Doc from com.fasterxml.jackson.core.JsonFactory._createUTF8Generator. Overridable factory method that actually instantiates generator for given `OutputStream` and context object, using UTF-8 encoding. This method is specifically designed to remain compatible between minor versions so that sub-classes can count on it being called as expected. That is, it is part of official interface from sub-class perspective, although not a public method available to users of factory implementations. Parameters out:OutputStream OutputStream underlying writer to write generated content to ctxt:IOContext I/O context to use Returns:CBORGenerator This factory instance (to allow call chaining) Annotations @Override Exceptions IOException: if parser initialization fails due to I/O (write) problem

protected CBORGenerator _createUTF8Generator(OutputStream out, IOContext ctxt) throws IOException

Overrides com.fasterxml.jackson.core.JsonFactory._createUTF8Generator.

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

Overridable factory method that actually instantiates generator for given OutputStream and context object, using UTF-8 encoding.

Parameters

out:OutputStream: OutputStream underlying writer to write generated content to
ctxt:IOContext: I/O context to use

Returns:CBORGenerator

This factory instance (to allow call chaining)

Annotations

@Override

Exceptions

IOException:: if parser initialization fails due to I/O (write) problem

_createWriter	back to summary
protected Writer _createWriter(OutputStream out, JsonEncoding enc, IOContext ctxt) throws IOException Overrides com.fasterxml.jackson.core.JsonFactory._createWriter. Annotations @Override

_createWriter

back to summary

protected Writer _createWriter(OutputStream out, JsonEncoding enc, IOContext ctxt) throws IOException

Overrides com.fasterxml.jackson.core.JsonFactory._createWriter.

Annotations

@Override

_nonByteSource	back to summary
protected <T> T _nonByteSource()

_nonByteTarget	back to summary
protected <T> T _nonByteTarget()

builder back to summary

builder	back to summary
public static CBORFactoryBuilder builder() Hides com.fasterxml.jackson.core.JsonFactory.builder. Main factory method to use for constructing `CBORFactory` instances with different configuration. Returns:CBORFactoryBuilder Doc from com.fasterxml.jackson.core.JsonFactory.builder. Builder instance to use

public static CBORFactoryBuilder builder()

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

Main factory method to use for constructing CBORFactory instances with different configuration.

Returns:CBORFactoryBuilder

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

Builder instance to use

canHandleBinaryNatively back to summary

canHandleBinaryNatively	back to summary
public boolean canHandleBinaryNatively() 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

public boolean canHandleBinaryNatively()

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

canUseCharArrays back to summary

canUseCharArrays	back to summary
public boolean canUseCharArrays() Overrides com.fasterxml.jackson.core.JsonFactory.canUseCharArrays. Doc from com.fasterxml.jackson.core.JsonFactory.canUseCharArrays. Introspection method that can be used by base factory to check whether access using `char[]` is something that actual parser implementations can take advantage of, over having to use `java.io.Reader`. Sub-types are expected to override definition; default implementation (suitable for JSON) alleges that optimization are possible; and thereby is likely to try to access `java.lang.String` content by first copying it into recyclable intermediate buffer. Returns:boolean Whether access to decoded textual content can be efficiently accessed using parser method `getTextCharacters()`. Annotations @Override

public boolean canUseCharArrays()

Overrides com.fasterxml.jackson.core.JsonFactory.canUseCharArrays.

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

Introspection method that can be used by base factory to check whether access using char[] is something that actual parser implementations can take advantage of, over having to use java.io.Reader. Sub-types are expected to override definition; default implementation (suitable for JSON) alleges that optimization are possible; and thereby is likely to try to access java.lang.String content by first copying it into recyclable intermediate buffer.

Returns:boolean

Whether access to decoded textual content can be efficiently accessed using parser method getTextCharacters().

Annotations

@Override

configure	back to summary
public final CBORFactory configure(CBORParser.Feature f, boolean state) Method for enabling or disabling specified parser feature (check `CBORParser.Feature` for list of features)

configure	back to summary
public final CBORFactory configure(CBORGenerator.Feature f, boolean state) Method for enabling or disabling specified generator feature (check `CBORGenerator.Feature` for list of features)

copy back to summary

copy	back to summary
public CBORFactory copy() 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:CBORFactory Copy of this factory instance Annotations @Override

public CBORFactory copy()

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:CBORFactory

Copy of this factory instance

Annotations

@Override

createGenerator back to summary

createGenerator	back to summary
public CBORGenerator createGenerator(OutputStream out, JsonEncoding enc) throws IOException Overrides com.fasterxml.jackson.core.JsonFactory.createGenerator. Method for constructing `JsonGenerator` for generating CBOR-encoded output. Since CBOR format always uses UTF-8 internally, `enc` argument is ignored. 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

public CBORGenerator createGenerator(OutputStream out, JsonEncoding enc) throws IOException

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

Method for constructing JsonGenerator for generating CBOR-encoded output.

Since CBOR format always uses UTF-8 internally, enc argument is ignored.

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

createGenerator back to summary

createGenerator	back to summary
public CBORGenerator createGenerator(OutputStream out) throws IOException Overrides com.fasterxml.jackson.core.JsonFactory.createGenerator. Method for constructing `JsonGenerator` for generating CBOR-encoded output. Since CBOR format always uses UTF-8 internally, no encoding need to be passed to this method. Annotations @Override

public CBORGenerator createGenerator(OutputStream out) throws IOException

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

Method for constructing JsonGenerator for generating CBOR-encoded output.

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

Annotations

@Override

createParser back to summary

createParser	back to summary
public CBORParser createParser(File f) throws IOException 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

public CBORParser createParser(File f) throws IOException

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

createParser back to summary

createParser	back to summary
public CBORParser createParser(URL url) throws IOException 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

public CBORParser createParser(URL url) throws IOException

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.

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

createParser back to summary

createParser	back to summary
public CBORParser createParser(InputStream in) throws IOException 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. Note no encoding argument is taken since it can always be auto-detected as suggested by JSON RFC. 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)`. Parameters in:InputStream InputStream to use for reading JSON content to parse Annotations @Override

public CBORParser createParser(InputStream in) throws IOException

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.

Note

no encoding argument is taken since it can always be auto-detected as suggested by JSON RFC. 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).

Parameters

in:InputStream: InputStream to use for reading JSON content to parse

Annotations

@Override

createParser	back to summary
public CBORParser createParser(byte[] data) throws IOException 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

createParser

back to summary

public CBORParser createParser(byte[] data) throws IOException

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

createParser	back to summary
public CBORParser createParser(byte[] data, int offset, int len) throws IOException 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

createParser

back to summary

public CBORParser createParser(byte[] data, int offset, int len) throws IOException

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

disable	back to summary
public CBORFactory disable(CBORParser.Feature f) Method for disabling specified parser features (check `CBORParser.Feature` for list of features)

disable	back to summary
public CBORFactory disable(CBORGenerator.Feature f) Method for disabling specified generator feature (check `CBORGenerator.Feature` for list of features)

enable	back to summary
public CBORFactory enable(CBORParser.Feature f) Method for enabling specified parser feature (check `CBORParser.Feature` for list of features)

enable	back to summary
public CBORFactory enable(CBORGenerator.Feature f) Method for enabling specified generator features (check `CBORGenerator.Feature` for list of features)

getFormatGeneratorFeatures	back to summary
public int getFormatGeneratorFeatures() Overrides com.fasterxml.jackson.core.JsonFactory.getFormatGeneratorFeatures. Annotations @Override

getFormatGeneratorFeatures

back to summary

public int getFormatGeneratorFeatures()

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

Annotations

@Override

getFormatName	back to summary
public String getFormatName() 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. Note sub-classes should override this method; default implementation will return null for all sub-classes Returns:String Name of the format handled by parsers, generators this factory creates Annotations @Override

getFormatName

back to summary

public String getFormatName()

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.

Note

sub-classes should override this method; default implementation will return null for all sub-classes

Returns:String

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

Annotations

@Override

getFormatParserFeatures	back to summary
public int getFormatParserFeatures() Overrides com.fasterxml.jackson.core.JsonFactory.getFormatParserFeatures. Annotations @Override

getFormatParserFeatures

back to summary

public int getFormatParserFeatures()

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

Annotations

@Override

getFormatReadFeatureType back to summary

getFormatReadFeatureType	back to summary
public Class<CBORParser.Feature> getFormatReadFeatureType() Overrides com.fasterxml.jackson.core.JsonFactory.getFormatReadFeatureType. Doc from com.fasterxml.jackson.core.TokenStreamFactory.getFormatReadFeatureType. Method for accessing kind of `FormatFeature` that a parser `JsonParser` produced by this factory would accept, if any; `null` returned if none. Returns:Class<CBORParser.Feature> Type of format-specific stream read features, if any; `null` if none Annotations @Override

public Class<CBORParser.Feature> getFormatReadFeatureType()

Overrides com.fasterxml.jackson.core.JsonFactory.getFormatReadFeatureType.

Doc from com.fasterxml.jackson.core.TokenStreamFactory.getFormatReadFeatureType.

Method for accessing kind of FormatFeature that a parser JsonParser produced by this factory would accept, if any; null returned if none.

Returns:Class<CBORParser.Feature>

Type of format-specific stream read features, if any; null if none

Annotations

@Override

getFormatWriteFeatureType back to summary

getFormatWriteFeatureType	back to summary
public Class<CBORGenerator.Feature> getFormatWriteFeatureType() Overrides com.fasterxml.jackson.core.JsonFactory.getFormatWriteFeatureType. Doc from com.fasterxml.jackson.core.TokenStreamFactory.getFormatWriteFeatureType. Method for accessing kind of `FormatFeature` that a parser `JsonGenerator` produced by this factory would accept, if any; `null` returned if none. Returns:Class<CBORGenerator.Feature> Type of format-specific stream read features, if any; `null` if none Annotations @Override

public Class<CBORGenerator.Feature> getFormatWriteFeatureType()

Overrides com.fasterxml.jackson.core.JsonFactory.getFormatWriteFeatureType.

Doc from com.fasterxml.jackson.core.TokenStreamFactory.getFormatWriteFeatureType.

Method for accessing kind of FormatFeature that a parser JsonGenerator produced by this factory would accept, if any; null returned if none.

Returns:Class<CBORGenerator.Feature>

Type of format-specific stream read features, if any; null if none

Annotations

@Override

hasFormat	back to summary
public MatchStrength hasFormat(InputAccessor acc) throws IOException Overrides com.fasterxml.jackson.core.JsonFactory.hasFormat. Annotations @Override

hasFormat

back to summary

public MatchStrength hasFormat(InputAccessor acc) throws IOException

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

Annotations

@Override

isEnabled	back to summary
public final boolean isEnabled(CBORParser.Feature f) Checked whether specified parser feature is enabled.

isEnabled	back to summary
public final boolean isEnabled(CBORGenerator.Feature f) Check whether specified generator feature is enabled.

readResolve	back to summary
protected Object readResolve() Overrides com.fasterxml.jackson.core.JsonFactory.readResolve. Method that we need to override to actually make restoration go through constructors etc. Also: must be overridden by sub-classes as well. Returns:Object Doc from com.fasterxml.jackson.core.JsonFactory.readResolve. Newly constructed instance Annotations @Override

readResolve

back to summary

protected Object readResolve()

Overrides com.fasterxml.jackson.core.JsonFactory.readResolve.

Method that we need to override to actually make restoration go through constructors etc. Also: must be overridden by sub-classes as well.

Returns:Object

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

Newly constructed instance

Annotations

@Override

rebuild

back to summary

public CBORFactoryBuilder rebuild()

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:CBORFactoryBuilder

Builder instance to use

Annotations

@Override

version back to summary

public Version version()

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

public Class CBORFactory

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail