com.airlenet.yang.compiler.api

Class YangCompilerException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

com.airlenet.yang.compiler.api.YangCompilerException

All Implemented Interfaces:

Serializable

public class YangCompilerException
extends RuntimeException

Represents base class for exceptions in YANG tool operations.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
YangCompilerException(String message) Creates a new YANG tool exception with given message.
YangCompilerException(String message, Throwable cause) Creates a new tool exception from given message and cause.
YangCompilerException(Throwable cause) Creates a new tool exception from cause.

Method Summary

Modifier and Type	Method and Description
Path	getYangFile() Retrieves the current YANG files for which exception has occured.
void	setYangFile(Path yangFile) Updates the YANG file which caused the exception.

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 Detail

YangCompilerException

public YangCompilerException(String message)

Creates a new YANG tool exception with given message. It's expected that caller of YANG compiler display's exception message to communicate error information with user.

Parameters:

message - the detail of exception in string

YangCompilerException

public YangCompilerException(String message,
                             Throwable cause)

Creates a new tool exception from given message and cause. It's expected that caller of YANG compiler display's exception cause and message to communicate error information with user.

Parameters:

message - the detail of exception in string

cause - underlying cause of the error

YangCompilerException

public YangCompilerException(Throwable cause)

Creates a new tool exception from cause. It's expected that caller of YANG compiler display's exception cause to communicate error information with user.

Parameters:

cause - underlying cause of the error

Method Detail

getYangFile

public Path getYangFile()

Retrieves the current YANG files for which exception has occured.

Returns:

current YANG file

setYangFile

public void setYangFile(Path yangFile)

Updates the YANG file which caused the exception.

Parameters:

yangFile - YANG files being processed