com.snmp4j.smi

Class SmiError

java.lang.Object

com.snmp4j.smi.SmiError

public final class SmiError
extends Object

The SmiError class represents a syntax or semantic error in a SMI specification file. The error is located at the provided row and column and the defective text is available as well. In addition, error number and message are provided.

Constructor Summary

Constructors

Constructor and Description
SmiError(String moduleName, int row, int column, int endRow, int endColumn, int position, int errorNumber, String message, String shortMessage, String defectiveText, String[] expectedText)

Method Summary

Methods

Modifier and Type	Method and Description
int	getColumn() Gets the column where the defective text was found in the text file.
String	getDefectiveText() The text in the MIB specification that failed to parse.
int	getEndColumn() Gets the ending column where the defective text ends in the text file.
int	getEndRow() Gets the bottom row of the defective text in the text file.
int	getErrorNumber() Gets the error code of the error.
String[]	getExpectedText() Returns the expected text alternatives identified by the SMI compiler.
String	getMessage() Gets the error message for the error.
String	getModuleName() Gets the MIB module name (if available) of the MIB module that contains the error.
int	getPosition() Gets the byte position in the input stream where the defective text starts.
int	getRow() Gets the row where the defective text was found in the text file.
String	getShortMessage() Gets the error message for the error in a short form, without error number and location information.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

SmiError

public SmiError(String moduleName,
        int row,
        int column,
        int endRow,
        int endColumn,
        int position,
        int errorNumber,
        String message,
        String shortMessage,
        String defectiveText,
        String[] expectedText)

Method Detail

getColumn

public int getColumn()

Gets the column where the defective text was found in the text file.

Returns:

the one-based starting column of the error.

getEndColumn

public int getEndColumn()

Gets the ending column where the defective text ends in the text file.

Returns:

the one-based ending column of the error.

Since:

1.4

getErrorNumber

public int getErrorNumber()

Gets the error code of the error. See http://www.agentpp.com/mibdesigner3.x/MIBDesigner.pdf for a explanation of the error codes. If you doubt that an error is correctly reported, please first read section 6 "MIB Design" of that PDF document before contacting support.

Returns:

an error code, numerically identifying the type of error.

getMessage

public String getMessage()

Gets the error message for the error.

Returns:

a human readable error message describing the error in English.

getShortMessage

public String getShortMessage()

Gets the error message for the error in a short form, without error number and location information.

Returns:

a human readable error message describing the error in English.

getDefectiveText

public String getDefectiveText()

The text in the MIB specification that failed to parse.

Returns:

a text fragment which is located in the MIB specification at column getColumn() and row getRow().

getRow

public int getRow()

Gets the row where the defective text was found in the text file.

Returns:

the one-based starting row of the error.

getEndRow

public int getEndRow()

Gets the bottom row of the defective text in the text file.

Returns:

the one-based ending row of the error.

Since:

1.4

getPosition

public int getPosition()

Gets the byte position in the input stream where the defective text starts.

Returns:

the zero-based byte position of the defective text in the SMI specification.

Since:

1.4

getModuleName

public String getModuleName()

Gets the MIB module name (if available) of the MIB module that contains the error.

Returns:

a MIB module name or null if the MIB module name was not determinable.

getExpectedText

public String[] getExpectedText()

Returns the expected text alternatives identified by the SMI compiler.

Returns:

null if no text was expected/could be identified as expected. Otherwise, a list of expected text is returned where each element provides one alternative.

Since:

1.4

toString

public String toString()

Overrides:

toString in class Object