CVS: jcontainer/loom/engine/src/java/org/jcontainer/loom/components/extensions/pkgmgr ExtensionManager.java,1.4,1.5 OptionalPackage.java,1.3,1.4 PackageManager.java,1.4,1.5 UnsatisfiedExtensionException.java,1.3,1.4
Peter Donald <pdonald-yCVjj/[email protected]> Sat, 29 Nov 2003 07:44:53 -0600
| Newsgroups | gmane.comp.java.jcontainer.cvs |
|---|---|
| Message-ID | <[email protected]> |
Update of /cvsroot/jcontainer/jcontainer/loom/engine/src/java/org/jcontainer/loom/components/extensions/pkgmgr
In directory hogshead.codehaus.org:/tmp/cvs-serv31016/loom/engine/src/java/org/jcontainer/loom/components/extensions/pkgmgr
Modified Files:
ExtensionManager.java OptionalPackage.java PackageManager.java
UnsatisfiedExtensionException.java
Log Message:
Remove email addie
Index: ExtensionManager.java
===================================================================
RCS file: /cvsroot/jcontainer/jcontainer/loom/engine/src/java/org/jcontainer/loom/components/extensions/pkgmgr/ExtensionManager.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -d -r1.4 -r1.5
--- ExtensionManager.java 2 Sep 2003 04:36:58 -0000 1.4
+++ ExtensionManager.java 29 Nov 2003 13:44:19 -0000 1.5
@@ -89,34 +89,33 @@
import org.realityforge.extension.Extension;
/**
- * <p>Interface used to store a collection of "Optional Packages"
- * (formerly known as "Standard Extensions"). It is assumed that each
- * "Optional Package" is represented by a single file on the file system.</p>
+ * <p>Interface used to store a collection of "Optional Packages" (formerly
+ * known as "Standard Extensions"). It is assumed that each "Optional Package"
+ * is represented by a single file on the file system.</p>
*
* <p>This repository is responsible for storing the local repository of
- * packages. The method used to locate packages on local filesystem
- * and install packages is not specified.</p>
+ * packages. The method used to locate packages on local filesystem and install
+ * packages is not specified.</p>
*
* <p>For more information about optional packages, see the document
* <em>Optional Package Versioning</em> in the documentation bundle for your
- * Java2 Standard Edition package, in file
- * <code>guide/extensions/versioning.html</code></p>.
+ * Java2 Standard Edition package, in file <code>guide/extensions/versioning.html</code></p>.
*
- * @author <a href="mailto:peter at realityforge.org">Peter Donald</a>
+ * @author Peter Donald
* @version $Revision$ $Date$
*/
public interface ExtensionManager
{
/**
- * Return all the {@link OptionalPackage}s that satisfy specified
- * {@link Extension}. The array must be sorted with the packages that
- * "best" satisfy the Extension earlier in the array. Note that the
- * definition of "best" is implementation dependent.
+ * Return all the {@link OptionalPackage}s that satisfy specified {@link
+ * Extension}. The array must be sorted with the packages that "best"
+ * satisfy the Extension earlier in the array. Note that the definition of
+ * "best" is implementation dependent.
*
- * @param extension Description of the extension that needs to be provided by
- * optional packages
- * @return an array of optional packages that satisfy extension and
- * the extensions dependencies
+ * @param extension Description of the extension that needs to be provided
+ * by optional packages
+ * @return an array of optional packages that satisfy extension and the
+ * extensions dependencies
* @see OptionalPackage
* @see Extension
*/
Index: OptionalPackage.java
===================================================================
RCS file: /cvsroot/jcontainer/jcontainer/loom/engine/src/java/org/jcontainer/loom/components/extensions/pkgmgr/OptionalPackage.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -d -r1.3 -r1.4
--- OptionalPackage.java 17 Aug 2003 18:27:32 -0000 1.3
+++ OptionalPackage.java 29 Nov 2003 13:44:19 -0000 1.4
@@ -90,11 +90,10 @@
import org.realityforge.extension.Extension;
/**
- * This contains the required meta-data for an "Optional Package"
- * (formerly known as "Standard Extension") as described in the manifest
- * of a JAR file.
+ * This contains the required meta-data for an "Optional Package" (formerly
+ * known as "Standard Extension") as described in the manifest of a JAR file.
*
- * @author <a href="mailto:peter at realityforge.org">Peter Donald</a>
+ * @author Peter Donald
*/
public final class OptionalPackage
{
@@ -121,8 +120,7 @@
}
/**
- * Constructor for OptionalPackage.
- * No parameter is allowed to be null.
+ * Constructor for OptionalPackage. No parameter is allowed to be null.
*
* @param file absolute location of file
* @param available the list of Extensions Optional Package provides
@@ -153,8 +151,7 @@
}
/**
- * Return <code>File</code> object in which OptionalPackage
- * is contained.
+ * Return <code>File</code> object in which OptionalPackage is contained.
*
* @return the file object for OptionalPackage
*/
@@ -164,8 +161,8 @@
}
/**
- * Return <code>Extension</code>s which OptionalPackage
- * requires to operate.
+ * Return <code>Extension</code>s which OptionalPackage requires to
+ * operate.
*
* @return the extensions required by OptionalPackage
*/
@@ -175,8 +172,7 @@
}
/**
- * Return <code>Extension</code>s which OptionalPackage
- * makes available.
+ * Return <code>Extension</code>s which OptionalPackage makes available.
*
* @return the extensions made available by OptionalPackage
*/
@@ -187,7 +183,8 @@
/**
* Return <code>true</code> if any of the available <code>Extension</code>s
- * are compatible with specified extension. Otherwise return <code>false</code>.
+ * are compatible with specified extension. Otherwise return
+ * <code>false</code>.
*
* @param extension the extension
* @return true if compatible, false otherwise
Index: PackageManager.java
===================================================================
RCS file: /cvsroot/jcontainer/jcontainer/loom/engine/src/java/org/jcontainer/loom/components/extensions/pkgmgr/PackageManager.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -d -r1.4 -r1.5
--- PackageManager.java 11 Nov 2003 11:29:51 -0000 1.4
+++ PackageManager.java 29 Nov 2003 13:44:19 -0000 1.5
@@ -92,18 +92,16 @@
import org.realityforge.extension.Extension;
/**
- * Basic Implementation Of PackageManager Interface used to manage
- * "Optional Packages" (formerly known as "Standard Extensions").
- * The "Optional Packages" are stored on file system in a number of
- * directories.
+ * Basic Implementation Of PackageManager Interface used to manage "Optional
+ * Packages" (formerly known as "Standard Extensions"). The "Optional Packages"
+ * are stored on file system in a number of directories.
*
- * @author <a href="mailto:peter at realityforge.org">Peter Donald</a>
+ * @author Peter Donald
* @version $Revision$ $Date$
+ * @todo Determine an appropriate interface to this service and an appropriate
+ * mechanism via which to do searching and expansion of a package set. At that
+ * point separate out implementation and interface for mechanism.
* @see ExtensionManager
- * @todo Determine an appropriate interface to this service and
- * an appropriate mechanism via which to do searching and
- * expansion of a package set. At that point separate out
- * implementation and interface for mechanism.
*/
public class PackageManager
{
@@ -126,26 +124,26 @@
}
/**
- * Return the {@link OptionalPackage} that provides specified
- * {@link Extension}. If the specified {@link Extension}
- * can not be found then <code>null</code> is returned. If there is
- * multiple implementations that satisfy {@link Extension},
- * then an {@link OptionalPackage} returned is based on the
- * following heristic;
+ * Return the {@link OptionalPackage} that provides specified {@link
+ * Extension}. If the specified {@link Extension} can not be found then
+ * <code>null</code> is returned. If there is multiple implementations that
+ * satisfy {@link Extension}, then an {@link OptionalPackage} returned is
+ * based on the following heristic;
*
- * <p>Return the first Optional Package. (This heuristic will
- * be replaced in time).</p>
+ * <p>Return the first Optional Package. (This heuristic will be replaced in
+ * time).</p>
*
- * @param extension Description of the extension that needs to be provided by
- * optional package
- * @return an array of optional packages that satisfy extension and
- * the extensions dependencies
+ * @param extension Description of the extension that needs to be provided
+ * by optional package
+ * @return an array of optional packages that satisfy extension and the
+ * extensions dependencies
* @see OptionalPackage
* @see Extension
*/
public OptionalPackage getOptionalPackage( final Extension extension )
{
- final OptionalPackage[] packages = m_repository.getOptionalPackages( extension );
+ final OptionalPackage[] packages = m_repository.getOptionalPackages(
+ extension );
if( null == packages || 0 == packages.length )
{
return null;
@@ -157,20 +155,21 @@
}
/**
- * Build a list of dependencies based on specified {@link Extension}s.
- * Each specified {@link Extension} is expected to be a required extension
- * of another "Optional Package".
+ * Build a list of dependencies based on specified {@link Extension}s. Each
+ * specified {@link Extension} is expected to be a required extension of
+ * another "Optional Package".
*
- * <p>If the required {@link Extension} can not be found locally then
- * an UnsatisfiedPackageException is thrown. if an {@link OptionalPackage}
- * is found locally that satisfies specified required {@link Extension}
- * then it is returned in the array of OptionalPackages. scanDependencies() is then recursively
- * called on all of the candidates required extensions.</p>
+ * <p>If the required {@link Extension} can not be found locally then an
+ * UnsatisfiedPackageException is thrown. if an {@link OptionalPackage} is
+ * found locally that satisfies specified required {@link Extension} then it
+ * is returned in the array of OptionalPackages. scanDependencies() is then
+ * recursively called on all of the candidates required extensions.</p>
*
* @param required the array of required Extensions.
* @param available the array of Extensions already available to caller.
* @return the list of OptionalPackages that satisfy required Extensions
- * @throws UnsatisfiedExtensionException if extensions could not be satisified
+ * @throws UnsatisfiedExtensionException if extensions could not be
+ * satisified
* @see #scanDependencies
*/
public OptionalPackage[] scanDependencies( final Extension required,
@@ -181,20 +180,21 @@
}
/**
- * Build a list of dependencies based on specified {@link Extension}.
- * The specified {@link Extension} is expected to be a required extension
- * of another "Optional Package".
+ * Build a list of dependencies based on specified {@link Extension}. The
+ * specified {@link Extension} is expected to be a required extension of
+ * another "Optional Package".
*
- * <p>If the required {@link Extension} can not be found locally then
- * an UnsatisfiedPackageException is thrown. if an {@link OptionalPackage}
- * is found locally that satisfies specified required {@link Extension}
- * then it is returned in the array of OptionalPackages. scanDependencies() is then recursively
- * called on all of the candidates required extensions.</p>
+ * <p>If the required {@link Extension} can not be found locally then an
+ * UnsatisfiedPackageException is thrown. if an {@link OptionalPackage} is
+ * found locally that satisfies specified required {@link Extension} then it
+ * is returned in the array of OptionalPackages. scanDependencies() is then
+ * recursively called on all of the candidates required extensions.</p>
*
* @param required the array of required Extensions.
* @param available the array of Extensions already available to caller.
* @return the list of OptionalPackages that satisfy required Extensions
- * @throws UnsatisfiedExtensionException if extensions could not be satisified
+ * @throws UnsatisfiedExtensionException if extensions could not be
+ * satisified
* @see #scanDependencies
*/
public OptionalPackage[] scanDependencies( final Extension[] required,
@@ -213,19 +213,21 @@
throw new UnsatisfiedExtensionException( extension );
}
- return (OptionalPackage[])dependencies.toArray( new OptionalPackage[ 0 ] );
+ return (OptionalPackage[])dependencies.toArray(
+ new OptionalPackage[ 0 ] );
}
/**
- * Build a list of dependencies based on specified {@link Extension}s.
- * Each specified {@link Extension} is expected to be a required extension
- * of another "Optional Package".
+ * Build a list of dependencies based on specified {@link Extension}s. Each
+ * specified {@link Extension} is expected to be a required extension of
+ * another "Optional Package".
*
- * <p>If the required {@link Extension} can not be found locally then
- * it is placed in list of unsatisfied Extensions. If a candidate {@link Extension}
- * is found locally that satisfies specified required {@link Extension}
- * then it is added to list of dependencies. scanDependencies() is then recursively
- * called on all of the candidates required extensions.</p>
+ * <p>If the required {@link Extension} can not be found locally then it is
+ * placed in list of unsatisfied Extensions. If a candidate {@link
+ * Extension} is found locally that satisfies specified required {@link
+ * Extension} then it is added to list of dependencies. scanDependencies()
+ * is then recursively called on all of the candidates required
+ * extensions.</p>
*
* @param required the array of required Extensions.
* @param available the array of Extensions already available to caller.
@@ -240,24 +242,29 @@
{
for( int i = 0; i < required.length; i++ )
{
- scanDependencies( required[ i ], available, dependencies, unsatisfied );
+ scanDependencies( required[ i ],
+ available,
+ dependencies,
+ unsatisfied );
}
}
/**
- * Build a list of dependencies based on specified {@link Extension}.
- * The specified {@link Extension} is expected to be a required extension
- * of another "Optional Package".
+ * Build a list of dependencies based on specified {@link Extension}. The
+ * specified {@link Extension} is expected to be a required extension of
+ * another "Optional Package".
*
- * <p>If the required {@link Extension} can not be found locally then
- * it is placed in list of unsatisfied Extensions. If a candidate {@link OptionalPackage}
- * is found locally that satisfies specified required {@link Extension}
- * then it is added to list of dependencies. scanDependencies() is then recursively
- * called on all of the candidates required extensions.</p>
+ * <p>If the required {@link Extension} can not be found locally then it is
+ * placed in list of unsatisfied Extensions. If a candidate {@link
+ * OptionalPackage} is found locally that satisfies specified required
+ * {@link Extension} then it is added to list of dependencies.
+ * scanDependencies() is then recursively called on all of the candidates
+ * required extensions.</p>
*
* @param required the required Extension.
* @param available the array of Extensions already available to caller.
- * @param dependencies the list of OptionalPackages required to satisfy extension.
+ * @param dependencies the list of OptionalPackages required to satisfy
+ * extension.
* @param unsatisfied the list of unsatisfied (ie non-local) dependencies.
* @see #scanDependencies
*/
Index: UnsatisfiedExtensionException.java
===================================================================
RCS file: /cvsroot/jcontainer/jcontainer/loom/engine/src/java/org/jcontainer/loom/components/extensions/pkgmgr/UnsatisfiedExtensionException.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -d -r1.3 -r1.4
--- UnsatisfiedExtensionException.java 17 Aug 2003 18:27:32 -0000 1.3
+++ UnsatisfiedExtensionException.java 29 Nov 2003 13:44:19 -0000 1.4
@@ -91,21 +91,19 @@
/**
* Exception indicating an extension was not found in Package Repository.
*
- * @author <a href="mailto:peter at realityforge.org">Peter Donald</a>
+ * @author Peter Donald
* @version $Revision$ $Date$
* @see Extension
*/
public class UnsatisfiedExtensionException
extends Exception
{
- /**
- * The unsatisfied Extension.
- */
+ /** The unsatisfied Extension. */
private final Extension m_extension;
/**
- * Construct the <code>UnsatisfiedPackageException</code>
- * for specified {@link Extension}.
+ * Construct the <code>UnsatisfiedPackageException</code> for specified
+ * {@link Extension}.
*
* @param extension the extension that caused exception
*/
@@ -120,8 +118,8 @@
}
/**
- * Return the unsatisfied {@link Extension} that
- * caused this exception tho be thrown.
+ * Return the unsatisfied {@link Extension} that caused this exception tho
+ * be thrown.
*
* @return the unsatisfied Extension
*/