Index
A B C D E G H I J K L M N O P S T V
All Classes All Packages
All Classes All Packages
All Classes All Packages
A
- addBoolean(String, boolean) - Method in interface com.clumd.projects.javajson.api.JsonBuilder
-
Add a boolean to this JSON object.
- addBoolean(String, boolean) - Method in class com.clumd.projects.javajson.core.BasicJsonBuilder
- addBuilderBlock(String, Json) - Method in interface com.clumd.projects.javajson.api.JsonBuilder
-
Use an existing, compiled piece of JSON, converted to a JsonBuilder, then assigned to the value at the path.
- addBuilderBlock(String, Json) - Method in class com.clumd.projects.javajson.core.BasicJsonBuilder
- addBuilderBlock(String, JsonBuilder) - Method in interface com.clumd.projects.javajson.api.JsonBuilder
-
Add another JsonBuilder (representing an object) with partially filled values to this JSON object.
- addBuilderBlock(String, JsonBuilder) - Method in class com.clumd.projects.javajson.core.BasicJsonBuilder
- addDouble(String, double) - Method in interface com.clumd.projects.javajson.api.JsonBuilder
-
Add a double to this JSON object.
- addDouble(String, double) - Method in class com.clumd.projects.javajson.core.BasicJsonBuilder
- addLong(String, long) - Method in interface com.clumd.projects.javajson.api.JsonBuilder
-
Add a long to this JSON object.
- addLong(String, long) - Method in class com.clumd.projects.javajson.core.BasicJsonBuilder
- addString(String, String) - Method in interface com.clumd.projects.javajson.api.JsonBuilder
-
Add a string to this JSON object.
- addString(String, String) - Method in class com.clumd.projects.javajson.core.BasicJsonBuilder
- ARRAY - com.clumd.projects.javajson.core.JSType
- asPrettyString() - Method in interface com.clumd.projects.javajson.api.Json
-
Calls asPrettyString with the deepest depth and a default indent width of 4.
- asPrettyString(int) - Method in interface com.clumd.projects.javajson.api.Json
-
Creates a string representation of the current object with a given depth of object expansion
- asPrettyString(int, int) - Method in interface com.clumd.projects.javajson.api.Json
-
Creates a string representation of the current object with a given depth of object expansion And a custom level of indentation
- asString() - Method in interface com.clumd.projects.javajson.api.Json
-
Calls as string with the deepest depth
- asString(int) - Method in interface com.clumd.projects.javajson.api.Json
-
Creates a string representation of the current object with a given depth of object expansion
B
- BasicJsonBuilder - Class in com.clumd.projects.javajson.core
- BasicJsonBuilder() - Constructor for class com.clumd.projects.javajson.core.BasicJsonBuilder
- BOOLEAN - com.clumd.projects.javajson.core.JSType
- build() - Method in interface com.clumd.projects.javajson.api.JsonBuilder
-
Used to finalise the current builder into a fully compiled Java-JSON object.
- build() - Method in class com.clumd.projects.javajson.core.BasicJsonBuilder
- builder() - Method in interface com.clumd.projects.javajson.api.JsonBuilder
-
Used to create an empty JSON shell.
- builder() - Method in class com.clumd.projects.javajson.core.BasicJsonBuilder
- BuildException - Exception in com.clumd.projects.javajson.exceptions
-
A class representing all possible exceptions that could occur when creating a JSON object from Java values.
- BuildException(String) - Constructor for exception com.clumd.projects.javajson.exceptions.BuildException
- BuildException(String, Throwable) - Constructor for exception com.clumd.projects.javajson.exceptions.BuildException
C
- com.clumd.projects.javajson - package com.clumd.projects.javajson
- com.clumd.projects.javajson.api - package com.clumd.projects.javajson.api
- com.clumd.projects.javajson.core - package com.clumd.projects.javajson.core
- com.clumd.projects.javajson.exceptions - package com.clumd.projects.javajson.exceptions
- com.clumd.projects.javajson.exceptions.json - package com.clumd.projects.javajson.exceptions.json
- com.clumd.projects.javajson.exceptions.schema - package com.clumd.projects.javajson.exceptions.schema
- consumeWhiteSpace() - Method in class com.clumd.projects.javajson.core.JsonTape
- contains(String) - Method in interface com.clumd.projects.javajson.api.Json
-
Used to check if a given key is present in this JSON object (Object in this sentence refers to any JSON data-type).
- containsAllKeys(Collection<String>) - Method in interface com.clumd.projects.javajson.api.Json
-
Used to check if every provided key appears in the current JSON object.
- convertFromJSON(Json) - Method in interface com.clumd.projects.javajson.api.JsonBuilder
-
Break a full JSON object down into a builder representation of itself to be added to.
- convertFromJSON(Json) - Method in class com.clumd.projects.javajson.core.BasicJsonBuilder
- convertToJSON() - Method in interface com.clumd.projects.javajson.api.JsonGenerator
-
Convert the current Java Class into a Java-JSON JSON representation of itself.
- convertToJSON() - Method in class com.clumd.projects.javajson.core.BasicJsonBuilder
- createFromMultilineString(List<String>) - Method in interface com.clumd.projects.javajson.api.Json
-
Convert the contents of consecutive Strings into the JSON representation of them.
- createFromString(String) - Method in interface com.clumd.projects.javajson.api.Json
-
Convert the contents of a String into the JSON representation.
D
E
- equals(Object) - Method in interface com.clumd.projects.javajson.api.Json
-
Replica of the .equals on a class, but used to enforce that implementors will override.
G
- getAny() - Method in interface com.clumd.projects.javajson.api.Json
-
Used to get the JSON datatype of the current object regardless of the underlying datatype it represents.
- getAnyAt(String) - Method in interface com.clumd.projects.javajson.api.Json
-
The same as
getAny, but at a path in the JSON given by key. - getArray() - Method in interface com.clumd.projects.javajson.api.Json
-
Used to get the array value of this JSON object, if it was itself, an array.
- getArrayAt(String) - Method in interface com.clumd.projects.javajson.api.Json
-
The same as
getArray, but at a path in the JSON given by key. - getBoolean() - Method in interface com.clumd.projects.javajson.api.Json
-
Used to get the boolean value of this JSON object, if it was itself, a boolean.
- getBooleanAt(String) - Method in interface com.clumd.projects.javajson.api.Json
-
The same as
getBoolean, but at a path in the JSON given by key. - getBuilder() - Static method in class com.clumd.projects.javajson.core.BasicJsonBuilder
- getDataType() - Method in interface com.clumd.projects.javajson.api.Json
-
Used to figure out which Datatype this JSON object represents from the JSON standard.
- getDataTypeOf(String) - Method in interface com.clumd.projects.javajson.api.Json
-
The same as
getDataType, but at a path in the JSON given by key. - getDouble() - Method in interface com.clumd.projects.javajson.api.Json
-
Used to get the double value of this JSON object, if it was itself, a double.
- getDoubleAt(String) - Method in interface com.clumd.projects.javajson.api.Json
-
The same as
getDouble, but at a path in the JSON given by key. - getFileAsString(String) - Static method in class com.clumd.projects.javajson.Main
- getJSONObject() - Method in interface com.clumd.projects.javajson.api.Json
-
Used to get the Object value of this JSON object, if it was itself, an Object.
- getJSONObjectAt(String) - Method in interface com.clumd.projects.javajson.api.Json
-
The same as
getJSONObject, but at a path in the JSON given by key. - getKeys() - Method in interface com.clumd.projects.javajson.api.Json
-
Used to get a list of all possible keys available at the current depth/level of json.
- getKeysOf(String) - Method in interface com.clumd.projects.javajson.api.Json
-
The same as
getKeys, but at a path in the JSON given by key. - getLong() - Method in interface com.clumd.projects.javajson.api.Json
-
Used to get the long value of this JSON object, if it was itself, a long.
- getLongAt(String) - Method in interface com.clumd.projects.javajson.api.Json
-
The same as
getLong, but at a path in the JSON given by key. - getString() - Method in interface com.clumd.projects.javajson.api.Json
-
Used to get the string value of this JSON object, if it was itself, a string.
- getStringAt(String) - Method in interface com.clumd.projects.javajson.api.Json
-
The same as
getString, but at a path in the JSON given by key. - getValue() - Method in interface com.clumd.projects.javajson.api.Json
-
Used to get the underlying value of each JSON datatype in a non-typesafe manner.
- getValueAt(String) - Method in interface com.clumd.projects.javajson.api.Json
-
The same as
getValue, but at a path in the JSON given by key. - getValues() - Method in interface com.clumd.projects.javajson.api.Json
-
Used to get a list of all values of the current JSON object.
- getValuesOf(String) - Method in interface com.clumd.projects.javajson.api.Json
-
The same as
getValues, but at a path in the JSON given by key.
H
- hashCode() - Method in interface com.clumd.projects.javajson.api.Json
-
Used to enforce the implementation of a Hashcode on Implementers
I
- InvalidSchemaException - Exception in com.clumd.projects.javajson.exceptions.schema
-
This exception is used when a provided schema, IS valid JSON, but is NOT a valid Schema.
- InvalidSchemaException(String) - Constructor for exception com.clumd.projects.javajson.exceptions.schema.InvalidSchemaException
- InvalidSchemaException(String, Throwable) - Constructor for exception com.clumd.projects.javajson.exceptions.schema.InvalidSchemaException
J
- Json - Interface in com.clumd.projects.javajson.api
-
Defines the required methods callable on a JSON object, to get type-safe properties, check existence, and convert to various degrees of string (pretty print etc).
- JsonBuilder - Interface in com.clumd.projects.javajson.api
-
Defines the required methods to build a JSON object from Java in this framework.
- JsonException - Exception in com.clumd.projects.javajson.exceptions
-
The top level exception.
- JsonException(String) - Constructor for exception com.clumd.projects.javajson.exceptions.JsonException
- JsonException(String, Throwable) - Constructor for exception com.clumd.projects.javajson.exceptions.JsonException
- JsonGenerator - Interface in com.clumd.projects.javajson.api
-
This defines all methods required to convert a Java object into a JSON object interperable by this framework.
- JsonKeyException - Exception in com.clumd.projects.javajson.exceptions.json
-
A class representing all possible exceptions that could occur with any JSON key.
- JsonKeyException(String) - Constructor for exception com.clumd.projects.javajson.exceptions.json.JsonKeyException
- JsonMapper<E> - Interface in com.clumd.projects.javajson.api
-
This interface defines the method used to unwrap a Java-JSON representation into a 'fully-qualified' Java object, devoid of any control, functionality or influence from this framework.
- JsonParseException - Exception in com.clumd.projects.javajson.exceptions.json
-
A class representing all possible exceptions that could occur when parsing a JSON object.
- JsonParseException(String) - Constructor for exception com.clumd.projects.javajson.exceptions.json.JsonParseException
- JsonParser - Class in com.clumd.projects.javajson.api
-
A default static utility class for constructing JSON objects from various forms of String input.
- JsonSchemaEnforceable - Interface in com.clumd.projects.javajson.api
-
Used to define all the methods required to verify that a given JSON object satisfies a given JSON Schema.
- JsonSchemaEnforcer - Class in com.clumd.projects.javajson.api
-
Default implementation of
JsonSchemaEnforceable, to verify whether a given JSON object satisfies a given JSON schema. - JsonSchemaEnforcer() - Constructor for class com.clumd.projects.javajson.api.JsonSchemaEnforcer
- JsonTape - Class in com.clumd.projects.javajson.core
- JsonTape(String) - Constructor for class com.clumd.projects.javajson.core.JsonTape
- JSType - Enum in com.clumd.projects.javajson.core
K
- KeyDifferentTypeException - Exception in com.clumd.projects.javajson.exceptions.json
-
This exception is used when there was a value found at a given key, but the datatype of the value found was not suitable for the calling method.
- KeyDifferentTypeException(String) - Constructor for exception com.clumd.projects.javajson.exceptions.json.KeyDifferentTypeException
- KeyInvalidException - Exception in com.clumd.projects.javajson.exceptions.json
-
This exception is used when a JSON key was malformed in some way.
- KeyInvalidException(String) - Constructor for exception com.clumd.projects.javajson.exceptions.json.KeyInvalidException
- KeyNotFoundException - Exception in com.clumd.projects.javajson.exceptions.json
-
This exception is used when the value at some location provided by some key does not exist.
- KeyNotFoundException(String) - Constructor for exception com.clumd.projects.javajson.exceptions.json.KeyNotFoundException
L
M
- main(String[]) - Static method in class com.clumd.projects.javajson.Main
- Main - Class in com.clumd.projects.javajson
- Main() - Constructor for class com.clumd.projects.javajson.Main
- mapToClass(Json) - Method in interface com.clumd.projects.javajson.api.JsonMapper
-
Used to convert the given JSON into a pure, top level Java object.
N
- newTypedException(String) - Method in class com.clumd.projects.javajson.core.JsonTape
O
P
- parse(JsonGenerator) - Static method in class com.clumd.projects.javajson.api.JsonParser
-
A pass-through method to convert any object marked as capable of converting itself to JSON, into the JSON equivalent.
- parse(String) - Static method in class com.clumd.projects.javajson.api.JsonParser
-
Parse a single JSON object from String.
- parse(String[]) - Static method in class com.clumd.projects.javajson.api.JsonParser
-
Parse a static array of strings into a single JSON object.
- parse(Collection<String>) - Static method in class com.clumd.projects.javajson.api.JsonParser
-
Parse a collection of strings into a single JSON object.
- parseMultipleJSONables(Collection<JsonGenerator>) - Static method in class com.clumd.projects.javajson.api.JsonParser
-
Parse a collection of Java Objects marked as capable of converting themselves to JSON into a multiple JSON objects.
- parseMultipleJSONablesForDistinct(Collection<JsonGenerator>) - Static method in class com.clumd.projects.javajson.api.JsonParser
-
The same as
JsonParser.parseMultipleJSONables(Collection), but any duplicates will be filtered out. - parseMultipleStrings(Collection<String>) - Static method in class com.clumd.projects.javajson.api.JsonParser
-
Parse a collection of strings into a multiple JSON objects.
- parseMultipleStringsForDistinct(Collection<String>) - Static method in class com.clumd.projects.javajson.api.JsonParser
-
The same as
JsonParser.parseMultipleStrings(Collection), but any duplicates will be filtered out. - parseNextElement() - Method in class com.clumd.projects.javajson.core.JsonTape
S
- SchemaException - Exception in com.clumd.projects.javajson.exceptions
-
A class representing all possible exceptions that could occur when validating a JSON object against a Schema.
- SchemaException(String) - Constructor for exception com.clumd.projects.javajson.exceptions.SchemaException
- SchemaException(String, Throwable) - Constructor for exception com.clumd.projects.javajson.exceptions.SchemaException
- SchemaViolationException - Exception in com.clumd.projects.javajson.exceptions.schema
-
This exception is used validating a JSON object against a schema, a violation of one of the Schema's constraints was found.
- SchemaViolationException(String) - Constructor for exception com.clumd.projects.javajson.exceptions.schema.SchemaViolationException
- SchemaViolationException(String, Throwable) - Constructor for exception com.clumd.projects.javajson.exceptions.schema.SchemaViolationException
- STRING - com.clumd.projects.javajson.core.JSType
T
- toPrettyString() - Method in interface com.clumd.projects.javajson.api.Json
-
Calls asPrettyString with the shallowest depth and a default indent width of 4.
- toString() - Method in interface com.clumd.projects.javajson.api.Json
-
Calls as string with the shallowest depth
- toString() - Method in class com.clumd.projects.javajson.core.BasicJsonBuilder
V
- validate(Json, Json) - Static method in class com.clumd.projects.javajson.api.JsonSchemaEnforcer
-
A static equivalent of
JsonSchemaEnforcer.validateWithReasoning(Json, Json). - validateStrict(Json, Json) - Static method in class com.clumd.projects.javajson.api.JsonSchemaEnforcer
-
A static equivalent of
JsonSchemaEnforceable.validateWithOutReasoning(Json, Json). - validateWithOutReasoning(Json, Json) - Method in interface com.clumd.projects.javajson.api.JsonSchemaEnforceable
-
Validate but never throw exceptions
- validateWithReasoning(Json, Json) - Method in interface com.clumd.projects.javajson.api.JsonSchemaEnforceable
-
Validate with the potential to throw exceptions to the caller.
- validateWithReasoning(Json, Json) - Method in class com.clumd.projects.javajson.api.JsonSchemaEnforcer
- valueOf(String) - Static method in enum com.clumd.projects.javajson.core.JSType
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum com.clumd.projects.javajson.core.JSType
-
Returns an array containing the constants of this enum type, in the order they are declared.
All Classes All Packages