Package org.apache.juneau.marshall.marshaller

Class OpenApi

java.lang.Object

org.apache.juneau.marshall.marshaller.Marshaller

org.apache.juneau.marshall.marshaller.CharMarshaller

org.apache.juneau.marshall.marshaller.OpenApi

public class OpenApi
extends CharMarshaller

A pairing of a OpenApiSerializer and OpenApiParser into a single class with convenience to/of methods.

The general idea is to combine a single serializer and parser inside a simplified API for serializing and parsing POJOs.

Examples:

// Using instance. OpenApi oapi = new OpenApi(); MyPojo myPojo = oapi.read(string, MyPojo.class); String string = oapi.write(myPojo);

// Using DEFAULT instance. MyPojo myPojo = OpenApi.DEFAULT.read(string, MyPojo.class); String string = OpenApi.DEFAULT.write(myPojo);

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

See Also:

• Marshallers

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
OpenApi()	Constructor.
OpenApi(OpenApiSerializer s, OpenApiParser 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 String	of(HttpPartSchema schema, Object object)	Serializes a Java object to an OpenApi output using the specified part schema.
static RecordWriter	ofRecords(Object output)	Opens a low-level RecordWriter cursor 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 <T> T	to(HttpPartSchema schema, String input, Class<T> type)	Parses an OpenApi input object to the specified Java type using the specified part schema.
static RecordReader	toRecords(Object input)	Opens a low-level RecordReader 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 OpenApi DEFAULT

Default reusable instance.

Constructor Details

OpenApi

public OpenApi()

Constructor.

Uses OpenApiSerializer.DEFAULT and OpenApiParser.DEFAULT.

OpenApi

public OpenApi(OpenApiSerializer s,
 OpenApiParser p)

Constructor.

Parameters:

s - The serializer to use for serializing output.
Must not be null.

p - The parser to use for parsing input.
Must not be null.

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.

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.

of

public static String of(HttpPartSchema schema,
 Object object)
                 throws SerializeException

Serializes a Java object to an OpenApi output using the specified part schema.

A shortcut for serializing a value with the specified part schema using the DEFAULT serializer.

Parameters:

schema - The part schema. Can be null (treated as HttpPartSchema.DEFAULT).

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(HttpPartSchema schema,
 String input,
 Class<T> type)
                throws ParseException

Parses an OpenApi input object to the specified Java type using the specified part schema.

A shortcut for parsing the input with the specified part schema using the DEFAULT parser.

Type Parameters:

T - The class type of the object being created.

Parameters:

schema - The part type schema. Can be null (treated as HttpPartSchema.DEFAULT).

input - The input.

type - The object type to create.

Returns:

The parsed object.

Throws:

ParseException - Malformed input encountered.