yoavs 2005/07/28 12:01:02
Modified: src/java/org/apache/log4j TTCCLayout.java
src/java/org/apache/log4j/filter LevelMatchFilter.java
LevelRangeFilter.java StringMatchFilter.java
src/java/org/apache/log4j/helpers
AbsoluteTimeDateFormat.java
src/java/org/apache/log4j/varia LevelMatchFilter.java
LevelRangeFilter.java StringMatchFilter.java
Log:
Corrected all JavaDoc warnings.
AbsoluteTimeDateFormat#DATE_AND_TIME_DATE_FORMAT seems unused, should
probably be deprecated.
Revision Changes Path
1.26 +2 -4 logging-log4j/src/java/org/apache/log4j/TTCCLayout.java
Index: TTCCLayout.java
===================================================================
RCS file: /home/cvs/logging-log4j/src/java/org/apache/log4j/TTCCLayout.java,v
retrieving revision 1.25
retrieving revision 1.26
diff -u -r1.25 -r1.26
--- TTCCLayout.java 1 Jul 2005 21:35:24 -0000 1.25
+++ TTCCLayout.java 28 Jul 2005 19:01:02 -0000 1.26
@@ -93,10 +93,8 @@
Instantiate a TTCCLayout object using the local time zone. The
DateFormat used will depend on the <code>dateFormatType</code>.
- <p>This constructor just calls the [EMAIL PROTECTED]
- DateLayout#setDateFormat} method.
-
- */
+ <p>This constructor just calls the [EMAIL PROTECTED] #setDateFormat}
method.
+ */
public TTCCLayout(String dateFormatType) {
this.setDateFormat(dateFormatType);
}
1.4 +4 -4
logging-log4j/src/java/org/apache/log4j/filter/LevelMatchFilter.java
Index: LevelMatchFilter.java
===================================================================
RCS file:
/home/cvs/logging-log4j/src/java/org/apache/log4j/filter/LevelMatchFilter.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- LevelMatchFilter.java 8 Jan 2005 14:05:28 -0000 1.3
+++ LevelMatchFilter.java 28 Jul 2005 19:01:02 -0000 1.4
@@ -28,11 +28,11 @@
<p>The filter admits two options <b>LevelToMatch</b> and
<b>AcceptOnMatch</b>. If there is an exact match between the value
of the <b>LevelToMatch</b> option and the level of the [EMAIL PROTECTED]
- LoggingEvent}, then the [EMAIL PROTECTED] #decide} method returns [EMAIL
PROTECTED]
- Filter#ACCEPT} in case the <b>AcceptOnMatch</b> option value is set
+ org.apache.log4j.spi.LoggingEvent}, then the [EMAIL PROTECTED] #decide}
method returns [EMAIL PROTECTED]
+ org.apache.log4j.spi.Filter#ACCEPT} in case the <b>AcceptOnMatch</b>
option value is set
to <code>true</code>, if it is <code>false</code> then [EMAIL PROTECTED]
- Filter#DENY} is returned. If there is no match, [EMAIL PROTECTED]
- Filter#NEUTRAL} is returned.
+ org.apache.log4j.spi.Filter#DENY} is returned. If there is no match,
[EMAIL PROTECTED]
+ org.apache.log4j.spi.Filter#NEUTRAL} is returned.
@author Ceki Gülcü
1.2 +4 -4
logging-log4j/src/java/org/apache/log4j/filter/LevelRangeFilter.java
Index: LevelRangeFilter.java
===================================================================
RCS file:
/home/cvs/logging-log4j/src/java/org/apache/log4j/filter/LevelRangeFilter.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- LevelRangeFilter.java 3 Jan 2005 11:01:02 -0000 1.1
+++ LevelRangeFilter.java 28 Jul 2005 19:01:02 -0000 1.2
@@ -18,12 +18,12 @@
<p>The filter admits three options <b>LevelMin</b>, <b>LevelMax</b>
and <b>AcceptOnMatch</b>.
- <p>If the level of the [EMAIL PROTECTED] LoggingEvent} is not between Min
and Max
- (inclusive), then [EMAIL PROTECTED] Filter#DENY} is returned.
+ <p>If the level of the [EMAIL PROTECTED]
org.apache.log4j.spi.LoggingEvent} is not between Min and Max
+ (inclusive), then [EMAIL PROTECTED] org.apache.log4j.spi.Filter#DENY} is
returned.
<p> If the Logging event level is within the specified range, then if
- <b>AcceptOnMatch</b> is true, [EMAIL PROTECTED] Filter#ACCEPT} is
returned, and if
- <b>AcceptOnMatch</b> is false, [EMAIL PROTECTED] Filter#NEUTRAL} is
returned.
+ <b>AcceptOnMatch</b> is true, [EMAIL PROTECTED]
org.apache.log4j.spi.Filter#ACCEPT} is returned, and if
+ <b>AcceptOnMatch</b> is false, [EMAIL PROTECTED]
org.apache.log4j.spi.Filter#NEUTRAL} is returned.
<p>If <code>LevelMin</code>w is not defined, then there is no
minimum acceptable level (ie a level is never rejected for
1.2 +20 -11
logging-log4j/src/java/org/apache/log4j/filter/StringMatchFilter.java
Index: StringMatchFilter.java
===================================================================
RCS file:
/home/cvs/logging-log4j/src/java/org/apache/log4j/filter/StringMatchFilter.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- StringMatchFilter.java 3 Jan 2005 11:01:02 -0000 1.1
+++ StringMatchFilter.java 28 Jul 2005 19:01:02 -0000 1.2
@@ -1,9 +1,17 @@
/*
- * Copyright (C) The Apache Software Foundation. All rights reserved.
- *
- * This software is published under the terms of the Apache Software License
- * version 1.1, a copy of which has been included with this distribution in
- * the LICENSE.txt file.
+ * Copyright 1999,2004-2005 The Apache Software Foundation.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
*/
package org.apache.log4j.filter;
@@ -12,20 +20,21 @@
import org.apache.log4j.spi.LoggingEvent;
/**
- This is a very simple filter based on string matching.
-
+ This is a very simple filter based on string matching.<br/>
<p>The filter admits two options <b>StringToMatch</b> and
<b>AcceptOnMatch</b>. If there is a match between the value of the
StringToMatch option and the message of the [EMAIL PROTECTED]
LoggingEvent},
- then the [EMAIL PROTECTED] #decide} method returns [EMAIL PROTECTED]
Filter#ACCEPT} if
+ then the [EMAIL PROTECTED] #decide(LoggingEvent)} method returns
+ [EMAIL PROTECTED] org.apache.log4j.spi.Filter#ACCEPT} if
the <b>AcceptOnMatch</b> option value is true, if it is false then
- [EMAIL PROTECTED] Filter#DENY} is returned. If there is no match, [EMAIL
PROTECTED]
- Filter#NEUTRAL} is returned.
+ [EMAIL PROTECTED] org.apache.log4j.spi.Filter#DENY} is returned. If there
is no match, [EMAIL PROTECTED]
+ org.apache.log4j.spi.Filter#NEUTRAL} is returned.
@author Ceki Gülcü
- @since 0.9.0 */
+ @since 0.9.0
+*/
public class StringMatchFilter extends Filter {
boolean acceptOnMatch = true;
1.9 +4 -9
logging-log4j/src/java/org/apache/log4j/helpers/AbsoluteTimeDateFormat.java
Index: AbsoluteTimeDateFormat.java
===================================================================
RCS file:
/home/cvs/logging-log4j/src/java/org/apache/log4j/helpers/AbsoluteTimeDateFormat.java,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- AbsoluteTimeDateFormat.java 1 Jul 2005 21:35:23 -0000 1.8
+++ AbsoluteTimeDateFormat.java 28 Jul 2005 19:01:02 -0000 1.9
@@ -39,22 +39,17 @@
*/
public class AbsoluteTimeDateFormat extends DateFormat {
/**
- String constant used to specify [EMAIL PROTECTED]
- org.apache.log4j.helpers.AbsoluteTimeDateFormat} in layouts. Current
- value is <b>ABSOLUTE</b>. */
+ String constant used to specify the Absolute time and date format.
+ */
public static final String ABS_TIME_DATE_FORMAT = "ABSOLUTE";
/**
- String constant used to specify [EMAIL PROTECTED]
- org.apache.log4j.helpers.DateTimeDateFormat} in layouts. Current
- value is <b>DATE</b>.
+ String constant used to specify the "Date and Time" date format.
*/
public static final String DATE_AND_TIME_DATE_FORMAT = "DATE";
/**
- String constant used to specify [EMAIL PROTECTED]
- org.apache.log4j.helpers.ISO8601DateFormat} in layouts. Current
- value is <b>ISO8601</b>.
+ String constant used to specify the ISO8601 format.
*/
public static final String ISO8601_DATE_FORMAT = "ISO8601";
1.12 +7 -16
logging-log4j/src/java/org/apache/log4j/varia/LevelMatchFilter.java
Index: LevelMatchFilter.java
===================================================================
RCS file:
/home/cvs/logging-log4j/src/java/org/apache/log4j/varia/LevelMatchFilter.java,v
retrieving revision 1.11
retrieving revision 1.12
diff -u -r1.11 -r1.12
--- LevelMatchFilter.java 1 Jul 2005 20:56:00 -0000 1.11
+++ LevelMatchFilter.java 28 Jul 2005 19:01:02 -0000 1.12
@@ -18,21 +18,12 @@
/**
- This is a very simple filter based on level matching.
-
- <p>The filter admits two options <b>LevelToMatch</b> and
- <b>AcceptOnMatch</b>. If there is an exact match between the value
- of the <b>LevelToMatch</b> option and the level of the [EMAIL PROTECTED]
- LoggingEvent}, then the [EMAIL PROTECTED] #decide} method returns [EMAIL
PROTECTED]
- Filter#ACCEPT} in case the <b>AcceptOnMatch</b> option value is set
- to <code>true</code>, if it is <code>false</code> then [EMAIL PROTECTED]
- Filter#DENY} is returned. If there is no match, [EMAIL PROTECTED]
- Filter#NEUTRAL} is returned.
-
- @author Ceki Gülcü
-
- @since 1.2
- @deprecated moved to org.apache.log4j.filter.LevelMatchFilter
- */
+ * <font color="red>Don't use this class. Use
+ * [EMAIL PROTECTED] org.apache.log4j.filter.LevelMatchFilter}
instead.</font>
+ *
+ * @author Ceki Gülcü
+ * @since 1.2
+ * @deprecated moved to org.apache.log4j.filter.LevelMatchFilter
+ */
public class LevelMatchFilter extends
org.apache.log4j.filter.LevelMatchFilter {
}
1.7 +7 -29
logging-log4j/src/java/org/apache/log4j/varia/LevelRangeFilter.java
Index: LevelRangeFilter.java
===================================================================
RCS file:
/home/cvs/logging-log4j/src/java/org/apache/log4j/varia/LevelRangeFilter.java,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- LevelRangeFilter.java 1 Jul 2005 20:56:00 -0000 1.6
+++ LevelRangeFilter.java 28 Jul 2005 19:01:02 -0000 1.7
@@ -17,34 +17,12 @@
package org.apache.log4j.varia;
/**
- This is a very simple filter based on level matching, which can be
- used to reject messages with priorities outside a certain range.
-
- <p>The filter admits three options <b>LevelMin</b>, <b>LevelMax</b>
- and <b>AcceptOnMatch</b>.
-
- <p>If the level of the [EMAIL PROTECTED] LoggingEvent} is not between Min
and Max
- (inclusive), then [EMAIL PROTECTED] Filter#DENY} is returned.
-
- <p> If the Logging event level is within the specified range, then if
- <b>AcceptOnMatch</b> is true, [EMAIL PROTECTED] Filter#ACCEPT} is
returned, and if
- <b>AcceptOnMatch</b> is false, [EMAIL PROTECTED] Filter#NEUTRAL} is
returned.
-
- <p>If <code>LevelMin</code>w is not defined, then there is no
- minimum acceptable level (ie a level is never rejected for
- being too "low"/unimportant). If <code>LevelMax</code> is not
- defined, then there is no maximum acceptable level (ie a
- level is never rejected for beeing too "high"/important).
-
- <p>Refer to the [EMAIL PROTECTED]
- org.apache.log4j.AppenderSkeleton#setThreshold setThreshold} method
- available to <code>all</code> appenders extending [EMAIL PROTECTED]
- org.apache.log4j.AppenderSkeleton} for a more convenient way to
- filter out events by level.
-
- @author Simon Kitching
- @author based on code by Ceki Gülcü
- @deprecated moved to org.apache.log4j.filter.LevelRangeFilter
-*/
+ * <font color="red>Don't use this class. Use
+ * [EMAIL PROTECTED] org.apache.log4j.filter.LevelMatchFilter}
instead.</font>
+ *
+ * @author Ceki Gülcü
+ * @since 1.2
+ * @deprecated moved to org.apache.log4j.filter.LevelRangeFilter
+ */
public class LevelRangeFilter extends
org.apache.log4j.filter.LevelRangeFilter {
}
1.12 +7 -25
logging-log4j/src/java/org/apache/log4j/varia/StringMatchFilter.java
Index: StringMatchFilter.java
===================================================================
RCS file:
/home/cvs/logging-log4j/src/java/org/apache/log4j/varia/StringMatchFilter.java,v
retrieving revision 1.11
retrieving revision 1.12
diff -u -r1.11 -r1.12
--- StringMatchFilter.java 1 Jul 2005 20:56:00 -0000 1.11
+++ StringMatchFilter.java 28 Jul 2005 19:01:02 -0000 1.12
@@ -18,31 +18,13 @@
/**
- This is a very simple filter based on string matching.
-
-
- <p>The filter admits two options <b>StringToMatch</b> and
- <b>AcceptOnMatch</b>. If there is a match between the value of the
- StringToMatch option and the message of the [EMAIL PROTECTED]
LoggingEvent},
- then the [EMAIL PROTECTED] #decide} method returns [EMAIL PROTECTED]
Filter#ACCEPT} if
- the <b>AcceptOnMatch</b> option value is true, if it is false then
- [EMAIL PROTECTED] Filter#DENY} is returned. If there is no match, [EMAIL
PROTECTED]
- Filter#NEUTRAL} is returned.
-
- <p>See configuration files <a
- href="../xml/doc-files/test6.xml">test6.xml</a>, <a
- href="../xml/doc-files/test7.xml">test7.xml</a>, <a
- href="../xml/doc-files/test8.xml">test8.xml</a>, <a
- href="../xml/doc-files/test9.xml">test9.xml</a>, and <a
- href="../xml/doc-files/test10.xml">test10.xml</a> for examples of
- seeting up a <code>StringMatchFilter</code>.
-
-
- @author Ceki Gülcü
-
- @since 0.9.0
- @deprecated org.apache.log4j.filter.StringMatchFilter
- */
+ * <font color="red>Don't use this class. Use
+ * [EMAIL PROTECTED] org.apache.log4j.filter.StringMatchFilter}
instead.</font>
+ *
+ * @author Ceki Gülcü
+ * @since 0.9.0
+ * @deprecated org.apache.log4j.filter.StringMatchFilter
+ */
public class StringMatchFilter
extends org.apache.log4j.filter.StringMatchFilter {
}
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
