Package Torello.Java.JSON

Class JsonPropMissingException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

javax.json.JsonException

Torello.Java.JSON.JsonBindingException

Torello.Java.JSON.JsonBindingObjException

Torello.Java.JSON.JsonPropMissingException

All Implemented Interfaces:

java.io.Serializable

public class JsonPropMissingException
extends JsonBindingObjException

JsonPropMissingException 🠞

• Json - This exception is thrown by the Json Reader Classes
  
  
• PropMissing - This particular class is tailored to hold information about errors that occur when a Json Property is missing from a JsonObject
  
  
• Exception - This class inherits class Exception
  
  

Used to indicate that therw was a property within a JsonObject that wasn't actually identified during the Json Parse.

The following 'final' Convenience Fields are exported by this Exception Class:

Inherited Field	Field Type	Inherited From
propertyName	java.lang.String	JsonBindingObjException
errorSourceJsonStruct	JsonStructure	JsonBindingException
expectedJsonType	JsonValue.ValueType	JsonBindingException
methodReturnJavaType	java.lang.Class	JsonBindingException
valueRetrieved	JsonValue	JsonBindingException

The main benefit of this complicated exception-class inheritance tree are the exception messages generated by this class. If any sub-class of JsonBindingException is thrown, it is guaranteed to produce as much detail as possible about which Json-Element has generated the error. Below is an example of what this class exception messages look like:

Terminal Output:

Exception in thread "main" Torello.Java.Additional.JsonPropMissingException: A JsonObject did not have any entry for the Property-Name requested Found In JsonObject: {"yearPurchased":"1999"} Property-Name: myWrongPropName Expected Json-Type: JsonValue.ValueType.NUMBER Contained JsonValue: Java-Null (Not Present) Having Actual Json-Type: Json-Type Not Available Converting To Java-Type: int ... [followed by stack-trace]

See Also:

Serialized Form

Hi-Lited Source-Code:

• View Here: Torello/Java/JSON/JsonPropMissingException.java
• Open New Browser-Tab: Torello/Java/JSON/JsonPropMissingException.java

File Size: 2,720 Bytes Line Count: 67 '\n' Characters Found

Field Summary

Serializable ID
Modifier and Type	Field
static long	serialVersionUID

Fields inherited from class Torello.Java.JSON.JsonBindingObjException

propertyName

Fields inherited from class Torello.Java.JSON.JsonBindingException

errorSourceJsonStruct, expectedJsonType, methodReturnJavaType, valueRetrieved

Constructor Summary

Constructors

Constructor	Description
JsonPropMissingException(String message, JsonObject errorSourceJsonObject, String propertyName, JsonValue.ValueType expectedJsonType, Class<?> methodReturnJavaType)	Constructs a JsonPropMissingException with the specified detail message, and user-provided convenience-field values.
JsonPropMissingException(JsonObject errorSourceJsonObject, String propertyName, JsonValue.ValueType expectedJsonType, Class<?> methodReturnJavaType)	Constructs a JsonPropMissingException with no specified detail messsage, and the user-provided convenience-field values.

Method Summary

Methods inherited from class Torello.Java.JSON.JsonBindingObjException

BASE_MESSAGE_OBJ

Methods inherited from class Torello.Java.JSON.JsonBindingException

BASE_MESSAGE

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

Field Detail

serialVersionUID

🡇 ⇈ ⮫ 🗕 🗗 🗖

public static final long serialVersionUID

This fulfils the SerialVersion UID requirement for all classes that implement Java's interface java.io.Serializable. Using the Serializable Implementation offered by java is very easy, and can make saving program state when debugging a lot easier. It can also be used in place of more complicated systems like "hibernate" to store data as well.

Note that Java's java.lang.Exception and java.lang.Error classes implement the Serializable interface, and a warning-free build expects this field be defined here.

See Also:

Constant Field Values

Code:

Exact Field Declaration Expression:

 public static final long serialVersionUID = 1;

Constructor Detail

JsonPropMissingException

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public JsonPropMissingException(JsonObject errorSourceJsonObject,
                                java.lang.String propertyName,
                                JsonValue.ValueType expectedJsonType,
                                java.lang.Class<?> methodReturnJavaType)

Constructs a JsonPropMissingException with no specified detail messsage, and the user-provided convenience-field values.

Parameters:

errorSourceJsonObject - The JsonObject from which the property is being retrieved / extracted.

propertyName - This is the property-name into the JsonObject from which the property is being retrieved / extracted.

expectedJsonType - This is the Json-Type that was expected to be retrieved from JsonObject.

methodReturnJavaType - Class ReadJSON will always provide the ultimate Java-Type that is to be returned by the method where this exception is being thrown.

JsonPropMissingException

🡅 ⇈ ⮫ 🗕 🗗 🗖

public JsonPropMissingException(java.lang.String message,
                                JsonObject errorSourceJsonObject,
                                java.lang.String propertyName,
                                JsonValue.ValueType expectedJsonType,
                                java.lang.Class<?> methodReturnJavaType)

Constructs a JsonPropMissingException with the specified detail message, and user-provided convenience-field values.

Parameters:

message - the detail message.

errorSourceJsonObject - The JsonObject from which the property is being retrieved / extracted.

propertyName - This is the property-name into the JsonObject from which the property is being retrieved / extracted.

expectedJsonType - This is the Json-Type that was expected to be retrieved from JsonObject.

methodReturnJavaType - Class ReadJSON will always provide the ultimate Java-Type that is to be returned by the method where this exception is being thrown.