java.lang.Object
- java.lang.Throwable
- - java.lang.Exception
  - - io.lighty.codecs.xml.DocumentedException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

MissingNameSpaceException, UnexpectedElementException, UnexpectedNamespaceException
```
@Deprecated(forRemoval=true)
public class DocumentedException
extends Exception
```
Deprecated, for removal: This API element is subject to removal in a future version.
Replaced by OpenDayLight implementation DocumentedException.

Checked exception to communicate an error that needs to be sent to the netconf client.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`DocumentedException.ErrorSeverity`	Deprecated, for removal: This API element is subject to removal in a future version.
`static class`	`DocumentedException.ErrorTag`	Deprecated, for removal: This API element is subject to removal in a future version.
`static class`	`DocumentedException.ErrorType`	Deprecated, for removal: This API element is subject to removal in a future version.

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`ERROR_APP_TAG`	Deprecated, for removal: This API element is subject to removal in a future version.
`static String`	`ERROR_INFO`	Deprecated, for removal: This API element is subject to removal in a future version.
`static String`	`ERROR_MESSAGE`	Deprecated, for removal: This API element is subject to removal in a future version.
`static String`	`ERROR_PATH`	Deprecated, for removal: This API element is subject to removal in a future version.
`static String`	`ERROR_SEVERITY`	Deprecated, for removal: This API element is subject to removal in a future version.
`static String`	`ERROR_TAG`	Deprecated, for removal: This API element is subject to removal in a future version.
`static String`	`ERROR_TYPE`	Deprecated, for removal: This API element is subject to removal in a future version.
`static String`	`RPC_ERROR`	Deprecated, for removal: This API element is subject to removal in a future version.

Constructor Summary

Constructors
Constructor	Description
`DocumentedException(String message)`	Deprecated, for removal: This API element is subject to removal in a future version.
`DocumentedException(String message, DocumentedException.ErrorType errorType, DocumentedException.ErrorTag errorTag, DocumentedException.ErrorSeverity errorSeverity)`	Deprecated, for removal: This API element is subject to removal in a future version.
`DocumentedException(String message, DocumentedException.ErrorType errorType, DocumentedException.ErrorTag errorTag, DocumentedException.ErrorSeverity errorSeverity, Map<String,String> errorInfo)`	Deprecated, for removal: This API element is subject to removal in a future version.
`DocumentedException(String message, Exception cause)`	Deprecated, for removal: This API element is subject to removal in a future version.
`DocumentedException(String message, Exception cause, DocumentedException.ErrorType errorType, DocumentedException.ErrorTag errorTag, DocumentedException.ErrorSeverity errorSeverity)`	Deprecated, for removal: This API element is subject to removal in a future version.
`DocumentedException(String message, Exception cause, DocumentedException.ErrorType errorType, DocumentedException.ErrorTag errorTag, DocumentedException.ErrorSeverity errorSeverity, Map<String,String> errorInfo)`	Deprecated, for removal: This API element is subject to removal in a future version.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`static DocumentedException`	`fromXMLDocument(Document fromDoc)`	Deprecated, for removal: This API element is subject to removal in a future version.
`Map<String,String>`	`getErrorInfo()`	Deprecated, for removal: This API element is subject to removal in a future version.
`DocumentedException.ErrorSeverity`	`getErrorSeverity()`	Deprecated, for removal: This API element is subject to removal in a future version.
`DocumentedException.ErrorTag`	`getErrorTag()`	Deprecated, for removal: This API element is subject to removal in a future version.
`DocumentedException.ErrorType`	`getErrorType()`	Deprecated, for removal: This API element is subject to removal in a future version.
`String`	`toString()`	Deprecated, for removal: This API element is subject to removal in a future version.
`Document`	`toXMLDocument()`	Deprecated, for removal: This API element is subject to removal in a future version.
`static <E extends Exception> DocumentedException`	`wrap(E exception)`	Deprecated, for removal: This API element is subject to removal in a future version.
`static DocumentedException`	`wrap(ConflictingVersionException ex)`	Deprecated, for removal: This API element is subject to removal in a future version.
`static DocumentedException`	`wrap(ValidationException ex)`	Deprecated, for removal: This API element is subject to removal in a future version.

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
- RPC_ERROR
```
public static final String RPC_ERROR
```
  Deprecated, for removal: This API element is subject to removal in a future version.
  
  See Also:
  
  Constant Field Values
- ERROR_TYPE
```
public static final String ERROR_TYPE
```
  Deprecated, for removal: This API element is subject to removal in a future version.
  
  See Also:
  
  Constant Field Values
- ERROR_TAG
```
public static final String ERROR_TAG
```
  Deprecated, for removal: This API element is subject to removal in a future version.
  
  See Also:
  
  Constant Field Values
- ERROR_SEVERITY
```
public static final String ERROR_SEVERITY
```
  Deprecated, for removal: This API element is subject to removal in a future version.
  
  See Also:
  
  Constant Field Values
- ERROR_APP_TAG
```
public static final String ERROR_APP_TAG
```
  Deprecated, for removal: This API element is subject to removal in a future version.
  
  See Also:
  
  Constant Field Values
- ERROR_PATH
```
public static final String ERROR_PATH
```
  Deprecated, for removal: This API element is subject to removal in a future version.
  
  See Also:
  
  Constant Field Values
- ERROR_MESSAGE
```
public static final String ERROR_MESSAGE
```
  Deprecated, for removal: This API element is subject to removal in a future version.
  
  See Also:
  
  Constant Field Values
- ERROR_INFO
```
public static final String ERROR_INFO
```
  Deprecated, for removal: This API element is subject to removal in a future version.
  
  See Also:
  
  Constant Field Values