diff --git a/proposal/myrmidon/build.xml b/proposal/myrmidon/build.xml
index 52ef5f398..0276a35d5 100644
--- a/proposal/myrmidon/build.xml
+++ b/proposal/myrmidon/build.xml
@@ -651,6 +651,8 @@ Legal:
+
+
-
+
@@ -740,6 +742,18 @@ Legal:
/>
+
+
+
+
+
+
+
+
+
+
+
+
Adam Murdoch
* @version $Revision$ $Date$
@@ -19,6 +19,12 @@ public class ConverterDefinition
private final String m_sourceType;
private final String m_destinationType;
+ /**
+ * Creates a converter definition.
+ * @param className the name of the implementing class
+ * @param sourceType the name of the types converted from
+ * @param destinationType the name of the type converted to
+ */
public ConverterDefinition( final String className,
final String sourceType,
final String destinationType )
@@ -29,7 +35,8 @@ public class ConverterDefinition
}
/**
- * Returns the converter's source type.
+ * Provides the name of the type which this converter can convert from.
+ * @return the converter's source type.
*/
public String getSourceType()
{
@@ -37,7 +44,8 @@ public class ConverterDefinition
}
/**
- * Returns the converter's destination type.
+ * Provides the name of the type which this converter can convert to.
+ * @return the converter's destination type.
*/
public String getDestinationType()
{
diff --git a/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/deployer/Deployer.java b/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/deployer/Deployer.java
index 2532e8aab..31d720c62 100644
--- a/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/deployer/Deployer.java
+++ b/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/deployer/Deployer.java
@@ -19,6 +19,7 @@ import org.apache.avalon.framework.service.ServiceManager;
*/
public interface Deployer
{
+ /** Role name for this interface. */
String ROLE = Deployer.class.getName();
/**
@@ -26,6 +27,7 @@ public interface Deployer
* creating the deployer if necessary.
*
* @param loader The ClassLoader to get the deployer for.
+ * @return the deployer for this loader.
* @exception DeploymentException if an error occurs.
*/
TypeDeployer createDeployer( ClassLoader loader )
@@ -36,13 +38,17 @@ public interface Deployer
* necessary.
*
* @param file the file containing the type library.
+ * @return the deployer for this type library.
* @exception DeploymentException if an error occurs.
*/
TypeDeployer createDeployer( File file )
throws DeploymentException;
/**
- * Creates a child deployer.
+ * Creates a deployer which is a child of this deployer.
+ * @param componentManager the ServiceManager for this component.
+ * @return a child deployer.
+ * @throws ServiceException if an error occurs.
*/
Deployer createChildDeployer( ServiceManager componentManager )
throws ServiceException;
diff --git a/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/deployer/TypeDefinition.java b/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/deployer/TypeDefinition.java
index aee5b47cb..ed5a3e5ca 100644
--- a/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/deployer/TypeDefinition.java
+++ b/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/deployer/TypeDefinition.java
@@ -19,6 +19,12 @@ public class TypeDefinition
private final String m_role;
private final String m_classname;
+ /**
+ * Creates a TypeDefinition
+ * @param name the name of the type
+ * @param roleShorthand the name of the role played by this type
+ * @param className the name of the class implementing this type
+ */
public TypeDefinition( final String name,
final String roleShorthand,
final String className )
@@ -29,7 +35,7 @@ public class TypeDefinition
}
/**
- * Returns the type's implementation class name.
+ * @return the type's implementation class name.
*/
public final String getClassname()
{
@@ -37,7 +43,7 @@ public class TypeDefinition
}
/**
- * Returns the type's role.
+ * @return the type's role.
*/
public final String getRole()
{
@@ -45,7 +51,7 @@ public class TypeDefinition
}
/**
- * Returns the type's name.
+ * @return the type's name.
*/
public String getName()
{
diff --git a/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/deployer/TypeDeployer.java b/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/deployer/TypeDeployer.java
index d95a28531..64a6185ff 100644
--- a/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/deployer/TypeDeployer.java
+++ b/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/deployer/TypeDeployer.java
@@ -18,6 +18,8 @@ public interface TypeDeployer
{
/**
* Deploys everything in the type library.
+ * @throws DeploymentException
+ * If the library cannot be deployed.
*/
void deployAll()
throws DeploymentException;
@@ -43,6 +45,9 @@ public interface TypeDeployer
*
* @param typeDef
* The type definition.
+ *
+ * @throws DeploymentException
+ * If the type cannot be deployed.
*/
void deployType( TypeDefinition typeDef )
throws DeploymentException;
diff --git a/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/embeddor/Embeddor.java b/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/embeddor/Embeddor.java
index 12bd66e0a..eb53831b4 100644
--- a/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/embeddor/Embeddor.java
+++ b/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/embeddor/Embeddor.java
@@ -20,6 +20,7 @@ import org.apache.myrmidon.listeners.ProjectListener;
*/
public interface Embeddor
{
+ /** Role name for this interface. */
String ROLE = Embeddor.class.getName();
/**
@@ -30,6 +31,8 @@ public interface Embeddor
* project file name.
* @param parameters The project builder parameters.
* @return the created Project
+ * @throws Exception If an error occurs creating the Project.
+ *
* @todo Should location be a URL or will it automatically assume file
* unless there is a protocol section like ftp:, file: etc
* @todo parameters needs more thought put into it.
@@ -42,6 +45,7 @@ public interface Embeddor
*
* @param name The shorthand name of the listener.
* @return the listener.
+ * @throws Exception If the listener could not be created.
*/
ProjectListener createListener( String name )
throws Exception;
@@ -51,6 +55,7 @@ public interface Embeddor
*
* @param parameters The properties to define in the workspace
* @return the Workspace
+ * @throws Exception If the workspace could not be created.
*/
Workspace createWorkspace( Parameters parameters )
throws Exception;
diff --git a/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/executor/ExecutionFrame.java b/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/executor/ExecutionFrame.java
index 79a5d2c06..156e39dbe 100644
--- a/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/executor/ExecutionFrame.java
+++ b/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/executor/ExecutionFrame.java
@@ -19,11 +19,21 @@ import org.apache.myrmidon.interfaces.type.TypeManager;
*/
public interface ExecutionFrame
{
+ /** Role name for this interface. */
String ROLE = ExecutionFrame.class.getName();
+ /**
+ * @return The TypeManager to use for creating Tasks.
+ */
TypeManager getTypeManager();
+ /**
+ * @return The logger which is used for execution messages.
+ */
Logger getLogger();
+ /**
+ * @return The TaskContext in which the task is executed.
+ */
TaskContext getContext();
}
diff --git a/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/executor/Executor.java b/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/executor/Executor.java
index 81f3499e0..e791c540e 100644
--- a/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/executor/Executor.java
+++ b/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/executor/Executor.java
@@ -18,12 +18,14 @@ import org.apache.myrmidon.api.TaskException;
*/
public interface Executor
{
+ /** Role name for this interface. */
String ROLE = Executor.class.getName();
/**
* execute a task.
*
* @param task the configruation data for task
+ * @param frame The frame in which the task is executed.
* @exception TaskException if an error occurs
*/
void execute( Configuration task, ExecutionFrame frame )
diff --git a/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/extensions/ExtensionManager.java b/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/extensions/ExtensionManager.java
index a1d4ddf58..7f616d944 100644
--- a/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/extensions/ExtensionManager.java
+++ b/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/extensions/ExtensionManager.java
@@ -18,5 +18,6 @@ import org.apache.avalon.excalibur.extension.PackageRepository;
public interface ExtensionManager
extends PackageRepository
{
+ /** Role name for this interface. */
String ROLE = ExtensionManager.class.getName();
}
diff --git a/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/model/DefaultNameValidator.java b/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/model/DefaultNameValidator.java
index f1e14da40..135d3e578 100644
--- a/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/model/DefaultNameValidator.java
+++ b/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/model/DefaultNameValidator.java
@@ -82,6 +82,7 @@ public class DefaultNameValidator
* Creates a valid name based on the supplied string value, removing invalid
* characters. If no valid characters are present, an exception is thrown.
* @param baseName the name used to construct the valid name
+ * @return a valid name based on the supplied name.
* @throws Exception if no valid name could be constructed.
*/
public String makeValidName( final String baseName ) throws Exception
@@ -113,8 +114,7 @@ public class DefaultNameValidator
}
/**
- * Validates the supplied name, failing if it is not.
- * @throws Exception is the supplied name is not valid.
+ * @see NameValidator
*/
public void validate( final String name ) throws Exception
{
diff --git a/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/model/Dependency.java b/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/model/Dependency.java
index 8c2ff9d3e..21043e5d8 100644
--- a/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/model/Dependency.java
+++ b/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/model/Dependency.java
@@ -18,17 +18,27 @@ public class Dependency
private final String m_projectName;
private final String m_targetName;
+ /**
+ * @param projectName The project containing the depended-on target.
+ * @param targetName The name of the depended-on target.
+ */
public Dependency( final String projectName, final String targetName )
{
m_projectName = projectName;
m_targetName = targetName;
}
+ /**
+ * @return The name of the project containing the depended-on target.
+ */
public String getProjectName()
{
return m_projectName;
}
+ /**
+ * @return The name of the depended-on target.
+ */
public String getTargetName()
{
return m_targetName;
diff --git a/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/model/NameValidator.java b/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/model/NameValidator.java
index c6f71af51..d754a50e4 100644
--- a/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/model/NameValidator.java
+++ b/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/model/NameValidator.java
@@ -17,6 +17,7 @@ public interface NameValidator
{
/**
* Validates the supplied name, failing if it is not.
+ * @param name The name to be validated.
* @throws Exception is the supplied name is not valid.
*/
void validate( String name ) throws Exception;
diff --git a/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/model/Project.java b/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/model/Project.java
index a42bb428b..dce423709 100644
--- a/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/model/Project.java
+++ b/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/model/Project.java
@@ -18,9 +18,10 @@ import java.io.File;
*/
public interface Project
{
+ /** Role name for this interface. */
String ROLE = Project.class.getName();
- // the name of currently executing project
+ /** Property which holds the name of currently executing project */
String PROJECT = "myrmidon.project.name";
// the name of currently executing project
@@ -30,7 +31,7 @@ public interface Project
//String TARGET = "myrmidon.target.name";
/**
- * Returns the project name.
+ * @return the project name.
*
* TODO: Determine if projects should carry their own name. Breaks IOC but
* Can be useful as project files embed own name (or should that be description).
diff --git a/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/model/Target.java b/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/model/Target.java
index 1dbaab8d0..4bac20013 100644
--- a/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/model/Target.java
+++ b/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/model/Target.java
@@ -23,6 +23,8 @@ public class Target
/**
* Constructs a target.
+ * @param tasks The task models for all tasks in this target.
+ * @param dependencies The dependencies for executing this target.
*/
public Target( final Configuration[] tasks,
final Dependency[] dependencies )
diff --git a/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/model/TypeLib.java b/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/model/TypeLib.java
index a292543da..fac8c21c6 100644
--- a/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/model/TypeLib.java
+++ b/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/model/TypeLib.java
@@ -27,11 +27,21 @@ public class TypeLib
//The name of type instance
private final String m_name;
+ /**
+ * Create a import for a complete library.
+ * @param library The name of the library to import.
+ */
public TypeLib( final String library )
{
this( library, null, null );
}
+ /**
+ * Create an import for a single type from a library.
+ * @param library The library containing the type.
+ * @param role The role for the imported type.
+ * @param name The name of the imported type.
+ */
public TypeLib( final String library, final String role, final String name )
{
m_library = library;
diff --git a/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/property/PropertyResolver.java b/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/property/PropertyResolver.java
index 6a7b0335b..66d09dd22 100644
--- a/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/property/PropertyResolver.java
+++ b/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/property/PropertyResolver.java
@@ -22,6 +22,7 @@ import org.apache.myrmidon.api.TaskContext;
*/
public interface PropertyResolver
{
+ /** Role name for this interface. */
String ROLE = PropertyResolver.class.getName();
/**
diff --git a/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/role/RoleInfo.java b/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/role/RoleInfo.java
index fa1ebc43d..899d36075 100644
--- a/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/role/RoleInfo.java
+++ b/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/role/RoleInfo.java
@@ -23,7 +23,9 @@ public final class RoleInfo
/**
* Creates a role definition.
*
- * @param name The role name.
+ *
+ * Same as calling RoleInfo( name, null, null, null )
+ * @see #RoleInfo( String, String, Class, String )
*/
public RoleInfo( final String name )
{
@@ -33,8 +35,8 @@ public final class RoleInfo
/**
* Creates a role definition.
*
- * @param name The role name.
- * @param shorthand The role shorthand name.
+ * Same as calling RoleInfo( name, shorthand, null, null )
+ * @see #RoleInfo( String, String, Class, String )
*/
public RoleInfo( final String name, final String shorthand )
{
@@ -43,10 +45,8 @@ public final class RoleInfo
/**
* Creates a role definition.
- *
- * @param name The role name.
- * @param shorthand The role shorthand name. May be null.
- * @param type The role type. May be null.
+ * Same as calling RoleInfo( name, shorthand, type, null )
+ * @see #RoleInfo( String, String, Class, String )
*/
public RoleInfo( final String name, final String shorthand, final Class type )
{
@@ -56,6 +56,8 @@ public final class RoleInfo
/**
* Creates a role definition. The role type's fully-qualified name
* is used as the role name.
+ *
+ * @see #RoleInfo( String, String, Class, String )
*/
public RoleInfo( final String shorthand, final Class type )
{
@@ -64,6 +66,10 @@ public final class RoleInfo
/**
* Creates a role definition.
+ * @param name The role name.
+ * @param shorthand The role shorthand name. May be null.
+ * @param type The role type. May be null.
+ * @param defaultType The default type to use. May be null.
*/
public RoleInfo( final String name,
final String shorthand,
@@ -78,6 +84,8 @@ public final class RoleInfo
/**
* Compares a role to this role.
+ * @param role The RoleInfo to compare.
+ * @return true if the supplied role is equal to this one.
*/
public boolean equals( final RoleInfo role )
{
@@ -105,7 +113,8 @@ public final class RoleInfo
}
/**
- * Returns this role's name. This name uniquely identifies the role.
+ * Provides this role's name, which uniquely identifies the role.
+ * @return The role name.
*/
public String getName()
{
diff --git a/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/role/RoleManager.java b/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/role/RoleManager.java
index 174b75bcd..c691429e0 100644
--- a/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/role/RoleManager.java
+++ b/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/role/RoleManager.java
@@ -19,6 +19,7 @@ package org.apache.myrmidon.interfaces.role;
*/
public interface RoleManager
{
+ /** Role name for this interface. */
String ROLE = RoleManager.class.getName();
/**
@@ -47,6 +48,8 @@ public interface RoleManager
/**
* Adds a role definition.
+ * @param role The RoleInfo definition of the role to add.
+ * @throws RoleException If this role conflict with an existing role.
*/
void addRole( RoleInfo role ) throws RoleException;
}
diff --git a/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/service/MultiSourceServiceManager.java b/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/service/MultiSourceServiceManager.java
index 63db8f6aa..189f36571 100644
--- a/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/service/MultiSourceServiceManager.java
+++ b/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/service/MultiSourceServiceManager.java
@@ -31,6 +31,7 @@ public class MultiSourceServiceManager
/**
* Adds a service manager to the end of the source list.
+ * @param mgr The ServiceManager to add.
*/
public void add( final ServiceManager mgr )
{
@@ -39,6 +40,9 @@ public class MultiSourceServiceManager
/**
* Determines if this service manager contains a particular service.
+ * @param serviceRole The name of the service to check for.
+ * @return true if this service manager contains
+ * the named service.
*/
public boolean hasService( final String serviceRole )
{
@@ -81,6 +85,7 @@ public class MultiSourceServiceManager
/**
* Releases a service.
+ * @param service The service to release.
*/
public void release( final Object service )
{
diff --git a/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/service/ServiceFactory.java b/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/service/ServiceFactory.java
index fda9c3bcb..372263995 100644
--- a/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/service/ServiceFactory.java
+++ b/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/service/ServiceFactory.java
@@ -19,12 +19,15 @@ package org.apache.myrmidon.interfaces.service;
*/
public interface ServiceFactory
{
+ /** Role name for this interface. */
String ROLE = ServiceFactory.class.getName();
/**
* Create a service that corresponds to this factory.
* This method is usually called after the factory has been
* prepared and configured as appropriate.
+ * @return The created service.
+ * @throws AntServiceException If the service could not be created.
*/
Object createService()
throws AntServiceException;
diff --git a/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/type/DefaultTypeFactory.java b/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/type/DefaultTypeFactory.java
index ed7b473cc..7fd128369 100644
--- a/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/type/DefaultTypeFactory.java
+++ b/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/type/DefaultTypeFactory.java
@@ -32,6 +32,7 @@ public class DefaultTypeFactory
/**
* Construct a factory that uses specified ClassLoader to load
* types from.
+ * @param classLoader The ClassLoader to use for loading types.
*/
public DefaultTypeFactory( final ClassLoader classLoader )
{
@@ -52,6 +53,8 @@ public class DefaultTypeFactory
/**
* Map a name to the fully qualified name of the Class that implements type.
+ * @param name The type name.
+ * @param className The fully qualified name of the implementin Class.
*/
public void addNameClassMapping( final String name, final String className )
{
@@ -59,7 +62,7 @@ public class DefaultTypeFactory
}
/**
- * Determines if this factory can create instances of a particular type.
+ * @see TypeFactory#canCreate
*/
public boolean canCreate( String name )
{
@@ -67,11 +70,7 @@ public class DefaultTypeFactory
}
/**
- * Create a type instance with appropriate name.
- *
- * @param name the name
- * @return the created instance
- * @exception TypeException if an error occurs
+ * @see TypeFactory#create
*/
public Object create( final String name )
throws TypeException
@@ -103,6 +102,9 @@ public class DefaultTypeFactory
return (String)m_classNames.get( name );
}
+ /**
+ * @return The ClassLoader to use for loading types.
+ */
protected ClassLoader getClassLoader()
{
return m_classLoader;
diff --git a/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/type/ReloadingTypeFactory.java b/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/type/ReloadingTypeFactory.java
index 3a555fc19..b6190caeb 100644
--- a/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/type/ReloadingTypeFactory.java
+++ b/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/type/ReloadingTypeFactory.java
@@ -35,6 +35,10 @@ public class ReloadingTypeFactory
* Construct a factory that recreats a ClassLoader from specified
* URLs and with specified parent ClassLoader. The specified urls must
* not be null.
+ * @param urls
+ * The URLs to include in the created classloader.
+ * @param parent
+ * The parent to use for the created classloader. May be null.
*/
public ReloadingTypeFactory( final URL[] urls,
final ClassLoader parent )
@@ -47,6 +51,9 @@ public class ReloadingTypeFactory
m_parent = parent;
}
+ /**
+ * @see DefaultTypeFactory
+ */
protected ClassLoader getClassLoader()
{
return new URLClassLoader( m_urls, m_parent );
diff --git a/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/type/TypeFactory.java b/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/type/TypeFactory.java
index c2e5b5d6f..07c918408 100644
--- a/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/type/TypeFactory.java
+++ b/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/type/TypeFactory.java
@@ -19,6 +19,7 @@ public interface TypeFactory
* Determines if this factory can create instances of a particular type.
*
* @param name the type name.
+ * @return true if this is a valid factory for the named type.
*/
boolean canCreate( String name );
diff --git a/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/type/TypeManager.java b/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/type/TypeManager.java
index 178165451..08750339e 100644
--- a/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/type/TypeManager.java
+++ b/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/type/TypeManager.java
@@ -15,6 +15,7 @@ package org.apache.myrmidon.interfaces.type;
*/
public interface TypeManager
{
+ /** Role name for this interface. */
String ROLE = TypeManager.class.getName();
/**
@@ -23,6 +24,7 @@ public interface TypeManager
* @param roleName The role for the type.
* @param shorthandName The shorthand name for the type.
* @param factory The type factory.
+ * @throws TypeException If an error occurs.
*/
void registerType( String roleName, String shorthandName, TypeFactory factory )
throws TypeException;
@@ -31,6 +33,8 @@ public interface TypeManager
* Returns the factory for a role.
*
* @param roleName The role for the type.
+ * @return The TypeFactory for the named role.
+ * @throws TypeException If the rolename is invalid.
*/
TypeFactory getFactory( String roleName )
throws TypeException;
@@ -39,6 +43,7 @@ public interface TypeManager
* Creates a child type manager. The child inherits the type factories
* from this type manager. Additional type factories may be added to the
* child, without affecting this type manager.
+ * @return A TypeManager with this as it's parent.
*/
TypeManager createChildTypeManager();
}
diff --git a/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/workspace/Workspace.java b/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/workspace/Workspace.java
index a49fcc02c..82f8362ba 100644
--- a/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/workspace/Workspace.java
+++ b/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/workspace/Workspace.java
@@ -19,6 +19,7 @@ import org.apache.myrmidon.listeners.ProjectListener;
*/
public interface Workspace
{
+ /** Role name for this interface. */
String ROLE = Workspace.class.getName();
/**