ra.util.logging

Class LogRecord

java.lang.Object

ra.util.logging.LogRecord

public class LogRecord
extends java.lang.Object

Create a file which be used to write Log. the following action: Keep the file I/O connection and will not close the file I/O connection when writing log into a file, after creating the Log file by earmark file name.

Author:

Ray Li

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	LogRecord.OnNotEnoughSpaceListener It will be called on, when has not enough storage space remaining.

Constructor Summary

Constructors

Constructor and Description
LogRecord() Initialize.

Method Summary

Modifier and Type	Method and Description
void	close() Close the Log file.
void	disenableDateFormat() Disenable add the head (Date-time information) when write log into Log file.
void	enableDateFormat() Enable add the head(Date-time information) when write log into Log file.
java.io.File	getLogFile() Returns the file name of the log file.
java.io.File	getLogFileFolder() Returns log file.
boolean	hasRemaining() Can it write in, after checking the storage space remaining?.
boolean	init(java.lang.String folderPath, java.lang.String fileName, java.lang.String charset) initialize.
void	setCompressionMode(CompressionMode mode) Setting the Compression Mode on a real-time saves Log.
void	setMaxFileSize(long space, SpaceUnit unit) Setting the limit size of Log file.
void	setOnNotEnoughSpaceListener(LogRecord.OnNotEnoughSpaceListener listener) Register listener to receive events when not enough space.
void	setSimpleDateFormat(java.lang.String format) The Date format style of write log into Log file.
void	write(java.lang.String str) Will not have text wraps automatically when write the log into file.
void	writeln(java.lang.String str) Will have text wraps automatically when write the log into file.

Methods inherited from class java.lang.Object

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

Constructor Detail

LogRecord

public LogRecord()

Initialize.

Method Detail

setOnNotEnoughSpaceListener

public void setOnNotEnoughSpaceListener(LogRecord.OnNotEnoughSpaceListener listener)

Register listener to receive events when not enough space.

Parameters:

listener - listener

setSimpleDateFormat

public void setSimpleDateFormat(java.lang.String format)

The Date format style of write log into Log file.

Parameters:

format - The Date format style

enableDateFormat

public void enableDateFormat()

Enable add the head(Date-time information) when write log into Log file.

disenableDateFormat

public void disenableDateFormat()

Disenable add the head (Date-time information) when write log into Log file.

setCompressionMode

public void setCompressionMode(CompressionMode mode)

Setting the Compression Mode on a real-time saves Log.

Parameters:

mode - the file Compression Mode

init

public boolean init(java.lang.String folderPath,
                    java.lang.String fileName,
                    java.lang.String charset)

initialize.

Parameters:

folderPath - the Folder path of the Log

fileName - the file name of Log

charset - The Character encoding of Log file

Returns:

initialize state

close

public void close()

Close the Log file.

write

public void write(java.lang.String str)

Will not have text wraps automatically when write the log into file.

Parameters:

str - message of the log record.

writeln

public void writeln(java.lang.String str)

Will have text wraps automatically when write the log into file.

Parameters:

str - log

getLogFile

public java.io.File getLogFile()

Returns the file name of the log file.

Returns:

file name of the Log file

getLogFileFolder

public java.io.File getLogFileFolder()

Returns log file.

Returns:

file

setMaxFileSize

public void setMaxFileSize(long space,
                           SpaceUnit unit)

Setting the limit size of Log file.

Parameters:

space - numbers in unit

unit - the unit of space

hasRemaining

public boolean hasRemaining()

Can it write in, after checking the storage space remaining?. Default：Infinity

Returns:

Returns true when storage space remaining.