Class Session
- java.lang.Object
-
- com.gurock.smartinspect.session.Session
-
public class Session extends Object
Logs all kind of data and variables to the SmartInspect Console or to a log file.The Session class offers dozens of useful methods for sending any kind of data with the assistance of its parent. Sessions can send simple messages, warnings, errors and more complex things like pictures, objects, exceptions, system information and much more. They are even able to send variable watches, generate illustrated process and thread information or control the behavior of the SmartInspect Console. It is possible, for example, to clear the entire log in the Console by calling the clearLog method.
Please note that log methods of this class do nothing and return immediately if the session is currently inactive its parent is disabled or the log level is not sufficient.
This class is fully threadsafe.
-
-
Field Summary
Fields Modifier and Type Field Description static ColorDEFAULT_COLOR
-
Constructor Summary
Constructors Constructor Description Session(SmartInspect parent, String name)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaddCheckpoint()Overloaded.voidaddCheckpoint(Level level)Overloaded.voidaddCheckpoint(Level level, String name)Overloaded.voidaddCheckpoint(Level level, String name, String details)Overloaded function.voidaddCheckpoint(String name)Overloaded.voidaddCheckpoint(String name, String details)Increments the counter of a named checkpoint and logs a message with the default log level and an optional message.voidclearAll()Resets the whole Console.voidclearAutoViews()Clears all AutoViews in the Console.voidclearLog()Clears all Log Entries in the Console.voidclearProcessFlow()Clears all Process Flow entries in the Console.voidclearWatches()Clears all Watches in the Console.voiddecCounter(Level level, String name)Overloaded.voiddecCounter(String name)Overloaded.voidenterMethod(Level level, Object instance, String methodName)Overloaded.voidenterMethod(Level level, Object instance, String methodNameFmt, Object[] args)Overloaded.voidenterMethod(Level level, String methodName)Overloaded.voidenterMethod(Level level, String methodNameFmt, Object[] args)Overloaded.voidenterMethod(Object instance, String methodName)An overloaded method that enters a method using the default log level.voidenterMethod(Object instance, String methodNameFmt, Object[] args)Overloaded.voidenterMethod(String methodName)Overloaded.voidenterMethod(String methodNameFmt, Object[] args)Overloaded.voidenterProcess()Overloaded.voidenterProcess(Level level)Overloaded.voidenterProcess(Level level, String processName)Enters a new process by using a custom log level.voidenterProcess(Level level, String processNameFmt, Object[] args)Overloaded.voidenterProcess(String processName)Overloaded.voidenterProcess(String processNameFmt, Object[] args)Overloaded.voidenterThread(Level level, String threadName)Overloaded.voidenterThread(Level level, String threadNameFmt, Object[] args)Overloaded.voidenterThread(String threadName)Overloaded method.voidenterThread(String threadNameFmt, Object[] args)Overloaded.ColorgetColor()Returns the background color in the SmartInspect Console of this session.LevelgetLevel()Returns the log level of this Session object.StringgetName()Returns the session name used for Log Entries.SmartInspectgetParent()Returns the parent of the session.voidincCounter(Level level, String name)Overloaded.voidincCounter(String name)Overloaded.booleanisActive()Indicates if this session is currently active or not.booleanisOn()Overloaded.booleanisOn(Level level)Overloaded.protected booleanisStored()Returns if this session is stored in the session tracking list of its Parent.voidleaveMethod(Level level, Object instance, String methodName)Overloaded.voidleaveMethod(Level level, Object instance, String methodNameFmt, Object[] args)Overloaded.voidleaveMethod(Level level, String methodName)Overloaded.voidleaveMethod(Level level, String methodNameFmt, Object[] args)Overloaded.voidleaveMethod(Object instance, String methodName)Overloaded.voidleaveMethod(Object instance, String methodNameFmt, Object[] args)Overloaded.voidleaveMethod(String methodName)Overloaded.voidleaveMethod(String methodNameFmt, Object[] args)Overloaded.voidleaveProcess()Overloaded.voidleaveProcess(Level level)Overloaded.voidleaveProcess(Level level, String processName)Overloaded.voidleaveProcess(Level level, String processNameFmt, Object[] args)Overloaded.voidleaveProcess(String processName)Overloaded.voidleaveProcess(String processNameFmt, Object[] args)Overloaded.voidleaveThread(Level level, String threadName)Overloaded.voidleaveThread(Level level, String threadNameFmt, Object[] args)Leaves a thread by using a custom log level.voidleaveThread(String threadName)Overloaded.voidleaveThread(String threadNameFmt, Object[] args)Overloaded method.voidlogArray(Level level, String title, Object[] array)Overloaded.voidlogArray(String title, Object[] array)Overloaded.voidlogAssert(boolean condition, String title)Overloaded.voidlogAssert(boolean condition, String titleFmt, Object[] args)Overloaded.voidlogAssigned(Level level, String title, Object instance)Overloaded.voidlogAssigned(String title, Object instance)Overloaded.voidlogBinary(Level level, String title, byte[] b)Overloaded.voidlogBinary(Level level, String title, byte[] b, int off, int len)Overloaded.voidlogBinary(String title, byte[] b)Overloaded.voidlogBinary(String title, byte[] b, int off, int len)Logs a byte array with the default log level and displays it in a hex viewer.voidlogBinaryFile(Level level, String fileName)Overloaded.voidlogBinaryFile(Level level, String title, String fileName)Overloaded.voidlogBinaryFile(String fileName)Overloaded.voidlogBinaryFile(String title, String fileName)Logs a binary file and displays its content in a hex viewer using a custom title and default log level.voidlogBinaryStream(Level level, String title, InputStream stream)Overloaded.voidlogBinaryStream(String title, InputStream stream)Overloaded.voidlogBitmapFile(Level level, String fileName)Logs a bitmap file with a custom log level and displays it in the Console.voidlogBitmapFile(Level level, String title, String fileName)Overloaded.voidlogBitmapFile(String fileName)Logs a bitmap file with the default log level and displays it in the Console.voidlogBitmapFile(String title, String fileName)Overloaded.voidlogBitmapStream(Level level, String title, InputStream stream)Overloaded.voidlogBitmapStream(String title, InputStream stream)Logs a stream with the default log level and interprets its content as a bitmap.voidlogBoolean(Level level, String name, boolean value)Overloaded.voidlogBoolean(String name, boolean value)Logs a boolean value with the default log level.voidlogByte(Level level, String name, byte value)Overloaded.voidlogByte(Level level, String name, byte value, boolean includeHex)This method logs the name and value of a byte variable.voidlogByte(String name, byte value)Overloaded.voidlogByte(String name, byte value, boolean includeHex)Overloaded.voidlogChar(Level level, String name, char value)Overloaded.voidlogChar(String name, char value)Overloaded method.voidlogCollection(Level level, String title, Collection c)Overloaded.voidlogCollection(String title, Collection c)Overloaded.voidlogColored(Level level, Color color, String title)Overloaded.voidlogColored(Level level, Color color, String titleFmt, Object[] args)Overloaded method that logs a colored message with a custom log level.voidlogColored(Color color, String title)Overloaded.voidlogColored(Color color, String titleFmt, Object[] args)Logs a colored message with the default log level.voidlogConditional(boolean condition, String title)Logs a conditional message with the default log level.voidlogConditional(boolean condition, String titleFmt, Object[] args)Overloaded.voidlogConditional(Level level, boolean condition, String title)Logs a conditional message with a custom log level.voidlogConditional(Level level, boolean condition, String titleFmt, Object[] args)Logs a conditional message with a custom log level.voidlogCurrentStackTrace()Overloaded.voidlogCurrentStackTrace(Level level)Overloaded.voidlogCurrentStackTrace(Level level, String title)Overloaded.voidlogCurrentStackTrace(String title)Overloaded.voidlogCurrentThread()Overloaded.voidlogCurrentThread(Level level)Logs information about the current thread with a custom log level.voidlogCurrentThread(Level level, String title)Overloaded method that logs information about the current thread using a custom title and a custom log level.voidlogCurrentThread(String title)Logs information about the current thread using a custom title and the default log level.voidlogCustomContext(Level level, String title, LogEntryType lt, ViewerContext ctx)Overloaded.voidlogCustomContext(String title, LogEntryType lt, ViewerContext ctx)Overloaded.voidlogCustomFile(Level level, String fileName, LogEntryType lt, ViewerId vi)Overloaded.voidlogCustomFile(Level level, String title, String fileName, LogEntryType lt, ViewerId vi)Overloaded.voidlogCustomFile(String fileName, LogEntryType lt, ViewerId vi)Overloaded.voidlogCustomFile(String title, String fileName, LogEntryType lt, ViewerId vi)Overloaded.voidlogCustomReader(Level level, String title, Reader reader, LogEntryType lt, ViewerId vi)Overloaded.voidlogCustomReader(String title, Reader reader, LogEntryType lt, ViewerId vi)Logs the content of a reader using a custom Log Entry type, viewer ID and default log level.voidlogCustomStream(Level level, String title, InputStream stream, LogEntryType lt, ViewerId vi)Overloaded.voidlogCustomStream(String title, InputStream stream, LogEntryType lt, ViewerId vi)Logs the content of a stream using a custom Log Entry type, viewer ID and default log level.voidlogCustomText(Level level, String title, String text, LogEntryType lt, ViewerId vi)Logs a text using a custom Log Entry type, viewer ID and custom log level.voidlogCustomText(String title, String text, LogEntryType lt, ViewerId vi)Overloaded.voidlogDate(Level level, String name, Date value)Overloaded.voidlogDate(String name, Date value)Overloaded.voidlogDebug(String title)Overloaded.voidlogDebug(String titleFmt, Object[] args)Overloaded.voidlogDouble(Level level, String name, double value)Overloaded.voidlogDouble(String name, double value)Overloaded.voidlogError(String title)Overloaded.voidlogError(String titleFmt, Object[] args)Logs an error message with a log level of Level.Error.voidlogException(String title, Throwable t)Overloaded.voidlogException(Throwable t)Logs the content of an exception with a log level of Level.Error.voidlogFatal(String title)Overloaded method to log a fatal error message with a log level of Level.Fatal.voidlogFatal(String titleFmt, Object[] args)Overloaded.voidlogFloat(Level level, String name, float value)Overloaded.voidlogFloat(String name, float value)Overloaded.voidlogHtml(Level level, String title, String html)Overloaded.voidlogHtml(String title, String html)Overloaded.voidlogHtmlFile(Level level, String fileName)Overloaded.voidlogHtmlFile(Level level, String title, String fileName)Overloaded.voidlogHtmlFile(String fileName)Overloaded.voidlogHtmlFile(String title, String fileName)Overloaded.voidlogHtmlReader(Level level, String title, Reader reader)Overloaded.voidlogHtmlReader(String title, Reader reader)Overloaded.voidlogHtmlStream(Level level, String title, InputStream stream)Overloaded.voidlogHtmlStream(String title, InputStream stream)Overloaded.voidlogIconFile(Level level, String fileName)Overloaded.voidlogIconFile(Level level, String title, String fileName)Overloaded.voidlogIconFile(String fileName)Overloaded.voidlogIconFile(String title, String fileName)Overloaded.voidlogIconStream(Level level, String title, InputStream stream)Logs a stream with a custom log level and interprets its content as Windows icon.voidlogIconStream(String title, InputStream stream)Overloaded.voidlogInt(Level level, String name, int value)Overloaded.voidlogInt(Level level, String name, int value, boolean includeHex)Overloaded.voidlogInt(String name, int value)Overloaded.voidlogInt(String name, int value, boolean includeHex)Logs an integer value with an optional hexadecimal representation and default log level.protected voidlogInternalError(String title)Logs an internal error with a log level of Level.Error.protected voidlogInternalError(String titleFmt, Object[] args)Overloaded.voidlogJpegFile(Level level, String fileName)Overloaded.voidlogJpegFile(Level level, String title, String fileName)Overloaded.voidlogJpegFile(String fileName)Overloaded.voidlogJpegFile(String title, String fileName)Overloaded.voidlogJpegStream(Level level, String title, InputStream stream)Overloaded.voidlogJpegStream(String title, InputStream stream)Overloaded.voidlogLong(Level level, String name, long value)Overloaded.voidlogLong(Level level, String name, long value, boolean includeHex)Overloaded.voidlogLong(String name, long value)Logs a long integer value with the default log level.voidlogLong(String name, long value, boolean includeHex)Overloaded.voidlogMap(Level level, String title, Map map)Logs the content of a map with a custom log level.voidlogMap(String title, Map map)Overloaded.voidlogMemoryStatistic()Overloaded.voidlogMemoryStatistic(Level level)Overloaded.voidlogMemoryStatistic(Level level, String title)Overloaded.voidlogMemoryStatistic(String title)Logs memory statistics about the virtual machine using a custom title and default log level.voidlogMessage(String title)Overloaded.voidlogMessage(String titleFmt, Object[] args)Overloaded.voidlogMetafileFile(Level level, String fileName)Overloaded.voidlogMetafileFile(Level level, String title, String fileName)Overloaded.voidlogMetafileFile(String fileName)Overloaded.voidlogMetafileFile(String title, String fileName)Logs a Windows Metafile file and displays it in the console using a custom title and default log level.voidlogMetafileStream(Level level, String title, InputStream stream)Overloaded.voidlogMetafileStream(String title, InputStream stream)Overloaded.voidlogObject(Level level, String title, Object instance)Overloaded.voidlogObject(Level level, String title, Object instance, boolean nonPublic)Overloaded.voidlogObject(String title, Object instance)Overloaded.voidlogObject(String title, Object instance, boolean nonPublic)Overloaded method that logs fields of an object with the default log level.voidlogObjectValue(Level level, String name, Object value)Overloaded.voidlogObjectValue(String name, Object value)Overloaded.voidlogReader(Level level, String title, Reader reader)Overloaded.voidlogReader(String title, Reader reader)Overloaded.voidlogResultSet(Level level, String title, ResultSet rset)Overloaded method that logs the content of a ResultSet with a custom log level.voidlogResultSet(String title, ResultSet rset)Logs the content of a ResultSet with the default log level.voidlogResultSetMetaData(Level level, String title, ResultSet rset)Overloaded.voidlogResultSetMetaData(Level level, String title, ResultSetMetaData rmeta)Overloaded.voidlogResultSetMetaData(String title, ResultSet rset)Overloaded.voidlogResultSetMetaData(String title, ResultSetMetaData rmeta)Overloaded method that logs the metadata of a ResultSet with the default log level.voidlogSeparator()Overloaded.voidlogSeparator(Level level)Overloaded.voidlogShort(Level level, String name, short value)Overloaded.voidlogShort(Level level, String name, short value, boolean includeHex)Overloaded.voidlogShort(String name, short value)Overloaded.voidlogShort(String name, short value, boolean includeHex)Overloaded.voidlogSource(Level level, String title, String source, SourceId id)Overloaded method, logs source code that is displayed with syntax highlighting in the Console using a custom log level.voidlogSource(String title, String source, SourceId id)Overloaded.voidlogSourceFile(Level level, String fileName, SourceId id)Overloaded.voidlogSourceFile(Level level, String title, String fileName, SourceId id)Overloaded.voidlogSourceFile(String fileName, SourceId id)Overloaded.voidlogSourceFile(String title, String fileName, SourceId id)Overloaded.voidlogSourceReader(Level level, String title, Reader reader, SourceId id)Overloaded.voidlogSourceReader(String title, Reader reader, SourceId id)Overloaded.voidlogSourceStream(Level level, String title, InputStream stream, SourceId id)Overloaded.voidlogSourceStream(String title, InputStream stream, SourceId id)Overloaded.voidlogSql(Level level, String title, String source)Overloaded.voidlogSql(String title, String source)Overloaded.voidlogStream(Level level, String title, InputStream stream)Overloaded.voidlogStream(String title, InputStream stream)Logs the content of a binary stream with the default log level.voidlogString(Level level, String name, String value)Overloaded.voidlogString(String name, String value)Overloaded.voidlogStringBuffer(Level level, String title, StringBuffer sb)Overloaded.voidlogStringBuffer(String title, StringBuffer sb)Overloaded method, logs the content of a StringBuffer instance with the default log level.voidlogSystem()Logs information about the system with the default log level.voidlogSystem(Level level)Logs information about the system with a custom log level.voidlogSystem(Level level, String title)Overloaded.voidlogSystem(String title)Overloaded.voidlogText(Level level, String title, String text)Overloaded.voidlogText(String title, String text)Logs a string with the default log level and displays it in a read-only text field.voidlogTextFile(Level level, String fileName)Overloaded.voidlogTextFile(Level level, String title, String fileName)Overloaded.voidlogTextFile(String fileName)Overloaded.voidlogTextFile(String title, String fileName)Overloaded.voidlogTextReader(Level level, String title, Reader reader)Overloaded.voidlogTextReader(String title, Reader reader)Overloaded method.voidlogTextStream(Level level, String title, InputStream stream)Logs a stream with a custom log level and displays the content in a read-only text field.voidlogTextStream(String title, InputStream stream)Overloaded.voidlogThread(Level level, String title, Thread thread)Overloaded.voidlogThread(String title, Thread thread)This method logs information about the supplied thread.voidlogValue(Level level, String name, boolean value)Overloaded.voidlogValue(Level level, String name, byte value)Overloaded.voidlogValue(Level level, String name, char value)Logs the name and value of a char variable with a custom log level.voidlogValue(Level level, String name, double value)Overloaded.voidlogValue(Level level, String name, float value)Overloaded.voidlogValue(Level level, String name, int value)Overloaded.voidlogValue(Level level, String name, long value)Overloaded.voidlogValue(Level level, String name, short value)Overloaded.voidlogValue(Level level, String name, Object value)Logs the name and value of an object with a custom log level.voidlogValue(Level level, String name, String value)Overloaded method that logs the name and value of a string variable with a custom log level.voidlogValue(Level level, String name, Date value)Overloaded.voidlogValue(String name, boolean value)Overloaded.voidlogValue(String name, byte value)Overloaded.voidlogValue(String name, char value)Overloaded.voidlogValue(String name, double value)Overloaded.voidlogValue(String name, float value)Logs the name and value of a float variable with the default log level.voidlogValue(String name, int value)Logs the name and value of an integer variable with the default log level.voidlogValue(String name, long value)Overloaded.voidlogValue(String name, short value)Overloaded.voidlogValue(String name, Object value)Overloaded.voidlogValue(String name, String value)Logs the name and value of a string variable with the default log level.voidlogValue(String name, Date value)Overloaded.voidlogVerbose(String title)Overloaded method.voidlogVerbose(String titleFmt, Object[] args)Overloaded.voidlogWarning(String title)Overloaded.voidlogWarning(String titleFmt, Object[] args)Overloaded.voidresetCallstack()Resets the call stack by using the default log level.voidresetCallstack(Level level)Overloaded.voidresetCheckpoint()Overloaded.voidresetCheckpoint(String name)Overloaded.voidresetColor()Resets the session color to its default value.voidresetCounter(String name)Resets a named counter to its initial value of 0.voidsendCustomControlCommand(Level level, ControlCommandType ct, byte[] data)Overloaded.voidsendCustomControlCommand(ControlCommandType ct, byte[] data)Overloaded.voidsendCustomLogEntry(Level level, String title, LogEntryType lt, ViewerId vi, byte[] data)Overloaded.voidsendCustomLogEntry(String title, LogEntryType lt, ViewerId vi, byte[] data)Overloaded.voidsendCustomProcessFlow(Level level, String title, ProcessFlowType pt)Overloaded.voidsendCustomProcessFlow(String title, ProcessFlowType pt)Overloaded.voidsendCustomWatch(Level level, String name, String value, WatchType wt)Overloaded method.voidsendCustomWatch(String name, String value, WatchType wt)Overloaded.voidsetActive(boolean active)Specifies if the session is currently active.voidsetColor(Color color)Sets the background color in the SmartInspect Console of this session.voidsetLevel(Level level)Sets the log level of this Session object.voidsetName(String name)Sets the session name used for Log Entries.protected voidsetStored(boolean stored)Indicates if this session is stored in the session tracking list of its Parent.voidwatch(Level level, String name, boolean value)Overloaded.voidwatch(Level level, String name, byte value)Overloaded.voidwatch(Level level, String name, char value)Overloaded.voidwatch(Level level, String name, double value)Logs a double Watch with a custom log level.voidwatch(Level level, String name, float value)Overloaded.voidwatch(Level level, String name, int value)Overloaded.voidwatch(Level level, String name, long value)Overloaded.voidwatch(Level level, String name, short value)Overloaded.voidwatch(Level level, String name, Object value)Overloaded.voidwatch(Level level, String name, String value)Overloaded.voidwatch(Level level, String name, Date value)Overloaded.voidwatch(String name, boolean value)Overloaded.voidwatch(String name, byte value)This method just calls the watchByte method.voidwatch(String name, char value)Overloaded.voidwatch(String name, double value)Overloaded.voidwatch(String name, float value)Overloaded.voidwatch(String name, int value)Overloaded method that logs an integer Watch with the default log level.voidwatch(String name, long value)Overloaded.voidwatch(String name, short value)Overloaded.voidwatch(String name, Object value)Overloaded.voidwatch(String name, String value)Overloaded.voidwatch(String name, Date value)Overloaded.voidwatchBoolean(Level level, String name, boolean value)Overloaded.voidwatchBoolean(String name, boolean value)Logs a boolean Watch with the default log level.voidwatchByte(Level level, String name, byte value)Overloaded.voidwatchByte(Level level, String name, byte value, boolean includeHex)Overloaded.voidwatchByte(String name, byte value)Overloaded.voidwatchByte(String name, byte value, boolean includeHex)Overloaded.voidwatchChar(Level level, String name, char value)Overloaded.voidwatchChar(String name, char value)Logs a char Watch with the default log level.voidwatchDate(Level level, String name, Date value)Overloaded.voidwatchDate(String name, Date value)Overloaded.voidwatchDouble(Level level, String name, double value)Logs a double Watch with a custom log level.voidwatchDouble(String name, double value)Logs a double Watch with the default log level.voidwatchFloat(Level level, String name, float value)Overloaded.voidwatchFloat(String name, float value)Overloaded.voidwatchInt(Level level, String name, int value)Overloaded.voidwatchInt(Level level, String name, int value, boolean includeHex)Logs an integer Watch with an optional hexadecimal representation and custom log level.voidwatchInt(String name, int value)Overloaded method.voidwatchInt(String name, int value, boolean includeHex)Overloaded.voidwatchLong(Level level, String name, long value)Overloaded.voidwatchLong(Level level, String name, long value, boolean includeHex)Overloaded.voidwatchLong(String name, long value)Overloaded.voidwatchLong(String name, long value, boolean includeHex)Overloaded method.voidwatchObject(Level level, String name, Object value)Overloaded.voidwatchObject(String name, Object value)Overloaded.voidwatchShort(Level level, String name, short value)Overloaded.voidwatchShort(Level level, String name, short value, boolean includeHex)Overloaded.voidwatchShort(String name, short value)Overloaded.voidwatchShort(String name, short value, boolean includeHex)Overloaded.voidwatchString(Level level, String name, String value)Overloaded.voidwatchString(String name, String value)Overloaded.
-
-
-
Field Detail
-
DEFAULT_COLOR
public static final Color DEFAULT_COLOR
-
-
Constructor Detail
-
Session
public Session(SmartInspect parent, String name)
-
-
Method Detail
-
isStored
protected boolean isStored()
Returns if this session is stored in the session tracking list of its Parent.See the SmartInspect.getSession and SmartInspect.addSession methods for more information about session tracking.
- Returns:
- True if this session is stored in the session tracking list and false otherwise
-
setStored
protected void setStored(boolean stored)
Indicates if this session is stored in the session tracking list of its Parent. See the SmartInspect.getSession and SmartInspect.addSession methods for more information about session tracking.- Parameters:
stored- True if this session is stored in the session tracking list and false otherwise
-
setName
public void setName(String name)
Sets the session name used for Log Entries. The session name helps you to identify Log Entries from different sessions in the SmartInspect Console. If you set the session name to null, the session name will be empty when sending Log Entries.- Parameters:
name- The new session name
-
getName
public String getName()
Returns the session name used for Log Entries. The session name helps you to identify Log Entries from different sessions in the SmartInspect Console.- Returns:
- The session name used for Log Entries.
-
setActive
public void setActive(boolean active)
Specifies if the session is currently active. If false is passed to this method, all logging methods of this class will return immediately and do nothing. Please note that the parent of this session also needs to be enabled in order to log information. This method is especially useful if you are using multiple sessions at once and want to deactivate a subset of these sessions. To deactivate all your sessions, you can use the setEnabled method of the parent.- Parameters:
active- A boolean value to activate or deactivate this instance
-
isActive
public boolean isActive()
Indicates if this session is currently active or not.- Returns:
- True if this session is currently active and false otherwise.
-
getLevel
public Level getLevel()
Returns the log level of this Session object.Each Session object can have its own log level. A log message is only logged if its log level is greater than or equal to the log level of a session and the session's parent. Log levels can thus be used to limit the logging output to important messages only.
- Returns:
- The log level of this session
-
setLevel
public void setLevel(Level level)
Sets the log level of this Session object. Each Session object can have its own log level. A log message is only logged if its log level is greater than or equal to the log level of a session and the sessiongetParent(). Log levels can thus be used to limit the logging output to important messages only.This method does nothing if the level parameter is null.
- Parameters:
level- The new log level for this session.
-
isOn
public boolean isOn(Level level)
Overloaded. Indicates if information can be logged for a certain log level or not.This method is used by the logging methods in this class to determine if information should be logged or not. When extending the Session class by adding new log methods to a derived class, it is recommended to call this method first. This method returns false if the supplied level argument is null.
- Parameters:
level- The log level to check for- Returns:
- True if information can be logged and false otherwise
-
isOn
public boolean isOn()
Overloaded. Indicates if information can be logged or not.This method is used by the logging methods in this class to determine if information should be logged or not. When extending the Session class by adding new log methods to a derived class it is recommended to call this method first.
- Returns:
- True if information can be logged and false otherwise
-
getParent
public SmartInspect getParent()
Returns the parent of the session.The parent of a session is a SmartInspect instance. It is responsible for sending the packets to the SmartInspect Console or for writing them to a file. If the parent is not
SmartInspect.setEnabled(boolean), enabled, all logging methods of this class will return immediately and do nothing.- Returns:
- The parent of this session
-
setColor
public void setColor(Color color)
Sets the background color in the SmartInspect Console of this session. The session color helps you to identify Log Entries from different sessions in the SmartInspect Console by changing the background color. Please note that if you pass a null reference, then the color will not be changed.- Parameters:
color- The new background color
-
getColor
public Color getColor()
Returns the background color in the SmartInspect Console of this session.The session color helps you to identify Log Entries from different sessions in the SmartInspect Console by changing the background color.
- Returns:
- The background color in the SmartInspect Console of this session
-
resetColor
public void resetColor()
Resets the session color to its default value.The default color of a session is transparent.
-
logSeparator
public void logSeparator()
Overloaded. Logs a simple separator with the default log level. This method instructs the Console to draw a separator. A separator is intended to group related Log Entries and to separate them visually from others. This method can help organizing Log Entries in the Console. See addCheckpoint for a method with a similar intention.This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.
- See Also:
addCheckpoint()
-
logSeparator
public void logSeparator(Level level)
Overloaded. Logs a simple separator with a custom log level. This method instructs the Console to draw a separator. A separator is intended to group related Log Entries and to separate them visually from others. This method can help organizing Log Entries in the Console. SeeaddCheckpoint()for a method with a similar intention.- Parameters:
level- The log level of this method call- See Also:
addCheckpoint()
-
resetCallstack
public void resetCallstack()
Resets the call stack by using the default log level.This method instructs the Console to reset the call stack generated by the EnterMethod and LeaveMethod methods. It is especially useful if you want to reset the indentation in the method hierarchy without clearing all Log Entries.
This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.
-
resetCallstack
public void resetCallstack(Level level)
Overloaded. Resets the call stack by using a custom log level. This method instructs the Console to reset the call stack generated by the EnterMethod and LeaveMethod methods. It is especially useful if you want to reset the indentation in the method hierarchy without clearing all Log Entries.- Parameters:
level- The log level of this method call
-
enterMethod
public void enterMethod(String methodName)
Overloaded. Enters a method by using the default log level. The enterMethod method notifies the Console that a new method has been entered. The Console includes the method in the method hierarchy. If this method is used consequently, a full call stack is visible in the Console which helps to locate bugs in the source code. Please see the leaveMethod method as the counter piece to enterMethod.This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.
- Parameters:
methodName- The name of the method
-
enterMethod
public void enterMethod(Level level, String methodName)
Overloaded. Enters a method by using a custom log level. The enterMethod method notifies the Console that a new method has been entered. The Console includes the method in the method hierarchy. If this method is used consequently, a full call stack is visible in the Console which helps to locate bugs in the source code. Please see the leaveMethod method as the counter piece to enterMethod.- Parameters:
level- The log level of this method callmethodName- The name of the method
-
enterMethod
public void enterMethod(String methodNameFmt, Object[] args)
Overloaded. Enters a method by using the default log level. The method name consists of a format string and the related array of arguments.The enterMethod method notifies the Console that a new method has been entered. The Console includes the method in the method hierarchy. If this method is used consequently, a full call stack is visible in the Console which helps to locate bugs in the source code. Please see the leaveMethod method as the counter piece to enterMethod.
The resulting method name consists of a format string and the related array of arguments.
This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.
- Parameters:
methodNameFmt- The format string to create the name of the methodargs- The array of arguments for the format string
-
enterMethod
public void enterMethod(Level level, String methodNameFmt, Object[] args)
Overloaded. Enters a method by using a custom log level. The method name consists of a format string and the related array of arguments.The enterMethod method notifies the Console that a new method has been entered. The Console includes the method in the method hierarchy. If this method is used consequently, a full call stack is visible in the Console which helps to locate bugs in the source code. Please see the leaveMethod method as the counter piece to enterMethod.
The resulting method name consists of a format string and the related array of arguments.
- Parameters:
level- The log level of this method callmethodNameFmt- The format string to create the name of the methodargs- The array of arguments for the format string
-
enterMethod
public void enterMethod(Object instance, String methodName)
An overloaded method that enters a method using the default log level. The resulting method name consists of the class name of the supplied instance parameter, followed by a dot and the supplied methodName argument.The enterMethod method notifies the Console that a new method has been entered. The Console includes the method in the method hierarchy. If this method is used consequently, a full call stack is visible in the Console which helps to locate bugs in the source code. Please see the leaveMethod method as the counter piece to enterMethod.
The resulting method name consists of the class name of the supplied instance parameter, followed by a dot and the supplied methodName argument.
This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.
- Parameters:
methodName- The name of the methodinstance- The class name of this instance and a dot will be prepended to the method name
-
enterMethod
public void enterMethod(Level level, Object instance, String methodName)
Overloaded. Enters a method by using a custom log level. The resulting method name consists of the class name of the supplied instance parameter, followed by a dot and the supplied methodName argument.The enterMethod method notifies the Console that a new method has been entered. The Console includes the method in the method hierarchy. If this method is used consequently, a full call stack is visible in the Console which helps to locate bugs in the source code. Please see the leaveMethod method as the counter piece to enterMethod.
The resulting method name consists of the class name of the supplied instance parameter, followed by a dot and the supplied methodName argument.
- Parameters:
level- The log level of this method callmethodName- The name of the methodinstance- The class name of this instance and a dot will be prepended to the method name
-
enterMethod
public void enterMethod(Object instance, String methodNameFmt, Object[] args)
Overloaded. Enters a method by using the default log level. The resulting method name consists of the class name of the supplied instance parameter, followed by a dot and the supplied format string and its related array of arguments.The enterMethod method notifies the Console that a new method has been entered. The Console includes the method in the method hierarchy. If this method is used consequently, a full call stack is visible in the Console which helps to locate bugs in the source code. Please see the leaveMethod method as the counter piece to enterMethod.
The resulting method name consists of the class name of the supplied instance parameter, followed by a dot and the supplied format string and its related array of arguments.
This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.
- Parameters:
instance- The class name of this instance and a dot will be prepended to the method namemethodNameFmt- The format string to create the name of the methodargs- The array of arguments for the format string
-
enterMethod
public void enterMethod(Level level, Object instance, String methodNameFmt, Object[] args)
Overloaded. Enters a method by using a custom log level. The resulting method name consists of the class name of the supplied instance parameter, followed by a dot and the supplied format string and its related array of arguments.The enterMethod method notifies the Console that a new method has been entered. The Console includes the method in the method hierarchy. If this method is used consequently, a full call stack is visible in the Console which helps to locate bugs in the source code. Please see the leaveMethod method as the counter piece to enterMethod.
The resulting method name consists of the class name of the supplied instance parameter, followed by a dot and the supplied format string and its related array of arguments.
- Parameters:
level- The log level of this method callinstance- The class name of this instance and a dot will be prepended to the method namemethodNameFmt- The format string to create the name of the methodargs- The array of arguments for the format string
-
leaveMethod
public void leaveMethod(String methodName)
Overloaded. Leaves a method by using the default log level.The leaveMethod method notifies the Console that a method has been left. The Console closes the current method in the method hierarchy. If this method is used consequently, a full call stack is visible in the Console which helps to locate bugs in the source code. Please see the enterMethod method as the counter piece to leaveMethod.
This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.
- Parameters:
methodName- The name of the method
-
leaveMethod
public void leaveMethod(Level level, String methodName)
Overloaded. Leaves a method by using a custom log level.The leaveMethod method notifies the Console that a method has been left. The Console closes the current method in the method hierarchy. If this method is used consequently, a full call stack is visible in the Console which helps to locate bugs in the source code. Please see the enterMethod method as the counter piece to leaveMethod.
- Parameters:
level- The log level of this method callmethodName- The name of the method
-
leaveMethod
public void leaveMethod(String methodNameFmt, Object[] args)
Overloaded. Leaves a method by using the default log level. The method name consists of a format string and its related array of arguments.The leaveMethod method notifies the Console that a method has been left. The Console closes the current method in the method hierarchy. If this method is used consequently, a full call stack is visible in the Console which helps to locate bugs in the source code. Please see the enterMethod method as the counter piece to leaveMethod.
The resulting method name consists of a format string and the related array of arguments.
This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.
- Parameters:
methodNameFmt- The format string to create the name of the methodargs- The array of arguments for the format string
-
leaveMethod
public void leaveMethod(Level level, String methodNameFmt, Object[] args)
Overloaded. Leaves a method by using a custom log level. The method name consists of a format string and its related array of arguments.The leaveMethod method notifies the Console that a method has been left. The Console closes the current method in the method hierarchy. If this method is used consequently, a full call stack is visible in the Console which helps to locate bugs in the source code. Please see the enterMethod method as the counterpart to leaveMethod.
The resulting method name consists of a format string and the related array of arguments.
- Parameters:
level- The log level of this method callmethodNameFmt- The format string to create the name of the methodargs- The array of arguments for the format string
-
leaveMethod
public void leaveMethod(Object instance, String methodName)
Overloaded. Leaves a method by using the default log level. The resulting method name consists of the class name of the supplied instance parameter, followed by a dot and the supplied methodName argument.The leaveMethod method notifies the Console that a method has been left. The Console closes the current method in the method hierarchy. If this method is used consequently, a full call stack is visible in the Console which helps to locate bugs in the source code. Please see the enterMethod method as the counter piece to leaveMethod.
The resulting method name consists of the class name of the supplied instance parameter, followed by a dot and the supplied methodName argument.
This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.
- Parameters:
instance- The class name of this instance and a dot will be prepended to the method namemethodName- The name of the method
-
leaveMethod
public void leaveMethod(Level level, Object instance, String methodName)
Overloaded. Leaves a method by using a custom log level. The resulting method name consists of the class name of the supplied instance parameter, followed by a dot and the supplied methodName argument.The leaveMethod method notifies the Console that a method has been left. The Console closes the current method in the method hierarchy. If this method is used consequently, a full call stack is visible in the Console which helps to locate bugs in the source code. Please see the enterMethod method as the counter piece to leaveMethod.
The resulting method name consists of the class name of the supplied instance parameter, followed by a dot and the supplied methodName argument.
- Parameters:
level- The log level of this method callinstance- The class name of this instance and a dot will be prepended to the method namemethodName- The name of the method
-
leaveMethod
public void leaveMethod(Object instance, String methodNameFmt, Object[] args)
Overloaded. Leaves a method by using the default log level. The resulting method name consists of the class name of the supplied instance parameter, followed by a dot and the supplied format string and its related array of arguments.The leaveMethod method notifies the Console that a method has been left. The Console closes the current method in the method hierarchy. If this method is used consequently, a full call stack is visible in the Console which helps to locate bugs in the source code. Please see the enterMethod method as the counter piece to leaveMethod.
The resulting method name consists of the class name of the supplied instance parameter, followed by a dot and the supplied format string and its related array of arguments.
This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.
- Parameters:
instance- The class name of this instance and a dot will be prepended to the method namemethodNameFmt- The format string to create the name of the methodargs- The array of arguments for the format string
-
leaveMethod
public void leaveMethod(Level level, Object instance, String methodNameFmt, Object[] args)
Overloaded. Leaves a method by using a custom log level. The resulting method name consists of the class name of the supplied instance parameter, followed by a dot and the supplied format string and its related array of arguments.The leaveMethod method notifies the Console that a method has been left. The Console closes the current method in the method hierarchy. If this method is used consequently, a full call stack is visible in the Console which helps to locate bugs in the source code. Please see the enterMethod method as the counter piece to leaveMethod.
The resulting method name consists of the class name of the supplied instance parameter, followed by a dot and the supplied format string and its related array of arguments.
- Parameters:
level- The log level of this method callinstance- The class name of this instance and a dot will be prepended to the method namemethodNameFmt- The format string to create the name of the methodargs- The array of arguments for the format string
-
enterThread
public void enterThread(String threadName)
Overloaded method. Enters a new thread by using the default log level.The enterThread method notifies the Console that a new thread has been entered. The Console display this thread in the Process Flow toolbox. If this method is used consequently, all threads of a process are displayed. Please see the leaveThread method as the counter piece to enterThread.
This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.
- Parameters:
threadName- The name of the thread
-
enterThread
public void enterThread(Level level, String threadName)
Overloaded. Enters a new thread by using a custom log level.The enterThread method notifies the Console that a new thread has been entered. The Console display this thread in the Process Flow toolbox. If this method is used consequently, all threads of a process are displayed. Please see the leaveThread method as the counter piece to enterThread.
- Parameters:
level- The log level of this method callthreadName- The name of the thread
-
enterThread
public void enterThread(String threadNameFmt, Object[] args)
Overloaded. Enters a new thread by using the default log level. The thread name consists of a format string the related array of arguments.The enterThread method notifies the Console that a new thread has been entered. The Console display this thread in the Process Flow toolbox. If this method is used consequently, all threads of a process are displayed. Please see the leaveThread method as the counter piece to enterThread.
The resulting thread name consists of a format string and the related array of arguments.
This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.
- Parameters:
threadNameFmt- The format string to create the name of the threadargs- The array of arguments for the format string
-
enterThread
public void enterThread(Level level, String threadNameFmt, Object[] args)
Overloaded. Enters a new thread by using a custom log level. The thread name consists of a format string the related array of arguments.The enterThread method notifies the Console that a new thread has been entered. The Console display this thread in the Process Flow toolbox. If this method is used consequently, all threads of a process are displayed. Please see the leaveThread method as the counter piece to enterThread.
The resulting thread name consists of a format string and the related array of arguments.
- Parameters:
level- The log level of this method callthreadNameFmt- The format string to create the name of the threadargs- The array of arguments for the format string
-
leaveThread
public void leaveThread(String threadName)
Overloaded. Leaves a thread by using the default log level.The leaveThread method notifies the Console that a thread has been finished. The Console display this change in the Process Flow toolbox. Please see the enterThread method as the counter piece to leaveThread.
This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.
- Parameters:
threadName- The name of the thread
-
leaveThread
public void leaveThread(Level level, String threadName)
Overloaded. Leaves a thread by using a custom log level. The leaveThread method notifies the Console that a thread has been finished. The Console display this change in the Process Flow toolbox. Please see the enterThread method as the counter piece to leaveThread.- Parameters:
level- The log level of this method callthreadName- The name of the thread
-
leaveThread
public void leaveThread(String threadNameFmt, Object[] args)
Overloaded method. Leaves a thread using the default log level. The thread name consists of a format string and the related array of arguments.The leaveThread method notifies the Console that a thread has been finished. The Console displays this change in the Process Flow toolbox. Please see the enterThread method as the counterpart to leaveThread.
The resulting thread name consists of a format string and the related array of arguments.
This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.
- Parameters:
threadNameFmt- The format string to create the name of the threadargs- The array of arguments for the format string
-
leaveThread
public void leaveThread(Level level, String threadNameFmt, Object[] args)
Leaves a thread by using a custom log level. The thread name consists of a format string and the related array of arguments.The leaveThread method notifies the Console that a thread has been finished. The Console display this change in the Process Flow toolbox. Please see the enterThread method as the counter piece to leaveThread.
The resulting thread name consists of a format string and the related array of arguments.
- Parameters:
level- The log level of this method callthreadNameFmt- The format string to create the name of the threadargs- The array of arguments for the format string
-
enterProcess
public void enterProcess()
Overloaded. Enters a new process by using the default log level and the parent's application name as process name.The enterProcess method notifies the Console that a new process has been entered. The Console displays this process in the Process Flow toolbox. Please see the leaveProcess method as the counter piece to enterProcess.
This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.
-
enterProcess
public void enterProcess(Level level)
Overloaded. Enters a new process by using a custom log level and the parent's application name as process name. The enterProcess method notifies the Console that a new process has been entered. The Console displays this process in the Process Flow toolbox. Please see the leaveProcess method as the counter piece to enterProcess.- Parameters:
level- The log level of this method call
-
enterProcess
public void enterProcess(String processName)
Overloaded. Enters a new process by using the default log level.The enterProcess method notifies the Console that a new process has been entered. The Console displays this process in the Process Flow toolbox. Please see the leaveProcess method as the counter piece to enterProcess.
This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.
- Parameters:
processName- The name of the process
-
enterProcess
public void enterProcess(Level level, String processName)
Enters a new process by using a custom log level. The enterProcess method notifies the Console that a new process has been entered. The Console displays this process in the Process Flow toolbox. Please see the leaveProcess method as the counter piece to enterProcess.- Parameters:
level- log levelprocessName- The name of the process
-
enterProcess
public void enterProcess(String processNameFmt, Object[] args)
Overloaded. Enters a new process by using the default log level. The process name consists of a format string and the related array of arguments.The enterProcess method notifies the Console that a new process has been entered. The Console displays this process in the Process Flow toolbox. Please see the leaveProcess method as the counter piece to enterProcess.
The resulting process name consists of a format string and the related array of arguments.
This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.
- Parameters:
processNameFmt- The format string to create the name of the processargs- The array of arguments for the format string
-
enterProcess
public void enterProcess(Level level, String processNameFmt, Object[] args)
Overloaded. Enters a new process by using a custom log level. The process name consists of a format string and the related array of arguments. The enterProcess method notifies the Console that a new process has been entered. The Console displays this process in the Process Flow toolbox. Please see the leaveProcess method as the counter piece to enterProcess. The resulting process name consists of a format string and the related array of arguments.- Parameters:
level- The log level of this method callprocessNameFmt- The format string to create the name of the processargs- The array of arguments for the format string
-
leaveProcess
public void leaveProcess()
Overloaded. Leaves a process by using the default log level and the parent's application name as process name.The leaveProcess method notifies the Console that a process has finished. The Console displays this change in the Process Flow toolbox. Please see the enterProcess method as the counter piece to leaveProcess.
This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.
-
leaveProcess
public void leaveProcess(Level level)
Overloaded. Leaves a process by using a custom log level and the parent's application name as process name. The leaveProcess method notifies the Console that a process has finished. The Console displays this change in the Process Flow toolbox. Please see the enterProcess method as the counter piece to leaveProcess.- Parameters:
level- The log level of this method call
-
leaveProcess
public void leaveProcess(String processName)
Overloaded. Leaves a process by using the default log level.The leaveProcess method notifies the Console that a process has finished. The Console displays this change in the Process Flow toolbox. Please see the enterProcess method as the counter piece to leaveProcess.
This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.
- Parameters:
processName- The name of the process
-
leaveProcess
public void leaveProcess(Level level, String processName)
Overloaded. Leaves a process by using a custom log level. The leaveProcess method notifies the Console that a process has finished. The Console displays this change in the Process Flow toolbox. Please see the enterProcess method as the counter piece to leaveProcess.- Parameters:
level- The log level of this method callprocessName- The name of the process
-
leaveProcess
public void leaveProcess(String processNameFmt, Object[] args)
Overloaded. Leaves a process by using the default log level. The process name consists of a format string and the related array of arguments.The leaveProcess method notifies the Console that a process has finished. The Console displays this change in the Process Flow toolbox. Please see the enterProcess method as the counter piece to leaveProcess.
The resulting process name consists of a format string and the related array of arguments.
This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.
- Parameters:
processNameFmt- The format string to create the name of the processargs- The array of arguments for the format string
-
leaveProcess
public void leaveProcess(Level level, String processNameFmt, Object[] args)
Overloaded. Leaves a process by using a custom log level. The process name consists of a format string and the related array of arguments.The leaveProcess method notifies the Console that a process has finished. The Console displays this change in the Process Flow toolbox. Please see the enterProcess method as the counter piece to leaveProcess.
The resulting process name consists of a format string and the related array of arguments.
- Parameters:
level- The log level of this method callprocessNameFmt- The format string to create the name of the processargs- The array of arguments for the format string
-
logColored
public void logColored(Color color, String title)
Overloaded. Logs a colored message with the default log level.This method uses the
SmartInspect.setDefaultLevel(com.gurock.smartinspect.Level)of the session'sgetParent()as log level. For more information, please refer to the documentation of theSmartInspect.setDefaultLevel(com.gurock.smartinspect.Level)method of the SmartInspect class.- Parameters:
color- The background color in the Consoletitle- The message to log
-
logColored
public void logColored(Level level, Color color, String title)
Overloaded. Logs a colored message with a custom log level.- Parameters:
level- The log level of this method callcolor- The background color in the Consoletitle- The message to log
-
logColored
public void logColored(Color color, String titleFmt, Object[] args)
Logs a colored message with the default log level. The message is created with a format string and a related array of arguments.This version of the method accepts a format string and a related array of arguments. These parameters will be passed to the MessageFormat.format() method and the resulting string will be the message.
This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.
- Parameters:
color- The background color in the ConsoletitleFmt- A format string to create the messageargs- The array of arguments for the format string
-
logColored
public void logColored(Level level, Color color, String titleFmt, Object[] args)
Overloaded method that logs a colored message with a custom log level. The message is created with a format string and a related array of arguments.This version of the method accepts a format string and a related array of arguments. These parameters will be passed to the MessageFormat.format method and the resulting string will be the message.
- Parameters:
level- The log level of this method callcolor- The background color in the ConsoletitleFmt- A format string to create the messageargs- The array of arguments for the format string
-
logDebug
public void logDebug(String title)
Overloaded. Logs a debug message with a log level of Level.Debug.- Parameters:
title- The message to log.
-
logDebug
public void logDebug(String titleFmt, Object[] args)
Overloaded. Logs a debug message with a log level of Level.Debug. The message is created with a format string and a related array of arguments. This version of the method accepts a format string and a related array of arguments. These parameters will be passed to the MessageFormat.format() method and the resulting string will be the message.- Parameters:
titleFmt- A format string to create the messageargs- The array of arguments for the format string
-
logVerbose
public void logVerbose(String title)
Overloaded method. This method is responsible for logging a verbose message with a log level of Level.Verbose.- Parameters:
title- The message to log
-
logVerbose
public void logVerbose(String titleFmt, Object[] args)
Overloaded. Logs a verbose message with a log level of Level.Verbose. The message is created with a format string and a related array of arguments. This version of the method accepts a format string and a related array of arguments. These parameters will be passed to the MessageFormat.format() method and the resulting string will be the message.- Parameters:
titleFmt- A format string to create the messageargs- The array of arguments for the format string
-
logMessage
public void logMessage(String title)
Overloaded. Logs a simple message with a log level of Level.Message.- Parameters:
title- The message to log
-
logMessage
public void logMessage(String titleFmt, Object[] args)
Overloaded. Logs a simple message with a log level of Level.Message. The message is created with a format string and a related array of arguments. This version of the method accepts a format string and a related array of arguments. These parameters will be passed to the MessageFormat.format() method and the resulting string will be the message.- Parameters:
titleFmt- A format string to create the messageargs- The array of arguments for the format string
-
logWarning
public void logWarning(String title)
Overloaded. Logs a warning message with a log level of Level.Warning.- Parameters:
title- The warning to log
-
logWarning
public void logWarning(String titleFmt, Object[] args)
Overloaded. Logs a warning message with a log level of Level.Warning. The warning message is created with a format string and a related array of arguments.This version of the method accepts a format string and a related array of arguments. These parameters will be passed to the MessageFormat.format() method and the resulting string will be the warning message.
- Parameters:
titleFmt- A format string to create the warningargs- The array of arguments for the format string
-
logError
public void logError(String title)
Overloaded. Logs an error message with a log level of Level.Error. This method is ideally used in error handling code such as exception handlers. If this method is used consequently, it is easy to troubleshoot and solve bugs in applications or configurations. See logException for a similar method.- Parameters:
title- A string which describes the error
-
logError
public void logError(String titleFmt, Object[] args)
Logs an error message with a log level of Level.Error. The error message is created with a format string and a related array of arguments. This version of the method accepts a format string and a related array of arguments. These parameters will be passed to the MessageFormat.format() method and the resulting string will be the error message. This method is ideally used in error handling code such as exception handlers. If this method is used consequently, it is easy to troubleshoot and solve bugs in applications or configurations. See logException for a similar method.- Parameters:
titleFmt- A format string to create a description of the errorargs- The array of arguments for the format string
-
logFatal
public void logFatal(String title)
Overloaded method to log a fatal error message with a log level of Level.Fatal.This method is ideally used in error handling code such as exception handlers. If this method is used consequently, it is easy to troubleshoot and solve bugs in applications or configurations. See logError for a method which does not describe fatal but recoverable errors.
- Parameters:
title- A string which describes the fatal error
-
logFatal
public void logFatal(String titleFmt, Object[] args)
Overloaded. Logs a fatal error message with a log level of Level.Fatal. The error message is created with a format string and a related array of arguments.This version of the method accepts a format string and a related array of arguments. These parameters will be passed to the MessageFormat.format method and the resulting string will be the fatal error message.
This method is ideally used in error handling code such as exception handlers. If this method is used consequently, it is easy to troubleshoot and solve bugs in applications or configurations. See logError for a method which does not describe fatal but recoverable errors.
- Parameters:
titleFmt- A format string to create a description of the fatal errorargs- The array of arguments for the format string
-
logInternalError
protected void logInternalError(String title)
Logs an internal error with a log level of Level.Error. This method logs an internal error. Such errors can occur if session methods are invoked with invalid arguments. For example, if you pass an invalid format string to logMessage, the exception will be caught and an internal error with the exception message will be sent.This method is also intended to be used in derived classes to report any errors in your own methods.
- Parameters:
title- A string which describes the internal error
-
logInternalError
protected void logInternalError(String titleFmt, Object[] args)
Overloaded. Logs an internal error with a log level of Level.Error. The error message is created with a format string and a related array of arguments.This method logs an internal error. Such errors can occur if session methods are invoked with invalid arguments. For example, if you pass an invalid format string to logMessage, the exception will be caught and an internal error with the exception message will be sent.
This version of the method accepts a format string and a related array of arguments. These parameters will be passed to the MessageFormat.format method and the resulting string will be the error message.
This method is also intended to be used in derived classes to report any errors in your own methods.
- Parameters:
titleFmt- A format string to create a description of the internal errorargs- The array of arguments for the format string
-
addCheckpoint
public void addCheckpoint()
Overloaded. Increments the default checkpoint counter and logs a message with the default log level. This method increments a checkpoint counter and then logs a message using "Checkpoint #N" as the title. The initial value of the checkpoint counter is 0. You can use theresetCheckpoint()method to reset the counter to 0 again. This method is useful, for example, for tracking loops. If addCheckpoint is called for each iteration of a loop, it is easy to follow the execution of the loop in question. This method can also be used in recursive methods to understand the execution flow. Furthermore, you can use it to highlight important parts of your code. SeelogSeparator()for a method with a similar intention. This method uses the SmartInspect.setDefaultLevel, default level of the session's parent as the log level. For more information, please refer to the documentation of the SmartInspect.setDefaultLevel, setDefaultLevel method of the SmartInspect class. Please refer tologSeparator(),resetCheckpoint()
-
addCheckpoint
public void addCheckpoint(Level level)
Overloaded. Increments the default checkpoint counter and logs a message with a custom log level.This method increments a checkpoint counter and then logs a message using "Checkpoint #N" as title. The initial value of the checkpoint counter is 0. You can use the
resetCheckpoint()method to reset the counter to 0 again.This method is useful, for example, for tracking loops. If addCheckpoint is called for each iteration of a loop, it is easy to follow the execution of the loop in question. This method can also be used in recursive methods to understand the execution flow. Furthermore, you can use it to highlight important parts of your code. See
logSeparator()for a method with a similar intention.- Parameters:
level- The log level of this method call- See Also:
logSeparator()
-
addCheckpoint
public void addCheckpoint(String name)
Overloaded. Increments the counter of a named checkpoint and logs a message with the default log level.This method increments the counter for the given checkpoint and then logs a message using "%checkpoint% #N" as title where %checkpoint% stands for the name of the checkpoint and N for the incremented counter value. The initial value of the counter for a given checkpoint is 0. You can use the resetCheckpoint method to reset the counter to 0 again.
This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.
- Parameters:
name- The name of the checkpoint to increment
-
addCheckpoint
public void addCheckpoint(Level level, String name)
Overloaded. Increments the counter of a named checkpoint and logs a message with a custom log level.This method increments the counter for the given checkpoint and then logs a message using "%checkpoint% #N" as title where %checkpoint% stands for the name of the checkpoint and N for the incremented counter value. The initial value of the counter for a given checkpoint is 0. You can use the resetCheckpoint method to reset the counter to 0 again.
- Parameters:
level- The log level of this method callname- The name of the checkpoint to increment
-
addCheckpoint
public void addCheckpoint(String name, String details)
Increments the counter of a named checkpoint and logs a message with the default log level and an optional message. This method increments the counter for the given checkpoint and then logs a message using "%checkpoint% #N" as title where %checkpoint% stands for the name of the checkpoint and N for the incremented counter value. The initial value of the counter for a given checkpoint is 0. Specify the details parameter to include an optional message in the resulting log entry. You can use the resetCheckpoint method to reset the counter to 0 again. This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.- Parameters:
name- The name of the checkpoint to incrementdetails- An optional message to include in the resulting log entry. Can be null
-
addCheckpoint
public void addCheckpoint(Level level, String name, String details)
Overloaded function. Increments the counter of a named checkpoint and logs a message with a custom log level and an optional message. This method increments the counter for the given checkpoint and then logs a message using "%checkpoint% #N" as title where %checkpoint% stands for the name of the checkpoint and N for the incremented counter value. The initial value of the counter for a given checkpoint is 0. Specify the details parameter to include an optional message in the resulting log entry. You can use the resetCheckpoint method to reset the counter to 0 again.- Parameters:
level- The log level of this method callname- The name of the checkpoint to incrementdetails- An optional message to include in the resulting log entry. Can be null
-
resetCheckpoint
public void resetCheckpoint()
Overloaded. Resets the default checkpoint counter. This method resets the default checkpoint counter to 0. The checkpoint counter is used by the addCheckpoint method.- See Also:
addCheckpoint()
-
resetCheckpoint
public void resetCheckpoint(String name)
Overloaded. Resets the counter of a named checkpoint. This method resets the counter of the given named checkpoint. Named checkpoints can be incremented and logged with the addCheckpoint method.- Parameters:
name- The name of the checkpoint to reset
-
logAssert
public void logAssert(boolean condition, String title)Overloaded. Logs an assert message if a condition is false with a log level of Level.Error. An assert message is logged if this method is called with a condition parameter of the value false. No Log Entry is generated if this method is called with a condition parameter of the value true. A typical usage of this method would be to test if a variable is not set to null before you use it. To do this, you just need to insert a logAssert call to the code section in question with "instance != null" as first parameter. If the reference is null and thus the expression evaluates to false, a message is logged.- Parameters:
condition- The condition to checktitle- The title of the Log Entry
-
logAssert
public void logAssert(boolean condition, String titleFmt, Object[] args)Overloaded. Logs an assert message if a condition is false with a log level of Lever.Error. The assert message is created with a format string and a related array of arguments.An assert message is logged if this method is called with a condition parameter of the value false. No Log Entry is generated if this method is called with a condition parameter of the value true.
This version of the method accepts a format string and a related array of arguments. These parameters will be passed to the MessageFormat.format() method and the resulting string will be the assert message.
A typical usage of this method would be to test if a variable is not set to null before you use it. To do this, you just need to insert a logAssert call to the code section in question with "instance != null" as first parameter. If the reference is null and thus the expression evaluates to false, a message is logged.
- Parameters:
condition- The condition to checktitleFmt- The format string to create the title of the Log Entryargs- The array of arguments for the format string
-
logAssigned
public void logAssigned(String title, Object instance)
Overloaded. Logs whether a variable is assigned or not with the default log level.If the instance argument is null, then ": Not assigned", otherwise ": Assigned" will be appended to the title before the Log Entry is sent.
This method is useful to check source code for null references in places where you experienced or expect problems and want to log possible null references.
This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.
- Parameters:
title- The title of the variableinstance- The variable which should be checked for null
-
logAssigned
public void logAssigned(Level level, String title, Object instance)
Overloaded. Logs whether a variable is assigned or not with a custom log level.If the instance argument is null, then ": Not assigned", otherwise ": Assigned" will be appended to the title before the log entry is sent.
This method is useful to check source code for null references in places where you experienced or expect problems and want to log possible null references.
- Parameters:
level- The log level of this method calltitle- The title of the variableinstance- The variable which should be checked for null
-
logConditional
public void logConditional(boolean condition, String title)Logs a conditional message with the default log level. This method only sends a message if the passed 'condition' argument evaluates to true. If 'condition' is false, this method has no effect and nothing is logged. This method is thus the counter piece to logAssert. This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.- Parameters:
condition- The condition to evaluatetitle- The title of the conditional message
-
logConditional
public void logConditional(boolean condition, String titleFmt, Object[] args)Overloaded. Logs a conditional message with the default log level. The message is created with a format string and a related array of arguments. This method only sends a message if the passed 'condition' argument evaluates to true. If 'condition' is false, this method has no effect and nothing is logged. This method is thus the counter piece to logAssert.This version of the method accepts a format string and a related array of arguments. These parameters will be passed to the MessageFormat.format method and the resulting string will be the conditional message.
This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.
- Parameters:
condition- The condition to evaluatetitleFmt- The format string to create the conditional messageargs- The array of arguments for the format string
-
logConditional
public void logConditional(Level level, boolean condition, String title)
Logs a conditional message with a custom log level. Overloaded version of the method. This method only sends a message if the passed 'condition' argument evaluates to true. If 'condition' is false, this method has no effect and nothing is logged. This method is thus the counter piece to logAssert.- Parameters:
level- The log level of this method callcondition- The condition to evaluatetitle- The title of the conditional message
-
logConditional
public void logConditional(Level level, boolean condition, String titleFmt, Object[] args)
Logs a conditional message with a custom log level. The message is created with a format string and a related array of arguments.This method only sends a message if the passed 'condition' argument evaluates to true. If 'condition' is false, this method has no effect and nothing is logged. This method is thus the counter piece to logAssert.
This version of the method accepts a format string and a related array of arguments. These parameters will be passed to the MessageFormat.format method and the resulting string will be the conditional message.
This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.
- Parameters:
level- The log level of this method callcondition- The condition to evaluatetitleFmt- The format string to create the conditional messageargs- The array of arguments for the format string
-
logBoolean
public void logBoolean(String name, boolean value)
Logs a boolean value with the default log level. Overloaded. This method logs the name and value of a boolean variable. A title like "name = True" will be displayed in the Console. This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.- Parameters:
name- The variable namevalue- The variable value
-
logBoolean
public void logBoolean(Level level, String name, boolean value)
Overloaded. Logs a boolean value with a custom log level. This method logs the name and value of a boolean variable. A title like "name = True" will be displayed in the Console.- Parameters:
level- The log level of this method callname- The variable namevalue- The variable value
-
logChar
public void logChar(String name, char value)
Overloaded method. Logs a char value with the default log level. This method logs the name and value of a char variable. A title like "name = 'c'" will be displayed in the Console. This method uses theSmartInspect.setDefaultLevel(com.gurock.smartinspect.Level)of the session'sparentas log level. For more information, please refer to the documentation of theSmartInspect.setDefaultLevel(com.gurock.smartinspect.Level)method of the SmartInspect class.- Parameters:
name- The variable namevalue- The variable value
-
logChar
public void logChar(Level level, String name, char value)
Overloaded. Logs a char value with a custom log level. This method logs the name and value of a char variable. A title like "name = 'c'" will be displayed in the Console.- Parameters:
level- The log level of this method callname- The variable namevalue- The variable value
-
logByte
public void logByte(String name, byte value)
Overloaded. Logs a byte value with the default log level. This method logs the name and value of a byte variable. A title like "name = 23" will be displayed in the Console.This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.
- Parameters:
name- The variable namevalue- The variable value
-
logByte
public void logByte(Level level, String name, byte value)
Overloaded. Logs a byte value with a custom log level. This method logs the name and value of a byte variable. A title like "name = 23" will be displayed in the Console.- Parameters:
level- The log level of this method callname- The variable namevalue- The variable value
-
logByte
public void logByte(String name, byte value, boolean includeHex)
Overloaded. Logs a byte value with an optional hexadecimal representation and default log level.This method logs the name and value of a byte variable. If you set the includeHex argument to true then the hexadecimal representation of the supplied variable value is included as well.
This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.
- Parameters:
name- The variable namevalue- The variable valueincludeHex- Indicates if a hexadecimal representation should be included
-
logByte
public void logByte(Level level, String name, byte value, boolean includeHex)
This method logs the name and value of a byte variable. If you set the includeHex argument to true then the hexadecimal representation of the supplied variable value is included as well. Overloaded. Logs a byte value with an optional hexadecimal representation and custom log level.- Parameters:
level- The log level of this method callname- The variable namevalue- The variable valueincludeHex- Indicates if a hexadecimal representation should be included
-
logShort
public void logShort(String name, short value)
Overloaded. Logs a short integer value with the default log level.This method logs the name and value of a short integer variable. A title like "name = 23" will be displayed in the Console.
This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.
- Parameters:
name- The variable namevalue- The variable value
-
logShort
public void logShort(Level level, String name, short value)
Overloaded. Logs a short integer value with a custom log level.This method logs the name and value of a short integer variable. A title like "name = 23" will be displayed in the Console.
- Parameters:
level- The log level of this method callname- The variable namevalue- The variable value
-
logShort
public void logShort(String name, short value, boolean includeHex)
Overloaded. Logs a short integer value with an optional hexadecimal representation and default log level.This method logs the name and value of a short integer variable. If you set the includeHex argument to true then the hexadecimal representation of the supplied variable value is included as well.
This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.
- Parameters:
name- The variable namevalue- The variable valueincludeHex- Indicates if a hexadecimal representation should be included
-
logShort
public void logShort(Level level, String name, short value, boolean includeHex)
Overloaded. Logs a short integer value with an optional hexadecimal representation and custom log level. This method logs the name and value of a short integer variable. If you set the includeHex argument to true then the hexadecimal representation of the supplied variable value is included as well.- Parameters:
level- The log level of this method callname- The variable namevalue- The variable valueincludeHex- Indicates if a hexadecimal representation should be included
-
logInt
public void logInt(String name, int value)
Overloaded. Logs an integer value with the default log level.This method logs the name and value of an integer variable. A title like "name = 23" will be displayed in the Console.
This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.
- Parameters:
name- The variable namevalue- The variable value
-
logInt
public void logInt(Level level, String name, int value)
Overloaded. Logs an integer value with a custom log level.This method logs the name and value of an integer variable. A title like "name = 23" will be displayed in the Console.
- Parameters:
level- The log level of this method callname- The variable namevalue- The variable value
-
logInt
public void logInt(String name, int value, boolean includeHex)
Logs an integer value with an optional hexadecimal representation and default log level.This method logs the name and value of an integer variable. If you set the includeHex argument to true then the hexadecimal representation of the supplied variable value is included as well.
This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.
- Parameters:
name- The variable namevalue- The variable valueincludeHex- Indicates if a hexadecimal representation should be included
-
logInt
public void logInt(Level level, String name, int value, boolean includeHex)
Overloaded. Logs an integer value with an optional hexadecimal representation and custom log level.This method logs the name and value of an integer variable. If you set the includeHex argument to true then the hexadecimal representation of the supplied variable value is included as well.
- Parameters:
level- The log level of this method callname- The variable namevalue- The variable valueincludeHex- Indicates if a hexadecimal representation should be included
-
logLong
public void logLong(String name, long value)
Logs a long integer value with the default log level.This method logs the name and value of a long integer variable. A title like "name = 23" will be displayed in the Console.
This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.
- Parameters:
name- The variable namevalue- The variable value
-
logLong
public void logLong(Level level, String name, long value)
Overloaded. Logs a long integer value with a custom log level. This method logs the name and value of a long integer variable. A title like "name = 23" will be displayed in the Console.- Parameters:
level- The log level of this method callname- The variable namevalue- The variable value
-
logLong
public void logLong(String name, long value, boolean includeHex)
Overloaded. Logs a long integer value with an optional hexadecimal representation and default log level.This method logs the name and value of a long integer variable. If you set the includeHex argument to true then the hexadecimal representation of the supplied variable value is included as well.
This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.
- Parameters:
name- The variable namevalue- The variable valueincludeHex- Indicates if a hexadecimal representation should be included
-
logLong
public void logLong(Level level, String name, long value, boolean includeHex)
Overloaded. Logs a long integer value with an optional hexadecimal representation and custom log level.This method logs the name and value of a long integer variable. If you set the includeHex argument to true then the hexadecimal representation of the supplied variable value is included as well.
- Parameters:
level- The log level of this method callname- The variable namevalue- The variable valueincludeHex- Indicates if a hexadecimal representation should be included
-
logFloat
public void logFloat(String name, float value)
Overloaded. Logs a float value with the default log level.This method logs the name and value of a float variable. A title like "name = 3.1415" will be displayed in the Console.
This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.
- Parameters:
name- The variable namevalue- The variable value
-
logFloat
public void logFloat(Level level, String name, float value)
Overloaded. Logs a float value with a custom log level. This method logs the name and value of a float variable. A title like "name = 3.1415" will be displayed in the Console.- Parameters:
level- The log level of this method callname- The variable namevalue- The variable value
-
logDouble
public void logDouble(String name, double value)
Overloaded. Logs a double value with the default log level. This method logs the name and value of a double variable. A title like "name = 3.1415" will be displayed in the Console.This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.
- Parameters:
name- The variable namevalue- The variable value
-
logDouble
public void logDouble(Level level, String name, double value)
Overloaded. Logs a double value with a custom log level.This method logs the name and value of a double variable. A title like "name = 3.1415" will be displayed in the Console.
- Parameters:
level- The log level of this method callname- The variable namevalue- The variable value
-
logString
public void logString(String name, String value)
Overloaded. Logs a string value with the default log level.This method logs the name and value of a string variable. A title like "name = "string"" will be displayed in the Console.
This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.
- Parameters:
name- The variable namevalue- The variable value
-
logString
public void logString(Level level, String name, String value)
Overloaded. Logs a string value with a custom log level.This method logs the name and value of a string variable. A title like "name = "string"" will be displayed in the Console.
- Parameters:
level- The log level of this method callname- The variable namevalue- The variable value
-
logObjectValue
public void logObjectValue(String name, Object value)
Overloaded. Logs an object value with the default log level.This method logs the name and value of an object. The title to display in the Console will consist of the name and the return value of the toString method of the object.
This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.
- Parameters:
name- The variable namevalue- The variable value
-
logObjectValue
public void logObjectValue(Level level, String name, Object value)
Overloaded. Logs an object value with a custom log level.This method logs the name and value of an object. The title to display in the Console will consist of the name and the return value of the toString method of the object.
- Parameters:
level- The log level of this method callname- The variable namevalue- The variable value
-
logDate
public void logDate(String name, Date value)
Overloaded. Logs a Date value with the default log level.This method logs the name and value of a Date instance. A title like "name = Wed Dec 29 10:52:31 CET 2004" will be displayed in the Console.
This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.
- Parameters:
name- The variable namevalue- The variable value
-
logDate
public void logDate(Level level, String name, Date value)
Overloaded. Logs a Date value with a custom log level.This method logs the name and value of a Date instance. A title like "name = Wed Dec 29 10:52:31 CET 2004" will be displayed in the Console.
- Parameters:
level- The log level of this method callname- The variable namevalue- The variable value
-
logValue
public void logValue(String name, boolean value)
Overloaded. Logs the name and value of a boolean variable with the default log level. This method just calls the logBoolean method. This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.- Parameters:
name- The name of the variablevalue- The boolean value of the variable
-
logValue
public void logValue(Level level, String name, boolean value)
Overloaded. Logs the name and value of a boolean variable with a custom log level. This method just calls the logBoolean method.- Parameters:
level- The log level of this method callname- The name of the variablevalue- The boolean value of the variable
-
logValue
public void logValue(String name, char value)
Overloaded. Logs the name and value of a char variable with the default log level. This method just calls the logChar method. This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.- Parameters:
name- The name of the variablevalue- The char value of the variable
-
logValue
public void logValue(Level level, String name, char value)
Logs the name and value of a char variable with a custom log level. This method just calls the logChar method.- Parameters:
level- The log level of this method callname- The name of the variablevalue- The char value of the variable
-
logValue
public void logValue(String name, byte value)
Overloaded. Logs the name and value of a byte variable with the default log level.This method just calls the logByte method. This method uses the
SmartInspect.setDefaultLevel(com.gurock.smartinspect.Level)of the session'sgetParent()as log level. For more information, please refer to the documentation of theSmartInspect.setDefaultLevel(com.gurock.smartinspect.Level)method of the SmartInspect class.- Parameters:
name- The name of the variablevalue- The byte value of the variable
-
logValue
public void logValue(Level level, String name, byte value)
Overloaded. Logs the name and value of a byte variable with a custom log level.Note: This method just calls the logByte method.
- Parameters:
level- The log level of this method callname- The name of the variablevalue- The byte value of the variable
-
logValue
public void logValue(String name, short value)
Overloaded. Logs the name and value of a short integer variable with the default log level. This method just calls the logShort method. This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.- Parameters:
name- The name of the variablevalue- The short integer value of the variable
-
logValue
public void logValue(Level level, String name, short value)
Overloaded. Logs the name and value of a short integer variable with a custom log level.This method just calls the logShort method.
- Parameters:
level- The log level of this method callname- The name of the variablevalue- The short integer value of the variable
-
logValue
public void logValue(String name, int value)
Logs the name and value of an integer variable with the default log level.This method just calls the logInt method.
This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.
- Parameters:
name- The name of the variablevalue- The integer value of the variable
-
logValue
public void logValue(Level level, String name, int value)
Overloaded. Logs the name and value of an integer variable with a custom log level.This method just calls the logInt method.
- Parameters:
level- The log level of this method callname- The name of the variablevalue- The integer value of the variable
-
logValue
public void logValue(String name, long value)
Overloaded. Logs the name and value of a long integer variable with the default log level. This method just calls the logLong method. This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.- Parameters:
name- The name of the variablevalue- The long integer value of the variable
-
logValue
public void logValue(Level level, String name, long value)
Overloaded. Logs the name and value of a long integer variable with a custom log level. This method just calls the logLong method.- Parameters:
level- The log level of this method callname- The name of the variablevalue- The long integer value of the variable
-
logValue
public void logValue(String name, float value)
Logs the name and value of a float variable with the default log level. This method just calls the logFloat method.This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.
- Parameters:
name- The name of the variablevalue- The float value of the variable
-
logValue
public void logValue(Level level, String name, float value)
Overloaded. Logs the name and value of a float variable with a custom log level. This method just calls the logFloat method.- Parameters:
level- The log level of this method callname- The name of the variablevalue- The float value of the variable
-
logValue
public void logValue(String name, double value)
Overloaded. Logs the name and value of a double variable with the default log level.This method just calls the logDouble method.
This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.
- Parameters:
name- The name of the variablevalue- The double value of the variable
-
logValue
public void logValue(Level level, String name, double value)
Overloaded. Logs the name and value of a double variable with a custom log level. This method just calls the logDouble method.- Parameters:
level- The log level of this method callname- The name of the variablevalue- The double value of the variable
-
logValue
public void logValue(String name, String value)
Logs the name and value of a string variable with the default log level. Overloaded.This method just calls the logString method. This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.
- Parameters:
name- The name of the variablevalue- The string value of the variable
-
logValue
public void logValue(Level level, String name, String value)
Overloaded method that logs the name and value of a string variable with a custom log level. This method just calls the logString method.- Parameters:
level- The log level of this method callname- The name of the variablevalue- The string value of the variable
-
logValue
public void logValue(String name, Object value)
Overloaded. Logs the name and value of an object with the default log level.This method just calls the logObjectValue method.
This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.
- Parameters:
name- The name of the variablevalue- The object to log
-
logValue
public void logValue(Level level, String name, Object value)
Logs the name and value of an object with a custom log level. This method just calls the logObjectValue method.- Parameters:
level- The log level of this method callname- The name of the variablevalue- The object to log
-
logValue
public void logValue(String name, Date value)
Overloaded. Logs the name and value of a Date instance with the default log level.This method just calls the logDate method.
This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.
- Parameters:
name- The name of the variablevalue- The Date value of the variable
-
logValue
public void logValue(Level level, String name, Date value)
Overloaded. Logs the name and value of a Date instance with a custom log level. This method just calls the logDate method.- Parameters:
level- The log level of this method callname- The name of the variablevalue- The Date value of the variable
-
logCustomContext
public void logCustomContext(String title, LogEntryType lt, ViewerContext ctx)
Overloaded. Logs a custom viewer context with the default log level.This method can be used to extend the capabilities of the SmartInspect Java library. You can assemble a so called viewer context and thus can send custom data to the SmartInspect Console. Furthermore, you can choose the viewer in which your data should be displayed. Every viewer in the Console has a corresponding viewer context class in this library.
Have a look at the ViewerContext class and its derived classes to see a list of available viewer context classes.
This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.
- Parameters:
title- The title to display in the Consolelt- The custom Log Entry typectx- SeeViewerContext
-
logCustomContext
public void logCustomContext(Level level, String title, LogEntryType lt, ViewerContext ctx)
Overloaded. Logs a custom viewer context with a custom log level.This method can be used to extend the capabilities of the SmartInspect Java library. You can assemble a so-called viewer context and thus can send custom data to the SmartInspect Console. Furthermore, you can choose the viewer in which your data should be displayed. Every viewer in the Console has a corresponding viewer context class in this library.
Have a look at the ViewerContext class and its derived classes to see a list of available viewer context classes.
- Parameters:
level- The log level of this method calltitle- The title to display in the Consolelt- The custom Log Entry typectx- viewer context- See Also:
ViewerContext
-
logCustomText
public void logCustomText(String title, String text, LogEntryType lt, ViewerId vi)
Overloaded. Logs a text using a custom Log Entry type, viewer ID and default log level.This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.
- Parameters:
title- The title to display in the Consoletext- The text to loglt- The custom Log Entry typevi- The custom viewer ID which specifies the way the Console handles the text content
-
logCustomText
public void logCustomText(Level level, String title, String text, LogEntryType lt, ViewerId vi)
Logs a text using a custom Log Entry type, viewer ID and custom log level.- Parameters:
level- The log level of this method calltitle- The title to display in the Consoletext- The text to loglt- The custom Log Entry typevi- The custom viewer ID which specifies the way the Console handles the text content
-
logCustomFile
public void logCustomFile(String fileName, LogEntryType lt, ViewerId vi)
Overloaded. Logs the content of a file using a custom Log Entry type, viewer ID and default log level.This method logs the content of the supplied file using a custom Log Entry type and viewer ID. The parameters control the way the content of the file is displayed in the Console. Thus you can extend the functionality of the SmartInspect Java library with this method.
This version of the method uses the fileName argument as title to display in the Console.
This method uses the
SmartInspect.setDefaultLevel(com.gurock.smartinspect.Level)default level of the session'sgetParent()parent as log level. For more information, please refer to the documentation of theSmartInspect.setDefaultLevel(com.gurock.smartinspect.Level)method of the SmartInspect class.- Parameters:
fileName- The file to loglt- The custom Log Entry typevi- The custom viewer ID which specifies the way the Console handles the file content
-
logCustomFile
public void logCustomFile(Level level, String fileName, LogEntryType lt, ViewerId vi)
Overloaded. Logs the content of a file using a custom Log Entry type, viewer ID and custom log level.This method logs the content of the supplied file using a custom Log Entry type and viewer ID. The parameters control the way the content of the file is displayed in the Console. Thus you can extend the functionality of the SmartInspect Java library with this method.
This version of the method uses the fileName argument as title to display in the Console.
- Parameters:
level- The log level of this method callfileName- The file to loglt- The custom Log Entry typevi- The custom viewer ID which specifies the way the Console handles the file content
-
logCustomFile
public void logCustomFile(String title, String fileName, LogEntryType lt, ViewerId vi)
Overloaded. Logs the content of a file using a custom Log Entry type, viewer ID, title and default log level.This method logs the content of the supplied file using a custom Log Entry type and viewer ID. The parameters control the way the content of the file is displayed in the Console. Thus, you can extend the functionality of the SmartInspect Java library with this method.
This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.
- Parameters:
fileName- The file to loglt- The custom Log Entry typevi- The custom viewer ID which specifies the way the Console handles the file contenttitle- The title to display in the Console
-
logCustomFile
public void logCustomFile(Level level, String title, String fileName, LogEntryType lt, ViewerId vi)
Overloaded. Logs the content of a file using a custom Log Entry type, viewer ID, title and custom log level.This method logs the content of the supplied file using a custom Log Entry type and viewer ID. The parameters control the way the content of the file is displayed in the Console. Thus you can extend the functionality of the SmartInspect Java library with this method.
- Parameters:
level- The log level of this method callfileName- The file to loglt- The custom Log Entry typevi- The custom viewer ID which specifies the way the Console handles the file contenttitle- The title to display in the Console
-
logCustomStream
public void logCustomStream(String title, InputStream stream, LogEntryType lt, ViewerId vi)
Logs the content of a stream using a custom Log Entry type, viewer ID and default log level. This method logs the content of the supplied stream using a custom Log Entry type and viewer ID. The parameters control the way the content of the file is displayed in the Console. Thus you can extend the functionality of the SmartInspect Java library with this method. This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.- Parameters:
title- The title to display in the Consolestream- The stream to loglt- The custom Log Entry typevi- The custom viewer ID which specifies the way the Console handles the stream content
-
logCustomStream
public void logCustomStream(Level level, String title, InputStream stream, LogEntryType lt, ViewerId vi)
Overloaded. Logs the content of a stream using a custom Log Entry type, viewer ID and custom log level.This method logs the content of the supplied stream using a custom Log Entry type and viewer ID. The parameters control the way the content of the file is displayed in the Console. Thus you can extend the functionality of the SmartInspect Java library with this method.
- Parameters:
level- The log level of this method calltitle- The title to display in the Consolestream- The stream to loglt- The custom Log Entry typevi- The custom viewer ID which specifies the way the Console handles the stream content
-
logCustomReader
public void logCustomReader(String title, Reader reader, LogEntryType lt, ViewerId vi)
Logs the content of a reader using a custom Log Entry type, viewer ID and default log level.This method logs the content of the supplied reader using a custom Log Entry type and viewer ID. The parameters control the way the content of the file is displayed in the Console. Thus you can extend the functionality of the SmartInspect Java library with this method.
This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.
- Parameters:
title- The title to display in the Consolereader- The reader to loglt- The custom Log Entry typevi- The custom viewer ID which specifies the way the Console handles the reader content
-
logCustomReader
public void logCustomReader(Level level, String title, Reader reader, LogEntryType lt, ViewerId vi)
Overloaded. Logs the content of a reader using a custom Log Entry type, viewer ID and custom log level. This method logs the content of the supplied reader using a custom Log Entry type and viewer ID. The parameters control the way the content of the file is displayed in the Console. Thus you can extend the functionality of the SmartInspect Java library with this method.- Parameters:
level- The log level of this method calltitle- The title to display in the Consolereader- The reader to loglt- The custom Log Entry typevi- The custom viewer ID which specifies the way the Console handles the reader content
-
logText
public void logText(String title, String text)
Logs a string with the default log level and displays it in a read-only text field. This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.- Parameters:
title- The title to display in the Consoletext- The text to log
-
logText
public void logText(Level level, String title, String text)
Overloaded. Logs a string with a custom log level and displays it in a read-only text field.- Parameters:
level- The log level of this method calltitle- The title to display in the Consoletext- The text to log
-
logTextFile
public void logTextFile(String fileName)
Overloaded. Logs a text file with the default log level and displays the content in a read-only text field.This version of the method uses the fileName argument as title to display in the Console.
This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.
- Parameters:
fileName- The file to log
-
logTextFile
public void logTextFile(Level level, String fileName)
Overloaded. Logs a text file with a custom log level and displays the content in a read-only text field.This version of the method uses the fileName argument as title to display in the Console.
- Parameters:
level- The log level of this method callfileName- The file to log
-
logTextFile
public void logTextFile(String title, String fileName)
Overloaded. Logs a text file and displays the content in a read-only text field using a custom title and default log level.This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.
- Parameters:
title- The title to display in the ConsolefileName- The file to log
-
logTextFile
public void logTextFile(Level level, String title, String fileName)
Overloaded. Logs a text file and displays the content in a read-only text field using a custom title and custom log level.- Parameters:
level- The log level of this method calltitle- The title to display in the ConsolefileName- The file to log
-
logTextStream
public void logTextStream(String title, InputStream stream)
Overloaded. Logs a stream with the default log level and displays the content in a read-only text field. This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.- Parameters:
title- The title to display in the Consolestream- The stream to log
-
logTextStream
public void logTextStream(Level level, String title, InputStream stream)
Logs a stream with a custom log level and displays the content in a read-only text field.- Parameters:
level- The log level of this method calltitle- The title to display in the Consolestream- The stream to log
-
logTextReader
public void logTextReader(String title, Reader reader)
Overloaded method. Logs a reader with the default log level and displays the content in a read-only text field.This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.
- Parameters:
title- The title to display in the Consolereader- The reader to log
-
logTextReader
public void logTextReader(Level level, String title, Reader reader)
Overloaded. Logs a reader with a custom log level and displays the content in a read-only text field.- Parameters:
level- The log level of this method calltitle- The title to display in the Consolereader- The reader to log
-
logHtml
public void logHtml(String title, String html)
Overloaded. Logs HTML code with the default log level and displays it in a web browser. This method logs the supplied HTML source code. The source code is displayed as a website in the web viewer of the Console.This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.
- Parameters:
title- The title to display in the Consolehtml- The HTML source code to display
-
logHtml
public void logHtml(Level level, String title, String html)
Overloaded. Logs HTML code with a custom log level and displays it in a web browser. This method logs the supplied HTML source code. The source code is displayed as a website in the web viewer of the Console.- Parameters:
level- The log level of this method calltitle- The title to display in the Consolehtml- The HTML source code to display
-
logHtmlFile
public void logHtmlFile(String fileName)
Overloaded. Logs an HTML file with the default log level and displays the content in a web browser.This method logs the HTML source code of the supplied file. The source code is displayed as a website in the web viewer of the Console.
This version of the method uses the fileName argument as title to display in the Console.
This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.
- Parameters:
fileName- The HTML file to display
-
logHtmlFile
public void logHtmlFile(Level level, String fileName)
Overloaded. Logs an HTML file with a custom log level and displays the content in a web browser.This method logs the HTML source code of the supplied file. The source code is displayed as a website in the web viewer of the Console.
This version of the method uses the fileName argument as title to display in the Console.
- Parameters:
level- The log level of this method callfileName- The HTML file to display
-
logHtmlFile
public void logHtmlFile(String title, String fileName)
Overloaded. Logs an HTML file and displays the content in a web browser using a custom title and default log level.This method logs the HTML source code of the supplied file. The source code is displayed as a website in the web viewer of the Console.
This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.
- Parameters:
title- The title to display in the ConsolefileName- The HTML file to display
-
logHtmlFile
public void logHtmlFile(Level level, String title, String fileName)
Overloaded. Logs an HTML file and displays the content in a web browser using a custom title and custom log level.This method logs the HTML source code of the supplied file. The source code is displayed as a website in the web viewer of the Console.
- Parameters:
level- The log level of this method calltitle- The title to display in the ConsolefileName- The HTML file to display
-
logHtmlStream
public void logHtmlStream(String title, InputStream stream)
Overloaded. Logs a stream with the default log level and displays the content in a web browser.This method logs the HTML source code of the supplied stream. The source code is displayed as a website in the web viewer of the Console.
This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.
- Parameters:
title- The title to display in the Consolestream- The stream to display
-
logHtmlStream
public void logHtmlStream(Level level, String title, InputStream stream)
Overloaded. Logs a stream with a custom log level and displays the content in a web browser.This method logs the HTML source code of the supplied stream. The source code is displayed as a website in the web viewer of the Console.
- Parameters:
level- The log level of this method calltitle- The title to display in the Consolestream- The stream to display
-
logHtmlReader
public void logHtmlReader(String title, Reader reader)
Overloaded. Logs a reader with the default log level and displays the content in a web browser.This method logs the HTML source code of the supplied reader. The source code is displayed as a website in the web viewer of the Console.
This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.
- Parameters:
title- The title to display in the Consolereader- The reader to display
-
logHtmlReader
public void logHtmlReader(Level level, String title, Reader reader)
Overloaded. Logs a reader with a custom log level and displays the content in a web browser.This method logs the HTML source code of the supplied reader. The source code is displayed as a website in the web viewer of the Console.
- Parameters:
level- The log level of this method calltitle- The title to display in the Consolereader- The reader to display
-
logBinary
public void logBinary(String title, byte[] b)
Overloaded. Logs a byte array with the default log level and displays it in a hex viewer.This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.
- Parameters:
title- The title to display in the Consoleb- The byte array to display in the hex viewer
-
logBinary
public void logBinary(Level level, String title, byte[] b)
Overloaded. Logs a byte array with a custom log level and displays it in a hex viewer.- Parameters:
level- The log level of this method calltitle- The title to display in the Consoleb- The byte array to display in the hex viewer
-
logBinary
public void logBinary(String title, byte[] b, int off, int len)
Logs a byte array with the default log level and displays it in a hex viewer. The input byte array is displayed in a hex viewer along with the specified title. The display starts from the given offset and displays the specified amount of bytes. This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.- Parameters:
title- The title to display in the Consoleb- The byte array to display in the hex vieweroff- The offset at which to display data fromlen- The amount of bytes to display
-
logBinary
public void logBinary(Level level, String title, byte[] b, int off, int len)
Overloaded. Logs a byte array with a custom log level and displays it in a hex viewer.- Parameters:
level- The log level of this method calltitle- The title to display in the Consoleb- The byte array to display in the hex vieweroff- The offset at which to display data fromlen- The amount of bytes to display
-
logBinaryFile
public void logBinaryFile(String fileName)
Overloaded. Logs a binary file with the default log level and displays its content in a hex viewer.This version of the method uses the supplied fileName argument as title to display in the Console. This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.
- Parameters:
fileName- The binary file to display in a hex viewer
-
logBinaryFile
public void logBinaryFile(Level level, String fileName)
Overloaded. Logs a binary file with a custom log level and displays its content in a hex viewer. This version of the method uses the supplied fileName argument as title to display in the Console.- Parameters:
level- The log level of this method callfileName- The binary file to display in a hex viewer
-
logBinaryFile
public void logBinaryFile(String title, String fileName)
Logs a binary file and displays its content in a hex viewer using a custom title and default log level. This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.- Parameters:
title- The title to display in the ConsolefileName- The binary file to display in a hex viewer
-
logBinaryFile
public void logBinaryFile(Level level, String title, String fileName)
Overloaded. Logs a binary file and displays its content in a hex viewer using a custom title and custom log level.- Parameters:
level- The log level of this method calltitle- The title to display in the ConsolefileName- The binary file to display in a hex viewer
-
logBinaryStream
public void logBinaryStream(String title, InputStream stream)
Overloaded. Logs a binary stream with the default log level and displays its content in a hex viewer.This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the
SmartInspect.setDefaultLevel(com.gurock.smartinspect.Level)method of the SmartInspect class.- Parameters:
title- The title to display in the Consolestream- The binary stream to display in a hex viewer
-
logBinaryStream
public void logBinaryStream(Level level, String title, InputStream stream)
Overloaded. Logs a binary stream with a custom log level and displays its content in a hex viewer.- Parameters:
level- The log level of this method calltitle- The title to display in the Consolestream- The binary stream to display in a hex viewer
-
logBitmapFile
public void logBitmapFile(String fileName)
Logs a bitmap file with the default log level and displays it in the Console.This version of the method uses the supplied fileName argument as title to display in the Console.
This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.
- Parameters:
fileName- The bitmap file to display in the Console
-
logBitmapFile
public void logBitmapFile(Level level, String fileName)
Logs a bitmap file with a custom log level and displays it in the Console. This version of the method uses the supplied fileName argument as title to display in the Console.- Parameters:
level- The log level of this method callfileName- The bitmap file to display in the Console
-
logBitmapFile
public void logBitmapFile(String title, String fileName)
Overloaded. Logs a bitmap file and displays it in the Console using a custom title and default log level.
This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.- Parameters:
title- The title to display in the ConsolefileName- The bitmap file to display in the Console
-
logBitmapFile
public void logBitmapFile(Level level, String title, String fileName)
Overloaded. Logs a bitmap file and displays it in the Console using a custom title and custom log level.- Parameters:
level- The log level of this method calltitle- The title to display in the ConsolefileName- The bitmap file to display in the Console
-
logBitmapStream
public void logBitmapStream(String title, InputStream stream)
Logs a stream with the default log level and interprets its content as a bitmap. This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.- Parameters:
title- The title to display in the Consolestream- The stream to display as bitmap
-
logBitmapStream
public void logBitmapStream(Level level, String title, InputStream stream)
Overloaded. Logs a stream with a custom log level and interprets its content as a bitmap.- Parameters:
level- The log level of this method calltitle- The title to display in the Consolestream- The stream to display as bitmap
-
logJpegFile
public void logJpegFile(String fileName)
Overloaded. Logs a JPEG file with the default log level and displays it in the Console.This version of the method uses the supplied fileName argument as title to display in the Console.
This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.
- Parameters:
fileName- The JPEG file to display in the Console
-
logJpegFile
public void logJpegFile(Level level, String fileName)
Overloaded. Logs a JPEG file with a custom log level and displays it in the Console. This version of the method uses the supplied fileName argument as title to display in the Console.- Parameters:
level- The log level of this method callfileName- The JPEG file to display in the Console
-
logJpegFile
public void logJpegFile(String title, String fileName)
Overloaded. Logs a JPEG file and displays it in the Console using a custom title and default log level. This method uses the SmartInspect.setDefaultLevel, default level of the session's getParent, parent as log level. For more information, please refer to the documentation of the SmartInspect.setDefaultLevel, setDefaultLevel method of the SmartInspect class.- Parameters:
title- The title to display in the ConsolefileName- The JPEG file to display in the Console
-
logJpegFile
public void logJpegFile(Level level, String title, String fileName)
Overloaded. Logs a JPEG file and displays it in the Console using a custom title and custom log level.- Parameters:
level- The log level of this method calltitle- The title to display in the ConsolefileName- The JPEG file to display in the Console
-
logJpegStream
public void logJpegStream(String title, InputStream stream)
Overloaded. Logs a stream with the default log level and interprets its content as a JPEG image.This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.
- Parameters:
title- The title to display in the Consolestream- The stream to display as JPEG image
-
logJpegStream
public void logJpegStream(Level level, String title, InputStream stream)
Overloaded. Logs a stream with a custom log level and interprets its content as a JPEG image.- Parameters:
level- The log level of this method calltitle- The title to display in the Consolestream- The stream to display as JPEG image
-
logIconFile
public void logIconFile(String fileName)
Overloaded. Logs a Windows icon file with the default log level and displays it in the Console.This version of the method uses the supplied fileName argument as title to display in the Console.
This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.
- Parameters:
fileName- The Windows icon file to display in the Console
-
logIconFile
public void logIconFile(Level level, String fileName)
Overloaded. Logs a Windows icon file with a custom log level and displays it in the Console.This version of the method uses the supplied fileName argument as title to display in the Console.
- Parameters:
level- The log level of this method callfileName- The Windows icon file to display in the Console
-
logIconFile
public void logIconFile(String title, String fileName)
Overloaded. Logs a Windows icon file and displays it in the Console using a custom title and default log level. This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.- Parameters:
title- The title to display in the ConsolefileName- The Windows icon file to display in the Console
-
logIconFile
public void logIconFile(Level level, String title, String fileName)
Overloaded. Logs a Windows icon file and displays it in the Console using a custom title and custom log level.- Parameters:
level- The log level of this method calltitle- The title to display in the ConsolefileName- The Windows icon file to display in the Console
-
logIconStream
public void logIconStream(String title, InputStream stream)
Overloaded. Logs a stream with the default log level and interprets its content as Windows icon.This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.
- Parameters:
title- The title to display in the Consolestream- The stream to display as Windows icon
-
logIconStream
public void logIconStream(Level level, String title, InputStream stream)
Logs a stream with a custom log level and interprets its content as Windows icon.- Parameters:
level- The log level of this method calltitle- The title to display in the Consolestream- The stream to display as Windows icon
-
logMetafileFile
public void logMetafileFile(String fileName)
Overloaded. Logs a Windows Metafile file with the default log level and displays it in the Console.This version of the method uses the supplied fileName argument as title to display in the Console.
This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.
- Parameters:
fileName- The Windows Metafile file to display in the Console
-
logMetafileFile
public void logMetafileFile(Level level, String fileName)
Overloaded. Logs a Windows Metafile file with a custom log level and displays it in the Console. This version of the method uses the supplied fileName argument as title to display in the Console.- Parameters:
level- The log level of this method callfileName- The Windows Metafile file to display in the Console
-
logMetafileFile
public void logMetafileFile(String title, String fileName)
Logs a Windows Metafile file and displays it in the console using a custom title and default log level. This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.- Parameters:
title- The title to display in the consolefileName- The Windows Metafile file to display in the console
-
logMetafileFile
public void logMetafileFile(Level level, String title, String fileName)
Overloaded. Logs a Windows Metafile file and displays it in the Console using a custom title and custom log level.- Parameters:
level- The log level of this method calltitle- The title to display in the ConsolefileName- The Windows Metafile file to display in the Console
-
logMetafileStream
public void logMetafileStream(String title, InputStream stream)
Overloaded. Logs a stream with the default log level and interprets its content as Windows Metafile image.This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.
- Parameters:
title- The title to display in the Consolestream- The stream to display as Windows Metafile image
-
logMetafileStream
public void logMetafileStream(Level level, String title, InputStream stream)
Overloaded. Logs a stream with a custom log level and interprets its content as Windows Metafile image.- Parameters:
level- The log level of this method calltitle- The title to display in the Consolestream- The stream to display as Windows Metafile image
-
logSql
public void logSql(String title, String source)
Overloaded. Logs a string containing SQL source code with the default log level. The SQL source code is displayed with syntax highlighting in the Console.This method displays the supplied SQL source code with syntax highlighting in the Console.
It is especially useful to debug or track dynamically generated SQL source code.
This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.
- Parameters:
title- The title to display in the Consolesource- The SQL source code to log
-
logSql
public void logSql(Level level, String title, String source)
Overloaded. Logs a string containing SQL source code with a custom log level. The SQL source code is displayed with syntax highlighting in the Console.This method displays the supplied SQL source code with syntax highlighting in the Console. It is especially useful to debug or track dynamically generated SQL source code.
- Parameters:
level- The log level of this method calltitle- The title to display in the Consolesource- The SQL source code to log
-
logSource
public void logSource(String title, String source, SourceId id)
Overloaded. Logs source code that is displayed with syntax highlighting in the Console using the default log level.This method displays the supplied source code with syntax highlighting in the Console. The type of the source code can be specified by the 'id' argument. Please see the SourceId documentation for information on the supported source code types.
This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.
- Parameters:
title- The title to display in the Consolesource- The source code to logid- Specifies the type of source code
-
logSource
public void logSource(Level level, String title, String source, SourceId id)
Overloaded method, logs source code that is displayed with syntax highlighting in the Console using a custom log level. This method displays the supplied source code with syntax highlighting in the Console. The type of the source code can be specified by the 'id' argument. Please see the SourceId documentation for information on the supported source code types.- Parameters:
level- The log level of this method calltitle- The title to display in the Consolesource- The source code to logid- Specifies the type of source code
-
logSourceFile
public void logSourceFile(String fileName, SourceId id)
Overloaded. Logs the content of a file as source code with syntax highlighting using the default log level.This method displays the source file with syntax highlighting in the Console. The type of the source code can be specified by the 'id' argument. Please see the SourceId documentation for information on the supported source code types.
This version of the method uses the supplied fileName argument as title to display in the Console.
This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.
- Parameters:
fileName- The file which contains the source codeid- Specifies the type of source code
-
logSourceFile
public void logSourceFile(Level level, String fileName, SourceId id)
Overloaded. Logs the content of a file as source code with syntax highlighting using a custom log level.This method displays the source file with syntax highlighting in the Console. The type of the source code can be specified by the 'id' argument. Please see the SourceId documentation for information on the supported source code types.
This version of the method uses the supplied fileName argument as title to display in the Console.
- Parameters:
level- The log level of this method callfileName- The file which contains the source codeid- Specifies the type of source code
-
logSourceFile
public void logSourceFile(String title, String fileName, SourceId id)
Overloaded. Logs the content of a file as source code with syntax highlighting using a custom title and default log level. This method displays the source file with syntax highlighting in the Console. The type of the source code can be specified by the 'id' argument. Please see the SourceId documentation for information on the supported source code types.This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.
- Parameters:
title- The title to display in the ConsolefileName- The file which contains the source codeid- Specifies the type of source code
-
logSourceFile
public void logSourceFile(Level level, String title, String fileName, SourceId id)
Overloaded. Logs the content of a file as source code with syntax highlighting using a custom title and custom log level.This method displays the source file with syntax highlighting in the Console. The type of the source code can be specified by the 'id' argument. Please see the SourceId documentation for information on the supported source code types.
- Parameters:
level- The log level of this method calltitle- The title to display in the ConsolefileName- The file which contains the source codeid- Specifies the type of source code
-
logSourceStream
public void logSourceStream(String title, InputStream stream, SourceId id)
Overloaded. Logs the content of a stream as source code with syntax highlighting using the default log level.This method displays the content of a stream with syntax highlighting in the Console. The type of the source code can be specified by the 'id' argument. Please see the SourceId documentation for information on the supported source code types.
This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.
- Parameters:
title- The title to display in the Consolestream- The stream which contains the source codeid- Specifies the type of source code
-
logSourceStream
public void logSourceStream(Level level, String title, InputStream stream, SourceId id)
Overloaded. Logs the content of a stream as source code with syntax highlighting using a custom log level.This method displays the content of a stream with syntax highlighting in the Console. The type of the source code can be specified by the 'id' argument. Please see the SourceId documentation for information on the supported source code types.
- Parameters:
level- The log level of this method calltitle- The title to display in the Consolestream- The stream which contains the source codeid- Specifies the type of source code
-
logSourceReader
public void logSourceReader(String title, Reader reader, SourceId id)
Overloaded. Logs the content of a reader as source code with syntax highlighting using the default log level.This method displays the content of a reader with syntax highlighting in the Console. The type of the source code can be specified by the 'id' argument. Please see the SourceId documentation for information on the supported source code types.
This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.
- Parameters:
title- The title to display in the Consolereader- The reader which contains the source codeid- Specifies the type of source code
-
logSourceReader
public void logSourceReader(Level level, String title, Reader reader, SourceId id)
Overloaded. Logs the content of a reader as source code with syntax highlighting using a custom log level.This method displays the content of a reader with syntax highlighting in the Console. The type of the source code can be specified by the 'id' argument. Please see the SourceId documentation for information on the supported source code types.
- Parameters:
level- The log level of this method calltitle- The title to display in the Consolereader- The reader which contains the source codeid- Specifies the type of source code
-
logObject
public void logObject(String title, Object instance)
Overloaded. Logs the public fields of an object with the default log level.This method logs all public field names and their current values of an object. These key/value pairs will be displayed in the Console in an object inspector-like viewer.
This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.
- Parameters:
title- The title to display in the Consoleinstance- The object whose public fields should be logged
-
logObject
public void logObject(Level level, String title, Object instance)
Overloaded. Logs the public fields of an object with a custom log level.This method logs all public field names and their current values of an object. These key/value pairs will be displayed in the Console in an object inspector like viewer.
- Parameters:
level- The log level of this method calltitle- The title to display in the Consoleinstance- The object whose public fields should be logged
-
logObject
public void logObject(String title, Object instance, boolean nonPublic)
Overloaded method that logs fields of an object with the default log level. This method allows specifying whether non-public members should also be logged. This method logs all field names and their current values of an object. These key/value pairs will be displayed in the Console in an object inspector-like viewer.You can specify if non-public or only public fields should be logged by setting the nonPublic argument to true or false, respectively. This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.
- Parameters:
title- The title to display in the Consoleinstance- The object whose fields should be loggednonPublic- Specifies if non-public members should be logged
-
logObject
public void logObject(Level level, String title, Object instance, boolean nonPublic)
Overloaded. Logs fields of an object with a custom log level. Lets you specify if non-public members should also be logged.This method logs all field names and their current values of an object. These key/value pairs will be displayed in the Console in an object inspector like viewer. You can specify if non public or only public fields should be logged by setting the nonPublic argument to true or false, respectively.
- Parameters:
level- The log level of this method calltitle- The title to display in the Consoleinstance- The object whose fields should be loggednonPublic- Specifies if non-public members should be logged
-
logException
public void logException(Throwable t)
Logs the content of an exception with a log level of Level.Error.This method extracts the exception message and stack trace from the supplied exception and logs an error with this data. It is especially useful if you place calls to this method in exception handlers, of course. See logError for a more general method with a similar intention.
This version of the method uses the exception message as title to display in the Console.
- Parameters:
t- The exception to log
-
logException
public void logException(String title, Throwable t)
Overloaded. Logs the content of an exception with a log level of Level.Error and a custom title.This method extracts the exception message and stack trace from the supplied exception and logs an error with this data. It is especially useful if you place calls to this method in exception handlers, of course. See logError for a more general method with a similar intention.
- Parameters:
title- The title to display in the Consolet- The exception to log
-
logMemoryStatistic
public void logMemoryStatistic()
Overloaded. Logs memory statistics about the virtual machine with the default log level. This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.
-
logMemoryStatistic
public void logMemoryStatistic(Level level)
Overloaded. Logs memory statistics about the virtual machine with a custom log level.- Parameters:
level- The log level of this method call
-
logMemoryStatistic
public void logMemoryStatistic(String title)
Logs memory statistics about the virtual machine using a custom title and default log level.This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.
- Parameters:
title- The title to display in the Console
-
logMemoryStatistic
public void logMemoryStatistic(Level level, String title)
Overloaded. Logs memory statistics about the virtual machine using a custom title and default log level.- Parameters:
level- The log level of this method calltitle- The title to display in the Console
-
logCurrentThread
public void logCurrentThread()
Overloaded. Logs information about the current thread with the default log level.This method logs information about the current thread. This includes its name, its current state and more.
logCurrentThread is especially useful in a multi-threaded program like in a network server application. By using this method you can easily track all threads of a process and obtain detailed information about them.
See logThread for a more general method, which can handle any thread.
This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.
-
logCurrentThread
public void logCurrentThread(Level level)
Logs information about the current thread with a custom log level.
This method logs information about the current thread. This includes its name, its current state and more.
logCurrentThread is especially useful in a multi-threaded program like in a network server application. By using this method you can easily track all threads of a process and obtain detailed information about them.
See logThread for a more general method, which can handle any thread.
- Parameters:
level- The log level of this method call
-
logCurrentThread
public void logCurrentThread(String title)
Logs information about the current thread using a custom title and the default log level.
This method logs information about the current thread. This includes its name, its current state and more.
logCurrentThread is especially useful in a multithreaded program like in a network server application. By using this method you can easily track all threads of a process and obtain detailed information about them.
See logThread for a more general method, which can handle any thread.
This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.- Parameters:
title- The title to display in the Console
-
logCurrentThread
public void logCurrentThread(Level level, String title)
Overloaded method that logs information about the current thread using a custom title and a custom log level.This method logs information about the current thread. This includes its name, its current state and more.
logCurrentThread is especially useful in a multithreaded program like in a network server application. By using this method you can easily track all threads of a process and obtain detailed information about them.
See logThread for a more general method, which can handle any thread.
- Parameters:
level- The log level of this method calltitle- The title to display in the Console
-
logThread
public void logThread(String title, Thread thread)
This method logs information about the supplied thread. This includes its name, its current state and more. logThread is especially useful in a multi-threaded program like in a network server application. By using this method you can easily track all threads of a process and obtain detailed information about them.This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.
- Parameters:
title- The title to display in the Consolethread- The thread to log
-
logThread
public void logThread(Level level, String title, Thread thread)
Overloaded. Logs information about a thread with a custom log level.This method logs information about the supplied thread. This includes its name, its current state and more.
logThread is especially useful in a multithreaded program like in a network server application. By using this method you can easily track all threads of a process and obtain detailed information about them.
- Parameters:
level- The log level of this method calltitle- The title to display in the Consolethread- The thread to log
-
logCollection
public void logCollection(String title, Collection c)
Overloaded. Logs the content of a collection with the default log level.This method iterates through the supplied collection and
ObjectRenderer.renderObject(java.lang.Object)every element into a string. These elements will be displayed in a listview in the Console.This method uses the
SmartInspect.setDefaultLevel(com.gurock.smartinspect.Level)of the session'sgetParent()as log level. For more information, please refer to the documentation of theSmartInspect.setDefaultLevel(com.gurock.smartinspect.Level)method of the SmartInspect class.- Parameters:
title- The title to display in the Consolec- The collection to log
-
logCollection
public void logCollection(Level level, String title, Collection c)
Overloaded. Logs the content of a collection with a custom log level. This method iterates through the supplied collection and renders every element into a string. These elements will be displayed in a listview in the Console.- Parameters:
level- The log level of this method calltitle- The title to display in the Consolec- The collection to log
-
logMap
public void logMap(String title, Map map)
Overloaded. Logs the content of a map with the default log level.This methods iterates through the supplied dictionary and renders every key/value pair into a string. These pairs will be displayed in a special key/value table in the Console.
This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.
- Parameters:
title- The title to display in the Consolemap- The map to log
-
logMap
public void logMap(Level level, String title, Map map)
Logs the content of a map with a custom log level.This method iterates through the supplied dictionary and
ObjectRenderer.renderObject(java.lang.Object)every key/value pair into a string. These pairs will be displayed in a special key/value table in the Console.- Parameters:
level- The log level of this method calltitle- The title to display in the Consolemap- The map to log
-
logArray
public void logArray(String title, Object[] array)
Overloaded. Logs the content of an array with the default log level.This method iterates through the supplied array and
rendersevery element into a string. These elements will be displayed in a listview in the Console.Please see logCollection to log a collection and logMap to log a map.
This method uses the
default levelof the session'sparentas log level. For more information, please refer to the documentation of thesetDefaultLevelmethod of the SmartInspect class.- Parameters:
title- The title to display in the Consolearray- The array to log
-
logArray
public void logArray(Level level, String title, Object[] array)
Overloaded. Logs the content of an array with a custom log level. This method iterates through the supplied array andObjectRenderer.renderObject(java.lang.Object)every element into a string. These elements will be displayed in a listview in the Console. Please see logCollection to log a collection and logMap to log a map.- Parameters:
level- The log level of this method calltitle- The title to display in the Consolearray- The array to log
-
logCurrentStackTrace
public void logCurrentStackTrace()
Overloaded. Logs the current stack trace with the default log level. This method logs the current stack trace. The resulting Log Entry contains all methods including the related classes that are currently on the stack. Furthermore, the filename and line numbers will be included. This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.
-
logCurrentStackTrace
public void logCurrentStackTrace(Level level)
Overloaded. Logs the current stack trace with a custom log level. This method logs the current stack trace. The resulting Log Entry contains all methods including the related classes that are currently on the stack. Furthermore, the filename and line numbers will be included.- Parameters:
level- The log level of this method call
-
logCurrentStackTrace
public void logCurrentStackTrace(String title)
Overloaded. Logs the current stack trace using a custom title and default log level. This method logs the current stack trace. The resulting Log Entry contains all methods including the related classes that are currently on the stack. Furthermore, the filename and line numbers will be included. This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.- Parameters:
title- The title to display in the Console
-
logCurrentStackTrace
public void logCurrentStackTrace(Level level, String title)
Overloaded. Logs the current stack trace using a custom title and custom log level.This method logs the current stack trace. The resulting Log Entry contains all methods including the related classes that are currently on the stack. Furthermore, the filename and line numbers will be included.
- Parameters:
level- The log level of this method calltitle- The title to display in the Console
-
logSystem
public void logSystem()
Logs information about the system with the default log level.The logged information include the version of the operating system, the Java version and more. This method is useful for logging general information at the program startup. This guarantees that the support staff or developers have general information about the execution environment.
This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.
-
logSystem
public void logSystem(Level level)
Logs information about the system with a custom log level. The logged information includes the version of the operating system, the Java version and more. This method is useful for logging general information at the program startup. This guarantees that support staff or developers have general information about the execution environment.- Parameters:
level- The log level of this method call
-
logSystem
public void logSystem(String title)
Overloaded. Logs information about the system using a custom title and the default log level.The logged information include the version of the operating system, the Java version and more. This method is useful for logging general information at the program startup. This guarantees that the support staff or developers have general information about the execution environment.
This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.
- Parameters:
title- The title to display in the Console
-
logSystem
public void logSystem(Level level, String title)
Overloaded. Logs information about the system using a custom title and a custom log level. The logged information include the version of the operating system, the Java version and more. This method is useful for logging general information at the program startup. This guarantees that the support staff or developers have general information about the execution environment.- Parameters:
level- The log level of this method calltitle- The title to display in the Console
-
logResultSetMetaData
public void logResultSetMetaData(String title, ResultSet rset)
Overloaded. Logs the metadata of a ResultSet with the default log level.This method sends the schema of a ResultSet. A schema includes the most important properties of every column in the set.
This logResultSetMetaData method is especially useful in database applications with lots of queries. It gives you the possibility to see the raw schema of query results.
This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.
- Parameters:
title- The title to display in the Consolerset- The ResultSet instance whose metadata should be logged
-
logResultSetMetaData
public void logResultSetMetaData(Level level, String title, ResultSet rset)
Overloaded. Logs the metadata of a ResultSet with a custom log level. This method sends the schema of a ResultSet. A schema includes the most important properties of every column in the set. This logResultSetMetaData method is especially useful in database applications with lots of queries. It gives you the possibility to see the raw schema of query results.- Parameters:
level- The log level of this method calltitle- The title to display in the Consolerset- The ResultSet instance whose metadata should be logged
-
logResultSetMetaData
public void logResultSetMetaData(String title, ResultSetMetaData rmeta)
Overloaded method that logs the metadata of a ResultSet with the default log level.This method sends the schema of a ResultSet. A schema includes the most important properties of every column in the set.
The logResultSetMetaData method is especially useful in database applications with lots of queries. It gives you the ability to see the raw schema of query results.
This method uses the default level of the session's parent as log level. For more details, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.
- Parameters:
title- Result set titlermeta- The metadata of a ResultSet which should be logged
-
logResultSetMetaData
public void logResultSetMetaData(Level level, String title, ResultSetMetaData rmeta)
Overloaded. Logs the metadata of a ResultSet with a custom log level.This method sends the schema of a ResultSet. A schema includes the most important properties of every column in the set. This logResultSetMetaData method is especially useful in database applications with lots of queries. It gives you the possibility to see the raw schema of query results.
- Parameters:
level- The log level of this method calltitle- Result set titlermeta- The metadata of a ResultSet which should be logged
-
logResultSet
public void logResultSet(String title, ResultSet rset)
Logs the content of a ResultSet with the default log level.This method logs the content of a ResultSet instance. This logResultSet method is especially useful in database applications with lots of queries. It gives you the possibility to see the raw query results.
Please note that this method tries to restore the original row position of the supplied ResultSet instance after reading the content, but only if its type is not ResultSet.TYPE_FORWARD_ONLY.
This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.
- Parameters:
title- The title to display in the Consolerset- The ResultSet instance whose content should be logged
-
logResultSet
public void logResultSet(Level level, String title, ResultSet rset)
Overloaded method that logs the content of a ResultSet with a custom log level. This method logs the content of a ResultSet instance. This logResultSet method is quite useful in database applications with myriad queries. It provides the opportunity to see the raw query results. Please note that this method attempts to restore the original row position of the supplied ResultSet instance after reading the content, but only if its type isn't ResultSet.TYPE_FORWARD_ONLY.- Parameters:
level- The log level of this method calltitle- The title to display in the Consolerset- The ResultSet instance whose content should be logged
-
logStringBuffer
public void logStringBuffer(String title, StringBuffer sb)
Overloaded method, logs the content of a StringBuffer instance with the default log level. The content of the supplied StringBuffer instance is displayed in a read-only text field. This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.- Parameters:
title- The title to display in the Consolesb- The StringBuffer instance whose content should be logged
-
logStringBuffer
public void logStringBuffer(Level level, String title, StringBuffer sb)
Overloaded. Logs the content of a StringBuffer instance with a custom log level. The content of the supplied StringBuffer instance is displayed in a read-only text field.- Parameters:
level- The log level of this method calltitle- The title to display in the Consolesb- The StringBuffer instance whose content should be logged
-
logStream
public void logStream(String title, InputStream stream)
Logs the content of a binary stream with the default log level.The content of the supplied binary stream will be displayed in a read-only hex editor.
This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.
- Parameters:
title- The title to display in the Consolestream- The stream whose content should be logged
-
logStream
public void logStream(Level level, String title, InputStream stream)
Overloaded. Logs the content of a binary stream with a custom log level. The content of the supplied binary stream will be displayed in a read-only hex editor.- Parameters:
level- The log level of this method calltitle- The title to display in the Consolestream- The stream whose content should be logged
-
logReader
public void logReader(String title, Reader reader)
Overloaded. Logs the content of a text reader with the default log level. The content of the supplied reader is displayed in a read-only text field. This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.- Parameters:
title- The title to display in the Consolereader- The reader whose content should be logged
-
logReader
public void logReader(Level level, String title, Reader reader)
Overloaded. Logs the content of a text reader with a custom log level. The content of the supplied reader is displayed in a read-only text field.- Parameters:
level- The log level of this method calltitle- The title to display in the Consolereader- The reader whose content should be logged
-
clearLog
public void clearLog()
Clears all Log Entries in the Console.
-
clearWatches
public void clearWatches()
Clears all Watches in the Console.
-
clearAutoViews
public void clearAutoViews()
Clears all AutoViews in the Console.
-
clearAll
public void clearAll()
Resets the whole Console.This method resets the whole Console. This means that all Watches, Log Entries, Process Flow entries and AutoViews will be deleted.
-
clearProcessFlow
public void clearProcessFlow()
Clears all Process Flow entries in the Console.
-
incCounter
public void incCounter(String name)
Overloaded. Increments a named counter by one and automatically sends its name and value as integer watch with the default log level.The Session class tracks a list of so called named counters. A counter has a name and a value of type integer. This method increments the value for the specified counter by one and then sends a normal integer watch with the name and value of the counter. The initial value of a counter is 0. To reset the value of a counter to 0 again, you can call resetCounter.
This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.
See decCounter for a method which decrements the value of a named counter instead of incrementing it.
- Parameters:
name- The name of the counter to log
-
incCounter
public void incCounter(Level level, String name)
Overloaded. Increments a named counter by one and automatically sends its name and value as integer watch with a custom log level.The Session class tracks a list of so called named counters. A counter has a name and a value of type integer. This method increments the value for the specified counter by one and then sends a normal integer watch with the name and value of the counter. The initial value of a counter is 0. To reset the value of a counter to 0 again, you can call resetCounter.
See decCounter for a method which decrements the value of a named counter instead of incrementing it.
- Parameters:
level- The log level of this method callname- The name of the counter to log
-
decCounter
public void decCounter(String name)
Overloaded. Decrements a named counter by one and automatically sends its name and value as integer watch with the default log level.The Session class tracks a list of so called named counters. A counter has a name and a value of type integer. This method decrements the value for the specified counter by one and then sends a normal integer watch with the name and value of the counter. The initial value of a counter is 0. To reset the value of a counter to 0 again, you can call resetCounter.
This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.
See incCounter for a method which increments the value of a named counter instead of decrementing it.
- Parameters:
name- The name of the counter to log
-
decCounter
public void decCounter(Level level, String name)
Overloaded. Decrements a named counter by one and automatically sends its name and value as integer watch with a custom log level.The Session class tracks a list of so called named counters. A counter has a name and a value of type integer. This method decrements the value for the specified counter by one and then sends a normal integer watch with the name and value of the counter. The initial value of a counter is 0. To reset the value of a counter to 0 again, you can call resetCounter.
See incCounter for a method which increments the value of a named counter instead of decrementing it.
- Parameters:
level- The log level of this method callname- The name of the counter to log
-
resetCounter
public void resetCounter(String name)
Resets a named counter to its initial value of 0. This method resets the integer value of a named counter to 0 again. If the supplied counter is unknown, this method has no effect. Please refer to the incCounter and decCounter methods for more information about named counters.- Parameters:
name- The name of the counter to reset
-
watchChar
public void watchChar(String name, char value)
Logs a char Watch with the default log level.This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.
- Parameters:
name- The name of the Watchvalue- The value to display as Watch value- See Also:
Watch
-
watchChar
public void watchChar(Level level, String name, char value)
Overloaded. Logs a char Watch with a custom log level.- Parameters:
level- The log level of this method callname- The name of the Watchvalue- The value to display as Watch value- See Also:
Watch
-
watchString
public void watchString(String name, String value)
Overloaded. Logs a String Watch with the default log level.This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.
- Parameters:
name- The name of the Watchvalue- The value to display as Watch value- See Also:
Watch
-
watchString
public void watchString(Level level, String name, String value)
Overloaded. Logs a String Watch with a custom log level.- Parameters:
level- The log level of this method callname- The name of the Watchvalue- The value to display as Watch value- See Also:
Watch
-
watchByte
public void watchByte(String name, byte value)
Overloaded. Logs a byte Watch with the default log level.This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.
- Parameters:
name- The name of the Watchvalue- The value to display as Watch value- See Also:
Watch
-
watchByte
public void watchByte(Level level, String name, byte value)
Overloaded. Logs a byte Watch with a custom log level.- Parameters:
level- The log level of this method callname- The name of the Watchvalue- The value to display as Watch value- See Also:
Watch
-
watchByte
public void watchByte(String name, byte value, boolean includeHex)
Overloaded. Logs a byte Watch with an optional hexadecimal representation and default log level.This method logs a byte Watch. You can specify if a hexadecimal representation should be included as well by setting the includeHex parameter to true.
This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.
- Parameters:
name- The name of the Watchvalue- The value to display as Watch valueincludeHex- Indicates if a hexadecimal representation should be included- See Also:
Watch
-
watchByte
public void watchByte(Level level, String name, byte value, boolean includeHex)
Overloaded. Logs a byte Watch with an optional hexadecimal representation and custom log level.This method logs a byte Watch. You can specify if a hexadecimal representation should be included as well by setting the includeHex parameter to true.
- Parameters:
level- The log level of this method callname- The name of the Watchvalue- The value to display as Watch valueincludeHex- Indicates if a hexadecimal representation should be included- See Also:
Watch
-
watchShort
public void watchShort(String name, short value)
Overloaded. Logs a short integer Watch with the default log level. This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.- Parameters:
name- The name of the Watchvalue- The value to display as Watch value- See Also:
Watch
-
watchShort
public void watchShort(Level level, String name, short value)
Overloaded. Logs a short integer Watch with a custom log level.- Parameters:
level- The log level of this method callname- The name of the Watchvalue- The value to display as Watch value- See Also:
Watch
-
watchShort
public void watchShort(String name, short value, boolean includeHex)
Overloaded. Logs a short integer Watch with an optional hexadecimal representation and default log level.This method logs a short integer Watch. You can specify if a hexadecimal representation should be included as well by setting the includeHex parameter to true.
This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.
- Parameters:
name- The name of the Watchvalue- The value to display as Watch valueincludeHex- Indicates if a hexadecimal representation should be included- See Also:
Watch
-
watchShort
public void watchShort(Level level, String name, short value, boolean includeHex)
Overloaded. Logs a short integer Watch with an optional hexadecimal representation and custom log level.This method logs a short integer Watch. You can specify if a hexadecimal representation should be included as well by setting the includeHex parameter to true.
- Parameters:
level- The log level of this method callname- The name of the Watchvalue- The value to display as Watch valueincludeHex- Indicates if a hexadecimal representation should be included- See Also:
Watch
-
watchInt
public void watchInt(String name, int value)
Overloaded method. This method logs an integer Watch with the default log level.This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.
- Parameters:
name- The name of the Watchvalue- The value to display as Watch value- See Also:
Watch
-
watchInt
public void watchInt(Level level, String name, int value)
Overloaded. Logs an integer Watch with a custom log level.- Parameters:
level- The log level of this method callname- The name of the Watchvalue- The value to display as Watch value- See Also:
Watch
-
watchInt
public void watchInt(String name, int value, boolean includeHex)
Overloaded. Logs an integer Watch with an optional hexadecimal representation and default log level.This method logs an integer Watch. You can specify if a hexadecimal representation should be included as well by setting the includeHex parameter to true.
This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.
- Parameters:
name- The name of the Watchvalue- The value to display as Watch valueincludeHex- Indicates if a hexadecimal representation should be included- See Also:
Watch
-
watchInt
public void watchInt(Level level, String name, int value, boolean includeHex)
Logs an integer Watch with an optional hexadecimal representation and custom log level. This method logs an integer Watch. You can specify if a hexadecimal representation should be included as well by setting the includeHex parameter to true.- Parameters:
level- The log level of this method callname- The name of the Watchvalue- The value to display as Watch valueincludeHex- Indicates if a hexadecimal representation should be included- See Also:
Watch
-
watchLong
public void watchLong(String name, long value)
Overloaded. Logs a long integer Watch with the default log level. This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.- Parameters:
name- The name of the Watchvalue- The value to display as Watch value- See Also:
Watch
-
watchLong
public void watchLong(Level level, String name, long value)
Overloaded. Logs a long integer Watch with a custom log level.- Parameters:
level- The log level of this method callname- The name of the Watchvalue- The value to display as Watch value- See Also:
Watch
-
watchLong
public void watchLong(String name, long value, boolean includeHex)
Overloaded method. Logs a long integer Watch with an optional hexadecimal representation and default log level.This method logs a long integer Watch. You can specify if a hexadecimal representation should be included as well by setting the includeHex parameter to true.
This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.
- Parameters:
name- The name of the Watchvalue- The value to display as Watch valueincludeHex- Indicates if a hexadecimal representation should be included- See Also:
Watch
-
watchLong
public void watchLong(Level level, String name, long value, boolean includeHex)
Overloaded. Logs a long integer Watch with an optional hexadecimal representation and custom log level. This method logs a long integer Watch. You can specify if a hexadecimal representation should be included as well by setting the includeHex parameter to true.- Parameters:
level- The log level of this method callname- The name of the Watchvalue- The value to display as Watch valueincludeHex- Indicates if a hexadecimal representation should be included.- See Also:
Watch
-
watchFloat
public void watchFloat(String name, float value)
Overloaded. Logs a float Watch with the default log level.This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.
- Parameters:
name- The name of the Watchvalue- The value to display as Watch value- See Also:
Watch
-
watchFloat
public void watchFloat(Level level, String name, float value)
Overloaded. Logs a float Watch with a custom log level.- Parameters:
level- The log level of this method callname- The name of the Watchvalue- The value to display as Watch value- See Also:
Watch
-
watchDouble
public void watchDouble(String name, double value)
Logs a double Watch with the default log level. This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.- Parameters:
name- The name of the Watchvalue- The value to display as Watch value- See Also:
Watch
-
watchDouble
public void watchDouble(Level level, String name, double value)
Logs a double Watch with a custom log level.- Parameters:
level- The log level of this method callname- The name of the Watchvalue- The value to display as Watch value- See Also:
Watch
-
watchBoolean
public void watchBoolean(String name, boolean value)
Logs a boolean Watch with the default log level.This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.
- Parameters:
name- The name of the Watchvalue- The value to display as Watch value- See Also:
Watch
-
watchBoolean
public void watchBoolean(Level level, String name, boolean value)
Overloaded. Logs a boolean Watch with a custom log level.- Parameters:
level- The log level of this method callname- The name of the Watchvalue- The value to display as Watch value- See Also:
Watch
-
watchDate
public void watchDate(String name, Date value)
Overloaded. Logs a Date Watch with the default log level. This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.- Parameters:
name- The name of the Watchvalue- The value to display as Watch value- See Also:
Watch
-
watchDate
public void watchDate(Level level, String name, Date value)
Overloaded. Logs a Date Watch with a custom log level.- Parameters:
level- The log level of this method callname- The name of the Watchvalue- The value to display as Watch value- See Also:
Watch
-
watchObject
public void watchObject(String name, Object value)
Overloaded. Logs an Object Watch with the default log level. The value of the resulting Watch is the return value of the toString method of the supplied Object.This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.
- Parameters:
name- The name of the Watchvalue- The value to display as Watch value- See Also:
Watch
-
watchObject
public void watchObject(Level level, String name, Object value)
Overloaded. Logs an Object Watch with a custom log level. The value of the resulting Watch is the return value of the toString method of the supplied Object.- Parameters:
level- The log level of this method callname- The name of the Watchvalue- The value to display as Watch value- See Also:
Watch
-
watch
public void watch(String name, char value)
Overloaded. Logs a char Watch with the default log level.This method just calls the watchChar method.
This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.
- Parameters:
name- The name of the Watchvalue- The char value to display as Watch value
-
watch
public void watch(Level level, String name, char value)
Overloaded. Logs a char Watch with a custom log level.This method just calls the watchChar method.
- Parameters:
level- The log level of this method callname- The name of the Watchvalue- The char value to display as Watch value
-
watch
public void watch(String name, String value)
Overloaded. Logs a String Watch with the default log level. This method just calls the watchString method. This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.- Parameters:
name- The name of the Watchvalue- The string value to display as Watch value
-
watch
public void watch(Level level, String name, String value)
Overloaded. Logs a String Watch with a custom log level. This method just calls the watchString method.- Parameters:
level- The log level of this method callname- The name of the Watchvalue- The string value to display as Watch value
-
watch
public void watch(String name, byte value)
This method just calls the watchByte method. Uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.Overloaded. Logs a byte watch with the default log level.
- Parameters:
name- The name of the watchvalue- The byte value to display as watch value
-
watch
public void watch(Level level, String name, byte value)
Overloaded. Logs a byte Watch with a custom level. This method just calls the watchByte method.- Parameters:
level- The log level of this method callname- The name of the Watchvalue- The byte value to display as Watch value
-
watch
public void watch(String name, short value)
Overloaded. Logs a short integer Watch with the default log level. This method just calls the watchShort method. This method uses theSmartInspect.setDefaultLevel(com.gurock.smartinspect.Level)of the session'sgetParent()as log level. For more information, please refer to the documentation of theSmartInspect.setDefaultLevel(com.gurock.smartinspect.Level)method of the SmartInspect class.- Parameters:
name- The name of the Watch.value- The short integer value to display as Watch value.
-
watch
public void watch(Level level, String name, short value)
Overloaded. Logs a short integer Watch with a custom log level. This method just calls the watchShort method.- Parameters:
level- The log level of this method callname- The name of the Watchvalue- The short integer value to display as Watch value
-
watch
public void watch(String name, int value)
Overloaded method that logs an integer Watch with the default log level. This method just calls the watchInt method. The method uses the default level of the session's parent as the log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.- Parameters:
name- The name of the Watchvalue- The integer value to display as Watch value
-
watch
public void watch(Level level, String name, int value)
Overloaded. Logs an integer Watch with a custom log level. This method just calls the watchInt method.- Parameters:
level- The log level of this method callname- The name of the Watchvalue- The integer value to display as Watch value
-
watch
public void watch(String name, long value)
Overloaded. Logs a long integer Watch with the default log level. This method just calls the watchLong method. This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.- Parameters:
name- The name of the Watchvalue- The long integer value to display as Watch value
-
watch
public void watch(Level level, String name, long value)
Overloaded. Logs a long integer Watch with a custom log level.This method just calls the watchLong method.
- Parameters:
level- The log level of this method callname- The name of the Watchvalue- The long integer value to display as Watch value
-
watch
public void watch(String name, float value)
Overloaded. Logs a float Watch with the default log level. This method just calls the watchFloat method.This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.
- Parameters:
name- The name of the Watchvalue- The float value to display as Watch value
-
watch
public void watch(Level level, String name, float value)
Overloaded. Logs a float Watch with a custom log level.This method just calls the watchFloat method.
- Parameters:
level- The log level of this method callname- The name of the Watchvalue- The float value to display as Watch value
-
watch
public void watch(String name, double value)
Overloaded. Logs a double Watch with the default log level. This method just calls the watchDouble method. This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.- Parameters:
name- The name of the Watchvalue- The double value to display as Watch value
-
watch
public void watch(Level level, String name, double value)
Logs a double Watch with a custom log level. This method just calls the watchDouble method.- Parameters:
level- The log level of this method callname- The name of the Watchvalue- The double value to display as Watch value
-
watch
public void watch(String name, boolean value)
Overloaded. Logs a boolean Watch with the default log level.This method just calls the watchBoolean method. This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.
- Parameters:
name- The name of the Watchvalue- The boolean value to display as Watch value
-
watch
public void watch(Level level, String name, boolean value)
Overloaded. Logs a boolean Watch with a custom log level. This method just calls the watchBoolean method.- Parameters:
level- The log level of this method callname- The name of the Watchvalue- The boolean value to display as Watch value
-
watch
public void watch(String name, Date value)
Overloaded. Logs a Date Watch with the default log level.This method just calls the watchDate method.
This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.
- Parameters:
name- The name of the Watchvalue- The Date value to display as Watch value
-
watch
public void watch(Level level, String name, Date value)
Overloaded. Logs a Date Watch with a custom log level. This method just calls the watchDate method.- Parameters:
level- The log level of this method callname- The name of the Watchvalue- The Date value to display as Watch value
-
watch
public void watch(String name, Object value)
Overloaded. Logs an Object Watch with the default log level. This method just calls the watchObject method. This method uses theSmartInspect.setDefaultLevel(com.gurock.smartinspect.Level)of the session'sgetParent()as log level. For more information, please refer to the documentation of theSmartInspect.setDefaultLevel(com.gurock.smartinspect.Level)method of the SmartInspect class.- Parameters:
name- The name of the Watchvalue- The Object value to display as Watch value
-
watch
public void watch(Level level, String name, Object value)
Overloaded. Logs an Object Watch with a custom log level. This method just calls the watchObject method.- Parameters:
level- The log level of this method callname- The name of the Watchvalue- The Object value to display as Watch value
-
sendCustomLogEntry
public void sendCustomLogEntry(String title, LogEntryType lt, ViewerId vi, byte[] data)
Overloaded. Logs a custom Log Entry with the default log level. This method is useful for implementing custom Log Entry methods. For example, if you want to display some information in a particular way in the Console, you can just create a simple method which formats the data in question correctly and sends them using this sendCustomLogEntry method.This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.
- Parameters:
title- The title of the new Log Entrylt- The Log Entry type to usevi- The Viewer ID to usedata- Optional data block which can be null- See Also:
LogEntry
-
sendCustomLogEntry
public void sendCustomLogEntry(Level level, String title, LogEntryType lt, ViewerId vi, byte[] data)
Overloaded. Logs a custom Log Entry with a custom log level. This method is useful for implementing custom Log Entry methods. For example, if you want to display some information in a particular way in the Console, you can just create a simple method which formats the data in question correctly and sends them using this sendCustomLogEntry method.- Parameters:
level- The log level of this method calltitle- The title of the new Log Entrylt- The Log Entry type to usevi- The Viewer ID to usedata- Optional data block which can be null- See Also:
LogEntry
-
sendCustomControlCommand
public void sendCustomControlCommand(ControlCommandType ct, byte[] data)
Overloaded. Logs a custom Control Command with the default log level. This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.- Parameters:
ct- The Control Command type to usedata- Optional data block which can be null- See Also:
ControlCommand
-
sendCustomControlCommand
public void sendCustomControlCommand(Level level, ControlCommandType ct, byte[] data)
Overloaded. Logs a custom Control Command with a custom log level.- Parameters:
level- The log level of this method callct- The Control Command type to usedata- Optional data block which can be null- See Also:
ControlCommand
-
sendCustomWatch
public void sendCustomWatch(String name, String value, WatchType wt)
Overloaded. Logs a custom Watch with the default log level. This method is useful for implementing custom Watch methods. For example, if you want to track the status of an instance of a specific class, you can just create a simple method which extracts all necessary information about this instance and logs them using this sendCustomWatch method. This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the setDefaultLevel method of the SmartInspect class.- Parameters:
name- The name of the new Watchvalue- The value of the new Watchwt- The Watch type to use- See Also:
Watch
-
sendCustomWatch
public void sendCustomWatch(Level level, String name, String value, WatchType wt)
Overloaded method. Logs a custom Watch with a custom log level. This method is useful for implementing custom Watch methods. For example, if you want to track the status of an instance of a specific class, you can just create a simple method which extracts all necessary information about this instance and logs them using this sendCustomWatch method.- Parameters:
level- The log level of this method callname- The name of the new Watchvalue- The value of the new Watchwt- The Watch type to use- See Also:
Watch
-
sendCustomProcessFlow
public void sendCustomProcessFlow(String title, ProcessFlowType pt)
Overloaded. Logs a custom Process Flow entry with the default log level.This method uses the default level of the session's parent as log level. For more information, please refer to the documentation of the
SmartInspect.setDefaultLevel(com.gurock.smartinspect.Level)method of the SmartInspect class.- Parameters:
title- The title of the new Process Flow entry.pt- The Process Flow type to use.- See Also:
ProcessFlow
-
sendCustomProcessFlow
public void sendCustomProcessFlow(Level level, String title, ProcessFlowType pt)
Overloaded. Logs a custom Process Flow entry with a custom log level.- Parameters:
level- Log leveltitle- The title of the new Process Flow entrypt- The Process Flow type to use- See Also:
ProcessFlow
-
-