Overview | Package | Class | Tree | Deprecated | Index | Help
| © 2004 BEA Systems, Inc.
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## com.bea.commerce.ebusiness.discount.util
Class Log

    java.lang.Object
      com.bea.commerce.ebusiness.discount.util.Log

public class Log
extends Object

This class provides some very simple logging interfaces. Everything is static, so just call `Log.info()`, etc. All static methods for this Singleton service.

Field Summary
`static boolean` | `consoleMode` flag for logging to console in addition to log file
`static String` | `logDir` Directory holding log output
`static String` | `logFile` The name of the file holding log output
`static PrintWriter` | `logWriter` output for stderr console logging
`static PrintWriter` | `stderrWriter` output for stderr console logging
`static PrintWriter` | `stdoutWriter` output for stdout console logging
`static String` | `T_SEP`

Constructor Summary
`Log()`

Method Summary
`static void` | `clearConsole()` Sets the consoleMode flag to false stopping logging to the tty.
`static String` | `currentTime()`
`static void` | `debug(Object o, String s)` Sends string (prepended with class name) to debug log with newline
`static void` | `debug(String s)` Sends string to debug log with newline
`static void` | `debug(String s, boolean newline)` Sends string to debug log with optional newline
`static void` | `debug(Throwable e)` Prints a stackTrace for the given exception to error log
`static void` | `error(Object o, String s)` Sends string (prepended with class name) to error log with newline
`static void` | `error(String s)` Sends string to error log with newline
`static void` | `error(String s, boolean newline)` Sends string to error log with optional newline
`static void` | `error(Throwable e)` Prints a stackTrace for the given exception to error log
`static void` | `exception(Throwable e)` Prints a stackTrace for the given exception to error log
`static void` | `fatal(String s, int exitVal)` WARNING: calls System.exit() to kill the VM
`static void` | `fatal(Throwable e, int exitVal)` WARNING: calls System.exit() to kill the VM
`static PrintWriter` | `getPrintWriter()` Synchronize on this writer if used in a multi-threaded environment.
`static String` | `getStackTrace(Throwable e)`
`static PrintWriter` | `getStderrWriter()` Synchronize on this writer if used in a multi-threaded environment.
`static PrintWriter` | `getStdoutWriter()` Synchronize on this writer if used in a multi-threaded environment.
`static void` | `info(String s)` Sends string to info log with newline
`static void` | `info(String s, boolean newline)` Sends string to info log with optional newline
`static void` | `printCurrentTime(PrintWriter out)`
`static void` | `printCurrentTime(PrintWriter out, boolean showThread)`
`static long` | `profileFinish(String taskName, long startTime)` Logs the start, finished, and elapsed time for the given task For example, long startTime = Log.profileStart(); ...do some stuff...
`static long` | `profileFinish(String taskName, long startTime, long finishTime, boolean verbose)`
`static long` | `profileStart()`
`static void` | `setConsole()` Sets the console flag to true causing all logging to be sent to the tty
`static void` | `setConsole(boolean value)` Sets the consoleMode flag controlling logging to the tty.
`static PrintWriter` | `setPrintWriter(PrintWriter writer)` Synchronize on this writer if used in a multi-threaded environment.
`static void` | `stackTrace()` Prints a stackTrace marking the current stack to error log
`static void` | `warn(String s)` Sends string to warn log with newline
`static void` | `warn(String s, boolean newline)` Sends string to warn log with optional newline

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

### consoleMode

    public static boolean consoleMode

  flag for logging to console in addition to log file

### logDir

    public static String logDir

  Directory holding log output

### logFile

    public static String logFile

  The name of the file holding log output

### logWriter

    public static PrintWriter logWriter

  output for stderr console logging

### stderrWriter

    public static PrintWriter stderrWriter

  output for stderr console logging

### stdoutWriter

    public static PrintWriter stdoutWriter

  output for stdout console logging

### T_SEP

    public static final String T_SEP

See Also:
  Constant Field Values

Constructor Detail

### Log

    public Log()

Method Detail

### clearConsole

    public static void clearConsole()

  Sets the consoleMode flag to false stopping logging to the tty.

### currentTime

    public static String currentTime()

  Returns:
    The current time and thread name formatted for logging

### debug

    public static void debug(Object o,
                             String s)

  Sends string (prepended with class name) to debug log with newline

### debug

    public static void debug(String s)

  Sends string to debug log with newline

### debug

    public static void debug(String s,
                             boolean newline)

  Sends string to debug log with optional newline

### debug

    public static void debug(Throwable e)

  Prints a stackTrace for the given exception to error log

### error

    public static void error(Object o,
                             String s)

  Sends string (prepended with class name) to error log with newline

### error

    public static void error(String s)

  Sends string to error log with newline

### error

    public static void error(String s,
                             boolean newline)

  Sends string to error log with optional newline

### error

    public static void error(Throwable e)

  Prints a stackTrace for the given exception to error log

### exception

    public static void exception(Throwable e)

  Prints a stackTrace for the given exception to error log

### fatal

    public static void fatal(String s,
                             int exitVal)

  WARNING: calls System.exit() to kill the VM

### fatal

    public static void fatal(Throwable e,
                             int exitVal)

  WARNING: calls System.exit() to kill the VM

### getPrintWriter

    public static PrintWriter getPrintWriter()

  Synchronize on this writer if used in a multi-threaded environment.

### getStackTrace

    public static String getStackTrace(Throwable e)

  Returns:
    String with stack trace information for given exception

### getStderrWriter

    public static PrintWriter getStderrWriter()

  Synchronize on this writer if used in a multi-threaded environment.

### getStdoutWriter

    public static PrintWriter getStdoutWriter()

  Synchronize on this writer if used in a multi-threaded environment.

### info

    public static void info(String s)

  Sends string to info log with newline

### info

    public static void info(String s,
                            boolean newline)

  Sends string to info log with optional newline

### printCurrentTime

    public static void printCurrentTime(PrintWriter out)

### printCurrentTime

    public static void printCurrentTime(PrintWriter out,
                                        boolean showThread)

### profileFinish

    public static long profileFinish(String taskName,
                                     long startTime)

  Logs the start, finished, and elapsed time for the given task For example,

       long startTime = Log.profileStart();
       ...do some stuff...
       Log.profileFinish("MyApp.TaskName", startTime);

  Parameters:
    `taskName` - A short name for the task -- no spaces
    `startTime` - from profileStart

### profileFinish

    public static long profileFinish(String taskName,
                                     long startTime,
                                     long finishTime,
                                     boolean verbose)

### profileStart

    public static long profileStart()

  Returns:
    the startTime used in profileFinish

### setConsole

    public static void setConsole()

  Sets the console flag to true causing all logging to be sent to the tty

### setConsole

    public static void setConsole(boolean value)

  Sets the consoleMode flag controlling logging to the tty.

### setPrintWriter

    public static PrintWriter setPrintWriter(PrintWriter writer)

  Synchronize on this writer if used in a multi-threaded environment.

### stackTrace

    public static void stackTrace()

  Prints a stackTrace marking the current stack to error log

### warn

    public static void warn(String s)

  Sends string to warn log with newline

### warn

    public static void warn(String s,
                            boolean newline)

  Sends string to warn log with optional newline

Overview | Package | Class | Tree | Deprecated | Index | Help
| © 2004 BEA Systems, Inc.
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2004 BEA Systems, Inc. All Rights Reserved