com.google.cloud.tools.jib.json

Class JsonTemplateMapper

java.lang.Object

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

public class JsonTemplateMapper
extends 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(String jsonString, Class<T> templateClass) Deserializes a JSON object from a JSON string.
static <T extends JsonTemplate> T	readJsonFromFile(Path jsonFile, Class<T> templateClass) Deserializes a JSON file via a JSON object template.
static <T extends JsonTemplate> T	readJsonFromFileWithLock(Path jsonFile, Class<T> templateClass) Deserializes a JSON file via a JSON object template with a shared lock on the file
static <T extends JsonTemplate> List<T>	readListOfJson(String jsonString, Class<T> templateClass) Deserializes a JSON object list from a JSON string.
static Blob	toBlob(JsonTemplate template) Convert a JsonTemplate to a Blob of the JSON string.
static Blob	toBlob(List<? extends JsonTemplate> templates) Convert a list of JsonTemplate to a Blob of the JSON string.

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(Path jsonFile,
                                                          Class<T> templateClass)
                                                   throws 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:

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

readJsonFromFileWithLock

public static <T extends JsonTemplate> T readJsonFromFileWithLock(Path jsonFile,
                                                                  Class<T> templateClass)
                                                           throws 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:

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

readJson

public static <T extends JsonTemplate> T readJson(String jsonString,
                                                  Class<T> templateClass)
                                           throws 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:

IOException - if an error occurred during parsing the JSON

readListOfJson

public static <T extends JsonTemplate> List<T> readListOfJson(String jsonString,
                                                              Class<T> templateClass)
                                                       throws 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:

IOException - if an error occurred during parsing the JSON

toBlob

public static Blob toBlob(JsonTemplate template)

Convert a JsonTemplate to a Blob of the JSON string.

Parameters:

template - the JSON template to convert

Returns:

a Blob of the JSON string

toBlob

public static Blob toBlob(List<? extends JsonTemplate> templates)

Convert a list of JsonTemplate to a Blob of the JSON string.

Parameters:

templates - the list of JSON templates to convert

Returns:

a Blob of the JSON string