Package com.atlassian.adf.model.ex

Class AdfException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

com.atlassian.adf.model.ex.AdfException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

AdfException.MissingType, AdfException.PropertyException, AdfException.UnexpectedRuntimeException, AdfException.UnsupportedEnumValue, BorderException, IndentationException, MarkException, NodeException

public abstract class AdfException
extends RuntimeException

An exception reporting a problem with the structure of an ADF document.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AdfException.DuplicateProperty	Thrown to indicate the error of attempting to add the same key to the map representation of a node more than one time.
static class	AdfException.EmptyProperty	Thrown to indicate that a required string value was specified as an empty string.
static class	AdfException.InvalidURI	Used as a runtime replacement for URISyntaxException when a parameter value that must be a valid URI is checked.
static class	AdfException.MissingProperty	Thrown to indicate that a required field or attribute was not provided.
static class	AdfException.MissingType	Thrown for any node or mark that fails to specify a type value.
static class	AdfException.PropertyException	Thrown to indicate that there is something wrong with a field (those values placed directly at the top level of a node or mark) or attribute (those placed within the attrs object).
static class	AdfException.UnexpectedRuntimeException	Used to wrap other runtime exceptions as an AdfException, primarily so that the error path can potentially be provided for it.
static class	AdfException.UnsupportedEnumValue	Thrown when a limited set of enumerated values are permitted, but a value was encountered that is not in the allowed set.
static class	AdfException.ValueTypeMismatch	Thrown to indicate that a particular value could not be extracted from a field or attribute because it was not of the correct type.

Field Summary

Fields

Modifier and Type	Field	Description
static String	MARK_PREFIX	Used in exception backtraces to introduce the mark's type after any preceding information about where the mark was found.
static String	MARKS_PREFIX	Used in exception backtraces to indicate that the problem occurs within a node's marks fields rather than elsewhere in the node's information.
static String	NODE_PREFIX	Used in exception backtraces to introduce the node's type after any preceding information about where the node was found.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AdfException(String message)
protected	AdfException(String message, Throwable cause)

Method Summary

Modifier and Type	Method	Description
AdfException	backtrace(String frame)	Adds the given frame to the backtrace for this exception.
static <T> T	frame(String frame, Supplier<T> supplier)	Wraps code that calculates a value with a catch block that will add the specified frame to the backtrace(String) if that code throws a runtime exception.
String	getPath()	Returns the current path information for this exception, if it is available.
String	toString()

Methods inherited from class java.lang.Throwable

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

Methods inherited from class java.lang.Object

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

Field Detail

NODE_PREFIX

public static final String NODE_PREFIX

Used in exception backtraces to introduce the node's type after any preceding information about where the node was found.

Example: doc[0].paragraph[0].text:marks[1].code
The periods (.) before paragraph and text are node prefixes.

See Also:

Constant Field Values

MARK_PREFIX

public static final String MARK_PREFIX

Used in exception backtraces to introduce the mark's type after any preceding information about where the mark was found.

Example: doc[0].paragraph[0].text:marks[1].code
The period (.) before code is a mark prefix.

See Also:

Constant Field Values

MARKS_PREFIX

public static final String MARKS_PREFIX

Used in exception backtraces to indicate that the problem occurs within a node's marks fields rather than elsewhere in the node's information.

Example: doc[0].paragraph[0].text:marks[1].code
The :marks portion indicates that the text node's marks were at fault, and specifically the one at index [1], meaning the second mark.

See Also:

Constant Field Values

Constructor Detail

AdfException

protected AdfException(String message)

AdfException

protected AdfException(String message,
                       @Nullable
                       Throwable cause)

Method Detail

frame

public static <T> T frame(String frame,
                          Supplier<T> supplier)

Wraps code that calculates a value with a catch block that will add the specified frame to the backtrace(String) if that code throws a runtime exception.

Type Parameters:

T - the inferred return type of the supplier

Parameters:

frame - the frame information to be added to the backtrace if an exception is thrown

supplier - the code that generates the requested value

Returns:

the supplied value

Throws:

AdfException - with frame added to the backtrace if any RuntimeException is thrown by the supplier

backtrace

public final AdfException backtrace(String frame)

Adds the given frame to the backtrace for this exception. The backtrace is used to provide the path when rendering an AdfException.

Parameters:

frame - the frame information to add to this exception's backtrace

Returns:

this

getPath

@Nullable
public String getPath()

Returns the current path information for this exception, if it is available. The path is formed by concatenating all of the frame values that were provided by frame(String, Supplier) or backtrace(String) calls, in reverse order.

Returns:

the path information for this exception, or null if none has been provided

toString

public String toString()

Overrides:

toString in class Throwable