jOOQ 3.18.7 · org.jooq.JSON

A JSON wrapper type for JSON data obtained from the database.

The wrapper represents JSON data() in serialised string form. A CAST(NULL AS JSON) value is represented by a null reference of type JSON, not as data() == null. This is consistent with jOOQ's general way of returning NULL from Result and Record methods.

Unlike the normalising JSONB data type, the JSON type uses a purely text based, formatting-preserving representation of the JSON content, meaning that e.g. the following two documents are not equal, due to their different object attribute order and formatting:

{"a":1,"b":2}
{"b": 2, "a": 1}

This impacts the behaviour of

Modifier and Type	Field and Description
private final String	data

Access	Constructor and Description
private	JSON(String data)

Modifier and Type	Method and Description
public final @NotNull String	data()
public boolean	equals(Object the reference object with which to compare. obj) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for the object.
public static final @NotNull JSON	json(String data) Create a new `JSON` instance from string data input.
public static final @Nullable JSON	jsonOrNull(String data) Create a new `JSON` instance from string data input, or `null` if the input is `null`.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public static final @NotNull JSON	valueOf(String data) Create a new `JSON` instance from string data input.

data	back to summary
private final String data

JSON	back to summary
private JSON(String data)

Method Detail

data	back to summary
public final @NotNull String data() Annotations @NotNull

equals back to summary

equals	back to summary
public boolean equals(Object obj) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. `JSON` specifics: The `JSON` type uses a text-based, formatting-preserving representation of the JSON content, meaning that two equivalent JSON documents are considered not equal if their formatting or object attribute ordering differs (see `JSON` for details). Parameters obj:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(Object obj)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

`JSON` specifics:

The JSON type uses a text-based, formatting-preserving representation of the JSON content, meaning that two equivalent JSON documents are considered not equal if their formatting or object attribute ordering differs (see JSON for details).

Parameters

obj:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. `JSON` specifics: The `JSON` type uses a text-based, formatting-preserving representation of the JSON content, meaning that two equivalent JSON documents are considered not equal if their formatting or object attribute ordering differs (see `JSON` for details). Returns:int a hash code value for this object. Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

`JSON` specifics:

Returns:int

a hash code value for this object.

Annotations

@Override

json back to summary

json	back to summary
public static final @NotNull JSON json(String data) Create a new `JSON` instance from string data input. This is the same as `valueOf(String)`, but it can be static imported. Annotations @NotNull

public static final @NotNull JSON json(String data)

Create a new JSON instance from string data input.

This is the same as valueOf(String), but it can be static imported.

Annotations

@NotNull

jsonOrNull back to summary

jsonOrNull	back to summary
public static final @Nullable JSON jsonOrNull(String data) Create a new `JSON` instance from string data input, or `null` if the input is `null`. Annotations @Nullable

public static final @Nullable JSON jsonOrNull(String data)

Create a new JSON instance from string data input, or null if the input is null.

Annotations

@Nullable

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. `JSON` specifics: The `JSON` type uses a text-based, formatting-preserving representation of the JSON content, meaning that two equivalent JSON documents are considered not equal if their formatting or object attribute ordering differs (see `JSON` for details). Returns:String a string representation of the object. Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

`JSON` specifics:

Returns:String

a string representation of the object.

Annotations

@Override

valueOf back to summary

valueOf	back to summary
public static final @NotNull JSON valueOf(String data) Create a new `JSON` instance from string data input. Annotations @NotNull

public static final @NotNull JSON valueOf(String data)

Create a new JSON instance from string data input.

Annotations

@NotNull

public final Class JSON

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

`JSON` specifics:

`JSON` specifics:

`JSON` specifics:

public final Class JSON

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

JSON specifics:

JSON specifics:

JSON specifics:

`JSON` specifics:

`JSON` specifics:

`JSON` specifics: