Package step.artefacts.handlers
Interface OutputJsonObject
- All Known Implementing Classes:
UserFriendlyJsonObject
Equivalent to the
JsonObject
, but implementing the Map<String, Object> instead of Map<String, JsonValue>
to simplify usage as output object in CallFunctionHandler
-
Nested Class Summary
Nested classes/interfaces inherited from interface jakarta.json.JsonValue
jakarta.json.JsonValue.ValueType
-
Field Summary
Fields inherited from interface jakarta.json.JsonValue
EMPTY_JSON_ARRAY, EMPTY_JSON_OBJECT, FALSE, NULL, TRUE
-
Method Summary
Modifier and TypeMethodDescriptionboolean
getBoolean
(String name) Returns the boolean value of the associated mapping for the specified name.boolean
getBoolean
(String name, boolean defaultValue) Returns the boolean value of the associated mapping for the specified name.int
A convenience method forgetJsonNumber(name).intValue()
int
Returns the int value of the associatedJsonNumber
mapping for the specified name.jakarta.json.JsonArray
getJsonArray
(String name) Returns the array value to which the specified name is mapped.jakarta.json.JsonNumber
getJsonNumber
(String name) Returns the number value to which the specified name is mapped.jakarta.json.JsonObject
getJsonObject
(String name) Returns the object value to which the specified name is mapped.jakarta.json.JsonString
getJsonString
(String name) Returns the string value to which the specified name is mapped.A convenience method forgetJsonString(name).getString()
Returns the string value of the associatedJsonString
mapping for the specified name.boolean
Returnstrue
if the associated value for the specified name isJsonValue.NULL
.Methods inherited from interface jakarta.json.JsonStructure
getValue
Methods inherited from interface jakarta.json.JsonValue
asJsonArray, asJsonObject, getValueType, toString
Methods inherited from interface java.util.Map
clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values
-
Method Details
-
getJsonArray
Returns the array value to which the specified name is mapped. This is a convenience method for(JsonArray)get(name)
to get the value.- Parameters:
name
- the name whose associated value is to be returned- Returns:
- the array value to which the specified name is mapped, or
null
if this object contains no mapping for the name - Throws:
ClassCastException
- if the value to which the specified name is mapped is not assignable to JsonArray type
-
getJsonObject
Returns the object value to which the specified name is mapped. This is a convenience method for(JsonObject)get(name)
to get the value.- Parameters:
name
- the name whose associated value is to be returned- Returns:
- the object value to which the specified name is mapped, or
null
if this object contains no mapping for the name - Throws:
ClassCastException
- if the value to which the specified name is mapped is not assignable to JsonObject type
-
getJsonNumber
Returns the number value to which the specified name is mapped. This is a convenience method for(JsonNumber)get(name)
to get the value.- Parameters:
name
- the name whose associated value is to be returned- Returns:
- the number value to which the specified name is mapped, or
null
if this object contains no mapping for the name - Throws:
ClassCastException
- if the value to which the specified name is mapped is not assignable to JsonNumber type
-
getJsonString
Returns the string value to which the specified name is mapped. This is a convenience method for(JsonString)get(name)
to get the value.- Parameters:
name
- the name whose associated value is to be returned- Returns:
- the string value to which the specified name is mapped, or
null
if this object contains no mapping for the name - Throws:
ClassCastException
- if the value to which the specified name is mapped is not assignable to JsonString type
-
getString
A convenience method forgetJsonString(name).getString()
- Parameters:
name
- whose associated value is to be returned as String- Returns:
- the String value to which the specified name is mapped
- Throws:
NullPointerException
- if the specified name doesn't have any mappingClassCastException
- if the value for specified name mapping is not assignable to JsonString
-
getString
Returns the string value of the associatedJsonString
mapping for the specified name. IfJsonString
is found, then itsJsonString.getString()
is returned. Otherwise, the specified default value is returned.- Parameters:
name
- whose associated value is to be returned as StringdefaultValue
- a default value to be returned- Returns:
- the string value of the associated mapping for the name, or the default value
-
getInt
A convenience method forgetJsonNumber(name).intValue()
- Parameters:
name
- whose associated value is to be returned as int- Returns:
- the int value to which the specified name is mapped
- Throws:
NullPointerException
- if the specified name doesn't have any mappingClassCastException
- if the value for specified name mapping is not assignable to JsonNumber
-
getInt
Returns the int value of the associatedJsonNumber
mapping for the specified name. IfJsonNumber
is found, then itsJsonNumber.intValue()
is returned. Otherwise, the specified default value is returned.- Parameters:
name
- whose associated value is to be returned as intdefaultValue
- a default value to be returned- Returns:
- the int value of the associated mapping for the name, or the default value
-
getBoolean
Returns the boolean value of the associated mapping for the specified name. If the associated mapping is JsonValue.TRUE, then returns true. If the associated mapping is JsonValue.FALSE, then returns false.- Parameters:
name
- whose associated value is to be returned as boolean- Returns:
- the boolean value to which the specified name is mapped
- Throws:
NullPointerException
- if the specified name doesn't have any mappingClassCastException
- if the value for specified name mapping is not assignable to JsonValue.TRUE or JsonValue.FALSE
-
getBoolean
Returns the boolean value of the associated mapping for the specified name. If the associated mapping is JsonValue.TRUE, then returns true. If the associated mapping is JsonValue.FALSE, then returns false. Otherwise, the specified default value is returned.- Parameters:
name
- whose associated value is to be returned as intdefaultValue
- a default value to be returned- Returns:
- the boolean value of the associated mapping for the name, or the default value
-
isNull
Returnstrue
if the associated value for the specified name isJsonValue.NULL
.- Parameters:
name
- name whose associated value is checked- Returns:
- return true if the associated value is
JsonValue.NULL
, otherwise false - Throws:
NullPointerException
- if the specified name doesn't have any mapping
-