gov.nist.antd.ospf_te
Class Debug

java.lang.Object
  |
  +--gov.nist.antd.ospf_te.Debug

public class Debug

extends java.lang.Object

Encapsulates and manages some debugging information and methods specific to OSPF.

Field Summary

private sOSPF_TE

ospf The OSPF protocol session object associated with this debugging manager.

Constructor Summary

(package private)

Debug(sOSPF_TE o) Constructs a debugging manager for a given OSPF instance.

Method Summary

void	_assert(boolean b) See comments for _assert(boolean,String).
void	_assert(boolean b, java.lang.String s) Each of the variations of _assert and gassert assert the truth of the given boolean, and print out a message if it is false.
void	err(java.lang.String s) Reports an OSPF-related error.
static void	gassert(boolean b) See comments for _assert(boolean,String).
static void	gassert(boolean b, java.lang.String s) See comments for _assert(boolean,String).
static void	gerr(java.lang.String str) A generic function for reporting OSPF-related errors which are not associated with a particular OSPF instance.
static void	gwarn(java.lang.String str) A generic function for reporting OSPF-related warnings which are not associated with a particular OSPF instance.
java.lang.String	hdr() Constructs a standardized output format prefix.
void	msg(int msgtype)
void	msg(int msgtype, double d)
void	msg(int msgtype, int caseno)
void	msg(int msgtype, int caseno, double d)
void	msg(int msgtype, int caseno, int i)
void	msg(int msgtype, int caseno, int i, int i2)
void	msg(int msgtype, int caseno, int i, int i2, java.lang.Object o)
void	msg(int msgtype, int caseno, int i, int i2, java.lang.Object o, java.lang.Object o2) Each variation of the msg method, except for the one-argument variation which takes a String, calls the Options class method to handle printing a debug message.
void	msg(int msgtype, int caseno, int i, java.lang.Object o)
void	msg(int msgtype, int caseno, java.lang.Object o)
void	msg(int msgtype, int caseno, java.lang.Object o, java.lang.Object o2)
void	msg(int msgtype, java.lang.Object o)
void	msg(int msgtype, java.lang.Object o, java.lang.Object o2)
void	msg(java.lang.String s) Prints a debugging message in the standardized format.
void	valid(int testnum, int msgnum) Each of the variations of valid handle printing messages associated with specific OSPF validation tests.
void	valid(int testnum, int msgnum, java.lang.Object o) See comments for valid(int,int).
void	warn(java.lang.String s) Reports an OSPF-related warning.

Methods inherited from class java.lang.Object

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

Field Detail

ospf

private sOSPF_TE ospf

The OSPF protocol session object associated with this debugging manager.

Constructor Detail

Debug

Debug(sOSPF_TE o)

Constructs a debugging manager for a given OSPF instance.

Parameters:

o - The OSPF instance with which this debug object is associated.

Method Detail

hdr

public final java.lang.String hdr()

Constructs a standardized output format prefix.

Returns:

the standardized output prefix as a String

_assert

public final void _assert(boolean b,
                          java.lang.String s)

Each of the variations of _assert and gassert assert the truth of the given boolean, and print out a message if it is false. gassert is for "generic assert," since it is static and doesn't print out the associated OSPF instance's info.

Parameters:

b - The boolean whose truth is asserted.

s - The string printed when the boolean is false.

_assert

public final void _assert(boolean b)

See comments for _assert(boolean,String).

Parameters:

b - XXX

gassert

public static final void gassert(boolean b,
                                 java.lang.String s)

See comments for _assert(boolean,String).

Parameters:

b - XXX

s - XXX

gassert

public static final void gassert(boolean b)

See comments for _assert(boolean,String).

err

public final void err(java.lang.String s)

Reports an OSPF-related error. XXX

Parameters:

s - - XXX

gerr

public static final void gerr(java.lang.String str)

A generic function for reporting OSPF-related errors which are not associated with a particular OSPF instance.

Parameters:

str - The string to be printed along with a generic OSPF error message preamble.

warn

public final void warn(java.lang.String s)

Reports an OSPF-related warning. XXX

Parameters:

s - - XXX

gwarn

public static final void gwarn(java.lang.String str)

A generic function for reporting OSPF-related warnings which are not associated with a particular OSPF instance.

Parameters:

str - The string to be printed as a warning message with a generic OSPF warning message preamble.

msg

public final void msg(java.lang.String s)

Prints a debugging message in the standardized format.

msg

public final void msg(int msgtype,
                      int caseno,
                      int i,
                      int i2,
                      java.lang.Object o,
                      java.lang.Object o2)

Each variation of the msg method, except for the one-argument variation which takes a String, calls the Options class method to handle printing a debug message.

Parameters:

msgtype - A constant indicating the type of debug message.

caseno - A case number, applicable to certain message types.

i - meaning varies depending on the message type

i2 - meaning varies depending on the message type

o - meaning varies depending on the message type

o2 - meaning varies depending on the message type

msg

public final void msg(int msgtype)

Parameters:

msgtype - - XXX

See Also:

XXX

msg

public final void msg(int msgtype,
                      int caseno)

Parameters:

msgtype - - XXX

caseno - - XXX

See Also:

XXX

msg

public final void msg(int msgtype,
                      int caseno,
                      int i)

Parameters:

msgtype - - XXX

caseno - - XXX

i - - XXX

See Also:

XXX

msg

public final void msg(int msgtype,
                      int caseno,
                      int i,
                      int i2)

Parameters:

msgtype - - XXX

caseno - - XXX

i - - XXX

i2 - - XXX

See Also:

XXX

msg

public final void msg(int msgtype,
                      int caseno,
                      int i,
                      int i2,
                      java.lang.Object o)

Parameters:

msgtype - - XXX

caseno - - XXX

i - - XXX

i2 - - XXX

o - - XXX

See Also:

XXX

msg

public final void msg(int msgtype,
                      int caseno,
                      int i,
                      java.lang.Object o)

Parameters:

msgtype - - XXX

caseno - - XXX

i - - XXX

o - - XXX

See Also:

XXX

msg

public final void msg(int msgtype,
                      int caseno,
                      java.lang.Object o)

Parameters:

msgtype - - XXX

caseno - - XXX

o - - XXX

See Also:

XXX

msg

public final void msg(int msgtype,
                      int caseno,
                      java.lang.Object o,
                      java.lang.Object o2)

Parameters:

msgtype - - XXX

caseno - - XXX

o - - XXX

o2 - - XXX

See Also:

XXX

msg

public final void msg(int msgtype,
                      java.lang.Object o)

Parameters:

msgtype - - XXX

o - - XXX

See Also:

XXX

msg

public final void msg(int msgtype,
                      java.lang.Object o,
                      java.lang.Object o2)

Parameters:

msgtype - - XXX

o - - XXX

o2 - - XXX

See Also:

XXX

msg

public final void msg(int msgtype,
                      double d)

Parameters:

msgtype - - XXX

d - - XXX

See Also:

XXX

msg

public final void msg(int msgtype,
                      int caseno,
                      double d)

Parameters:

msgtype - - XXX

caseno - - XXX

d - - XXX

See Also:

XXX

valid

public final void valid(int testnum,
                        int msgnum)

Each of the variations of valid handle printing messages associated with specific OSPF validation tests.

Parameters:

testnum - The validation test number.

msgnum - The message number relative to the validation test.

valid

public final void valid(int testnum,
                        int msgnum,
                        java.lang.Object o)

See comments for valid(int,int).