cx.ath.matthew.debug.Debug クラス

cx.ath.matthew.debug.Debug 連携図

クラス
interface	FilterCommand

静的公開メンバ関数
static void	setProperties (Properties prop)
static void	loadConfig (File f) throws IOException
static boolean	debugging (Class c, int loglevel)
static boolean	debugging (String s, int loglevel)
static void	setOutput (PrintStream p) throws IOException
static void	setOutput (String filename) throws IOException
static void	setOutput () throws IOException
static void	print (Object d)
static void	print (Object o, Object d)
static void	print (Object o, int loglevel, Object d)
static void	print (Object o, int loglevel, String s)
static void	print (Object o, int loglevel, Throwable t)
static void	print (Class c, int loglevel, Throwable t)
static void	print (int loglevel, Throwable t)
static void	print (int loglevel, byte[] b)
static void	print (int loglevel, String s)
static void	print (Class c, int loglevel, Object d)
static void	print (Class c, int loglevel, String s)
static void	print (int loglevel, Object o)
static void	printMap (Object o, int loglevel, Map m)
static void	printMap (Class c, int loglevel, Map m)
static void	printMap (Map m)
static void	printMap (int loglevel, Map m)
static void	setThrowableTraces (boolean ttrace)
static void	setTiming (boolean timing)
static void	setLineNos (boolean lines)
static void	setHexDump (boolean hexdump)
static void	setByteArrayCount (int count)
static void	setByteArrayWidth (int width)
static void	addFilterCommand (Class c, FilterCommand f)

静的公開変数類
static final int	CRIT = 1
static final int	ERR = 2
static final int	WARN = 3
static final int	INFO = 4
static final int	DEBUG = 5
static final int	VERBOSE = 6
static final boolean	debug = false
static PrintStream	debugout = System.err

静的非公開メンバ関数
static String []	getTraceElements ()
static void	_print (Class c, int level, String loc, String extra, String message, String[] lines)

静的非公開変数類
static Properties	prop = null
static boolean	timing = false
static boolean	ttrace = false
static boolean	lines = false
static boolean	hexdump = false
static long	last = 0
static int	balen = 36
static int	bawidth = 80
static Class	saveclass = null
static Map	filterMap = new HashMap()

詳解

Add debugging to your program, has support for large projects with multiple classes and debug levels per class. Supports optional enabling of debug per-level per-class and debug targets of files, Streams or stderr. Also supports timing between debug outputs, printing of stack traces for Throwables and files/line numbers on each message.

Debug now automatically figures out which class it was called from, so all methods passing in the calling class are deprecated.

The defaults are to print all messages to stderr with class and method name.

Should be called like this:

if (Debug.debug) Debug.print(Debug.INFO, "Debug Message");

関数詳解

_print()

static void cx.ath.matthew.debug.Debug._print ( Class  c, int  level, String  loc, String  extra, String  message, String []  lines  )

inlinestaticprivate

                                                                                                             {
        //TODO 1.5: FilterCommand f = filterMap.get(c);
        FilterCommand f = (FilterCommand) filterMap.get(c);
        if (null == f) {
            debugout.println("[" + loc + "] " + extra + message);
            if (null != lines)
                for (String s : lines)
                    debugout.println(s);
        } else
            f.filter(debugout, level, loc, extra, message, lines);
    }

addFilterCommand()

static void cx.ath.matthew.debug.Debug.addFilterCommand ( Class  c, FilterCommand  f  )

inlinestatic

Add a filter command for a specific type. This command will be called with the output stream and the text to be sent. It should perform any changes necessary to the text and then print the result to the output stream.

    {
        filterMap.put(c, f);
    }

debugging() [1/2]

static boolean cx.ath.matthew.debug.Debug.debugging ( Class  c, int  loglevel  )

inlinestatic

非推奨:

In Java 1.5 calling class is automatically identified, no need to pass it in.

                                                           {
        if (debug) {
            if (null == c) return true;
            return debugging(c.getName(), loglevel);
        }
        return false;
    }

debugging() [2/2]

static boolean cx.ath.matthew.debug.Debug.debugging ( String  s, int  loglevel  )

inlinestatic

                                                            {
        if (debug) {
            try {
                if (null == s) return true;
                if (null == prop) return loglevel <= DEBUG;
                String d = prop.getProperty(s);
                if (null == d || "".equals(d)) d = prop.getProperty("ALL");
                if (null == d) return loglevel <= ERR;
                if ("".equals(d)) return loglevel <= ERR;
                d = d.toLowerCase();
                if ("true".equals(d)) return true;
                if ("yes".equals(d)) return true;
                if ("all".equals(d)) return true;
                if ("verbose".equals(d)) return loglevel <= VERBOSE;
                if ("debug".equals(d)) return loglevel <= DEBUG;
                if ("info".equals(d)) return loglevel <= INFO;
                if ("warn".equals(d)) return loglevel <= WARN;
                if ("err".equals(d)) return loglevel <= ERR;
                if ("crit".equals(d)) return loglevel <= CRIT;
                int i = Integer.parseInt(d);
                return i >= loglevel;
            } catch (Exception e) {
                return false;
            }
        }
        return false;
    }

getTraceElements()

static String [] cx.ath.matthew.debug.Debug.getTraceElements ( )

inlinestaticprivate

                                               {
        String[] data = new String[]{"", "", ""};
        try {
            Method m = Thread.class.getMethod("getStackTrace", new Class[0]);
            StackTraceElement[] stes = (StackTraceElement[]) m.invoke(Thread.currentThread(), new Object[0]);
            for (StackTraceElement ste : stes) {
                if (Debug.class.getName().equals(ste.getClassName())) continue;
                if (Thread.class.getName().equals(ste.getClassName())) continue;
                if (Method.class.getName().equals(ste.getClassName())) continue;
                if (ste.getClassName().startsWith("sun.reflect")) continue;
                data[0] = ste.getClassName();
                data[1] = ste.getMethodName();
                if (lines)
                    data[2] = " " + ste.getFileName() + ":" + ste.getLineNumber();
                break;
            }
        } catch (NoSuchMethodException NSMe) {
            if (null != saveclass)
                data[0] = saveclass.getName();
        } catch (IllegalAccessException IAe) {
        } catch (InvocationTargetException ITe) {
        }
        return data;
    }

loadConfig()

static void cx.ath.matthew.debug.Debug.loadConfig ( File  f ) throws IOException

inlinestatic

Read which class to debug on at which level from the given File. Syntax the same as Java Properties files:

<class> = <debuglevel>

E.G.

cx.ath.matthew.io.TeeOutputStream = INFO
cx.ath.matthew.io.DOMPrinter = DEBUG

The debug level can be one of CRIT, ERR, WARN, INFO, DEBUG or VERBOSE which correspond to all messages up to that level. The special words YES, ALL and TRUE cause all messages to be printed regardless of level. All other terms disable messages for that class. CRIT and ERR messages are always printed if debugging is enabled unless explicitly disabled. The special class name ALL can be used to set the default level for all classes.

引数

f	File to read from.

                                                             {
        prop = new Properties();
        prop.load(new FileInputStream(f));
    }

print() [1/12]

static void cx.ath.matthew.debug.Debug.print ( Object  d )

inlinestatic

Log at DEBUG

引数

d	The object to log

                                       {
        if (debug) {
            if (d instanceof String)
                print(DEBUG, (String) d);
            else if (d instanceof Throwable)
                print(DEBUG, (Throwable) d);
            else if (d instanceof byte[])
                print(DEBUG, (byte[]) d);
            else if (d instanceof Map)
                printMap(DEBUG, (Map) d);
            else print(DEBUG, d);
        }
    }

print() [2/12]

static void cx.ath.matthew.debug.Debug.print ( Object  o, Object  d  )

inlinestatic

Log at DEBUG

引数

o	The object doing the logging
d	The object to log

非推奨:

In Java 1.5 calling class is automatically identified, no need to pass it in.

                                                 {
        if (debug) {
            if (o instanceof Class)
                saveclass = (Class) o;
            else
                saveclass = o.getClass();
            print(d);
        }
    }

print() [3/12]

static void cx.ath.matthew.debug.Debug.print ( Object  o, int  loglevel, Object  d  )

inlinestatic

Log an Object

引数

o	The object doing the logging
loglevel	The level to log at (DEBUG, WARN, etc)
d	The object to log with d.toString()

非推奨:

In Java 1.5 calling class is automatically identified, no need to pass it in.

                                                               {
        if (debug) {
            if (o instanceof Class)
                saveclass = (Class) o;
            else
                saveclass = o.getClass();
            print(loglevel, d);
        }
    }

print() [4/12]

static void cx.ath.matthew.debug.Debug.print ( Object  o, int  loglevel, String  s  )

inlinestatic

Log a String

引数

o	The object doing the logging
loglevel	The level to log at (DEBUG, WARN, etc)
s	The log message

非推奨:

In Java 1.5 calling class is automatically identified, no need to pass it in.

                                                               {
        if (debug) {
            if (o instanceof Class)
                saveclass = (Class) o;
            else
                saveclass = o.getClass();
            print(loglevel, s);
        }
    }

print() [5/12]

static void cx.ath.matthew.debug.Debug.print ( Object  o, int  loglevel, Throwable  t  )

inlinestatic

Log a Throwable

引数

o	The object doing the logging
loglevel	The level to log at (DEBUG, WARN, etc)
t	The throwable to log with .toString and .printStackTrace

非推奨:

In Java 1.5 calling class is automatically identified, no need to pass it in.

                                                                  {
        if (debug) {
            if (o instanceof Class)
                saveclass = (Class) o;
            else
                saveclass = o.getClass();
            print(loglevel, t);
        }
    }

print() [6/12]

static void cx.ath.matthew.debug.Debug.print ( Class  c, int  loglevel, Throwable  t  )

inlinestatic

Log a Throwable

引数

c	The class doing the logging
loglevel	The level to log at (DEBUG, WARN, etc)
t	The throwable to log with .toString and .printStackTrace

非推奨:

In Java 1.5 calling class is automatically identified, no need to pass it in.

                                                                 {
        if (debug) {
            saveclass = c;
            print(loglevel, t);
        }
    }

print() [7/12]

static void cx.ath.matthew.debug.Debug.print ( int  loglevel, Throwable  t  )

inlinestatic

Log a Throwable

引数

loglevel	The level to log at (DEBUG, WARN, etc)
t	The throwable to log with .toString and .printStackTrace

参照

setThrowableTraces to turn on stack traces.

                                                        {
        if (debug) {
            String timestr = "";
            String[] data = getTraceElements();
            if (debugging(data[0], loglevel)) {
                if (timing) {
                    long now = System.currentTimeMillis();
                    timestr = "{" + (now - last) + "} ";
                    last = now;
                }
                String[] lines = null;
                if (ttrace) {
                    StackTraceElement[] ste = t.getStackTrace();
                    lines = new String[ste.length];
                    for (int i = 0; i < ste.length; i++)
                        lines[i] = "\tat " + ste[i].toString();
                }
                _print(t.getClass(), loglevel, data[0] + "." + data[1] + "()" + data[2], timestr, t.toString(), lines);
            }
        }
    }

print() [8/12]

static void cx.ath.matthew.debug.Debug.print ( int  loglevel, byte []  b  )

inlinestatic

Log a byte array

引数

loglevel	The level to log at (DEBUG, WARN, etc)
b	The byte array to print.

参照

setHexDump to enable hex dumping.

setByteArrayCount to change how many bytes are printed.

setByteArrayWidth to change the formatting width of hex.

                                                     {
        if (debug) {
            String timestr = "";
            String[] data = getTraceElements();
            if (debugging(data[0], loglevel)) {
                if (timing) {
                    long now = System.currentTimeMillis();
                    timestr = "{" + (now - last) + "} ";
                    last = now;
                }
                String[] lines = null;
                if (hexdump) {
                    if (balen >= b.length)
                        lines = Hexdump.format(b, bawidth).split("\n");
                    else {
                        byte[] buf = new byte[balen];
                        System.arraycopy(b, 0, buf, 0, balen);
                        lines = Hexdump.format(buf, bawidth).split("\n");
                    }
                }
                _print(b.getClass(), loglevel, data[0] + "." + data[1] + "()" + data[2], timestr, b.length + " bytes", lines);
            }
        }
    }

print() [9/12]

static void cx.ath.matthew.debug.Debug.print ( int  loglevel, String  s  )

inlinestatic

Log a String

引数

loglevel	The level to log at (DEBUG, WARN, etc)
s	The string to log with d.toString()

                                                     {
        if (debug)
            print(loglevel, (Object) s);
    }

print() [10/12]

static void cx.ath.matthew.debug.Debug.print ( Class  c, int  loglevel, Object  d  )

inlinestatic

Log an Object

引数

c	The class doing the logging
loglevel	The level to log at (DEBUG, WARN, etc)
d	The object to log with d.toString()

非推奨:

In Java 1.5 calling class is automatically identified, no need to pass it in.

                                                              {
        if (debug) {
            saveclass = c;
            print(loglevel, d);
        }
    }

print() [11/12]

static void cx.ath.matthew.debug.Debug.print ( Class  c, int  loglevel, String  s  )

inlinestatic

Log a String

引数

c	The class doing the logging
loglevel	The level to log at (DEBUG, WARN, etc)
s	The log message

非推奨:

In Java 1.5 calling class is automatically identified, no need to pass it in.

                                                              {
        if (debug) {
            saveclass = c;
            print(loglevel, s);
        }
    }

print() [12/12]

static void cx.ath.matthew.debug.Debug.print ( int  loglevel, Object  o  )

inlinestatic

Log an Object

引数

loglevel	The level to log at (DEBUG, WARN, etc)
o	The object to log

                                                     {
        if (debug) {
            String timestr = "";
            String[] data = getTraceElements();
            if (debugging(data[0], loglevel)) {
                if (timing) {
                    long now = System.currentTimeMillis();
                    timestr = "{" + (now - last) + "} ";
                    last = now;
                }
                _print(o.getClass(), loglevel, data[0] + "." + data[1] + "()" + data[2], timestr, o.toString(), null);
            }
        }
    }

printMap() [1/4]

static void cx.ath.matthew.debug.Debug.printMap ( Object  o, int  loglevel, Map  m  )

inlinestatic

Log a Map

引数

o	The object doing the logging
loglevel	The level to log at (DEBUG, WARN, etc)
m	The Map to print out

非推奨:

In Java 1.5 calling class is automatically identified, no need to pass it in.

                                                               {
        if (debug) {
            if (o instanceof Class)
                saveclass = (Class) o;
            else
                saveclass = o.getClass();
            printMap(loglevel, m);
        }
    }

printMap() [2/4]

static void cx.ath.matthew.debug.Debug.printMap ( Class  c, int  loglevel, Map  m  )

inlinestatic

Log a Map

引数

c	The class doing the logging
loglevel	The level to log at (DEBUG, WARN, etc)
m	The Map to print out

非推奨:

In Java 1.5 calling class is automatically identified, no need to pass it in.

                                                              {
        if (debug) {
            saveclass = c;
            printMap(loglevel, m);
        }
    }

printMap() [3/4]

static void cx.ath.matthew.debug.Debug.printMap ( Map  m )

inlinestatic

Log a Map at DEBUG log level

引数

m	The Map to print out

                                       {
        printMap(DEBUG, m);
    }

printMap() [4/4]

static void cx.ath.matthew.debug.Debug.printMap ( int  loglevel, Map  m  )

inlinestatic

Log a Map

引数

loglevel	The level to log at (DEBUG, WARN, etc)
m	The Map to print out

                                                     {
        if (debug) {
            String timestr = "";
            String[] data = getTraceElements();
            if (debugging(data[0], loglevel)) {
                if (timing) {
                    long now = System.currentTimeMillis();
                    timestr = "{" + (now - last) + "} ";
                    last = now;
                }
                Iterator i = m.keySet().iterator();
                String[] lines = new String[m.size()];
                int j = 0;
                while (i.hasNext()) {
                    Object key = i.next();
                    lines[j++] = "\t\t- " + key + " => " + m.get(key);
                }
                _print(m.getClass(), loglevel, data[0] + "." + data[1] + "()" + data[2], timestr, "Map:", lines);
            }
        }
    }

setByteArrayCount()

static void cx.ath.matthew.debug.Debug.setByteArrayCount ( int  count )

inlinestatic

Set the size of hexdumps. (Default: 36)

                                                    {
        Debug.balen = count;
    }

setByteArrayWidth()

static void cx.ath.matthew.debug.Debug.setByteArrayWidth ( int  width )

inlinestatic

Set the formatted width of hexdumps. (Default: 80 chars)

                                                    {
        Debug.bawidth = width;
    }

setHexDump()

static void cx.ath.matthew.debug.Debug.setHexDump ( boolean  hexdump )

inlinestatic

Enable or disable hexdumps.

                                                   {
        Debug.hexdump = hexdump;
    }

setLineNos()

static void cx.ath.matthew.debug.Debug.setLineNos ( boolean  lines )

inlinestatic

Enable or disable line numbers.

                                                 {
        Debug.lines = lines;
    }

setOutput() [1/3]

static void cx.ath.matthew.debug.Debug.setOutput ( PrintStream  p ) throws IOException

inlinestatic

Output to the given Stream

                                                                   {
        debugout = p;
    }

setOutput() [2/3]

static void cx.ath.matthew.debug.Debug.setOutput ( String  filename ) throws IOException

inlinestatic

Output to the given file

                                                                     {
        debugout = new PrintStream(new FileOutputStream(filename, true));
    }

setOutput() [3/3]

static void cx.ath.matthew.debug.Debug.setOutput ( ) throws IOException

inlinestatic

Output to the default debug.log

                                                      {
        setOutput("./debug.log");
    }

setProperties()

static void cx.ath.matthew.debug.Debug.setProperties ( Properties  prop )

inlinestatic

Set properties to configure debugging. Format of properties is class => level, e.g.

cx.ath.matthew.io.TeeOutputStream = INFO
cx.ath.matthew.io.DOMPrinter = DEBUG

The debug level can be one of CRIT, ERR, WARN, INFO, DEBUG or VERBOSE which correspond to all messages up to that level. The special words YES, ALL and TRUE cause all messages to be printed regardless of level. All other terms disable messages for that class. CRIT and ERR messages are always printed if debugging is enabled unless explicitly disabled. The special class name ALL can be used to set the default level for all classes.

引数

prop	Properties object to use.

                                                      {
        Debug.prop = prop;
    }

setThrowableTraces()

static void cx.ath.matthew.debug.Debug.setThrowableTraces ( boolean  ttrace )

inlinestatic

Enable or disable stack traces in Debuging throwables.

                                                          {
        Debug.ttrace = ttrace;
    }

setTiming()

static void cx.ath.matthew.debug.Debug.setTiming ( boolean  timing )

inlinestatic

Enable or disable timing in Debug messages.

                                                 {
        Debug.timing = timing;
    }

メンバ詳解

balen

int cx.ath.matthew.debug.Debug.balen = 36

staticprivate

bawidth

int cx.ath.matthew.debug.Debug.bawidth = 80

staticprivate

CRIT

final int cx.ath.matthew.debug.Debug.CRIT = 1

static

Highest priority messages

DEBUG

final int cx.ath.matthew.debug.Debug.DEBUG = 5

static

Debug messages

debug

final boolean cx.ath.matthew.debug.Debug.debug = false

static

Set this to false to disable compilation of Debug statements

debugout

PrintStream cx.ath.matthew.debug.Debug.debugout = System.err

static

The current output stream (defaults to System.err)

ERR

final int cx.ath.matthew.debug.Debug.ERR = 2

static

Error messages

filterMap

Map cx.ath.matthew.debug.Debug.filterMap = new HashMap()

staticprivate

hexdump

boolean cx.ath.matthew.debug.Debug.hexdump = false

staticprivate

INFO

final int cx.ath.matthew.debug.Debug.INFO = 4

static

Information

last

long cx.ath.matthew.debug.Debug.last = 0

staticprivate

lines

boolean cx.ath.matthew.debug.Debug.lines = false

staticprivate

prop

Properties cx.ath.matthew.debug.Debug.prop = null

staticprivate

saveclass

Class cx.ath.matthew.debug.Debug.saveclass = null

staticprivate

timing

boolean cx.ath.matthew.debug.Debug.timing = false

staticprivate

ttrace

boolean cx.ath.matthew.debug.Debug.ttrace = false

staticprivate

VERBOSE

final int cx.ath.matthew.debug.Debug.VERBOSE = 6

static

Verbose debug messages

WARN

final int cx.ath.matthew.debug.Debug.WARN = 3

static

Warnings

---

このクラス詳解は次のファイルから抽出されました:

• D:/AppData/doxygen/keycloak/federation/src/federation/sssd/src/main/java/cx/ath/matthew/debug/Debug.java