com.unboundid.util.json.JSONValue Maven / Gradle / Ivy
/*
* Copyright 2015-2020 Ping Identity Corporation
* All Rights Reserved.
*/
/*
* Copyright 2015-2020 Ping Identity Corporation
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/*
* Copyright (C) 2015-2020 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 java.io.Serializable;
import com.unboundid.util.NotExtensible;
import com.unboundid.util.NotNull;
import com.unboundid.util.Nullable;
import com.unboundid.util.ThreadSafety;
import com.unboundid.util.ThreadSafetyLevel;
/**
* This class provides the base class for data types that can be used as values
* in JSON objects and as elements in JSON arrays. The types of values defined
* in the ECMA-404 specification are:
*
* -
* The {@code null} value, as implemented in the {@link JSONNull} class.
*
* -
* The Boolean {@code true} and {@code false} values, as implemented in the
* {@link JSONBoolean} class.
*
* -
* Numeric values, as implemented in the {@link JSONNumber} class.
*
* -
* String values, as implemented in the {@link JSONString} class.
*
* -
* Object values (consisting of zero or more name-value pairs), as
* implemented in the {@link JSONObject} class.
*
* -
* Arrays of JSON values, as implemented in the {@link JSONArray} class.
*
*
*/
@NotExtensible()
@ThreadSafety(level=ThreadSafetyLevel.INTERFACE_THREADSAFE)
public abstract class JSONValue
implements Serializable
{
/**
* A serial version UID for this serializable class.
*/
private static final long serialVersionUID = -4446120225858980451L;
/**
* Retrieves a hash code for this JSON value.
*
* @return The hash code for this JSON value.
*/
public abstract int hashCode();
/**
* Indicates whether the provided object is equal to this JSON value.
*
* @param o The object to compare against this JSON value.
*
* @return {@code true} if the provided object is considered equal to this
* JSON value, or {@code false} if not.
*/
public abstract boolean equals(@Nullable Object o);
/**
* 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.
*
* @param v The JSON value for which to make the
* determination. It must not be {@code null}.
* @param ignoreFieldNameCase Indicates whether to ignore differences in the
* capitalization of JSON field names.
* @param ignoreValueCase Indicates whether to ignore differences in
* the capitalization of JSON values that
* represent strings.
* @param ignoreArrayOrder Indicates whether to ignore differences in the
* order of elements in JSON arrays.
*
* @return {@code true} if this JSON value is considered equal to the
* provided JSON value (subject to the specified constraints), or
* {@code false} if not.
*/
public abstract boolean equals(@NotNull JSONValue v,
boolean ignoreFieldNameCase,
boolean ignoreValueCase,
boolean ignoreArrayOrder);
/**
* Retrieves a string representation of this value as it should appear in a
* JSON object, including any necessary quoting, escaping, etc. If the object
* containing this value was decoded from a string, then this method will use
* the same string representation as in that original object. Otherwise, the
* string representation will be constructed.
*
* @return A string representation of this value as it should appear in a
* JSON object.
*/
@NotNull()
public abstract String toString();
/**
* Appends a string representation of this value (as it should appear in a
* JSON object, including any necessary quoting, escaping, etc.) to the
* provided buffer. If the object containing this value was decoded from a
* string, then this method will use the same string representation as in that
* original object. Otherwise, the string representation will be constructed.
*
* @param buffer The buffer to which the information should be appended.
*/
public abstract void toString(@NotNull StringBuilder buffer);
/**
* Retrieves a single-line string representation of this value as it should
* appear in a JSON object, including any necessary quoting, escaping, etc.
*
* @return A string representation of this value as it should appear in a
* JSON object.
*/
@NotNull()
public abstract String toSingleLineString();
/**
* Appends a single-line string representation of this value (as it should
* appear in a JSON object, including any necessary quoting, escaping, etc.)
* to the provided buffer.
*
* @param buffer The buffer to which the information should be appended.
*/
public abstract void toSingleLineString(@NotNull StringBuilder buffer);
/**
* Retrieves a normalized string representation of this value. All equivalent
* JSON values must have equivalent normalized representations, even if there
* are other legal representations for the value.
*
* @return A normalized string representation of this value.
*/
@NotNull()
public abstract String toNormalizedString();
/**
* Appends a normalized string representation of this value to the provided
* buffer. All equivalent JSON values must have equivalent normalized
* representations, even if there are other legal representations for the
* value.
*
* @param buffer The buffer to which the information should be appended.
*/
public abstract void toNormalizedString(@NotNull StringBuilder buffer);
/**
* Retrieves a normalized string representation of this value using the
* provided settings.
*
* @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 value.
*/
@NotNull()
public abstract String toNormalizedString(boolean ignoreFieldNameCase,
boolean ignoreValueCase,
boolean ignoreArrayOrder);
/**
* Appends a normalized string representation of this value to the provided
* buffer using the provided settings.
*
* @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}).
*/
public abstract void toNormalizedString(@NotNull StringBuilder buffer,
boolean ignoreFieldNameCase,
boolean ignoreValueCase,
boolean ignoreArrayOrder);
/**
* 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.
*
* @param buffer The JSON buffer to which this value should be appended.
*/
public abstract void appendToJSONBuffer(@NotNull JSONBuffer buffer);
/**
* Appends a field with the given name and this value to the provided JSON
* buffer.
*
* @param fieldName The name to use for the field.
* @param buffer The JSON buffer to which this value should be appended.
*/
public abstract void appendToJSONBuffer(@NotNull String fieldName,
@NotNull JSONBuffer buffer);
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy