avalon-cvs mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From mcconn...@apache.org
Subject cvs commit: avalon/util/xdocs/plugin index.xml
Date Thu, 11 Dec 2003 10:02:06 GMT
mcconnell    2003/12/11 02:02:06

  Modified:    util/exception/src/test/org/apache/avalon/util/exception
                        ExceptionHelperTest.java
               util/xdocs/exception index.xml
               util/xdocs/plugin index.xml
  Log:
  Complete docs.
  
  Revision  Changes    Path
  1.2       +3 -2      avalon/util/exception/src/test/org/apache/avalon/util/exception/ExceptionHelperTest.java
  
  Index: ExceptionHelperTest.java
  ===================================================================
  RCS file: /home/cvs/avalon/util/exception/src/test/org/apache/avalon/util/exception/ExceptionHelperTest.java,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- ExceptionHelperTest.java	26 Nov 2003 22:25:54 -0000	1.1
  +++ ExceptionHelperTest.java	11 Dec 2003 10:02:06 -0000	1.2
  @@ -45,7 +45,7 @@
                "Composite exception report", 
                new Throwable[]{ e1, e2 }, false );
           assertNotNull( message );
  -        System.out.println( message );
  +        //System.out.println( message );
       }
   
       final public void testExceptionWithMessageReport()
  @@ -59,6 +59,7 @@
           {
               final String message = 
                 ExceptionHelper.packException( "An error occured.", e );
  +            //System.out.println( message );
               assertNotNull( message );
           }
       }
  
  
  
  1.2       +33 -1     avalon/util/xdocs/exception/index.xml
  
  Index: index.xml
  ===================================================================
  RCS file: /home/cvs/avalon/util/xdocs/exception/index.xml,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- index.xml	4 Dec 2003 21:01:32 -0000	1.1
  +++ index.xml	11 Dec 2003 10:02:06 -0000	1.2
  @@ -56,7 +56,39 @@
     <body>
       <section name="Exception">
         <subsection name="Overview">
  -        <p>IN PREPARATION</p>
  +        <p>The exception utility contains a single class ExceptionHelper
  +        that provides a set of static methods for generating exception
  +        reports that take into consideration a causal chain.</p>
  +        <source>
  +
  +try
  +{
  +    // do stuff
  +}
  +catch( Throwable e )
  +{
  +    final String message = 
  +      "A problem occured.";
  +    final String error = ExceptionHelper.packException( message, e, true );
  +    System.out.println( error );
  +}</source>
  +
  +        <p>The above code results in the creation of report similar to 
  +         the following:</p>
  +
  +<source>
  +---- exception report ----------------------------------------------------------
  +An error occured.
  +Exception: org.apache.avalon.util.exception.StandardException
  +Message: Unable to do something due to a error condition.
  +---- cause ---------------------------------------------------------------------
  +Exception: org.apache.avalon.util.exception.StandardRuntimeException
  +Message: Unable to do something else due to a error condition.
  +---- cause ---------------------------------------------------------------------
  +Exception: org.apache.avalon.util.exception.StandardError
  +Message: Raising exception because that's what I'm programmed to do.
  +--------------------------------------------------------------------------------      
 </source>
  +
         </subsection>
       </section>
     </body>
  
  
  
  1.2       +88 -1     avalon/util/xdocs/plugin/index.xml
  
  Index: index.xml
  ===================================================================
  RCS file: /home/cvs/avalon/util/xdocs/plugin/index.xml,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- index.xml	8 Dec 2003 09:33:28 -0000	1.1
  +++ index.xml	11 Dec 2003 10:02:06 -0000	1.2
  @@ -56,7 +56,94 @@
     <body>
       <section name="Maven Plugin">
         <subsection name="Overview">
  -        <p>IN PREPARATION</p>
  +        <p>The avalon plugin provides support for the generation 
  +        of classloader metadata associated with a jar file.</p>
  +        <p>The generation of metyada is triggered using the following goal:</p>
  +        <source>
  +avalon:artifact
  +</source>
  +        <p>The goal generates a file with the same name as the 
  +        jar artifact + ".meta".</p>
  +
  +        <p>An example from the merlin/kernel/impl project is included below.</p>
  +
  +        <source>
  +
  +#
  +# Meta classifier.
  +# 
  +
  +meta.domain = avalon
  +meta.version = 1.0
  +
  +#
  +# Artifact descriptor.
  +# 
  +
  +avalon.artifact.group = merlin
  +avalon.artifact.name = merlin-impl
  +avalon.artifact.version = 3.2-dev
  +avalon.artifact.signature = 20031211.044644
  +
  +#
  +# API dependencies.
  +#
  +
  +avalon.artifact.dependency.api.0 = merlin:merlin-api;3.2-dev
  +avalon.artifact.dependency.api.1 = avalon-activation:avalon-activation-api;1.2.1-dev
  +avalon.artifact.dependency.api.2 = avalon-repository:avalon-repository-api;1.2-dev
  +avalon.artifact.dependency.api.3 = avalon-composition:avalon-composition-api;1.2.1-dev
  +avalon.artifact.dependency.api.4 = avalon-meta:avalon-meta-api;1.2.1-dev
  +avalon.artifact.dependency.api.5 = avalon-extension:avalon-extension-spi;1.0
  +avalon.artifact.dependency.api.6 = avalon-framework:avalon-framework-api;4.1.5
  +avalon.artifact.dependency.api.7 = excalibur-lifecycle:excalibur-lifecycle-api;1.0
  +avalon.artifact.dependency.api.8 = xml-apis:xml-apis;2.0.2
  +avalon.artifact.dependency.api.9 = xml-apis:xmlParserAPIs;2.0.2
  +
  +#
  +# SPI dependencies.
  +#
  +
  +avalon.artifact.dependency.spi.0 = avalon-activation:avalon-activation-spi;1.2.2-dev
  +avalon.artifact.dependency.spi.1 = avalon-repository:avalon-repository-spi;1.2-dev
  +avalon.artifact.dependency.spi.2 = avalon-composition:avalon-composition-spi;1.2.1-dev
  +avalon.artifact.dependency.spi.3 = avalon-meta:avalon-meta-spi;1.2.1-dev
  +
  +#
  +# Implementation dependencies.
  +#
  +
  +avalon.artifact.dependency.0 = avalon-activation:avalon-activation-impl;1.2.3-dev
  +avalon.artifact.dependency.1 = avalon-composition:avalon-composition-impl;1.2.2-dev
  +avalon.artifact.dependency.2 = avalon-meta:avalon-meta-impl;1.2.1-dev
  +avalon.artifact.dependency.3 = avalon-extension:avalon-extension-impl;1.0
  +avalon.artifact.dependency.4 = avalon-framework:avalon-framework-impl;4.1.5
  +avalon.artifact.dependency.5 = avalon-util:avalon-util-defaults;1.1-dev
  +avalon.artifact.dependency.6 = avalon-util:avalon-util-env;1.0-dev
  +avalon.artifact.dependency.7 = avalon-util:avalon-util-exception;1.0-dev
  +avalon.artifact.dependency.8 = avalon-util:avalon-util-criteria;1.0-dev
  +avalon.artifact.dependency.9 = logkit:logkit;1.2
  +avalon.artifact.dependency.10 = excalibur-i18n:excalibur-i18n;1.1
  +avalon.artifact.dependency.11 = excalibur-configuration:excalibur-configuration;1.1
  +avalon.artifact.dependency.12 = excalibur-event:excalibur-event;1.0.3
  +avalon.artifact.dependency.13 = excalibur:excalibur-util-concurrent;1.3.1
  +avalon.artifact.dependency.14 = mx4j:mx4j-jmx;1.1.1
  +avalon.artifact.dependency.15 = mx4j:mx4j-tools;1.1.1
  +avalon.artifact.dependency.16 = commons-collections:commons-collections;2.1
  +avalon.artifact.dependency.17 = xerces:xerces;2.4.0
  +
  +#
  +# Factory.
  +#
  +
  +avalon.artifact.factory = org.apache.avalon.merlin.impl.DefaultFactory
  +
  +#
  +# EOF
  +#
  +
  +        </source>
  +
         </subsection>
       </section>
     </body>
  
  
  

---------------------------------------------------------------------
To unsubscribe, e-mail: cvs-unsubscribe@avalon.apache.org
For additional commands, e-mail: cvs-help@avalon.apache.org


Mime
View raw message