com.sap.client.odata.v4.core

Class DebugConsole

java.lang.Object

com.sap.client.odata.v4.core.DebugConsole

public abstract class DebugConsole
extends java.lang.Object

Represents the system's debug console.

Constructor Summary

Constructors

Constructor and Description
DebugConsole()

Method Summary

Modifier and Type	Method and Description
static void	append(java.lang.String file) Start copying debug console output to file (append mode).
static void	close() Close the file opened by DebugConsole.open or DebugConsole.append.
static void	debug(java.lang.String message) See debug(String, RuntimeException, boolean).
static void	debug(java.lang.String message, java.lang.RuntimeException cause) See debug(String, RuntimeException, boolean).
static void	debug(java.lang.String message, java.lang.RuntimeException cause, boolean dump) Log a DEBUG message to the debug console.
static void	dumpStack() Dump the current thread's stack frames to the debug console.
static void	error(java.lang.String message) See error(String, RuntimeException, boolean).
static void	error(java.lang.String message, java.lang.RuntimeException cause) See error(String, RuntimeException, boolean).
static void	error(java.lang.String message, java.lang.RuntimeException cause, boolean dump) Log an ERROR message to the debug console.
static void	flush() Flush any buffered output written to a file.
static java.lang.String	getCaptured() Return captured debug console output.
static void	info(java.lang.String message) See info(String, RuntimeException, boolean).
static void	info(java.lang.String message, java.lang.RuntimeException cause) See info(String, RuntimeException, boolean).
static void	info(java.lang.String message, java.lang.RuntimeException cause, boolean dump) Log an INFO message to the debug console.
static void	log(java.lang.String message) See log(String, RuntimeException, boolean).
static void	log(java.lang.String message, java.lang.RuntimeException cause) See log(String, RuntimeException, boolean).
static void	log(java.lang.String message, java.lang.RuntimeException cause, boolean dump) Log a DEBUG message to the debug console.
static void	mainException(java.lang.RuntimeException cause) For internal use only.
static void	open(java.lang.String file) Start copying debug console output to file (create mode).
static void	startCapture() Start capturing debug console output to an internal buffer.
static void	stopCapture() Stop capturing debug console output to an internal buffer.
static void	trace(java.lang.String message) See trace(String, RuntimeException, boolean).
static void	trace(java.lang.String message, java.lang.RuntimeException cause) See trace(String, RuntimeException, boolean).
static void	trace(java.lang.String message, java.lang.RuntimeException cause, boolean dump) Log a TRACE message to the debug console.
static void	traceEx(java.lang.RuntimeException cause) Trace an exception to the debug console.
static void	traceIn(java.lang.String method) Trace a function entry to the debug console.
static void	traceOut(java.lang.String method) Trace a function exit to the debug console.
static void	warn(java.lang.String message) See warn(String, RuntimeException, boolean).
static void	warn(java.lang.String message, java.lang.RuntimeException cause) See warn(String, RuntimeException, boolean).
static void	warn(java.lang.String message, java.lang.RuntimeException cause, boolean dump) Log a WARN message to the debug console.

Methods inherited from class java.lang.Object

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

Constructor Detail

DebugConsole

public DebugConsole()

Method Detail

append

public static void append(java.lang.String file)

Start copying debug console output to file (append mode).

Parameters:

file - File for captured debug console output (created if it doesn't exist already).

close

public static void close()

Close the file opened by DebugConsole.open or DebugConsole.append. Has no effect if file was not open.

debug

public static void debug(java.lang.String message)

See debug(String, RuntimeException, boolean).

debug

public static void debug(java.lang.String message,
                         java.lang.RuntimeException cause)

See debug(String, RuntimeException, boolean).

debug

public static void debug(java.lang.String message,
                         java.lang.RuntimeException cause,
                         boolean dump)

Log a DEBUG message to the debug console.

Parameters:

message - Message text.

cause - (nullable) Optional exception.

dump - True to dump cause stack trace.

dumpStack

public static void dumpStack()

Dump the current thread's stack frames to the debug console.

error

public static void error(java.lang.String message)

See error(String, RuntimeException, boolean).

error

public static void error(java.lang.String message,
                         java.lang.RuntimeException cause)

See error(String, RuntimeException, boolean).

error

public static void error(java.lang.String message,
                         java.lang.RuntimeException cause,
                         boolean dump)

Log an ERROR message to the debug console.

Parameters:

message - Message text.

cause - (nullable) Optional exception.

dump - True to dump cause stack trace.

flush

public static void flush()

Flush any buffered output written to a file.

See Also:

DebugConsole.open, DebugConsole.append.

getCaptured

public static java.lang.String getCaptured()

Return captured debug console output.

See Also:

DebugConsole.startCapture, DebugConsole.stopCapture.

Returns:

Captured debug console output.

info

public static void info(java.lang.String message)

See info(String, RuntimeException, boolean).

info

public static void info(java.lang.String message,
                        java.lang.RuntimeException cause)

See info(String, RuntimeException, boolean).

info

public static void info(java.lang.String message,
                        java.lang.RuntimeException cause,
                        boolean dump)

Log an INFO message to the debug console.

Parameters:

message - Message text.

cause - (nullable) Optional exception.

dump - True to dump cause stack trace.

log

public static void log(java.lang.String message)

See log(String, RuntimeException, boolean).

log

public static void log(java.lang.String message,
                       java.lang.RuntimeException cause)

See log(String, RuntimeException, boolean).

log

public static void log(java.lang.String message,
                       java.lang.RuntimeException cause,
                       boolean dump)

Log a DEBUG message to the debug console.

Parameters:

message - Message text.

cause - (nullable) Optional exception.

dump - True to dump cause stack trace.

mainException

public static void mainException(java.lang.RuntimeException cause)

For internal use only.

open

public static void open(java.lang.String file)

Start copying debug console output to file (create mode).

Parameters:

file - File for captured debug console output (recreated if it does exist already).

startCapture

public static void startCapture()

Start capturing debug console output to an internal buffer.

stopCapture

public static void stopCapture()

Stop capturing debug console output to an internal buffer.

trace

public static void trace(java.lang.String message)

See trace(String, RuntimeException, boolean).

trace

public static void trace(java.lang.String message,
                         java.lang.RuntimeException cause)

See trace(String, RuntimeException, boolean).

trace

public static void trace(java.lang.String message,
                         java.lang.RuntimeException cause,
                         boolean dump)

Log a TRACE message to the debug console.

Parameters:

message - Message text.

cause - (nullable) Optional exception.

dump - True to dump cause stack trace.

traceEx

public static void traceEx(java.lang.RuntimeException cause)

Trace an exception to the debug console.

Parameters:

cause - Exception traced.

traceIn

public static void traceIn(java.lang.String method)

Trace a function entry to the debug console.

Parameters:

method - Function name.

traceOut

public static void traceOut(java.lang.String method)

Trace a function exit to the debug console.

Parameters:

method - Function name.

warn

public static void warn(java.lang.String message)

See warn(String, RuntimeException, boolean).

warn

public static void warn(java.lang.String message,
                        java.lang.RuntimeException cause)

See warn(String, RuntimeException, boolean).

warn

public static void warn(java.lang.String message,
                        java.lang.RuntimeException cause,
                        boolean dump)

Log a WARN message to the debug console.

Parameters:

message - Message text.

cause - (nullable) Optional exception.

dump - True to dump cause stack trace.