org.zoolu.util

Class LogRotationWriter

java.lang.Object

org.zoolu.util.LogWriter

org.zoolu.util.LogRotationWriter

All Implemented Interfaces:

Logger

public class LogRotationWriter
extends LogWriter

It extends LogWriter providing rotation of the log file.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DAY Day
static int	HOUR Hour
static int	MINUTE Minute
static int	MONTH Month

Fields inherited from class org.zoolu.util.LogWriter

DEFAULT_MAX_SIZE, out

Constructor Summary

Constructors

Constructor and Description
LogRotationWriter(java.lang.String file_name, LogLevel verbose_level, long max_size, int num_rotations, int time_scale, int time_value) Creates a new LogRotationWriter.
LogRotationWriter(java.lang.String file_name, LogLevel verbose_level, long max_size, int num_rotations, int time_scale, int time_value, boolean append) Creates a new LogRotationWriter.

Method Summary

Modifier and Type	Method and Description
LogRotationWriter	rotate() Rotates logs.
void	write(java.lang.String str) Writes a string onto the inner writer.

Methods inherited from class org.zoolu.util.LogWriter

close, getLoggingLevel, log, log, log, reset, setLoggingLevel, setTimestamp

Methods inherited from class java.lang.Object

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

Field Detail

MONTH

public static final int MONTH

Month

See Also:

Constant Field Values

DAY

public static final int DAY

Day

See Also:

Constant Field Values

HOUR

public static final int HOUR

Hour

See Also:

Constant Field Values

MINUTE

public static final int MINUTE

Minute

See Also:

Constant Field Values

Constructor Detail

LogRotationWriter

public LogRotationWriter(java.lang.String file_name,
                         LogLevel verbose_level,
                         long max_size,
                         int num_rotations,
                         int time_scale,
                         int time_value)

Creates a new LogRotationWriter.

Parameters:

file_name - the file where log messages are written to

verbose_level - the verbose level

max_size - the maximum size for the log, that is the maximum number of characters that can be written

num_rotations - the number of log file rotations (value 0 means no rotation)

time_scale - the time scale (MONTH, DAY, HOUR, or MINUTE)

time_value - the time value when log files are rotated (actual time = time_scale * time_value)

LogRotationWriter

public LogRotationWriter(java.lang.String file_name,
                         LogLevel verbose_level,
                         long max_size,
                         int num_rotations,
                         int time_scale,
                         int time_value,
                         boolean append)

Creates a new LogRotationWriter.

Parameters:

file_name - the file where log messages are written to

verbose_level - the verbose level

max_size - the maximum size for the log, that is the maximum number of characters that can be written

num_rotations - the number of log file rotations (value 0 means no rotation)

time_scale - the time scale (MONTH, DAY, HOUR, or MINUTE)

time_value - the time value when log files are rotated (actual time = time_scale * time_value)

append - if true, it opens the existing log file in 'append' mode, without rewritting the previously saved content

Method Detail

rotate

public LogRotationWriter rotate()

Rotates logs.

write

public void write(java.lang.String str)

Writes a string onto the inner writer.

Overrides:

write in class LogWriter

Parameters:

str - the string to be written