Package com.unboundid.util.json
Class JSONNull
- java.lang.Object
-
- com.unboundid.util.json.JSONValue
-
- com.unboundid.util.json.JSONNull
-
- All Implemented Interfaces:
java.io.Serializable
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class JSONNull extends JSONValue
This class provides an implementation of a JSON value that represents a null value. The string representation of the null value isnull
in all lowercase and without any quotation marks.- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description JSONNull()
Creates a new JSON value capable of representing anull
value.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
appendToJSONBuffer(JSONBuffer buffer)
Appends this value to the provided JSON buffer.void
appendToJSONBuffer(java.lang.String fieldName, JSONBuffer buffer)
Appends a field with the given name and this value to the provided JSON buffer.boolean
equals(JSONValue v, boolean ignoreFieldNameCase, boolean ignoreValueCase, boolean ignoreArrayOrder)
Indicates whether this JSON value is considered equal to the provided JSON value, subject to the specified constraints.boolean
equals(java.lang.Object o)
Indicates whether the provided object is equal to this JSON value.int
hashCode()
Retrieves a hash code for this JSON value.java.lang.String
toNormalizedString()
Retrieves a normalized string representation of this null value as it should appear in a JSON object.java.lang.String
toNormalizedString(boolean ignoreFieldNameCase, boolean ignoreValueCase, boolean ignoreArrayOrder)
Retrieves a normalized string representation of this null value as it should appear in a JSON object.void
toNormalizedString(java.lang.StringBuilder buffer)
Appends a normalized string representation of this null value as it should appear in a JSON object to the provided buffer.void
toNormalizedString(java.lang.StringBuilder buffer, boolean ignoreFieldNameCase, boolean ignoreValueCase, boolean ignoreArrayOrder)
Appends a normalized string representation of this null value as it should appear in a JSON object to the provided buffer.java.lang.String
toSingleLineString()
Retrieves a single-line string representation of this null value as it should appear in a JSON object.void
toSingleLineString(java.lang.StringBuilder buffer)
Appends a single-line string representation of this null value as it should appear in a JSON object to the provided buffer.java.lang.String
toString()
Retrieves a string representation of this null value as it should appear in a JSON object.void
toString(java.lang.StringBuilder buffer)
Appends a string representation of this null value as it should appear in a JSON object to the provided buffer.
-
-
-
Constructor Detail
-
JSONNull
public JSONNull()
Creates a new JSON value capable of representing anull
value.
-
-
Method Detail
-
hashCode
public int hashCode()
Retrieves a hash code for this JSON value.
-
equals
public boolean equals(@Nullable java.lang.Object o)
Indicates whether the provided object is equal to this JSON value.
-
equals
public boolean equals(@NotNull JSONValue v, boolean ignoreFieldNameCase, boolean ignoreValueCase, boolean ignoreArrayOrder)
Indicates whether this JSON value is considered equal to the provided JSON value, subject to the specified constraints. Note that not all constraints will apply to all data types.- Specified by:
equals
in classJSONValue
- Parameters:
v
- The JSON value for which to make the determination. It must not benull
.ignoreFieldNameCase
- Indicates whether to ignore differences in the capitalization of JSON field names.ignoreValueCase
- Indicates whether to ignore differences in the capitalization of JSON values that represent strings.ignoreArrayOrder
- Indicates whether to ignore differences in the order of elements in JSON arrays.- Returns:
true
if this JSON value is considered equal to the provided JSON value (subject to the specified constraints), orfalse
if not.
-
toString
@NotNull public java.lang.String toString()
Retrieves a string representation of this null value as it should appear in a JSON object. Null values will always have a string representation of "null
" (without the surrounding quotes).
-
toString
public void toString(@NotNull java.lang.StringBuilder buffer)
Appends a string representation of this null value as it should appear in a JSON object to the provided buffer. Null values will always have a string representation of "null
" (without the surrounding quotes).
-
toSingleLineString
@NotNull public java.lang.String toSingleLineString()
Retrieves a single-line string representation of this null value as it should appear in a JSON object. Null values will always have a string representation of "null
" (without the surrounding quotes).- Specified by:
toSingleLineString
in classJSONValue
- Returns:
- A single-line string representation of this null value as it should appear in a JSON object.
-
toSingleLineString
public void toSingleLineString(@NotNull java.lang.StringBuilder buffer)
Appends a single-line string representation of this null value as it should appear in a JSON object to the provided buffer. Null values will always have a string representation of "null
" (without the surrounding quotes).- Specified by:
toSingleLineString
in classJSONValue
- Parameters:
buffer
- The buffer to which the information should be appended.
-
toNormalizedString
@NotNull public java.lang.String toNormalizedString()
Retrieves a normalized string representation of this null value as it should appear in a JSON object. Null values will always have a string representation of "null
" (without the surrounding quotes).- Specified by:
toNormalizedString
in classJSONValue
- Returns:
- A normalized string representation of this null value as it should appear in a JSON object.
-
toNormalizedString
public void toNormalizedString(@NotNull java.lang.StringBuilder buffer)
Appends a normalized string representation of this null value as it should appear in a JSON object to the provided buffer. Null values will always have a string representation of "null
" (without the surrounding quotes).- Specified by:
toNormalizedString
in classJSONValue
- Parameters:
buffer
- The buffer to which the information should be appended.
-
toNormalizedString
@NotNull public java.lang.String toNormalizedString(boolean ignoreFieldNameCase, boolean ignoreValueCase, boolean ignoreArrayOrder)
Retrieves a normalized string representation of this null value as it should appear in a JSON object. Null values will always have a string representation of "null
" (without the surrounding quotes).- Specified by:
toNormalizedString
in classJSONValue
- Parameters:
ignoreFieldNameCase
- Indicates whether field names should be treated in a case-sensitive (iffalse
) or case-insensitive (iftrue
) manner.ignoreValueCase
- Indicates whether string field values should be treated in a case-sensitive (iffalse
) or case-insensitive (iftrue
) manner.ignoreArrayOrder
- Indicates whether the order of elements in an array should be considered significant (iffalse
) or insignificant (iftrue
).- Returns:
- A normalized string representation of this null value as it should appear in a JSON object.
-
toNormalizedString
public void toNormalizedString(@NotNull java.lang.StringBuilder buffer, boolean ignoreFieldNameCase, boolean ignoreValueCase, boolean ignoreArrayOrder)
Appends a normalized string representation of this null value as it should appear in a JSON object to the provided buffer. Null values will always have a string representation of "null
" (without the surrounding quotes).- Specified by:
toNormalizedString
in classJSONValue
- Parameters:
buffer
- The buffer to which the information should be appended.ignoreFieldNameCase
- Indicates whether field names should be treated in a case-sensitive (iffalse
) or case-insensitive (iftrue
) manner.ignoreValueCase
- Indicates whether string field values should be treated in a case-sensitive (iffalse
) or case-insensitive (iftrue
) manner.ignoreArrayOrder
- Indicates whether the order of elements in an array should be considered significant (iffalse
) or insignificant (iftrue
).
-
appendToJSONBuffer
public void appendToJSONBuffer(@NotNull JSONBuffer buffer)
Appends this value to the provided JSON buffer. This will not include a field name, so it should only be used for Boolean value elements in an array.- Specified by:
appendToJSONBuffer
in classJSONValue
- Parameters:
buffer
- The JSON buffer to which this value should be appended.
-
appendToJSONBuffer
public void appendToJSONBuffer(@NotNull java.lang.String fieldName, @NotNull JSONBuffer buffer)
Appends a field with the given name and this value to the provided JSON buffer.- Specified by:
appendToJSONBuffer
in classJSONValue
- Parameters:
fieldName
- The name to use for the field.buffer
- The JSON buffer to which this value should be appended.
-
-