You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@ant.apache.org by da...@apache.org on 2002/04/01 11:56:28 UTC
cvs commit: jakarta-ant/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/workspace Workspace.java
darrell 02/04/01 01:56:28
Modified: proposal/myrmidon build.xml
proposal/myrmidon/src/java/org/apache/myrmidon/components/builder
ConvertingProjectBuilder.java DefaultProject.java
DefaultProjectBuilder.java
TransformingProjectBuilder.java
proposal/myrmidon/src/java/org/apache/myrmidon/components/configurer
ClassicConfigurer.java DefaultConfigurer.java
proposal/myrmidon/src/java/org/apache/myrmidon/components/deployer
Deployment.java RoleDescriptor.java
RoleDescriptorBuilder.java ServiceDescriptor.java
ServiceDescriptorBuilder.java TypeDescriptor.java
TypeDescriptorBuilder.java
proposal/myrmidon/src/java/org/apache/myrmidon/components/embeddor
DefaultEmbeddor.java
proposal/myrmidon/src/java/org/apache/myrmidon/components/executor
DefaultExecutor.java
proposal/myrmidon/src/java/org/apache/myrmidon/components/service
InstantiatingServiceManager.java
proposal/myrmidon/src/java/org/apache/myrmidon/components/type
MultiSourceTypeFactory.java
proposal/myrmidon/src/java/org/apache/myrmidon/components/workspace
DefaultWorkspace.java
proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/aspect
AspectManager.java
proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/builder
ProjectBuilder.java
proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/classloader
ClassLoaderManager.java
proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/configurer
Configurer.java
proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/converter
ConverterRegistry.java
proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/deployer
ConverterDefinition.java Deployer.java
TypeDefinition.java TypeDeployer.java
proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/embeddor
Embeddor.java
proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/executor
ExecutionFrame.java Executor.java
proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/extensions
ExtensionManager.java
proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/model
DefaultNameValidator.java Dependency.java
NameValidator.java Project.java Target.java
TypeLib.java
proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/property
PropertyResolver.java
proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/role
RoleInfo.java RoleManager.java
proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/service
MultiSourceServiceManager.java ServiceFactory.java
proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/type
DefaultTypeFactory.java ReloadingTypeFactory.java
TypeFactory.java TypeManager.java
proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/workspace
Workspace.java
Log:
* Fixed a bunch of checkstyle violations (mostly
javadoc)
* Added basic javadoc target to build.
Revision Changes Path
1.100 +15 -1 jakarta-ant/proposal/myrmidon/build.xml
Index: build.xml
===================================================================
RCS file: /home/cvs/jakarta-ant/proposal/myrmidon/build.xml,v
retrieving revision 1.99
retrieving revision 1.100
diff -u -r1.99 -r1.100
--- build.xml 1 Apr 2002 00:40:41 -0000 1.99
+++ build.xml 1 Apr 2002 09:56:25 -0000 1.100
@@ -651,6 +651,8 @@
<target name="checkstyle" description="Checkstyle">
+ <property name="checkstyle.dir" value="${java.dir}"/>
+
<!-- this invocation of checkstyle requires that checkstyle be downloaded and setup -->
<!-- thats why you are required to define do.checkstyle property to generate the report -->
<taskdef name="checkstyle"
@@ -678,7 +680,7 @@
cacheFile="checkstyle.cache"
failOnViolation="false"
ignoreCastWhitespace="true">
- <fileset dir="${java.dir}">
+ <fileset dir="${checkstyle.dir}">
<include name="**/*.java"/>
</fileset>
<formatter type="plain"/>
@@ -738,6 +740,18 @@
excludes="stylesheets/**"
velocitypropertiesfile="src/xdocs/velocity.properties"
/>
+ </target>
+
+ <target name="javadoc" description="Generates the API docs.">
+ <property name="build.apidocs" value="${build.dir}/apidocs"/>
+ <mkdir dir="${build.apidocs}"/>
+
+ <javadoc destdir="${build.apidocs}" packagenames="org.apache.*">
+ <sourcepath>
+ <pathelement location="${java.dir}"/>
+ </sourcepath>
+ <classpath refid="project.class.path"/>
+ </javadoc>
</target>
<!-- Creates the distribution -->
1.2 +8 -1 jakarta-ant/proposal/myrmidon/src/java/org/apache/myrmidon/components/builder/ConvertingProjectBuilder.java
Index: ConvertingProjectBuilder.java
===================================================================
RCS file: /home/cvs/jakarta-ant/proposal/myrmidon/src/java/org/apache/myrmidon/components/builder/ConvertingProjectBuilder.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- ConvertingProjectBuilder.java 31 Mar 2002 10:56:58 -0000 1.1
+++ ConvertingProjectBuilder.java 1 Apr 2002 09:56:25 -0000 1.2
@@ -18,7 +18,7 @@
* configuration into a Myrmidon one.
*
* @author <a href="mailto:darrell@apache.org">Darrell DeBoer</a>
- * @version $Revision: 1.1 $ $Date: 2002/03/31 10:56:58 $
+ * @version $Revision: 1.2 $ $Date: 2002/04/01 09:56:25 $
*
* @ant.type type="project-builder" name="xml"
*/
@@ -27,6 +27,13 @@
{
private static final String VERSION_ATTRIBUTE = "version";
+ /**
+ * Builds a Configuration from an Ant1 project file, converting it
+ * into a valid Myrmidon Project.
+ * @param systemID the xml Systemid of the project file.
+ * @return the configured project
+ * @throws ProjectException if an error occurs parsing the project file
+ */
protected Configuration parseProject( String systemID )
throws ProjectException
{
1.5 +6 -3 jakarta-ant/proposal/myrmidon/src/java/org/apache/myrmidon/components/builder/DefaultProject.java
Index: DefaultProject.java
===================================================================
RCS file: /home/cvs/jakarta-ant/proposal/myrmidon/src/java/org/apache/myrmidon/components/builder/DefaultProject.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- DefaultProject.java 29 Mar 2002 12:56:03 -0000 1.4
+++ DefaultProject.java 1 Apr 2002 09:56:25 -0000 1.5
@@ -20,7 +20,7 @@
* Default project implementation.
*
* @author <a href="mailto:peter@apache.org">Peter Donald</a>
- * @version $Revision: 1.4 $ $Date: 2002/03/29 12:56:03 $
+ * @version $Revision: 1.5 $ $Date: 2002/04/01 09:56:25 $
*/
public class DefaultProject
implements Project
@@ -50,7 +50,7 @@
private String m_name;
/**
- * Returns the project name.
+ * @return the project name.
*/
public String getProjectName()
{
@@ -59,6 +59,7 @@
/**
* Sets the project name.
+ * @param name the project name
*/
public void setProjectName( String name )
{
@@ -169,7 +170,8 @@
}
/**
- * Retrieve base directory of project.
+ * Sets the project base directory.
+ * @param baseDirectory the base directory for the project
*/
public final void setBaseDirectory( final File baseDirectory )
{
@@ -178,6 +180,7 @@
/**
* Adds a type library import to the project.
+ * @param typeLib the type library
*/
public final void addTypeLib( final TypeLib typeLib )
{
1.42 +25 -12 jakarta-ant/proposal/myrmidon/src/java/org/apache/myrmidon/components/builder/DefaultProjectBuilder.java
Index: DefaultProjectBuilder.java
===================================================================
RCS file: /home/cvs/jakarta-ant/proposal/myrmidon/src/java/org/apache/myrmidon/components/builder/DefaultProjectBuilder.java,v
retrieving revision 1.41
retrieving revision 1.42
diff -u -r1.41 -r1.42
--- DefaultProjectBuilder.java 29 Mar 2002 12:56:03 -0000 1.41
+++ DefaultProjectBuilder.java 1 Apr 2002 09:56:25 -0000 1.42
@@ -34,7 +34,7 @@
* Default implementation to construct project from a build file.
*
* @author <a href="mailto:peter@apache.org">Peter Donald</a>
- * @version $Revision: 1.41 $ $Date: 2002/03/29 12:56:03 $
+ * @version $Revision: 1.42 $ $Date: 2002/04/01 09:56:25 $
*
* @ant.type type="project-builder" name="ant"
*/
@@ -96,13 +96,17 @@
}
catch( Exception e )
{
- final String message = REZ.getString( "ant.project-build.error", file.getAbsolutePath() );
+ final String message = REZ.getString( "ant.project-build.error",
+ file.getAbsolutePath() );
throw new ProjectException( message, e );
}
}
/**
- * Parses the project.
+ * Builds a project configuration from a build file.
+ * @param systemID the XML system id of the build file
+ * @return the project configuration
+ * @throws ProjectException on parse error
*/
protected Configuration parseProject( final String systemID )
throws ProjectException
@@ -172,7 +176,8 @@
if( getLogger().isDebugEnabled() )
{
- final String message = REZ.getString( "ant.project-banner.notice", file, baseDirectory );
+ final String message = REZ.getString( "ant.project-banner.notice",
+ file, baseDirectory );
getLogger().debug( message );
}
@@ -189,7 +194,8 @@
* Get the project name from the configuration, or create a default name if none
* was supplied.
*/
- private String getProjectName( final Configuration configuration, final File file )
+ private String getProjectName( final Configuration configuration,
+ final File file )
throws ProjectException
{
String projectName = configuration.getAttribute( "name", null );
@@ -332,7 +338,8 @@
else
{
final String message =
- REZ.getString( "ant.unknown-toplevel-element.error", name, element.getLocation() );
+ REZ.getString( "ant.unknown-toplevel-element.error", name,
+ element.getLocation() );
throw new ProjectException( message );
}
}
@@ -355,7 +362,8 @@
if( null == name )
{
final String message =
- REZ.getString( "ant.projectref-no-name.error", element.getLocation() );
+ REZ.getString( "ant.projectref-no-name.error",
+ element.getLocation() );
throw new ProjectException( message );
}
@@ -366,14 +374,16 @@
catch( Exception e )
{
final String message =
- REZ.getString( "ant.projectref-bad-name.error", element.getLocation() );
+ REZ.getString( "ant.projectref-bad-name.error",
+ element.getLocation() );
throw new ProjectException( message, e );
}
if( null == location )
{
final String message =
- REZ.getString( "ant.projectref-no-location.error", element.getLocation() );
+ REZ.getString( "ant.projectref-no-location.error",
+ element.getLocation() );
throw new ProjectException( message );
}
@@ -487,7 +497,8 @@
}
}
- private Dependency[] buildDependsList( final String depends, final Configuration target )
+ private Dependency[] buildDependsList( final String depends,
+ final Configuration target )
throws ProjectException
{
//apply depends attribute
@@ -505,7 +516,8 @@
if( getLogger().isDebugEnabled() )
{
- final String message = REZ.getString( "ant.target-dependency.notice", dependency );
+ final String message = REZ.getString( "ant.target-dependency.notice",
+ dependency );
getLogger().debug( message );
}
@@ -524,7 +536,8 @@
targetName = dependency;
}
- if( targetName.length() == 0 || ( projectName != null && projectName.length() == 0 ) )
+ if( targetName.length() == 0 ||
+ ( projectName != null && projectName.length() == 0 ) )
{
final String message = REZ.getString( "ant.target-bad-dependency.error",
target.getName(),
1.5 +8 -1 jakarta-ant/proposal/myrmidon/src/java/org/apache/myrmidon/components/builder/TransformingProjectBuilder.java
Index: TransformingProjectBuilder.java
===================================================================
RCS file: /home/cvs/jakarta-ant/proposal/myrmidon/src/java/org/apache/myrmidon/components/builder/TransformingProjectBuilder.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- TransformingProjectBuilder.java 31 Mar 2002 10:56:58 -0000 1.4
+++ TransformingProjectBuilder.java 1 Apr 2002 09:56:25 -0000 1.5
@@ -25,7 +25,7 @@
* A Project Builder which performs an XSL transformation on a project.
*
* @author <a href="mailto:darrell@apache.org">Darrell DeBoer</a>
- * @version $Revision: 1.4 $ $Date: 2002/03/31 10:56:58 $
+ * @version $Revision: 1.5 $ $Date: 2002/04/01 09:56:25 $
*
* @ant.type type="project-builder" name="ant-transform"
*/
@@ -38,6 +38,13 @@
private static final String STYLESHEET = "ant1convert.xsl";
private Transformer m_transformer;
+ /**
+ * Builds a project Configuration from a project file, applying the
+ * ant1 conversion stylesheet.
+ * @param systemID the XML system id for the project file
+ * @return the project configuration
+ * @throws ProjectException if a parse error occurs
+ */
protected Configuration parseProject( String systemID )
throws ProjectException
{
1.12 +2 -1 jakarta-ant/proposal/myrmidon/src/java/org/apache/myrmidon/components/configurer/ClassicConfigurer.java
Index: ClassicConfigurer.java
===================================================================
RCS file: /home/cvs/jakarta-ant/proposal/myrmidon/src/java/org/apache/myrmidon/components/configurer/ClassicConfigurer.java,v
retrieving revision 1.11
retrieving revision 1.12
diff -u -r1.11 -r1.12
--- ClassicConfigurer.java 23 Mar 2002 04:01:25 -0000 1.11
+++ ClassicConfigurer.java 1 Apr 2002 09:56:25 -0000 1.12
@@ -154,7 +154,8 @@
if( DEBUG )
{
- final String message = REZ.getString( "configure-attribute.notice", name, value );
+ final String message = REZ.getString( "configure-attribute.notice",
+ name, value );
getLogger().debug( message );
}
1.44 +7 -4 jakarta-ant/proposal/myrmidon/src/java/org/apache/myrmidon/components/configurer/DefaultConfigurer.java
Index: DefaultConfigurer.java
===================================================================
RCS file: /home/cvs/jakarta-ant/proposal/myrmidon/src/java/org/apache/myrmidon/components/configurer/DefaultConfigurer.java,v
retrieving revision 1.43
retrieving revision 1.44
diff -u -r1.43 -r1.44
--- DefaultConfigurer.java 29 Mar 2002 12:56:03 -0000 1.43
+++ DefaultConfigurer.java 1 Apr 2002 09:56:26 -0000 1.44
@@ -33,7 +33,7 @@
* Class used to configure tasks.
*
* @author <a href="mailto:peter@apache.org">Peter Donald</a>
- * @version $Revision: 1.43 $ $Date: 2002/03/29 12:56:03 $
+ * @version $Revision: 1.44 $ $Date: 2002/04/01 09:56:26 $
* @ant.type type="configurer" name="default"
*/
public class DefaultConfigurer
@@ -104,7 +104,8 @@
catch( final Exception e )
{
// Wrap all other errors with general purpose error message
- final String message = REZ.getString( "bad-configure-element.error", configuration.getName() );
+ final String message = REZ.getString( "bad-configure-element.error",
+ configuration.getName() );
throw new ConfigurationException( message, e );
}
}
@@ -426,7 +427,8 @@
else
{
// Set the value
- PropertyConfigurer propConfigurer = getConfigurerFromName( state.getConfigurer(), name, false, false );
+ PropertyConfigurer propConfigurer =
+ getConfigurerFromName( state.getConfigurer(), name, false, false );
setValue( propConfigurer, state, value, context );
}
}
@@ -558,7 +560,8 @@
else
{
// Check the role name
- final RoleInfo roleInfo = m_roleManager.getRoleByType( propertyConfigurer.getType() );
+ final RoleInfo roleInfo =
+ m_roleManager.getRoleByType( propertyConfigurer.getType() );
if( roleInfo != null && name.equalsIgnoreCase( roleInfo.getShorthand() ) )
{
return propertyConfigurer;
1.26 +21 -11 jakarta-ant/proposal/myrmidon/src/java/org/apache/myrmidon/components/deployer/Deployment.java
Index: Deployment.java
===================================================================
RCS file: /home/cvs/jakarta-ant/proposal/myrmidon/src/java/org/apache/myrmidon/components/deployer/Deployment.java,v
retrieving revision 1.25
retrieving revision 1.26
diff -u -r1.25 -r1.26
--- Deployment.java 29 Mar 2002 12:56:03 -0000 1.25
+++ Deployment.java 1 Apr 2002 09:56:26 -0000 1.26
@@ -30,7 +30,7 @@
*
* @author <a href="mailto:peter@apache.org">Peter Donald</a>
* @author <a href="mailto:adammurdoch@apache.org">Adam Murdoch</a>
- * @version $Revision: 1.25 $ $Date: 2002/03/29 12:56:03 $
+ * @version $Revision: 1.26 $ $Date: 2002/04/01 09:56:26 $
*/
class Deployment
extends AbstractLogEnabled
@@ -85,7 +85,8 @@
// Build the role descriptors
final ArrayList roleUrls = locateResources( ROLE_DESCRIPTOR_NAME, jarUrl );
- final ArrayList roleDescriptors = buildDescriptors( roleUrls, m_roleBuilder, parser, handler );
+ final ArrayList roleDescriptors =
+ buildDescriptors( roleUrls, m_roleBuilder, parser, handler );
// Deploy the roles
// TODO - need to defer this
@@ -98,13 +99,17 @@
// Build the type descriptors
final ArrayList typeUrls = locateResources( TYPE_DESCRIPTOR_NAME, jarUrl );
- final ArrayList typeDescriptors = buildDescriptors( typeUrls, m_typeBuilder, parser, handler );
- m_descriptors = (TypeDescriptor[])typeDescriptors.toArray( new TypeDescriptor[ typeDescriptors.size() ] );
+ final ArrayList typeDescriptors =
+ buildDescriptors( typeUrls, m_typeBuilder, parser, handler );
+ m_descriptors = (TypeDescriptor[])typeDescriptors.toArray
+ ( new TypeDescriptor[ typeDescriptors.size() ] );
// Build the service descriptors
final ArrayList serviceUrls = locateResources( SERVICE_DESCRIPTOR_NAME, jarUrl );
- final ArrayList serviceDescriptors = buildDescriptors( serviceUrls, m_serviceBuilder, parser, handler );
- m_services = (ServiceDescriptor[])serviceDescriptors.toArray( new ServiceDescriptor[ serviceDescriptors.size() ] );
+ final ArrayList serviceDescriptors =
+ buildDescriptors( serviceUrls, m_serviceBuilder, parser, handler );
+ m_services = (ServiceDescriptor[])serviceDescriptors.toArray
+ ( new ServiceDescriptor[ serviceDescriptors.size() ] );
}
/**
@@ -198,7 +203,8 @@
}
catch( Exception e )
{
- final String message = REZ.getString( "deploy-type.error", typeDef.getRole(), typeDef.getName() );
+ final String message = REZ.getString( "deploy-type.error",
+ typeDef.getRole(), typeDef.getName() );
throw new DeploymentException( message, e );
}
}
@@ -220,7 +226,8 @@
// Parse the file
parser.parse( url );
- final TypelibDescriptor descriptor = builder.createDescriptor( handler.getConfiguration(), url );
+ final TypelibDescriptor descriptor =
+ builder.createDescriptor( handler.getConfiguration(), url );
descriptors.add( descriptor );
}
@@ -274,7 +281,8 @@
{
if( getLogger().isDebugEnabled() )
{
- final String message = REZ.getString( "url-deploy-roles.notice", descriptor.getUrl() );
+ final String message =
+ REZ.getString( "url-deploy-roles.notice", descriptor.getUrl() );
getLogger().debug( message );
}
@@ -302,7 +310,8 @@
{
if( getLogger().isDebugEnabled() )
{
- final String message = REZ.getString( "url-deploy-types.notice", descriptor.getUrl() );
+ final String message =
+ REZ.getString( "url-deploy-types.notice", descriptor.getUrl() );
getLogger().debug( message );
}
@@ -332,7 +341,8 @@
{
if( getLogger().isDebugEnabled() )
{
- final String message = REZ.getString( "url-deploy-services.notice", descriptor.getUrl() );
+ final String message =
+ REZ.getString( "url-deploy-services.notice", descriptor.getUrl() );
getLogger().debug( message );
}
1.2 +3 -2 jakarta-ant/proposal/myrmidon/src/java/org/apache/myrmidon/components/deployer/RoleDescriptor.java
Index: RoleDescriptor.java
===================================================================
RCS file: /home/cvs/jakarta-ant/proposal/myrmidon/src/java/org/apache/myrmidon/components/deployer/RoleDescriptor.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- RoleDescriptor.java 12 Feb 2002 10:40:08 -0000 1.1
+++ RoleDescriptor.java 1 Apr 2002 09:56:26 -0000 1.2
@@ -14,7 +14,7 @@
* A typelib role descriptor, which defines a set of roles.
*
* @author <a href="mailto:adammurdoch@apache.org">Adam Murdoch</a>
- * @version $Revision: 1.1 $ $Date: 2002/02/12 10:40:08 $
+ * @version $Revision: 1.2 $ $Date: 2002/04/01 09:56:26 $
*/
class RoleDescriptor
extends TypelibDescriptor
@@ -31,7 +31,8 @@
*/
public RoleDefinition[] getDefinitions()
{
- return (RoleDefinition[])m_definitions.toArray( new RoleDefinition[ m_definitions.size() ] );
+ return (RoleDefinition[])m_definitions.toArray
+ ( new RoleDefinition[ m_definitions.size() ] );
}
/**
1.4 +3 -2 jakarta-ant/proposal/myrmidon/src/java/org/apache/myrmidon/components/deployer/RoleDescriptorBuilder.java
Index: RoleDescriptorBuilder.java
===================================================================
RCS file: /home/cvs/jakarta-ant/proposal/myrmidon/src/java/org/apache/myrmidon/components/deployer/RoleDescriptorBuilder.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- RoleDescriptorBuilder.java 29 Mar 2002 12:56:03 -0000 1.3
+++ RoleDescriptorBuilder.java 1 Apr 2002 09:56:26 -0000 1.4
@@ -17,7 +17,7 @@
* Builds typelib role descriptors.
*
* @author <a href="mailto:adammurdoch@apache.org">Adam Murdoch</a>
- * @version $Revision: 1.3 $ $Date: 2002/03/29 12:56:03 $
+ * @version $Revision: 1.4 $ $Date: 2002/04/01 09:56:26 $
*/
class RoleDescriptorBuilder
implements DescriptorBuilder
@@ -41,7 +41,8 @@
final Version version = Version.getVersion( versionString );
if( !ROLE_DESCRIPTOR_VERSION.complies( version ) )
{
- final String message = REZ.getString( "role-descriptor-version.error", version, ROLE_DESCRIPTOR_VERSION );
+ final String message = REZ.getString( "role-descriptor-version.error",
+ version, ROLE_DESCRIPTOR_VERSION );
throw new DeploymentException( message );
}
1.2 +3 -2 jakarta-ant/proposal/myrmidon/src/java/org/apache/myrmidon/components/deployer/ServiceDescriptor.java
Index: ServiceDescriptor.java
===================================================================
RCS file: /home/cvs/jakarta-ant/proposal/myrmidon/src/java/org/apache/myrmidon/components/deployer/ServiceDescriptor.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- ServiceDescriptor.java 12 Feb 2002 10:40:08 -0000 1.1
+++ ServiceDescriptor.java 1 Apr 2002 09:56:26 -0000 1.2
@@ -14,7 +14,7 @@
* A typelib service descriptor, which defines a set of services.
*
* @author <a href="mailto:adammurdoch@apache.org">Adam Murdoch</a>
- * @version $Revision: 1.1 $ $Date: 2002/02/12 10:40:08 $
+ * @version $Revision: 1.2 $ $Date: 2002/04/01 09:56:26 $
*/
class ServiceDescriptor
extends TypelibDescriptor
@@ -28,7 +28,8 @@
public ServiceDefinition[] getDefinitions()
{
- return (ServiceDefinition[])m_services.toArray( new ServiceDefinition[ m_services.size() ] );
+ return (ServiceDefinition[])m_services.toArray
+ ( new ServiceDefinition[ m_services.size() ] );
}
public void addDefinition( final ServiceDefinition definition )
1.5 +5 -3 jakarta-ant/proposal/myrmidon/src/java/org/apache/myrmidon/components/deployer/ServiceDescriptorBuilder.java
Index: ServiceDescriptorBuilder.java
===================================================================
RCS file: /home/cvs/jakarta-ant/proposal/myrmidon/src/java/org/apache/myrmidon/components/deployer/ServiceDescriptorBuilder.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- ServiceDescriptorBuilder.java 29 Mar 2002 12:56:03 -0000 1.4
+++ ServiceDescriptorBuilder.java 1 Apr 2002 09:56:26 -0000 1.5
@@ -17,7 +17,7 @@
* Builds typelib service descriptors.
*
* @author <a href="mailto:adammurdoch@apache.org">Adam Murdoch</a>
- * @version $Revision: 1.4 $ $Date: 2002/03/29 12:56:03 $
+ * @version $Revision: 1.5 $ $Date: 2002/04/01 09:56:26 $
*/
class ServiceDescriptorBuilder
implements DescriptorBuilder
@@ -41,7 +41,8 @@
final Version version = Version.getVersion( versionString );
if( !SERVICE_DESCRIPTOR_VERSION.complies( version ) )
{
- final String message = REZ.getString( "service-descriptor-version.error", version, SERVICE_DESCRIPTOR_VERSION );
+ final String message = REZ.getString( "service-descriptor-version.error",
+ version, SERVICE_DESCRIPTOR_VERSION );
throw new DeploymentException( message );
}
@@ -55,7 +56,8 @@
final Configuration element = elements[ i ];
final String roleShorthand = element.getName();
final String factoryClassName = element.getAttribute( "factory" );
- final ServiceDefinition definition = new ServiceDefinition( roleShorthand, factoryClassName, config );
+ final ServiceDefinition definition =
+ new ServiceDefinition( roleShorthand, factoryClassName, config );
descriptor.addDefinition( definition );
}
1.2 +3 -2 jakarta-ant/proposal/myrmidon/src/java/org/apache/myrmidon/components/deployer/TypeDescriptor.java
Index: TypeDescriptor.java
===================================================================
RCS file: /home/cvs/jakarta-ant/proposal/myrmidon/src/java/org/apache/myrmidon/components/deployer/TypeDescriptor.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- TypeDescriptor.java 12 Feb 2002 10:40:08 -0000 1.1
+++ TypeDescriptor.java 1 Apr 2002 09:56:26 -0000 1.2
@@ -15,7 +15,7 @@
* A typelib type descriptor, which defines a set of types.
*
* @author <a href="mailto:adammurdoch@apache.org">Adam Murdoch</a>
- * @version $Revision: 1.1 $ $Date: 2002/02/12 10:40:08 $
+ * @version $Revision: 1.2 $ $Date: 2002/04/01 09:56:26 $
*/
class TypeDescriptor
extends TypelibDescriptor
@@ -29,7 +29,8 @@
public TypeDefinition[] getDefinitions()
{
- return (TypeDefinition[])m_definitions.toArray( new TypeDefinition[ m_definitions.size() ] );
+ return (TypeDefinition[])m_definitions.toArray
+ ( new TypeDefinition[ m_definitions.size() ] );
}
public void addDefinition( final TypeDefinition def )
1.5 +3 -2 jakarta-ant/proposal/myrmidon/src/java/org/apache/myrmidon/components/deployer/TypeDescriptorBuilder.java
Index: TypeDescriptorBuilder.java
===================================================================
RCS file: /home/cvs/jakarta-ant/proposal/myrmidon/src/java/org/apache/myrmidon/components/deployer/TypeDescriptorBuilder.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- TypeDescriptorBuilder.java 29 Mar 2002 12:56:03 -0000 1.4
+++ TypeDescriptorBuilder.java 1 Apr 2002 09:56:26 -0000 1.5
@@ -20,7 +20,7 @@
* Builds typelib type descriptors.
*
* @author <a href="mailto:adammurdoch@apache.org">Adam Murdoch</a>
- * @version $Revision: 1.4 $ $Date: 2002/03/29 12:56:03 $
+ * @version $Revision: 1.5 $ $Date: 2002/04/01 09:56:26 $
*/
class TypeDescriptorBuilder
implements DescriptorBuilder
@@ -44,7 +44,8 @@
final Version version = Version.getVersion( versionString );
if( !TYPE_DESCRIPTOR_VERSION.complies( version ) )
{
- final String message = REZ.getString( "type-descriptor-version.error", version, TYPE_DESCRIPTOR_VERSION );
+ final String message = REZ.getString( "type-descriptor-version.error",
+ version, TYPE_DESCRIPTOR_VERSION );
throw new DeploymentException( message );
}
1.40 +9 -5 jakarta-ant/proposal/myrmidon/src/java/org/apache/myrmidon/components/embeddor/DefaultEmbeddor.java
Index: DefaultEmbeddor.java
===================================================================
RCS file: /home/cvs/jakarta-ant/proposal/myrmidon/src/java/org/apache/myrmidon/components/embeddor/DefaultEmbeddor.java,v
retrieving revision 1.39
retrieving revision 1.40
diff -u -r1.39 -r1.40
--- DefaultEmbeddor.java 29 Mar 2002 12:56:04 -0000 1.39
+++ DefaultEmbeddor.java 1 Apr 2002 09:56:26 -0000 1.40
@@ -52,7 +52,7 @@
* Instantiate this to embed inside other applications.
*
* @author <a href="mailto:peter@apache.org">Peter Donald</a>
- * @version $Revision: 1.39 $ $Date: 2002/03/29 12:56:04 $
+ * @version $Revision: 1.40 $ $Date: 2002/04/01 09:56:26 $
*/
public class DefaultEmbeddor
extends AbstractLogEnabled
@@ -175,7 +175,8 @@
// setup a service manager that creates the project services
final ServiceManager projServiceManager
- = (ServiceManager)createService( ServiceManager.class, PREFIX + "service.InstantiatingServiceManager" );
+ = (ServiceManager)createService( ServiceManager.class,
+ PREFIX + "service.InstantiatingServiceManager" );
setupObject( projServiceManager, m_serviceManager, m_parameters );
// setup a service manager to be used by workspaces
@@ -267,7 +268,8 @@
createComponent( RoleManager.class, PREFIX + "role.DefaultRoleManager" );
createComponent( AspectManager.class, PREFIX + "aspect.DefaultAspectManager" );
createComponent( Deployer.class, PREFIX + "deployer.DefaultDeployer" );
- createComponent( ClassLoaderManager.class, PREFIX + "classloader.DefaultClassLoaderManager" );
+ createComponent( ClassLoaderManager.class,
+ PREFIX + "classloader.DefaultClassLoaderManager" );
createComponent( Executor.class, PREFIX + "executor.AspectAwareExecutor" );
createComponent( PropertyResolver.class, PREFIX + "property.DefaultPropertyResolver" );
@@ -388,7 +390,8 @@
if( !roleType.isInstance( object ) )
{
- final String message = REZ.getString( "bad-type.error", className, roleType.getName() );
+ final String message = REZ.getString( "bad-type.error",
+ className, roleType.getName() );
throw new Exception( message );
}
@@ -396,7 +399,8 @@
}
catch( final IllegalAccessException iae )
{
- final String message = REZ.getString( "bad-ctor.error", roleType.getName(), className );
+ final String message = REZ.getString( "bad-ctor.error",
+ roleType.getName(), className );
throw new Exception( message );
}
catch( final InstantiationException ie )
1.34 +3 -2 jakarta-ant/proposal/myrmidon/src/java/org/apache/myrmidon/components/executor/DefaultExecutor.java
Index: DefaultExecutor.java
===================================================================
RCS file: /home/cvs/jakarta-ant/proposal/myrmidon/src/java/org/apache/myrmidon/components/executor/DefaultExecutor.java,v
retrieving revision 1.33
retrieving revision 1.34
diff -u -r1.33 -r1.34
--- DefaultExecutor.java 29 Mar 2002 12:56:03 -0000 1.33
+++ DefaultExecutor.java 1 Apr 2002 09:56:26 -0000 1.34
@@ -28,7 +28,7 @@
* The basic executor that just executes the tasks.
*
* @author <a href="mailto:peter@apache.org">Peter Donald</a>
- * @version $Revision: 1.33 $ $Date: 2002/03/29 12:56:03 $
+ * @version $Revision: 1.34 $ $Date: 2002/04/01 09:56:26 $
*/
public class DefaultExecutor
extends AbstractLogEnabled
@@ -75,7 +75,8 @@
catch( Exception e )
{
// Wrap in generic error message
- final String message = REZ.getString( "execute.error", taskName, taskModel.getLocation() );
+ final String message = REZ.getString( "execute.error",
+ taskName, taskModel.getLocation() );
throw new TaskException( message, e );
}
}
1.4 +3 -2 jakarta-ant/proposal/myrmidon/src/java/org/apache/myrmidon/components/service/InstantiatingServiceManager.java
Index: InstantiatingServiceManager.java
===================================================================
RCS file: /home/cvs/jakarta-ant/proposal/myrmidon/src/java/org/apache/myrmidon/components/service/InstantiatingServiceManager.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- InstantiatingServiceManager.java 29 Mar 2002 12:56:04 -0000 1.3
+++ InstantiatingServiceManager.java 1 Apr 2002 09:56:26 -0000 1.4
@@ -43,7 +43,7 @@
* </ul>
*
* @author <a href="mailto:adammurdoch@apache.org">Adam Murdoch</a>
- * @version $Revision: 1.3 $ $Date: 2002/03/29 12:56:04 $
+ * @version $Revision: 1.4 $ $Date: 2002/04/01 09:56:26 $
*/
public class InstantiatingServiceManager
extends AbstractLogEnabled
@@ -188,7 +188,8 @@
final Class serviceType = roleInfo.getType();
if( serviceType != null && !serviceType.isInstance( service ) )
{
- final String message = REZ.getString( "mismatched-service-type.error", serviceRole, service.getClass().getName() );
+ final String message = REZ.getString( "mismatched-service-type.error",
+ serviceRole, service.getClass().getName() );
throw new ServiceException( message );
}
1.16 +3 -2 jakarta-ant/proposal/myrmidon/src/java/org/apache/myrmidon/components/type/MultiSourceTypeFactory.java
Index: MultiSourceTypeFactory.java
===================================================================
RCS file: /home/cvs/jakarta-ant/proposal/myrmidon/src/java/org/apache/myrmidon/components/type/MultiSourceTypeFactory.java,v
retrieving revision 1.15
retrieving revision 1.16
diff -u -r1.15 -r1.16
--- MultiSourceTypeFactory.java 29 Mar 2002 12:56:04 -0000 1.15
+++ MultiSourceTypeFactory.java 1 Apr 2002 09:56:26 -0000 1.16
@@ -17,7 +17,7 @@
* This factory acts as a proxy to set of object factories.
*
* @author <a href="mailto:peter@apache.org">Peter Donald</a>
- * @version $Revision: 1.15 $ $Date: 2002/03/29 12:56:04 $
+ * @version $Revision: 1.16 $ $Date: 2002/04/01 09:56:26 $
*/
public class MultiSourceTypeFactory
implements TypeFactory
@@ -84,7 +84,8 @@
final Object object = factory.create( name );
if( m_type != null && !m_type.isInstance( object ) )
{
- final String message = REZ.getString( "mismatched-type.error", name, object.getClass().getName() );
+ final String message = REZ.getString( "mismatched-type.error",
+ name, object.getClass().getName() );
throw new TypeException( message );
}
1.37 +5 -3 jakarta-ant/proposal/myrmidon/src/java/org/apache/myrmidon/components/workspace/DefaultWorkspace.java
Index: DefaultWorkspace.java
===================================================================
RCS file: /home/cvs/jakarta-ant/proposal/myrmidon/src/java/org/apache/myrmidon/components/workspace/DefaultWorkspace.java,v
retrieving revision 1.36
retrieving revision 1.37
diff -u -r1.36 -r1.37
--- DefaultWorkspace.java 29 Mar 2002 12:56:04 -0000 1.36
+++ DefaultWorkspace.java 1 Apr 2002 09:56:26 -0000 1.37
@@ -43,7 +43,7 @@
* This is the default implementation of Workspace.
*
* @author <a href="mailto:peter@apache.org">Peter Donald</a>
- * @version $Revision: 1.36 $ $Date: 2002/03/29 12:56:04 $
+ * @version $Revision: 1.37 $ $Date: 2002/04/01 09:56:26 $
*/
public class DefaultWorkspace
extends AbstractLogEnabled
@@ -203,7 +203,8 @@
}
catch( final DeploymentException de )
{
- final String message = REZ.getString( "no-deploy.error", typeLib.getLibrary(), file );
+ final String message = REZ.getString( "no-deploy.error",
+ typeLib.getLibrary(), file );
throw new TaskException( message, de );
}
}
@@ -416,7 +417,8 @@
if( getLogger().isDebugEnabled() )
{
- final String message = REZ.getString( "exec-target.notice", project.getProjectName(), name );
+ final String message = REZ.getString( "exec-target.notice",
+ project.getProjectName(), name );
getLogger().debug( message );
}
1.9 +24 -1 jakarta-ant/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/aspect/AspectManager.java
Index: AspectManager.java
===================================================================
RCS file: /home/cvs/jakarta-ant/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/aspect/AspectManager.java,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- AspectManager.java 16 Mar 2002 04:08:06 -0000 1.8
+++ AspectManager.java 1 Apr 2002 09:56:26 -0000 1.9
@@ -16,21 +16,44 @@
* Manage and propogate Aspects..
*
* @author <a href="mailto:peter@apache.org">Peter Donald</a>
- * @version $Revision: 1.8 $ $Date: 2002/03/16 04:08:06 $
+ * @version $Revision: 1.9 $ $Date: 2002/04/01 09:56:26 $
*/
public interface AspectManager
extends AspectHandler
{
+ /** Role name for this interface. */
String ROLE = AspectManager.class.getName();
+ /**
+ * @return The names of all AspectHandlers managed.
+ */
String[] getNames();
+ /**
+ * Dispatches aspect settings to the named AspectHandler.
+ * @param name The name of the AspectHandler to recieve the settings.
+ * @param parameters The parameter settings.
+ * @param elements The nested Configuration settings.
+ * @throws TaskException if the named AspectHandler doesn't exist,
+ * or it cannot handle the settings.
+ */
void dispatchAspectSettings( String name, Parameters parameters, Configuration[] elements )
throws TaskException;
+ /**
+ * Adds a named aspect handler to the manager.
+ * @param name The name used to lookup the aspect handler.
+ * @param handler The aspect handler to add.
+ * @throws TaskException If an error occurs.
+ */
void addAspectHandler( String name, AspectHandler handler )
throws TaskException;
+ /**
+ * Removes a named aspect handler from the manager.
+ * @param name The name of the handler to remove.
+ * @throws TaskException If the named handler doesn't exist.
+ */
void removeAspectHandler( String name )
throws TaskException;
}
1.11 +2 -1 jakarta-ant/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/builder/ProjectBuilder.java
Index: ProjectBuilder.java
===================================================================
RCS file: /home/cvs/jakarta-ant/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/builder/ProjectBuilder.java,v
retrieving revision 1.10
retrieving revision 1.11
diff -u -r1.10 -r1.11
--- ProjectBuilder.java 13 Mar 2002 07:35:19 -0000 1.10
+++ ProjectBuilder.java 1 Apr 2002 09:56:26 -0000 1.11
@@ -13,11 +13,12 @@
* Interface implemented by components that build projects from sources.
*
* @author <a href="mailto:peter@apache.org">Peter Donald</a>
- * @version $Revision: 1.10 $ $Date: 2002/03/13 07:35:19 $
+ * @version $Revision: 1.11 $ $Date: 2002/04/01 09:56:26 $
* @ant:role shorthand="project-builder"
*/
public interface ProjectBuilder
{
+ /** Role name for this interface. */
String ROLE = ProjectBuilder.class.getName();
/**
1.3 +8 -1 jakarta-ant/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/classloader/ClassLoaderManager.java
Index: ClassLoaderManager.java
===================================================================
RCS file: /home/cvs/jakarta-ant/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/classloader/ClassLoaderManager.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- ClassLoaderManager.java 27 Mar 2002 07:04:17 -0000 1.2
+++ ClassLoaderManager.java 1 Apr 2002 09:56:26 -0000 1.3
@@ -16,10 +16,14 @@
*/
public interface ClassLoaderManager
{
+ /** Role name for this interface. */
String ROLE = ClassLoaderManager.class.getName();
/**
* Builds the ClassLoader for a Jar file, resolving dependencies.
+ * @param jar the jar file containing the classes to load
+ * @return the created classloader
+ * @throws ClassLoaderException on error
*/
ClassLoader createClassLoader( File jar ) throws ClassLoaderException;
@@ -28,12 +32,15 @@
*
* @param jars The Jar/zip files to create the classloader for. Use null
* or an empty array to use the common classloader.
+ * @return the created ClassLoader
+ * @throws ClassLoaderException on error
*/
ClassLoader createClassLoader( File[] jars ) throws ClassLoaderException;
/**
- * Returns the common ClassLoader. This is the parent of all classloaders
+ * Provides the common ClassLoader, which is the parent of all classloaders
* built by this ClassLoaderManager.
+ * @return the common ClassLoader
*/
ClassLoader getCommonClassLoader();
}
1.12 +2 -1 jakarta-ant/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/configurer/Configurer.java
Index: Configurer.java
===================================================================
RCS file: /home/cvs/jakarta-ant/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/configurer/Configurer.java,v
retrieving revision 1.11
retrieving revision 1.12
diff -u -r1.11 -r1.12
--- Configurer.java 12 Mar 2002 11:14:44 -0000 1.11
+++ Configurer.java 1 Apr 2002 09:56:26 -0000 1.12
@@ -15,11 +15,12 @@
* Class used to configure tasks.
*
* @author <a href="mailto:peter@apache.org">Peter Donald</a>
- * @version $Revision: 1.11 $ $Date: 2002/03/12 11:14:44 $
+ * @version $Revision: 1.12 $ $Date: 2002/04/01 09:56:26 $
* @ant:role shorthand="configurer"
*/
public interface Configurer
{
+ /** Role name for this interface. */
String ROLE = Configurer.class.getName();
/**
1.8 +2 -1 jakarta-ant/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/converter/ConverterRegistry.java
Index: ConverterRegistry.java
===================================================================
RCS file: /home/cvs/jakarta-ant/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/converter/ConverterRegistry.java,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- ConverterRegistry.java 23 Mar 2002 04:37:16 -0000 1.7
+++ ConverterRegistry.java 1 Apr 2002 09:56:27 -0000 1.8
@@ -11,10 +11,11 @@
* Interface for registry for ConverterInfos.
*
* @author <a href="mailto:peter@apache.org">Peter Donald</a>
- * @version $Revision: 1.7 $ $Date: 2002/03/23 04:37:16 $
+ * @version $Revision: 1.8 $ $Date: 2002/04/01 09:56:27 $
*/
public interface ConverterRegistry
{
+ /** Role name for this interface. */
String ROLE = ConverterRegistry.class.getName();
/**
1.4 +12 -4 jakarta-ant/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/deployer/ConverterDefinition.java
Index: ConverterDefinition.java
===================================================================
RCS file: /home/cvs/jakarta-ant/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/deployer/ConverterDefinition.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- ConverterDefinition.java 7 Feb 2002 13:01:20 -0000 1.3
+++ ConverterDefinition.java 1 Apr 2002 09:56:27 -0000 1.4
@@ -8,10 +8,10 @@
package org.apache.myrmidon.interfaces.deployer;
/**
- * A converter definition.
+ * A specialised TypeDefinition which defines a converter.
*
* @author <a href="mailto:adammurdoch@apache.org">Adam Murdoch</a>
- * @version $Revision: 1.3 $ $Date: 2002/02/07 13:01:20 $
+ * @version $Revision: 1.4 $ $Date: 2002/04/01 09:56:27 $
*/
public class ConverterDefinition
extends TypeDefinition
@@ -19,6 +19,12 @@
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 @@
}
/**
- * 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 @@
}
/**
- * 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()
{
1.8 +8 -2 jakarta-ant/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/deployer/Deployer.java
Index: Deployer.java
===================================================================
RCS file: /home/cvs/jakarta-ant/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/deployer/Deployer.java,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- Deployer.java 21 Feb 2002 11:06:41 -0000 1.7
+++ Deployer.java 1 Apr 2002 09:56:27 -0000 1.8
@@ -15,10 +15,11 @@
* This class deploys type libraries into a registry.
*
* @author <a href="mailto:peter@apache.org">Peter Donald</a>
- * @version $Revision: 1.7 $ $Date: 2002/02/21 11:06:41 $
+ * @version $Revision: 1.8 $ $Date: 2002/04/01 09:56:27 $
*/
public interface Deployer
{
+ /** Role name for this interface. */
String ROLE = Deployer.class.getName();
/**
@@ -26,6 +27,7 @@
* 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 @@
* 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;
1.4 +10 -4 jakarta-ant/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/deployer/TypeDefinition.java
Index: TypeDefinition.java
===================================================================
RCS file: /home/cvs/jakarta-ant/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/deployer/TypeDefinition.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- TypeDefinition.java 7 Feb 2002 13:01:20 -0000 1.3
+++ TypeDefinition.java 1 Apr 2002 09:56:27 -0000 1.4
@@ -11,7 +11,7 @@
* A general-purpose type definition.
*
* @author <a href="mailto:adammurdoch@apache.org">Adam Murdoch</a>
- * @version $Revision: 1.3 $ $Date: 2002/02/07 13:01:20 $
+ * @version $Revision: 1.4 $ $Date: 2002/04/01 09:56:27 $
*/
public class TypeDefinition
{
@@ -19,6 +19,12 @@
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 @@
}
/**
- * Returns the type's implementation class name.
+ * @return the type's implementation class name.
*/
public final String getClassname()
{
@@ -37,7 +43,7 @@
}
/**
- * Returns the type's role.
+ * @return the type's role.
*/
public final String getRole()
{
@@ -45,7 +51,7 @@
}
/**
- * Returns the type's name.
+ * @return the type's name.
*/
public String getName()
{
1.4 +6 -1 jakarta-ant/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/deployer/TypeDeployer.java
Index: TypeDeployer.java
===================================================================
RCS file: /home/cvs/jakarta-ant/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/deployer/TypeDeployer.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- TypeDeployer.java 7 Feb 2002 13:01:20 -0000 1.3
+++ TypeDeployer.java 1 Apr 2002 09:56:27 -0000 1.4
@@ -12,12 +12,14 @@
* library to be deployed.
*
* @author <a href="mailto:adammurdoch@apache.org">Adam Murdoch</a>
- * @version $Revision: 1.3 $ $Date: 2002/02/07 13:01:20 $
+ * @version $Revision: 1.4 $ $Date: 2002/04/01 09:56:27 $
*/
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 @@
*
* @param typeDef
* The type definition.
+ *
+ * @throws DeploymentException
+ * If the type cannot be deployed.
*/
void deployType( TypeDefinition typeDef )
throws DeploymentException;
1.11 +6 -1 jakarta-ant/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/embeddor/Embeddor.java
Index: Embeddor.java
===================================================================
RCS file: /home/cvs/jakarta-ant/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/embeddor/Embeddor.java,v
retrieving revision 1.10
retrieving revision 1.11
diff -u -r1.10 -r1.11
--- Embeddor.java 23 Mar 2002 23:41:27 -0000 1.10
+++ Embeddor.java 1 Apr 2002 09:56:27 -0000 1.11
@@ -16,10 +16,11 @@
* Interface through which you embed Myrmidon into applications.
*
* @author <a href="mailto:peter@apache.org">Peter Donald</a>
- * @version $Revision: 1.10 $ $Date: 2002/03/23 23:41:27 $
+ * @version $Revision: 1.11 $ $Date: 2002/04/01 09:56:27 $
*/
public interface Embeddor
{
+ /** Role name for this interface. */
String ROLE = Embeddor.class.getName();
/**
@@ -30,6 +31,8 @@
* 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 @@
*
* @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 @@
*
* @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;
1.10 +11 -1 jakarta-ant/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/executor/ExecutionFrame.java
Index: ExecutionFrame.java
===================================================================
RCS file: /home/cvs/jakarta-ant/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/executor/ExecutionFrame.java,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -r1.9 -r1.10
--- ExecutionFrame.java 7 Feb 2002 13:01:20 -0000 1.9
+++ ExecutionFrame.java 1 Apr 2002 09:56:27 -0000 1.10
@@ -15,15 +15,25 @@
* Frames in which tasks are executed.
*
* @author <a href="mailto:peter@apache.org">Peter Donald</a>
- * @version $Revision: 1.9 $ $Date: 2002/02/07 13:01:20 $
+ * @version $Revision: 1.10 $ $Date: 2002/04/01 09:56:27 $
*/
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();
}
1.8 +3 -1 jakarta-ant/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/executor/Executor.java
Index: Executor.java
===================================================================
RCS file: /home/cvs/jakarta-ant/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/executor/Executor.java,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- Executor.java 21 Feb 2002 11:06:41 -0000 1.7
+++ Executor.java 1 Apr 2002 09:56:27 -0000 1.8
@@ -14,16 +14,18 @@
* Engine inteface that should be implemented by all tasklet engines.
*
* @author <a href="mailto:peter@apache.org">Peter Donald</a>
- * @version $Revision: 1.7 $ $Date: 2002/02/21 11:06:41 $
+ * @version $Revision: 1.8 $ $Date: 2002/04/01 09:56:27 $
*/
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 )
1.6 +2 -1 jakarta-ant/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/extensions/ExtensionManager.java
Index: ExtensionManager.java
===================================================================
RCS file: /home/cvs/jakarta-ant/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/extensions/ExtensionManager.java,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- ExtensionManager.java 21 Feb 2002 11:06:41 -0000 1.5
+++ ExtensionManager.java 1 Apr 2002 09:56:27 -0000 1.6
@@ -13,10 +13,11 @@
* PackageRepository
*
* @author <a href="mailto:peter@apache.org">Peter Donald</a>
- * @version $Revision: 1.5 $ $Date: 2002/02/21 11:06:41 $
+ * @version $Revision: 1.6 $ $Date: 2002/04/01 09:56:27 $
*/
public interface ExtensionManager
extends PackageRepository
{
+ /** Role name for this interface. */
String ROLE = ExtensionManager.class.getName();
}
1.3 +3 -3 jakarta-ant/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/model/DefaultNameValidator.java
Index: DefaultNameValidator.java
===================================================================
RCS file: /home/cvs/jakarta-ant/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/model/DefaultNameValidator.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- DefaultNameValidator.java 29 Mar 2002 12:56:04 -0000 1.2
+++ DefaultNameValidator.java 1 Apr 2002 09:56:27 -0000 1.3
@@ -15,7 +15,7 @@
* in ant projects.
*
* @author <a href="mailto:darrell@apache.org">Darrell DeBoer</a>
- * @version $Revision: 1.2 $ $Date: 2002/03/29 12:56:04 $
+ * @version $Revision: 1.3 $ $Date: 2002/04/01 09:56:27 $
*/
public class DefaultNameValidator
implements NameValidator
@@ -82,6 +82,7 @@
* 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 @@
}
/**
- * 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
{
1.2 +11 -1 jakarta-ant/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/model/Dependency.java
Index: Dependency.java
===================================================================
RCS file: /home/cvs/jakarta-ant/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/model/Dependency.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- Dependency.java 13 Mar 2002 07:35:19 -0000 1.1
+++ Dependency.java 1 Apr 2002 09:56:27 -0000 1.2
@@ -11,24 +11,34 @@
* A dependency for a target.
*
* @author <a href="mailto:adammurdoch@apache.org">Adam Murdoch</a>
- * @version $Revision: 1.1 $ $Date: 2002/03/13 07:35:19 $
+ * @version $Revision: 1.2 $ $Date: 2002/04/01 09:56: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;
1.2 +2 -1 jakarta-ant/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/model/NameValidator.java
Index: NameValidator.java
===================================================================
RCS file: /home/cvs/jakarta-ant/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/model/NameValidator.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- NameValidator.java 11 Mar 2002 06:07:24 -0000 1.1
+++ NameValidator.java 1 Apr 2002 09:56:27 -0000 1.2
@@ -11,12 +11,13 @@
* Determines the validity of names used in projects.
*
* @author <a href="mailto:darrell@apache.org">Darrell DeBoer</a>
- * @version $Revision: 1.1 $ $Date: 2002/03/11 06:07:24 $
+ * @version $Revision: 1.2 $ $Date: 2002/04/01 09:56:27 $
*/
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;
1.9 +4 -3 jakarta-ant/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/model/Project.java
Index: Project.java
===================================================================
RCS file: /home/cvs/jakarta-ant/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/model/Project.java,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- Project.java 21 Feb 2002 11:06:42 -0000 1.8
+++ Project.java 1 Apr 2002 09:56:27 -0000 1.9
@@ -14,13 +14,14 @@
* Implementations may choose to structure it anyway they choose.
*
* @author <a href="mailto:peter@apache.org">Peter Donald</a>
- * @version $Revision: 1.8 $ $Date: 2002/02/21 11:06:42 $
+ * @version $Revision: 1.9 $ $Date: 2002/04/01 09:56:27 $
*/
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 @@
//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).
1.8 +3 -1 jakarta-ant/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/model/Target.java
Index: Target.java
===================================================================
RCS file: /home/cvs/jakarta-ant/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/model/Target.java,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- Target.java 13 Mar 2002 07:35:19 -0000 1.7
+++ Target.java 1 Apr 2002 09:56:27 -0000 1.8
@@ -14,7 +14,7 @@
* Targets in build file.
*
* @author <a href="mailto:peter@apache.org">Peter Donald</a>
- * @version $Revision: 1.7 $ $Date: 2002/03/13 07:35:19 $
+ * @version $Revision: 1.8 $ $Date: 2002/04/01 09:56:27 $
*/
public class Target
{
@@ -23,6 +23,8 @@
/**
* 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 )
1.6 +11 -1 jakarta-ant/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/model/TypeLib.java
Index: TypeLib.java
===================================================================
RCS file: /home/cvs/jakarta-ant/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/model/TypeLib.java,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- TypeLib.java 7 Feb 2002 13:01:20 -0000 1.5
+++ TypeLib.java 1 Apr 2002 09:56:27 -0000 1.6
@@ -11,7 +11,7 @@
* Imports in a build file.
*
* @author <a href="mailto:peter@apache.org">Peter Donald</a>
- * @version $Revision: 1.5 $ $Date: 2002/02/07 13:01:20 $
+ * @version $Revision: 1.6 $ $Date: 2002/04/01 09:56:27 $
*/
public class TypeLib
{
@@ -27,11 +27,21 @@
//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;
1.5 +2 -1 jakarta-ant/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/property/PropertyResolver.java
Index: PropertyResolver.java
===================================================================
RCS file: /home/cvs/jakarta-ant/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/property/PropertyResolver.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- PropertyResolver.java 24 Mar 2002 07:53:54 -0000 1.4
+++ PropertyResolver.java 1 Apr 2002 09:56:27 -0000 1.5
@@ -16,12 +16,13 @@
* String content.
*
* @author <a href="mailto:darrell@apache.org">Darrell DeBoer</a>
- * @version $Revision: 1.4 $ $Date: 2002/03/24 07:53:54 $
+ * @version $Revision: 1.5 $ $Date: 2002/04/01 09:56:27 $
*
* @ant:role shorthand="property-resolver"
*/
public interface PropertyResolver
{
+ /** Role name for this interface. */
String ROLE = PropertyResolver.class.getName();
/**
1.4 +18 -9 jakarta-ant/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/role/RoleInfo.java
Index: RoleInfo.java
===================================================================
RCS file: /home/cvs/jakarta-ant/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/role/RoleInfo.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- RoleInfo.java 1 Mar 2002 08:54:20 -0000 1.3
+++ RoleInfo.java 1 Apr 2002 09:56:27 -0000 1.4
@@ -11,7 +11,7 @@
* A role definition. Role definitions are immutable.
*
* @author <a href="mailto:adammurdoch@apache.org">Adam Murdoch</a>
- * @version $Revision: 1.3 $ $Date: 2002/03/01 08:54:20 $
+ * @version $Revision: 1.4 $ $Date: 2002/04/01 09:56:27 $
*/
public final class RoleInfo
{
@@ -23,7 +23,9 @@
/**
* Creates a role definition.
*
- * @param name The role name.
+ *
+ * Same as calling <code>RoleInfo( name, null, null, null )</code>
+ * @see #RoleInfo( String, String, Class, String )
*/
public RoleInfo( final String name )
{
@@ -33,8 +35,8 @@
/**
* Creates a role definition.
*
- * @param name The role name.
- * @param shorthand The role shorthand name.
+ * Same as calling <code>RoleInfo( name, shorthand, null, null )</code>
+ * @see #RoleInfo( String, String, Class, String )
*/
public RoleInfo( final String name, final String shorthand )
{
@@ -43,10 +45,8 @@
/**
* 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 <code>RoleInfo( name, shorthand, type, null )</code>
+ * @see #RoleInfo( String, String, Class, String )
*/
public RoleInfo( final String name, final String shorthand, final Class type )
{
@@ -56,6 +56,8 @@
/**
* 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 @@
/**
* 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 @@
/**
* Compares a role to this role.
+ * @param role The RoleInfo to compare.
+ * @return <code>true</code> if the supplied role is equal to this one.
*/
public boolean equals( final RoleInfo role )
{
@@ -105,7 +113,8 @@
}
/**
- * 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()
{
1.9 +4 -1 jakarta-ant/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/role/RoleManager.java
Index: RoleManager.java
===================================================================
RCS file: /home/cvs/jakarta-ant/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/role/RoleManager.java,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- RoleManager.java 21 Feb 2002 12:52:07 -0000 1.8
+++ RoleManager.java 1 Apr 2002 09:56:27 -0000 1.9
@@ -15,10 +15,11 @@
* @author <a href="mailto:giacomo@apache,org">Giacomo Pati</a>
* @author <a href="mailto:peter@apache.org">Peter Donald</a>
* @author <a href="mailto:adammurdoch@apache.org">Adam Murdoch</a>
- * @version CVS $Revision: 1.8 $ $Date: 2002/02/21 12:52:07 $
+ * @version CVS $Revision: 1.9 $ $Date: 2002/04/01 09:56:27 $
*/
public interface RoleManager
{
+ /** Role name for this interface. */
String ROLE = RoleManager.class.getName();
/**
@@ -47,6 +48,8 @@
/**
* 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;
}
1.6 +6 -1 jakarta-ant/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/service/MultiSourceServiceManager.java
Index: MultiSourceServiceManager.java
===================================================================
RCS file: /home/cvs/jakarta-ant/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/service/MultiSourceServiceManager.java,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- MultiSourceServiceManager.java 29 Mar 2002 12:56:05 -0000 1.5
+++ MultiSourceServiceManager.java 1 Apr 2002 09:56:27 -0000 1.6
@@ -18,7 +18,7 @@
* {@link ServiceManager} objects.
*
* @author <a href="mailto:adammurdoch@apache.org">Adam Murdoch</a>
- * @version $Revision: 1.5 $ $Date: 2002/03/29 12:56:05 $
+ * @version $Revision: 1.6 $ $Date: 2002/04/01 09:56:27 $
*/
public class MultiSourceServiceManager
implements ServiceManager
@@ -31,6 +31,7 @@
/**
* 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 @@
/**
* Determines if this service manager contains a particular service.
+ * @param serviceRole The name of the service to check for.
+ * @return <code>true</code> if this service manager contains
+ * the named service.
*/
public boolean hasService( final String serviceRole )
{
@@ -81,6 +85,7 @@
/**
* Releases a service.
+ * @param service The service to release.
*/
public void release( final Object service )
{
1.5 +4 -1 jakarta-ant/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/service/ServiceFactory.java
Index: ServiceFactory.java
===================================================================
RCS file: /home/cvs/jakarta-ant/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/service/ServiceFactory.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- ServiceFactory.java 15 Mar 2002 02:48:21 -0000 1.4
+++ ServiceFactory.java 1 Apr 2002 09:56:27 -0000 1.5
@@ -13,18 +13,21 @@
* preparing the service for use.
*
* @author <a href="mailto:peter@apache.org">Peter Donald</a>
- * @version $Revision: 1.4 $ $Date: 2002/03/15 02:48:21 $
+ * @version $Revision: 1.5 $ $Date: 2002/04/01 09:56:27 $
*
* @ant:role shorthand="service-factory"
*/
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;
1.12 +9 -7 jakarta-ant/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/type/DefaultTypeFactory.java
Index: DefaultTypeFactory.java
===================================================================
RCS file: /home/cvs/jakarta-ant/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/type/DefaultTypeFactory.java,v
retrieving revision 1.11
retrieving revision 1.12
diff -u -r1.11 -r1.12
--- DefaultTypeFactory.java 29 Mar 2002 12:56:04 -0000 1.11
+++ DefaultTypeFactory.java 1 Apr 2002 09:56:27 -0000 1.12
@@ -15,7 +15,7 @@
* Create a type instance based on name.
*
* @author <a href="mailto:peter@apache.org">Peter Donald</a>
- * @version CVS $Revision: 1.11 $ $Date: 2002/03/29 12:56:04 $
+ * @version CVS $Revision: 1.12 $ $Date: 2002/04/01 09:56:27 $
*/
public class DefaultTypeFactory
implements TypeFactory
@@ -32,6 +32,7 @@
/**
* 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 @@
/**
* 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 @@
}
/**
- * Determines if this factory can create instances of a particular type.
+ * @see TypeFactory#canCreate
*/
public boolean canCreate( String name )
{
@@ -67,11 +70,7 @@
}
/**
- * 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 @@
return (String)m_classNames.get( name );
}
+ /**
+ * @return The ClassLoader to use for loading types.
+ */
protected ClassLoader getClassLoader()
{
return m_classLoader;
1.3 +8 -1 jakarta-ant/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/type/ReloadingTypeFactory.java
Index: ReloadingTypeFactory.java
===================================================================
RCS file: /home/cvs/jakarta-ant/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/type/ReloadingTypeFactory.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- ReloadingTypeFactory.java 17 Mar 2002 08:09:47 -0000 1.2
+++ ReloadingTypeFactory.java 1 Apr 2002 09:56:27 -0000 1.3
@@ -18,7 +18,7 @@
* libraries.
*
* @author <a href="mailto:peter@apache.org">Peter Donald</a>
- * @version CVS $Revision: 1.2 $ $Date: 2002/03/17 08:09:47 $
+ * @version CVS $Revision: 1.3 $ $Date: 2002/04/01 09:56:27 $
*/
public class ReloadingTypeFactory
extends DefaultTypeFactory
@@ -35,6 +35,10 @@
* 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 @@
m_parent = parent;
}
+ /**
+ * @see DefaultTypeFactory
+ */
protected ClassLoader getClassLoader()
{
return new URLClassLoader( m_urls, m_parent );
1.5 +2 -1 jakarta-ant/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/type/TypeFactory.java
Index: TypeFactory.java
===================================================================
RCS file: /home/cvs/jakarta-ant/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/type/TypeFactory.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- TypeFactory.java 14 Feb 2002 02:00:07 -0000 1.4
+++ TypeFactory.java 1 Apr 2002 09:56:28 -0000 1.5
@@ -11,7 +11,7 @@
* Create an instance on name.
*
* @author <a href="mailto:peter@apache.org">Peter Donald</a>
- * @version CVS $Revision: 1.4 $ $Date: 2002/02/14 02:00:07 $
+ * @version CVS $Revision: 1.5 $ $Date: 2002/04/01 09:56:28 $
*/
public interface TypeFactory
{
@@ -19,6 +19,7 @@
* Determines if this factory can create instances of a particular type.
*
* @param name the type name.
+ * @return <code>true</code> if this is a valid factory for the named type.
*/
boolean canCreate( String name );
1.10 +6 -1 jakarta-ant/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/type/TypeManager.java
Index: TypeManager.java
===================================================================
RCS file: /home/cvs/jakarta-ant/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/type/TypeManager.java,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -r1.9 -r1.10
--- TypeManager.java 15 Mar 2002 02:48:21 -0000 1.9
+++ TypeManager.java 1 Apr 2002 09:56:28 -0000 1.10
@@ -11,10 +11,11 @@
* The interface that is used to manage types.
*
* @author <a href="mailto:peter@apache.org">Peter Donald</a>
- * @version $Revision: 1.9 $ $Date: 2002/03/15 02:48:21 $
+ * @version $Revision: 1.10 $ $Date: 2002/04/01 09:56:28 $
*/
public interface TypeManager
{
+ /** Role name for this interface. */
String ROLE = TypeManager.class.getName();
/**
@@ -23,6 +24,7 @@
* @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 @@
* 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 @@
* 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();
}
1.9 +2 -1 jakarta-ant/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/workspace/Workspace.java
Index: Workspace.java
===================================================================
RCS file: /home/cvs/jakarta-ant/proposal/myrmidon/src/java/org/apache/myrmidon/interfaces/workspace/Workspace.java,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- Workspace.java 21 Feb 2002 11:06:42 -0000 1.8
+++ Workspace.java 1 Apr 2002 09:56:28 -0000 1.9
@@ -15,10 +15,11 @@
* This is the abstraction through which Projects are managed and executed.
*
* @author <a href="mailto:peter@apache.org">Peter Donald</a>
- * @version $Revision: 1.8 $ $Date: 2002/02/21 11:06:42 $
+ * @version $Revision: 1.9 $ $Date: 2002/04/01 09:56:28 $
*/
public interface Workspace
{
+ /** Role name for this interface. */
String ROLE = Workspace.class.getName();
/**
--
To unsubscribe, e-mail: <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>