Package org.apache.juneau.marshaller

Class OpenApi

java.lang.Object

org.apache.juneau.marshaller.Marshaller

org.apache.juneau.marshaller.CharMarshaller

org.apache.juneau.marshaller.OpenApi

public class OpenApi
extends CharMarshaller

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

The general idea is to combine a single serializer and parser inside a simplified API for reading and writing 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);

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 Java object to an OpenApi string.
static Object	of(Object object, Object output)	Serializes a Java object to an OpenApi output.
static String	of(HttpPartSchema schema, Object object)	Serializes a Java object to an OpenApi output.
static <T> T	to(Object input, Class<T> type)	Parses an OpenApi input object to the specified Java type.
static <T> T	to(Object input, Type type, Type... args)	Parses an OpenApi input object to the specified Java type.
static <T> T	to(String input, Class<T> type)	Parses an OpenApi input string to the specified type.
static <T> T	to(String input, Type type, Type... args)	Parses an OpenApi input string to the specified Java type.
static <T> T	to(HttpPartSchema schema, String input, Class<T> type)	Parses an OpenApi input object to the specified Java type.

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

read, read, write

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

getParser, getSerializer, read, read, write

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(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.

OpenApi

public OpenApi()

Constructor.

Uses OpenApiSerializer.DEFAULT and OpenApiParser.DEFAULT.

Method Details

to

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

Parses an OpenApi input string to the specified type.

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(Object input,
 Class<T> type)
                throws ParseException,
IOException

Parses an OpenApi input object to the specified Java type.

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

Type Parameters:

T - The class type of the object being created.

Parameters:

input - The input.
Can be any of the following types:

• null
• Reader
• CharSequence
• InputStream containing UTF-8 encoded text (or charset defined by ReaderParser.Builder.streamCharset(Charset) property value).
• byte[] containing UTF-8 encoded text (or charset defined by ReaderParser.Builder.streamCharset(Charset) property value).
• File containing system encoded text (or charset defined by ReaderParser.Builder.fileCharset(Charset) property value).

type - The object type to create.

Returns:

The parsed object.

Throws:

ParseException - Malformed input encountered.

IOException - Thrown by underlying stream.

to

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

Parses an OpenApi input object to the specified Java type.

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

Type Parameters:

T - The class type of the object being created.

Parameters:

schema - The part type schema. Can be null.

input - The input.

type - The object type to create.

Returns:

The parsed object.

Throws:

ParseException - Malformed input encountered.

IOException - Thrown by underlying stream.

to

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

Parses an OpenApi input string to the specified Java type.

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.
Can be any of the following: ClassMeta, Class, ParameterizedType, GenericArrayType

args - The type arguments of the class if it's a collection or map.
Can be any of the following: ClassMeta, Class, ParameterizedType, GenericArrayType
Ignored if the main type is not a map or collection.

Returns:

The parsed object.

Throws:

ParseException - Malformed input encountered.

See Also:

• for argument syntax for maps and collections.

to

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

Parses an OpenApi input object to the specified Java type.

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

Type Parameters:

T - The class type of the object to create.

Parameters:

input - The input.
Can be any of the following types:

• null
• Reader
• CharSequence
• InputStream containing UTF-8 encoded text (or charset defined by ReaderParser.Builder.streamCharset(Charset) property value).
• byte[] containing UTF-8 encoded text (or charset defined by ReaderParser.Builder.streamCharset(Charset) property value).
• File containing system encoded text (or charset defined by ReaderParser.Builder.fileCharset(Charset) property value).

type - The object type to create.
Can be any of the following: ClassMeta, Class, ParameterizedType, GenericArrayType

args - The type arguments of the class if it's a collection or map.
Can be any of the following: ClassMeta, Class, ParameterizedType, GenericArrayType
Ignored if the main type is not a map or collection.

Returns:

The parsed object.

Throws:

ParseException - Malformed input encountered.

IOException - Thrown by underlying stream.

See Also:

• for argument syntax for maps and collections.

of

public static String of(Object object)
                 throws SerializeException

Serializes a Java object to an OpenApi string.

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.

of

public static Object of(Object object,
 Object output)
                 throws SerializeException,
IOException

Serializes a Java object to an OpenApi output.

A shortcut for calling DEFAULT.write(output).

Parameters:

object - The object to serialize.

output - The output object.
Can be any of the following types:

• Writer
• OutputStream - Output will be written as UTF-8 encoded stream.
• File - Output will be written as system-default encoded stream.
• StringBuilder - Output will be written to the specified string builder.

Returns:

The output object.

Throws:

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

IOException - Thrown by underlying stream.

of

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

Serializes a Java object to an OpenApi output.

A shortcut for calling DEFAULT.write(output).

Parameters:

schema - The part schema. Can be null.

object - The object to serialize.

Returns:

The output object.

Throws:

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