com.google.cloud.tools.jib.json

Class JsonTemplateMapper

java.lang.Object

com.google.cloud.tools.jib.json.JsonTemplateMapper

public class JsonTemplateMapper
extends java.lang.Object

Helper class for serializing and deserializing JSON.

The interface uses Jackson as the JSON parser. Some useful annotations to include on classes used as templates for JSON are:

@JsonInclude(JsonInclude.Include.NON_NULL)

• Does not serialize fields that are null.

@JsonAutoDetect(fieldVisibility = JsonAutoDetect.Visibility.ANY)

• Fields that are private are also accessible for serialization/deserialization.

See Also:

https://github.com/FasterXML/jackson

Method Summary

Modifier and Type	Method and Description
static <T extends JsonTemplate> T	readJson(byte[] jsonBytes, java.lang.Class<T> templateClass) Deserializes a JSON object from a JSON byte array.
static <T extends JsonTemplate> T	readJson(java.io.InputStream jsonStream, java.lang.Class<T> templateClass) Deserializes a JSON object from a JSON input stream.
static <T extends JsonTemplate> T	readJson(java.lang.String jsonString, java.lang.Class<T> templateClass) Deserializes a JSON object from a JSON string.
static <T extends JsonTemplate> T	readJsonFromFile(java.nio.file.Path jsonFile, java.lang.Class<T> templateClass) Deserializes a JSON file via a JSON object template.
static <T extends JsonTemplate> T	readJsonFromFileWithLock(java.nio.file.Path jsonFile, java.lang.Class<T> templateClass) Deserializes a JSON file via a JSON object template with a shared lock on the file
static <T extends JsonTemplate> java.util.List<T>	readListOfJson(java.lang.String jsonString, java.lang.Class<T> templateClass) Deserializes a JSON object list from a JSON string.
static byte[]	toByteArray(JsonTemplate template)
static byte[]	toByteArray(java.util.List<? extends JsonTemplate> templates)
static java.lang.String	toUtf8String(JsonTemplate template)
static java.lang.String	toUtf8String(java.util.List<? extends JsonTemplate> templates)
static void	writeTo(JsonTemplate template, java.io.OutputStream out)
static void	writeTo(java.util.List<? extends JsonTemplate> templates, java.io.OutputStream out)

Methods inherited from class java.lang.Object

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

Method Detail

readJsonFromFile

public static <T extends JsonTemplate> T readJsonFromFile(java.nio.file.Path jsonFile,
                                                          java.lang.Class<T> templateClass)
                                                   throws java.io.IOException

Deserializes a JSON file via a JSON object template.

Type Parameters:

T - child type of JsonTemplate

Parameters:

jsonFile - a file containing a JSON string

templateClass - the template to deserialize the string to

Returns:

the template filled with the values parsed from jsonFile

Throws:

java.io.IOException - if an error occurred during reading the file or parsing the JSON

readJsonFromFileWithLock

public static <T extends JsonTemplate> T readJsonFromFileWithLock(java.nio.file.Path jsonFile,
                                                                  java.lang.Class<T> templateClass)
                                                           throws java.io.IOException

Deserializes a JSON file via a JSON object template with a shared lock on the file

Type Parameters:

T - child type of JsonTemplate

Parameters:

jsonFile - a file containing a JSON string

templateClass - the template to deserialize the string to

Returns:

the template filled with the values parsed from jsonFile

Throws:

java.io.IOException - if an error occurred during reading the file or parsing the JSON

readJson

public static <T extends JsonTemplate> T readJson(java.io.InputStream jsonStream,
                                                  java.lang.Class<T> templateClass)
                                           throws java.io.IOException

Deserializes a JSON object from a JSON input stream.

Type Parameters:

T - child type of JsonTemplate

Parameters:

jsonStream - input stream

templateClass - the template to deserialize the string to

Returns:

the template filled with the values parsed from jsonString

Throws:

java.io.IOException - if an error occurred during parsing the JSON

readJson

public static <T extends JsonTemplate> T readJson(java.lang.String jsonString,
                                                  java.lang.Class<T> templateClass)
                                           throws java.io.IOException

Deserializes a JSON object from a JSON string.

Type Parameters:

T - child type of JsonTemplate

Parameters:

jsonString - a JSON string

templateClass - the template to deserialize the string to

Returns:

the template filled with the values parsed from jsonString

Throws:

java.io.IOException - if an error occurred during parsing the JSON

readJson

public static <T extends JsonTemplate> T readJson(byte[] jsonBytes,
                                                  java.lang.Class<T> templateClass)
                                           throws java.io.IOException

Deserializes a JSON object from a JSON byte array.

Type Parameters:

T - child type of JsonTemplate

Parameters:

jsonBytes - a JSON byte array

templateClass - the template to deserialize the string to

Returns:

the template filled with the values parsed from jsonBytes

Throws:

java.io.IOException - if an error occurred during parsing the JSON

readListOfJson

public static <T extends JsonTemplate> java.util.List<T> readListOfJson(java.lang.String jsonString,
                                                                        java.lang.Class<T> templateClass)
                                                                 throws java.io.IOException

Deserializes a JSON object list from a JSON string.

Type Parameters:

T - child type of JsonTemplate

Parameters:

jsonString - a JSON string

templateClass - the template to deserialize the string to

Returns:

the template filled with the values parsed from jsonString

Throws:

java.io.IOException - if an error occurred during parsing the JSON

toUtf8String

public static java.lang.String toUtf8String(JsonTemplate template)
                                     throws java.io.IOException

Throws:

java.io.IOException

toUtf8String

public static java.lang.String toUtf8String(java.util.List<? extends JsonTemplate> templates)
                                     throws java.io.IOException

Throws:

java.io.IOException

toByteArray

public static byte[] toByteArray(JsonTemplate template)
                          throws java.io.IOException

Throws:

java.io.IOException

toByteArray

public static byte[] toByteArray(java.util.List<? extends JsonTemplate> templates)
                          throws java.io.IOException

Throws:

java.io.IOException

writeTo

public static void writeTo(JsonTemplate template,
                           java.io.OutputStream out)
                    throws java.io.IOException

Throws:

java.io.IOException

writeTo

public static void writeTo(java.util.List<? extends JsonTemplate> templates,
                           java.io.OutputStream out)
                    throws java.io.IOException

Throws:

java.io.IOException