agilermi.utility.logging

Interface RMILogger

All Superinterfaces:

Remote

public interface RMILogger
extends Remote

This class defines a simple logger whose references can be sent over RMI streams, when automatic referencing is enabled. A Logger instance will remain on the machine that created it and its references can be sent to other connected machines. If the original logger is not reachable a log operation does not throw RemoteException and the logging operation will have no effects.

Author:

Salvatore Giampa'

Method Summary

Modifier and Type	Method and Description
static RMILogger	get(java.lang.Class<?> cls) Creates a Logger using the name of the specified class
static RMILogger	get(java.lang.Class<?> cls, java.io.PrintStream printStream) Creates a Logger using the name of the specified class and the given PrintStream on which the logger must print.
static RMILogger	get(java.lang.String name) Creates a Logger using the specified name
static RMILogger	get(java.lang.String name, java.io.PrintStream printStream) Creates a Logger using the specified name and the given PrintStream on which the logger must print.
void	log(java.lang.String format, java.lang.Object... objects) Logs a string using the specified format and composed by the specified objects.
void	logIf(boolean condition, java.lang.String format, java.lang.Object... objects) As log(String, Object...) logs a string.

Method Detail

get

static RMILogger get(java.lang.String name,
                     java.io.PrintStream printStream)

Creates a Logger using the specified name and the given PrintStream on which the logger must print.

Parameters:

name - the name of this logger that will be printed aside each log string

printStream - the PrintStream to log to

Returns:

a new instance of RMILogger

get

static RMILogger get(java.lang.Class<?> cls,
                     java.io.PrintStream printStream)

Creates a Logger using the name of the specified class and the given PrintStream on which the logger must print.

Parameters:

cls - the class whose name is used as logger name that will be printed aside each log string

printStream - the PrintStream to log to

Returns:

a new instance of RMILogger

get

static RMILogger get(java.lang.String name)

Creates a Logger using the specified name

Parameters:

name - the name of this logger that will be printed aside each log string

Returns:

a new instance of RMILogger

get

static RMILogger get(java.lang.Class<?> cls)

Creates a Logger using the name of the specified class

Parameters:

cls - the class whose name is used as logger name that will be printed aside each log string

Returns:

a new instance of RMILogger

log

void log(java.lang.String format,
         java.lang.Object... objects)

Logs a string using the specified format and composed by the specified objects.

Parameters:

format - the format of the log string

objects - the objects that are printed in the formatted string

logIf

void logIf(boolean condition,
           java.lang.String format,
           java.lang.Object... objects)

As log(String, Object...) logs a string. The string is logged if and only if the specified condition is true.

Parameters:

condition - set to true to log the string or set to false to have no effects

format - the format of the log string

objects - the objects that are printed in the formatted string