Module org.opendaylight.yangtools.yang.common

Package org.opendaylight.yangtools.yang.common

Enum Class ErrorType

java.lang.Object

java.lang.Enum<ErrorType>

org.opendaylight.yangtools.yang.common.ErrorType

All Implemented Interfaces:

Serializable, Comparable<ErrorType>, Constable

@NonNullByDefault
public enum ErrorType
extends Enum<ErrorType>

Enumeration of error-type values. These provide glue between NetconfLayer and various sources of such errors. This enumeration is not extensible in YANG as it is modeled in RFC8040.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
APPLICATION	A NetconfLayer.CONTENT layer error.
PROTOCOL	A NetconfLayer.OPERATIONS layer error.
RPC	A NetconfLayer.RPC layer error.
TRANSPORT	A NetconfLayer.TRANSPORT layer error.

Method Summary

Modifier and Type	Method	Description
String	elementBody()	Return the XML element body of this object.
static @Nullable ErrorType	forElementBody(String elementBody)
final NetconfLayer	layer()	Return the NetconfLayer corresponding to this error type.
static ErrorType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ErrorType[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

TRANSPORT

public static final ErrorType TRANSPORT

A NetconfLayer.TRANSPORT layer error. This typically happens on transport endpoints, where a protocol plugin needs to report a NETCONF-equivalent condition.

RPC

public static final ErrorType RPC

A NetconfLayer.RPC layer error. This typically happens on request routers, where a request may end up being resolved due to implementation-internal causes, such as timeouts and state loss.

PROTOCOL

public static final ErrorType PROTOCOL

A NetconfLayer.OPERATIONS layer error. These typically happen in a NETCONF protocol implementation.

APPLICATION

public static final ErrorType APPLICATION

A NetconfLayer.CONTENT layer error. These typically happen due to YANG data handling, such as type checking and structural consistency.

Method Details

values

public static ErrorType[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static ErrorType valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

elementBody

public String elementBody()

Return the XML element body of this object.

Returns:

element body of this object

layer

public final NetconfLayer layer()

Return the NetconfLayer corresponding to this error type.

Returns:

A NETCONF layer

forElementBody

public static @Nullable ErrorType forElementBody(String elementBody)