avalon-cvs mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From dona...@apache.org
Subject cvs commit: jakarta-avalon-logkit/src/java/org/apache/log/output/net SocketOutputTarget.java
Date Sat, 09 Feb 2002 21:40:24 GMT
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 <morpheus@SMI.Stanford.EDU>
  
  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}">
         <classpath refid="project.class.path" />
         <doclet name="com.sun.tools.doclets.standard.Standard">
  -       <param name="-author"/>
  -       <param name="-version"/>
  -       <param name="-doctitle" value="${Name}"/>
  -       <param name="-windowtitle" value="${Name} API"/>
  -       <param name="-bottom"
  -              value="&quot;Copyright &#169; 2001 Apache Jakarta Project. All Rights
Reserved.&quot;"/>
  +        <param name="-author"/>
  +        <param name="-version"/>
  +        <param name="-doctitle" value="${Name}"/>
  +        <param name="-windowtitle" value="${Name} API"/>
  +        <param name="-bottom"
  +               value="&quot;Copyright &#169; 2001 Apache Jakarta Project. All Rights
Reserved.&quot;"/>
  +        <param name="-link" value="http://java.sun.com/j2se/1.4/docs/api/"/>
  +        <param name="-link" value="http://java.sun.com/j2ee/sdk_1.3/techdocs/api/"/>
  +        <param name="-link" value="http://jakarta.apache.org/avalon/api/"/>
         </doclet>
       </javadoc>
   
  
  
  
  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.
    * <p>
  - * The format of each pattern element can be %[+|-][#[.#]]{field:subformat}.
  + * The format of each pattern element can be
  + * <code>%[+|-][#[.#]]{field:subformat}</code>.
    * </p>
    * <ul>
  - * <li>The +|- indicates left or right justify.
  - * </li>
  - * <li>The #.# indicates the minimum and maximum size of output.<br>
  - *   You may omit the values and the field will be formatted without size
  - *   restriction.<br>
  - *   You may specify '#', or '#.' to define an minimum size, only.</br>
  - *   You may specify '.#' to define an maximum size only.
  - * </li>
  - * <li>
  -   * 'field' indicates which field is to be output and must be one of
  - *  properties of LogEvent.<br>
  - *  Currently following fields are supported:
  - *   <dl>
  - *     <dt>category</dt>
  - *     <dd>Category value of the logging event.</dd>
  - *     <dt>context</dt>
  - *     <dd>Context value of the logging event.</dd>
  - *     <dt>message</dt>
  - *     <dd>Message value of the logging event.</dd>
  - *     <dt>time</dt>
  - *     <dd>Time value of the logging event.</dd>
  - *     <dt>rtime</dt>
  - *     <dd>Relative time value of the logging event.</dd>
  - *     <dt>throwable</dt>
  - *     <dd>Throwable value of the logging event.</dd>
  - *     <dt>priority</dt>
  - *     <dd>Priority value of the logging event.</dd>
  - *   </dl>
  - * </li>
  - * <li>'subformat' indicates a particular subformat and is currently only used
  - *   for category context to specify the context map parameter name.
  - * </li>
  + *   <li><p>The <code>+|-</code> indicates left or right justify.
  + *   </p></li>
  + *   <li><p>The <code>#.#</code> indicates the minimum and maximum
  + *     size of output.  You may omit the values and the field will be
  + *     formatted without size restriction.<br />
  + *     You may specify <code>#</code>, or <code>#.</code> to only
  + *     define the minimum size.<br />
  + *     You may specify <code>.#</code> to only define the maximum
  + *     size.
  + *   </p></li>
  + *   <li><p><code>field</code> indicates which field is to be output
and must be
  + *     one of properties of LogEvent.  The following fields are
  + *     currently supported:
  + *     <table border="0" cellpadding="4" cellspacing="0">
  + *       <tr>
  + *         <td><b>category</b></td>
  + *         <td>Category value of the logging event.</td>
  + *       </tr><tr>
  + *         <td><b>context</b></td>
  + *         <td>Context value of the logging event.</td>
  + *       </tr><tr>
  + *         <td><b>message</b></td>
  + *         <td>Message value of the logging event.</td>
  + *       </tr><tr>
  + *         <td><b>time</b></td>
  + *         <td>Time value of the logging event.</td>
  + *       </tr><tr>
  + *         <td><b>rtime</b></td>
  + *         <td>Relative time value of the logging event.</td>
  + *       </tr><tr>
  + *         <td><b>throwable</b></td>
  + *         <td>Throwable value of the logging event.</td>
  + *       </tr><tr>
  + *         <td><b>priority</b></td>
  + *         <td>Priority value of the logging event.</td>
  + *       </tr>
  + *     </table>
  + *   </p></li>
  + *
  + *   <li><p><code>subformat</code> indicates a particular subformat
to
  + *     use on the specified field, and is currently only supported by:
  + *     <table border="0" cellpadding="4" cellspacing="0">
  + *       <tr>
  + *         <td><b>context</b></td>
  + *         <td>Specifies the context map parameter name.</td>
  + *       </tr><tr>
  + *         <td><b>time</b></td>
  + *         <td>Specifies the pattern to be pass to 
  + *         {@link java.text.SimpleDateFormat SimpleDateFormat} to format the time.</td>
  + *       </tr>
  + *     </table>
  + *   </p></li>
    * </ul>
    * <p>A simple example of a typical PatternFormatter format:
  + * <code>%{time} %5.5{priority}[%-10.10{category}]: %{message}</code>
    * </p>
  - * <pre><code>%{time} %5.5{priority}[%-10.10{category}]: %{message}
  - * </pre></code>
    * <p>
    *   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 @@
    * <pre><code>1000928827905 DEBUG [     junit]: Sample message
    * </pre><code>
    *
  + *
    * @author <a href="mailto:peter@apache.org">Peter Donald</a>
    * @author <a href="mailto:sylvain@apache.org">Sylvain Wallez</a>
  - * @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 <code>isRotationNeeded</code> 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 <a href="mailto:cziegeler@apache.org">Carsten Ziegeler</a>
    */
  
  
  
  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 <a href="mailto:bh22351@i-one.at">Bernhard Huber</a>
    */
  
  
  
  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 <a href="mailto:rghorpade@onebridge.de"> Rajendra Ghorpade </a>
  - * @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:   <mailto:avalon-cvs-unsubscribe@jakarta.apache.org>
For additional commands, e-mail: <mailto:avalon-cvs-help@jakarta.apache.org>


Mime
View raw message