Jackson 3.0.1 · tools.jackson.dataformat.cbor.CBORFactory

Modifier and Type	Field and Description
protected final transient ByteQuadsCanonicalizer	_byteSymbolCanonicalizer Alternative to the basic symbol table, some stream-based parsers use different name canonicalization method.
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 generator features that are enabled by default.
public static final String	FORMAT_NAME Name used to identify CBOR format.
private static final long	serialVersionUID Hides tools.jackson.core.base.BinaryTSFactory.serialVersionUID.

Access	Constructor and Description
public	CBORFactory() Default constructor used to create factory instances.
public	CBORFactory(CBORFactory src)
protected	CBORFactory(CBORFactoryBuilder b) Constructors used by `CBORFactoryBuilder` for instantiation.

Method Summary

Modifier and Type	Method and Description
protected IOContext	_createContext(ContentReference contentRef, boolean resourceManaged) Overrides tools.jackson.core.TokenStreamFactory._createContext. Overridable factory method that actually instantiates desired context object.
protected JsonGenerator	_createGenerator(ObjectWriteContext writeCtxt, IOContext ioCtxt, OutputStream out) Implements abstract tools.jackson.core.base.BinaryTSFactory._createGenerator. Overridable factory method that actually instantiates generator for given `OutputStream` and context object, using UTF-8 encoding.
protected CBORParser	_createParser(ObjectReadContext readCtxt, IOContext ioCtxt, InputStream in) Implements abstract tools.jackson.core.base.BinaryTSFactory._createParser. Overridable factory method that actually instantiates desired parser.
protected CBORParser	_createParser(ObjectReadContext readCtxt, IOContext ioCtxt, byte[] data, int offset, int len) Implements abstract tools.jackson.core.base.BinaryTSFactory._createParser. Overridable factory method that actually instantiates desired parser.
protected JsonParser	_createParser(ObjectReadContext readCtxt, IOContext ctxt, DataInput input) Implements abstract tools.jackson.core.base.BinaryTSFactory._createParser.
public static CBORFactoryBuilder	builder() Main factory method to use for constructing `CBORFactory` instances with different configuration.
public boolean	canParseAsync() Implements abstract tools.jackson.core.TokenStreamFactory.canParseAsync. Introspection method that can be used to check whether this factory can create non-blocking parsers: parsers that do not use blocking I/O abstractions but instead use a `tools.jackson.core.async.NonBlockingInputFeeder`.
public boolean	canUseSchema(FormatSchema schema) Implements abstract tools.jackson.core.TokenStreamFactory.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.
public PropertyNameMatcher	constructCINameMatcher(List<Named> matches, boolean alreadyInterned, Locale locale) Overrides tools.jackson.core.TokenStreamFactory.constructCINameMatcher. Factory method for constructing case-insensitive `PropertyNameMatcher` for given names.
public PropertyNameMatcher	constructNameMatcher(List<Named> matches, boolean alreadyInterned) Overrides tools.jackson.core.TokenStreamFactory.constructNameMatcher. Factory method for constructing case-sensitive `PropertyNameMatcher` for given names.
public CBORFactory	copy() Implements abstract tools.jackson.core.TokenStreamFactory.copy. Method similar to `snapshot()`, but one that forces creation of actual new copy that does NOT share any state, even non-visible to calling code, such as symbol table reuse.
public String	getFormatName() Implements abstract tools.jackson.core.TokenStreamFactory.getFormatName. Method that returns short textual id identifying format this factory supports.
public Class<CBORReadFeature>	getFormatReadFeatureType() Overrides tools.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.
public Class<CBORWriteFeature>	getFormatWriteFeatureType() Overrides tools.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.
public boolean	isEnabled(CBORReadFeature f) Check whether specified CBOR-specific stream read feature is enabled.
public boolean	isEnabled(CBORWriteFeature f) Check whether specified CBOR-specific stream write feature is enabled.
protected Object	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() Implements abstract tools.jackson.core.TokenStreamFactory.rebuild. Method that can be used to create differently configured stream factories: it will create and return a Builder instance with exact settings of this stream factory.
public TokenStreamFactory	snapshot() Implements abstract tools.jackson.core.TokenStreamFactory.snapshot. Implements tools.jackson.core.util.Snapshottable.snapshot. Instances are immutable so just return `this`
public Version	version() Implements abstract tools.jackson.core.TokenStreamFactory.version. Implements tools.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 tools.jackson.core.base.BinaryTSFactory:: _createContentReference _createContentReference _nonByteSource _nonByteTarget canHandleBinaryNatively createGenerator createGenerator createGenerator createGenerator createParser createParser createParser createParser createParser createParser createParser createParser

_byteSymbolCanonicalizer	back to summary
protected final transient ByteQuadsCanonicalizer _byteSymbolCanonicalizer Alternative to the basic symbol table, some stream-based parsers use different name canonicalization method.

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 generator 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 tools.jackson.core.base.BinaryTSFactory.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(CBORFactory src)

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

Method Detail

_createContext	back to summary
protected IOContext _createContext(ContentReference contentRef, boolean resourceManaged) Overrides tools.jackson.core.TokenStreamFactory._createContext. Doc from tools.jackson.core.TokenStreamFactory._createContext. Overridable factory method that actually instantiates desired context object. Annotations @Override

_createContext

back to summary

protected IOContext _createContext(ContentReference contentRef, boolean resourceManaged)

Overrides tools.jackson.core.TokenStreamFactory._createContext.

Doc from tools.jackson.core.TokenStreamFactory._createContext.

Overridable factory method that actually instantiates desired context object.

Annotations

@Override

_createGenerator back to summary

_createGenerator	back to summary
protected JsonGenerator _createGenerator(ObjectWriteContext writeCtxt, IOContext ioCtxt, OutputStream out) Implements abstract tools.jackson.core.base.BinaryTSFactory._createGenerator. Doc from tools.jackson.core.base.BinaryTSFactory._createGenerator. 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. Annotations @Override

protected JsonGenerator _createGenerator(ObjectWriteContext writeCtxt, IOContext ioCtxt, OutputStream out)

Implements abstract tools.jackson.core.base.BinaryTSFactory._createGenerator.

Doc from tools.jackson.core.base.BinaryTSFactory._createGenerator.

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.

Annotations

@Override

_createParser	back to summary
protected CBORParser _createParser(ObjectReadContext readCtxt, IOContext ioCtxt, InputStream in) Implements abstract tools.jackson.core.base.BinaryTSFactory._createParser. Overridable factory method that actually instantiates desired parser. Annotations @Override

_createParser

back to summary

protected CBORParser _createParser(ObjectReadContext readCtxt, IOContext ioCtxt, InputStream in)

Implements abstract tools.jackson.core.base.BinaryTSFactory._createParser.

Overridable factory method that actually instantiates desired parser.

Annotations

@Override

_createParser	back to summary
protected CBORParser _createParser(ObjectReadContext readCtxt, IOContext ioCtxt, byte[] data, int offset, int len) Implements abstract tools.jackson.core.base.BinaryTSFactory._createParser. Overridable factory method that actually instantiates desired parser. Annotations @Override

_createParser

back to summary

protected CBORParser _createParser(ObjectReadContext readCtxt, IOContext ioCtxt, byte[] data, int offset, int len)

Implements abstract tools.jackson.core.base.BinaryTSFactory._createParser.

Overridable factory method that actually instantiates desired parser.

Annotations

@Override

_createParser	back to summary
protected JsonParser _createParser(ObjectReadContext readCtxt, IOContext ctxt, DataInput input) Implements abstract tools.jackson.core.base.BinaryTSFactory._createParser. Annotations @Override

_createParser

back to summary

protected JsonParser _createParser(ObjectReadContext readCtxt, IOContext ctxt, DataInput input)

Implements abstract tools.jackson.core.base.BinaryTSFactory._createParser.

Annotations

@Override

builder	back to summary
public static CBORFactoryBuilder builder() Main factory method to use for constructing `CBORFactory` instances with different configuration.

canParseAsync back to summary

canParseAsync	back to summary
public boolean canParseAsync() Implements abstract tools.jackson.core.TokenStreamFactory.canParseAsync. Doc from tools.jackson.core.TokenStreamFactory.canParseAsync. Introspection method that can be used to check whether this factory can create non-blocking parsers: parsers that do not use blocking I/O abstractions but instead use a `tools.jackson.core.async.NonBlockingInputFeeder`. Annotations @Override

public boolean canParseAsync()

Implements abstract tools.jackson.core.TokenStreamFactory.canParseAsync.

Doc from tools.jackson.core.TokenStreamFactory.canParseAsync.

Introspection method that can be used to check whether this factory can create non-blocking parsers: parsers that do not use blocking I/O abstractions but instead use a tools.jackson.core.async.NonBlockingInputFeeder.

Annotations

@Override

canUseSchema	back to summary
public boolean canUseSchema(FormatSchema schema) Implements abstract tools.jackson.core.TokenStreamFactory.canUseSchema. Doc from tools.jackson.core.TokenStreamFactory.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. Annotations @Override

canUseSchema

back to summary

public boolean canUseSchema(FormatSchema schema)

Implements abstract tools.jackson.core.TokenStreamFactory.canUseSchema.

Doc from tools.jackson.core.TokenStreamFactory.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.

Annotations

@Override

constructCINameMatcher back to summary

constructCINameMatcher	back to summary
public PropertyNameMatcher constructCINameMatcher(List<Named> matches, boolean alreadyInterned, Locale locale) Overrides tools.jackson.core.TokenStreamFactory.constructCINameMatcher. Doc from tools.jackson.core.TokenStreamFactory.constructCINameMatcher. Factory method for constructing case-insensitive `PropertyNameMatcher` for given names. It will call `String#intern` on names unless specified that this has already been done by caller. Annotations @Override

public PropertyNameMatcher constructCINameMatcher(List<Named> matches, boolean alreadyInterned, Locale locale)

Overrides tools.jackson.core.TokenStreamFactory.constructCINameMatcher.

Doc from tools.jackson.core.TokenStreamFactory.constructCINameMatcher.

Factory method for constructing case-insensitive PropertyNameMatcher for given names. It will call String#intern on names unless specified that this has already been done by caller.

Annotations

@Override

constructNameMatcher back to summary

constructNameMatcher	back to summary
public PropertyNameMatcher constructNameMatcher(List<Named> matches, boolean alreadyInterned) Overrides tools.jackson.core.TokenStreamFactory.constructNameMatcher. Doc from tools.jackson.core.TokenStreamFactory.constructNameMatcher. Factory method for constructing case-sensitive `PropertyNameMatcher` for given names. It will call `String#intern` on names unless specified that this has already been done by caller. Annotations @Override

public PropertyNameMatcher constructNameMatcher(List<Named> matches, boolean alreadyInterned)

Overrides tools.jackson.core.TokenStreamFactory.constructNameMatcher.

Doc from tools.jackson.core.TokenStreamFactory.constructNameMatcher.

Factory method for constructing case-sensitive PropertyNameMatcher for given names. It will call String#intern on names unless specified that this has already been done by caller.

Annotations

@Override

copy back to summary

copy	back to summary
public CBORFactory copy() Implements abstract tools.jackson.core.TokenStreamFactory.copy. Doc from tools.jackson.core.TokenStreamFactory.copy. Method similar to `snapshot()`, but one that forces creation of actual new copy that does NOT share any state, even non-visible to calling code, such as symbol table reuse. Implementation should be functionally equivalent to: factoryInstance.rebuild().build(); Annotations @Override

public CBORFactory copy()

Implements abstract tools.jackson.core.TokenStreamFactory.copy.

Doc from tools.jackson.core.TokenStreamFactory.copy.

Method similar to snapshot(), but one that forces creation of actual new copy that does NOT share any state, even non-visible to calling code, such as symbol table reuse.

Implementation should be functionally equivalent to:

    factoryInstance.rebuild().build();

Annotations

@Override

getFormatName	back to summary
public String getFormatName() Implements abstract tools.jackson.core.TokenStreamFactory.getFormatName. Doc from tools.jackson.core.TokenStreamFactory.getFormatName. Method that returns short textual id identifying format this factory supports. Annotations @Override

getFormatName

back to summary

public String getFormatName()

Implements abstract tools.jackson.core.TokenStreamFactory.getFormatName.

Doc from tools.jackson.core.TokenStreamFactory.getFormatName.

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

Annotations

@Override

getFormatReadFeatureType back to summary

getFormatReadFeatureType	back to summary
public Class<CBORReadFeature> getFormatReadFeatureType() Overrides tools.jackson.core.TokenStreamFactory.getFormatReadFeatureType. Doc from tools.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. Annotations @Override

public Class<CBORReadFeature> getFormatReadFeatureType()

Overrides tools.jackson.core.TokenStreamFactory.getFormatReadFeatureType.

Doc from tools.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.

Annotations

@Override

getFormatWriteFeatureType back to summary

getFormatWriteFeatureType	back to summary
public Class<CBORWriteFeature> getFormatWriteFeatureType() Overrides tools.jackson.core.TokenStreamFactory.getFormatWriteFeatureType. Doc from tools.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. Annotations @Override

public Class<CBORWriteFeature> getFormatWriteFeatureType()

Overrides tools.jackson.core.TokenStreamFactory.getFormatWriteFeatureType.

Doc from tools.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.

Annotations

@Override

isEnabled	back to summary
public boolean isEnabled(CBORReadFeature f) Check whether specified CBOR-specific stream read feature is enabled.

isEnabled	back to summary
public boolean isEnabled(CBORWriteFeature f) Check whether specified CBOR-specific stream write feature is enabled.

readResolve	back to summary
protected Object readResolve() Method that we need to override to actually make restoration go through constructors etc. Also: must be overridden by sub-classes as well.

rebuild	back to summary
public CBORFactoryBuilder rebuild() Implements abstract tools.jackson.core.TokenStreamFactory.rebuild. Doc from tools.jackson.core.TokenStreamFactory.rebuild. Method that can be used to create differently configured stream factories: it will create and return a Builder instance with exact settings of this stream factory. Annotations @Override

rebuild

back to summary

public CBORFactoryBuilder rebuild()

Implements abstract tools.jackson.core.TokenStreamFactory.rebuild.

Doc from tools.jackson.core.TokenStreamFactory.rebuild.

Method that can be used to create differently configured stream factories: it will create and return a Builder instance with exact settings of this stream factory.

Annotations

@Override

snapshot	back to summary
public TokenStreamFactory snapshot() Implements abstract tools.jackson.core.TokenStreamFactory.snapshot. Implements tools.jackson.core.util.Snapshottable.snapshot. Instances are immutable so just return `this` Annotations @Override

snapshot

back to summary

public TokenStreamFactory snapshot()

Implements abstract tools.jackson.core.TokenStreamFactory.snapshot.

Implements tools.jackson.core.util.Snapshottable.snapshot.

Instances are immutable so just return `this`

Annotations

@Override

version back to summary

version	back to summary
public Version version() Implements abstract tools.jackson.core.TokenStreamFactory.version. Implements tools.jackson.core.Versioned.version. Doc from tools.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). Annotations @Override

public Version version()

Implements abstract tools.jackson.core.TokenStreamFactory.version.

Implements tools.jackson.core.Versioned.version.

Doc from tools.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).

Annotations

@Override

public Class CBORFactory

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail