StructureException (Structure API 17.20.0 API)

Object
- Throwable
- - Exception
  - - StructureException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ForestMergeStructureException, StructureInteractionException
```
@PublicApi
public class StructureException
extends Exception
```
StructureException can be thrown for different causes that involve Structure plugin. It usually means that the operation that is traced back to the user's action cannot be performed and should be reported as an error.

Each exception is associated with a specific value from enumeration StructureError. Exception may also carry additional message and information about affected structure, view, item or row. The general method Throwable.getMessage(), returns all information included with the exception, except for the stack trace and cause.

Displaying User-Friendly Errors

To display an error on the user interface: use getLocalizedMessage() or getLocalizedMessage(ApplicationUser) to get a human-friendly error in the user's locale. However, in many cases the error message will not be localized and the result of getLocalizedMessage() will contain the problem description in English.

So for the best result, you should check isLocalized() method and if exception is not localized, use some wrapper text to display the error to the user in a good way:
```
 Java code:
   try {
     ...
   } catch (StructureException e) {
     if (e.isLocalized()) {
       setDisplayedError(e.getLocalizedMessage());
     } else {
       setDisplayedError(getText("my.errors.structure-error", e.getLocalizedMessage()));
     }
   }
```
Throwing StructureException

An instance of StructureException may be created by using one of the available constructors, but it might be more convenient to start from StructureError and use chained builder commands, ending with message specification:
```
   throw StructureErrors.GENERIC_ERROR.withMessage("cannot foo bar");
   ...
   throw StructureErrors.INVALID_JQL.causedBy(caughtException).forStructure(id).withoutMessage();
   ...
   throw StructureErrors.VIEW_EDIT_DENIED.forView(id).withLocalizedMessage("error.view.edit.denied", id, name);
 
```
See Also:

StructureError, Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class StructureException.Builder
A builder for StructureException.

Nested Classes
Modifier and Type	Class and Description
`static class`	`StructureException.Builder` A builder for `StructureException`.

Constructor Summary

Constructors
Modifier	Constructor and Description
	`StructureException(StructureError error)` Constructs an instance of exception.
	`StructureException(StructureError error, Long structure)` Constructs an instance of exception.
	`StructureException(StructureError error, Long structure, Long row)` Constructs an instance of exception.
	`StructureException(StructureError error, Long structure, Long row, Long view)` Constructs an instance of exception.
	`StructureException(StructureError error, Long structure, Long row, Long view, String message)` Constructs an instance of exception.
	`StructureException(StructureError error, Long structure, Long row, String message)` Constructs an instance of exception.
	`StructureException(StructureError error, Long structure, Long row, String message, Throwable cause)` Constructs an instance of exception.
	`StructureException(StructureError error, String message)` Constructs an instance of exception.
`protected`	`StructureException(StructureError error, Throwable cause, Long structure, Long view, Long row, ItemIdentity item, String message, String messageKey, Object... messageParameters)` Constructs an instance of this exception.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`I18nText`	`asI18nText()`
`StructureError`	`getError()` Returns the error value associated with the exception.
`ItemIdentity`	`getItem()` Returns related item, or null if no item is related.
`String`	`getLocalizedMessage()` Gets the localized message about the problem in the current user's locale.
`String`	`getLocalizedMessage(ApplicationUser user)` Gets the localized message about the problem in the given user's locale.
`String`	`getProblemDetails()` Returns the part of `Throwable.getMessage()` that corresponds to the original description of the problem.
`long`	`getRow()` Returns related row, or 0 if no row is related.
`long`	`getStructure()` Returns related structure, or 0 if no structure is related.
`long`	`getView()` Returns related view, or 0 if no view is related.
`boolean`	`isLocalized()` Checks if there's a i18n message.
`String`	`toString()` Provides string representation of the exception.

Methods inherited from class Throwable
addSuppressed, fillInStackTrace, getCause, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace

Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait