Package org.apache.juneau.marshall.msgpack

Class MsgPackParser.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<MsgPackParser.Builder>

org.apache.juneau.marshall.msgpack.MsgPackParser.Builder

Enclosing class:

MsgPackParser

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

Builder class.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
MsgPackParser	build()	Build the object.
MsgPackParser.Builder	copy()	Copy creator.
HashKey	hashKey()	Returns the hashkey of this builder.
MsgPackParser.Builder	maxLength(int value)	The maximum allowed wire-declared length (in bytes) for MessagePack binary and string payloads.
MsgPackParser.Builder	nativeMode()	Surfaces the MsgPack ext type byte as token-level metadata on TokenReader cursors returned by MsgPackParserSession.readTokens(Object).
MsgPackParser.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(MsgPackParser.Builder copyFrom)

Copy constructor.

Parameters:

copyFrom - The builder to copy from.
Cannot be null.

Builder

protected Builder(MsgPackParser copyFrom)

Copy constructor.

Parameters:

copyFrom - The bean to copy from.
Cannot be null.

Method Details

nativeMode

public MsgPackParser.Builder nativeMode()

Surfaces the MsgPack ext type byte as token-level metadata on TokenReader cursors returned by MsgPackParserSession.readTokens(Object).

When enabled, ext tokens carry the signed type byte (visible via TokenReader.getExtType()) on TokenType.VALUE_BINARY tokens. When disabled (default), the payload still surfaces as TokenType.VALUE_BINARY but the type byte is dropped.

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 the type byte.

Returns:

This object.

nativeMode

public MsgPackParser.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 MsgPackParser.Builder maxLength(int value)

The maximum allowed wire-declared length (in bytes) for MessagePack binary and string payloads.

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

Parameters:

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

Returns:

This object.

build

public MsgPackParser build()

Description copied from class: Context.Builder

Build the object.

Overrides:

build in class InputStreamParser.Builder<MsgPackParser.Builder>

Returns:

The built object.

copy

public MsgPackParser.Builder copy()

Description copied from class: Context.Builder

Copy creator.

Specified by:

copy in class InputStreamParser.Builder<MsgPackParser.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<MsgPackParser.Builder>

Returns:

The hashkey of this builder.