Package io.openems.common.utils

Class JsonUtils.JsonObjectBuilder

java.lang.Object

io.openems.common.utils.JsonUtils.JsonObjectBuilder

Enclosing class:

JsonUtils

public static class JsonUtils.JsonObjectBuilder
extends java.lang.Object

A temporary builder class for JsonObjects.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	JsonObjectBuilder()
protected	JsonObjectBuilder(com.google.gson.JsonObject j)

Method Summary

Modifier and Type	Method	Description
JsonUtils.JsonObjectBuilder	add(java.lang.String property, com.google.gson.JsonElement value)	Add a JsonElement value to the JsonObject.
JsonUtils.JsonObjectBuilder	addProperty(java.lang.String property, boolean value)	Add a boolean value to the JsonObject.
JsonUtils.JsonObjectBuilder	addProperty(java.lang.String property, double value)	Add a double value to the JsonObject.
JsonUtils.JsonObjectBuilder	addProperty(java.lang.String property, int value)	Add a int value to the JsonObject.
JsonUtils.JsonObjectBuilder	addProperty(java.lang.String property, long value)	Add a long value to the JsonObject.
JsonUtils.JsonObjectBuilder	addProperty(java.lang.String property, java.lang.Enum<?> value)	Add a Enum value to the JsonObject.
JsonUtils.JsonObjectBuilder	addProperty(java.lang.String property, java.lang.String value)	Add a String value to the JsonObject.
JsonUtils.JsonObjectBuilder	addProperty(java.lang.String property, java.time.ZonedDateTime value)	Add a ZonedDateTime value to the JsonObject.
JsonUtils.JsonObjectBuilder	addPropertyIfNotNull(java.lang.String property, java.lang.Boolean value)	Add a Boolean value to the JsonObject.
JsonUtils.JsonObjectBuilder	addPropertyIfNotNull(java.lang.String property, java.lang.Double value)	Add a Double value to the JsonObject if it is not null.
JsonUtils.JsonObjectBuilder	addPropertyIfNotNull(java.lang.String property, java.lang.Enum<?> value)	Add a Enum value to the JsonObject if it is not null.
JsonUtils.JsonObjectBuilder	addPropertyIfNotNull(java.lang.String property, java.lang.Integer value)	Add an Integer value to the JsonObject if it is not null.
JsonUtils.JsonObjectBuilder	addPropertyIfNotNull(java.lang.String property, java.lang.Long value)	Add a Long value to the JsonObject if it is not null.
JsonUtils.JsonObjectBuilder	addPropertyIfNotNull(java.lang.String property, java.lang.String value)	Add a String value to the JsonObject if it is not null.
JsonUtils.JsonObjectBuilder	addPropertyIfNotNull(java.lang.String property, java.time.ZonedDateTime value)	Add a ZonedDateTime value to the JsonObject if it is not null.
com.google.gson.JsonObject	build()	Return the built JsonObject.
JsonUtils.JsonObjectBuilder	onlyIf(boolean expression, java.util.function.Consumer<JsonUtils.JsonObjectBuilder> ifTrueCallback)	Call a method on a JsonObjectBuilder if an expression is true.

Methods inherited from class java.lang.Object

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

Constructor Detail

JsonObjectBuilder

protected JsonObjectBuilder()

JsonObjectBuilder

protected JsonObjectBuilder(com.google.gson.JsonObject j)

Method Detail

add

public JsonUtils.JsonObjectBuilder add(java.lang.String property,
                                       com.google.gson.JsonElement value)

Add a JsonElement value to the JsonObject.

Parameters:

property - the key

value - the value

Returns:

the JsonUtils.JsonObjectBuilder

addProperty

public JsonUtils.JsonObjectBuilder addProperty(java.lang.String property,
                                               boolean value)

Add a boolean value to the JsonObject.

Parameters:

property - the key

value - the value

Returns:

the JsonUtils.JsonObjectBuilder

addProperty

public JsonUtils.JsonObjectBuilder addProperty(java.lang.String property,
                                               double value)

Add a double value to the JsonObject.

Parameters:

property - the key

value - the value

Returns:

the JsonUtils.JsonObjectBuilder

addProperty

public JsonUtils.JsonObjectBuilder addProperty(java.lang.String property,
                                               int value)

Add a int value to the JsonObject.

Parameters:

property - the key

value - the value

Returns:

the JsonUtils.JsonObjectBuilder

addProperty

public JsonUtils.JsonObjectBuilder addProperty(java.lang.String property,
                                               long value)

Add a long value to the JsonObject.

Parameters:

property - the key

value - the value

Returns:

the JsonUtils.JsonObjectBuilder

addProperty

public JsonUtils.JsonObjectBuilder addProperty(java.lang.String property,
                                               java.lang.String value)

Add a String value to the JsonObject.

Parameters:

property - the key

value - the value

Returns:

the JsonUtils.JsonObjectBuilder

addProperty

public JsonUtils.JsonObjectBuilder addProperty(java.lang.String property,
                                               java.lang.Enum<?> value)

Add a Enum value to the JsonObject.

Parameters:

property - the key

value - the value

Returns:

the JsonUtils.JsonObjectBuilder

addProperty

public JsonUtils.JsonObjectBuilder addProperty(java.lang.String property,
                                               java.time.ZonedDateTime value)

Add a ZonedDateTime value to the JsonObject.

The value gets added in the format of DateTimeFormatter.ISO_INSTANT.

Parameters:

property - the key

value - the value

Returns:

the JsonUtils.JsonObjectBuilder

addPropertyIfNotNull

public JsonUtils.JsonObjectBuilder addPropertyIfNotNull(java.lang.String property,
                                                        java.lang.Boolean value)

Add a Boolean value to the JsonObject.

Parameters:

property - the key

value - the value

Returns:

the JsonUtils.JsonObjectBuilder

addPropertyIfNotNull

public JsonUtils.JsonObjectBuilder addPropertyIfNotNull(java.lang.String property,
                                                        java.lang.Double value)

Add a Double value to the JsonObject if it is not null.

Parameters:

property - the key

value - the value

Returns:

the JsonUtils.JsonObjectBuilder

addPropertyIfNotNull

public JsonUtils.JsonObjectBuilder addPropertyIfNotNull(java.lang.String property,
                                                        java.lang.Integer value)

Add an Integer value to the JsonObject if it is not null.

Parameters:

property - the key

value - the value

Returns:

the JsonUtils.JsonObjectBuilder

addPropertyIfNotNull

public JsonUtils.JsonObjectBuilder addPropertyIfNotNull(java.lang.String property,
                                                        java.lang.Long value)

Add a Long value to the JsonObject if it is not null.

Parameters:

property - the key

value - the value

Returns:

the JsonUtils.JsonObjectBuilder

addPropertyIfNotNull

public JsonUtils.JsonObjectBuilder addPropertyIfNotNull(java.lang.String property,
                                                        java.lang.String value)

Add a String value to the JsonObject if it is not null.

Parameters:

property - the key

value - the value

Returns:

the JsonUtils.JsonObjectBuilder

addPropertyIfNotNull

public JsonUtils.JsonObjectBuilder addPropertyIfNotNull(java.lang.String property,
                                                        java.lang.Enum<?> value)

Add a Enum value to the JsonObject if it is not null.

Parameters:

property - the key

value - the value

Returns:

the JsonUtils.JsonObjectBuilder

addPropertyIfNotNull

public JsonUtils.JsonObjectBuilder addPropertyIfNotNull(java.lang.String property,
                                                        java.time.ZonedDateTime value)

Add a ZonedDateTime value to the JsonObject if it is not null.

The value gets added in the format of DateTimeFormatter.ISO_INSTANT.

Parameters:

property - the key

value - the value

Returns:

the JsonUtils.JsonObjectBuilder

onlyIf

public JsonUtils.JsonObjectBuilder onlyIf(boolean expression,
                                          java.util.function.Consumer<JsonUtils.JsonObjectBuilder> ifTrueCallback)

Call a method on a JsonObjectBuilder if an expression is true.

Parameters:

expression - the expression

ifTrueCallback - allows a lambda function on JsonUtils.JsonObjectBuilder

Returns:

the JsonUtils.JsonObjectBuilder

build

public com.google.gson.JsonObject build()

Return the built JsonObject.

Returns:

the JsonObject