NvdmAPI
Class RTE

java.lang.Object
  NvdmAPI.RTE

public abstract class RTE

extends java.lang.Object

Class representing the run-time environment for the API. The class acts as a (static) container for global configuration data, especially with respect to the logging facilities. It defines the constants for setting the logging type and level, and provides a method to convert an error code of the NvdmAPI back into english text.
The class cannot be instantiated.

Version:

1.0 6-Oct-2002

Author:

Lothar Baum

Field Summary

static long	ALL Constant for setting the logging to all levels.
static long	APPL Logging level for reporting actions directly related to using the NvdmAPI.
static long	BUFF Logging level for reporting actions related to internal buffer handling.
static long	CMPR Logging level for reporting actions related to compression and decompression of objects (intermediate object format).
static long	CODE Logging level for reporting actions related to coding and decoding of objects (network-related).
static long	COMM Logging level for reporting all general communication related actions.
static int	ERR Logging type for reporting errors.
static long	FILE Logging level for reporting file i/o operations.
static int	INFO Logging type for reporting general information about actions performed.
static long	NONE Logging level NONE.
static long	OBJC Logging level for reporting actions related to application-level object handling.
static long	RECV Logging level for detailled reporting of received data (including packet dump).
static long	SEND Logging level for detailled reporting of sent data (including packet dump).

Method Summary

static java.lang.String

getErrorText(int errcode) Returns the text message to a specified error code.

Methods inherited from class java.lang.Object

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

Field Detail

NONE

public static final long NONE

Logging level NONE. This is the default level: nothing will be reported.

See Also:

Constant Field Values

COMM

public static final long COMM

Logging level for reporting all general communication related actions.

See Also:

Constant Field Values

SEND

public static final long SEND

Logging level for detailled reporting of sent data (including packet dump).

See Also:

Constant Field Values

RECV

public static final long RECV

Logging level for detailled reporting of received data (including packet dump).

See Also:

Constant Field Values

BUFF

public static final long BUFF

Logging level for reporting actions related to internal buffer handling.

See Also:

Constant Field Values

FILE

public static final long FILE

Logging level for reporting file i/o operations.

See Also:

Constant Field Values

CODE

public static final long CODE

Logging level for reporting actions related to coding and decoding of objects (network-related).

See Also:

Constant Field Values

CMPR

public static final long CMPR

Logging level for reporting actions related to compression and decompression of objects (intermediate object format).

See Also:

Constant Field Values

OBJC

public static final long OBJC

Logging level for reporting actions related to application-level object handling.

See Also:

Constant Field Values

APPL

public static final long APPL

Logging level for reporting actions directly related to using the NvdmAPI.

See Also:

Constant Field Values

ALL

public static final long ALL

Constant for setting the logging to all levels.

See Also:

Constant Field Values

ERR

public static final int ERR

Logging type for reporting errors.

See Also:

Constant Field Values

INFO

public static final int INFO

Logging type for reporting general information about actions performed.

See Also:

Constant Field Values

Method Detail

getErrorText

public static java.lang.String getErrorText(int errcode)

Returns the text message to a specified error code. If the error code is 0 (no error), an empty string will be returned. If the error code is not recognized, the string 'unknown error' will be returned.

Parameters:

errcode - the error code

Returns:

the corresponding text message