com.madara.logger

Class Logger

java.lang.Object

com.madara.MadaraJNI

com.madara.logger.Logger

public class Logger
extends MadaraJNI

An extensible logger used for printing to files, terminals and system logs

Constructor Summary

Constructors

Constructor and Description
Logger() Default constructor

Method Summary

Modifier and Type	Method and Description
void	addFile(java.lang.String filename) Adds a file to logging outputs
void	addSyslog() Adds the system logger to logging outputs
void	addTerm() Adds the terminal to logging outputs (turned on by default)
void	clear() Clears all logging targets
protected void	finalize() Cleans up underlying C resources
void	free() Deletes the C instantiation.
static Logger	fromPointer(long cptr) Creates a java object instance from a C/C++ pointer
static Logger	fromPointer(long cptr, boolean shouldManage) Creates a java object instance from a C/C++ pointer
int	getLevel() Gets the logging level, e.g., where 0 is EMERGENCY and 6 is DETAILED
java.lang.String	getTag() Gets the tag used in system logging
void	log(int level, java.lang.String message) Logs a message at the specified level
void	setLevel(int level) Sets the logging level
void	setTag(java.lang.String tag) Sets the tag used for system logging
void	setTimestampFormat(java.lang.String format) Sets timestamp format.

Methods inherited from class com.madara.MadaraJNI

getCPtr, setCPtr, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

Logger

public Logger()

Default constructor

Method Detail

fromPointer

public static Logger fromPointer(long cptr)

Creates a java object instance from a C/C++ pointer

Parameters:

cptr - C pointer to the object

Returns:

a new java instance of the underlying pointer

fromPointer

public static Logger fromPointer(long cptr,
                                 boolean shouldManage)

Creates a java object instance from a C/C++ pointer

Parameters:

cptr - C pointer to the object

shouldManage - if true, manage the pointer

Returns:

a new java instance of the underlying pointer

getTag

public java.lang.String getTag()

Gets the tag used in system logging

Returns:

current tag for system logging

getLevel

public int getLevel()

Gets the logging level, e.g., where 0 is EMERGENCY and 6 is DETAILED

Returns:

the current logging level

setTag

public void setTag(java.lang.String tag)

Sets the tag used for system logging

Parameters:

tag - the tag to be used for system logging

setLevel

public void setLevel(int level)

Sets the logging level

Parameters:

level - level of message severity to print to log targets

clear

public void clear()

Clears all logging targets

addTerm

public void addTerm()

Adds the terminal to logging outputs (turned on by default)

addSyslog

public void addSyslog()

Adds the system logger to logging outputs

addFile

public void addFile(java.lang.String filename)

Adds a file to logging outputs

Parameters:

filename - the name of a file to add to logging targets

log

public void log(int level,
                java.lang.String message)

Logs a message at the specified level

Parameters:

level - the logging severity level (0 is high)

message - the message to send to all logging targets

setTimestampFormat

public void setTimestampFormat(java.lang.String format)

Sets timestamp format. Uses strftime for formatting time.

Parameters:

format - the format of the timestamp. See C++ strftime definition for common usage.

free

public void free()

Deletes the C instantiation. To prevent memory leaks, this must be called before an instance gets garbage collected

finalize

protected void finalize()
                 throws java.lang.Throwable

Cleans up underlying C resources

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable - necessary for override but unused