Module org.opendaylight.yangtools.yang.parser.spi

Package org.opendaylight.yangtools.yang.parser.spi.meta

Class InferenceException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.opendaylight.yangtools.yang.model.api.meta.StatementSourceException

org.opendaylight.yangtools.yang.parser.spi.meta.InferenceException

All Implemented Interfaces:

Serializable

public final class InferenceException
extends StatementSourceException

A StatementSourceException indicating an inference problem, e.g. a problem with how statements interact with each other.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
InferenceException(@NonNull String message, @NonNull StatementSourceReference source)
InferenceException(@NonNull String message, @NonNull StatementSourceReference source, Throwable cause)
InferenceException(@NonNull String message, @NonNull CommonStmtCtx stmt)
InferenceException(@NonNull String message, @NonNull CommonStmtCtx stmt, Throwable cause)
InferenceException(@NonNull StatementSourceReference source, @NonNull String format, Object... args)
InferenceException(@NonNull CommonStmtCtx stmt, @NonNull String format, Object... args)

Method Summary

Modifier and Type	Method	Description
static void	throwIf(boolean expression, @NonNull StatementSourceReference source, @NonNull String format, Object... args)	Throw an instance of this exception if an expression evaluates to true.
static void	throwIf(boolean expression, @NonNull CommonStmtCtx stmt, @NonNull String format, Object... args)	Throw an instance of this exception if an expression evaluates to true.
static <T> @NonNull T	throwIfNull(@Nullable T obj, @NonNull StatementSourceReference source, @NonNull String format, Object... args)	Throw an instance of this exception if an object is null.
static <T> @NonNull T	throwIfNull(@Nullable T obj, @NonNull CommonStmtCtx stmt, @NonNull String format, Object... args)	Throw an instance of this exception if an object is null.

Methods inherited from class org.opendaylight.yangtools.yang.model.api.meta.StatementSourceException

sourceRef, throwNSE

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

InferenceException

public InferenceException(@NonNull String message,
 @NonNull StatementSourceReference source)

InferenceException

public InferenceException(@NonNull String message,
 @NonNull StatementSourceReference source,
 Throwable cause)

InferenceException

public InferenceException(@NonNull StatementSourceReference source,
 @NonNull String format,
 Object... args)

InferenceException

public InferenceException(@NonNull String message,
 @NonNull CommonStmtCtx stmt)

InferenceException

public InferenceException(@NonNull String message,
 @NonNull CommonStmtCtx stmt,
 Throwable cause)

InferenceException

public InferenceException(@NonNull CommonStmtCtx stmt,
 @NonNull String format,
 Object... args)

Method Details

throwIf

public static void throwIf(boolean expression,
 @NonNull StatementSourceReference source,
 @NonNull String format,
 Object... args)

Throw an instance of this exception if an expression evaluates to true. If the expression evaluates to false, this method does nothing.

Parameters:

expression - Expression to be evaluated

source - Statement source reference

format - Format string, according to String.format(String, Object...).

args - Format string arguments, according to String.format(String, Object...)

Throws:

InferenceException - if the expression evaluates to true.

throwIf

public static void throwIf(boolean expression,
 @NonNull CommonStmtCtx stmt,
 @NonNull String format,
 Object... args)

Throw an instance of this exception if an expression evaluates to true. If the expression evaluates to false, this method does nothing.

Parameters:

expression - Expression to be evaluated

stmt - Statement context

format - Format string, according to String.format(String, Object...).

args - Format string arguments, according to String.format(String, Object...)

Throws:

InferenceException - if the expression evaluates to true.

throwIfNull

public static <T> @NonNull T throwIfNull(@Nullable T obj,
 @NonNull CommonStmtCtx stmt,
 @NonNull String format,
 Object... args)

Throw an instance of this exception if an object is null. If the object is non-null, it will be returned as the result of this method.

Parameters:

obj - Object reference to be checked

stmt - Statement context, not retained

format - Format string, according to String.format(String, Object...).

args - Format string arguments, according to String.format(String, Object...)

Returns:

Object if it is not null

Throws:

InferenceException - if object is null

throwIfNull

public static <T> @NonNull T throwIfNull(@Nullable T obj,
 @NonNull StatementSourceReference source,
 @NonNull String format,
 Object... args)

Throw an instance of this exception if an object is null. If the object is non-null, it will be returned as the result of this method.

Parameters:

obj - Object reference to be checked

source - Statement source reference

format - Format string, according to String.format(String, Object...).

args - Format string arguments, according to String.format(String, Object...)

Returns:

Object if it is not null

Throws:

InferenceException - if object is null