rioko.utilities

Class Log

java.lang.Object

rioko.utilities.Log

public final class Log
extends java.lang.Object

Static Log class to have an structured and readable text from an execution.

Author:

Antonio

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	isReady Flag to know if the Log has been activated

Constructor Summary

Constructors

Constructor and Description
Log()

Method Summary

Modifier and Type	Method and Description
static void	close() Method to close the Log system.
static void	exception(java.lang.Exception e) Method that prints in the Exception Log File the Stack Trace of an Exception.
static void	open() Open the Log files.
static void	open(java.lang.String XMLpath, java.lang.String ExceptionPath) OPen the Log files using the given paths to save them.
static void	print(java.lang.String string) Method to print a message in the Log System.
static void	sPrint(java.lang.String string) Method to print a message in the System Terminal
static void	xClose(java.lang.String label) Method that close a node of the XML Log file.
static void	xOpen(java.lang.String label) Method that open a new node of the XML Log file.
static void	xPrint(java.lang.String string) Method to print a message in the XML Log File

Methods inherited from class java.lang.Object

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

Field Detail

isReady

public static boolean isReady

Flag to know if the Log has been activated

Constructor Detail

Log

public Log()

Method Detail

open

public static void open()

Open the Log files. Use the .metadata/plugins/ folder to save them creating a new folder for this plugin if it does not exists.

open

public static void open(java.lang.String XMLpath,
                        java.lang.String ExceptionPath)

OPen the Log files using the given paths to save them.

Parameters:

XMLpath - Path where save the XML Log File

ExceptionPath - Path where save the Exception Log File

close

public static void close()

Method to close the Log system.

sPrint

public static void sPrint(java.lang.String string)

Method to print a message in the System Terminal

Parameters:

string - Message to print.

xPrint

public static void xPrint(java.lang.String string)

Method to print a message in the XML Log File

Parameters:

string - Message to print

xOpen

public static void xOpen(java.lang.String label)

Method that open a new node of the XML Log file.

Parameters:

label - Name of the node to be opened.

xClose

public static void xClose(java.lang.String label)

Method that close a node of the XML Log file.

Parameters:

label - Name of the node to be closed.

exception

public static void exception(java.lang.Exception e)

Method that prints in the Exception Log File the Stack Trace of an Exception.

Parameters:

e - Exception to be printed.

print

public static void print(java.lang.String string)

Method to print a message in the Log System. This generic method prints the message in both Terminal and XML Logs, using the methods sPrint(String) and xPrint(String).

Parameters:

string - Message to print in the Log system.