org.ka2ddo.yaac.core

Class StringLogger

java.lang.Object

org.ka2ddo.util.ReschedulableTimerTask

org.ka2ddo.yaac.core.FileLogger<java.lang.String>

org.ka2ddo.yaac.core.StringLogger

All Implemented Interfaces:

java.lang.Comparable<ReschedulableTimerTask>, java.lang.Runnable, ShutdownHandler

public class StringLogger
extends FileLogger<java.lang.String>

This class batches up logging text messages to a text file.

Author:

Andrew Pavlin, KA2DDO

Nested Class Summary

Nested classes/interfaces inherited from class org.ka2ddo.yaac.core.FileLogger

FileLogger.RolloverHandler<T>

Constructor Summary

Constructors

Constructor and Description
StringLogger(java.lang.String prefix, java.lang.String datePattern, java.lang.String suffix) Create a StringLogger using the specified prefix on the file name, also using the date format "yyyy-MM-dd" and the file type ".log".
StringLogger(java.lang.String prefix, java.lang.String datePattern, java.lang.String suffix, long rolloverInterval) Create a StringLogger using the specified prefix on the file name, also using the date format "yyyy-MM-dd" and the file type ".log".

Method Summary

Modifier and Type	Method and Description
void	dumpRecordQueueToFile(java.io.File logFileFile, java.util.ArrayList<java.lang.String> recordQueue) Subclasses should implement this method to open the specified sequential file for append, then write each of the records in the recordQueue in order to the file, then close the file.

Methods inherited from class org.ka2ddo.yaac.core.FileLogger

flush, getDefaultLogDir, log, log, log, run, setDatePattern, setDefaultLogDir, setFilePrefix, setFileSuffix, setFlushInterval, setLogDirectory, setRolloverHandler, setRolloverInterval, setTimeZone, shutdown

Methods inherited from class org.ka2ddo.util.ReschedulableTimerTask

cancel, compareTo, equals, hashCode, isActive, resched, resched, resched, resched

Methods inherited from class java.lang.Object

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

Constructor Detail

StringLogger

public StringLogger(java.lang.String prefix,
                    java.lang.String datePattern,
                    java.lang.String suffix)

Create a StringLogger using the specified prefix on the file name, also using the date format "yyyy-MM-dd" and the file type ".log".

Parameters:

prefix - String prefix for the file name

datePattern - format string for file name embedded date, using SimpleDateFormat directives

suffix - String file name suffix (after the date)

StringLogger

public StringLogger(java.lang.String prefix,
                    java.lang.String datePattern,
                    java.lang.String suffix,
                    long rolloverInterval)

Create a StringLogger using the specified prefix on the file name, also using the date format "yyyy-MM-dd" and the file type ".log".

Parameters:

prefix - String prefix for the file name

datePattern - format string for file name embedded date, using SimpleDateFormat directives

suffix - String file name suffix (after the date)

rolloverInterval - the interval in milliseconds between log file changes

Method Detail

dumpRecordQueueToFile

public void dumpRecordQueueToFile(java.io.File logFileFile,
                                  java.util.ArrayList<java.lang.String> recordQueue)
                           throws java.io.IOException

Subclasses should implement this method to open the specified sequential file for append, then write each of the records in the recordQueue in order to the file, then close the file.

Specified by:

dumpRecordQueueToFile in class FileLogger<java.lang.String>

Parameters:

logFileFile - File identifying the log file to open and write

recordQueue - the ArrayList of ordered records to write

Throws:

java.io.IOException - if record saving fails for any reason