You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@commons.apache.org by sc...@apache.org on 2003/12/05 23:22:09 UTC
cvs commit: jakarta-commons-sandbox/events/xdocs index.xml navigation.xml .cvsignore
scolebourne 2003/12/05 14:22:09
Added: events maven.xml build.properties.sample STATUS.html
project.xml checkstyle.xml build.xml
DEVELOPERS-GUIDE.html LICENSE.txt .cvsignore
project.properties
events/xdocs index.xml navigation.xml .cvsignore
Log:
Initial checkin
Revision Changes Path
1.1 jakarta-commons-sandbox/events/maven.xml
Index: maven.xml
===================================================================
<project default="java:jar" xmlns:j="jelly:core">
<!--postGoal name="xdoc:register-reports">
<attainGoal name="maven-checkstyle-plugin:deregister"/>
<attainGoal name="maven-linkcheck-plugin:deregister"/>
</postGoal-->
</project>
1.1 jakarta-commons-sandbox/events/build.properties.sample
Index: build.properties.sample
===================================================================
# The directory containing your binary distribution of JUnit,
# version 3.8.1 or later
junit.home = /usr/local/junit3.8.1
# The pathname of the "junit.jar" JAR file
junit.jar = ${junit.home}/junit.jar
1.1 jakarta-commons-sandbox/events/STATUS.html
Index: STATUS.html
===================================================================
<html>
<head>
<title>Status File for Jakarta Commons "Events" Package</title>
<head>
<body bgcolor="white">
<div align="center">
<h1>The Jakarta Commons <em>Events</em> Package</h1>
$Id: STATUS.html,v 1.1 2003/12/05 22:22:09 scolebourne Exp $<br>
<a href="#Introduction">[Introduction]</a>
<a href="#Dependencies">[Dependencies]</a>
<a href="#Release Info">[Release Info]</a>
<a href="#Committers">[Committers]</a>
<a href="#Action Items">[Action Items]</a>
<br><br>
</div>
<a name="Introduction"></a>
<h3>1. INTRODUCTION</h3>
<p>The <em>Observables</em> package contains a set of Java classes to allow
changes to collections to be easily observed.
<a name="Dependencies"></a>
<h3>2. DEPENDENCIES</h3>
<p>The <em>Events</em> package is dependent upon the following external
components for development and use:</p>
<ul>
<li><a href="http://jakarta.apache.org/commons/collections">Commons Collections</a>
<li><a href="http://java.sun.com/j2se">Java Development Kit</a>
(Version 1.2 or later)</li>
<li><a href="http://www.junit.org">JUnit Testing Framework</a>
(Version 3.7 or later) - for unit tests only, not required
for deployment</li>
</ul>
<a name="Release Info"></a>
<h3>3. RELEASE INFO</h3>
<p>No release yet...</p>
<a name="Committers"></a>
<h3>4. COMMITTERS</h3>
<p>The following individuals are the primary developers and maintainers of this
component. Developers who plan to use <em>Events</em> in their own
projects are encouraged to collaborate on the future development of this
component to ensure that it continues to meet a variety of needs.</p>
<ul>
<li><a href="mailto:scolebourne@apache.org">Stephen Colebourne</a></li>
<li><a href="mailto:neilotoole@apache.org">Neil O'Toole</a></li>
</ul>
<a name="Action Items"></a>
<h3>5. ACTION ITEMS</h3>
<p>Want to help? Here's some "to do" items the team has identified.</p>
<table border="1">
<tr>
<th width="80%">Action Item</th>
<th width="20%">Volunteer</th>
</tr>
<tr>
<td><strong>Unify design</strong>. More than one design currently exists for
collections events. These designs should be unified (multiple event designs
are allowed, but there should only be one event firing design)</td>
<td align="center"> </td>
</tr>
<tr>
<td><strong>ObservableMap</strong>. A map implementation that can be observed.</td>
<td align="center"> </td>
</tr>
<tr>
<td><strong>Observed exceptions</strong>. The ability to observe exceptions thrown
when calling an observed method.</td>
<td align="center"> </td>
</tr>
<tr>
<td><strong>Rich events</strong>. A full rich event package with detailed information
about each event.</td>
<td align="center"> </td>
</tr>
<tr>
<td><strong>Event playback</strong>. Add the ability to playback events.</td>
<td align="center"> </td>
</tr>
<tr>
<td><strong>Simple events</strong>. A simple event implementation that just
indicates something has changed (no detail).</td>
<td align="center"> </td>
</tr>
</table>
</body>
</html>
1.1 jakarta-commons-sandbox/events/project.xml
Index: project.xml
===================================================================
<?xml version="1.0"?>
<project>
<extend>../project.xml</extend>
<id>commons-events</id>
<name>Commons Events</name>
<currentVersion>0.5-dev</currentVersion>
<inceptionYear>2003</inceptionYear>
<package>org.apache.commons.collections.events</package>
<!--url>http://jakarta.apache.org/commons/events/index.html</url-->
<!--mailingLists>
<mailingList>
<name>Commons Dev List</name>
<subscribe>commons-dev-subscribe@jakarta.apache.org</subscribe>
<unsubscribe>commons-dev-unsubscribe@jakarta.apache.org</unsubscribe>
<archive>http://nagoya.apache.org/eyebrowse/SummarizeList?listName=commons-dev@jakarta.apache.org</archive>
</mailingList>
<mailingList>
<name>Commons User List</name>
<subscribe>commons-user-subscribe@jakarta.apache.org</subscribe>
<unsubscribe>commons-user-unsubscribe@jakarta.apache.org</unsubscribe>
<archive>http://nagoya.apache.org/eyebrowse/SummarizeList?listName=commons-user@jakarta.apache.org</archive>
</mailingList>
</mailingLists-->
<description>
Commons Events is a set of classes to enable changes to objects to be observed.
It includes wrappers for other classes, notably collections, and the associated
events and event handling mechanisms.
</description>
<shortDescription>Apache Jakarta Commons Events</shortDescription>
<developers>
<developer>
<name>Stephen Colebourne</name>
<id>scolebourne</id>
<email>scolebourne@apache.org</email>
</developer>
</developers>
<contributors>
</contributors>
<dependencies>
<!-- compile time dependencies -->
<dependency>
<id>junit</id>
<version>3.8.1</version>
<url>http://www.junit.org/</url>
</dependency>
<!-- run time dependencies -->
<dependency>
<id>commons-collections</id>
<version>SNAPSHOT</version>
<url>http://jakarta.apache.org/commons/collections/</url>
</dependency>
<!-- maven dependencies -->
<dependency>
<id>jdepend</id>
<version>2.5</version>
</dependency>
</dependencies>
<build>
<sourceDirectory>src/java</sourceDirectory>
<unitTest>
<includes>
<include>org/apache/commons/collections/events/**/Test*.java</include>
</includes>
<excludes>
<exclude>org/apache/commons/collections/events/**/*All*.java</exclude>
</excludes>
</unitTest>
</build>
<reports>
<report>maven-changelog-plugin</report>
<report>maven-changes-plugin</report>
<report>maven-checkstyle-plugin</report>
<!-- <report>maven-clover-plugin</report> -->
<report>maven-jcoverage-plugin</report>
<report>maven-developer-activity-plugin</report>
<report>maven-file-activity-plugin</report>
<report>maven-javadoc-plugin</report>
<!-- <report>maven-jellydoc-plugin</report> -->
<report>maven-junit-report-plugin</report>
<report>maven-jxr-plugin</report>
<report>maven-license-plugin</report>
<!--report>maven-linkcheck-plugin</report-->
<!--report>maven-statcvs-plugin</report-->
<!--report>maven-tasklist-plugin</report-->
</reports>
</project>
1.1 jakarta-commons-sandbox/events/checkstyle.xml
Index: checkstyle.xml
===================================================================
<?xml version="1.0"?>
<!DOCTYPE module PUBLIC
"-//Puppy Crawl//DTD Check Configuration 1.1//EN"
"http://www.puppycrawl.com/dtds/configuration_1_1.dtd">
<!-- commons lang customization of default Checkstyle behavior -->
<module name="Checker">
<property name="basedir" value="."/>
<property name="localeLanguage" value="en"/>
<module name="PackageHtml"/>
<module name="TreeWalker">
<module name="TabCharacter"/>
<module name="AvoidStarImport"/>
<module name="RedundantImport"/>
<module name="UnusedImports"/>
<module name="NeedBraces"/>
<module name="WhitespaceAfter"/>
<module name="WhitespaceAround"/>
<module name="ModifierOrder"/>
<module name="RedundantModifier"/>
<module name="EmptyBlock"/>
<module name="LeftCurly"/>
<module name="NeedBraces"/>
<module name="RightCurly"/>
<module name="UpperEll"/>
<module name="ArrayTypeStyle"/>
<module name="Indentation"/>
<module name="GenericIllegalRegexp">
<property name="format" value="System\.out\.println"/>
</module>
<module name="GenericIllegalRegexp">
<property name="format" value="System\.err\.println"/>
</module>
<module name="GenericIllegalRegexp">
<property name="format" value="\.printStackTrace"/>
</module>
<module name="IllegalInstantiation">
<property name="classes" value="java.lang.Boolean"/>
</module>
<module name="RedundantThrows">
<property name="allowUnchecked" value="true"/>
</module>
<module name="LineLength">
<property name="max" value="120"/>
</module>
<module name="JavadocVariable"/>
<module name="JavadocMethod">
<property name="allowUndeclaredRTE" value="true"/>
</module>
</module>
</module>
1.1 jakarta-commons-sandbox/events/build.xml
Index: build.xml
===================================================================
<project name="events" default="compile" basedir=".">
<!--
"Events" component of the Jakarta Commons Subproject
$Id: build.xml,v 1.1 2003/12/05 22:22:09 scolebourne Exp $
-->
<!-- ========== Initialize Properties ===================================== -->
<property file="build.properties"/> <!-- Component local -->
<property file="../build.properties"/> <!-- Commons local -->
<property file="${user.home}/build.properties"/> <!-- User local -->
<!-- ========== External Dependencies ===================================== -->
<!-- The directory containing your binary distribution of JUnit,
version 3.8.1 or later -->
<property name="junit.home" value="/usr/local/junit3.8.1"/>
<!-- ========== Derived Values ============================================ -->
<!-- The pathname of the "junit.jar" JAR file -->
<property name="junit.jar" value="${junit.home}/junit.jar"/>
<!-- ========== Component Declarations ==================================== -->
<!-- The name of this component -->
<property name="component.name" value="events"/>
<!-- The primary package name of this component -->
<property name="component.package" value="org.apache.commons.events"/>
<!-- The title of this component -->
<property name="component.title" value="Event management utilities"/>
<!-- The current version number of this component -->
<property name="component.version" value="0.1-dev"/>
<!-- The final name of the component -->
<property name="final.name" value="commons-${component.name}-${component.version}"/>
<!-- The final source name of the component -->
<property name="final.name.src" value="${final.name}-src"/>
<!-- The base directory for component sources -->
<property name="source" value="src"/>
<!-- The base directory for component sources -->
<property name="source.home" value="src/java"/>
<!-- The base directory for unit test sources -->
<property name="test.home" value="src/test"/>
<!-- The base directory for component configuration files -->
<property name="conf.home" value="src/conf"/>
<!-- The base directory for targets -->
<property name="target" value="target"/>
<!-- The directory for compiled classes -->
<property name="target.class" value="${target}/classes"/>
<!-- The directory for compiled test classes -->
<property name="target.class.test" value="${target}/test-classes"/>
<!-- The directory for filtered conf files -->
<property name="target.conf" value="${target}/conf"/>
<!-- The directory for javadoc -->
<property name="target.javadoc" value="${target}/docs"/>
<!-- The base directory for assembling zips -->
<property name="target.assembly" value="${target}/${final.name}"/>
<!-- The base directory for assembling zips -->
<property name="target.assembly.src" value="${target}/${final.name.src}"/>
<!-- ========== Compiler Defaults ========================================= -->
<!-- Should Java compilations set the 'debug' compiler option? -->
<property name="compile.debug" value="true"/>
<!-- Should Java compilations set the 'deprecation' compiler option? -->
<property name="compile.deprecation" value="true"/>
<!-- Should Java compilations set the 'optimize' compiler option? -->
<property name="compile.optimize" value="true"/>
<!-- Construct compile classpath -->
<path id="compile.classpath">
<pathelement location="${target}/classes"/>
<pathelement location="../collections/bin"/> <!-- TODO CHANGE !!! -->
</path>
<!-- ========== Test Execution Defaults =================================== -->
<!-- Construct unit test classpath -->
<path id="test.classpath">
<pathelement location="${target.class}"/>
<pathelement location="${target.class.test}"/>
<pathelement location="${junit.jar}"/>
<pathelement location="../collections/bin"/> <!-- TODO CHANGE !!! -->
<pathelement location="${collections-testframework.jar}"/>
</path>
<!-- Should all tests fail if one does? -->
<property name="test.failonerror" value="true"/>
<!-- The test runner to execute -->
<property name="test.runner" value="junit.textui.TestRunner"/>
<!-- ========== Executable Targets ======================================== -->
<target name="init" description="Initialize and evaluate conditionals">
<echo message="-------- ${component.name} ${component.version} --------"/>
<filter token="name" value="${component.name}"/>
<filter token="package" value="${component.package}"/>
<filter token="version" value="${component.version}"/>
</target>
<target name="prepare" depends="init" description="Prepare build directory">
<mkdir dir="${target}"/>
<mkdir dir="${target.class}"/>
<mkdir dir="${target.class.test}"/>
<mkdir dir="${target.conf}"/>
</target>
<target name="static" depends="prepare" description="Copy static files to build directory">
<tstamp/>
<copy todir="${target.conf}" filtering="on">
<fileset dir="${conf.home}" includes="*.MF"/>
</copy>
</target>
<target name="compile" depends="static" description="Compile main classes">
<javac srcdir="${source.home}"
destdir="${target.class}"
debug="${compile.debug}"
deprecation="${compile.deprecation}"
optimize="${compile.optimize}">
<classpath refid="compile.classpath"/>
</javac>
</target>
<target name="compile.tests" depends="compile" description="Compile unit test classes">
<javac srcdir="${test.home}"
destdir="${target.class.test}"
debug="${compile.debug}"
deprecation="${compile.deprecation}"
optimize="${compile.optimize}">
<classpath refid="test.classpath"/>
</javac>
</target>
<target name="jar" depends="compile" description="Create jar">
<mkdir dir="${target.class}/META-INF"/>
<copy file="LICENSE.txt" tofile="${target.class}/META-INF/LICENSE.txt"/>
<jar jarfile="${target}/${final.name}.jar"
basedir="${target.class}"
manifest="${target.conf}/MANIFEST.MF"/>
</target>
<target name="clean" description="Clean build and distribution directories">
<delete dir="${target}"/>
</target>
<target name="all" depends="clean,compile" description="Clean and compile all components"/>
<target name="javadoc" depends="compile" description="Create component Javadoc documentation">
<mkdir dir="${target.javadoc}/api"/>
<javadoc sourcepath="${source.home}"
destdir="${target.javadoc}/api"
packagenames="org.apache.commons.*"
author="true"
private="true"
version="true"
doctitle="<h1>${component.title}</h1>"
windowtitle="${component.title} (Version ${component.version})"
bottom="Copyright (c) 2002-2003 - Apache Software Foundation">
<classpath refid="compile.classpath"/>
</javadoc>
</target>
<target name="dist" depends="dist-bin,dist-src" description="Create distribution">
</target>
<target name="dist-bin" depends="compile,test,jar,javadoc" description="Create binary distribution">
<mkdir dir="${target.assembly}"/>
<copy file="LICENSE.txt" todir="${target.assembly}"/>
<copy file="RELEASE-NOTES.txt" todir="${target.assembly}"/>
<copy file="${target}/${final.name}.jar" todir="${target.assembly}"/>
<mkdir dir="${target.assembly}/docs"/>
<copy todir="${target.assembly}/docs">
<fileset dir="${target.javadoc}"/>
</copy>
<tar destfile="${target}/${final.name}.tar" basedir="${target.assembly}"/>
<gzip zipfile="${target}/${final.name}.tar.gz" src="${target}/${final.name}.tar"/>
<delete file="${target}/${final.name}.tar"/>
<fixcrlf srcdir="${target.assembly}" eol="crlf" includes="**/*.txt"/>
<zip destfile="${target}/${final.name}.zip" basedir="${target.assembly}"/>
<delete dir="${target.assembly}"/>
</target>
<target name="dist-src" depends="compile,test,jar" description="Create source distribution">
<mkdir dir="${target.assembly.src}"/>
<copy file="LICENSE.txt" todir="${target.assembly.src}"/>
<copy file="RELEASE-NOTES.txt" todir="${target.assembly.src}"/>
<copy file="build.xml" todir="${target.assembly.src}"/>
<copy file="maven.xml" todir="${target.assembly.src}"/>
<copy file="project.properties" todir="${target.assembly.src}"/>
<copy file="project.xml" todir="${target.assembly.src}"/>
<copy file="checkstyle.xml" todir="${target.assembly.src}"/>
<copy file="${target}/${final.name}.jar" todir="${target.assembly.src}"/>
<mkdir dir="${target.assembly.src}/${source}"/>
<copy todir="${target.assembly.src}/${source}">
<fileset dir="${source}"/>
</copy>
<tar destfile="${target}/${final.name.src}.tar" basedir="${target.assembly.src}"/>
<gzip zipfile="${target}/${final.name.src}.tar.gz" src="${target}/${final.name.src}.tar"/>
<delete file="${target}/${final.name.src}.tar"/>
<fixcrlf srcdir="${target.assembly.src}" eol="crlf" includes="**/*.txt"/>
<fixcrlf srcdir="${target.assembly.src}" eol="crlf" includes="**/*.xml"/>
<fixcrlf srcdir="${target.assembly.src}" eol="crlf" includes="**/*.properties"/>
<zip destfile="${target}/${final.name.src}.zip" basedir="${target.assembly.src}"/>
<delete dir="${target.assembly.src}"/>
</target>
<!-- ========== Unit Test Targets ========================================= -->
<target name="test" depends="compile.tests"
description="Run all unit test cases">
<java classname="${test.runner}" fork="yes"
failonerror="${test.failonerror}">
<arg value="org.apache.commons.events.AllTestSuite"/>
<classpath refid="test.classpath"/>
</java>
</target>
</project>
1.1 jakarta-commons-sandbox/events/DEVELOPERS-GUIDE.html
Index: DEVELOPERS-GUIDE.html
===================================================================
<html>
<head>
<title>Developers guide for Jakarta Commons "Events" Package</title>
<head>
<body bgcolor="white">
<div align="center">
<h1>The Jakarta Commons <em>Events</em> Package</h1>
<h2>Developers Guide</h2>
$Id: DEVELOPERS-GUIDE.html,v 1.1 2003/12/05 22:22:09 scolebourne Exp $<br>
<a href="#Introduction">[Introduction]</a>
<a href="#CodingStandards">[Coding standards]</a>
<a href="#DevelopmentGuide">[Development guide]</a>
<br><br>
</div>
<a name="Introduction"></a>
<h3>1. INTRODUCTION</h3>
<p>The <em>Events</em> package contains a set of Java classes that enable
other classes, notably collections, to be observed. In other words, any changes
made to a class can be observed by listeners.
This document outlines the coding and development standards to use.
</p>
<a name="CodingStandards"></a>
<h3>2. CODING STANDARDS</h3>
<p>
Events will follow the Sun coding standards. In particular:
</p>
<ul>
<li>no tabs - indent using 4 spaces
<li>brackets around each block - includes single line if and loop statements
<li>open bracket at end of line
<li>single space after keywords and cast
</ul>
<a name="DevelopmentGuide"></a>
<h3>3. DEVELOPMENT GUIDE</h3>
<p>
The Events package shall build upon other Java designs.
The Java collections framework will be used as the basis for collections design.
Event handling will be based on Java event design.
This paragraph does not prevent alternative implementations, however these should be additional.
</p>
</body>
</html>
1.1 jakarta-commons-sandbox/events/LICENSE.txt
Index: LICENSE.txt
===================================================================
/* ====================================================================
* The Apache Software License, Version 1.1
*
* Copyright (c) 2003 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, 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 acknowledgement:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowledgement may appear in the software itself,
* if and wherever such third-party acknowledgements normally appear.
*
* 4. The names "The Jakarta Project", "Commons", 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 names 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 (INCLUDING, 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 jakarta-commons-sandbox/events/.cvsignore
Index: .cvsignore
===================================================================
build.properties
.classpath
.project
1.1 jakarta-commons-sandbox/events/project.properties
Index: project.properties
===================================================================
maven.checkstyle.properties=checkstyle.xml
maven.junit.fork=true
maven.xdoc.date = left
maven.xdoc.poweredby.image=maven-feather.png
maven.javadoc.links=http://java.sun.com/products/jdk/1.4/docs/api
1.1 jakarta-commons-sandbox/events/xdocs/index.xml
Index: index.xml
===================================================================
<?xml version="1.0"?>
<document>
<properties>
<title>Apache Jakarta Commons Events</title>
<author email="commons-dev@jakarta.apache.org">Commons Documentation Team</author>
</properties>
<body>
<section name="The Events Component">
<p>
Apache Jakarta Commons Events provides additional classes for firing and handling events.
It focusses on the Java Collections Framework, providing decorators to other collections
that fire events.
</p>
</section>
<section name="Status">
<p>
Commons Events has not yet had a release, and is waiting further development.
</p>
</section>
</body>
</document>
1.1 jakarta-commons-sandbox/events/xdocs/navigation.xml
Index: navigation.xml
===================================================================
<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE project [
<!ENTITY commons-nav SYSTEM "../../incl_nav.xml">
]>
<project name="Events">
<title>Events</title>
<organizationLogo href="/images/jakarta-logo-blue.gif">Jakarta</organizationLogo>
<body>
<menu name="Commons Events">
<item name="Overview" href="/index.html"/>
</menu>
&commons-nav;
</body>
</project>
1.1 jakarta-commons-sandbox/events/xdocs/.cvsignore
Index: .cvsignore
===================================================================
stylesheets
---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org