Package org.apache.juneau.marshall.marshaller

Class Jcs

java.lang.Object

org.apache.juneau.marshall.marshaller.Marshaller

org.apache.juneau.marshall.marshaller.CharMarshaller

org.apache.juneau.marshall.marshaller.Jcs

public class Jcs
extends CharMarshaller

A pairing of a JcsSerializer and JsonParser into a single class with convenience to/of methods.

Produces canonical JSON per RFC 8785. Parsing uses the standard JsonParser since JCS output is valid JSON.

Examples:

// Using static convenience methods. String s = Jcs.of(myBean); MyBean b = Jcs.to(s, MyBean.class);

// Using instance. Jcs jcs = new Jcs(); String s = jcs.write(myBean); MyBean b = jcs.read(s, MyBean.class);

Example output (bean with name/age):

{"age":30,"name":"Alice"}

Notes:

• BigDecimal and BigInteger values beyond IEEE 754 double precision range will lose precision or throw during serialization.
• Double.NaN, Double.POSITIVE_INFINITY, and Double.NEGATIVE_INFINITY are not permitted and will throw during serialization.

// Using static shortcuts. MyPojo myPojo = Jcs.to(string, MyPojo.class); String string = Jcs.of(myPojo);

See Also:

• RFC 8785 — JSON Canonicalization Scheme
• JCS
• JcsSerializer
• JsonParser

Field Summary

Fields

Modifier and Type	Field	Description
static final Jcs	DEFAULT	Default reusable instance.

Constructor Summary

Constructors

Constructor	Description
Jcs()	Constructor.
Jcs(JcsSerializer s, JsonParser p)	Constructor.

Method Summary

Modifier and Type	Method	Description
static String	of(Object object)	Serializes a POJO to a String using the DEFAULT marshaller.
static void	of(Object object, Writer output)	Serializes a POJO to the specified Writer using the DEFAULT marshaller.
static RecordWriter	ofArrayRecords(Object output)	Opens a RecordWriter that wraps each written value as one element of a top-level wire array using the DEFAULT marshaller.
static RecordWriter	ofRecords(Object output)	Opens a low-level RecordWriter cursor over the specified output using the DEFAULT marshaller.
static TokenWriter	ofTokens(Object output)	Opens a low-level TokenWriter generator over the specified output using the DEFAULT marshaller.
static <T> T	to(Reader input, Class<T> type)	Parses the contents of a Reader into the specified object type using the DEFAULT marshaller.
static <T> T	to(Reader input, Type type, Type... args)	Parses the contents of a Reader into the specified parameterized object type using the DEFAULT marshaller.
static <T> T	to(String input, Class<T> type)	Parses an input into the specified object type using the DEFAULT marshaller.
static <T> T	to(String input, Type type, Type... args)	Parses an input into the specified parameterized object type using the DEFAULT marshaller.
static RecordReader	toArrayRecords(Object input)	Opens a RecordReader that yields each element of a top-level wire array using the DEFAULT marshaller.
static RecordReader	toRecords(Object input)	Opens a low-level RecordReader cursor over the specified input using the DEFAULT marshaller.
static TokenReader	toTokens(Object input)	Opens a low-level TokenReader cursor over the specified input using the DEFAULT marshaller.

Methods inherited from class org.apache.juneau.marshall.marshaller.CharMarshaller

read, read, write

Methods inherited from class org.apache.juneau.marshall.marshaller.Marshaller

getParser, getSerializer, read, read, readArrayRecords, readRecords, readTokens, write, writeArrayRecords, writeRecords, writeTokens

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT

public static final Jcs DEFAULT

Default reusable instance.

Constructor Details

Jcs

public Jcs()

Constructor.

Uses JcsSerializer.DEFAULT and JsonParser.DEFAULT.

Jcs

public Jcs(JcsSerializer s,
 JsonParser p)

Constructor.

Parameters:

s - The serializer to use for serializing output.

p - The parser to use for parsing input.

Method Details

of

public static String of(Object object)
                 throws SerializeException

Serializes a POJO to a String using the DEFAULT marshaller.

A shortcut for calling DEFAULT.write(object).

Parameters:

object - The object to serialize.

Returns:

The serialized object.

Throws:

SerializeException - If a problem occurred trying to convert the output.

to

public static <T> T to(String input,
 Class<T> type)
                throws ParseException

Parses an input into the specified object type using the DEFAULT marshaller.

A shortcut for calling DEFAULT.read(input, type).

Type Parameters:

T - The class type of the object being created.

Parameters:

input - The input.

type - The object type to create.

Returns:

The parsed object.

Throws:

ParseException - Malformed input encountered.

to

public static <T> T to(String input,
 Type type,
 Type... args)
                throws ParseException

Parses an input into the specified parameterized object type using the DEFAULT marshaller.

A shortcut for calling DEFAULT.read(input, type, args).

Type Parameters:

T - The class type of the object to create.

Parameters:

input - The input.

type - The object type to create.

args - The type arguments of the class if it's a collection or map.

Returns:

The parsed object.

Throws:

ParseException - Malformed input encountered.

to

public static <T> T to(Reader input,
 Class<T> type)
                throws ParseException

Parses the contents of a Reader into the specified object type using the DEFAULT marshaller.

A shortcut for calling DEFAULT.read(input, type) that catches any IOException from the underlying stream and rethrows it as an unchecked ParseException, so the caller is not burdened with a checked exception.

Type Parameters:

T - The class type of the object being created.

Parameters:

input - The input reader.

type - The object type to create.

Returns:

The parsed object.

Throws:

ParseException - Malformed input encountered or an I/O error occurred on the underlying stream.

to

public static <T> T to(Reader input,
 Type type,
 Type... args)
                throws ParseException

Parses the contents of a Reader into the specified parameterized object type using the DEFAULT marshaller.

A shortcut for calling DEFAULT.read(input, type, args) that catches any IOException from the underlying stream and rethrows it as an unchecked ParseException, so the caller is not burdened with a checked exception.

Type Parameters:

T - The class type of the object to create.

Parameters:

input - The input reader.

type - The object type to create.

args - The type arguments of the class if it's a collection or map.

Returns:

The parsed object.

Throws:

ParseException - Malformed input encountered or an I/O error occurred on the underlying stream.

of

public static void of(Object object,
 Writer output)
               throws SerializeException

Serializes a POJO to the specified Writer using the DEFAULT marshaller.

A shortcut for calling DEFAULT.write(object, output) that catches any IOException from the underlying stream and rethrows it as an unchecked SerializeException, so the caller is not burdened with a checked exception.

Parameters:

object - The object to serialize.

output - The writer to serialize to.

Throws:

SerializeException - If a problem occurred trying to convert the output or an I/O error occurred on the underlying stream.

toTokens

public static TokenReader toTokens(Object input)
                            throws IOException

Opens a low-level TokenReader cursor over the specified input using the DEFAULT marshaller.

A shortcut for calling DEFAULT.readTokens(input).

Parameters:

input - The input.

Returns:

A new TokenReader.

Throws:

IOException - If a problem occurred opening the underlying input.

ofTokens

public static TokenWriter ofTokens(Object output)
                            throws IOException

Opens a low-level TokenWriter generator over the specified output using the DEFAULT marshaller.

A shortcut for calling DEFAULT.writeTokens(output).

Parameters:

output - The output.

Returns:

A new TokenWriter.

Throws:

IOException - If a problem occurred opening the underlying output.

toRecords

public static RecordReader toRecords(Object input)
                              throws IOException

Opens a low-level RecordReader cursor over the specified input using the DEFAULT marshaller.

A shortcut for calling DEFAULT.readRecords(input).

Parameters:

input - The input.

Returns:

A new RecordReader.

Throws:

IOException - If a problem occurred opening the underlying input.

ofRecords

public static RecordWriter ofRecords(Object output)
                              throws IOException

Opens a low-level RecordWriter cursor over the specified output using the DEFAULT marshaller.

A shortcut for calling DEFAULT.writeRecords(output).

Parameters:

output - The output.

Returns:

A new RecordWriter.

Throws:

IOException - If a problem occurred opening the underlying output.

toArrayRecords

public static RecordReader toArrayRecords(Object input)
                                   throws IOException

Opens a RecordReader that yields each element of a top-level wire array using the DEFAULT marshaller.

A shortcut for calling DEFAULT.readArrayRecords(input).

Parameters:

input - The input.

Returns:

A new RecordReader.

Throws:

IOException - If a problem occurred opening the underlying input.

ofArrayRecords

public static RecordWriter ofArrayRecords(Object output)
                                   throws IOException

Opens a RecordWriter that wraps each written value as one element of a top-level wire array using the DEFAULT marshaller.

A shortcut for calling DEFAULT.writeArrayRecords(output).

Parameters:

output - The output.

Returns:

A new RecordWriter.

Throws:

IOException - If a problem occurred opening the underlying output.