SSF.OS.OSPF
Class Debug

java.lang.Object
  |
  +--SSF.OS.OSPF.Debug

public class Debug
extends java.lang.Object

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


Method Summary
 void affirm(boolean b)
          See comments for affirm(boolean,String).
 void affirm(boolean b, java.lang.String s)
          Each of the variations of affirm and gaffirm 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 gaffirm(boolean b)
          See comments for affirm(boolean,String).
static void gaffirm(boolean b, java.lang.String s)
          See comments for affirm(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
 

Method Detail

hdr

public final java.lang.String hdr()
Constructs a standardized output format prefix.

Returns:
the standardized output prefix as a String

affirm

public final void affirm(boolean b,
                         java.lang.String s)
Each of the variations of affirm and gaffirm assert the truth of the given boolean, and print out a message if it is false. gaffirm is for "generic affirm," since it is static and doesn't print out the associated OSPF instance's info. This method was called assert in previous versions, but assert became a Java keyword as of Java 1.4.0.

Parameters:
b - The boolean whose truth is asserted.
s - The string printed when the boolean is false.

affirm

public final void affirm(boolean b)
See comments for affirm(boolean,String).


gaffirm

public static final void gaffirm(boolean b,
                                 java.lang.String s)
See comments for affirm(boolean,String).


gaffirm

public static final void gaffirm(boolean b)
See comments for affirm(boolean,String).


err

public final void err(java.lang.String s)
Reports an OSPF-related error.


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.


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)
See Also:
msg(int,int,int,int,Object,Object)

msg

public final void msg(int msgtype,
                      int caseno)
See Also:
msg(int,int,int,int,Object,Object)

msg

public final void msg(int msgtype,
                      int caseno,
                      int i)
See Also:
msg(int,int,int,int,Object,Object)

msg

public final void msg(int msgtype,
                      int caseno,
                      int i,
                      int i2)
See Also:
msg(int,int,int,int,Object,Object)

msg

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

msg

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

msg

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

msg

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

msg

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

msg

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

msg

public final void msg(int msgtype,
                      double d)
See Also:
msg(int,int,int,int,Object,Object)

msg

public final void msg(int msgtype,
                      int caseno,
                      double d)
See Also:
msg(int,int,int,int,Object,Object)

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).