Class DittoJsonSerializable

java.lang.Object

com.ditto.java.serialization.DittoJsonSerializable

Direct Known Subclasses:

DittoJsonSerializable.ArrayValue, DittoJsonSerializable.NullValue, DittoJsonSerializable.ObjectValue, DittoJsonSerializable.PrimitiveValue, DittoJsonSerializable.StringValue

public abstract sealed class DittoJsonSerializable
extends Object
permits DittoJsonSerializable.StringValue, DittoJsonSerializable.ObjectValue, DittoJsonSerializable.ArrayValue, DittoJsonSerializable.PrimitiveValue, DittoJsonSerializable.NullValue

Represents a value that can be serialized to JSON format.

This class provides methods for creating and manipulating JSON-serializable values used by Ditto for document data. JSON serialization is simpler than CBOR and is commonly used for interoperability with web services and REST APIs.

Values can be created using the static factory methods:

- [#of(String)] - for string values
- [#of(Map)] - for JSON objects
- [#of(List)] - for JSON arrays
- [#of(boolean)], [#of(int)], [#of(long)], [#of(float)], [#of(double)] - for primitives
- [#nullValue()] - for null values

Values can be converted to Java types using the various get* methods, such as getBoolean(), getInt(), getDouble(), etc.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	DittoJsonSerializable.ArrayValue	Represents a JSON array value.
static final class	DittoJsonSerializable.NullValue	Represents a JSON null value.
static final class	DittoJsonSerializable.ObjectValue	Represents a JSON object value.
static final class	DittoJsonSerializable.PrimitiveValue	Represents a JSON primitive value (boolean, number).
static final class	DittoJsonSerializable.StringValue	Represents a JSON string value.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DittoJsonSerializable(@NonNull com.ditto.internal.serialization.InternalDittoJsonSerializable implementation)	Protected constructor for internal use.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)
boolean	getBoolean()	Converts this value to a boolean.
@Nullable Boolean	getBooleanOrNull()	Converts this value to a boolean, or returns null if conversion fails.
byte	getByte()	Converts this value to a byte.
double	getDouble()	Converts this value to a double.
float	getFloat()	Converts this value to a float.
protected @NonNull com.ditto.internal.serialization.InternalDittoJsonSerializable	getImplementation()	Returns the internal JSON serializable implementation.
int	getInt()	Converts this value to an int.
long	getLong()	Converts this value to a long.
short	getShort()	Converts this value to a short.
int	hashCode()
boolean	isNull()	Checks if this value represents null.
static @NonNull DittoJsonSerializable.NullValue	nullValue()	Returns a JSON null value.
static @NonNull DittoJsonSerializable.PrimitiveValue	of(boolean value)	Creates a JSON-serializable value from a boolean.
static @NonNull DittoJsonSerializable.PrimitiveValue	of(double value)	Creates a JSON-serializable value from a double.
static @NonNull DittoJsonSerializable.PrimitiveValue	of(float value)	Creates a JSON-serializable value from a float.
static @NonNull DittoJsonSerializable.PrimitiveValue	of(int value)	Creates a JSON-serializable value from an int.
static @NonNull DittoJsonSerializable.PrimitiveValue	of(long value)	Creates a JSON-serializable value from a long.
static @NonNull DittoJsonSerializable.StringValue	of(@NonNull String value)	Creates a JSON-serializable value from a string.
static @NonNull DittoJsonSerializable.ArrayValue	of(@NonNull List<@NonNull DittoJsonSerializable> value)	Creates a JSON-serializable value from a list (JSON array).
static @NonNull DittoJsonSerializable.ObjectValue	of(@NonNull Map<@NonNull String,@NonNull DittoJsonSerializable> value)	Creates a JSON-serializable value from a map (JSON object).
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

DittoJsonSerializable

protected DittoJsonSerializable(@NonNull com.ditto.internal.serialization.InternalDittoJsonSerializable implementation)

Protected constructor for internal use.

Parameters:

implementation - the internal JSON serializable implementation.

Method Details

getImplementation

protected @NonNull com.ditto.internal.serialization.InternalDittoJsonSerializable getImplementation()

Returns the internal JSON serializable implementation.

Returns:

the internal implementation.

isNull

public boolean isNull()

Checks if this value represents null.

Returns:

true if this is a null value, false otherwise.

getBoolean

public boolean getBoolean()
                   throws DittoException

Converts this value to a boolean.

Returns:

the boolean value.

Throws:

DittoException - if this value is not a boolean.

getBooleanOrNull

public @Nullable Boolean getBooleanOrNull()

Converts this value to a boolean, or returns null if conversion fails.

Returns:

the boolean value, or null if this value cannot be converted.

getByte

public byte getByte()
             throws DittoException

Converts this value to a byte.

Returns:

the byte value.

Throws:

DittoException - if this value is not a byte.

getShort

public short getShort()
               throws DittoException

Converts this value to a short.

Returns:

the short value.

Throws:

DittoException - if this value is not a short.

getInt

public int getInt()
           throws DittoException

Converts this value to an int.

Returns:

the int value.

Throws:

DittoException - if this value is not an int.

getLong

public long getLong()
             throws DittoException

Converts this value to a long.

Returns:

the long value.

Throws:

DittoException - if this value is not a long.

getFloat

public float getFloat()
               throws DittoException

Converts this value to a float.

Returns:

the float value.

Throws:

DittoException - if this value is not a float.

getDouble

public double getDouble()
                 throws DittoException

Converts this value to a double.

Returns:

the double value.

Throws:

DittoException - if this value is not a double.

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

of

public static @NonNull DittoJsonSerializable.StringValue of(@NonNull String value)

Creates a JSON-serializable value from a string.

Parameters:

value - the string value.

Returns:

a DittoJsonSerializable.StringValue containing the value.

of

public static @NonNull DittoJsonSerializable.ObjectValue of(@NonNull Map<@NonNull String,@NonNull DittoJsonSerializable> value)

Creates a JSON-serializable value from a map (JSON object).

Parameters:

value - the map with string keys and JSON-serializable values.

Returns:

an DittoJsonSerializable.ObjectValue containing the map.

of

public static @NonNull DittoJsonSerializable.ArrayValue of(@NonNull List<@NonNull DittoJsonSerializable> value)

Creates a JSON-serializable value from a list (JSON array).

Parameters:

value - the list of JSON-serializable values.

Returns:

an DittoJsonSerializable.ArrayValue containing the list.

of

public static @NonNull DittoJsonSerializable.PrimitiveValue of(boolean value)

Creates a JSON-serializable value from a boolean.

Parameters:

value - the boolean value.

Returns:

a DittoJsonSerializable.PrimitiveValue containing the value.

of

public static @NonNull DittoJsonSerializable.PrimitiveValue of(int value)

Creates a JSON-serializable value from an int.

Parameters:

value - the int value.

Returns:

a DittoJsonSerializable.PrimitiveValue containing the value.

of

public static @NonNull DittoJsonSerializable.PrimitiveValue of(long value)

Creates a JSON-serializable value from a long.

Parameters:

value - the long value.

Returns:

a DittoJsonSerializable.PrimitiveValue containing the value.

of

public static @NonNull DittoJsonSerializable.PrimitiveValue of(float value)

Creates a JSON-serializable value from a float.

Parameters:

value - the float value.

Returns:

a DittoJsonSerializable.PrimitiveValue containing the value.

of

public static @NonNull DittoJsonSerializable.PrimitiveValue of(double value)

Creates a JSON-serializable value from a double.

Parameters:

value - the double value.

Returns:

a DittoJsonSerializable.PrimitiveValue containing the value.

nullValue

public static @NonNull DittoJsonSerializable.NullValue nullValue()

Returns a JSON null value.

Returns:

the singleton DittoJsonSerializable.NullValue instance.