CVS: jcontainer/loom/engine/src/java/org/jcontainer/loom/components/extensions/pkgmgr/impl DefaultExtensionManager.java,1.4,1.5 DelegatingExtensionManager.java,1.4,1.5 NoopExtensionManager.java,1.4,1.5 OptionalPackageComparator.java,1.4,1.5
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/impl
In directory hogshead.codehaus.org:/tmp/cvs-serv31016/loom/engine/src/java/org/jcontainer/loom/components/extensions/pkgmgr/impl
Modified Files:
DefaultExtensionManager.java DelegatingExtensionManager.java
NoopExtensionManager.java OptionalPackageComparator.java
Log Message:
Remove email addie
Index: DefaultExtensionManager.java
===================================================================
RCS file: /cvsroot/jcontainer/jcontainer/loom/engine/src/java/org/jcontainer/loom/components/extensions/pkgmgr/impl/DefaultExtensionManager.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -d -r1.4 -r1.5
--- DefaultExtensionManager.java 16 Oct 2003 14:45:45 -0000 1.4
+++ DefaultExtensionManager.java 29 Nov 2003 13:44:19 -0000 1.5
@@ -101,12 +101,12 @@
import org.realityforge.extension.Extension;
/**
- * <p>Interface used to contain "Optional Packages" (formerly known as
- * "Standard Extensions"). It is assumed that each "Optional Package" is
- * represented by a single file on the file system. This Repository searches
- * a path to find the Optional Packages.</p>
+ * <p>Interface used to contain "Optional Packages" (formerly known as "Standard
+ * Extensions"). It is assumed that each "Optional Package" is represented by a
+ * single file on the file system. This Repository searches a path to find the
+ * Optional Packages.</p>
*
- * @author <a href="mailto:peter at realityforge.org">Peter Donald</a>
+ * @author Peter Donald
* @version $Revision$ $Date$
* @see OptionalPackage
* @see ExtensionManager
@@ -116,24 +116,18 @@
{
private static final boolean DEBUG = false;
- /**
- * separator used to separate path elements in a string.
- */
+ /** separator used to separate path elements in a string. */
private static final String SEPARATOR = "|";
- /**
- * Map between files and {@link OptionalPackage} objects.
- */
+ /** Map between files and {@link OptionalPackage} objects. */
private final Map m_packages = new HashMap();
- /**
- * The set of directories in which to look for Optional Packages
- */
+ /** The set of directories in which to look for Optional Packages */
private File[] m_path;
/**
- * Flag set when it is necessary to scan paths to
- * build "Optional Package" list
+ * Flag set when it is necessary to scan paths to build "Optional Package"
+ * list
*/
private boolean m_needToScan;
@@ -148,7 +142,8 @@
/**
* Construct a package repository with path.
*
- * @param path The set of directories in which to look for Optional Packages
+ * @param path The set of directories in which to look for Optional
+ * Packages
*/
public DefaultExtensionManager( final File[] path )
{
@@ -156,10 +151,8 @@
}
/**
- * Return an array of path elements where each
- * element in array represents a directory
- * in which the ExtensionManager will look
- * for Extensions.
+ * Return an array of path elements where each element in array represents a
+ * directory in which the ExtensionManager will look for Extensions.
*
* @return the list of paths to search in
*/
@@ -169,17 +162,17 @@
}
/**
- * Return all the {@link OptionalPackage}s that satisfy specified
- * {@link Extension}. It is expected that this {@link Extension}
- * object will be one retrieved via getLocalExtension() method. If the
- * specified {@link Extension} is not local then <code>null</code>
- * is returned.
+ * Return all the {@link OptionalPackage}s that satisfy specified {@link
+ * Extension}. It is expected that this {@link Extension} object will be one
+ * retrieved via getLocalExtension() method. If the specified {@link
+ * Extension} is not local then <code>null</code> is returned.
*
* @param extension the extension to search for
- * @return an array of optional packages that satisfy the extension
- * (and the extensions dependencies)
+ * @return an array of optional packages that satisfy the extension (and the
+ * extensions dependencies)
*/
- public synchronized OptionalPackage[] getOptionalPackages( final Extension extension )
+ public synchronized OptionalPackage[] getOptionalPackages(
+ final Extension extension )
{
if( m_needToScan )
{
@@ -187,13 +180,15 @@
}
final ArrayList results = new ArrayList();
- final ArrayList candidates = (ArrayList)m_packages.get( extension.getExtensionName() );
+ final ArrayList candidates = (ArrayList)m_packages.get(
+ extension.getExtensionName() );
if( null != candidates )
{
final int size = candidates.size();
for( int i = 0; i < size; i++ )
{
- final OptionalPackage optionalPackage = (OptionalPackage)candidates.get( i );
+ final OptionalPackage optionalPackage = (OptionalPackage)candidates.get(
+ i );
final Extension[] extensions = optionalPackage.getAvailableExtensions();
for( int j = 0; j < extensions.length; j++ )
@@ -228,7 +223,8 @@
final int size = list.size();
for( int i = 0; i < size; i++ )
{
- final OptionalPackage optionalPackage = (OptionalPackage)list.get( i );
+ final OptionalPackage optionalPackage = (OptionalPackage)list.get(
+ i );
if( !packages.contains( optionalPackage ) )
{
packages.add( optionalPackage );
@@ -236,7 +232,8 @@
}
}
- return (OptionalPackage[])packages.toArray( new OptionalPackage[ packages.size() ] );
+ return (OptionalPackage[])packages.toArray(
+ new OptionalPackage[ packages.size() ] );
}
/**
@@ -264,8 +261,8 @@
}
/**
- * Add path elements to repository search path.
- * Note that each path element is separated by a '|' character.
+ * Add path elements to repository search path. Note that each path element
+ * is separated by a '|' character.
*
* @param pathString the path elements to add to repository search path
*/
@@ -276,8 +273,8 @@
}
/**
- * Set the path for the Repository.
- * Note thart each path element is separated by a '|' character.
+ * Set the path for the Repository. Note thart each path element is
+ * separated by a '|' character.
*
* @param pathString the list of directories in which to search
*/
@@ -311,10 +308,9 @@
}
/**
- * Scan the path for this repository and reload all
- * the "Optional Packages" found in the path.
- * All of the old Extensions/Optional Packages will
- * be removed.
+ * Scan the path for this repository and reload all the "Optional Packages"
+ * found in the path. All of the old Extensions/Optional Packages will be
+ * removed.
*/
protected final synchronized void scanPath()
{
@@ -327,9 +323,8 @@
}
/**
- * Utility method to scan a directory for
- * all jar fi;les in directory and add them as
- * OptionalPackages.
+ * Utility method to scan a directory for all jar fi;les in directory and
+ * add them as OptionalPackages.
*
* @param directory the directory to scan
*/
@@ -367,13 +362,16 @@
try
{
- final OptionalPackage optionalPackage = getOptionalPackage( file );
+ final OptionalPackage optionalPackage = getOptionalPackage(
+ file );
cacheOptionalPackage( optionalPackage );
}
catch( final IOException ioe )
{
final String message =
- "Skipping " + file + " as it could not be loaded " +
+ "Skipping " +
+ file +
+ " as it could not be loaded " +
"due to " + ioe;
debug( message );
}
@@ -390,13 +388,14 @@
}
/**
- * Add OptionalPackage to internal cache of Optional Packages.
- * Note that this method is only protected so that unit tests can sub-class
- * and add entries to PackageRepository by calling this method.
+ * Add OptionalPackage to internal cache of Optional Packages. Note that
+ * this method is only protected so that unit tests can sub-class and add
+ * entries to PackageRepository by calling this method.
*
* @param optionalPackage the OptionalPackage to be added to repository
*/
- protected final synchronized void cacheOptionalPackage( final OptionalPackage optionalPackage )
+ protected final synchronized void cacheOptionalPackage(
+ final OptionalPackage optionalPackage )
{
m_needToScan = false;
@@ -407,7 +406,8 @@
}
final Extension extension = optionalPackage.getAvailableExtensions()[ 0 ];
- ArrayList candidates = (ArrayList)m_packages.get( extension.getExtensionName() );
+ ArrayList candidates = (ArrayList)m_packages.get(
+ extension.getExtensionName() );
if( null == candidates )
{
candidates = new ArrayList();
@@ -461,8 +461,8 @@
}
/**
- * Get Canonical or failing that the absolute file
- * for every specified file.
+ * Get Canonical or failing that the absolute file for every specified
+ * file.
*
* @param path the files that make up path
* @return the resolved path
@@ -478,8 +478,7 @@
}
/**
- * Get Canonical or failing that the absolute file
- * for specified file.
+ * Get Canonical or failing that the absolute file for specified file.
*
* @param file the file
* @return the resolved file
@@ -515,8 +514,8 @@
}
/**
- * Make sure specified path element is valid.
- * The elements should exist and should be a directory.
+ * Make sure specified path element is valid. The elements should exist and
+ * should be a directory.
*
* @param file the path element
*/
@@ -524,7 +523,8 @@
{
if( !file.exists() || !file.isDirectory() )
{
- final String message = "path element " + file +
+ final String message = "path element " +
+ file +
" must exist and must be a directory";
throw new IllegalArgumentException( message );
}
@@ -570,7 +570,8 @@
*/
private static String[] split( final String string, final String onToken )
{
- final StringTokenizer tokenizer = new StringTokenizer( string, onToken );
+ final StringTokenizer tokenizer = new StringTokenizer( string,
+ onToken );
final String[] result = new String[ tokenizer.countTokens() ];
for( int i = 0; i < result.length; i++ )
Index: DelegatingExtensionManager.java
===================================================================
RCS file: /cvsroot/jcontainer/jcontainer/loom/engine/src/java/org/jcontainer/loom/components/extensions/pkgmgr/impl/DelegatingExtensionManager.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -d -r1.4 -r1.5
--- DelegatingExtensionManager.java 16 Oct 2003 14:45:45 -0000 1.4
+++ DelegatingExtensionManager.java 29 Nov 2003 13:44:19 -0000 1.5
@@ -93,18 +93,16 @@
import org.realityforge.extension.Extension;
/**
- * A {@link ExtensionManager} that can delegate to multiple
- * different package repositories.
+ * A {@link ExtensionManager} that can delegate to multiple different package
+ * repositories.
*
- * @author <a href="mailto:peter at realityforge.org">Peter Donald</a>
+ * @author Peter Donald
* @version $Revision$ $Date$
*/
public class DelegatingExtensionManager
implements ExtensionManager
{
- /**
- * The list containing the {@link ExtensionManager} objects.
- */
+ /** The list containing the {@link ExtensionManager} objects. */
private final ArrayList m_extensionManagers = new ArrayList();
/**
@@ -117,7 +115,8 @@
/**
* Default constructor that delegates to specified extensionManagers.
*/
- public DelegatingExtensionManager( final ExtensionManager[] extensionManagers )
+ public DelegatingExtensionManager(
+ final ExtensionManager[] extensionManagers )
{
for( int i = 0; i < extensionManagers.length; i++ )
{
@@ -126,12 +125,13 @@
}
/**
- * Add a extensionManager to list of repositories delegated to
- * to find Optional Packages.
+ * Add a extensionManager to list of repositories delegated to to find
+ * Optional Packages.
*
* @param extensionManager the extensionManager to add
*/
- protected synchronized void addExtensionManager( final ExtensionManager extensionManager )
+ protected synchronized void addExtensionManager(
+ final ExtensionManager extensionManager )
{
if( !m_extensionManagers.contains( extensionManager ) )
{
@@ -140,48 +140,52 @@
}
/**
- * Add a extensionManager to list of repositories delegated to
- * to find Optional Packages.
+ * Add a extensionManager to list of repositories delegated to to find
+ * Optional Packages.
*
* @param extensionManager the extensionManager to add
* @deprecated Use addExtensionManager instead
*/
- protected void addPackageRepository( final ExtensionManager extensionManager )
+ protected void addPackageRepository(
+ final ExtensionManager extensionManager )
{
addExtensionManager( extensionManager );
}
/**
- * Remove a repository from list of repositories delegated to
- * to find Optional Packages.
+ * Remove a repository from list of repositories delegated to to find
+ * Optional Packages.
*
* @param repository the repository to remove
*/
- protected synchronized void removeExtensionManager( final ExtensionManager repository )
+ protected synchronized void removeExtensionManager(
+ final ExtensionManager repository )
{
m_extensionManagers.remove( repository );
}
/**
- * Remove a extensionManager from list of repositories delegated to
- * to find Optional Packages.
+ * Remove a extensionManager from list of repositories delegated to to find
+ * Optional Packages.
*
* @param extensionManager the extensionManager to remove
* @deprecated Use removeExtensionManager instead.
*/
- protected void removePackageRepository( final ExtensionManager extensionManager )
+ protected void removePackageRepository(
+ final ExtensionManager extensionManager )
{
removeExtensionManager( extensionManager );
}
/**
- * Scan through list of respositories and return all the matching {@link OptionalPackage}
- * objects that match in any repository.
+ * Scan through list of respositories and return all the matching {@link
+ * OptionalPackage} objects that match in any repository.
*
* @param extension the extension to search for
* @return the matching {@link OptionalPackage} objects.
*/
- public synchronized OptionalPackage[] getOptionalPackages( final Extension extension )
+ public synchronized OptionalPackage[] getOptionalPackages(
+ final Extension extension )
{
final ArrayList resultPackages = new ArrayList();
Index: NoopExtensionManager.java
===================================================================
RCS file: /cvsroot/jcontainer/jcontainer/loom/engine/src/java/org/jcontainer/loom/components/extensions/pkgmgr/impl/NoopExtensionManager.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -d -r1.4 -r1.5
--- NoopExtensionManager.java 16 Oct 2003 14:45:45 -0000 1.4
+++ NoopExtensionManager.java 29 Nov 2003 13:44:19 -0000 1.5
@@ -91,11 +91,11 @@
import org.realityforge.extension.Extension;
/**
- * A Noop ExtensionManager that can't provide any extensions.
- * This is for use in certain environments (ala Servlets) that
- * require apps to be be self-contained.
+ * A Noop ExtensionManager that can't provide any extensions. This is for use in
+ * certain environments (ala Servlets) that require apps to be be
+ * self-contained.
*
- * @author <a href="mailto:peter at realityforge.org">Peter Donald</a>
+ * @author Peter Donald
* @version $Revision$ $Date$
*/
public class NoopExtensionManager
Index: OptionalPackageComparator.java
===================================================================
RCS file: /cvsroot/jcontainer/jcontainer/loom/engine/src/java/org/jcontainer/loom/components/extensions/pkgmgr/impl/OptionalPackageComparator.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -d -r1.4 -r1.5
--- OptionalPackageComparator.java 16 Oct 2003 14:45:45 -0000 1.4
+++ OptionalPackageComparator.java 29 Nov 2003 13:44:19 -0000 1.5
@@ -92,19 +92,17 @@
import org.realityforge.extension.Extension;
/**
- * A simple class to compare two extensions and sort them
- * on spec version and then on impl version. Unspecified
- * versions rate lower than specified versions.
+ * A simple class to compare two extensions and sort them on spec version and
+ * then on impl version. Unspecified versions rate lower than specified
+ * versions.
*
- * @author <a href="mailto:peter at realityforge.org">Peter Donald</a>
+ * @author Peter Donald
* @version $Revision$ $Date$
*/
class OptionalPackageComparator
implements Comparator
{
- /**
- * The name of extension the comparator is working with.
- */
+ /** The name of extension the comparator is working with. */
private final String m_name;
public OptionalPackageComparator( final String name )