Package org.opendaylight.yangtools.yang.common

Class CanonicalValueViolation

java.lang.Object

org.opendaylight.yangtools.yang.common.CanonicalValueViolation

All Implemented Interfaces:

Serializable, Immutable, MutationBehaviour<Immutable>

Direct Known Subclasses:

CanonicalValueViolation.Regular, CanonicalValueViolation.WithException

@Beta
@NonNullByDefault
public abstract class CanonicalValueViolation
extends Object
implements Immutable, Serializable

A violation of a CanonicalValue validation. Contains details as mandated by RFC7950 Section 8.3.1.

Author:

Robert Varga

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CanonicalValueViolation.Regular
static class	CanonicalValueViolation.WithException

Constructor Summary

Constructors

Constructor	Description
CanonicalValueViolation()

Method Summary

Modifier and Type	Method	Description
static CanonicalValueViolation	empty()
static <T> Either<T,CanonicalValueViolation>	emptyVariant()
boolean	equals(@Nullable Object obj)
Optional<String>	getAppTag()
Optional<String>	getMessage()
int	hashCode()
static CanonicalValueViolation	of(@Nullable String appTag, @Nullable String message)
static CanonicalValueViolation	of(Exception cause)
String	toString()
static <T> Either<T,CanonicalValueViolation>	variantOf(@Nullable String appTag, String message)
static <T> Either<T,CanonicalValueViolation>	variantOf(Exception cause)
static <T> Either<T,CanonicalValueViolation>	variantOf(String message)

Methods inherited from class java.lang.Object

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

Constructor Detail

CanonicalValueViolation

public CanonicalValueViolation()

Method Detail

empty

public static CanonicalValueViolation empty()

of

public static CanonicalValueViolation of(Exception cause)

of

public static CanonicalValueViolation of(@Nullable String appTag,
                                         @Nullable String message)

emptyVariant

public static <T> Either<T,CanonicalValueViolation> emptyVariant()

variantOf

public static <T> Either<T,CanonicalValueViolation> variantOf(Exception cause)

variantOf

public static <T> Either<T,CanonicalValueViolation> variantOf(String message)

variantOf

public static <T> Either<T,CanonicalValueViolation> variantOf(@Nullable String appTag,
                                                                    String message)

getAppTag

public final Optional<String> getAppTag()

getMessage

public final Optional<String> getMessage()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(@Nullable Object obj)

Overrides:

equals in class Object

toString

public final String toString()

Overrides:

toString in class Object