Package org.apache.juneau.marshall.cbor

Class CborParser

java.lang.Object

org.apache.juneau.marshall.Context

org.apache.juneau.marshall.MarshallingContextable

org.apache.juneau.marshall.parser.Parser

org.apache.juneau.marshall.parser.InputStreamParser

org.apache.juneau.marshall.cbor.CborParser

All Implemented Interfaces:

CborMetaProvider, ArrayRecordReadable, RecordReadable, TokenReadable

Direct Known Subclasses:

CborParser.Base64, CborParser.SpacedHex

public class CborParser
extends InputStreamParser
implements CborMetaProvider, TokenReadable, ArrayRecordReadable

Parses CBOR streams (RFC 8949) into POJO models.

Media types

Handles Content-Type types: application/cbor

Description

CBOR-to-Java type mapping:

• CBOR map (major type 5) → bean or Map
• CBOR array (major type 4) → Collection or Java array
• CBOR text string (major type 3) → String; coerced to types parseable from string
• CBOR unsigned/negative integer (major types 0/1) → Integer or Long
• CBOR float (major type 7, 0xFA/0xFB) → Float or Double
• CBOR half-precision float (major type 7, 0xF9) → Float (converted)
• CBOR boolean (major type 7, 0xF4/0xF5) → Boolean
• CBOR null (major type 7, 0xF6) → null
• CBOR byte string (major type 2) → byte[]
• CBOR semantic tag (major type 6) → tag ignored; tagged value parsed normally

Round-trip notes:

• Integers (major types 0/1) surface by target type: a BigInteger field carries the full unsigned-64-bit magnitude; any other numeric type keeps the raw 64-bit bits as a long.
• BigInteger / BigDecimal round-trip losslessly (big integers decode from native CBOR integers or, beyond ±2^64, from their decimal string; BigDecimal decodes from its decimal string).
• Indefinite-length CBOR (RFC 8949 §3.2) is supported: arrays, maps, and chunked text/byte strings all decode.
• Semantic tags are read and discarded on the databind path; tag number does not affect parsed type. Enable nativeMode to surface tags/simple values on the TokenReader cursor.

Notes:

• This class is thread safe and reusable.

See Also:

• CBOR
• RFC 8949

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CborParser.Base64	Default parser, string input encoded as BASE64.
static class	CborParser.Builder	Builder class.
static class	CborParser.SpacedHex	Default parser, string input encoded as spaced-hex.

Nested classes/interfaces inherited from class org.apache.juneau.marshall.parser.InputStreamParser

InputStreamParser.DefaultBuilder

Nested classes/interfaces inherited from class org.apache.juneau.marshall.parser.Parser

Parser.Null

Field Summary

Fields

Modifier and Type	Field	Description
static final CborParser	DEFAULT	Default parser, all default settings.
static final CborParser	DEFAULT_BASE64	Default parser, string input encoded as BASE64.
static final CborParser	DEFAULT_NATIVE	Default parser with binary-native opt-in mode enabled (CBOR tags / simple values surface as token-level metadata).
static final CborParser	DEFAULT_SPACED_HEX	Default parser, string input encoded as spaced-hex.
protected final boolean	nativeMode

Fields inherited from class org.apache.juneau.marshall.parser.Parser

autoCloseStreams, consumes, debugOutputLines, listener, nulls, trimStrings, unbuffered

Fields inherited from class org.apache.juneau.marshall.MarshallingContextable

marshallingContext

Fields inherited from class org.apache.juneau.marshall.Context

CONTEXT_APPLY_FILTER

Constructor Summary

Constructors

Constructor	Description
CborParser(CborParser.Builder builder)	Constructor.

Method Summary

Modifier and Type	Method	Description
CborParser.Builder	copy()	Creates a builder from this context object.
static CborParser.Builder	create()	Creates a new builder for this object.
CborParserSession.Builder	createSession()	Create a session builder based on the properties defined on this context.
CborBeanPropertyMeta	getCborBeanPropertyMeta(BeanPropertyMeta bpm)	Returns the language-specific metadata on the specified bean property.
CborClassMeta	getCborClassMeta(ClassMeta<?> cm)	Returns the language-specific metadata on the specified class.
int	getMaxLength()	Returns the maximum allowed wire-declared length for byte/text strings and array/map element counts.
CborParserSession	getSession()	Returns a session to use for this context.
boolean	isNativeMode()	Returns true if token-cursor native mode is enabled.
protected FluentMap<String,Object>	properties()	Returns the properties on this bean as a map for debugging.
RecordReader	readArrayRecords(Object input)	Convenience delegator for the streaming array-element RecordReader (uses default session args; see readTokens(Object)).
TokenReader	readTokens(Object input)	Convenience delegator that opens a CborTokenReader over the input using default session arguments (mirrors Parser.read(Object, Class)).

Methods inherited from class org.apache.juneau.marshall.parser.InputStreamParser

getBinaryFormat, isReaderParser

Methods inherited from class org.apache.juneau.marshall.parser.Parser

canHandle, createParserBuilder, doRead, getDebugOutputLines, getListener, getMediaTypes, getNulls, getPrimaryMediaType, isAutoCloseStreams, isTrimStrings, isUnbuffered, read, read, read, read, read, read, readArgs, readIntoCollection, readIntoMap, readWithOuter

Methods inherited from class org.apache.juneau.marshall.MarshallingContextable

getDurationFormat, getMarshallingContext, getPeriodFormat

Methods inherited from class org.apache.juneau.marshall.Context

createBuilder, getAnnotationProvider, init, isDebug, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.juneau.marshall.stream.ArrayRecordReadable

isArrayRecordStreaming, readArrayRecords

Methods inherited from interface org.apache.juneau.marshall.stream.RecordReadable

isRecordStreaming

Methods inherited from interface org.apache.juneau.marshall.stream.TokenReadable

readRecords

Field Details

DEFAULT

public static final CborParser DEFAULT

Default parser, all default settings.

DEFAULT_NATIVE

public static final CborParser DEFAULT_NATIVE

Default parser with binary-native opt-in mode enabled (CBOR tags / simple values surface as token-level metadata).

DEFAULT_SPACED_HEX

public static final CborParser DEFAULT_SPACED_HEX

Default parser, string input encoded as spaced-hex.

DEFAULT_BASE64

public static final CborParser DEFAULT_BASE64

Default parser, string input encoded as BASE64.

nativeMode

protected final boolean nativeMode

Constructor Details

CborParser

public CborParser(CborParser.Builder builder)

Constructor.

Parameters:

builder - The builder for this object.

Method Details

create

public static CborParser.Builder create()

Creates a new builder for this object.

Returns:

A new builder.

isNativeMode

public boolean isNativeMode()

Returns true if token-cursor native mode is enabled.

Returns:

true if native mode is enabled, else false.

getMaxLength

public int getMaxLength()

Returns the maximum allowed wire-declared length for byte/text strings and array/map element counts.

Returns:

The maximum length.

copy

public CborParser.Builder copy()

Description copied from class: Context

Creates a builder from this context object.

Builders are used to define new contexts (e.g. serializers, parsers) based on existing configurations.

Overrides:

copy in class Parser

Returns:

A new Builder object.

createSession

public CborParserSession.Builder createSession()

Description copied from class: Context

Create a session builder based on the properties defined on this context.

Use this method for creating sessions where you want to override basic settings. Otherwise, use Context.getSession() directly.

Overrides:

createSession in class InputStreamParser

Returns:

A new session builder.

getCborBeanPropertyMeta

public CborBeanPropertyMeta getCborBeanPropertyMeta(BeanPropertyMeta bpm)

Description copied from interface: CborMetaProvider

Returns the language-specific metadata on the specified bean property.

Specified by:

getCborBeanPropertyMeta in interface CborMetaProvider

Parameters:

bpm - The bean property to return the metadata on.

Returns:

The metadata.

getCborClassMeta

public CborClassMeta getCborClassMeta(ClassMeta<?> cm)

Description copied from interface: CborMetaProvider

Returns the language-specific metadata on the specified class.

Specified by:

getCborClassMeta in interface CborMetaProvider

Parameters:

cm - The class to return the metadata on.

Returns:

The metadata.

getSession

public CborParserSession getSession()

Description copied from class: Context

Returns a session to use for this context.

Note that subclasses may opt to return a reusable non-modifiable session.

Overrides:

getSession in class InputStreamParser

Returns:

A new session object.

readTokens

public TokenReader readTokens(Object input)
                       throws IOException

Convenience delegator that opens a CborTokenReader over the input using default session arguments (mirrors Parser.read(Object, Class)).

The real implementation lives on CborParserSession.readTokens(Object). Callers that need request-derived configuration (locale, timezone, schema, swaps) should call createSession() and invoke CborParserSession.readTokens(Object) on the built session instead.

Specified by:

readTokens in interface TokenReadable

Parameters:

input - The input.

Returns:

A new CborTokenReader.

Throws:

IOException - If a problem occurred opening the underlying input.

readArrayRecords

public RecordReader readArrayRecords(Object input)
                              throws IOException

Convenience delegator for the streaming array-element RecordReader (uses default session args; see readTokens(Object)). Real impl on CborParserSession.readArrayRecords(Object).

Specified by:

readArrayRecords in interface ArrayRecordReadable

Parameters:

input - The input.

Returns:

A new element-streamed RecordReader.

Throws:

IOException - If a problem occurred opening the underlying input.

properties

protected FluentMap<String,Object> properties()

Description copied from class: Context

Returns the properties on this bean as a map for debugging.

Overrides:

properties in class Parser

Returns:

The properties on this bean as a map for debugging.