com.alibaba.fastjson2

Class JSONObject

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<K,V>

java.util.LinkedHashMap<java.lang.String,java.lang.Object>

com.alibaba.fastjson2.JSONObject

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.reflect.InvocationHandler, java.util.Map<java.lang.String,java.lang.Object>

public class JSONObject
extends java.util.LinkedHashMap<java.lang.String,java.lang.Object>
implements java.lang.reflect.InvocationHandler

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) static class	JSONObject.NameConsumer Consumer for processing method names.

Nested classes/interfaces inherited from class java.util.AbstractMap

java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
(package private) static ObjectReader<JSONArray>	arrayReader
(package private) static long	NONE_DIRECT_FEATURES
private static long	serialVersionUID

Constructor Summary

Constructors

Constructor and Description
JSONObject() default
JSONObject(int initialCapacity)
JSONObject(int initialCapacity, float loadFactor)
JSONObject(int initialCapacity, float loadFactor, boolean accessOrder)
JSONObject(java.util.Map map)

Method Summary

Modifier and Type	Method and Description
JSONObject	clone()
boolean	containsKey(java.lang.Object key) Returns true if this map contains a mapping for the specified key
boolean	containsKey(java.lang.String key) Returns true if this map contains a mapping for the specified key
void	copyTo(java.lang.Object object, JSONReader.Feature... features)
java.lang.Object	eval(JSONPath path) Evaluates a JSONPath expression against this JSONObject.
JSONObject	fluentPut(java.lang.String key, java.lang.Object value) Chained addition of elements
void	forEachArrayObject(java.lang.String key, java.util.function.Consumer<JSONObject> action) Iterates over the JSONArray elements associated with the given key.
void	forEchArrayObject(java.lang.String key, java.util.function.Consumer<JSONObject> action) Deprecated. Typo in the method name. Use forEachArrayObject instead
static JSONObject	from(java.lang.Object obj) See JSON.toJSON(java.lang.Object) for details
static JSONObject	from(java.lang.Object obj, JSONWriter.Feature... writeFeatures) See JSON.toJSON(java.lang.Object) for details
java.lang.Object	get(java.lang.Object key) Returns the Object of the associated keys in this JSONObject.
java.lang.Object	get(java.lang.String key) Returns the Object of the associated keys in this JSONObject.
java.math.BigDecimal	getBigDecimal(java.lang.String key) Returns the BigDecimal of the associated keys in this JSONObject.
java.math.BigInteger	getBigInteger(java.lang.String key) Returns the BigInteger of the associated keys in this JSONObject.
java.lang.Boolean	getBoolean(java.lang.String key) Returns the Boolean of the associated keys in this JSONObject.
boolean	getBooleanValue(java.lang.String key) Returns a boolean value of the associated key in this object.
boolean	getBooleanValue(java.lang.String key, boolean defaultValue) Returns a boolean value of the associated key in this object.
java.lang.Object	getByPath(java.lang.String jsonPath)
java.lang.Byte	getByte(java.lang.String key) Returns the Byte of the associated keys in this JSONObject.
byte[]	getBytes(java.lang.String key)
byte	getByteValue(java.lang.String key) Returns a byte value of the associated keys in this JSONObject.
java.util.Date	getDate(java.lang.String key) Returns the Date of the associated keys in this JSONObject.
java.util.Date	getDate(java.lang.String key, java.util.Date defaultValue)
java.lang.Double	getDouble(java.lang.String key) Returns the Double of the associated keys in this JSONObject.
double	getDoubleValue(java.lang.String key) Returns a double value of the associated keys in this JSONObject.
java.lang.Float	getFloat(java.lang.String key) Returns the Float of the associated keys in this JSONObject.
float	getFloatValue(java.lang.String key) Returns a float value of the associated keys in this JSONObject.
java.time.Instant	getInstant(java.lang.String key) Returns the BigInteger of the associated keys in this JSONObject.
java.lang.Integer	getInteger(java.lang.String key) Returns the Integer of the associated keys in this JSONObject.
int	getIntValue(java.lang.String key) Returns an int value of the associated keys in this JSONObject.
int	getIntValue(java.lang.String key, int defaultValue) Returns an int value of the associated keys in this JSONObject.
JSONArray	getJSONArray(java.lang.String key) Returns the JSONArray of the associated keys in this JSONObject.
private java.lang.String	getJSONFieldName(java.lang.reflect.Method method) Gets the JSON field name from the method's annotations.
JSONObject	getJSONObject(java.lang.String key) Returns the JSONObject of the associated keys in this JSONObject.
<T> java.util.List<T>	getList(java.lang.String key, java.lang.Class<T> itemClass, JSONReader.Feature... features) Returns a list of objects of the specified type from the associated JSONArray in this JSONObject.
java.time.LocalDate	getLocalDate(java.lang.String key)
java.time.LocalDate	getLocalDate(java.lang.String key, java.time.LocalDate defaultValue)
java.time.LocalDateTime	getLocalDateTime(java.lang.String key)
java.time.LocalDateTime	getLocalDateTime(java.lang.String key, java.time.LocalDateTime defaultValue)
java.time.LocalTime	getLocalTime(java.lang.String key)
java.time.LocalTime	getLocalTime(java.lang.String key, java.time.LocalTime defaultValue)
java.lang.Long	getLong(java.lang.String key) Returns the Long of the associated keys in this JSONObject.
long	getLongValue(java.lang.String key) Returns a long value of the associated keys in this JSONObject.
long	getLongValue(java.lang.String key, long defaultValue) Returns a long value of the associated keys in this JSONObject.
<T> T	getObject(java.lang.String key, java.lang.Class<T> type, JSONReader.Feature... features) Returns the result of the Type converter conversion of the associated value in this JSONObject.
<T> T	getObject(java.lang.String key, java.util.function.Function<JSONObject,T> creator)
<T> T	getObject(java.lang.String key, java.lang.reflect.Type type, JSONReader.Feature... features) Returns the result of the Type converter conversion of the associated value in this JSONObject.
<T> T	getObject(java.lang.String key, TypeReference<T> typeReference, JSONReader.Feature... features) Returns the result of the Type converter conversion of the associated value in this JSONObject.
java.time.OffsetDateTime	getOffsetDateTime(java.lang.String key)
java.time.OffsetDateTime	getOffsetDateTime(java.lang.String key, java.time.OffsetDateTime defaultValue)
java.time.OffsetTime	getOffsetTime(java.lang.String key)
java.time.OffsetTime	getOffsetTime(java.lang.String key, java.time.OffsetTime defaultValue)
java.lang.Object	getOrDefault(java.lang.Object key, java.lang.Object defaultValue)
java.lang.Object	getOrDefault(java.lang.String key, java.lang.Object defaultValue)
java.lang.Short	getShort(java.lang.String key) Returns the Short of the associated keys in this JSONObject.
short	getShortValue(java.lang.String key) Returns a short value of the associated keys in this JSONObject.
int	getSize(java.lang.String key) Returns the size of the value associated with the given key if it is a Map or Collection.
java.lang.String	getString(java.lang.String key) Returns the String of the associated keys in this JSONObject.
java.lang.String	getString(java.lang.String key, java.lang.String defaultValue) Returns the String of the associated keys in this JSONObject.
java.time.ZonedDateTime	getZonedDateTime(java.lang.String key)
java.time.ZonedDateTime	getZonedDateTime(java.lang.String key, java.time.ZonedDateTime defaultValue)
java.lang.Object	invoke(java.lang.Object proxy, java.lang.reflect.Method method, java.lang.Object[] args) Handles method invocations on a proxy instance.
boolean	isArray(java.lang.Object key)
boolean	isValid(JSONSchema schema) Checks if this JSONObject is valid according to the specified JSON schema.
(package private) static void	nameFilter(java.lang.Iterable<?> iterable, NameFilter nameFilter) Applies a name filter to an iterable collection.
(package private) static void	nameFilter(java.util.Map map, NameFilter nameFilter) Applies a name filter to a map.
void	nameFilter(NameFilter nameFilter) Applies a name filter to this JSONObject.
static JSONObject	of() JSONObject jsonObject = JSONObject.of();
private static JSONObject	of(JSONObject jsonObject, java.lang.Object... kvArray) Pack multiple key-value pairs as JSONObject
static JSONObject	of(java.lang.String key, java.lang.Object value) Pack a pair of key-values as JSONObject
static JSONObject	of(java.lang.String k1, java.lang.Object v1, java.lang.String k2, java.lang.Object v2) Pack two key-value pairs as JSONObject
static JSONObject	of(java.lang.String k1, java.lang.Object v1, java.lang.String k2, java.lang.Object v2, java.lang.String k3, java.lang.Object v3) Pack three key-value pairs as JSONObject
static JSONObject	of(java.lang.String k1, java.lang.Object v1, java.lang.String k2, java.lang.Object v2, java.lang.String k3, java.lang.Object v3, java.lang.String k4, java.lang.Object v4) Pack three key-value pairs as JSONObject
static JSONObject	of(java.lang.String k1, java.lang.Object v1, java.lang.String k2, java.lang.Object v2, java.lang.String k3, java.lang.Object v3, java.lang.String k4, java.lang.Object v4, java.lang.String k5, java.lang.Object v5) Pack three key-value pairs as JSONObject
static JSONObject	of(java.lang.String k1, java.lang.Object v1, java.lang.String k2, java.lang.Object v2, java.lang.String k3, java.lang.Object v3, java.lang.String k4, java.lang.Object v4, java.lang.String k5, java.lang.Object v5, java.lang.Object... kvArray) Pack multiple key-value pairs as JSONObject
static JSONObject	parse(java.lang.String text, JSONReader.Feature... features) See JSON.parse(java.lang.String) for details
static JSONObject	parseObject(java.lang.String text) See JSON.parseObject(java.lang.String) for details
static <T> T	parseObject(java.lang.String text, java.lang.Class<T> objectClass) See JSON.parseObject(java.lang.String) for details
static <T> T	parseObject(java.lang.String text, java.lang.Class<T> objectClass, JSONReader.Feature... features) See JSON.parseObject(java.lang.String) for details
static <T> T	parseObject(java.lang.String text, java.lang.reflect.Type objectType, JSONReader.Feature... features) See JSON.parseObject(java.lang.String) for details
static <T> T	parseObject(java.lang.String text, TypeReference<T> typeReference, JSONReader.Feature... features) See JSON.parseObject(java.lang.String) for details
JSONArray	putArray(java.lang.String name) Creates and puts a new JSONArray with the specified name.
JSONObject	putObject(java.lang.String name) Creates and puts a new JSONObject with the specified name.
<T> T	to(java.lang.Class<T> clazz, JSONReader.Feature... features) Convert this JSONObject to the specified Object
<T> T	to(java.util.function.Function<JSONObject,T> function)
<T> T	to(java.lang.reflect.Type type, JSONReader.Feature... features) Convert this JSONObject to the specified Object
<T> T	to(TypeReference<T> typeReference, JSONReader.Feature... features) Convert this JSONObject to the specified Object
<T> T	toJavaObject(java.lang.Class<T> clazz, JSONReader.Feature... features) Convert this JSONObject to the specified Object
<T> T	toJavaObject(java.lang.reflect.Type type, JSONReader.Feature... features) Deprecated. since 2.0.4, please use to(Type, JSONReader.Feature...)
<T> T	toJavaObject(TypeReference<T> typeReference, JSONReader.Feature... features) Deprecated. since 2.0.4, please use to(Type, JSONReader.Feature...)
byte[]	toJSONBBytes(JSONWriter.Feature... features) Serialize to JSONB bytes
java.lang.String	toJSONString(JSONWriter.Feature... features) Serialize to JSON String
static java.lang.String	toJSONString(java.lang.Object object, JSONWriter.Feature... features) Serialize Java Object to JSON String with specified JSONReader.Features enabled
java.lang.String	toString() Serialize to JSON String
java.lang.String	toString(JSONWriter.Feature... features) Serialize to JSON String
(package private) static void	valueFilter(java.lang.Iterable<?> iterable, ValueFilter valueFilter) Applies a value filter to an iterable collection.
(package private) static void	valueFilter(java.util.Map map, ValueFilter valueFilter) Applies a value filter to a map.
void	valueFilter(ValueFilter valueFilter) Applies a value filter to this JSONObject.

Methods inherited from class java.util.LinkedHashMap

clear, containsValue, entrySet, forEach, keySet, removeEldestEntry, replaceAll, values

Methods inherited from class java.util.HashMap

compute, computeIfAbsent, computeIfPresent, isEmpty, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, size

Methods inherited from class java.util.AbstractMap

equals, hashCode

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, equals, hashCode, isEmpty, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, size

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

arrayReader

static ObjectReader<JSONArray> arrayReader

NONE_DIRECT_FEATURES

static final long NONE_DIRECT_FEATURES

Constructor Detail

JSONObject

public JSONObject()

default

JSONObject

public JSONObject(int initialCapacity)

Parameters:

initialCapacity - the initial capacity = (number of elements to store / load factor) + 1

Throws:

java.lang.IllegalArgumentException - If the initial capacity is negative

JSONObject

public JSONObject(int initialCapacity,
                  float loadFactor)

Parameters:

initialCapacity - the initial capacity = (number of elements to store / load factor) + 1

loadFactor - the load factor

Throws:

java.lang.IllegalArgumentException - If the initial capacity is negative or the load factor is negative

Since:

2.0.2

JSONObject

public JSONObject(int initialCapacity,
                  float loadFactor,
                  boolean accessOrder)

Parameters:

initialCapacity - the initial capacity = (number of elements to store / load factor) + 1

loadFactor - the load factor

accessOrder - the ordering mode - true for access-order, false for insertion-order

Throws:

java.lang.IllegalArgumentException - If the initial capacity is negative or the load factor is negative

Since:

2.0.2

JSONObject

public JSONObject(java.util.Map map)

Parameters:

map - the map whose mappings are to be placed in this map

Throws:

java.lang.NullPointerException - If the specified map is null

Method Detail

get

public java.lang.Object get(java.lang.String key)

Returns the Object of the associated keys in this JSONObject.

Parameters:

key - the key whose associated value is to be returned

get

public java.lang.Object get(java.lang.Object key)

Returns the Object of the associated keys in this JSONObject.

Specified by:

get in interface java.util.Map<java.lang.String,java.lang.Object>

Overrides:

get in class java.util.LinkedHashMap<java.lang.String,java.lang.Object>

Parameters:

key - the key whose associated value is to be returned

Since:

2.0.2

getByPath

public java.lang.Object getByPath(java.lang.String jsonPath)

containsKey

public boolean containsKey(java.lang.String key)

Returns true if this map contains a mapping for the specified key

Parameters:

key - the key whose presence in this map is to be tested

containsKey

public boolean containsKey(java.lang.Object key)

Returns true if this map contains a mapping for the specified key

Specified by:

containsKey in interface java.util.Map<java.lang.String,java.lang.Object>

Overrides:

containsKey in class java.util.HashMap<java.lang.String,java.lang.Object>

Parameters:

key - the key whose presence in this map is to be tested

getOrDefault

public java.lang.Object getOrDefault(java.lang.String key,
                                     java.lang.Object defaultValue)

Parameters:

key - the key whose associated value is to be returned

defaultValue - the default mapping of the key

getOrDefault

public java.lang.Object getOrDefault(java.lang.Object key,
                                     java.lang.Object defaultValue)

Specified by:

getOrDefault in interface java.util.Map<java.lang.String,java.lang.Object>

Overrides:

getOrDefault in class java.util.LinkedHashMap<java.lang.String,java.lang.Object>

Parameters:

key - the key whose associated value is to be returned

defaultValue - the default mapping of the key

Since:

2.0.2

forEchArrayObject

@Deprecated
public void forEchArrayObject(java.lang.String key,
                                          java.util.function.Consumer<JSONObject> action)

Deprecated. Typo in the method name. Use forEachArrayObject instead

Iterates over the JSONArray elements associated with the given key.

Parameters:

key - the key whose associated JSONArray is to be iterated

action - the action to be performed for each JSONObject element

Since:

2.0.52

forEachArrayObject

public void forEachArrayObject(java.lang.String key,
                               java.util.function.Consumer<JSONObject> action)

Iterates over the JSONArray elements associated with the given key.

Parameters:

key - the key whose associated JSONArray is to be iterated

action - the action to be performed for each JSONObject element

getJSONArray

public JSONArray getJSONArray(java.lang.String key)

Returns the JSONArray of the associated keys in this JSONObject.

Parameters:

key - the key whose associated value is to be returned

Returns:

JSONArray or null

getList

public <T> java.util.List<T> getList(java.lang.String key,
                                     java.lang.Class<T> itemClass,
                                     JSONReader.Feature... features)

Returns a list of objects of the specified type from the associated JSONArray in this JSONObject.

Type Parameters:

T - the type of elements in the list

Parameters:

key - the key whose associated value is to be returned

itemClass - the class of the items in the list

features - features to be enabled in parsing

Returns:

a list of objects or null

getJSONObject

public JSONObject getJSONObject(java.lang.String key)

Returns the JSONObject of the associated keys in this JSONObject.

Parameters:

key - the key whose associated value is to be returned

Returns:

JSONObject or null

getString

public java.lang.String getString(java.lang.String key)

Returns the String of the associated keys in this JSONObject.

Parameters:

key - the key whose associated value is to be returned

Returns:

String or null

getString

public java.lang.String getString(java.lang.String key,
                                  java.lang.String defaultValue)

Returns the String of the associated keys in this JSONObject.

Parameters:

key - the key whose associated value is to be returned

defaultValue - the default mapping of the key

Returns:

String or null

getDouble

public java.lang.Double getDouble(java.lang.String key)

Returns the Double of the associated keys in this JSONObject.

Parameters:

key - the key whose associated value is to be returned

Returns:

Double or null

Throws:

java.lang.NumberFormatException - If the value of get is String and it contains no parsable double

JSONException - Unsupported type conversion to Double

getDoubleValue

public double getDoubleValue(java.lang.String key)

Returns a double value of the associated keys in this JSONObject.

Parameters:

key - the key whose associated value is to be returned

Returns:

double

Throws:

java.lang.NumberFormatException - If the value of get is String and it contains no parsable double

JSONException - Unsupported type conversion to double value

getFloat

public java.lang.Float getFloat(java.lang.String key)

Returns the Float of the associated keys in this JSONObject.

Parameters:

key - the key whose associated value is to be returned

Returns:

Float or null

Throws:

java.lang.NumberFormatException - If the value of get is String and it contains no parsable float

JSONException - Unsupported type conversion to Float

getFloatValue

public float getFloatValue(java.lang.String key)

Returns a float value of the associated keys in this JSONObject.

Parameters:

key - the key whose associated value is to be returned

Returns:

float

Throws:

java.lang.NumberFormatException - If the value of get is String and it contains no parsable float

JSONException - Unsupported type conversion to float value

getLong

public java.lang.Long getLong(java.lang.String key)

Returns the Long of the associated keys in this JSONObject.

Parameters:

key - the key whose associated value is to be returned

Returns:

Long or null

Throws:

java.lang.NumberFormatException - If the value of get is String and it contains no parsable long

JSONException - Unsupported type conversion to Long

getLongValue

public long getLongValue(java.lang.String key)

Returns a long value of the associated keys in this JSONObject.

Parameters:

key - the key whose associated value is to be returned

Returns:

long

Throws:

java.lang.NumberFormatException - If the value of get is String and it contains no parsable long

JSONException - Unsupported type conversion to long value

getLongValue

public long getLongValue(java.lang.String key,
                         long defaultValue)

Returns a long value of the associated keys in this JSONObject.

Parameters:

key - the key whose associated value is to be returned

defaultValue - the default mapping of the key

Returns:

long

Throws:

java.lang.NumberFormatException - If the value of get is String and it contains no parsable long

JSONException - Unsupported type conversion to long value

getInteger

public java.lang.Integer getInteger(java.lang.String key)

Returns the Integer of the associated keys in this JSONObject.

Parameters:

key - the key whose associated value is to be returned

Returns:

Integer or null

Throws:

java.lang.NumberFormatException - If the value of get is String and it contains no parsable int

JSONException - Unsupported type conversion to Integer

getIntValue

public int getIntValue(java.lang.String key)

Returns an int value of the associated keys in this JSONObject.

Parameters:

key - the key whose associated value is to be returned

Returns:

int

Throws:

java.lang.NumberFormatException - If the value of get is String and it contains no parsable int

JSONException - Unsupported type conversion to int value

getIntValue

public int getIntValue(java.lang.String key,
                       int defaultValue)

Returns an int value of the associated keys in this JSONObject.

Parameters:

key - the key whose associated value is to be returned

defaultValue - the default mapping of the key

Returns:

int

Throws:

java.lang.NumberFormatException - If the value of get is String and it contains no parsable int

JSONException - Unsupported type conversion to int value

getShort

public java.lang.Short getShort(java.lang.String key)

Returns the Short of the associated keys in this JSONObject.

Parameters:

key - the key whose associated value is to be returned

Returns:

Short or null

Throws:

java.lang.NumberFormatException - If the value of get is String and it contains no parsable short

JSONException - Unsupported type conversion to Short

getShortValue

public short getShortValue(java.lang.String key)

Returns a short value of the associated keys in this JSONObject.

Parameters:

key - the key whose associated value is to be returned

Returns:

short

Throws:

java.lang.NumberFormatException - If the value of get is String and it contains no parsable short

JSONException - Unsupported type conversion to short value

getByte

public java.lang.Byte getByte(java.lang.String key)

Returns the Byte of the associated keys in this JSONObject.

Parameters:

key - the key whose associated value is to be returned

Returns:

Byte or null

Throws:

java.lang.NumberFormatException - If the value of get is String and it contains no parsable byte

JSONException - Unsupported type conversion to Byte

getByteValue

public byte getByteValue(java.lang.String key)

Returns a byte value of the associated keys in this JSONObject.

Parameters:

key - the key whose associated value is to be returned

Returns:

byte

Throws:

java.lang.NumberFormatException - If the value of get is String and it contains no parsable byte

JSONException - Unsupported type conversion to byte value

getBytes

public byte[] getBytes(java.lang.String key)

getBoolean

public java.lang.Boolean getBoolean(java.lang.String key)

Returns the Boolean of the associated keys in this JSONObject.

Parameters:

key - the key whose associated value is to be returned

Returns:

Boolean or null

Throws:

JSONException - Unsupported type conversion to Boolean

getBooleanValue

public boolean getBooleanValue(java.lang.String key)

Returns a boolean value of the associated key in this object.

Parameters:

key - the key whose associated value is to be returned

Returns:

boolean

Throws:

JSONException - Unsupported type conversion to boolean value

getBooleanValue

public boolean getBooleanValue(java.lang.String key,
                               boolean defaultValue)

Returns a boolean value of the associated key in this object.

Parameters:

key - the key whose associated value is to be returned

defaultValue - the default mapping of the key

Returns:

boolean

Throws:

JSONException - Unsupported type conversion to boolean value

getBigInteger

public java.math.BigInteger getBigInteger(java.lang.String key)

Returns the BigInteger of the associated keys in this JSONObject.

Parameters:

key - the key whose associated value is to be returned

Returns:

BigInteger or null

Throws:

JSONException - Unsupported type conversion to BigInteger

java.lang.NumberFormatException - If the value of get is String and it is not a valid representation of BigInteger

getBigDecimal

public java.math.BigDecimal getBigDecimal(java.lang.String key)

Returns the BigDecimal of the associated keys in this JSONObject.

Parameters:

key - the key whose associated value is to be returned

Returns:

BigDecimal or null

Throws:

JSONException - Unsupported type conversion to BigDecimal

java.lang.NumberFormatException - If the value of get is String and it is not a valid representation of BigDecimal

getDate

public java.util.Date getDate(java.lang.String key)

Returns the Date of the associated keys in this JSONObject.

Parameters:

key - the key whose associated value is to be returned

Returns:

Date or null

getDate

public java.util.Date getDate(java.lang.String key,
                              java.util.Date defaultValue)

Since:

2.0.27

getInstant

public java.time.Instant getInstant(java.lang.String key)

Returns the BigInteger of the associated keys in this JSONObject.

Parameters:

key - the key whose associated value is to be returned

Returns:

BigInteger or null

getLocalDate

public java.time.LocalDate getLocalDate(java.lang.String key)

Since:

2.0.57

getLocalDate

public java.time.LocalDate getLocalDate(java.lang.String key,
                                        java.time.LocalDate defaultValue)

Since:

2.0.57

getLocalTime

public java.time.LocalTime getLocalTime(java.lang.String key)

Since:

2.0.57

getLocalTime

public java.time.LocalTime getLocalTime(java.lang.String key,
                                        java.time.LocalTime defaultValue)

Since:

2.0.57

getOffsetTime

public java.time.OffsetTime getOffsetTime(java.lang.String key)

Since:

2.0.57

getOffsetTime

public java.time.OffsetTime getOffsetTime(java.lang.String key,
                                          java.time.OffsetTime defaultValue)

Since:

2.0.57

getLocalDateTime

public java.time.LocalDateTime getLocalDateTime(java.lang.String key)

Since:

2.0.57

getLocalDateTime

public java.time.LocalDateTime getLocalDateTime(java.lang.String key,
                                                java.time.LocalDateTime defaultValue)

Since:

2.0.57

getOffsetDateTime

public java.time.OffsetDateTime getOffsetDateTime(java.lang.String key)

Since:

2.0.57

getOffsetDateTime

public java.time.OffsetDateTime getOffsetDateTime(java.lang.String key,
                                                  java.time.OffsetDateTime defaultValue)

Since:

2.0.57

getZonedDateTime

public java.time.ZonedDateTime getZonedDateTime(java.lang.String key)

Since:

2.0.57

getZonedDateTime

public java.time.ZonedDateTime getZonedDateTime(java.lang.String key,
                                                java.time.ZonedDateTime defaultValue)

Since:

2.0.57

toString

public java.lang.String toString()

Serialize to JSON String

Overrides:

toString in class java.util.AbstractMap<java.lang.String,java.lang.Object>

Returns:

JSON String

toString

public java.lang.String toString(JSONWriter.Feature... features)

Serialize to JSON String

Parameters:

features - features to be enabled in serialization

Returns:

JSON String

toJSONString

public java.lang.String toJSONString(JSONWriter.Feature... features)

Serialize to JSON String

Parameters:

features - features to be enabled in serialization

Returns:

JSON String

toJSONString

public static java.lang.String toJSONString(java.lang.Object object,
                                            JSONWriter.Feature... features)

Serialize Java Object to JSON String with specified JSONReader.Features enabled

Parameters:

object - Java Object to be serialized into JSON String

features - features to be enabled in serialization

Since:

2.0.6

toJSONBBytes

public byte[] toJSONBBytes(JSONWriter.Feature... features)

Serialize to JSONB bytes

Parameters:

features - features to be enabled in serialization

Returns:

JSONB bytes

to

public <T> T to(java.util.function.Function<JSONObject,T> function)

Since:

2.0.4

to

public <T> T to(java.lang.reflect.Type type,
                JSONReader.Feature... features)

Convert this JSONObject to the specified Object

 JSONObject obj = ...
 Map<String, User> users = obj.to(new TypeReference<HashMap<String, User>>(){}.getType());
 

Parameters:

type - specify the Type to be converted

features - features to be enabled in parsing

Since:

2.0.4

to

public <T> T to(TypeReference<T> typeReference,
                JSONReader.Feature... features)

Convert this JSONObject to the specified Object

 JSONObject obj = ...
 Map<String, User> users = obj.to(new TypeReference<HashMap<String, User>>(){});
 

Parameters:

typeReference - specify the TypeReference to be converted

features - features to be enabled in parsing

Since:

2.0.7

to

public <T> T to(java.lang.Class<T> clazz,
                JSONReader.Feature... features)

Convert this JSONObject to the specified Object

 JSONObject obj = ...
 User user = obj.to(User.class);
 

Parameters:

clazz - specify the Class<T> to be converted

features - features to be enabled in parsing

Since:

2.0.4

copyTo

public void copyTo(java.lang.Object object,
                   JSONReader.Feature... features)

toJavaObject

public <T> T toJavaObject(java.lang.Class<T> clazz,
                          JSONReader.Feature... features)

Convert this JSONObject to the specified Object

Parameters:

clazz - specify the Class<T> to be converted

features - features to be enabled in parsing

toJavaObject

public <T> T toJavaObject(java.lang.reflect.Type type,
                          JSONReader.Feature... features)

Deprecated. since 2.0.4, please use to(Type, JSONReader.Feature...)

Convert this JSONObject to the specified Object

Parameters:

type - specify the Type to be converted

features - features to be enabled in parsing

toJavaObject

public <T> T toJavaObject(TypeReference<T> typeReference,
                          JSONReader.Feature... features)

Deprecated. since 2.0.4, please use to(Type, JSONReader.Feature...)

Convert this JSONObject to the specified Object

Parameters:

typeReference - specify the TypeReference to be converted

features - features to be enabled in parsing

getObject

public <T> T getObject(java.lang.String key,
                       java.lang.Class<T> type,
                       JSONReader.Feature... features)

Returns the result of the Type converter conversion of the associated value in this JSONObject.

User user = jsonObject.getObject("user", User.class);

Parameters:

key - the key whose associated value is to be returned

type - specify the Class to be converted

Returns:

<T> or null

Throws:

JSONException - If no suitable conversion method is found

getObject

public <T> T getObject(java.lang.String key,
                       java.lang.reflect.Type type,
                       JSONReader.Feature... features)

Returns the result of the Type converter conversion of the associated value in this JSONObject.

User user = jsonObject.getObject("user", User.class);

Parameters:

key - the key whose associated value is to be returned

type - specify the Type to be converted

features - features to be enabled in parsing

Returns:

<T> or null

Throws:

JSONException - If no suitable conversion method is found

getObject

public <T> T getObject(java.lang.String key,
                       TypeReference<T> typeReference,
                       JSONReader.Feature... features)

Returns the result of the Type converter conversion of the associated value in this JSONObject.

User user = jsonObject.getObject("user", User.class);

Parameters:

key - the key whose associated value is to be returned

typeReference - specify the TypeReference to be converted

features - features to be enabled in parsing

Returns:

<T> or null

Throws:

JSONException - If no suitable conversion method is found

Since:

2.0.3

getObject

public <T> T getObject(java.lang.String key,
                       java.util.function.Function<JSONObject,T> creator)

Since:

2.0.4

invoke

public java.lang.Object invoke(java.lang.Object proxy,
                               java.lang.reflect.Method method,
                               java.lang.Object[] args)
                        throws java.lang.Throwable

Handles method invocations on a proxy instance.

Specified by:

invoke in interface java.lang.reflect.InvocationHandler

Parameters:

proxy - proxy object, currently useless

method - methods that need reflection

args - parameters of invoke

Returns:

the result of the method invocation

Throws:

java.lang.Throwable - if an error occurs during method invocation

java.lang.UnsupportedOperationException - If reflection for this method is not supported

java.lang.ArrayIndexOutOfBoundsException - If the length of args does not match the length of the method parameter

getJSONFieldName

private java.lang.String getJSONFieldName(java.lang.reflect.Method method)

Gets the JSON field name from the method's annotations.

Parameters:

method - the method to get the JSON field name from

Returns:

the JSON field name, or null if not found

Since:

2.0.4

putArray

public JSONArray putArray(java.lang.String name)

Creates and puts a new JSONArray with the specified name.

Parameters:

name - the name for the new JSONArray

Returns:

the created JSONArray

putObject

public JSONObject putObject(java.lang.String name)

Creates and puts a new JSONObject with the specified name.

Parameters:

name - the name for the new JSONObject

Returns:

the created JSONObject

fluentPut

public JSONObject fluentPut(java.lang.String key,
                            java.lang.Object value)

Chained addition of elements

 JSONObject object = new JSONObject().fluentPut("a", 1).fluentPut("b", 2).fluentPut("c", 3);
 

Parameters:

key - key with which the specified value is to be associated

value - value to be associated with the specified key

isValid

public boolean isValid(JSONSchema schema)

Checks if this JSONObject is valid according to the specified JSON schema.

Parameters:

schema - the JSON schema to validate against

Returns:

true if this JSONObject is valid according to the schema, false otherwise

Since:

2.0.4

nameFilter

static void nameFilter(java.lang.Iterable<?> iterable,
                       NameFilter nameFilter)

Applies a name filter to an iterable collection.

Parameters:

iterable - the iterable collection to apply the filter to

nameFilter - the name filter to apply

Since:

2.0.3

nameFilter

static void nameFilter(java.util.Map map,
                       NameFilter nameFilter)

Applies a name filter to a map.

Parameters:

map - the map to apply the filter to

nameFilter - the name filter to apply

Since:

2.0.3

valueFilter

static void valueFilter(java.lang.Iterable<?> iterable,
                        ValueFilter valueFilter)

Applies a value filter to an iterable collection.

Parameters:

iterable - the iterable collection to apply the filter to

valueFilter - the value filter to apply

Since:

2.0.3

valueFilter

static void valueFilter(java.util.Map map,
                        ValueFilter valueFilter)

Applies a value filter to a map.

Parameters:

map - the map to apply the filter to

valueFilter - the value filter to apply

Since:

2.0.3

valueFilter

public void valueFilter(ValueFilter valueFilter)

Applies a value filter to this JSONObject.

Parameters:

valueFilter - the value filter to apply

Since:

2.0.3

nameFilter

public void nameFilter(NameFilter nameFilter)

Applies a name filter to this JSONObject.

Parameters:

nameFilter - the name filter to apply

Since:

2.0.3

clone

public JSONObject clone()

Overrides:

clone in class java.util.HashMap<java.lang.String,java.lang.Object>

See Also:

JSONObject(Map)

eval

public java.lang.Object eval(JSONPath path)

Evaluates a JSONPath expression against this JSONObject.

Parameters:

path - the JSONPath expression to evaluate

Returns:

the result of evaluating the JSONPath expression

See Also:

JSONPath.paths(Object)

getSize

public int getSize(java.lang.String key)

Returns the size of the value associated with the given key if it is a Map or Collection. For other types, returns 0.

Parameters:

key - the key whose associated value's size is to be returned

Returns:

the size of the value if it is a Map or Collection, otherwise 0

Since:

2.0.24

of

public static JSONObject of()

 JSONObject jsonObject = JSONObject.of();
 

of

public static JSONObject of(java.lang.String key,
                            java.lang.Object value)

Pack a pair of key-values as JSONObject

 JSONObject jsonObject = JSONObject.of("name", "fastjson2");
 

Parameters:

key - the key of the element

value - the value of the element

of

public static JSONObject of(java.lang.String k1,
                            java.lang.Object v1,
                            java.lang.String k2,
                            java.lang.Object v2)

Pack two key-value pairs as JSONObject

 JSONObject jsonObject = JSONObject.of("key1", "value1", "key2", "value2");
 

Parameters:

k1 - first key

v1 - first value

k2 - second key

v2 - second value

Since:

2.0.2

of

public static JSONObject of(java.lang.String k1,
                            java.lang.Object v1,
                            java.lang.String k2,
                            java.lang.Object v2,
                            java.lang.String k3,
                            java.lang.Object v3)

Pack three key-value pairs as JSONObject

 JSONObject jsonObject = JSONObject.of("key1", "value1", "key2", "value2", "key3", "value3");
 

Parameters:

k1 - first key

v1 - first value

k2 - second key

v2 - second value

k3 - third key

v3 - third value

Since:

2.0.2

of

public static JSONObject of(java.lang.String k1,
                            java.lang.Object v1,
                            java.lang.String k2,
                            java.lang.Object v2,
                            java.lang.String k3,
                            java.lang.Object v3,
                            java.lang.String k4,
                            java.lang.Object v4)

Pack three key-value pairs as JSONObject

 JSONObject jsonObject = JSONObject.of("key1", "value1", "key2", "value2", "key3", "value3", "key4", "value4");
 

Parameters:

k1 - first key

v1 - first value

k2 - second key

v2 - second value

k3 - third key

v3 - third value

k4 - four key

v4 - four value

Since:

2.0.8

of

public static JSONObject of(java.lang.String k1,
                            java.lang.Object v1,
                            java.lang.String k2,
                            java.lang.Object v2,
                            java.lang.String k3,
                            java.lang.Object v3,
                            java.lang.String k4,
                            java.lang.Object v4,
                            java.lang.String k5,
                            java.lang.Object v5)

Pack three key-value pairs as JSONObject

 JSONObject jsonObject = JSONObject.of("key1", "value1", "key2", "value2", "key3", "value3", "key4", "value4", "key5", "value5");
 

Parameters:

k1 - first key

v1 - first value

k2 - second key

v2 - second value

k3 - third key

v3 - third value

k4 - four key

v4 - four value

k5 - five key

v5 - five value

Since:

2.0.21

of

public static JSONObject of(java.lang.String k1,
                            java.lang.Object v1,
                            java.lang.String k2,
                            java.lang.Object v2,
                            java.lang.String k3,
                            java.lang.Object v3,
                            java.lang.String k4,
                            java.lang.Object v4,
                            java.lang.String k5,
                            java.lang.Object v5,
                            java.lang.Object... kvArray)

Pack multiple key-value pairs as JSONObject

 JSONObject jsonObject = JSONObject.of("key1", "value1", "key2", "value2", "key3", "value3", "key4", "value4", "key5", "value5", kvArray);
 

Parameters:

k1 - first key

v1 - first value

k2 - second key

v2 - second value

k3 - third key

v3 - third value

k4 - four key

v4 - four value

k5 - five key

v5 - five value

kvArray - multiple key-value

Since:

2.0.53

of

private static JSONObject of(JSONObject jsonObject,
                             java.lang.Object... kvArray)

Pack multiple key-value pairs as JSONObject

 JSONObject jsonObject = JSONObject.of(Object... kvArray);
 

Parameters:

kvArray - key-value

Since:

2.0.53

parseObject

public static <T> T parseObject(java.lang.String text,
                                java.lang.Class<T> objectClass)

See JSON.parseObject(java.lang.String) for details

parseObject

public static <T> T parseObject(java.lang.String text,
                                java.lang.Class<T> objectClass,
                                JSONReader.Feature... features)

See JSON.parseObject(java.lang.String) for details

parseObject

public static <T> T parseObject(java.lang.String text,
                                java.lang.reflect.Type objectType,
                                JSONReader.Feature... features)

See JSON.parseObject(java.lang.String) for details

parseObject

public static <T> T parseObject(java.lang.String text,
                                TypeReference<T> typeReference,
                                JSONReader.Feature... features)

See JSON.parseObject(java.lang.String) for details

parseObject

public static JSONObject parseObject(java.lang.String text)

See JSON.parseObject(java.lang.String) for details

parse

public static JSONObject parse(java.lang.String text,
                               JSONReader.Feature... features)

See JSON.parse(java.lang.String) for details

Since:

2.0.13

from

public static JSONObject from(java.lang.Object obj)

See JSON.toJSON(java.lang.Object) for details

from

public static JSONObject from(java.lang.Object obj,
                              JSONWriter.Feature... writeFeatures)

See JSON.toJSON(java.lang.Object) for details

isArray

public boolean isArray(java.lang.Object key)