Package org.opendaylight.yangtools.yang.data.api

Class ImmutableYangNetconfError

java.lang.Object

org.opendaylight.yangtools.yang.data.api.ImmutableYangNetconfError

All Implemented Interfaces:

YangNetconfError

@Generated("org.immutables.processor.ProxyProcessor")
public final class ImmutableYangNetconfError
extends Object
implements YangNetconfError

Immutable implementation of YangNetconfError.

Use the builder to create immutable instances: ImmutableYangNetconfError.builder().

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ImmutableYangNetconfError.Builder	Builds instances of type ImmutableYangNetconfError.
static interface	ImmutableYangNetconfError.BuildFinal
static interface	ImmutableYangNetconfError.SeverityBuildStage
static interface	ImmutableYangNetconfError.TagBuildStage
static interface	ImmutableYangNetconfError.TypeBuildStage

Method Summary

Modifier and Type	Method	Description
@Nullable String	appTag()	Return this error's error-app-tag, if available.
static ImmutableYangNetconfError.SeverityBuildStage	builder()	Creates a builder for ImmutableYangNetconfError.
boolean	equals(Object another)	This instance is equal to all instances of ImmutableYangNetconfError that have equal attribute values.
int	hashCode()	Computes a hash code from attributes: severity, type, tag, message, appTag, path, info.
ImmutableList<YangErrorInfo>	info()	Return this error's additional info.
@Nullable String	message()	Return this errors's error-message, if available.
@Nullable YangInstanceIdentifier	path()	Return the path which triggered this error, if available.
ErrorSeverity	severity()	Return this error's severity.
ErrorTag	tag()	Return this error's tag.
String	toString()	Prints the immutable value YangNetconfError with attribute values.
ErrorType	type()	Return this error's type.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

severity

public ErrorSeverity severity()

Return this error's severity.

Specified by:

severity in interface YangNetconfError

Returns:

Error severity.

type

public ErrorType type()

Return this error's type.

Specified by:

type in interface YangNetconfError

Returns:

Error type.

tag

public ErrorTag tag()

Return this error's tag.

Specified by:

tag in interface YangNetconfError

Returns:

Error tag.

message

public @Nullable String message()

Return this errors's error-message, if available. This value is expected to be defined in a YANG model through a error-message statement.

Specified by:

message in interface YangNetconfError

Returns:

Event message, or null.

appTag

public @Nullable String appTag()

Return this error's error-app-tag, if available. This value is expected to be defined in a YANG model through a error-app-tag statement.

Specified by:

appTag in interface YangNetconfError

Returns:

Application tag, or null.

path

public @Nullable YangInstanceIdentifier path()

Return the path which triggered this error, if available.

Specified by:

path in interface YangNetconfError

Returns:

Triggering path, or null.

info

public ImmutableList<YangErrorInfo> info()

Return this error's additional info.

Specified by:

info in interface YangNetconfError

Returns:

Additional info.

equals

public boolean equals(Object another)

This instance is equal to all instances of ImmutableYangNetconfError that have equal attribute values.

Overrides:

equals in class Object

Returns:

true if this is equal to another instance

hashCode

public int hashCode()

Computes a hash code from attributes: severity, type, tag, message, appTag, path, info.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value YangNetconfError with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

builder

public static ImmutableYangNetconfError.SeverityBuildStage builder()

Creates a builder for ImmutableYangNetconfError.

 ImmutableYangNetconfError.builder()
    .severity(org.opendaylight.yangtools.yang.common.ErrorSeverity) // required severity
    .type(org.opendaylight.yangtools.yang.common.ErrorType) // required type
    .tag(org.opendaylight.yangtools.yang.common.ErrorTag) // required tag
    .message(@org.eclipse.jdt.annotation.Nullable String | null) // nullable message
    .appTag(@org.eclipse.jdt.annotation.Nullable String | null) // nullable appTag
    .path(org.opendaylight.yangtools.yang.data.api.@org.eclipse.jdt.annotation.Nullable YangInstanceIdentifier | null) // nullable path
    .addInfo|addAllInfo(org.opendaylight.yangtools.yang.data.api.YangErrorInfo) // info elements
    .build();
 

Returns:

A new ImmutableYangNetconfError builder