Package io.openems.common.utils

Class JsonUtils

java.lang.Object

io.openems.common.utils.JsonUtils

public class JsonUtils
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	JsonUtils.JsonArrayBuilder	A temporary builder class for JsonArrays.
static class	JsonUtils.JsonArrayCollector
static class	JsonUtils.JsonObjectBuilder	A temporary builder class for JsonObjects.

Constructor Summary

Constructors

Constructor	Description
JsonUtils()

Method Summary

Modifier and Type	Method	Description
static JsonUtils.JsonArrayBuilder	buildJsonArray()	Creates a JsonArray using a Builder.
static JsonUtils.JsonArrayBuilder	buildJsonArray(com.google.gson.JsonArray j)	Creates a JsonArray using a Builder.
static JsonUtils.JsonObjectBuilder	buildJsonObject()	Creates a JsonObject using a Builder.
static JsonUtils.JsonObjectBuilder	buildJsonObject(com.google.gson.JsonObject j)	Creates a JsonObject using a Builder.
static <T extends com.google.gson.JsonElement> com.google.gson.JsonArray	generateJsonArray(Collection<T> list)	Provide a easy way to generate a JsonArray from a collection of JsonElements.
static <T> com.google.gson.JsonArray	generateJsonArray(Collection<T> list, com.google.common.base.Function<T,com.google.gson.JsonElement> convert)	Provide a easy way to generate a JsonArray from a list using the given convert function to add each element.
static Object	getAsBestType(com.google.gson.JsonElement j)	Tries to find the best matching Object representation of the given JsonElement.
static boolean	getAsBoolean(com.google.gson.JsonElement jElement)	Gets the JsonElement as Boolean.
static boolean	getAsBoolean(com.google.gson.JsonElement jElement, String memberName)	Gets the member of the JsonElement as Boolean.
static double	getAsDouble(com.google.gson.JsonElement jElement)	Gets the JsonElement as Double.
static double	getAsDouble(com.google.gson.JsonElement jElement, String memberName)	Gets the member of the JsonElement as Double.
static <E extends Enum<E>> E	getAsEnum(Class<E> enumType, com.google.gson.JsonElement jElement)	Gets the JsonElement as Enum.
static <E extends Enum<E>> E	getAsEnum(Class<E> enumType, com.google.gson.JsonElement jElement, String memberName)	Gets the member of the JsonElement as Enum.
static float	getAsFloat(com.google.gson.JsonElement jElement)	Gets the JsonElement as Float.
static float	getAsFloat(com.google.gson.JsonElement jElement, String memberName)	Gets the member of the JsonElement as Float.
static Inet4Address	getAsInet4Address(com.google.gson.JsonElement jElement)	Gets the JsonElement as Inet4Address.
static Inet4Address	getAsInet4Address(com.google.gson.JsonElement jElement, String memberName)	Gets the member of the JsonElement as Inet4Address.
static int	getAsInt(com.google.gson.JsonArray jArray, int index)	Gets the member with given index of the JsonArray as int.
static int	getAsInt(com.google.gson.JsonElement jElement)	Gets the JsonElement as int.
static int	getAsInt(com.google.gson.JsonElement jElement, String memberName)	Gets the member of the JsonElement as int.
static com.google.gson.JsonArray	getAsJsonArray(com.google.gson.JsonElement jElement)	Gets the JsonElement as JsonArray.
static com.google.gson.JsonArray	getAsJsonArray(com.google.gson.JsonElement jElement, String memberName)	Gets the member of the JsonElement as JsonArray.
static com.google.gson.JsonElement	getAsJsonElement(Object value)	Gets a JsonElement representing the Object value.
static com.google.gson.JsonObject	getAsJsonObject(com.google.gson.JsonElement jElement)	Gets the JsonElement as JsonObject.
static com.google.gson.JsonObject	getAsJsonObject(com.google.gson.JsonElement jElement, String memberName)	Gets the member of the JsonElement as JsonObject.
static long	getAsLong(com.google.gson.JsonElement jElement)	Gets the JsonElement as long.
static long	getAsLong(com.google.gson.JsonElement jElement, String memberName)	Gets the member of the JsonElement as long.
static Optional<Boolean>	getAsOptionalBoolean(com.google.gson.JsonElement jElement)	Gets the JsonElement as an Optional Boolean.
static Optional<Boolean>	getAsOptionalBoolean(com.google.gson.JsonElement jElement, String memberName)	Gets the member of the JsonElement as an Optional Boolean.
static Optional<Double>	getAsOptionalDouble(com.google.gson.JsonElement jElement)	Gets the JsonElement as Optional Double.
static Optional<Double>	getAsOptionalDouble(com.google.gson.JsonElement jElement, String memberName)	Gets the member of the JsonElement as Optional Double.
static <E extends Enum<E>> Optional<E>	getAsOptionalEnum(Class<E> enumType, com.google.gson.JsonElement jElement)	Gets the JsonElement as Optional Enum.
static <E extends Enum<E>> Optional<E>	getAsOptionalEnum(Class<E> enumType, com.google.gson.JsonElement jElement, String memberName)	Gets the member of the JsonElement as Optional Enum.
static Optional<Float>	getAsOptionalFloat(com.google.gson.JsonElement jElement)	Gets the JsonElement as Optional Float.
static Optional<Float>	getAsOptionalFloat(com.google.gson.JsonElement jElement, String memberName)	Gets the member of the JsonElement as Optional Float.
static Optional<Inet4Address>	getAsOptionalInet4Address(com.google.gson.JsonElement jElement)	Gets the JsonElement as Optional Inet4Address.
static Optional<Inet4Address>	getAsOptionalInet4Address(com.google.gson.JsonElement jElement, String memberName)	Gets the member of the JsonElement as Optional Inet4Address.
static Optional<Integer>	getAsOptionalInt(com.google.gson.JsonElement jElement)	Gets the JsonElement as Optional Integer.
static Optional<Integer>	getAsOptionalInt(com.google.gson.JsonElement jElement, String memberName)	Gets the member of the JsonElement as Optional Integer.
static Optional<com.google.gson.JsonArray>	getAsOptionalJsonArray(com.google.gson.JsonElement jElement)	Gets the member of the JsonElement as Optional JsonArray.
static Optional<com.google.gson.JsonArray>	getAsOptionalJsonArray(com.google.gson.JsonElement jElement, String memberName)	Gets the member of the JsonElement as Optional JsonArray.
static Optional<com.google.gson.JsonObject>	getAsOptionalJsonObject(com.google.gson.JsonElement jElement)	Gets the JsonElement as Optional JsonObject.
static Optional<com.google.gson.JsonObject>	getAsOptionalJsonObject(com.google.gson.JsonElement jElement, String memberName)	Gets the member of the JsonElement as Optional JsonObject.
static Optional<Long>	getAsOptionalLong(com.google.gson.JsonElement jElement)	Gets the JsonElement as Optional Long.
static Optional<Long>	getAsOptionalLong(com.google.gson.JsonElement jElement, String memberName)	Gets the member of the JsonElement as Optional Long.
static Optional<com.google.gson.JsonPrimitive>	getAsOptionalPrimitive(com.google.gson.JsonElement jElement, String memberName)	Gets the member of the JsonElement as Optional JsonPrimitive.
static Optional<Short>	getAsOptionalShort(com.google.gson.JsonElement jElement)	Gets the JsonElement as an Optional Short.
static Optional<Short>	getAsOptionalShort(com.google.gson.JsonElement jElement, String memberName)	Gets the member of the JsonElement as an Optional Short.
static Optional<String>	getAsOptionalString(com.google.gson.JsonElement jElement)	Gets the JsonElement as Optional String.
static Optional<String>	getAsOptionalString(com.google.gson.JsonElement jElement, String memberName)	Gets the member of the JsonElement as Optional String.
static Optional<UUID>	getAsOptionalUUID(com.google.gson.JsonElement jElement)	Gets the JsonElement as Optional UUID.
static Optional<UUID>	getAsOptionalUUID(com.google.gson.JsonElement jElement, String memberName)	Gets the member of the JsonElement as Optional UUID.
static Optional<ZonedDateTime>	getAsOptionalZonedDateTime(com.google.gson.JsonElement element, String memberName)	Takes a JSON in the form 'YYYY-MM-DD' and converts it to a ZonedDateTime.
static com.google.gson.JsonPrimitive	getAsPrimitive(com.google.gson.JsonElement jElement)	Gets the JsonElement as JsonPrimitive.
static com.google.gson.JsonPrimitive	getAsPrimitive(com.google.gson.JsonElement jElement, String memberName)	Gets the member of the JsonElement as JsonPrimitive.
static short	getAsShort(com.google.gson.JsonElement jElement)	Gets the JsonElement as short.
static short	getAsShort(com.google.gson.JsonElement jElement, String memberName)	Gets the member of the JsonElement as short.
static String	getAsString(com.google.gson.JsonElement jElement)	Gets the JsonElement as String.
static String	getAsString(com.google.gson.JsonElement jElement, String memberName)	Gets the member of the JsonElement as String.
static String[]	getAsStringArray(com.google.gson.JsonArray json)	Converts a JsonArray to a String Array.
static String	getAsStringOrElse(com.google.gson.JsonElement jElement, String memberName, String alternative)	Gets the member of the JsonElement as String if it exists, and the alternative value otherwise.
static <T> T	getAsType(OpenemsType type, com.google.gson.JsonElement j)	Gets a JsonElement as the given OpenemsType.
static Object	getAsType(Class<?> type, com.google.gson.JsonElement j)	Gets a JsonElement as the given type.
static Object	getAsType(Optional<Class<?>> typeOptional, com.google.gson.JsonElement j)	Gets a JsonElement as the given type.
static UUID	getAsUUID(com.google.gson.JsonElement jElement)	Gets the JsonElement as UUID.
static UUID	getAsUUID(com.google.gson.JsonElement jElement, String memberName)	Gets the member of the JsonElement as UUID.
static ZonedDateTime	getAsZonedDateWithZeroTime(com.google.gson.JsonElement element, String memberName, ZoneId timezone)	Takes a JSON in the form 'YYYY-MM-DD' and converts it to a ZonedDateTime with hour, minute and second set to zero.
static Optional<com.google.gson.JsonElement>	getOptionalSubElement(com.google.gson.JsonElement jElement, String memberName)	Gets the member of the JsonElement as Optional JsonElement.
static com.google.gson.JsonElement	getSubElement(com.google.gson.JsonElement jElement, String memberName)	Gets the member of the JsonElement as JsonElement.
static boolean	isEmptyJsonArray(com.google.gson.JsonElement j)	Check if the given JsonElement is an empty JsonArray [].
static boolean	isEmptyJsonObject(com.google.gson.JsonElement j)	Check if the given JsonElement is an empty JsonObject {}.
static boolean	isNumber(com.google.gson.JsonElement j)	Check if the given JsonElement is a Number.
static com.google.gson.JsonElement	parse(String string)	Parses a string to a JsonElement.
static Optional<com.google.gson.JsonElement>	parseOptional(String string)	Parses a string to a Optional JsonElement.
static com.google.gson.JsonArray	parseToJsonArray(String string)	Parses a string to a JsonArray.
static com.google.gson.JsonObject	parseToJsonObject(String string)	Parses a string to a JsonObject.
static void	prettyPrint(com.google.gson.JsonElement j)	Pretty print a JsonElement.
static String	prettyToString(com.google.gson.JsonElement j)	Pretty toString()-method for a JsonElement.
static Stream<com.google.gson.JsonElement>	stream(com.google.gson.JsonArray jsonArray)	Returns a sequential stream of the JsonElements in the JsonArray.
static com.google.gson.JsonElement	toJson(Boolean bool)	Creates a JsonElement from the Boolean value.
static com.google.gson.JsonElement	toJson(Character c)	Creates a JsonElement from the Boolean value.
static com.google.gson.JsonElement	toJson(Number number)	Creates a JsonElement from the Number value.
static com.google.gson.JsonElement	toJson(String string)	Creates a JsonElement from the Boolean value.
static Collector<com.google.gson.JsonElement,JsonUtils.JsonArrayBuilder,com.google.gson.JsonArray>	toJsonArray()	Returns a Collector that accumulates the input elements into a new JsonArray.
static <T> Collector<T,?,com.google.gson.JsonObject>	toJsonObject(com.google.common.base.Function<T,? extends String> keyMapper, com.google.common.base.Function<T,? extends com.google.gson.JsonElement> valueMapper)	Returns a Collector that accumulates the input elements into a new JsonObject.

Methods inherited from class java.lang.Object

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

Constructor Details

JsonUtils

public JsonUtils()

Method Details

generateJsonArray

public static <T> com.google.gson.JsonArray generateJsonArray(Collection<T> list,
 com.google.common.base.Function<T,com.google.gson.JsonElement> convert)

Provide a easy way to generate a JsonArray from a list using the given convert function to add each element.

Type Parameters:

T - type of an element from list

Parameters:

list - to convert

convert - function to convert elements

Returns:

list as JsonArray

generateJsonArray

public static <T extends com.google.gson.JsonElement>
com.google.gson.JsonArray generateJsonArray(Collection<T> list)

Provide a easy way to generate a JsonArray from a collection of JsonElements.

Type Parameters:

T - type of element from list

Parameters:

list - to convert

Returns:

list as JsonArray

buildJsonArray

public static JsonUtils.JsonArrayBuilder buildJsonArray()

Creates a JsonArray using a Builder.

Returns:

the Builder

buildJsonArray

public static JsonUtils.JsonArrayBuilder buildJsonArray(com.google.gson.JsonArray j)

Creates a JsonArray using a Builder. Initialized from an existing JsonArray.

Parameters:

j - the initial JsonArray

Returns:

the Builder

buildJsonObject

public static JsonUtils.JsonObjectBuilder buildJsonObject()

Creates a JsonObject using a Builder.

Returns:

the Builder

buildJsonObject

public static JsonUtils.JsonObjectBuilder buildJsonObject(com.google.gson.JsonObject j)

Creates a JsonObject using a Builder. Initialized from an existing JsonObject.

Parameters:

j - the initial JsonObject

Returns:

the Builder

toJson

public static com.google.gson.JsonElement toJson(Number number)

Creates a JsonElement from the Number value.

Parameters:

number - the Number

Returns:

a JsonPrimitive or JsonNull

toJson

public static com.google.gson.JsonElement toJson(Boolean bool)

Creates a JsonElement from the Boolean value.

Parameters:

bool - the Boolean

Returns:

a JsonPrimitive or JsonNull

toJson

public static com.google.gson.JsonElement toJson(Character c)

Creates a JsonElement from the Boolean value.

Parameters:

c - the Character

Returns:

a JsonPrimitive or JsonNull

toJson

public static com.google.gson.JsonElement toJson(String string)

Creates a JsonElement from the Boolean value.

Parameters:

string - the String

Returns:

a JsonPrimitive or JsonNull

getAsPrimitive

public static com.google.gson.JsonPrimitive getAsPrimitive(com.google.gson.JsonElement jElement)
                                                    throws OpenemsError.OpenemsNamedException

Gets the JsonElement as JsonPrimitive.

Parameters:

jElement - the JsonElement

Returns:

the JsonPrimitive value

Throws:

OpenemsError.OpenemsNamedException - on error

getAsPrimitive

public static com.google.gson.JsonPrimitive getAsPrimitive(com.google.gson.JsonElement jElement,
 String memberName)
                                                    throws OpenemsError.OpenemsNamedException

Gets the member of the JsonElement as JsonPrimitive.

Parameters:

jElement - the JsonElement

memberName - the name of the member

Returns:

the JsonPrimitive value

Throws:

OpenemsError.OpenemsNamedException - on error

getAsOptionalPrimitive

public static Optional<com.google.gson.JsonPrimitive> getAsOptionalPrimitive(com.google.gson.JsonElement jElement,
 String memberName)

Gets the member of the JsonElement as Optional JsonPrimitive.

Parameters:

jElement - the JsonElement

memberName - the name of the member

Returns:

the Optional JsonPrimitive value

Throws:

OpenemsError.OpenemsNamedException - on error

getSubElement

public static com.google.gson.JsonElement getSubElement(com.google.gson.JsonElement jElement,
 String memberName)
                                                 throws OpenemsError.OpenemsNamedException

Gets the member of the JsonElement as JsonElement.

Parameters:

jElement - the JsonElement

memberName - the name of the member

Returns:

the JsonElement value

Throws:

OpenemsError.OpenemsNamedException - on error

getOptionalSubElement

public static Optional<com.google.gson.JsonElement> getOptionalSubElement(com.google.gson.JsonElement jElement,
 String memberName)

Gets the member of the JsonElement as Optional JsonElement.

Parameters:

jElement - the JsonElement

memberName - the name of the member

Returns:

the Optional JsonElement value

Throws:

OpenemsError.OpenemsNamedException - on error

getAsJsonObject

public static com.google.gson.JsonObject getAsJsonObject(com.google.gson.JsonElement jElement)
                                                  throws OpenemsError.OpenemsNamedException

Gets the JsonElement as JsonObject.

Parameters:

jElement - the JsonElement

Returns:

the JsonObject value

Throws:

OpenemsError.OpenemsNamedException - on error

getAsJsonObject

public static com.google.gson.JsonObject getAsJsonObject(com.google.gson.JsonElement jElement,
 String memberName)
                                                  throws OpenemsError.OpenemsNamedException

Gets the member of the JsonElement as JsonObject.

Parameters:

jElement - the JsonElement

memberName - the name of the member

Returns:

the JsonObject value

Throws:

OpenemsError.OpenemsNamedException - on error

getAsOptionalJsonObject

public static Optional<com.google.gson.JsonObject> getAsOptionalJsonObject(com.google.gson.JsonElement jElement)

Gets the JsonElement as Optional JsonObject.

Parameters:

jElement - the JsonElement

Returns:

the Optional JsonObject value

Throws:

OpenemsError.OpenemsNamedException - on error

getAsOptionalJsonObject

public static Optional<com.google.gson.JsonObject> getAsOptionalJsonObject(com.google.gson.JsonElement jElement,
 String memberName)

Gets the member of the JsonElement as Optional JsonObject.

Parameters:

jElement - the JsonElement

memberName - the name of the member

Returns:

the Optional JsonObject value

Throws:

OpenemsError.OpenemsNamedException - on error

getAsJsonArray

public static com.google.gson.JsonArray getAsJsonArray(com.google.gson.JsonElement jElement)
                                                throws OpenemsError.OpenemsNamedException

Gets the JsonElement as JsonArray.

Parameters:

jElement - the JsonElement

Returns:

the JsonArray value

Throws:

OpenemsError.OpenemsNamedException - on error

getAsJsonArray

public static com.google.gson.JsonArray getAsJsonArray(com.google.gson.JsonElement jElement,
 String memberName)
                                                throws OpenemsError.OpenemsNamedException

Gets the member of the JsonElement as JsonArray.

Parameters:

jElement - the JsonElement

memberName - the name of the member

Returns:

the JsonArray value

Throws:

OpenemsError.OpenemsNamedException - on error

getAsOptionalJsonArray

public static Optional<com.google.gson.JsonArray> getAsOptionalJsonArray(com.google.gson.JsonElement jElement)

Gets the member of the JsonElement as Optional JsonArray.

Parameters:

jElement - the JsonElement

Returns:

the Optional JsonArray value

Throws:

OpenemsError.OpenemsNamedException - on error

getAsOptionalJsonArray

public static Optional<com.google.gson.JsonArray> getAsOptionalJsonArray(com.google.gson.JsonElement jElement,
 String memberName)

Gets the member of the JsonElement as Optional JsonArray.

Parameters:

jElement - the JsonElement

memberName - the name of the member

Returns:

the Optional JsonArray value

Throws:

OpenemsError.OpenemsNamedException - on error

getAsString

public static String getAsString(com.google.gson.JsonElement jElement)
                          throws OpenemsError.OpenemsNamedException

Gets the JsonElement as String.

Parameters:

jElement - the JsonElement

Returns:

the String value

Throws:

OpenemsError.OpenemsNamedException - on error

getAsString

public static String getAsString(com.google.gson.JsonElement jElement,
 String memberName)
                          throws OpenemsError.OpenemsNamedException

Gets the member of the JsonElement as String.

Parameters:

jElement - the JsonElement

memberName - the name of the member

Returns:

the String value

Throws:

OpenemsError.OpenemsNamedException - on error

getAsOptionalString

public static Optional<String> getAsOptionalString(com.google.gson.JsonElement jElement)

Gets the JsonElement as Optional String.

Parameters:

jElement - the JsonElement

Returns:

the Optional String value

Throws:

OpenemsError.OpenemsNamedException - on error

getAsOptionalString

public static Optional<String> getAsOptionalString(com.google.gson.JsonElement jElement,
 String memberName)

Gets the member of the JsonElement as Optional String.

Parameters:

jElement - the JsonElement

memberName - the name of the member

Returns:

the Optional String value

Throws:

OpenemsError.OpenemsNamedException - on error

getAsStringOrElse

public static String getAsStringOrElse(com.google.gson.JsonElement jElement,
 String memberName,
 String alternative)

Gets the member of the JsonElement as String if it exists, and the alternative value otherwise.

Parameters:

jElement - the JsonElement

memberName - the name of the member

alternative - the alternative value

Returns:

the String value or the alternative value

getAsStringArray

public static String[] getAsStringArray(com.google.gson.JsonArray json)
                                 throws OpenemsError.OpenemsNamedException

Converts a JsonArray to a String Array.

Parameters:

json - the JsonArray

Returns:

a String Array

Throws:

OpenemsError.OpenemsNamedException - on error

getAsBoolean

public static boolean getAsBoolean(com.google.gson.JsonElement jElement)
                            throws OpenemsError.OpenemsNamedException

Gets the JsonElement as Boolean.

Parameters:

jElement - the JsonElement

Returns:

the Boolean value

Throws:

OpenemsError.OpenemsNamedException - on error

getAsBoolean

public static boolean getAsBoolean(com.google.gson.JsonElement jElement,
 String memberName)
                            throws OpenemsError.OpenemsNamedException

Gets the member of the JsonElement as Boolean.

Parameters:

jElement - the JsonElement

memberName - the name of the member

Returns:

the Boolean value

Throws:

OpenemsError.OpenemsNamedException - on error

getAsOptionalBoolean

public static Optional<Boolean> getAsOptionalBoolean(com.google.gson.JsonElement jElement)

Gets the JsonElement as an Optional Boolean.

Parameters:

jElement - the JsonElement

Returns:

the Optional Boolean value

Throws:

OpenemsError.OpenemsNamedException - on error

getAsOptionalBoolean

public static Optional<Boolean> getAsOptionalBoolean(com.google.gson.JsonElement jElement,
 String memberName)

Gets the member of the JsonElement as an Optional Boolean.

Parameters:

jElement - the JsonElement

memberName - the name of the member

Returns:

the Optional Boolean value

Throws:

OpenemsError.OpenemsNamedException - on error

getAsShort

public static short getAsShort(com.google.gson.JsonElement jElement)
                        throws OpenemsError.OpenemsNamedException

Gets the JsonElement as short.

Parameters:

jElement - the JsonElement

Returns:

the short value

Throws:

OpenemsError.OpenemsNamedException - on error

getAsShort

public static short getAsShort(com.google.gson.JsonElement jElement,
 String memberName)
                        throws OpenemsError.OpenemsNamedException

Gets the member of the JsonElement as short.

Parameters:

jElement - the JsonElement

memberName - the name of the member

Returns:

the short value

Throws:

OpenemsError.OpenemsNamedException - on error

getAsOptionalShort

public static Optional<Short> getAsOptionalShort(com.google.gson.JsonElement jElement)

Gets the JsonElement as an Optional Short.

Parameters:

jElement - the JsonElement

Returns:

the Optional Short value

Throws:

OpenemsError.OpenemsNamedException - on error

getAsOptionalShort

public static Optional<Short> getAsOptionalShort(com.google.gson.JsonElement jElement,
 String memberName)

Gets the member of the JsonElement as an Optional Short.

Parameters:

jElement - the JsonElement

memberName - the name of the member

Returns:

the Optional Boolean value

Throws:

OpenemsError.OpenemsNamedException - on error

getAsInt

public static int getAsInt(com.google.gson.JsonElement jElement)
                    throws OpenemsError.OpenemsNamedException

Gets the JsonElement as int.

Parameters:

jElement - the JsonElement

Returns:

the int value

Throws:

OpenemsError.OpenemsNamedException - on error

getAsInt

public static int getAsInt(com.google.gson.JsonElement jElement,
 String memberName)
                    throws OpenemsError.OpenemsNamedException

Gets the member of the JsonElement as int.

Parameters:

jElement - the JsonElement

memberName - the name of the member

Returns:

the int value

Throws:

OpenemsError.OpenemsNamedException - on error

getAsInt

public static int getAsInt(com.google.gson.JsonArray jArray,
 int index)
                    throws OpenemsError.OpenemsNamedException

Gets the member with given index of the JsonArray as int.

Parameters:

jArray - the JsonArray

index - the index of the member

Returns:

the int value

Throws:

OpenemsError.OpenemsNamedException - on error

getAsOptionalInt

public static Optional<Integer> getAsOptionalInt(com.google.gson.JsonElement jElement)

Gets the JsonElement as Optional Integer.

Parameters:

jElement - the JsonElement

Returns:

the Optional Integer value

Throws:

OpenemsError.OpenemsNamedException - on error

getAsOptionalInt

public static Optional<Integer> getAsOptionalInt(com.google.gson.JsonElement jElement,
 String memberName)

Gets the member of the JsonElement as Optional Integer.

Parameters:

jElement - the JsonElement

memberName - the name of the member

Returns:

the Optional Integer value

Throws:

OpenemsError.OpenemsNamedException - on error

getAsLong

public static long getAsLong(com.google.gson.JsonElement jElement)
                      throws OpenemsError.OpenemsNamedException

Gets the JsonElement as long.

Parameters:

jElement - the JsonElement

Returns:

the long value

Throws:

OpenemsError.OpenemsNamedException - on error

getAsLong

public static long getAsLong(com.google.gson.JsonElement jElement,
 String memberName)
                      throws OpenemsError.OpenemsNamedException

Gets the member of the JsonElement as long.

Parameters:

jElement - the JsonElement

memberName - the name of the member

Returns:

the long value

Throws:

OpenemsError.OpenemsNamedException - on error

getAsOptionalLong

public static Optional<Long> getAsOptionalLong(com.google.gson.JsonElement jElement)

Gets the JsonElement as Optional Long.

Parameters:

jElement - the JsonElement

Returns:

the Optional Long value

Throws:

OpenemsError.OpenemsNamedException - on error

getAsOptionalLong

public static Optional<Long> getAsOptionalLong(com.google.gson.JsonElement jElement,
 String memberName)

Gets the member of the JsonElement as Optional Long.

Parameters:

jElement - the JsonElement

memberName - the name of the member

Returns:

the Optional Long value

Throws:

OpenemsError.OpenemsNamedException - on error

getAsFloat

public static float getAsFloat(com.google.gson.JsonElement jElement)
                        throws OpenemsError.OpenemsNamedException

Gets the JsonElement as Float.

Parameters:

jElement - the JsonElement

Returns:

the Float value

Throws:

OpenemsError.OpenemsNamedException - on error

getAsFloat

public static float getAsFloat(com.google.gson.JsonElement jElement,
 String memberName)
                        throws OpenemsError.OpenemsNamedException

Gets the member of the JsonElement as Float.

Parameters:

jElement - the JsonElement

memberName - the name of the member

Returns:

the Float value

Throws:

OpenemsError.OpenemsNamedException - on error

getAsOptionalFloat

public static Optional<Float> getAsOptionalFloat(com.google.gson.JsonElement jElement)

Gets the JsonElement as Optional Float.

Parameters:

jElement - the JsonElement

Returns:

the Optional Float value

Throws:

OpenemsError.OpenemsNamedException - on error

getAsOptionalFloat

public static Optional<Float> getAsOptionalFloat(com.google.gson.JsonElement jElement,
 String memberName)

Gets the member of the JsonElement as Optional Float.

Parameters:

jElement - the JsonElement

memberName - the name of the member

Returns:

the Optional Float value

Throws:

OpenemsError.OpenemsNamedException - on error

getAsDouble

public static double getAsDouble(com.google.gson.JsonElement jElement)
                          throws OpenemsError.OpenemsNamedException

Gets the JsonElement as Double.

Parameters:

jElement - the JsonElement

Returns:

the Double value

Throws:

OpenemsError.OpenemsNamedException - on error

getAsDouble

public static double getAsDouble(com.google.gson.JsonElement jElement,
 String memberName)
                          throws OpenemsError.OpenemsNamedException

Gets the member of the JsonElement as Double.

Parameters:

jElement - the JsonElement

memberName - the name of the member

Returns:

the Double value

Throws:

OpenemsError.OpenemsNamedException - on error

getAsOptionalDouble

public static Optional<Double> getAsOptionalDouble(com.google.gson.JsonElement jElement)

Gets the JsonElement as Optional Double.

Parameters:

jElement - the JsonElement

Returns:

the Optional Double value

Throws:

OpenemsError.OpenemsNamedException - on error

getAsOptionalDouble

public static Optional<Double> getAsOptionalDouble(com.google.gson.JsonElement jElement,
 String memberName)

Gets the member of the JsonElement as Optional Double.

Parameters:

jElement - the JsonElement

memberName - the name of the member

Returns:

the Optional Double value

Throws:

OpenemsError.OpenemsNamedException - on error

getAsEnum

public static <E extends Enum<E>> E getAsEnum(Class<E> enumType,
 com.google.gson.JsonElement jElement)
                                       throws OpenemsError.OpenemsNamedException

Gets the JsonElement as Enum.

Type Parameters:

E - the Enum type

Parameters:

enumType - the class of the Enum

jElement - the JsonElement

Returns:

the Enum value

Throws:

OpenemsError.OpenemsNamedException - on error

getAsEnum

public static <E extends Enum<E>> E getAsEnum(Class<E> enumType,
 com.google.gson.JsonElement jElement,
 String memberName)
                                       throws OpenemsError.OpenemsNamedException

Gets the member of the JsonElement as Enum.

Type Parameters:

E - the Enum type

Parameters:

enumType - the class of the Enum

jElement - the JsonElement

memberName - the name of the member

Returns:

the Enum value

Throws:

OpenemsError.OpenemsNamedException - on error

getAsOptionalEnum

public static <E extends Enum<E>> Optional<E> getAsOptionalEnum(Class<E> enumType,
 com.google.gson.JsonElement jElement)

Gets the JsonElement as Optional Enum.

Type Parameters:

E - the Enum type

Parameters:

enumType - the class of the Enum

jElement - the JsonElement

Returns:

the Optional Enum value

Throws:

OpenemsError.OpenemsNamedException - on error

getAsOptionalEnum

public static <E extends Enum<E>> Optional<E> getAsOptionalEnum(Class<E> enumType,
 com.google.gson.JsonElement jElement,
 String memberName)

Gets the member of the JsonElement as Optional Enum.

Type Parameters:

E - the Enum type

Parameters:

enumType - the class of the Enum

jElement - the JsonElement

memberName - the name of the member

Returns:

the Optional Enum value

Throws:

OpenemsError.OpenemsNamedException - on error

getAsInet4Address

public static Inet4Address getAsInet4Address(com.google.gson.JsonElement jElement)
                                      throws OpenemsError.OpenemsNamedException

Gets the JsonElement as Inet4Address.

Parameters:

jElement - the JsonElement

Returns:

the Inet4Address value

Throws:

OpenemsError.OpenemsNamedException - on error

getAsInet4Address

public static Inet4Address getAsInet4Address(com.google.gson.JsonElement jElement,
 String memberName)
                                      throws OpenemsError.OpenemsNamedException

Gets the member of the JsonElement as Inet4Address.

Parameters:

jElement - the JsonElement

memberName - the name of the member

Returns:

the Inet4Address value

Throws:

OpenemsError.OpenemsNamedException - on error

getAsOptionalInet4Address

public static Optional<Inet4Address> getAsOptionalInet4Address(com.google.gson.JsonElement jElement)

Gets the JsonElement as Optional Inet4Address.

Parameters:

jElement - the JsonElement

Returns:

the Optional Inet4Address value

Throws:

OpenemsError.OpenemsNamedException - on error

getAsOptionalInet4Address

public static Optional<Inet4Address> getAsOptionalInet4Address(com.google.gson.JsonElement jElement,
 String memberName)

Gets the member of the JsonElement as Optional Inet4Address.

Parameters:

jElement - the JsonElement

memberName - the name of the member

Returns:

the Optional Inet4Address value

Throws:

OpenemsError.OpenemsNamedException - on error

getAsUUID

public static UUID getAsUUID(com.google.gson.JsonElement jElement)
                      throws OpenemsError.OpenemsNamedException

Gets the JsonElement as UUID.

Parameters:

jElement - the JsonElement

Returns:

the UUID value

Throws:

OpenemsError.OpenemsNamedException - on error

getAsUUID

public static UUID getAsUUID(com.google.gson.JsonElement jElement,
 String memberName)
                      throws OpenemsError.OpenemsNamedException

Gets the member of the JsonElement as UUID.

Parameters:

jElement - the JsonElement

memberName - the name of the member

Returns:

the UUID value

Throws:

OpenemsError.OpenemsNamedException - on error

getAsOptionalUUID

public static Optional<UUID> getAsOptionalUUID(com.google.gson.JsonElement jElement)

Gets the JsonElement as Optional UUID.

Parameters:

jElement - the JsonElement

Returns:

the Optional UUID value

Throws:

OpenemsError.OpenemsNamedException - on error

getAsOptionalUUID

public static Optional<UUID> getAsOptionalUUID(com.google.gson.JsonElement jElement,
 String memberName)

Gets the member of the JsonElement as Optional UUID.

Parameters:

jElement - the JsonElement

memberName - the name of the member

Returns:

the Optional UUID value

Throws:

OpenemsError.OpenemsNamedException - on error

getAsBestType

public static Object getAsBestType(com.google.gson.JsonElement j)
                            throws OpenemsError.OpenemsNamedException

Tries to find the best matching Object representation of the given JsonElement.

Parameters:

j - the JsonElement

Returns:

the Object

Throws:

OpenemsError.OpenemsNamedException - on error

getAsJsonElement

public static com.google.gson.JsonElement getAsJsonElement(Object value)

Gets a JsonElement representing the Object value.

Parameters:

value - the Object value

Returns:

the JsonElement

getAsType

public static Object getAsType(Class<?> type,
 com.google.gson.JsonElement j)
                        throws NotImplementedException,
IllegalStateException

Gets a JsonElement as the given type.

Parameters:

type - the class of the type

j - the JsonElement

Returns:

an Object of the given type

Throws:

NotImplementedException

IllegalStateException

getAsType

public static <T> T getAsType(OpenemsType type,
 com.google.gson.JsonElement j)
                       throws OpenemsError.OpenemsNamedException

Gets a JsonElement as the given OpenemsType.

Type Parameters:

T - the Type for implicit casting of the result

Parameters:

type - the OpenemsType

j - the JsonElement

Returns:

an Object of the given type

Throws:

OpenemsError.OpenemsNamedException

getAsType

public static Object getAsType(Optional<Class<?>> typeOptional,
 com.google.gson.JsonElement j)
                        throws NotImplementedException

Gets a JsonElement as the given type.

Parameters:

typeOptional - the class of the type

j - the JsonElement

Returns:

an Object of the given type

Throws:

NotImplementedException

getAsZonedDateWithZeroTime

public static ZonedDateTime getAsZonedDateWithZeroTime(com.google.gson.JsonElement element,
 String memberName,
 ZoneId timezone)
                                                throws OpenemsError.OpenemsNamedException

Takes a JSON in the form 'YYYY-MM-DD' and converts it to a ZonedDateTime with hour, minute and second set to zero.

Parameters:

element - the JsonElement

memberName - the name of the member of the JsonObject

timezone - the timezone as ZoneId

Returns:

the ZonedDateTime

Throws:

OpenemsError.OpenemsNamedException - on parse error

getAsOptionalZonedDateTime

public static Optional<ZonedDateTime> getAsOptionalZonedDateTime(com.google.gson.JsonElement element,
 String memberName)
                                                          throws OpenemsError.OpenemsNamedException

Takes a JSON in the form 'YYYY-MM-DD' and converts it to a ZonedDateTime.

Parameters:

element - the JsonElement

memberName - the name of the member of the JsonObject

Returns:

the ZonedDateTime

Throws:

OpenemsError.OpenemsNamedException

parse

public static com.google.gson.JsonElement parse(String string)
                                         throws OpenemsError.OpenemsNamedException

Parses a string to a JsonElement.

Parameters:

string - to be parsed

Returns:

the JsonElement

Throws:

OpenemsError.OpenemsNamedException - on error

parseOptional

public static Optional<com.google.gson.JsonElement> parseOptional(String string)

Parses a string to a Optional JsonElement.

Parameters:

string - to be parsed

Returns:

the Optional of the result; Optional.empty() if the value can not be parsed

parseToJsonObject

public static com.google.gson.JsonObject parseToJsonObject(String string)
                                                    throws OpenemsError.OpenemsNamedException

Parses a string to a JsonObject.

Parameters:

string - the String

Returns:

the JsonObject

Throws:

OpenemsError.OpenemsNamedException - on error

parseToJsonArray

public static com.google.gson.JsonArray parseToJsonArray(String string)
                                                  throws OpenemsError.OpenemsNamedException

Parses a string to a JsonArray.

Parameters:

string - the String

Returns:

the JsonArray

Throws:

OpenemsError.OpenemsNamedException - on error

prettyPrint

public static void prettyPrint(com.google.gson.JsonElement j)

Pretty print a JsonElement.

Parameters:

j - the JsonElement

prettyToString

public static String prettyToString(com.google.gson.JsonElement j)

Pretty toString()-method for a JsonElement.

Parameters:

j - the JsonElement

Returns:

a pretty string representing the JsonElement using GsonBuilder.setPrettyPrinting()

isEmptyJsonObject

public static boolean isEmptyJsonObject(com.google.gson.JsonElement j)

Check if the given JsonElement is an empty JsonObject {}.

Parameters:

j - the JsonElement to check

Returns:

true if is empty, otherwise false

isEmptyJsonArray

public static boolean isEmptyJsonArray(com.google.gson.JsonElement j)

Check if the given JsonElement is an empty JsonArray [].

Parameters:

j - the JsonElement to check

Returns:

true if is empty, otherwise false

isNumber

public static boolean isNumber(com.google.gson.JsonElement j)

Check if the given JsonElement is a Number.

Parameters:

j - the JsonElement to check

Returns:

true if the element is a Number, otherwise false

stream

public static Stream<com.google.gson.JsonElement> stream(com.google.gson.JsonArray jsonArray)

Returns a sequential stream of the JsonElements in the JsonArray.

Parameters:

jsonArray - The JsonArray, assumed to be unmodified during use

Returns:

a Stream of the elements

toJsonObject

public static <T>
Collector<T,?,com.google.gson.JsonObject> toJsonObject(com.google.common.base.Function<T,? extends String> keyMapper,
 com.google.common.base.Function<T,? extends com.google.gson.JsonElement> valueMapper)

Returns a Collector that accumulates the input elements into a new JsonObject.

Type Parameters:

T - the type of the input

Parameters:

keyMapper - the key mapper

valueMapper - the value mapper

Returns:

the Collector

toJsonArray

public static Collector<com.google.gson.JsonElement,JsonUtils.JsonArrayBuilder,com.google.gson.JsonArray> toJsonArray()

Returns a Collector that accumulates the input elements into a new JsonArray.

Returns:

a Collector which collects all the input elements into a JsonArray