Class CBORizer

java.lang.Object

com.authlete.cbor.CBORizer

public class CBORizer
extends Object

A converter that converts Java primitives and instances of common Java classes into instances of CBORItem subclasses.

Constructor Summary

Constructors

Constructor	Description
CBORizer()

Method Summary

Modifier and Type	Method	Description
CBORItem	cborize(Object object)	Convert the given object into an instance of CBORItem subclass.
CBORItem	cborizeBigInteger(BigInteger value)	Create a CBORBigInteger instance with the given value.
CBORBoolean	cborizeBoolean(boolean value)	Return CBORBoolean.FALSE or CBORBoolean.TRUE according to the given value.
CBORItem	cborizeByteArray(byte[] value)	Create a CBORByteArray instance with the given value.
CBORItem	cborizeCollection(Collection<?> collection)	Create a CBORItemList instance with the given collection.
CBORDouble	cborizeDouble(double value)	Create a CBORDouble instance with the given value.
CBORFloat	cborizeFloat(float value)	Create a CBORFloat instance with the given value.
CBORInteger	cborizeInteger(int value)	Create a CBORInteger instance with the given value.
CBORLong	cborizeLong(long value)	Create a CBORLong instance with the given value.
CBORItem	cborizeMap(Map<?,?> map)	Create a CBORPairList instance with the given map.
CBORItem	cborizeObject(Object object)	Convert the given object into an instance of CBORItem subclass.
CBORItem	cborizeString(String value)	Create a CBORString instance with the given value.
CBORDiagnosticNotationParser	getDiagnosticNotationParser()	Get the parser that interprets the CBOR Diagnostic Notation.
String	getDiagnosticNotationPrefix()	Get the prefix to indicate that the substring of the string given to the cborizeString(String) method should be interpreted as the CBOR Diagnostic Notation.
CBORizer	setDiagnosticNotationParser(CBORDiagnosticNotationParser parser)	Set the parser that interprets the CBOR Diagnostic Notation.
CBORizer	setDiagnosticNotationPrefix(String prefix)	Set the prefix to indicate that the substring of the string given to the cborizeString(String) method should be interpreted as the CBOR Diagnostic Notation.

Methods inherited from class java.lang.Object

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

Constructor Details

CBORizer

public CBORizer()

Method Details

getDiagnosticNotationPrefix

public String getDiagnosticNotationPrefix()

Get the prefix to indicate that the substring of the string given to the cborizeString(String) method should be interpreted as the CBOR Diagnostic Notation.

Returns:

The prefix to invoke the CBOR Diagnostic Notation parser.

Since:

1.5

See Also:

• RFC 8949 Concise Binary Object Representation (CBOR), 8 Diagnostic Notation
• RFC 8610 Concise Data Definition Language (CDDL): A Notational Convention to Express Concise Binary Object Representation (CBOR) and JSON Data Structures, Appendix G. Extended Diagnostic Notation

setDiagnosticNotationPrefix

public CBORizer setDiagnosticNotationPrefix(String prefix)

Set the prefix to indicate that the substring of the string given to the cborizeString(String) method should be interpreted as the CBOR Diagnostic Notation.

For example, if the prefix is "cbor:" (which is the default value), when "cbor:h'0102'" is given to the cborizeString(String) method, the substring after the prefix, which is "h'0102'" in this example, is passed to the parser's parseItem(String) method. The parser will generate a CBORByteArray instance that contains the two bytes, 0x01 and 0x02.

If null or an empty string is set as the prefix, it will result in that every non-null string is processed by the parser unconditionally. Therefore, for example, a string "123" will be converted into a CBORInteger instance that represents the decimal integer, 123. If 123 needs to be processed as a string, "\"123\"" must be given.

If a CBOR Diagnostic Notation parser is not set to this CBORizer instance, this prefix is not used, and conversion based on the CBOR Diagnostic Notation is not performed.

Parameters:

prefix - The prefix to invoke the CBOR Diagnostic Notation parser.

Returns:

this object.

Since:

1.5

See Also:

• RFC 8949 Concise Binary Object Representation (CBOR), 8 Diagnostic Notation
• RFC 8610 Concise Data Definition Language (CDDL): A Notational Convention to Express Concise Binary Object Representation (CBOR) and JSON Data Structures, Appendix G. Extended Diagnostic Notation

getDiagnosticNotationParser

public CBORDiagnosticNotationParser getDiagnosticNotationParser()

Get the parser that interprets the CBOR Diagnostic Notation.

Returns:

The CBOR Diagnostic Notation parser.

Since:

1.5

See Also:

• RFC 8949 Concise Binary Object Representation (CBOR), 8 Diagnostic Notation
• RFC 8610 Concise Data Definition Language (CDDL): A Notational Convention to Express Concise Binary Object Representation (CBOR) and JSON Data Structures, Appendix G. Extended Diagnostic Notation

setDiagnosticNotationParser

public CBORizer setDiagnosticNotationParser(CBORDiagnosticNotationParser parser)

Set the parser that interprets the CBOR Diagnostic Notation.

Parameters:

parser - The CBOR Diagnostic Notation parser.

Returns:

this object.

Since:

1.5

See Also:

• RFC 8949 Concise Binary Object Representation (CBOR), 8 Diagnostic Notation
• RFC 8610 Concise Data Definition Language (CDDL): A Notational Convention to Express Concise Binary Object Representation (CBOR) and JSON Data Structures, Appendix G. Extended Diagnostic Notation

cborizeBoolean

public CBORBoolean cborizeBoolean(boolean value)

Return CBORBoolean.FALSE or CBORBoolean.TRUE according to the given value.

Parameters:

value - A boolean value.

Returns:

CBORBoolean.FALSE or CBORBoolean.TRUE.

cborizeInteger

public CBORInteger cborizeInteger(int value)

Create a CBORInteger instance with the given value.

Parameters:

value - An integer.

Returns:

A new CBORInteger instance.

cborizeLong

public CBORLong cborizeLong(long value)

Create a CBORLong instance with the given value.

Parameters:

value - A long integer.

Returns:

A new CBORLong instance.

cborizeBigInteger

public CBORItem cborizeBigInteger(BigInteger value)

Create a CBORBigInteger instance with the given value.

Parameters:

value - A big integer. When null is given, CBORNull.INSTANCE is returned.

Returns:

A new CBORBigInteger instance or CBORNull.INSTANCE.

cborizeFloat

public CBORFloat cborizeFloat(float value)

Create a CBORFloat instance with the given value.

Parameters:

value - A single-precision floating-point number.

Returns:

A new CBORFloat instance.

cborizeDouble

public CBORDouble cborizeDouble(double value)

Create a CBORDouble instance with the given value.

Parameters:

value - A double-precision floating-point number.

Returns:

A new CBORDouble instance.

cborizeByteArray

public CBORItem cborizeByteArray(byte[] value)

Create a CBORByteArray instance with the given value.

Parameters:

value - A byte array. When null is given, CBORNull.INSTANCE is returned.

Returns:

A new CBORByteArray instance or CBORNull.INSTANCE.

cborizeString

public CBORItem cborizeString(String value)

Create a CBORString instance with the given value.

When null is given, CBORNull.INSTANCE is returned. Otherwise, a CBORString instance that represents the given string is returned.

However, if a CBORDiagnosticNotationParser instance is set to this CBORizer instance (cf. setDiagnosticNotationParser(CBORDiagnosticNotationParser)), and if the prefix of the given string indicates that the string should be interpreted as CBOR Diagnostic Notation (cf. setDiagnosticNotationPrefix(String)), the substring after the prefix is passed to the parseItem(String) method of the parser, and the object returned from the parser is returned from this method.

Parameters:

value - An input string.

Returns:

A new CBOR item built from the given string. In typical cases, a CBORString instance that represents the given string is returned.

cborizeCollection

public CBORItem cborizeCollection(Collection<?> collection)

Create a CBORItemList instance with the given collection. Contents in the given collection are converted into instances of CBORItem subclasses recursively.

Parameters:

collection - A collection of objects. When null is given, CBORNull.INSTANCE is returned.

Returns:

A new CBORItemList instance or CBORNull.INSTANCE.

cborizeMap

public CBORItem cborizeMap(Map<?,?> map)

Create a CBORPairList instance with the given map. Contents in the given map are converted into instances of CBORItem subclasses recursively.

Parameters:

map - A map of key-value pairs. When null is given, CBORNull.INSTANCE is returned.

Returns:

A new CBORPairList instance or CBORNull.INSTANCE.

cborizeObject

public CBORItem cborizeObject(Object object)

Convert the given object into an instance of CBORItem subclass. Conversion is performed recursively as necessary.

The implementation of this method delegates conversion to one of other cborizeXxx methods according to the class of the object. If the class of the given object is unknown, cborizeString(object.toString()) is called.

When the given object is already an instance of CBORItem subclass, the given object is returned as is.

When null is given, CBORNull.INSTANCE is returned.

Parameters:

object - An object to be converted to an instance of CBORItem subclass.

Returns:

An instance of CBORItem subclass.

cborize

public CBORItem cborize(Object object)

Convert the given object into an instance of CBORItem subclass. Conversion is performed recursively as necessary.

This method is an alias of cborizeObject(object).

Parameters:

object - An object to be converted to an instance of CBORItem subclass.

Returns:

An instance of CBORItem subclass.