leosutic 2003/02/06 04:15:37
Modified: src/java/org/apache/log/output/io/rotate RotateStrategy.java
Log:
Changed javadoc to reflect the way the ROtateStrategy is actually used,
as opposed to what the Javadoc said.
I figure in this case it is easier to change the contract-as-written, as code
written for the RotateStrategy interface must de facto have been written
for the contract-as-it-really-is in order to work. So while the contract
changes in theory, it doesn't in practice.
Revision Changes Path
1.5 +4 -2
avalon-logkit/src/java/org/apache/log/output/io/rotate/RotateStrategy.java
Index: RotateStrategy.java
===================================================================
RCS file:
/home/cvs/avalon-logkit/src/java/org/apache/log/output/io/rotate/RotateStrategy.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- RotateStrategy.java 3 Feb 2003 17:40:14 -0000 1.4
+++ RotateStrategy.java 6 Feb 2003 12:15:37 -0000 1.5
@@ -59,12 +59,13 @@
/**
* Strategy that checks condition under which file rotation is needed.
*
+ * @author <a href="mailto:[EMAIL PROTECTED]";>Leo Sutic</a>
* @author <a href="mailto:[EMAIL PROTECTED]";>Bernhard Huber</a>
*/
public interface RotateStrategy
{
/**
- * reset cumulative rotation history data.
+ * Reset cumulative rotation history data.
* Called after rotation.
*/
void reset();
@@ -72,7 +73,8 @@
/**
* Check if a log rotation is neccessary at this time.
*
- * @param data the serialized version of last message written to the log system
+ * @param data the serialized version of the message about to be written
+ * to the log system
* @param file the File that we are writing to
* @return boolean return true if log rotation is neccessary, else false
*/
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
