net.wildfyre.utils

Class InvalidJsonException

java.lang.Object

java.lang.Throwable

java.lang.Exception

net.wildfyre.utils.InvalidJsonException

All Implemented Interfaces:

Serializable

public class InvalidJsonException
extends Exception

This exception represents a problem that occurred because the JSON data provided contained an error.

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
static InvalidJsonException	missingField(String field, com.eclipsesource.json.JsonValue json) Creates and returns an exception symbolizing that a required field was missing in some JSON data.
static Optional<com.eclipsesource.json.JsonValue>	optionalField(com.eclipsesource.json.JsonObject json, String name) Tries to access a field of a JSON object.
static com.eclipsesource.json.JsonValue	requireField(com.eclipsesource.json.JsonObject json, String name) Requires the existence of a field in a JSON object.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

missingField

public static InvalidJsonException missingField(String field,
                                                com.eclipsesource.json.JsonValue json)

Creates and returns an exception symbolizing that a required field was missing in some JSON data.

Parameters:

field - the missing field

json - the JSON data that did not contain the field

Returns:

The exception created by this class.

requireField

public static com.eclipsesource.json.JsonValue requireField(com.eclipsesource.json.JsonObject json,
                                                            String name)
                                                     throws InvalidJsonException

Requires the existence of a field in a JSON object.

Parameters:

json - the JSON object

name - the name of the field

Returns:

The value found in that field (see JsonObject.get(String)).

Throws:

InvalidJsonException - If the field is not found.

optionalField

public static Optional<com.eclipsesource.json.JsonValue> optionalField(com.eclipsesource.json.JsonObject json,
                                                                       String name)

Tries to access a field of a JSON object.

Parameters:

json - the JSON object

name - the name of the field

Returns:

The value found in that field, or an empty Optional.