Package org.apache.juneau.marshall.cbor

Class CborParser.Builder

java.lang.Object

org.apache.juneau.marshall.Context.Builder<SELF>

org.apache.juneau.marshall.MarshallingContextable.Builder<SELF>

org.apache.juneau.marshall.parser.Parser.Builder<SELF>

org.apache.juneau.marshall.parser.InputStreamParser.Builder<CborParser.Builder>

org.apache.juneau.marshall.cbor.CborParser.Builder

Enclosing class:

CborParser

public static class CborParser.Builder
extends InputStreamParser.Builder<CborParser.Builder>

Builder class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Builder()	Constructor, default settings.
protected	Builder(CborParser copyFrom)	Copy constructor.
protected	Builder(CborParser.Builder copyFrom)	Copy constructor.

Method Summary

Modifier and Type	Method	Description
CborParser	build()	Build the object.
CborParser.Builder	copy()	Copy creator.
HashKey	hashKey()	Returns the hashkey of this builder.
CborParser.Builder	maxLength(int value)	The maximum allowed wire-declared length for CBOR byte/text strings and array/map element counts.
CborParser.Builder	nativeMode()	Surfaces CBOR semantic tags and simple values as token-level metadata on TokenReader cursors returned by CborParserSession.readTokens(Object).
CborParser.Builder	nativeMode(boolean value)	Same as nativeMode() but allows you to explicitly specify the value.

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

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

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

activeView, annotations, beanClassVisibility, beanConstructorVisibility, beanDictionary, beanFieldVisibility, beanInterceptor, beanMapPutReturnsOldValue, beanMethodVisibility, beanProperties, beanProperties, beanProperties, beanPropertiesExcludes, beanPropertiesExcludes, beanPropertiesExcludes, beanPropertiesReadOnly, beanPropertiesReadOnly, beanPropertiesReadOnly, beanPropertiesWriteOnly, beanPropertiesWriteOnly, beanPropertiesWriteOnly, beansRequireDefaultConstructor, beansRequireSerializable, beansRequireSettersForGetters, bigNumberFormat, binaryFormat, bitSetFormat, booleanFormat, calendarFormat, classFormat, classLoader, currencyFormat, dateFormat, debug, dictionaryOn, disableBeansRequireSomeProperties, disableDefaultViewInclusion, disableIgnoreMissingSetters, disableIgnoreTransientFields, disableIgnoreUnknownNullBeanProperties, disableInterfaceProxies, durationFormat, enumFormat, example, example, findFluentSetters, findFluentSetters, floatFormat, ignoreInvocationExceptionsOnGetters, ignoreInvocationExceptionsOnSetters, ignoreUnknownBeanProperties, ignoreUnknownEnumValues, implClass, implClasses, interfaceClass, interfaces, locale, localeFormat, marshallingContext, marshallingContext, marshallingContext, marshallingContext, mediaType, notBeanClasses, notBeanPackages, periodFormat, propertyNamer, propertyNamer, recordComponentOrder, stopClass, swap, swap, swaps, swaps, temporalFormat, timeZone, timeZoneFormat, typeName, typePropertyName, typePropertyName, unsortedProperties, unsortedProperties, useJavaBeanIntrospector, uuidFormat, validateSchema, validateSchema

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

annotations, apply, applyAnnotations, applyAnnotations, asSubtype, build, cache, canApply, copyOrNull, debug, getApplied, getType, impl, isDebug, registerBuilders, self, type

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

protected Builder()

Constructor, default settings.

Builder

protected Builder(CborParser.Builder copyFrom)

Copy constructor.

Parameters:

copyFrom - The builder to copy from.

Builder

protected Builder(CborParser copyFrom)

Copy constructor.

Parameters:

copyFrom - The parser to copy from.

Method Details

nativeMode

public CborParser.Builder nativeMode()

Surfaces CBOR semantic tags and simple values as token-level metadata on TokenReader cursors returned by CborParserSession.readTokens(Object).

When enabled, tags accumulate on the cursor's tag stack (visible via TokenReader.getTagCount() / TokenReader.getTag(int)) and simple values surface their int via TokenReader.getSimpleValue() on TokenType.VALUE_NULL tokens. When disabled (default), tags are silently unwrapped and simple values collapse to TokenType.VALUE_NULL with no metadata.

This is a token-cursor-level setting and does not affect the high-level POJO databind path (Parser.read(Object, Class)); that path always discards tags.

Returns:

This object.

nativeMode

public CborParser.Builder nativeMode(boolean value)

Same as nativeMode() but allows you to explicitly specify the value.

Parameters:

value - The value for this setting.

Returns:

This object.

maxLength

public CborParser.Builder maxLength(int value)

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

Guards against malformed or adversarial input where a small payload declares a huge length or element count, which would otherwise trigger OutOfMemoryError. Malformed lengths are reported as a clean parse error instead.

Parameters:

value - The maximum length. Default is 16 MiB. Values ≤ 0 disable the cap.

Returns:

This object.

build

public CborParser build()

Description copied from class: Context.Builder

Build the object.

Overrides:

build in class InputStreamParser.Builder<CborParser.Builder>

Returns:

The built object.

copy

public CborParser.Builder copy()

Description copied from class: Context.Builder

Copy creator.

Specified by:

copy in class InputStreamParser.Builder<CborParser.Builder>

Returns:

A new mutable copy of this builder.

hashKey

public HashKey hashKey()

Description copied from class: Context.Builder

Returns the hashkey of this builder.

Used to return previously instantiated context beans that have matching hashkeys. The HashKey object is suitable for use as a hashmap key of a map of context beans. A context bean is considered equivalent if the HashKey.equals(Object) method is the same.

Overrides:

hashKey in class Parser.Builder<CborParser.Builder>

Returns:

The hashkey of this builder.