com.asakusafw.runtime.io.json

Class JsonFormat<T>

java.lang.Object

com.asakusafw.runtime.io.json.JsonFormat<T>

Type Parameters:

T - the data type

public class JsonFormat<T>
extends Object

Provides JsonInput and JsonOutput.

Since:

0.10.3

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JsonFormat.Builder<T> A builder for JsonFormat.
static class	JsonFormat.InputOption Options for input.
static class	JsonFormat.OutputOption Options for output.

Field Summary

Fields

Modifier and Type	Field and Description
static Charset	DEFAULT_CHARSET The default charset.
static boolean	DEFAULT_ESCAPE_NO_ASCII_CHARACTER The default behavior of whether or not escaping no-ASCII characters.
static Set<JsonFormat.InputOption>	DEFAULT_INPUT_OPTIONS The default input options.
static com.fasterxml.jackson.core.JsonFactory	DEFAULT_JSON_FACTORY The default JsonFactory instance.
static LineSeparator	DEFAULT_LINE_SEPARATOR The default line separator.
static ErrorAction	DEFAULT_ON_UNKNOWN_INPUT The default error action of unknown properties.
static Set<JsonFormat.OutputOption>	DEFAULT_OUTPUT_OPTIONS The default output options.
static boolean	DEFAULT_USE_PLAIN_DECIMAL The default behavior of whether or not use plain style to decimal numbers.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	JsonFormat(JsonFormat.Builder<T> builder) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
static <T> JsonFormat.Builder<T>	builder(Class<T> dataType) Creates a new builder.
JsonInput<T>	open(String path, InputStream input, Collection<? extends JsonFormat.InputOption> options) Opens JsonInput for the given input.
JsonOutput<T>	open(String path, OutputStream output, Collection<? extends JsonFormat.OutputOption> options) Opens JsonOutput for the given output.
JsonInput<T>	open(String path, Reader input, Collection<? extends JsonFormat.InputOption> options) Opens JsonInput for the given input.
JsonOutput<T>	open(String path, Writer output, Collection<? extends JsonFormat.OutputOption> options) Opens JsonOutput for the given output.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_JSON_FACTORY

public static final com.fasterxml.jackson.core.JsonFactory DEFAULT_JSON_FACTORY

The default JsonFactory instance.

DEFAULT_CHARSET

public static final Charset DEFAULT_CHARSET

The default charset.

DEFAULT_LINE_SEPARATOR

public static final LineSeparator DEFAULT_LINE_SEPARATOR

The default line separator.

DEFAULT_USE_PLAIN_DECIMAL

public static final boolean DEFAULT_USE_PLAIN_DECIMAL

The default behavior of whether or not use plain style to decimal numbers.

See Also:

Constant Field Values

DEFAULT_ESCAPE_NO_ASCII_CHARACTER

public static final boolean DEFAULT_ESCAPE_NO_ASCII_CHARACTER

The default behavior of whether or not escaping no-ASCII characters.

See Also:

Constant Field Values

DEFAULT_ON_UNKNOWN_INPUT

public static final ErrorAction DEFAULT_ON_UNKNOWN_INPUT

The default error action of unknown properties.

DEFAULT_INPUT_OPTIONS

public static final Set<JsonFormat.InputOption> DEFAULT_INPUT_OPTIONS

The default input options.

DEFAULT_OUTPUT_OPTIONS

public static final Set<JsonFormat.OutputOption> DEFAULT_OUTPUT_OPTIONS

The default output options.

Constructor Detail

JsonFormat

protected JsonFormat(JsonFormat.Builder<T> builder)

Creates a new instance.

Parameters:

builder - the builder of this

Method Detail

builder

public static <T> JsonFormat.Builder<T> builder(Class<T> dataType)

Creates a new builder.

Type Parameters:

T - the data type

Parameters:

dataType - the target data type

Returns:

the created builder

open

public JsonInput<T> open(String path,
                         InputStream input,
                         Collection<? extends JsonFormat.InputOption> options)
                  throws IOException

Opens JsonInput for the given input.

Parameters:

path - the source path name

input - the source input stream

options - input options

Returns:

the opened JsonInput

Throws:

IOException - if I/O error was occurred while initializing the reader

open

public JsonOutput<T> open(String path,
                          OutputStream output,
                          Collection<? extends JsonFormat.OutputOption> options)
                   throws IOException

Opens JsonOutput for the given output.

Parameters:

path - the source path name

output - the destination output stream

options - output options

Returns:

the opened JsonOutput

Throws:

IOException - if I/O error was occurred while initializing the writer

open

public JsonInput<T> open(String path,
                         Reader input,
                         Collection<? extends JsonFormat.InputOption> options)
                  throws IOException

Opens JsonInput for the given input.

Parameters:

path - the source path name

input - the source input reader

options - input options

Returns:

the opened JsonInput

Throws:

IOException - if I/O error was occurred while initializing the reader

open

public JsonOutput<T> open(String path,
                          Writer output,
                          Collection<? extends JsonFormat.OutputOption> options)
                   throws IOException

Opens JsonOutput for the given output.

Parameters:

path - the source path name

output - the destination output writer

options - output options

Returns:

the opened JsonOutput

Throws:

IOException - if I/O error was occurred while initializing the writer