You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by ch...@apache.org on 2012/07/06 05:51:40 UTC
svn commit: r1358034 - in /commons/sandbox/classscan/trunk: ./
api/src/main/java/org/apache/commons/classscan/builtin/
api/src/main/java/org/apache/commons/classscan/spi/model/
api/src/main/java/org/apache/commons/classscan/util/ parent/ src/site/
src/...
Author: chas
Date: Fri Jul 6 03:51:39 2012
New Revision: 1358034
URL: http://svn.apache.org/viewvc?rev=1358034&view=rev
Log:
clean up ClassScan reports
Added:
commons/sandbox/classscan/trunk/src/site/xdoc/issue-tracking.xml
Modified:
commons/sandbox/classscan/trunk/api/src/main/java/org/apache/commons/classscan/builtin/package-info.java
commons/sandbox/classscan/trunk/api/src/main/java/org/apache/commons/classscan/spi/model/SpiClassPath.java
commons/sandbox/classscan/trunk/api/src/main/java/org/apache/commons/classscan/util/ServiceVisitor.java
commons/sandbox/classscan/trunk/api/src/main/java/org/apache/commons/classscan/util/package-info.java
commons/sandbox/classscan/trunk/parent/pom.xml
commons/sandbox/classscan/trunk/pom.xml
commons/sandbox/classscan/trunk/src/site/site.xml
commons/sandbox/classscan/trunk/src/site/xdoc/building.xml
commons/sandbox/classscan/trunk/src/site/xdoc/index.xml
commons/sandbox/classscan/trunk/src/site/xdoc/userguide.xml
Modified: commons/sandbox/classscan/trunk/api/src/main/java/org/apache/commons/classscan/builtin/package-info.java
URL: http://svn.apache.org/viewvc/commons/sandbox/classscan/trunk/api/src/main/java/org/apache/commons/classscan/builtin/package-info.java?rev=1358034&r1=1358033&r2=1358034&view=diff
==============================================================================
--- commons/sandbox/classscan/trunk/api/src/main/java/org/apache/commons/classscan/builtin/package-info.java (original)
+++ commons/sandbox/classscan/trunk/api/src/main/java/org/apache/commons/classscan/builtin/package-info.java Fri Jul 6 03:51:39 2012
@@ -13,8 +13,8 @@
*/
/**
* <p>This package contains builtin implementations of the {@link org.apache.commons.classscan.spi} providers.</p>
- * <p>The {@link DefaultClassPathFactory} provider supports the URLClassLoader and Sun boostrap classLoader.</p>
- * <p>The {@link DefaultClassPathElementFactory} provider supports "jar" and "file" URL schemes.</p>
+ * <p>The {@link org.apache.commons.classscan.builtin.DefaultClassPathFactory DefaultClassPathFactory} provider supports the URLClassLoader and Sun boostrap classLoader.</p>
+ * <p>The {@link org.apache.commons.classscan.builtin.DefaultClassPathElementFactory DefaultClassPathElementFactory} provider supports "jar" and "file" URL schemes.</p>
* <p><b>The non-public methods in these classes are subject to change in any release.</b></p>
*/
package org.apache.commons.classscan.builtin;
Modified: commons/sandbox/classscan/trunk/api/src/main/java/org/apache/commons/classscan/spi/model/SpiClassPath.java
URL: http://svn.apache.org/viewvc/commons/sandbox/classscan/trunk/api/src/main/java/org/apache/commons/classscan/spi/model/SpiClassPath.java?rev=1358034&r1=1358033&r2=1358034&view=diff
==============================================================================
--- commons/sandbox/classscan/trunk/api/src/main/java/org/apache/commons/classscan/spi/model/SpiClassPath.java (original)
+++ commons/sandbox/classscan/trunk/api/src/main/java/org/apache/commons/classscan/spi/model/SpiClassPath.java Fri Jul 6 03:51:39 2012
@@ -25,7 +25,7 @@ public interface SpiClassPath extends Cl
* Create a MetaClassLoader that will inspect the classes specified by this ClassPath
* @param registry
* @param classLoader
- * @return
+ * @return metadata about ClassLoader
*/
SpiMetaClassLoader createMetaClassLoader(SpiMetaRegistry registry, ClassLoader classLoader);
}
Modified: commons/sandbox/classscan/trunk/api/src/main/java/org/apache/commons/classscan/util/ServiceVisitor.java
URL: http://svn.apache.org/viewvc/commons/sandbox/classscan/trunk/api/src/main/java/org/apache/commons/classscan/util/ServiceVisitor.java?rev=1358034&r1=1358033&r2=1358034&view=diff
==============================================================================
--- commons/sandbox/classscan/trunk/api/src/main/java/org/apache/commons/classscan/util/ServiceVisitor.java (original)
+++ commons/sandbox/classscan/trunk/api/src/main/java/org/apache/commons/classscan/util/ServiceVisitor.java Fri Jul 6 03:51:39 2012
@@ -35,8 +35,8 @@ public abstract class ServiceVisitor<T>
* @param serviceInterface The interface of the service
* @param classLoader The ClassLoader which will load the service
*/
- public void visitProviders(Class<T> factoryClass, ClassLoader classLoader) {
- Iterator<T> factories = ServiceLoader.load(factoryClass, classLoader).iterator();
+ public void visitProviders(Class<T> serviceInterface, ClassLoader classLoader) {
+ Iterator<T> factories = ServiceLoader.load(serviceInterface, classLoader).iterator();
for(;;) {
// this odd loop is due to the possibility of the iterator throwing
// ServiceConfigurationError from either hasNext() or next()
Modified: commons/sandbox/classscan/trunk/api/src/main/java/org/apache/commons/classscan/util/package-info.java
URL: http://svn.apache.org/viewvc/commons/sandbox/classscan/trunk/api/src/main/java/org/apache/commons/classscan/util/package-info.java?rev=1358034&r1=1358033&r2=1358034&view=diff
==============================================================================
--- commons/sandbox/classscan/trunk/api/src/main/java/org/apache/commons/classscan/util/package-info.java (original)
+++ commons/sandbox/classscan/trunk/api/src/main/java/org/apache/commons/classscan/util/package-info.java Fri Jul 6 03:51:39 2012
@@ -12,7 +12,7 @@
* limitations under the License.
*/
/**
- * <p>The util package consists of utility collection implementations to support the {@link org.apache.commons.classscan.bcel} package.</p>
+ * <p>The util package consists of utility collection implementations to support the {@link org.apache.commons.classscan.builtin} package.</p>
* <p><b>These classes are subject to change in any release.</b></p>
*/
package org.apache.commons.classscan.util;
\ No newline at end of file
Modified: commons/sandbox/classscan/trunk/parent/pom.xml
URL: http://svn.apache.org/viewvc/commons/sandbox/classscan/trunk/parent/pom.xml?rev=1358034&r1=1358033&r2=1358034&view=diff
==============================================================================
--- commons/sandbox/classscan/trunk/parent/pom.xml (original)
+++ commons/sandbox/classscan/trunk/parent/pom.xml Fri Jul 6 03:51:39 2012
@@ -38,13 +38,13 @@
<properties>
<maven.compile.source>1.5</maven.compile.source>
<maven.compile.target>1.5</maven.compile.target>
- <commons.subproject.location>sandbox/classscan/trunk</commons.subproject.location>
+ <commons.jira.componentid>12318823</commons.jira.componentid>
</properties>
<scm>
- <connection>scm:svn:http://svn.apache.org/repos/asf/commons/${commons.subproject.location}</connection>
- <developerConnection>scm:svn:https://svn.apache.org/repos/asf/commons/${commons.subproject.location}</developerConnection>
- <url>http://svn.apache.org/viewvc/commons/${commons.subproject.location}</url>
+ <connection>scm:svn:http://svn.apache.org/repos/asf/commons/sandbox/classscan/trunk</connection>
+ <developerConnection>scm:svn:https://svn.apache.org/repos/asf/commons/sandbox/classscan/trunk</developerConnection>
+ <url>http://svn.apache.org/viewvc/commons/sandbox/classscan/trunk</url>
</scm>
<build>
@@ -106,9 +106,9 @@
<distributionManagement>
<site>
- <id>apache.website</id>
+ <id>people.apache.org</id>
<name>Apache Commons Site</name>
- <url>${commons.deployment.protocol}://people.apache.org/www/commons.apache.org/${commons.componentid}</url>
+ <url>scp://people.apache.org/www/commons.apache.org/sandbox/classscan</url>
</site>
</distributionManagement>
Modified: commons/sandbox/classscan/trunk/pom.xml
URL: http://svn.apache.org/viewvc/commons/sandbox/classscan/trunk/pom.xml?rev=1358034&r1=1358033&r2=1358034&view=diff
==============================================================================
--- commons/sandbox/classscan/trunk/pom.xml (original)
+++ commons/sandbox/classscan/trunk/pom.xml Fri Jul 6 03:51:39 2012
@@ -21,24 +21,53 @@
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
-
+
<parent>
<groupId>org.apache.commons.classscan</groupId>
<artifactId>parent</artifactId>
<version>0.2-SNAPSHOT</version>
- <relativePath>parent</relativePath>
+ <relativePath>parent</relativePath>
</parent>
-
+
<groupId>org.apache.commons.classscan</groupId>
<artifactId>classscan</artifactId>
- <name>ClassScan Group</name>
+ <name>ClassScan</name>
<version>0.2-SNAPSHOT</version>
<packaging>pom</packaging>
- <description>A collection of libraries to obtain information about class(es) without loading by the jvm</description>
+ <description>A collection of libraries to obtain information about java classes without jvm loading</description>
<modules>
<module>api</module>
<module>bcel</module>
</modules>
+
+ <reporting>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-surefire-report-plugin</artifactId>
+ <version>2.12</version>
+ <configuration>
+ <aggregate>true</aggregate>
+ </configuration>
+ <reportSets>
+ <reportSet>
+ <reports>
+ <report>report-only</report>
+ </reports>
+ </reportSet>
+ </reportSets>
+ </plugin>
+ </plugins>
+ </reporting>
+ <distributionManagement>
+ <!-- repeat this here to prevent maven from locating at classscan/classscan -->
+ <site>
+ <id>people.apache.org</id>
+ <name>Apache Commons Site</name>
+ <url>scp://people.apache.org/www/commons.apache.org/sandbox/classscan</url>
+ </site>
+ </distributionManagement>
+
</project>
Modified: commons/sandbox/classscan/trunk/src/site/site.xml
URL: http://svn.apache.org/viewvc/commons/sandbox/classscan/trunk/src/site/site.xml?rev=1358034&r1=1358033&r2=1358034&view=diff
==============================================================================
--- commons/sandbox/classscan/trunk/src/site/site.xml (original)
+++ commons/sandbox/classscan/trunk/src/site/site.xml Fri Jul 6 03:51:39 2012
@@ -15,7 +15,7 @@
See the License for the specific language governing permissions and
limitations under the License.
-->
-<project name="Lang">
+<project name="ClassScan">
<bannerRight>
<name>Commons ClassScan</name>
<src>/images/logo.png</src>
@@ -23,9 +23,11 @@
</bannerRight>
<body>
- <menu name="Lang">
+ <menu name="ClassScan">
<item name="Overview" href="/index.html"/>
<item name="Users guide" href="/userguide.html"/>
+ <item name="Api Module" href="api"/>
+ <item name="BCEL Module" href="bcel"/>
</menu>
<menu name="Development">
Modified: commons/sandbox/classscan/trunk/src/site/xdoc/building.xml
URL: http://svn.apache.org/viewvc/commons/sandbox/classscan/trunk/src/site/xdoc/building.xml?rev=1358034&r1=1358033&r2=1358034&view=diff
==============================================================================
--- commons/sandbox/classscan/trunk/src/site/xdoc/building.xml (original)
+++ commons/sandbox/classscan/trunk/src/site/xdoc/building.xml Fri Jul 6 03:51:39 2012
@@ -24,13 +24,13 @@ limitations under the License.
<!-- ================================================== -->
<section name="Overview">
<p>
- Commons Lang uses <a href="http://maven.apache.org">Maven</a> as a build system.
+ Commons ClassScan uses <a href="http://maven.apache.org">Maven</a> as a build system.
</p>
</section>
<!-- ================================================== -->
<section name="Maven Goals">
<p>
- To build a jar file, change into the root directory of ClasspathInfo and run "mvn package".
+ To build a jar file, change into the root directory of ClassScan and run "mvn package".
The result will be in the "target" subdirectory.
</p>
<p>
Modified: commons/sandbox/classscan/trunk/src/site/xdoc/index.xml
URL: http://svn.apache.org/viewvc/commons/sandbox/classscan/trunk/src/site/xdoc/index.xml?rev=1358034&r1=1358033&r2=1358034&view=diff
==============================================================================
--- commons/sandbox/classscan/trunk/src/site/xdoc/index.xml (original)
+++ commons/sandbox/classscan/trunk/src/site/xdoc/index.xml Fri Jul 6 03:51:39 2012
@@ -17,20 +17,20 @@ limitations under the License.
-->
<document>
<properties>
- <title>Commons ClasspathInfo</title>
+ <title>Commons ClassScan</title>
<author email="dev@commons.apache.org">Commons Documentation Team</author>
</properties>
<body>
<!-- ================================================== -->
-<section name="Commons ClasspathInfo">
+<section name="Commons ClassScan">
<p>
The standard Java runtime hides many details about classes, particularly the location of classes which can potentially be loaded, and the details of unloaded classes.
-</p>
-
-<p>
-ClasspathInfo can provide information about all of the classes available to the runtime, whether or not the class has been loaded.
-<ul>An application may want to discover:
+<br/>
+ClassScan can provide information about all of the classes available to the runtime, whether or not the class has been loaded.
+<br/>
+An application may want to discover:
+<ul>
<li>all of the implementers of a particular interface</li>
<li>all of the classes with a specific annotation (or even a particular annotation value)</li>
<li>a particular field or all of the fields of a class</li>
@@ -47,7 +47,17 @@ together with various <a href="project-r
</p>
</section>
<!-- ================================================== -->
+<section name="Modules">
+<p>ClassScan consists of multiple modules. The details of these modules are linked below:
+<ul>
+<li><a href="api">api</a> - The client Application Programming Interface and Service Provider Interface</li>
+<li><a href="bcel">bcel</a> - A backend provider which digests class bytes using BCEL</li>
+</ul>
+</p>
+</section>
+<!-- ================================================== -->
<section name="Release Information">
+Source is available from <a href="source-repository.html">svn repository</a>
</section>
<!-- ================================================== -->
<section name="Support">
@@ -56,12 +66,11 @@ The <a href="mail-lists.html">commons ma
The user list is suitable for most library usage queries.
The dev list is intended for the development discussion.
Please remember that the lists are shared between all commons components,
-so prefix your email by [meiyo].
+so prefix your email by [classscan].
</p>
-<!-- p>
+<p>
Bug reports and enhancements are also welcomed via the <a href="issue-tracking.html">JIRA</a> issue tracker.
-Please read the instructions carefully.
-</p -->
+</p>
</section>
<!-- ================================================== -->
</body>
Added: commons/sandbox/classscan/trunk/src/site/xdoc/issue-tracking.xml
URL: http://svn.apache.org/viewvc/commons/sandbox/classscan/trunk/src/site/xdoc/issue-tracking.xml?rev=1358034&view=auto
==============================================================================
--- commons/sandbox/classscan/trunk/src/site/xdoc/issue-tracking.xml (added)
+++ commons/sandbox/classscan/trunk/src/site/xdoc/issue-tracking.xml Fri Jul 6 03:51:39 2012
@@ -0,0 +1,100 @@
+<?xml version="1.0"?>
+<!--
+Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements. See the NOTICE file distributed with
+this work for additional information regarding copyright ownership.
+The ASF licenses this file to You under the Apache License, Version 2.0
+(the "License"); you may not use this file except in compliance with
+the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+-->
+<!--
+ +======================================================================+
+ |**** ****|
+ |**** THIS FILE IS GENERATED BY THE COMMONS BUILD PLUGIN ****|
+ |**** DO NOT EDIT DIRECTLY ****|
+ |**** ****|
+ +======================================================================+
+ | TEMPLATE FILE: sandbox-issue-tracking-template.xml |
+ | commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates |
+ +======================================================================+
+ | |
+ | 1) Re-generate using: mvn commons:sandbox-jira-page |
+ | |
+ | 2) Set the following properties in the component's pom: |
+ | - commons.jira.componentid (required, numeric) |
+ | |
+ | 3) Example Properties |
+ | |
+ | <properties> |
+ | <commons.jira.componentid>12311182</commons.jira.componentid> |
+ | </properties> |
+ | |
+ +======================================================================+
+-->
+<document>
+ <properties>
+ <title>ClassScan Issue tracking</title>
+ <author email="dev@commons.apache.org">Commons Documentation Team</author>
+ </properties>
+ <body>
+
+ <section name="ClassScan Issue tracking">
+ <p>
+ ClassScan uses <a href="http://issues.apache.org/jira/">ASF JIRA</a> for tracking issues.
+ See the <a href="http://issues.apache.org/jira/browse/SANDBOX">Sandbox JIRA project page</a>.
+ </p>
+
+ <p>
+ To use JIRA you may need to <a href="http://issues.apache.org/jira/secure/Signup!default.jspa">create an account</a>
+ (if you have previously created/updated Commons issues using Bugzilla an account will have been automatically
+ created and you can use the <a href="http://issues.apache.org/jira/secure/ForgotPassword!default.jspa">Forgot Password</a>
+ page to get a new password).
+ </p>
+
+ <p>
+ If you would like to report a bug, or raise an enhancement request with
+ ClassScan please do the following:
+ <ol>
+ <li><a href="http://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&pid=12310491&component=12318823&sorter/field=issuekey&sorter/order=DESC&status=1&status=3&status=4">Search existing open bugs</a>.
+ If you find your issue listed then please add a comment with your details.</li>
+ <li><a href="mail-lists.html">Search the mailing list archive(s)</a>.
+ You may find your issue or idea has already been discussed.</li>
+ <li>Decide if your issue is a bug or an enhancement.</li>
+ <li>Submit either a <a href="http://issues.apache.org/jira/secure/CreateIssueDetails!init.jspa?pid=12310491&components=12318823&issuetype=1&priority=4&assignee=-1">bug report</a>
+ or <a href="http://issues.apache.org/jira/secure/CreateIssueDetails!init.jspa?pid=12310491&components=12318823&issuetype=4&priority=4&assignee=-1">enhancement request</a>.</li>
+ </ol>
+ </p>
+
+ <p>
+ Please also remember these points:
+ <ul>
+ <li>the more information you provide, the better we can help you</li>
+ <li>test cases are vital, particularly for any proposed enhancements</li>
+ <li>the developers of ClassScan are all unpaid volunteers</li>
+ </ul>
+ </p>
+
+ <p>
+ For more information on subversion and creating patches see the
+ <a href="http://www.apache.org/dev/contributors.html">Apache Contributors Guide</a>.
+ </p>
+
+ <p>
+ You may also find these links useful:
+ <ul>
+ <li><a href="http://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&pid=12310491&component=12318823&sorter/field=issuekey&sorter/order=DESC&status=1&status=3&status=4">All Open ClassScan bugs</a></li>
+ <li><a href="http://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&pid=12310491&component=12318823&sorter/field=issuekey&sorter/order=DESC&status=5&status=6">All Resolved ClassScan bugs</a></li>
+ <li><a href="http://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&pid=12310491&component=12318823&sorter/field=issuekey&sorter/order=DESC">All ClassScan bugs</a></li>
+ </ul>
+ </p>
+ </section>
+ </body>
+</document>
Modified: commons/sandbox/classscan/trunk/src/site/xdoc/userguide.xml
URL: http://svn.apache.org/viewvc/commons/sandbox/classscan/trunk/src/site/xdoc/userguide.xml?rev=1358034&r1=1358033&r2=1358034&view=diff
==============================================================================
--- commons/sandbox/classscan/trunk/src/site/xdoc/userguide.xml (original)
+++ commons/sandbox/classscan/trunk/src/site/xdoc/userguide.xml Fri Jul 6 03:51:39 2012
@@ -19,7 +19,7 @@ limitations under the License.
<document>
<properties>
- <title>Commons ClasspathInfo - User guide</title>
+ <title>Commons ClassScan - User guide</title>
<author email="dev@commons.apache.org">Commons Documentation Team</author>
</properties>