org.clapper.util.io
Interface RollingFileWriter.RolloverCallback

Enclosing class:

RollingFileWriter

public static interface RollingFileWriter.RolloverCallback

Defines the interface to a callback object containing methods that a RollingFileWriter can invoke during processing. Currently, the only capability that is defined is the retrieval of a roll-over message. When a caller opens a RollingFileWriter object, it can also register a callback object that will be invoked at the moment of roll-over, to retrieve a roll-over message. This message is then written to the end of the just rolled-over file and the beginning of the new file, and can help users to determine whether a file is one of a chain of files.

Method Summary

java.lang.String

getRollOverMessage() Return a message to be written to the rolled-over file and the newly-opened primary file at the moment of roll-over.

Method Detail

getRollOverMessage

java.lang.String getRollOverMessage()

Return a message to be written to the rolled-over file and the newly-opened primary file at the moment of roll-over.

Returns:

the message, or null if there isn't one.