net.sourceforge.plantuml.json.JsonHandler 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;
/**
* A handler for parser events. Instances of this class can be given to a
* {@link JsonParser}. The parser will then call the methods of the given
* handler while reading the input.
*
* The default implementations of these methods do nothing. Subclasses may
* override only those methods they are interested in. They can use
* getLocation() to access the current character position of the
* parser at any point. The start* methods will be called while the
* location points to the first character of the parsed element. The
* end* methods will be called while the location points to the
* character position that directly follows the last character of the parsed
* element. Example:
*
*
*
* ["lorem ipsum"]
* ^ ^
* startString endString
*
*
* Subclasses that build an object representation of the parsed JSON can return
* arbitrary handler objects for JSON arrays and JSON objects in
* {@link #startArray()} and {@link #startObject()}. These handler objects will
* then be provided in all subsequent parser events for this particular array or
* object. They can be used to keep track the elements of a JSON array or
* object.
*
*
* @param The type of handlers used for JSON arrays
* @param The type of handlers used for JSON objects
* @see JsonParser
*/
public abstract class JsonHandler {
// ::remove folder when __HAXE__
JsonParser parser;
/**
* Returns the current parser location.
*
* @return the current parser location
*/
protected Location getLocation() {
return parser.getLocation();
}
/**
* Indicates the beginning of a null literal in the JSON input.
* This method will be called when reading the first character of the literal.
*/
public void startNull() {
}
/**
* Indicates the end of a null literal in the JSON input. This
* method will be called after reading the last character of the literal.
*/
public void endNull() {
}
/**
* Indicates the beginning of a boolean literal (true or
* false) in the JSON input. This method will be called when
* reading the first character of the literal.
*/
public void startBoolean() {
}
/**
* Indicates the end of a boolean literal (true or
* false) in the JSON input. This method will be called after
* reading the last character of the literal.
*
* @param value the parsed boolean value
*/
public void endBoolean(boolean value) {
}
/**
* Indicates the beginning of a string in the JSON input. This method will be
* called when reading the opening double quote character
* ('"').
*/
public void startString() {
}
/**
* Indicates the end of a string in the JSON input. This method will be called
* after reading the closing double quote character ('"').
*
* @param string the parsed string
*/
public void endString(String string) {
}
/**
* Indicates the beginning of a number in the JSON input. This method will be
* called when reading the first character of the number.
*/
public void startNumber() {
}
/**
* Indicates the end of a number in the JSON input. This method will be called
* after reading the last character of the number.
*
* @param string the parsed number string
*/
public void endNumber(String string) {
}
/**
* Indicates the beginning of an array in the JSON input. This method will be
* called when reading the opening square bracket character ('[').
*
* This method may return an object to handle subsequent parser events for this
* array. This array handler will then be provided in all calls to
* {@link #startArrayValue(Object) startArrayValue()},
* {@link #endArrayValue(Object) endArrayValue()}, and {@link #endArray(Object)
* endArray()} for this array.
*
*
* @return a handler for this array, or null if not needed
*/
public A startArray() {
return null;
}
/**
* Indicates the end of an array in the JSON input. This method will be called
* after reading the closing square bracket character (']').
*
* @param array the array handler returned from {@link #startArray()}, or
* null if not provided
*/
public void endArray(A array) {
}
/**
* Indicates the beginning of an array element in the JSON input. This method
* will be called when reading the first character of the element, just before
* the call to the start method for the specific element type
* ({@link #startString()}, {@link #startNumber()}, etc.).
*
* @param array the array handler returned from {@link #startArray()}, or
* null if not provided
*/
public void startArrayValue(A array) {
}
/**
* Indicates the end of an array element in the JSON input. This method will be
* called after reading the last character of the element value, just after the
* end method for the specific element type (like
* {@link #endString(String) endString()}, {@link #endNumber(String)
* endNumber()}, etc.).
*
* @param array the array handler returned from {@link #startArray()}, or
* null if not provided
*/
public void endArrayValue(A array) {
}
/**
* Indicates the beginning of an object in the JSON input. This method will be
* called when reading the opening curly bracket character ('{').
*
* This method may return an object to handle subsequent parser events for this
* object. This object handler will be provided in all calls to
* {@link #startObjectName(Object) startObjectName()},
* {@link #endObjectName(Object, String) endObjectName()},
* {@link #startObjectValue(Object, String) startObjectValue()},
* {@link #endObjectValue(Object, String) endObjectValue()}, and
* {@link #endObject(Object) endObject()} for this object.
*
*
* @return a handler for this object, or null if not needed
*/
public O startObject() {
return null;
}
/**
* Indicates the end of an object in the JSON input. This method will be called
* after reading the closing curly bracket character ('}').
*
* @param object the object handler returned from {@link #startObject()}, or
* null if not provided
*/
public void endObject(O object) {
}
/**
* Indicates the beginning of the name of an object member in the JSON input.
* This method will be called when reading the opening quote character
* ('"') of the member name.
*
* @param object the object handler returned from {@link #startObject()}, or
* null if not provided
*/
public void startObjectName(O object) {
}
/**
* Indicates the end of an object member name in the JSON input. This method
* will be called after reading the closing quote character ('"')
* of the member name.
*
* @param object the object handler returned from {@link #startObject()}, or
* null if not provided
* @param name the parsed member name
*/
public void endObjectName(O object, String name) {
}
/**
* Indicates the beginning of the name of an object member in the JSON input.
* This method will be called when reading the opening quote character
* ('"') of the member name.
*
* @param object the object handler returned from {@link #startObject()}, or
* null if not provided
* @param name the member name
*/
public void startObjectValue(O object, String name) {
}
/**
* Indicates the end of an object member value in the JSON input. This method
* will be called after reading the last character of the member value, just
* after the end method for the specific member type (like
* {@link #endString(String) endString()}, {@link #endNumber(String)
* endNumber()}, etc.).
*
* @param object the object handler returned from {@link #startObject()}, or
* null if not provided
* @param name the parsed member name
*/
public void endObjectValue(O object, String name) {
}
}