Package org.apache.juneau.marshall.cbor

Class CborSerializer.Builder

java.lang.Object

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

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

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

org.apache.juneau.marshall.serializer.Serializer.Builder<SELF>

org.apache.juneau.marshall.serializer.OutputStreamSerializer.Builder<CborSerializer.Builder>

org.apache.juneau.marshall.cbor.CborSerializer.Builder

Enclosing class:

CborSerializer

public static class CborSerializer.Builder
extends OutputStreamSerializer.Builder<CborSerializer.Builder>

Builder class.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
CborSerializer.Builder	addBeanTypesCbor()	Add "_type" properties when needed.
CborSerializer.Builder	addBeanTypesCbor(boolean value)	Same as addBeanTypesCbor() but allows you to explicitly specify the value.
CborSerializer	build()	Build the object.
CborSerializer.Builder	copy()	Copy creator.
HashKey	hashKey()	Returns the hashkey of this builder.
CborSerializer.Builder	useTags()	Use CBOR semantic tags for dates and other typed values.
CborSerializer.Builder	useTags(boolean value)	Same as useTags() but allows you to explicitly specify the value.

Methods inherited from class org.apache.juneau.marshall.serializer.Serializer.Builder

accept, addBeanTypes, addBeanTypes, addRootType, addRootType, getAccept, getProduces, keepNullProperties, keepNullProperties, listener, nonDefault, nonDefault, produces, sortCollections, sortCollections, sortMaps, sortMaps, trimEmptyCollections, trimEmptyCollections, trimEmptyMaps, trimEmptyMaps, trimStrings, trimStrings, uriContext, uriRelativity, uriResolution

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

detectRecursions, detectRecursions, ignoreRecursions, ignoreRecursions, initialDepth, maxDepth

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(CborSerializer.Builder copyFrom)

Copy constructor.

Parameters:

copyFrom - The builder to copy from.

Builder

protected Builder(CborSerializer copyFrom)

Copy constructor.

Parameters:

copyFrom - The serializer to copy from.

Method Details

addBeanTypesCbor

public CborSerializer.Builder addBeanTypesCbor()

Add "_type" properties when needed.

Returns:

This object.

addBeanTypesCbor

public CborSerializer.Builder addBeanTypesCbor(boolean value)

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

Parameters:

value - The value for this setting.

Returns:

This object.

useTags

public CborSerializer.Builder useTags()

Use CBOR semantic tags for dates and other typed values.

Returns:

This object.

useTags

public CborSerializer.Builder useTags(boolean value)

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

Parameters:

value - The value for this setting.

Returns:

This object.

copy

public CborSerializer.Builder copy()

Description copied from class: Context.Builder

Copy creator.

Specified by:

copy in class OutputStreamSerializer.Builder<CborSerializer.Builder>

Returns:

A new mutable copy of this builder.

build

public CborSerializer build()

Description copied from class: Context.Builder

Build the object.

Overrides:

build in class OutputStreamSerializer.Builder<CborSerializer.Builder>

Returns:

The built object.

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 Serializer.Builder<CborSerializer.Builder>

Returns:

The hashkey of this builder.