net.sourceforge.plantuml.json.JsonArray Maven / Gradle / Ivy
// THIS FILE HAS BEEN GENERATED BY A PREPROCESSOR.
/* +=======================================================================
* |
* | PlantUML : a free UML diagram generator
* |
* +=======================================================================
*
* (C) Copyright 2009-2024, Arnaud Roques
*
* Project Info: https://plantuml.com
*
* If you like this project or if you find it useful, you can support us at:
*
* https://plantuml.com/patreon (only 1$ per month!)
* https://plantuml.com/liberapay (only 1€ per month!)
* https://plantuml.com/paypal
*
*
* PlantUML is free software; you can redistribute it and/or modify it
* under the terms of the Revised BSD License.
*
* All rights reserved.
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* * Neither the name of the University of California, Berkeley nor the
* names of its contributors may be used to endorse or promote products
* derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* PlantUML can occasionally display sponsored or advertising messages. Those
* messages are usually generated on welcome or error images and never on
* functional diagrams.
* See https://plantuml.com/professional if you want to remove them
*
* Images (whatever their format : PNG, SVG, EPS...) generated by running PlantUML
* are owned by the author of their corresponding sources code (that is, their
* textual description in PlantUML language). Those images are not covered by
* this BSD license.
*
* The generated images can then be used without any reference to the BSD license.
* It is not even necessary to stipulate that they have been generated with PlantUML,
* although this will be appreciated by the PlantUML team.
*
* There is an exception : if the textual description in PlantUML language is also covered
* by any license, then the generated images are logically covered
* by the very same license.
*
* This is the IGY distribution (Install GraphViz by Yourself).
* You have to install GraphViz and to setup the GRAPHVIZ_DOT environment variable
* (see https://plantuml.com/graphviz-dot )
*
* Icons provided by OpenIconic : https://useiconic.com/open
* Archimate sprites provided by Archi : http://www.archimatetool.com
* Stdlib AWS provided by https://github.com/milo-minderbinder/AWS-PlantUML
* Stdlib Icons provided https://github.com/tupadr3/plantuml-icon-font-sprites
* ASCIIMathML (c) Peter Jipsen http://www.chapman.edu/~jipsen
* ASCIIMathML (c) David Lippman http://www.pierce.ctc.edu/dlippman
* CafeUndZopfli ported by Eugene Klyuchnikov https://github.com/eustas/CafeUndZopfli
* Brotli (c) by the Brotli Authors https://github.com/google/brotli
* Themes (c) by Brett Schwarz https://github.com/bschwarz/puml-themes
* Twemoji (c) by Twitter at https://twemoji.twitter.com/
*
*/
package net.sourceforge.plantuml.json;
import java.io.IOException;
import java.io.Reader;
import java.util.ArrayList;
import java.util.Collections;
import java.util.Iterator;
import java.util.List;
/**
* Represents a JSON array, an ordered collection of JSON values.
*
* Elements can be added using the add(...) methods which accept
* instances of {@link JsonValue}, strings, primitive numbers, and boolean
* values. To replace an element of an array, use the set(int, ...)
* methods.
*
*
* Elements can be accessed by their index using {@link #get(int)}. This class
* also supports iterating over the elements in document order using an
* {@link #iterator()} or an enhanced for loop:
*
*
*
* for (JsonValue value : jsonArray) {
* ...
* }
*
*
* An equivalent {@link List} can be obtained from the method {@link #values()}.
*
*
* Note that this class is not thread-safe. If multiple threads
* access a JsonArray instance concurrently, while at least one of
* these threads modifies the contents of this array, access to the instance
* must be synchronized externally. Failure to do so may lead to an inconsistent
* state.
*
*
* This class is not supposed to be extended by clients.
*
*/
@SuppressWarnings("serial") // use default serial UID
public class JsonArray extends JsonValue implements Iterable {
/**
* Added for PlantUML
*/
public JsonValue cloneMe() {
final JsonArray copy = new JsonArray();
for (JsonValue value : values)
copy.values.add(value.cloneMe());
return copy;
}
private final List values;
/**
* Creates a new empty JsonArray.
*/
public JsonArray() {
values = new ArrayList<>();
}
/**
* Creates a new JsonArray with the contents of the specified JSON array.
*
* @param array the JsonArray to get the initial contents from, must not be
* null
*/
public JsonArray(JsonArray array) {
this(array, false);
}
private JsonArray(JsonArray array, boolean unmodifiable) {
if (array == null) {
throw new NullPointerException("array is null");
}
if (unmodifiable) {
values = Collections.unmodifiableList(array.values);
} else {
values = new ArrayList<>(array.values);
}
}
/**
* Reads a JSON array from the given reader.
*
* Characters are read in chunks and buffered internally, therefore wrapping an
* existing reader in an additional BufferedReader does
* not improve reading performance.
*
*
* @param reader the reader to read the JSON array from
* @return the JSON array that has been read
* @throws IOException if an I/O error occurs in the reader
* @throws ParseException if the input is not valid JSON
* @throws UnsupportedOperationException if the input does not contain a JSON
* array
* @deprecated Use {@link Json#parse(Reader)}{@link JsonValue#asArray()
* .asArray()} instead
*/
@Deprecated
public static JsonArray readFrom(Reader reader) throws IOException {
return JsonValue.readFrom(reader).asArray();
}
/**
* Reads a JSON array from the given string.
*
* @param string the string that contains the JSON array
* @return the JSON array that has been read
* @throws ParseException if the input is not valid JSON
* @throws UnsupportedOperationException if the input does not contain a JSON
* array
* @deprecated Use {@link Json#parse(String)}{@link JsonValue#asArray()
* .asArray()} instead
*/
@Deprecated
public static JsonArray readFrom(String string) {
return JsonValue.readFrom(string).asArray();
}
/**
* Returns an unmodifiable wrapper for the specified JsonArray. This method
* allows to provide read-only access to a JsonArray.
*
* The returned JsonArray is backed by the given array and reflects subsequent
* changes. Attempts to modify the returned JsonArray result in an
* UnsupportedOperationException.
*
*
* @param array the JsonArray for which an unmodifiable JsonArray is to be
* returned
* @return an unmodifiable view of the specified JsonArray
*/
public static JsonArray unmodifiableArray(JsonArray array) {
return new JsonArray(array, true);
}
/**
* Appends the JSON representation of the specified int value to
* the end of this array.
*
* @param value the value to add to the array
* @return the array itself, to enable method chaining
*/
public JsonArray add(int value) {
values.add(Json.value(value));
return this;
}
/**
* Appends the JSON representation of the specified long value to
* the end of this array.
*
* @param value the value to add to the array
* @return the array itself, to enable method chaining
*/
public JsonArray add(long value) {
values.add(Json.value(value));
return this;
}
/**
* Appends the JSON representation of the specified float value to
* the end of this array.
*
* @param value the value to add to the array
* @return the array itself, to enable method chaining
*/
public JsonArray add(float value) {
values.add(Json.value(value));
return this;
}
/**
* Appends the JSON representation of the specified double value to
* the end of this array.
*
* @param value the value to add to the array
* @return the array itself, to enable method chaining
*/
public JsonArray add(double value) {
values.add(Json.value(value));
return this;
}
/**
* Appends the JSON representation of the specified boolean value
* to the end of this array.
*
* @param value the value to add to the array
* @return the array itself, to enable method chaining
*/
public JsonArray add(boolean value) {
values.add(Json.value(value));
return this;
}
/**
* Appends the JSON representation of the specified string to the end of this
* array.
*
* @param value the string to add to the array
* @return the array itself, to enable method chaining
*/
public JsonArray add(String value) {
values.add(Json.value(value));
return this;
}
/**
* Appends the specified JSON value to the end of this array.
*
* @param value the JsonValue to add to the array, must not be null
* @return the array itself, to enable method chaining
*/
public JsonArray add(JsonValue value) {
if (value == null) {
throw new NullPointerException("value is null");
}
values.add(value);
return this;
}
/**
* Replaces the element at the specified position in this array with the JSON
* representation of the specified int value.
*
* @param index the index of the array element to replace
* @param value the value to be stored at the specified array position
* @return the array itself, to enable method chaining
* @throws IndexOutOfBoundsException if the index is out of range, i.e.
* index < 0 or
* index >= size
*/
public JsonArray set(int index, int value) {
values.set(index, Json.value(value));
return this;
}
/**
* Replaces the element at the specified position in this array with the JSON
* representation of the specified long value.
*
* @param index the index of the array element to replace
* @param value the value to be stored at the specified array position
* @return the array itself, to enable method chaining
* @throws IndexOutOfBoundsException if the index is out of range, i.e.
* index < 0 or
* index >= size
*/
public JsonArray set(int index, long value) {
values.set(index, Json.value(value));
return this;
}
/**
* Replaces the element at the specified position in this array with the JSON
* representation of the specified float value.
*
* @param index the index of the array element to replace
* @param value the value to be stored at the specified array position
* @return the array itself, to enable method chaining
* @throws IndexOutOfBoundsException if the index is out of range, i.e.
* index < 0 or
* index >= size
*/
public JsonArray set(int index, float value) {
values.set(index, Json.value(value));
return this;
}
/**
* Replaces the element at the specified position in this array with the JSON
* representation of the specified double value.
*
* @param index the index of the array element to replace
* @param value the value to be stored at the specified array position
* @return the array itself, to enable method chaining
* @throws IndexOutOfBoundsException if the index is out of range, i.e.
* index < 0 or
* index >= size
*/
public JsonArray set(int index, double value) {
values.set(index, Json.value(value));
return this;
}
/**
* Replaces the element at the specified position in this array with the JSON
* representation of the specified boolean value.
*
* @param index the index of the array element to replace
* @param value the value to be stored at the specified array position
* @return the array itself, to enable method chaining
* @throws IndexOutOfBoundsException if the index is out of range, i.e.
* index < 0 or
* index >= size
*/
public JsonArray set(int index, boolean value) {
values.set(index, Json.value(value));
return this;
}
/**
* Replaces the element at the specified position in this array with the JSON
* representation of the specified string.
*
* @param index the index of the array element to replace
* @param value the string to be stored at the specified array position
* @return the array itself, to enable method chaining
* @throws IndexOutOfBoundsException if the index is out of range, i.e.
* index < 0 or
* index >= size
*/
public JsonArray set(int index, String value) {
values.set(index, Json.value(value));
return this;
}
/**
* Replaces the element at the specified position in this array with the
* specified JSON value.
*
* @param index the index of the array element to replace
* @param value the value to be stored at the specified array position, must not
* be null
* @return the array itself, to enable method chaining
* @throws IndexOutOfBoundsException if the index is out of range, i.e.
* index < 0 or
* index >= size
*/
public JsonArray set(int index, JsonValue value) {
if (value == null) {
throw new NullPointerException("value is null");
}
values.set(index, value);
return this;
}
/**
* Removes the element at the specified index from this array.
*
* @param index the index of the element to remove
* @return the array itself, to enable method chaining
* @throws IndexOutOfBoundsException if the index is out of range, i.e.
* index < 0 or
* index >= size
*/
public JsonArray remove(int index) {
values.remove(index);
return this;
}
/**
* Returns the number of elements in this array.
*
* @return the number of elements in this array
*/
public int size() {
return values.size();
}
/**
* Returns true if this array contains no elements.
*
* @return true if this array contains no elements
*/
public boolean isEmpty() {
return values.isEmpty();
}
/**
* Returns the value of the element at the specified position in this array.
*
* @param index the index of the array element to return
* @return the value of the element at the specified position
* @throws IndexOutOfBoundsException if the index is out of range, i.e.
* index < 0 or
* index >= size
*/
public JsonValue get(int index) {
return values.get(index);
}
/**
* Returns a list of the values in this array in document order. The returned
* list is backed by this array and will reflect subsequent changes. It cannot
* be used to modify this array. Attempts to modify the returned list will
* result in an exception.
*
* @return a list of the values in this array
*/
public List values() {
return Collections.unmodifiableList(values);
}
/**
* Returns an iterator over the values of this array in document order. The
* returned iterator cannot be used to modify this array.
*
* @return an iterator over the values of this array
*/
public Iterator iterator() {
final Iterator iterator = values.iterator();
return new Iterator() {
public boolean hasNext() {
return iterator.hasNext();
}
public JsonValue next() {
return iterator.next();
}
public void remove() {
throw new UnsupportedOperationException();
}
};
}
@Override
void write(JsonWriter writer) throws IOException {
writer.writeArrayOpen();
Iterator iterator = iterator();
if (iterator.hasNext()) {
iterator.next().write(writer);
while (iterator.hasNext()) {
writer.writeArraySeparator();
iterator.next().write(writer);
}
}
writer.writeArrayClose();
}
@Override
public boolean isArray() {
return true;
}
@Override
public JsonArray asArray() {
return this;
}
@Override
public int hashCode() {
return values.hashCode();
}
/**
* Indicates whether a given object is "equal to" this JsonArray. An object is
* considered equal if it is also a JsonArray and both arrays
* contain the same list of values.
*
* If two JsonArrays are equal, they will also produce the same JSON output.
*
*
* @param object the object to be compared with this JsonArray
* @return true if the specified object is equal to this JsonArray,
* false otherwise
*/
@Override
public boolean equals(Object object) {
if (this == object) {
return true;
}
if (object == null) {
return false;
}
if (getClass() != object.getClass()) {
return false;
}
JsonArray other = (JsonArray) object;
return values.equals(other.values);
}
}