JSONException

java.lang.Object
- java.lang.Throwable
- - java.lang.Exception
  - - com.purplehillsbooks.json.JSONException

All Implemented Interfaces:

TemplatizedMessage, java.io.Serializable
```
public class JSONException
extends java.lang.Exception
implements TemplatizedMessage
```
JSONException is mainly a class that has a few helpful methods for handling exceptions, such as: to get the full message of a chain of exceptions, to test if a particular message is anywhere in a chain, to convert an exception to JSON in a standard way to trace an exception to the output stream in a standard way.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static int MAXIMUM_PARAM_LENGTH

java.lang.String[] params

java.lang.String template

Fields
Modifier and Type	Field and Description
`static int`	`MAXIMUM_PARAM_LENGTH`
`java.lang.String[]`	`params`
`java.lang.String`	`template`

Constructor Summary

Constructors
Constructor and Description
`JSONException(java.lang.String message)` Constructs a JSONException with an explanatory message.
`JSONException(java.lang.String template, java.lang.Object... params)` Construct the exception with a template by using variable parameters Use a template like this:
`JSONException(java.lang.String message, java.lang.Throwable cause)` Constructs a JSONException with an explanatory message.
`JSONException(java.lang.String template, java.lang.Throwable cause, java.lang.Object... params)` Construct the exception with a template by using variable parameters with a pattern like this:

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static boolean`	`containsMessage(java.lang.Throwable t, java.lang.String fragment)` When an exception is caught, you will want to test whether the exception, or any of the causing exceptions contains a particular string fragment.
`static java.lang.Exception`	`convertJSONToException(JSONObject ex)` Given a JSON representation of an exception, this re-constructs the Exception chain (linked cause exceptions) and returns the Exception object.
`static JSONObject`	`convertToJSON(java.lang.Throwable e, java.lang.String context)` In any kind of JSON protocol, you need to return an exception back to the caller.
`static java.lang.String`	`formatString(java.lang.String template, java.lang.String[] params)`
`java.lang.String`	`getFormattedMessage()`
`static java.lang.String`	`getFullMessage(java.lang.Throwable e)` Walks through a chain of exception objects, from the first, to each "cause" in turn, creating a single combined string message from all the exception objects in the chain, with newline characters between each exception message.
`java.lang.String[]`	`getParameters()`
`java.lang.String`	`getStdTemplate()` Get a message template with the form of "Problem {0} found in {1}" Parameters are zero based Parameters are in curly braces
`static java.lang.String`	`getTraceExceptionFormat(JSONObject errOb)` If you have already converted to a JSONOBject, you can use this method to get a standard trace of that object to the output writer.
`static int`	`safeConvertInt(java.lang.String val)`
`static java.lang.String[]`	`stringifyParams(java.lang.Object[] input)`
`java.lang.String`	`substituteParams()`
`static void`	`traceConvertedException(java.io.PrintStream out, JSONObject errOb)` If you have already converted to a JSONOBject, you can use this method to get a standard trace of that object to the output writer.
`static void`	`traceConvertedException(java.io.Writer w, JSONObject errOb)`
`static JSONObject`	`traceException(java.io.PrintStream out, java.lang.Throwable e, java.lang.String context)` A standardized way to trace a given exception to the system out.
`static JSONObject`	`traceException(java.lang.Throwable e, java.lang.String context)` A standardized way to trace a given exception to the system out.
`static JSONObject`	`traceException(java.io.Writer w, java.lang.Throwable e, java.lang.String context)` A standardized way to trace a given exception to the system out.

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
  - template
```
public java.lang.String template
```
  - params
```
public java.lang.String[] params
```
  - MAXIMUM_PARAM_LENGTH
```
public static int MAXIMUM_PARAM_LENGTH
```
- Constructor Detail
  - JSONException
```
public JSONException(java.lang.String message)
```
    Constructs a JSONException with an explanatory message.
    
    Parameters:
    
    message - Detail about the reason for the exception.
  - JSONException
```
public JSONException(java.lang.String message,
                     java.lang.Throwable cause)
```
    Constructs a JSONException with an explanatory message. Wraps the passed throwable as the 'cause' exception.
    
    Parameters:
    
    message - Detail about the reason for the exception.
  - JSONException
```
public JSONException(java.lang.String template,
                     java.lang.Object... params)
```
    Construct the exception with a template by using variable parameters Use a template like this:
```
JSONException("Error when contemplating {0} in context of {1}", value0, value1)
```
    Tokens are braces with a single digit numeral between them. The message will ultimately include the main string template with the values substituted, however this gives the option to translate the template before substitution and get a translated message. Parameters can be any object, but they are immediately conferted to a string using toString so if you want different formatting convert to a string before passing the value in. Parameters are truncated to MAXIMUM_PARAM_LENGTH. The static value MAXIMUM_PARAM_LENGTH can be modified by containing program.
  - JSONException
```
public JSONException(java.lang.String template,
                     java.lang.Throwable cause,
                     java.lang.Object... params)
```
    Construct the exception with a template by using variable parameters with a pattern like this:
```
JSONException("Error when contemplating {0} in context of {1}", ex, value0, value1)
```
    See JSONException constructor without Throwable for more details.
- Method Detail
  - stringifyParams
```
public static java.lang.String[] stringifyParams(java.lang.Object[] input)
```
  - formatString
```
public static java.lang.String formatString(java.lang.String template,
                                            java.lang.String[] params)
```
  - safeConvertInt
```
public static int safeConvertInt(java.lang.String val)
```
  - getFullMessage
```
public static java.lang.String getFullMessage(java.lang.Throwable e)
```
    Walks through a chain of exception objects, from the first, to each "cause" in turn, creating a single combined string message from all the exception objects in the chain, with newline characters between each exception message.
  - containsMessage
```
public static boolean containsMessage(java.lang.Throwable t,
                                      java.lang.String fragment)
```
    When an exception is caught, you will want to test whether the exception, or any of the causing exceptions contains a particular string fragment. This routine searches the entire cascading chain of exceptions and return true if the string fragment is found in any of the exception, and false if the fragment is not found anywhere.
  - substituteParams
```
public java.lang.String substituteParams()
```
  - convertToJSON
```
public static JSONObject convertToJSON(java.lang.Throwable e,
                                       java.lang.String context)
                                throws java.lang.Exception
```
    In any kind of JSON protocol, you need to return an exception back to the caller. How should the Java exception be encoded into JSON? This method offers a convenient way to convert ANY exception into a stardard form proposed by OASIS: http://docs.oasis-open.org/odata/odata-json-format/v4.0/errata02/os/odata-json-format-v4.0-errata02-os-complete.html#_Toc403940655 Also see: https://agiletribe.wordpress.com/2015/09/16/json-rest-api-exception-handling/
    
    Parameters:
    
    context - allows you to include some context about the operation that was being performed when the exception occurred.
    
    Throws:
    
    java.lang.Exception
  - traceException
```
public static JSONObject traceException(java.lang.Throwable e,
                                        java.lang.String context)
```
    A standardized way to trace a given exception to the system out.
  - traceException
```
public static JSONObject traceException(java.io.PrintStream out,
                                        java.lang.Throwable e,
                                        java.lang.String context)
```
    A standardized way to trace a given exception to the system out. Because this is a method designed to be used during exception handling, it is written to avoid throwing any exceptions. All errors in the running of this routine are written to standard out.
  - traceException
```
public static JSONObject traceException(java.io.Writer w,
                                        java.lang.Throwable e,
                                        java.lang.String context)
```
    A standardized way to trace a given exception to the system out.
  - traceConvertedException
```
public static void traceConvertedException(java.io.PrintStream out,
                                           JSONObject errOb)
```
    If you have already converted to a JSONOBject, you can use this method to get a standard trace of that object to the output writer.
  - traceConvertedException
```
public static void traceConvertedException(java.io.Writer w,
                                           JSONObject errOb)
```
  - getTraceExceptionFormat
```
public static java.lang.String getTraceExceptionFormat(JSONObject errOb)
```
    If you have already converted to a JSONOBject, you can use this method to get a standard trace of that object to the output writer. This returns a string because it was too difficult to sort out the PrintWriter, Writer, PrintStream differences, and because all of the exceptions within exception need to be handled with output streams. Clearly returning a string is not efficient memory-wise, but exceptions should be rare, so don't worry about it.
  - convertJSONToException
```
public static java.lang.Exception convertJSONToException(JSONObject ex)
```
    Given a JSON representation of an exception, this re-constructs the Exception chain (linked cause exceptions) and returns the Exception object. The main purpose of this is when calling a web service, if it returns this standard kind of JSON representation, then this converts it back to exception objects so that can be thrown. Thus the exception on the server is reproduced to the client. This copies the stack to the final (rootmost) exception object and does not try to allocate stack to each of the individual exception objects in the chain
  - getStdTemplate
```
public java.lang.String getStdTemplate()
```
    Description copied from interface: TemplatizedMessage
    
    Get a message template with the form of "Problem {0} found in {1}" Parameters are zero based Parameters are in curly braces
    
    Specified by:
    
    getStdTemplate in interface TemplatizedMessage
  - getParameters
```
public java.lang.String[] getParameters()
```
    Specified by:
    
    getParameters in interface TemplatizedMessage
  - getFormattedMessage
```
public java.lang.String getFormattedMessage()
```
    Specified by:
    
    getFormattedMessage in interface TemplatizedMessage

Class JSONException

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Throwable

Methods inherited from class java.lang.Object

Field Detail

template

params

MAXIMUM_PARAM_LENGTH

Constructor Detail

JSONException

JSONException

JSONException

JSONException

Method Detail

stringifyParams

formatString

safeConvertInt

getFullMessage

containsMessage

substituteParams

convertToJSON

traceException

traceException

traceException

traceConvertedException

traceConvertedException

getTraceExceptionFormat

convertJSONToException

getStdTemplate

getParameters

getFormattedMessage