Modifier and Type	Class and Description
private class	RolloverFileOutputStream.RollTask

Modifier and Type	Field and Description
private static Timer	__rollover
private boolean	_append
private File	_file
private SimpleDateFormat	_fileBackupFormat
private SimpleDateFormat	_fileDateFormat
private String	_filename
private int	_retainDays
private RolloverFileOutputStream.RollTask	_rollTask
pack-priv static final String	YYYY_MM_DD

Constructor Summary

Access	Constructor and Description
public	RolloverFileOutputStream(String The filename must include the string "yyyy_mm_dd", which is replaced with the actual date when creating and rolling over the file. filename)
public	RolloverFileOutputStream(String The filename must include the string "yyyy_mm_dd", which is replaced with the actual date when creating and rolling over the file. filename, boolean If true, existing files will be appended to. append)
public	RolloverFileOutputStream(String The filename must include the string "yyyy_mm_dd", which is replaced with the actual date when creating and rolling over the file. filename, boolean If true, existing files will be appended to. append, int The number of days to retain files before deleting them. 0 to retain forever. retainDays)
public	RolloverFileOutputStream(String The filename must include the string "yyyy_mm_dd", which is replaced with the actual date when creating and rolling over the file. filename, boolean If true, existing files will be appended to. append, int The number of days to retain files before deleting them. 0 to retain forever. retainDays, TimeZone zone)
public	RolloverFileOutputStream(String The filename must include the string "yyyy_mm_dd", which is replaced with the actual date when creating and rolling over the file. filename, boolean If true, existing files will be appended to. append, int The number of days to retain files before deleting them. 0 to retain forever. retainDays, TimeZone zone, String The format for the date file substitution. If null the system property ROLLOVERFILE_DATE_FORMAT is used and if that is null, then default is "yyyy_MM_dd". dateFormat, String The format for the file extension of backup files. If null the system property ROLLOVERFILE_BACKUP_FORMAT is used and if that is null, then default is "HHmmssSSS". backupFormat)

Method Summary

Modifier and Type	Method and Description
public void	close() Overrides java.io.FilterOutputStream.close. Implements java.io.Closeable.close. Closes this output stream and releases any system resources associated with the stream.
public String	getDatedFilename()
public String	getFilename()
public int	getRetainDays()
private void	removeOldFiles()
private synchronized void	setFile()
public void	write(byte[] the data to be written. buf) Overrides java.io.FilterOutputStream.write. Writes `b.length` bytes to this output stream.
public void	write(byte[] the data. buf, int the start offset in the data. off, int the number of bytes to write. len) Overrides java.io.FilterOutputStream.write. Writes `len` bytes from the specified `byte` array starting at offset `off` to this output stream.

Inherited from java.io.FilterOutputStream:: flush write

Field Detail

__rollover	back to summary
private static Timer __rollover

_append	back to summary
private boolean _append

_file	back to summary
private File _file

_fileBackupFormat	back to summary
private SimpleDateFormat _fileBackupFormat

_fileDateFormat	back to summary
private SimpleDateFormat _fileDateFormat

_filename	back to summary
private String _filename

_retainDays	back to summary
private int _retainDays

_rollTask	back to summary
private RolloverFileOutputStream.RollTask _rollTask

YYYY_MM_DD	back to summary
pack-priv static final String YYYY_MM_DD

Constructor Detail

RolloverFileOutputStream	back to summary
public RolloverFileOutputStream(String filename) throws IOException Parameters filename:String The filename must include the string "yyyy_mm_dd", which is replaced with the actual date when creating and rolling over the file.

RolloverFileOutputStream	back to summary
public RolloverFileOutputStream(String filename, boolean append) throws IOException Parameters filename:String The filename must include the string "yyyy_mm_dd", which is replaced with the actual date when creating and rolling over the file. append:boolean If true, existing files will be appended to.

RolloverFileOutputStream	back to summary
public RolloverFileOutputStream(String filename, boolean append, int retainDays) throws IOException Parameters filename:String The filename must include the string "yyyy_mm_dd", which is replaced with the actual date when creating and rolling over the file. append:boolean If true, existing files will be appended to. retainDays:int The number of days to retain files before deleting them. 0 to retain forever.

RolloverFileOutputStream

back to summary

public RolloverFileOutputStream(String filename, boolean append, int retainDays) throws IOException

Parameters

filename:String: The filename must include the string "yyyy_mm_dd", which is replaced with the actual date when creating and rolling over the file.
append:boolean: If true, existing files will be appended to.
retainDays:int: The number of days to retain files before deleting them. 0 to retain forever.

RolloverFileOutputStream	back to summary
public RolloverFileOutputStream(String filename, boolean append, int retainDays, TimeZone zone) throws IOException Parameters filename:String The filename must include the string "yyyy_mm_dd", which is replaced with the actual date when creating and rolling over the file. append:boolean If true, existing files will be appended to. retainDays:int The number of days to retain files before deleting them. 0 to retain forever.

RolloverFileOutputStream

back to summary

public RolloverFileOutputStream(String filename, boolean append, int retainDays, TimeZone zone) throws IOException

Parameters

filename:String: The filename must include the string "yyyy_mm_dd", which is replaced with the actual date when creating and rolling over the file.
append:boolean: If true, existing files will be appended to.
retainDays:int: The number of days to retain files before deleting them. 0 to retain forever.

RolloverFileOutputStream	back to summary
public RolloverFileOutputStream(String filename, boolean append, int retainDays, TimeZone zone, String dateFormat, String backupFormat) throws IOException Parameters filename:String The filename must include the string "yyyy_mm_dd", which is replaced with the actual date when creating and rolling over the file. append:boolean If true, existing files will be appended to. retainDays:int The number of days to retain files before deleting them. 0 to retain forever. dateFormat:String The format for the date file substitution. If null the system property ROLLOVERFILE_DATE_FORMAT is used and if that is null, then default is "yyyy_MM_dd". backupFormat:String The format for the file extension of backup files. If null the system property ROLLOVERFILE_BACKUP_FORMAT is used and if that is null, then default is "HHmmssSSS".

RolloverFileOutputStream

back to summary

public RolloverFileOutputStream(String filename, boolean append, int retainDays, TimeZone zone, String dateFormat, String backupFormat) throws IOException

Parameters

filename:String: The filename must include the string "yyyy_mm_dd", which is replaced with the actual date when creating and rolling over the file.
append:boolean: If true, existing files will be appended to.
retainDays:int: The number of days to retain files before deleting them. 0 to retain forever.
dateFormat:String: The format for the date file substitution. If null the system property ROLLOVERFILE_DATE_FORMAT is used and if that is null, then default is "yyyy_MM_dd".
backupFormat:String: The format for the file extension of backup files. If null the system property ROLLOVERFILE_BACKUP_FORMAT is used and if that is null, then default is "HHmmssSSS".

Method Detail

close	back to summary
public void close() throws IOException Overrides java.io.FilterOutputStream.close. Implements java.io.Closeable.close. Doc from java.io.FilterOutputStream.close. Closes this output stream and releases any system resources associated with the stream. Exceptions IOException: if an I/O error occurs.

back to summary

public void close() throws IOException

Overrides java.io.FilterOutputStream.close.

Implements java.io.Closeable.close.

Doc from java.io.FilterOutputStream.close.

Closes this output stream and releases any system resources associated with the stream.

Exceptions

IOException:: if an I/O error occurs.

getDatedFilename	back to summary
public String getDatedFilename()

getFilename	back to summary
public String getFilename()

getRetainDays	back to summary
public int getRetainDays()

removeOldFiles	back to summary
private void removeOldFiles()

setFile	back to summary
private synchronized void setFile() throws IOException

write back to summary

write	back to summary
public void write(byte[] buf) throws IOException Overrides java.io.FilterOutputStream.write. Doc from java.io.FilterOutputStream.write. Writes `b.length` bytes to this output stream. Parameters buf:byte[] the data to be written. Exceptions IOException: if an I/O error occurs.

public void write(byte[] buf) throws IOException

Overrides java.io.FilterOutputStream.write.

Doc from java.io.FilterOutputStream.write.

Writes b.length bytes to this output stream.

Parameters

buf:byte[]: the data to be written.

Exceptions

IOException:: if an I/O error occurs.

write back to summary

write	back to summary
public void write(byte[] buf, int off, int len) throws IOException Overrides java.io.FilterOutputStream.write. Doc from java.io.FilterOutputStream.write. Writes `len` bytes from the specified `byte` array starting at offset `off` to this output stream. Parameters buf:byte[] the data. off:int the start offset in the data. len:int the number of bytes to write. Exceptions IOException: if an I/O error occurs.

public void write(byte[] buf, int off, int len) throws IOException

Overrides java.io.FilterOutputStream.write.

Doc from java.io.FilterOutputStream.write.

Writes len bytes from the specified byte array starting at offset off to this output stream.

Parameters

buf:byte[]: the data.
off:int: the start offset in the data.
len:int: the number of bytes to write.

Exceptions

IOException:: if an I/O error occurs.

org.mortbay.util back to summary

private Class RolloverFileOutputStream.RollTask

Class Inheritance

extends TimerTask

java.lang.Object
java.util.TimerTask
org.mortbay.util.RolloverFileOutputStream.RollTask

Constructor Summary

Access	Constructor and Description
private	RollTask()

Method Summary

Modifier and Type	Method and Description
public void	run() Implements abstract java.util.TimerTask.run. Implements java.lang.Runnable.run. The action to be performed by this timer task.

Inherited from java.util.TimerTask:: cancel scheduledExecutionTime

Constructor Detail

RollTask	back to summary
private RollTask()

Method Detail

run	back to summary
public void run() Implements abstract java.util.TimerTask.run. Implements java.lang.Runnable.run. Doc from java.util.TimerTask.run. The action to be performed by this timer task.

run

back to summary

public void run()

Implements abstract java.util.TimerTask.run.

Implements java.lang.Runnable.run.

Doc from java.util.TimerTask.run.

The action to be performed by this timer task.