Class Log

java.lang.Object
  |
  +--Log

public class Log

extends java.lang.Object

A general 'logger' or 'tracer' class that logs data into a file.

• It is static so it can be called from any directory provided that it is in a specified classpath.
• This logger will append to a file that already exists, otherwise, it will create a new file to write to. *
• The first line written will always be the time of the current log was opened.
• For the lazy programmers, you can use Log.log(Object o) to simply log to the last stream opened, otherwise, you can specify the log to write to.
• This logger is different in that it allows for loggers to create many different logs under simple names, and write to any of them quickly.
• It is particularly useful for debugging complex programs.
• On the other hand, if you are running many (millions) of computations, I would recommend keeping this logger out of time complex loops, it will inevitably slow the program down.
• Lastly, if you need to write a other data types into the logs, feel free to extend/override this program, or email me and I will include it in future releases.
• Remember to close the log (Log.close()) after writing, or the logs will not be written.

Here is a sample of it's usage:

public class LogTest {
        public LogTest() {
                Log.open("c:\project\ErrorStream.log", "err");
                Log.open("c:\project\StandardStream.log", "std");
                Log.open("c:\prod.output", "out");
                this.testLog();
                Log.close("err");
                Log.close();
        }

        public void testLog() {
                Log.log("err", "This is an error Test.", false);
                Log.log("std", "This is a standard test.");
                Log.log("This will also output to standard since it was last opened and written to.");
                Log.log("out", "This is to output.");
                Log.log("Now this will write to the out stream.");
        }
}
 

Field Summary

static java.lang.String	lastStream Stores the last open stream for quick logging.
static java.util.Map	openFiles Map of all open streams.

Constructor Summary

Log()

Method Summary

static void	close() Closes the iostream for a all log files.
static void	close(java.lang.String name) Closes the iostream for a specific log file.
static boolean	log(java.lang.Object input) Lazy man's log method, logs to the last open stream, new line by default.
static boolean	log(java.lang.String name, java.lang.Object input) Default log method, creates new line for each input.
static boolean	log(java.lang.String name, java.lang.Object input, boolean nl) Logs input into file only if it is open.
static void	open(java.lang.String file, java.lang.String name) Opens a file to write into.

Methods inherited from class java.lang.Object

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

Field Detail

openFiles

public static java.util.Map openFiles

Map of all open streams.

lastStream

public static java.lang.String lastStream

Stores the last open stream for quick logging.

Constructor Detail

Log

public Log()

Method Detail

open

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

Opens a file to write into.

Parameters:

file - the actualy path of the file that this log will write to.

name - the simple name that this specific log will be referenced by.

log

public static boolean log(java.lang.String name,
                          java.lang.Object input,
                          boolean nl)

Logs input into file only if it is open. Sets the current stream to that of name.

Parameters:

name - the name of a file stream to log to.

input - the object input to log.

nl - whether to write a 'new line' to end of line or not.

Returns:

whether the log was successful or not. The only occurance that will cause the logger to return false is if the log ('name') has not been opened before hand.

log

public static boolean log(java.lang.String name,
                          java.lang.Object input)

Default log method, creates new line for each input. Sets the current stream to that of name.

Parameters:

name - the name of a file stream to log to.

input - the object input to log.

Returns:

whether the log was successful or not. The only occurance that will cause the logger to return false is if the log ('name') has not been opened before hand.

log

public static boolean log(java.lang.Object input)

Lazy man's log method, logs to the last open stream, new line by default.

close

public static void close()

Closes the iostream for a all log files.

close

public static void close(java.lang.String name)

Closes the iostream for a specific log file.

Parameters:

name - the name of the log to close.