io.humble.ferry

Class Logger

java.lang.Object

io.humble.ferry.Logger

public class Logger
extends Object

Internal Only

C++ wrapper to SLF4J Java Logging frame work.

If not running inside a JVM, then this class
just does a rudimentary printout of log messages
to stderr.

Otherwise, it forwards to Java's SLF4J logging framework.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Logger.Level Different logging levels (noiseness) supported by us.

Method Summary

Modifier and Type	Method and Description
boolean	debug(String filename, int lineNo, String format)
void	delete() Releases any underlying native memory and marks this object as invalid.
boolean	equals(Object obj) Compares two values, returning true if the underlying objects in native code are the same object.
boolean	error(String filename, int lineNo, String format)
static Logger	getLogger(String aLoggerName) Returns a new Logger object for this loggerName.
String	getName()
static Logger	getStaticLogger(String aLoggerName) Get a Logger object, but ask the Logger code to free it up once the JavaVM shuts down.
int	hashCode() Get a hashable value for this object.
boolean	info(String filename, int lineNo, String format)
static boolean	isGlobalLogging(Logger.Level level)
boolean	isLogging(Logger.Level level)
boolean	isPrintStackTrace()
boolean	log(String filename, int lineNo, Logger.Level level, String format) Log the message to the logger, using sprintf() format strings.
static void	setGlobalIsLogging(Logger.Level level, boolean value)
void	setIsLogging(Logger.Level level, boolean value)
void	setPrintStackTrace(boolean value)
boolean	trace(String filename, int lineNo, String format)
boolean	warn(String filename, int lineNo, String format)

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Method Detail

equals

public boolean equals(Object obj)

Compares two values, returning true if the underlying objects in native code are the same object. That means you can have two different Java objects, but when you do a comparison, you'll find out they are the EXACT same object.

Overrides:

equals in class Object

Returns:

True if the underlying native object is the same. False otherwise.

hashCode

public int hashCode()

Get a hashable value for this object.

Overrides:

hashCode in class Object

Returns:

the hashable value.

delete

public void delete()

Releases any underlying native memory and marks this object as invalid.

Normally Ferry manages when to release native memory.

In the unlikely event you want to control EXACTLY when a native object is released, each Humble object has a delete() method that you can use. Once you call delete(), you must ENSURE your object is never referenced again from that Java object -- Ferry tries to help you avoid crashes if you accidentally use an object after deletion but on this but we cannot offer 100% protection (specifically if another thread is accessing that object EXACTLY when you delete() it).

getLogger

public static Logger getLogger(String aLoggerName)

Returns a new Logger object for this loggerName.

Parameters:

aLoggerName - A name (no spaces allowed) for this logger.

Returns:

a New logger for logging; caller must delete when done.

getStaticLogger

public static Logger getStaticLogger(String aLoggerName)

Get a Logger object, but ask the Logger code to
free it up once the JavaVM shuts down. Use at your
own risk.

Parameters:

aLoggerName - A name (no spaces allowed) for this logger.

Returns:

A new logger for logging; caller must not call delete
and must not use the logger once the JavaVM (or main) has exited.

log

public boolean log(String filename,
                   int lineNo,
                   Logger.Level level,
                   String format)

Log the message to the logger, using sprintf() format
strings.

Parameters:

filename - The filename that is logging, or NULL.

lineNo - The line number where this log statement is executed from.
or 0.

level - Level to log at.

format - A format specification string, in sprintf format.

Returns:

if the message was actually logged.

error

public boolean error(String filename,
                     int lineNo,
                     String format)

warn

public boolean warn(String filename,
                    int lineNo,
                    String format)

info

public boolean info(String filename,
                    int lineNo,
                    String format)

debug

public boolean debug(String filename,
                     int lineNo,
                     String format)

trace

public boolean trace(String filename,
                     int lineNo,
                     String format)

isPrintStackTrace

public boolean isPrintStackTrace()

setPrintStackTrace

public void setPrintStackTrace(boolean value)

isLogging

public boolean isLogging(Logger.Level level)

setIsLogging

public void setIsLogging(Logger.Level level,
                         boolean value)

isGlobalLogging

public static boolean isGlobalLogging(Logger.Level level)

setGlobalIsLogging

public static void setGlobalIsLogging(Logger.Level level,
                                      boolean value)

getName

public String getName()