[jboss-svn-commits] JBoss Common SVN: r4463 - in shrinkwrap/trunk/api/src/main/java/org/jboss/shrinkwrap/api: exporter and 2 other directories.
jboss-svn-commits at lists.jboss.org
jboss-svn-commits at lists.jboss.org
Sun May 30 11:32:55 EDT 2010
Author: ALRubinger
Date: 2010-05-30 11:32:54 -0400 (Sun, 30 May 2010)
New Revision: 4463
Removed:
shrinkwrap/trunk/api/src/main/java/org/jboss/shrinkwrap/api/container/DirectoryContainer.java
Modified:
shrinkwrap/trunk/api/src/main/java/org/jboss/shrinkwrap/api/container/ClassContainer.java
shrinkwrap/trunk/api/src/main/java/org/jboss/shrinkwrap/api/container/EnterpriseContainer.java
shrinkwrap/trunk/api/src/main/java/org/jboss/shrinkwrap/api/container/LibraryContainer.java
shrinkwrap/trunk/api/src/main/java/org/jboss/shrinkwrap/api/container/ManifestContainer.java
shrinkwrap/trunk/api/src/main/java/org/jboss/shrinkwrap/api/container/ResourceAdapterContainer.java
shrinkwrap/trunk/api/src/main/java/org/jboss/shrinkwrap/api/container/ResourceContainer.java
shrinkwrap/trunk/api/src/main/java/org/jboss/shrinkwrap/api/container/WebContainer.java
shrinkwrap/trunk/api/src/main/java/org/jboss/shrinkwrap/api/exporter/ArchiveExportException.java
shrinkwrap/trunk/api/src/main/java/org/jboss/shrinkwrap/api/exporter/ExplodedExporter.java
shrinkwrap/trunk/api/src/main/java/org/jboss/shrinkwrap/api/importer/ExplodedImporter.java
shrinkwrap/trunk/api/src/main/java/org/jboss/shrinkwrap/api/spec/EnterpriseArchive.java
shrinkwrap/trunk/api/src/main/java/org/jboss/shrinkwrap/api/spec/JavaArchive.java
shrinkwrap/trunk/api/src/main/java/org/jboss/shrinkwrap/api/spec/ResourceAdapterArchive.java
shrinkwrap/trunk/api/src/main/java/org/jboss/shrinkwrap/api/spec/WebArchive.java
Log:
[SHRINKWRAP-172] JavaDocs cleanup of API
Modified: shrinkwrap/trunk/api/src/main/java/org/jboss/shrinkwrap/api/container/ClassContainer.java
===================================================================
--- shrinkwrap/trunk/api/src/main/java/org/jboss/shrinkwrap/api/container/ClassContainer.java 2010-05-30 15:18:35 UTC (rev 4462)
+++ shrinkwrap/trunk/api/src/main/java/org/jboss/shrinkwrap/api/container/ClassContainer.java 2010-05-30 15:32:54 UTC (rev 4463)
@@ -21,8 +21,6 @@
import org.jboss.shrinkwrap.api.Filter;
/**
- * ClassContainer
- *
* Defines the contract for a component capable of storing
* Java Classes.
* <br/><br/>
Deleted: shrinkwrap/trunk/api/src/main/java/org/jboss/shrinkwrap/api/container/DirectoryContainer.java
===================================================================
Modified: shrinkwrap/trunk/api/src/main/java/org/jboss/shrinkwrap/api/container/EnterpriseContainer.java
===================================================================
--- shrinkwrap/trunk/api/src/main/java/org/jboss/shrinkwrap/api/container/EnterpriseContainer.java 2010-05-30 15:18:35 UTC (rev 4462)
+++ shrinkwrap/trunk/api/src/main/java/org/jboss/shrinkwrap/api/container/EnterpriseContainer.java 2010-05-30 15:32:54 UTC (rev 4463)
@@ -24,8 +24,6 @@
import org.jboss.shrinkwrap.api.asset.Asset;
/**
- * EnterpriseContainer
- *
* Defines the contract for a component capable of storing
* Enterprise related resources.
* <br/><br/>
Modified: shrinkwrap/trunk/api/src/main/java/org/jboss/shrinkwrap/api/container/LibraryContainer.java
===================================================================
--- shrinkwrap/trunk/api/src/main/java/org/jboss/shrinkwrap/api/container/LibraryContainer.java 2010-05-30 15:18:35 UTC (rev 4462)
+++ shrinkwrap/trunk/api/src/main/java/org/jboss/shrinkwrap/api/container/LibraryContainer.java 2010-05-30 15:32:54 UTC (rev 4463)
@@ -24,8 +24,6 @@
import org.jboss.shrinkwrap.api.asset.Asset;
/**
- * LibraryContainer
- *
* Defines the contract for a component capable of storing
* Libraries.
* <br/><br/>
@@ -55,7 +53,7 @@
* @see #addLibrary(Asset, ArchivePath)
*/
T addLibrary(String resourceName) throws IllegalArgumentException;
-
+
/**
* Adds the {@link File} as a library to the container, returning the container itself.
* <br/>
@@ -81,7 +79,7 @@
* @see #addLibrary(Asset, ArchivePath)
*/
T addLibrary(String resourceName, String target) throws IllegalArgumentException;
-
+
/**
* Adds the {@link File} as a library to the container, returning the container itself.
*
@@ -93,7 +91,7 @@
* @see #addLibrary(Asset, ArchivePath)
*/
T addLibrary(File resource, String target) throws IllegalArgumentException;
-
+
/**
* Adds the {@link URL} as a library to the container, returning the container itself.
*
@@ -105,7 +103,7 @@
* @see #addLibrary(Asset, ArchivePath)
*/
T addLibrary(URL resource, String target) throws IllegalArgumentException;
-
+
/**
* Adds the {@link Asset} as a library to the container, returning the container itself.
*
@@ -132,7 +130,7 @@
* @see #addLibrary(Asset, ArchivePath)
*/
T addLibrary(String resourceName, ArchivePath target) throws IllegalArgumentException;
-
+
/**
* Adds the {@link File} as a library to the container, returning the container itself.
*
@@ -179,7 +177,7 @@
* @see #addLibrary(Asset, ArchivePath)
*/
T addLibrary(Archive<?> archive) throws IllegalArgumentException;
-
+
/**
* Add multiple resources to this {@link Archive} as libraries to the container, returning the container itself.
* <br/>
@@ -194,7 +192,7 @@
* @see #addLibrary(String)
*/
T addLibraries(String... resourceNames) throws IllegalArgumentException;
-
+
/**
* Add multiple {@link File} to this {@link Archive} as libraries to the container, returning the container itself.
* <br/>
Modified: shrinkwrap/trunk/api/src/main/java/org/jboss/shrinkwrap/api/container/ManifestContainer.java
===================================================================
--- shrinkwrap/trunk/api/src/main/java/org/jboss/shrinkwrap/api/container/ManifestContainer.java 2010-05-30 15:18:35 UTC (rev 4462)
+++ shrinkwrap/trunk/api/src/main/java/org/jboss/shrinkwrap/api/container/ManifestContainer.java 2010-05-30 15:32:54 UTC (rev 4463)
@@ -24,8 +24,6 @@
import org.jboss.shrinkwrap.api.asset.Asset;
/**
- * ManifestContainer
- *
* Defines the contract for a component capable of storing
* Manifest related resources.
* <br/><br/>
@@ -53,7 +51,7 @@
* @see #setManifest(Asset)
*/
T setManifest(String resourceName) throws IllegalArgumentException;
-
+
/**
* Adds the {@link File} as MANIFEST.FM to the container, returning the container itself.
*
@@ -73,7 +71,7 @@
* @see #setManifest(Asset)
*/
T setManifest(URL resource) throws IllegalArgumentException;
-
+
/**
* Adds the {@link Asset} as MANIFEST.FM to the container, returning the container itself.
*
@@ -83,7 +81,7 @@
* @see #addManifestResource(Asset, ArchivePath)
*/
T setManifest(Asset resource) throws IllegalArgumentException;
-
+
/**
* Adds the resource as a Manifest resource to the container, returning the container itself.
* <br/>
@@ -99,7 +97,7 @@
* @see #addManifestResource(Asset, ArchivePath)
*/
T addManifestResource(String resourceName) throws IllegalArgumentException;
-
+
/**
* Adds the {@link File} as a Manifest resource to the container, returning the container itself.
* <br/>
@@ -188,7 +186,7 @@
* @see #addManifestResource(Asset, ArchivePath)
*/
T addManifestResource(File resource, ArchivePath target) throws IllegalArgumentException;
-
+
/**
* Adds the {@link URL} as a Manifest resource to the container, returning the container itself.
*
@@ -224,7 +222,7 @@
* @throws IllegalArgumentException if no resourceNames are specified or containing null
*/
T addManifestResources(Package resourcePackage, String... resourceNames) throws IllegalArgumentException;
-
+
/**
* Adds the resource as a resource to the container, returning the container itself.
* <br/><br/>
@@ -237,7 +235,7 @@
* @throws IllegalArgumentException if resourceName is null
*/
T addManifestResource(Package resourcePackage, String resourceName) throws IllegalArgumentException;
-
+
/**
* Adds the resource as a resource to a specific path inside the container, returning the container itself.
* <br/><br/>
@@ -266,7 +264,8 @@
* @throws IllegalArgumentException if resourceName is null
* @throws IllegalArgumentException if target is null
*/
- T addManifestResource(Package resourcePackage, String resourceName, ArchivePath target) throws IllegalArgumentException;
+ T addManifestResource(Package resourcePackage, String resourceName, ArchivePath target)
+ throws IllegalArgumentException;
/**
* Adds a META-INF/services/ServiceInterfaceName {@link Asset} representing this service.
Modified: shrinkwrap/trunk/api/src/main/java/org/jboss/shrinkwrap/api/container/ResourceAdapterContainer.java
===================================================================
--- shrinkwrap/trunk/api/src/main/java/org/jboss/shrinkwrap/api/container/ResourceAdapterContainer.java 2010-05-30 15:18:35 UTC (rev 4462)
+++ shrinkwrap/trunk/api/src/main/java/org/jboss/shrinkwrap/api/container/ResourceAdapterContainer.java 2010-05-30 15:32:54 UTC (rev 4463)
@@ -23,8 +23,6 @@
import org.jboss.shrinkwrap.api.asset.Asset;
/**
- * ResourceAdapterContainer
- *
* Defines the contract for a component capable of storing Resource adapter
* resources. <br/>
* <br/>
@@ -47,7 +45,7 @@
* @see #setResourceAdapterXML(Asset)
*/
T setResourceAdapterXML(String resourceName) throws IllegalArgumentException;
-
+
/**
* Adds the {@link File} as ra.xml to the container, returning the container itself.
*
@@ -57,7 +55,7 @@
* @see #setResourceAdapterXML(Asset)
*/
T setResourceAdapterXML(File resource) throws IllegalArgumentException;
-
+
/**
* Adds the {@link URL} as ra.xml to the container, returning the container itself.
*
@@ -67,7 +65,7 @@
* @see #setResourceAdapterXML(Asset)
*/
T setResourceAdapterXML(URL resource) throws IllegalArgumentException;
-
+
/**
* Adds the {@link Asset} as ra.xml to the container, returning the container itself.
*
Modified: shrinkwrap/trunk/api/src/main/java/org/jboss/shrinkwrap/api/container/ResourceContainer.java
===================================================================
--- shrinkwrap/trunk/api/src/main/java/org/jboss/shrinkwrap/api/container/ResourceContainer.java 2010-05-30 15:18:35 UTC (rev 4462)
+++ shrinkwrap/trunk/api/src/main/java/org/jboss/shrinkwrap/api/container/ResourceContainer.java 2010-05-30 15:32:54 UTC (rev 4463)
@@ -24,10 +24,9 @@
import org.jboss.shrinkwrap.api.asset.Asset;
/**
- * ResourceContainer
- *
* Defines the contract for a component capable of storing
- * a series of {@link ClassLoader} resources
+ * a series of {@link ClassLoader}, {@link File}, and {@link URL}-based
+ * Assets as resources within an archive.
* <br/><br/>
* The actual path to the Resources within the {@link Archive}
* is up to the implementations/specifications.
@@ -56,7 +55,7 @@
* @see #addResource(Asset, ArchivePath)
*/
T addResource(String resourceName) throws IllegalArgumentException;
-
+
/**
* Adds the {@link File} as a resource to the container, returning the container itself.
* <br/>
@@ -82,7 +81,7 @@
* @see #addResource(Asset, ArchivePath)
*/
T addResource(String resourceName, String target) throws IllegalArgumentException;
-
+
/**
* Adds the {@link File} as a resource to the container, returning the container itself.
*
@@ -94,7 +93,7 @@
* @see #addResource(Asset, ArchivePath)
*/
T addResource(File resource, String target) throws IllegalArgumentException;
-
+
/**
* Adds the {@link URL} as a resource to the container, returning the container itself.
*
@@ -131,7 +130,7 @@
* @throws IllegalArgumentException If the resourceName is null
*/
T addResource(String resourceName, ArchivePath target) throws IllegalArgumentException;
-
+
/**
* Adds the resource as a resource to the container, returning the container itself.
* <br/><br/>
@@ -193,7 +192,7 @@
* @throws IllegalArgumentException if no resourceNames are specified or containing null
*/
T addResources(Package resourcePackage, String... resourceNames) throws IllegalArgumentException;
-
+
/**
* Adds the resource as a resource to the container, returning the container itself.
* <br/><br/>
@@ -206,7 +205,7 @@
* @throws IllegalArgumentException if resourceName is null
*/
T addResource(Package resourcePackage, String resourceName) throws IllegalArgumentException;
-
+
/**
* Adds the resource as a resource to a specific path inside the container, returning the container itself.
* <br/><br/>
Modified: shrinkwrap/trunk/api/src/main/java/org/jboss/shrinkwrap/api/container/WebContainer.java
===================================================================
--- shrinkwrap/trunk/api/src/main/java/org/jboss/shrinkwrap/api/container/WebContainer.java 2010-05-30 15:18:35 UTC (rev 4462)
+++ shrinkwrap/trunk/api/src/main/java/org/jboss/shrinkwrap/api/container/WebContainer.java 2010-05-30 15:32:54 UTC (rev 4463)
@@ -24,10 +24,8 @@
import org.jboss.shrinkwrap.api.asset.Asset;
/**
- * WebContainer
- *
* Defines the contract for a component capable of storing
- * Web related resources.
+ * web-related resources.
* <br/><br/>
* The actual path to the Web resources within the Archive
* is up to the implementations/specifications.
Modified: shrinkwrap/trunk/api/src/main/java/org/jboss/shrinkwrap/api/exporter/ArchiveExportException.java
===================================================================
--- shrinkwrap/trunk/api/src/main/java/org/jboss/shrinkwrap/api/exporter/ArchiveExportException.java 2010-05-30 15:18:35 UTC (rev 4462)
+++ shrinkwrap/trunk/api/src/main/java/org/jboss/shrinkwrap/api/exporter/ArchiveExportException.java 2010-05-30 15:32:54 UTC (rev 4463)
@@ -17,8 +17,6 @@
package org.jboss.shrinkwrap.api.exporter;
/**
- * ArchiveExportException
- *
* Exception thrown when an error occurs exporting an Archive.
*
* @author <a href="mailto:baileyje at gmail.com">John Bailey</a>
Modified: shrinkwrap/trunk/api/src/main/java/org/jboss/shrinkwrap/api/exporter/ExplodedExporter.java
===================================================================
--- shrinkwrap/trunk/api/src/main/java/org/jboss/shrinkwrap/api/exporter/ExplodedExporter.java 2010-05-30 15:18:35 UTC (rev 4462)
+++ shrinkwrap/trunk/api/src/main/java/org/jboss/shrinkwrap/api/exporter/ExplodedExporter.java 2010-05-30 15:32:54 UTC (rev 4463)
@@ -21,8 +21,6 @@
import org.jboss.shrinkwrap.api.Assignable;
/**
- * ExplodedExporter
- *
* Exporter used to export an Archive as an exploded directory structure.
*
* @author <a href="mailto:baileyje at gmail.com">John Bailey</a>
Modified: shrinkwrap/trunk/api/src/main/java/org/jboss/shrinkwrap/api/importer/ExplodedImporter.java
===================================================================
--- shrinkwrap/trunk/api/src/main/java/org/jboss/shrinkwrap/api/importer/ExplodedImporter.java 2010-05-30 15:18:35 UTC (rev 4462)
+++ shrinkwrap/trunk/api/src/main/java/org/jboss/shrinkwrap/api/importer/ExplodedImporter.java 2010-05-30 15:32:54 UTC (rev 4463)
@@ -22,8 +22,6 @@
import org.jboss.shrinkwrap.api.Assignable;
/**
- * ExplodedImporter
- *
* Importer used to import Exploded directory structures into a {@link Archive}
*
* @author <a href="mailto:aslak at conduct.no">Aslak Knutsen</a>
Modified: shrinkwrap/trunk/api/src/main/java/org/jboss/shrinkwrap/api/spec/EnterpriseArchive.java
===================================================================
--- shrinkwrap/trunk/api/src/main/java/org/jboss/shrinkwrap/api/spec/EnterpriseArchive.java 2010-05-30 15:18:35 UTC (rev 4462)
+++ shrinkwrap/trunk/api/src/main/java/org/jboss/shrinkwrap/api/spec/EnterpriseArchive.java 2010-05-30 15:32:54 UTC (rev 4463)
@@ -23,12 +23,10 @@
import org.jboss.shrinkwrap.api.container.ResourceContainer;
/**
- * EnterpriseArchive
- *
* Traditional EAR (Java Enterprise Archive) structure. Used in
* construction of enterprise applications.
*
- * @see TODO: find ear spec doc url
+ * @see http://java.sun.com/javaee/5/docs/tutorial/doc/bnaby.html#indexterm-47
* @author <a href="mailto:aslak at conduct.no">Aslak Knutsen</a>
* @version $Revision: $
*/
Modified: shrinkwrap/trunk/api/src/main/java/org/jboss/shrinkwrap/api/spec/JavaArchive.java
===================================================================
--- shrinkwrap/trunk/api/src/main/java/org/jboss/shrinkwrap/api/spec/JavaArchive.java 2010-05-30 15:18:35 UTC (rev 4462)
+++ shrinkwrap/trunk/api/src/main/java/org/jboss/shrinkwrap/api/spec/JavaArchive.java 2010-05-30 15:32:54 UTC (rev 4463)
@@ -21,8 +21,6 @@
import org.jboss.shrinkwrap.api.container.ManifestContainer;
/**
- * JavaArchive
- *
* Traditional JAR (Java Archive) structure. Used in
* construction of libraries and applications.
*
Modified: shrinkwrap/trunk/api/src/main/java/org/jboss/shrinkwrap/api/spec/ResourceAdapterArchive.java
===================================================================
--- shrinkwrap/trunk/api/src/main/java/org/jboss/shrinkwrap/api/spec/ResourceAdapterArchive.java 2010-05-30 15:18:35 UTC (rev 4462)
+++ shrinkwrap/trunk/api/src/main/java/org/jboss/shrinkwrap/api/spec/ResourceAdapterArchive.java 2010-05-30 15:32:54 UTC (rev 4463)
@@ -23,8 +23,6 @@
import org.jboss.shrinkwrap.api.container.ResourceContainer;
/**
- * ResourceAdapterArchive
- *
* Traditional RAR (Resource Adapter Archive) structure. Used in
* construction of resource adapters.
*
Modified: shrinkwrap/trunk/api/src/main/java/org/jboss/shrinkwrap/api/spec/WebArchive.java
===================================================================
--- shrinkwrap/trunk/api/src/main/java/org/jboss/shrinkwrap/api/spec/WebArchive.java 2010-05-30 15:18:35 UTC (rev 4462)
+++ shrinkwrap/trunk/api/src/main/java/org/jboss/shrinkwrap/api/spec/WebArchive.java 2010-05-30 15:32:54 UTC (rev 4463)
@@ -23,12 +23,9 @@
import org.jboss.shrinkwrap.api.container.WebContainer;
/**
- * WebArchive
- *
* Traditional WAR (Java Web Archive) structure. Used in
* construction of web applications.
*
- * @see TODO: find war spec doc url
* @author <a href="mailto:aslak at conduct.no">Aslak Knutsen</a>
* @version $Revision: $
*/
More information about the jboss-svn-commits
mailing list