com.unboundid.util.json.JSONNull Maven / Gradle / Ivy
/*
* Copyright 2015-2018 Ping Identity Corporation
* All Rights Reserved.
*/
/*
* Copyright (C) 2015-2018 Ping Identity Corporation
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License (GPLv2 only)
* or the terms of the GNU Lesser General Public License (LGPLv2.1 only)
* as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, see .
*/
package com.unboundid.util.json;
import com.unboundid.util.NotMutable;
import com.unboundid.util.ThreadSafety;
import com.unboundid.util.ThreadSafetyLevel;
/**
* This class provides an implementation of a JSON value that represents a null
* value. The string representation of the null value is {@code null} in all
* lowercase and without any quotation marks.
*/
@NotMutable()
@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE)
public final class JSONNull
extends JSONValue
{
/**
* A pre-allocated JSON null value object.
*/
public static final JSONNull NULL = new JSONNull();
/**
* The serial version UID for this serializable class.
*/
private static final long serialVersionUID = -8359265286375144526L;
/**
* Creates a new JSON value capable of representing a {@code null} value.
*/
public JSONNull()
{
}
/**
* {@inheritDoc}
*/
@Override()
public int hashCode()
{
return 1;
}
/**
* {@inheritDoc}
*/
@Override()
public boolean equals(final Object o)
{
return ((o == this) || (o instanceof JSONNull));
}
/**
* {@inheritDoc}
*/
@Override()
public boolean equals(final JSONValue v, final boolean ignoreFieldNameCase,
final boolean ignoreValueCase,
final boolean ignoreArrayOrder)
{
return (v instanceof JSONNull);
}
/**
* 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
* "{@code null}" (without the surrounding quotes).
*
* @return A string representation of this null value as it should appear
* in a JSON object.
*/
@Override()
public String toString()
{
return "null";
}
/**
* 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 "{@code null}" (without the surrounding quotes).
*
* @param buffer The buffer to which the information should be appended.
*/
@Override()
public void toString(final StringBuilder buffer)
{
buffer.append("null");
}
/**
* 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 "{@code null}" (without the surrounding quotes).
*
* @return A single-line string representation of this null value as it
* should appear in a JSON object.
*/
@Override()
public String toSingleLineString()
{
return "null";
}
/**
* 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 "{@code null}" (without the surrounding
* quotes).
*
* @param buffer The buffer to which the information should be appended.
*/
@Override()
public void toSingleLineString(final StringBuilder buffer)
{
buffer.append("null");
}
/**
* 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 "{@code null}" (without the surrounding quotes).
*
* @return A normalized string representation of this null value as it
* should appear in a JSON object.
*/
@Override()
public String toNormalizedString()
{
return "null";
}
/**
* 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 "{@code null}" (without the surrounding
* quotes).
*
* @param buffer The buffer to which the information should be appended.
*/
@Override()
public void toNormalizedString(final StringBuilder buffer)
{
buffer.append("null");
}
/**
* 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 "{@code null}" (without the surrounding quotes).
*
* @param ignoreFieldNameCase Indicates whether field names should be
* treated in a case-sensitive (if {@code false})
* or case-insensitive (if {@code true}) manner.
* @param ignoreValueCase Indicates whether string field values should
* be treated in a case-sensitive (if
* {@code false}) or case-insensitive (if
* {@code true}) manner.
* @param ignoreArrayOrder Indicates whether the order of elements in an
* array should be considered significant (if
* {@code false}) or insignificant (if
* {@code true}).
*
* @return A normalized string representation of this null value as it
* should appear in a JSON object.
*/
@Override()
public String toNormalizedString(final boolean ignoreFieldNameCase,
final boolean ignoreValueCase,
final boolean ignoreArrayOrder)
{
return "null";
}
/**
* 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 "{@code null}" (without the surrounding
* quotes).
*
* @param buffer The buffer to which the information should be
* appended.
* @param ignoreFieldNameCase Indicates whether field names should be
* treated in a case-sensitive (if {@code false})
* or case-insensitive (if {@code true}) manner.
* @param ignoreValueCase Indicates whether string field values should
* be treated in a case-sensitive (if
* {@code false}) or case-insensitive (if
* {@code true}) manner.
* @param ignoreArrayOrder Indicates whether the order of elements in an
* array should be considered significant (if
* {@code false}) or insignificant (if
* {@code true}).
*/
@Override()
public void toNormalizedString(final StringBuilder buffer,
final boolean ignoreFieldNameCase,
final boolean ignoreValueCase,
final boolean ignoreArrayOrder)
{
buffer.append("null");
}
/**
* {@inheritDoc}
*/
@Override()
public void appendToJSONBuffer(final JSONBuffer buffer)
{
buffer.appendNull();
}
/**
* {@inheritDoc}
*/
@Override()
public void appendToJSONBuffer(final String fieldName,
final JSONBuffer buffer)
{
buffer.appendNull(fieldName);
}
}