Top Description Fields Constructors Methods
com.fasterxml.jackson.dataformat.cbor

public Class CBORFactory

extends JsonFactory
Class Inheritance
Imports
java.io.*, java.net.URL, com.fasterxml.jackson.core.*, com.fasterxml.jackson.core.format.InputAccessor, .MatchStrength, com.fasterxml.jackson.core.io.IOContext, .ContentReference
Factory used for constructing CBORParser and CBORGenerator instances; both of which handle CBOR encoded data.

Extends JsonFactory mostly so that users can actually use it in place of regular non-CBOR factory instances.

Note on using non-byte-based sources/targets (char based, like java.io.Reader and java.io.Writer): these can not be used for CBOR documents; attempt will throw exception.

Author
Tatu Saloranta

Field Summary

Modifier and TypeField 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.

Inherited from com.fasterxml.jackson.core.JsonFactory:
_byteSymbolCanonicalizer_characterEscapes_errorReportConfiguration_factoryFeatures_generatorDecorators_generatorFeatures_inputDecorator_maximumNonEscapedChar_objectCodec_outputDecorator_parserFeatures_quoteChar_recyclerPool_rootCharSymbols_rootValueSeparator_streamReadConstraints_streamWriteConstraintsDEFAULT_FACTORY_FEATURE_FLAGSDEFAULT_GENERATOR_FEATURE_FLAGSDEFAULT_PARSER_FEATURE_FLAGSDEFAULT_QUOTE_CHARDEFAULT_ROOT_VALUE_SEPARATORFORMAT_NAME_JSON

Constructor Summary

AccessConstructor 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 TypeMethod 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_getRecyclerPoolcanParseAsynccanUseSchemaconfigureconfigureconfigurecreateGeneratorcreateGeneratorcreateGeneratorcreateGeneratorcreateJsonGeneratorcreateJsonGeneratorcreateJsonGeneratorcreateJsonParsercreateJsonParsercreateJsonParsercreateJsonParsercreateJsonParsercreateJsonParsercreateJsonParsercreateNonBlockingByteArrayParsercreateNonBlockingByteBufferParsercreateParsercreateParsercreateParsercreateParsercreateParserdisabledisabledisableenableenableenablegetCharacterEscapesgetCodecgetFactoryFeaturesgetGeneratorFeaturesgetInputDecoratorgetOutputDecoratorgetParserFeaturesgetRootValueSeparatorhasJSONFormatisEnabledisEnabledisEnabledisEnabledisEnabledrequiresCustomCodecrequiresPropertyOrderingsetCharacterEscapessetCodecsetErrorReportConfigurationsetInputDecoratorsetOutputDecoratorsetRecyclerPoolsetRootValueSeparatorsetStreamReadConstraintssetStreamWriteConstraintsstreamReadConstraintsstreamWriteConstraints