Return-Path: Delivered-To: apmail-jakarta-avalon-cvs-archive@apache.org Received: (qmail 36390 invoked from network); 9 Feb 2002 21:40:27 -0000 Received: from unknown (HELO nagoya.betaversion.org) (192.18.49.131) by daedalus.apache.org with SMTP; 9 Feb 2002 21:40:27 -0000 Received: (qmail 29689 invoked by uid 97); 9 Feb 2002 21:40:32 -0000 Delivered-To: qmlist-jakarta-archive-avalon-cvs@jakarta.apache.org Received: (qmail 29635 invoked by uid 97); 9 Feb 2002 21:40:31 -0000 Mailing-List: contact avalon-cvs-help@jakarta.apache.org; run by ezmlm Precedence: bulk List-Unsubscribe: List-Subscribe: List-Help: List-Post: List-Id: "Avalon CVS List" Reply-To: "Avalon Developers List" Delivered-To: mailing list avalon-cvs@jakarta.apache.org Received: (qmail 29624 invoked by uid 97); 9 Feb 2002 21:40:31 -0000 Date: 9 Feb 2002 21:40:24 -0000 Message-ID: <20020209214024.36695.qmail@icarus.apache.org> From: donaldp@apache.org To: jakarta-avalon-logkit-cvs@apache.org Subject: cvs commit: jakarta-avalon-logkit/src/java/org/apache/log/output/net SocketOutputTarget.java X-Spam-Rating: daedalus.apache.org 1.6.2 0/1000/N X-Spam-Rating: daedalus.apache.org 1.6.2 0/1000/N donaldp 02/02/09 13:40:24 Modified: . build.xml src/java/org/apache/log/format PatternFormatter.java src/java/org/apache/log/output/io/rotate OrRotateStrategy.java RevolvingFileStrategy.java src/java/org/apache/log/output/net SocketOutputTarget.java Log: Fix up errors in the javadocs and make sure the javadocs get linked to external docs. Submitted By: Mark Woon Revision Changes Path 1.69 +9 -6 jakarta-avalon-logkit/build.xml Index: build.xml =================================================================== RCS file: /home/cvs/jakarta-avalon-logkit/build.xml,v retrieving revision 1.68 retrieving revision 1.69 diff -u -r1.68 -r1.69 --- build.xml 31 Jan 2002 16:27:41 -0000 1.68 +++ build.xml 9 Feb 2002 21:40:23 -0000 1.69 @@ -392,12 +392,15 @@ destdir="${build.javadocs}"> - - - - - + + + + + + + + 1.25 +57 -36 jakarta-avalon-logkit/src/java/org/apache/log/format/PatternFormatter.java Index: PatternFormatter.java =================================================================== RCS file: /home/cvs/jakarta-avalon-logkit/src/java/org/apache/log/format/PatternFormatter.java,v retrieving revision 1.24 retrieving revision 1.25 diff -u -r1.24 -r1.25 --- PatternFormatter.java 13 Dec 2001 08:04:51 -0000 1.24 +++ PatternFormatter.java 9 Feb 2002 21:40:24 -0000 1.25 @@ -20,46 +20,66 @@ * This formater formats the LogEvents according to a input pattern * string. *

- * The format of each pattern element can be %[+|-][#[.#]]{field:subformat}. + * The format of each pattern element can be + * %[+|-][#[.#]]{field:subformat}. *

*
    - *
  • The +|- indicates left or right justify. - *
    • - *
  • The #.# indicates the minimum and maximum size of output.
    - * You may omit the values and the field will be formatted without size - * restriction.
    - * You may specify '#', or '#.' to define an minimum size, only.
    - * You may specify '.#' to define an maximum size only. - *
    • - *
  • - * 'field' indicates which field is to be output and must be one of - * properties of LogEvent.
    - * Currently following fields are supported: - *
    - *
    category
    - *
    Category value of the logging event.
    - *
    context
    - *
    Context value of the logging event.
    - *
    message
    - *
    Message value of the logging event.
    - *
    time
    - *
    Time value of the logging event.
    - *
    rtime
    - *
    Relative time value of the logging event.
    - *
    throwable
    - *
    Throwable value of the logging event.
    - *
    priority
    - *
    Priority value of the logging event.
    - *
    - *
    • - *
  • 'subformat' indicates a particular subformat and is currently only used - * for category context to specify the context map parameter name. - *
    • + *

  • The +|- indicates left or right justify. + *

    • + *

  • The #.# indicates the minimum and maximum + * size of output. You may omit the values and the field will be + * formatted without size restriction.
    + * You may specify #, or #. to only + * define the minimum size.
    + * You may specify .# to only define the maximum + * size. + *

    • + *

  • field indicates which field is to be output and must be + * one of properties of LogEvent. The following fields are + * currently supported: + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
    categoryCategory value of the logging event.
    contextContext value of the logging event.
    messageMessage value of the logging event.
    timeTime value of the logging event.
    rtimeRelative time value of the logging event.
    throwableThrowable value of the logging event.
    priorityPriority value of the logging event.
    + *

    • + * + *

  • subformat indicates a particular subformat to + * use on the specified field, and is currently only supported by: + * + * + * + * + * + * + * + * + *
    contextSpecifies the context map parameter name.
    timeSpecifies the pattern to be pass to + * {@link java.text.SimpleDateFormat SimpleDateFormat} to format the time.
    + *

    • *
*

A simple example of a typical PatternFormatter format: + * %{time} %5.5{priority}[%-10.10{category}]: %{message} *

- * 
%{time} %5.5{priority}[%-10.10{category}]: %{message}
  - *
*

* This format string will format a log event printing first time value of * of log event with out size restriction, next priority with minum and maximum size 5, @@ -71,9 +91,10 @@ * 

1000928827905 DEBUG [     junit]: Sample message
    *
* + * * @author Peter Donald * @author Sylvain Wallez - * @version CVS $Revision: 1.24 $ $Date: 2001/12/13 08:04:51 $ + * @version CVS $Revision: 1.25 $ $Date: 2002/02/09 21:40:24 $ */ public class PatternFormatter implements Formatter, org.apache.log.Formatter 1.3 +2 -2 jakarta-avalon-logkit/src/java/org/apache/log/output/io/rotate/OrRotateStrategy.java Index: OrRotateStrategy.java =================================================================== RCS file: /home/cvs/jakarta-avalon-logkit/src/java/org/apache/log/output/io/rotate/OrRotateStrategy.java,v retrieving revision 1.2 retrieving revision 1.3 diff -u -r1.2 -r1.3 --- OrRotateStrategy.java 21 Aug 2001 05:08:07 -0000 1.2 +++ OrRotateStrategy.java 9 Feb 2002 21:40:24 -0000 1.3 @@ -10,11 +10,11 @@ import java.io.File; /** - * Hierarchical Rotation stragety. + * Hierarchical rotation strategy. * This object is initialised with several rotation strategy objects. * The isRotationNeeded method checks the first rotation * strategy object. If a rotation is needed, this result is returned. - * If not the next rotation strategy object is asked and so on. + * If not, the next rotation strategy object is checked, and so on. * * @author Carsten Ziegeler */ 1.3 +1 -1 jakarta-avalon-logkit/src/java/org/apache/log/output/io/rotate/RevolvingFileStrategy.java Index: RevolvingFileStrategy.java =================================================================== RCS file: /home/cvs/jakarta-avalon-logkit/src/java/org/apache/log/output/io/rotate/RevolvingFileStrategy.java,v retrieving revision 1.2 retrieving revision 1.3 diff -u -r1.2 -r1.3 --- RevolvingFileStrategy.java 21 Aug 2001 04:50:47 -0000 1.2 +++ RevolvingFileStrategy.java 9 Feb 2002 21:40:24 -0000 1.3 @@ -13,7 +13,7 @@ import java.text.NumberFormat; /** - * strategy for naming log files based on appending revolving suffix. + * Strategy for naming log files based on appending a revolving suffix. * * @author Bernhard Huber */ 1.2 +1 -2 jakarta-avalon-logkit/src/java/org/apache/log/output/net/SocketOutputTarget.java Index: SocketOutputTarget.java =================================================================== RCS file: /home/cvs/jakarta-avalon-logkit/src/java/org/apache/log/output/net/SocketOutputTarget.java,v retrieving revision 1.1 retrieving revision 1.2 diff -u -r1.1 -r1.2 --- SocketOutputTarget.java 22 Dec 2001 11:29:29 -0000 1.1 +++ SocketOutputTarget.java 9 Feb 2002 21:40:24 -0000 1.2 @@ -18,7 +18,6 @@ * Useful for writing the output to a TCP/IP client socket. * * @author Rajendra Ghorpade - * @version */ public class SocketOutputTarget extends AbstractOutputTarget { @@ -98,4 +97,4 @@ super.close(); m_socket = null; } -} \ No newline at end of file +} -- To unsubscribe, e-mail: For additional commands, e-mail: