Return-Path: Delivered-To: apmail-avalon-cvs-archive@www.apache.org Received: (qmail 12538 invoked from network); 4 Dec 2003 21:01:34 -0000 Received: from daedalus.apache.org (HELO mail.apache.org) (208.185.179.12) by minotaur-2.apache.org with SMTP; 4 Dec 2003 21:01:34 -0000 Received: (qmail 43816 invoked by uid 500); 4 Dec 2003 21:01:22 -0000 Delivered-To: apmail-avalon-cvs-archive@avalon.apache.org Received: (qmail 43764 invoked by uid 500); 4 Dec 2003 21:01:22 -0000 Mailing-List: contact cvs-help@avalon.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 cvs@avalon.apache.org Received: (qmail 43741 invoked from network); 4 Dec 2003 21:01:22 -0000 Received: from unknown (HELO minotaur.apache.org) (209.237.227.194) by daedalus.apache.org with SMTP; 4 Dec 2003 21:01:22 -0000 Received: (qmail 12448 invoked by uid 1438); 4 Dec 2003 21:01:32 -0000 Date: 4 Dec 2003 21:01:32 -0000 Message-ID: <20031204210132.12447.qmail@minotaur.apache.org> From: mcconnell@apache.org To: avalon-cvs@apache.org Subject: cvs commit: avalon/util/xdocs/factory index.xml navigation.xml X-Spam-Rating: daedalus.apache.org 1.6.2 0/1000/N X-Spam-Rating: minotaur-2.apache.org 1.6.2 0/1000/N mcconnell 2003/12/04 13:01:32 Modified: util maven.xml util/env/src/java/org/apache/avalon/util/env Env.java util/exception/src/java/org/apache/avalon/util/exception ExceptionHelper.java util/factory/api/src/java/org/apache/avalon/util/factory package.html util/factory/impl/src/java/org/apache/avalon/util/factory/impl Parameter.java Added: util LICENSE.txt project.properties util/xdocs download.xml index.xml navigation.xml util/xdocs/defaults index.xml navigation.xml util/xdocs/env index.xml navigation.xml util/xdocs/exception index.xml navigation.xml util/xdocs/factory index.xml navigation.xml Log: Addition of initial documentation templates. Revision Changes Path 1.2 +35 -0 avalon/util/maven.xml Index: maven.xml =================================================================== RCS file: /home/cvs/avalon/util/maven.xml,v retrieving revision 1.1 retrieving revision 1.2 diff -u -r1.1 -r1.2 --- maven.xml 3 Dec 2003 04:58:13 -0000 1.1 +++ maven.xml 4 Dec 2003 21:01:32 -0000 1.2 @@ -22,4 +22,39 @@ ignoreFailures="false"/> + + + + + + + + + + + + + + + + + + + + + + + + 1.1 avalon/util/LICENSE.txt Index: LICENSE.txt =================================================================== ============================================================================ The Apache Software License, Version 1.1 ============================================================================ Copyright (C) 1997-2003 The Apache Software Foundation. All rights reserved. Redistribution and use in source and binary forms, with or without modifica- tion, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. The end-user documentation included with the redistribution, if any, must include the following acknowledgment: "This product includes software developed by the Apache Software Foundation (http://www.apache.org/)." Alternately, this acknowledgment may appear in the software itself, if and wherever such third-party acknowledgments normally appear. 4. The names "Apache", "Avalon", "Excalibur", "Fortress", "Phoenix", "Merlin" and "Apache Software Foundation" must not be used to endorse or promote products derived from this software without prior written permission. For written permission, please contact apache@apache.org. 5. Products derived from this software may not be called "Apache", nor may "Apache" appear in their name, without prior written permission of the Apache Software Foundation. THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLU- DING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This software consists of voluntary contributions made by many individuals on behalf of the Apache Software Foundation. For more information on the Apache Software Foundation, please see http://www.apache.org/. 1.1 avalon/util/project.properties Index: project.properties =================================================================== # # Banner background and foreground colors. # maven.ui.banner.background = #fff maven.ui.banner.foreground = #000 maven.xdoc.jsl = ./../tools/etc/site.jsl maven.javadoc.stylesheet =${basedir}/../tools/etc/stylesheet.css maven.xdoc.poweredby.image= # # Declaration of the remote links to assign on javadoc generation. # Link declarations can be overriden in the user's build.properties # file. # sun.j2se.link = http://java.sun.com/j2ee/1.4/docs/api/ avalon.util.link = http://avalon.apache.org/merlin/api/ maven.javadoc.links = ${sun.j2se.link},${avalon.util.link} 1.2 +3 -3 avalon/util/env/src/java/org/apache/avalon/util/env/Env.java Index: Env.java =================================================================== RCS file: /home/cvs/avalon/util/env/src/java/org/apache/avalon/util/env/Env.java,v retrieving revision 1.1 retrieving revision 1.2 diff -u -r1.1 -r1.2 --- Env.java 26 Nov 2003 22:25:52 -0000 1.1 +++ Env.java 4 Dec 2003 21:01:32 -0000 1.2 @@ -66,11 +66,11 @@ * Encapsulates operating system and shell specific access to environment * variables. * - * @todo cleanup exception handling which is now in an odd state (constructors) + * TODO cleanup exception handling which is now in an odd state (constructors) * need to be added and or changed. * * @author Alex Karasulu - * @author $Author$ + * @author Stephen McConnell * @version $Revision$ */ public class Env extends Properties 1.2 +1 -2 avalon/util/exception/src/java/org/apache/avalon/util/exception/ExceptionHelper.java Index: ExceptionHelper.java =================================================================== RCS file: /home/cvs/avalon/util/exception/src/java/org/apache/avalon/util/exception/ExceptionHelper.java,v retrieving revision 1.1 retrieving revision 1.2 diff -u -r1.1 -r1.2 --- ExceptionHelper.java 26 Nov 2003 22:25:54 -0000 1.1 +++ ExceptionHelper.java 4 Dec 2003 21:01:32 -0000 1.2 @@ -77,7 +77,6 @@ /** * Returns the exception and causal exceptions as a formatted string. - * @param message the header message * @param e the exception * @return String the formatting string */ @@ -129,7 +128,7 @@ /** * Returns the exception and causal exceptions as a formatted string. * @param message the header message - * @param e the exception + * @param e the exceptions * @param stack TRUE to generate a stack trace * @return String the formatting string */ 1.2 +1 -2 avalon/util/factory/api/src/java/org/apache/avalon/util/factory/package.html Index: package.html =================================================================== RCS file: /home/cvs/avalon/util/factory/api/src/java/org/apache/avalon/util/factory/package.html,v retrieving revision 1.1 retrieving revision 1.2 diff -u -r1.1 -r1.2 --- package.html 2 Dec 2003 23:05:29 -0000 1.1 +++ package.html 4 Dec 2003 21:01:32 -0000 1.2 @@ -1,7 +1,6 @@

-The repository api package defines the repository service contract. This includes operations supporting the establishment of URLs to local cached resources based on -supplied logical artifact descriptions. +The factory api package defines a generic factory interface. The interfaces exposes an operation to establish application defaults, and operations supporting the creation of new instances based on supplied criteria.

1.2 +2 -2 avalon/util/factory/impl/src/java/org/apache/avalon/util/factory/impl/Parameter.java Index: Parameter.java =================================================================== RCS file: /home/cvs/avalon/util/factory/impl/src/java/org/apache/avalon/util/factory/impl/Parameter.java,v retrieving revision 1.1 retrieving revision 1.2 diff -u -r1.1 -r1.2 --- Parameter.java 2 Dec 2003 23:05:30 -0000 1.1 +++ Parameter.java 4 Dec 2003 21:01:32 -0000 1.2 @@ -175,7 +175,7 @@ /** * Resolve a supplied argument to a value. - * @param arg the supplied argument + * @param value the supplied argument * @return the resolved object * @exception Exception if an error occurs */ 1.1 avalon/util/xdocs/download.xml Index: download.xml =================================================================== Stephen McConnell Avalon Repository Resource - Download

Pending formal release, the utilities are available from DPML/avalon-uitilities. Please note that interim and snapshot builds are not subject to a formal release review process.

1.1 avalon/util/xdocs/index.xml Index: index.xml =================================================================== Stephen McConnell Avalon Repository

Welcome to the Avalon Utilities Home Page.

Within Avalon there are a number of emerging container facilities and tools. The facilties provide the famework for the delivery of open and adaptive solutions to container construction and component maangement. In the development of these facilities, a number of common low-level utilities have evolved and are collected here. Typically these utilities are either a single class, or a very small number of classes dealing with a specific concern. The following table provides a brief overview of the current set of utilities.

UtilityDescription
Defaults Collection and consilidation of properties.
Environment A static class that provides access to environment variables across different operating systems.
Exception A static class that provides support for report generation from cascading exceptions.
Factory A generic factory interface and a default map implementation.
1.1 avalon/util/xdocs/navigation.xml Index: navigation.xml =================================================================== Avalon Utilities 1.1 avalon/util/xdocs/defaults/index.xml Index: index.xml =================================================================== Stephen McConnell Avalon Utilities - Defaults

IN PREPARATION

1.1 avalon/util/xdocs/defaults/navigation.xml Index: navigation.xml =================================================================== Avalon Utilities 1.1 avalon/util/xdocs/env/index.xml Index: index.xml =================================================================== Stephen McConnell Avalon Utilities - Environment

IN PREPARATION

1.1 avalon/util/xdocs/env/navigation.xml Index: navigation.xml =================================================================== Avalon Utilities 1.1 avalon/util/xdocs/exception/index.xml Index: index.xml =================================================================== Stephen McConnell Avalon Utilities - Exception

IN PREPARATION

1.1 avalon/util/xdocs/exception/navigation.xml Index: navigation.xml =================================================================== Avalon Utilities 1.1 avalon/util/xdocs/factory/index.xml Index: index.xml =================================================================== Stephen McConnell Avalon Utilities - Factory

IN PREPARATION

1.1 avalon/util/xdocs/factory/navigation.xml Index: navigation.xml =================================================================== Avalon Utilities --------------------------------------------------------------------- To unsubscribe, e-mail: cvs-unsubscribe@avalon.apache.org For additional commands, e-mail: cvs-help@avalon.apache.org