software.amazon.smithy.model.node.internal.JsonHandler Maven / Gradle / Ivy
/*
* Copyright (c) 2016 EclipseSource.
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
package software.amazon.smithy.model.node.internal;
import software.amazon.smithy.model.SourceLocation;
/**
* 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.
*
*
* Note: This class was trimmed down to expose only the methods needed for Smithy.
* In particular, various "start*" methods were removed.
*
* @param The type of handlers used for JSON arrays
* @param The type of handlers used for JSON objects
* @see JsonParser
*/
abstract class JsonHandler {
void endNull(SourceLocation location) {
}
void endBoolean(boolean value, SourceLocation location) {
}
void endString(String string, SourceLocation location) {
}
void endNumber(String string, SourceLocation location) {
}
A startArray() {
return null;
}
void endArray(A array, SourceLocation location) {
}
void endArrayValue(A array) {
}
O startObject() {
return null;
}
void endObject(O object, SourceLocation location) {
}
void endObjectValue(O object, String name, SourceLocation keyLocation) {
}
}