com.unboundid.util.json

Class JSONField

java.lang.Object

com.unboundid.util.json.JSONField

All Implemented Interfaces:

java.io.Serializable

@NotMutable
 @ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class JSONField
extends java.lang.Object
implements java.io.Serializable

This class provides a simple data structure that represents a field in a JSON object, containing a name and a value. This is primarily intended as a convenience when programmatically constructing JSON objects.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
JSONField(java.lang.String name, boolean value) Creates a new JSON field with the specified name and a JSONBoolean value.
JSONField(java.lang.String name, double value) Creates a new JSON field with the specified name and a JSONNumber value.
JSONField(java.lang.String name, JSONValue value) Creates a new JSON field with the specified name and value.
JSONField(java.lang.String name, long value) Creates a new JSON field with the specified name and a JSONNumber value.
JSONField(java.lang.String name, java.lang.String value) Creates a new JSON field with the specified name and a JSONString value.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o) Indicates whether the provided object is considered equal to this JSON field.
java.lang.String	getName() Retrieves the name for this field.
JSONValue	getValue() Retrieves the value for this field.
int	hashCode() Retrieves a hash code for this JSON field.
java.lang.String	toString() Retrieves a string representation of this field.
void	toString(java.lang.StringBuilder buffer) Appends a string representation of this field to the provided buffer.

Methods inherited from class java.lang.Object

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

Constructor Detail

JSONField

public JSONField(@NotNull
                 java.lang.String name,
                 @NotNull
                 JSONValue value)

Creates a new JSON field with the specified name and value.

Parameters:

name - The name for this field. It must not be null.

value - The value for this field. It must not be null (although it may be a JSONNull instance).

JSONField

public JSONField(@NotNull
                 java.lang.String name,
                 boolean value)

Creates a new JSON field with the specified name and a JSONBoolean value.

Parameters:

name - The name for this field. It must not be null.

value - The value for this field. It must not be null.

JSONField

public JSONField(@NotNull
                 java.lang.String name,
                 long value)

Creates a new JSON field with the specified name and a JSONNumber value.

Parameters:

name - The name for this field. It must not be null.

value - The value for this field. It must not be null.

JSONField

public JSONField(@NotNull
                 java.lang.String name,
                 double value)

Creates a new JSON field with the specified name and a JSONNumber value.

Parameters:

name - The name for this field. It must not be null.

value - The value for this field. It must not be null.

JSONField

public JSONField(@NotNull
                 java.lang.String name,
                 @NotNull
                 java.lang.String value)

Creates a new JSON field with the specified name and a JSONString value.

Parameters:

name - The name for this field. It must not be null.

value - The value for this field. It must not be null.

Method Detail

getName

@NotNull
public java.lang.String getName()

Retrieves the name for this field.

Returns:

The name for this field.

getValue

@NotNull
public JSONValue getValue()

Retrieves the value for this field.

Returns:

The value for this field.

hashCode

public int hashCode()

Retrieves a hash code for this JSON field.

Overrides:

hashCode in class java.lang.Object

Returns:

A hash code for this JSON field.

equals

public boolean equals(@Nullable
                      java.lang.Object o)

Indicates whether the provided object is considered equal to this JSON field.

Overrides:

equals in class java.lang.Object

Parameters:

o - The object for which to make the determination.

Returns:

true if the provided object is a JSON field with the same name and an equivalent value, or false if not.

toString

@NotNull
public java.lang.String toString()

Retrieves a string representation of this field.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this field.

toString

public void toString(@NotNull
                     java.lang.StringBuilder buffer)

Appends a string representation of this field to the provided buffer.

Parameters:

buffer - The buffer to which the information should be appended.