tuscany-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From jboy...@apache.org
Subject svn commit: r380937 - /incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/
Date Sat, 25 Feb 2006 15:38:27 GMT
Author: jboynes
Date: Sat Feb 25 07:38:24 2006
New Revision: 380937

URL: http://svn.apache.org/viewcvs?rev=380937&view=rev
Log:
add more javadoc to the logical model

Modified:
    incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/Aggregate.java
    incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/AggregatePart.java
    incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/AssemblyModelContext.java
    incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/AssemblyModelObject.java
    incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/AssemblyModelVisitor.java
    incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/Binding.java
    incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/Component.java
    incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/ComponentImplementation.java
    incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/ComponentType.java
    incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/ConfiguredPort.java
    incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/ConfiguredProperty.java
    incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/ConfiguredReference.java
    incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/ConfiguredService.java
    incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/EntryPoint.java
    incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/Extensible.java
    incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/ExternalService.java
    incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/ModelInitException.java
    incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/Module.java
    incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/ModuleComponent.java
    incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/ModuleFragment.java
    incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/Multiplicity.java
    incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/OverrideOption.java
    incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/Port.java
    incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/Property.java
    incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/Reference.java
    incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/RuntimeConfigurationHolder.java
    incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/Scope.java
    incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/Service.java
    incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/ServiceContract.java
    incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/SimpleComponent.java
    incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/Wire.java

Modified: incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/Aggregate.java
URL: http://svn.apache.org/viewcvs/incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/Aggregate.java?rev=380937&r1=380936&r2=380937&view=diff
==============================================================================
--- incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/Aggregate.java (original)
+++ incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/Aggregate.java Sat Feb 25 07:38:24 2006
@@ -21,25 +21,31 @@
 import javax.wsdl.Import;
 
 /**
- * Represents an aggregate. An aggregate contains AggregateParts (e.g. components, entry points
- * and external services).
+ * A model object that describes a container for other module objects, which must be {@link AggregatePart}s.
  */
 public interface Aggregate extends Extensible {
 
     /**
      * Returns the name of the aggregate.
-     * @return
+     * @return the name of the aggregate
      */
     String getName();
 
     /**
      * Sets the name of the aggregate.
-     * @param value
+     * @param name the name of the aggregate
      */
-    void setName(String value);
+    void setName(String name);
+
+    /**
+     * Returns the AggregatePart objects that are contained in this aggregate.
+     * @return the AggregatePart objects that are contained in this aggregate
+     */
+    List<AggregatePart> getAggregateParts();
 
     /**
-     * Returns the entry points contained in this aggregate.
+     * Helper method that returns all entry points contained in this aggregate.
+     * @return a list of all EntryPoint model objects driectly contained in this aggregate
      */
     List<EntryPoint> getEntryPoints();
 
@@ -51,7 +57,7 @@
     EntryPoint getEntryPoint(String name);
 
     /**
-     * Returns the components contained in this aggregate.
+     * Helper method that returns all entry points contained in this aggregate.
      * @return
      */
     List<Component> getComponents();
@@ -82,12 +88,6 @@
      * @return
      */
     ConfiguredService getConfiguredService(ServiceURI address);
-
-    /**
-     * Returns the AggregateParts in this aggregate
-     * @return
-     */
-    List<AggregatePart> getAggregateParts();
 
     /**
      * Returns the wires.

Modified: incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/AggregatePart.java
URL: http://svn.apache.org/viewcvs/incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/AggregatePart.java?rev=380937&r1=380936&r2=380937&view=diff
==============================================================================
--- incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/AggregatePart.java (original)
+++ incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/AggregatePart.java Sat Feb 25 07:38:24 2006
@@ -17,24 +17,24 @@
 package org.apache.tuscany.model.assembly;
 
 /**
- * Represents a part of an aggregate (a component, an external service or an entry point).
+ * A configured object that is contained inside an {@link Aggregate}.
  */
 public interface AggregatePart extends AssemblyModelObject {
-
     /**
-     * Returns the name of the part.
+     * Returns the name that uniquely identifies this part within its containing aggregate.
+     * @return the name that uniquely identifies this part within its containing aggregate
      */
     String getName();
 
     /**
-     * Sets name of the part.
+     * Sets the name that uniquely identifies this part within its containing aggregate.
+     * @param value the name that uniquely identifies this part within its containing aggregate
      */
     void setName(String value);
 
     /**
-     * Returns the aggregate containing this aggregate part.
-     * @return
+     * Returns the aggregate that contains this part.
+     * @return the aggregate that contains this part
      */
     Aggregate getAggregate();
-    
 }

Modified: incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/AssemblyModelContext.java
URL: http://svn.apache.org/viewcvs/incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/AssemblyModelContext.java?rev=380937&r1=380936&r2=380937&view=diff
==============================================================================
--- incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/AssemblyModelContext.java (original)
+++ incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/AssemblyModelContext.java Sat Feb 25 07:38:24 2006
@@ -19,28 +19,30 @@
 import org.apache.tuscany.common.resource.ResourceLoader;
 import org.apache.tuscany.model.assembly.loader.AssemblyModelLoader;
 
-
 /**
+ * Context object supplied by visitors that are processing the model.
  */
 public interface AssemblyModelContext {
 
     /**
-     * Returns a model factory.
+     * Returns a factory that can be used to create other model objects
      *
-     * @return
+     * @return a factory for model objects
      */
     AssemblyFactory getAssemblyFactory();
 
     /**
-     * Returns a resource loader
-     * @return
+     * Returns a loader for resources in the current environment
+     *
+     * @return a resource loader
      */
     ResourceLoader getResourceLoader();
-    
+
     /**
-     * Returns an assembly loader.
-     * @return
+     * Returns a loader that can be used to load sub-models.
+     *
+     * @return a loader for sub-models
      */
     AssemblyModelLoader getAssemblyLoader();
-    
+
 }

Modified: incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/AssemblyModelObject.java
URL: http://svn.apache.org/viewcvs/incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/AssemblyModelObject.java?rev=380937&r1=380936&r2=380937&view=diff
==============================================================================
--- incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/AssemblyModelObject.java (original)
+++ incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/AssemblyModelObject.java Sat Feb 25 07:38:24 2006
@@ -17,27 +17,28 @@
 package org.apache.tuscany.model.assembly;
 
 /**
- * Base interface for assembly model objects.
+ * Base interface for all assembly model objects providing methods for managing the model itself.
  */
 public interface AssemblyModelObject {
 
     /**
      * Initialize this model object.
      * 
-     * @param modelContext
+     * @param modelContext context providing access to the environment in which this model is being used
      * @throws ModelInitException if an error ocurrs initializing the artifact
      */
     void initialize(AssemblyModelContext modelContext) throws ModelInitException;
 
     /**
-     * Freeze this model object.
+     * Freeze this model object preventing any additional changes.
      */
     void freeze();
 
     /**
      * Accept a visitor
      * 
-     * @param visitor
+     * @param visitor a visitor that is visiting the model
+     * @return true if processing is complete and the visitor should stop traversing the model
      */
     boolean accept(AssemblyModelVisitor visitor);
 

Modified: incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/AssemblyModelVisitor.java
URL: http://svn.apache.org/viewcvs/incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/AssemblyModelVisitor.java?rev=380937&r1=380936&r2=380937&view=diff
==============================================================================
--- incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/AssemblyModelVisitor.java (original)
+++ incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/AssemblyModelVisitor.java Sat Feb 25 07:38:24 2006
@@ -17,14 +17,15 @@
 package org.apache.tuscany.model.assembly;
 
 /**
+ * A visitor that traverses the model performing some operation.
  */
 public interface AssemblyModelVisitor {
 
     /**
      * Visit the given model object.
      *
-     * @param modelObject
-     * @return
+     * @param modelObject the assembly model object to visit
+     * @return true if processing is complete
      */
     boolean visit(AssemblyModelObject modelObject);
 

Modified: incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/Binding.java
URL: http://svn.apache.org/viewcvs/incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/Binding.java?rev=380937&r1=380936&r2=380937&view=diff
==============================================================================
--- incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/Binding.java (original)
+++ incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/Binding.java Sat Feb 25 07:38:24 2006
@@ -18,19 +18,22 @@
 
 
 /**
- * Represents a binding.
+ * The binding of an entry point or external service to a transport.
+ * This model object will typically by extended by binding implementations to allow
+ * specification of binding/transport specific information.
  */
 public interface Binding extends AssemblyModelObject, RuntimeConfigurationHolder {
-
     /**
      * Returns the binding URI.
-     * @return
+     * @return the binding uri
+     * todo do we need this?
      */
     String getURI();
 
     /**
      * Sets binding URI.
-     * @param value
+     * @param value the binding uri
+     * todo do we need this?
      */
     void setURI(String value);
 

Modified: incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/Component.java
URL: http://svn.apache.org/viewcvs/incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/Component.java?rev=380937&r1=380936&r2=380937&view=diff
==============================================================================
--- incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/Component.java (original)
+++ incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/Component.java Sat Feb 25 07:38:24 2006
@@ -20,58 +20,60 @@
 
 
 /**
- * Represents a component.
+ * A component is a configured instance of a generic {@link ComponentImplementation}.
  */
 public interface Component extends Extensible, AggregatePart {
 
     /**
-     * Returns the component implementation.
-     * @return
+     * Returns the ComponentImplementation for this configured instance.
+     * @return the ComponentImplementation for this configured instance
      */
     ComponentImplementation getComponentImplementation();
 
     /**
-     * Sets the component implementation.
-     * @param value
+     * Sets the ComponentImplementation for this configured instance
+     * @param value the ComponentImplementation for this configured instance
      */
     void setComponentImplementation(ComponentImplementation value);
 
     /**
-     * Returns the configured properties.
-     * @return
+     * Returns a list of configured property values for this configured instance.
+     * These values will be used to initialize the component when it is activated.
+     * @return a list of ConfiguredProperty values
      */
     List<ConfiguredProperty> getConfiguredProperties();
 
     /**
-     * Returns the named configured property.
-     * @param name
-     * @return
+     * Returns the ConfiguredProperty value for the specified property.
+     *
+     * @param name the name of the Property
+     * @return the configured property value for the named property
      */
     ConfiguredProperty getConfiguredProperty(String name);
 
     /**
-     * Returns the configured references.
-     * @return
+     * Returns a list of configured reference values for the configured instance.
+     * @return a list of configured reference values for the configured instance
      */
     List<ConfiguredReference> getConfiguredReferences();
 
     /**
-     * Returns the named configured reference.
-     * @param name
-     * @return
+     * Returns the ConfiguredReference value for the specified reference.
+     * @param name the name of the Property
+     * @return the configured reference value for the named reference
      */
     ConfiguredReference getConfiguredReference(String name);
 
     /**
-     * Returns the configured services.
-     * @return
+     * Returns the configured services for the configured instance.
+     * @return the configured services for the configured instance
      */
     List<ConfiguredService> getConfiguredServices();
 
     /**
-     * Returns the named configured service.
-     * @param name
-     * @return
+     * Returns the ConfiguredService value for the specified property.
+     * @param name the name of the Property
+     * @return the configured service value for the named service
      */
     ConfiguredService getConfiguredService(String name);
 	

Modified: incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/ComponentImplementation.java
URL: http://svn.apache.org/viewcvs/incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/ComponentImplementation.java?rev=380937&r1=380936&r2=380937&view=diff
==============================================================================
--- incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/ComponentImplementation.java (original)
+++ incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/ComponentImplementation.java Sat Feb 25 07:38:24 2006
@@ -18,19 +18,22 @@
 
 
 /**
- * Represents a component implementation.
+ * The implementation for a specific component instance.
+ * This interface will typically be extended by component type implementations to indicate the
+ * specific implementation to be used by a runtime and to allow for additional runtime configuration
+ * properties.
  */
 public interface ComponentImplementation extends Extensible, RuntimeConfigurationHolder {
 
     /**
-     * Returns the component type describing this implementation.
-     * @return
+     * Returns the generic component type corresponding to this implementation.
+     * @return the generic component type corresponding to this implementation
      */
     ComponentType getComponentType();
     
     /**
-     * Sets the component type describing this implementation.
-     * @param componentType
+     * Sets the generic component type corresponding to this implementation.
+     * @param componentType the generic component type corresponding to this implementation
      */
     void setComponentType(ComponentType componentType);
 

Modified: incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/ComponentType.java
URL: http://svn.apache.org/viewcvs/incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/ComponentType.java?rev=380937&r1=380936&r2=380937&view=diff
==============================================================================
--- incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/ComponentType.java (original)
+++ incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/ComponentType.java Sat Feb 25 07:38:24 2006
@@ -20,46 +20,46 @@
 
 
 /**
- * Represents a component type.
+ * A logical definition of a type of component separate from any specific implementation.
  */
 public interface ComponentType extends Extensible {
 
     /**
-     * Returns the declared services.
-     * @return
+     * Returns a list of services exposed by this component type.
+     * @return a list of services exposed by this component type
      */
     List<Service> getServices();
 
     /**
-     * Returns the named service.
-     * @param name
-     * @return
+     * Returns the specfied service if exposed by this component type.
+     * @param name the name of the service
+     * @return the service identified by the supplied name, or null if there is no service with that name
      */
     Service getService(String name);
 
     /**
-     * Returns the declared references.
-     * @return
+     * Returns the list of references this component type consumes.
+     * @return the list of references this component type consumes
      */
     List<Reference> getReferences();
 
     /**
-     * Returns the named reference.
-     * @param name
-     * @return
+     * Returns the specified reference.
+     * @param name the name of the reference
+     * @return the reference identified by the supplied name, or null if there is no reference with that name
      */
     Reference getReference(String name);
 
     /**
-     * Returns the properties declared by the component type.
-     * @return
+     * Returns the list of properties that can be used to configure components with this component type.
+     * @return the list of properties that can be used to configure components with this component type
      */
     List<Property> getProperties();
 
     /**
-     * Returns the named property.
-     * @param name
-     * @return
+     * Returns the specified property
+     * @param name the name of the property
+     * @return the property with the supplied name, or null if there is no property with that name
      */
     Property getProperty(String name);
 

Modified: incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/ConfiguredPort.java
URL: http://svn.apache.org/viewcvs/incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/ConfiguredPort.java?rev=380937&r1=380936&r2=380937&view=diff
==============================================================================
--- incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/ConfiguredPort.java (original)
+++ incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/ConfiguredPort.java Sat Feb 25 07:38:24 2006
@@ -23,32 +23,34 @@
 public interface ConfiguredPort extends AssemblyModelObject, RuntimeConfigurationHolder {
 
     /**
-     * Returns the port definition.
-     * @return
+     * Returns the port that is being configured.
+     * @return the port that is being configured
      */
     Port getPort();
 
     /**
-     * Sets the port definition.
-     * @param port
+     * Sets the port that is being configured.
+     * @param port the port that is being configured
      */
     void setPort(Port port);
 
     /**
      * Returns the aggregate part containing this port.
-     * @return
+     * @return the aggregate part that contains this port
      */
     AggregatePart getAggregatePart();
     
     /**
      * Returns the port's proxy factory
-     * @return
+     * @return the port's proxy factory
+     * todo should this be here or should it be provided in a sub-interface?
      */
     Object getProxyFactory();
 
     /**
      * Sets the port's proxy factory
-     * @param proxyFactory
+     * @param proxyFactory the port's proxy factory
+     * todo should this be here or should it be provided in a sub-interface?
      */
     void setProxyFactory(Object proxyFactory);
 	

Modified: incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/ConfiguredProperty.java
URL: http://svn.apache.org/viewcvs/incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/ConfiguredProperty.java?rev=380937&r1=380936&r2=380937&view=diff
==============================================================================
--- incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/ConfiguredProperty.java (original)
+++ incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/ConfiguredProperty.java Sat Feb 25 07:38:24 2006
@@ -16,33 +16,32 @@
  */
 package org.apache.tuscany.model.assembly;
 
-
 /**
- * Represents a configured property.
+ * The configured value of a {@link Property}.
  */
 public interface ConfiguredProperty extends AssemblyModelObject {
 
     /**
-     * Returns the property definition.
-     * @return
+     * Returns the {@link Property} whose value is being set.
+     * @return the {@link Property} whose value is being set
      */
     Property getProperty();
 
     /**
-     * Sets the property definition
-     * @param property
+     * Sets the {@link Property} whose value is being set.
+     * @param property the {@link Property} whose value is being set
      */
     void setProperty(Property property);
 
     /**
-     * Returns the property value
-     * @return
+     * Returns the value being set for this usage of the {@link Property}.
+     * @return the value being set for this usage of the {@link Property}
      */
     Object getValue();
 
     /**
-     * Sets the property value
-     * @param value
+     * Sets the value being set for this usage of the {@link Property}.
+     * @param value the value being set for this usage of the {@link Property}
      */
     void setValue(Object value);
 	

Modified: incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/ConfiguredReference.java
URL: http://svn.apache.org/viewcvs/incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/ConfiguredReference.java?rev=380937&r1=380936&r2=380937&view=diff
==============================================================================
--- incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/ConfiguredReference.java (original)
+++ incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/ConfiguredReference.java Sat Feb 25 07:38:24 2006
@@ -19,25 +19,25 @@
 import java.util.List;
 
 /**
- * Represents a configured reference.
+ * A configured reference associated with a particular usage.
  */
 public interface ConfiguredReference extends ConfiguredPort {
 
     /**
-     * Returns the reference definition.
-     * @return
+     * Returns the {@link Reference} that is being configured.
+     * @return the {@link Reference} that is being configured
      */
     Reference getReference();
 
     /**
-     * Sets the reference definition.
-     * @return
+     * Sets the {@link Reference} that is being configured.
+     * @param reference the {@link Reference} that is being configured
      */
     void setReference(Reference reference);
 
     /**
-     * Returns the target configured services wired to this configured reference.
-     * @return
+     * Returns the list of configured services that are wired to this configured reference.
+     * @return the list of configured services that are wired to this configured reference
      */
     List<ConfiguredService> getTargetConfiguredServices();
 

Modified: incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/ConfiguredService.java
URL: http://svn.apache.org/viewcvs/incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/ConfiguredService.java?rev=380937&r1=380936&r2=380937&view=diff
==============================================================================
--- incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/ConfiguredService.java (original)
+++ incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/ConfiguredService.java Sat Feb 25 07:38:24 2006
@@ -18,19 +18,18 @@
 
 
 /**
- * Represents a configured service.
+ * A configured service associated with a particular usage.
  */
 public interface ConfiguredService extends ConfiguredPort {
-
     /**
-     * Returns the service definition.
-     * @return
+     * Returns the {@link Service} that is being configured.
+     * @return the {@link Service} that is being configured
      */
     Service getService();
 
     /**
-     * Sets the service definition.
-     * @param service
+     * Sets the {@link Service} that is being configured.
+     * @param service the {@link Service} that is being configured
      */
     void setService(Service service);
     

Modified: incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/EntryPoint.java
URL: http://svn.apache.org/viewcvs/incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/EntryPoint.java?rev=380937&r1=380936&r2=380937&view=diff
==============================================================================
--- incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/EntryPoint.java (original)
+++ incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/EntryPoint.java Sat Feb 25 07:38:24 2006
@@ -20,37 +20,45 @@
 
 
 /**
- * Represents an entry point.
+ * An entry point exposed by its containing {@link Aggregate}.
+ * References from outside the Aggregate can only be connected to its entry points.
  */
 public interface EntryPoint extends AggregatePart, Extensible {
 
     /**
-     * Returns the bindings used by this entry point.
+     * Returns the bindings supported by this entry point.
+     * A single entry point may be bound to multiple transports.
+     *
+     * @return a list of bindings supported by this entry point
      */
     List<Binding> getBindings();
 
     /**
-     * Returns the configured service exposed by this external service.
-     * @return
+     * Returns the configured service exposed by this entry point.
+     *
+     * @return the configured service exposed by this entry point
      */
     ConfiguredService getConfiguredService();
 
     /**
-     * Sets the configured service exposed by this external service.
-     * @param configuredService
+     * Sets the configured service exposed by this entry point.
+     *
+     * @param configuredService the configured service exposed by this entry point
      */
     void setConfiguredService(ConfiguredService configuredService);
 
     /**
-     * Returns the configured reference wiring this entry point to the published service.
-     * @return
+     * Returns the configured reference that wires this entry point to the published service inside the aggregate.
+     *
+     * @return the reference that wires this entry point to the published service
      */
     ConfiguredReference getConfiguredReference();
 
     /**
-     * Sets the configured reference wiring this entry point to the published service.
-     * @param configuredReference
+     * Sets the configured reference that wires this entry point to the published service inside the aggregate.
+     *
+     * @param configuredReference the configured reference that wires this entry point to the published service inside the aggregate
      */
     void setConfiguredReference(ConfiguredReference configuredReference);
-    
+
 }

Modified: incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/Extensible.java
URL: http://svn.apache.org/viewcvs/incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/Extensible.java?rev=380937&r1=380936&r2=380937&view=diff
==============================================================================
--- incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/Extensible.java (original)
+++ incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/Extensible.java Sat Feb 25 07:38:24 2006
@@ -19,19 +19,19 @@
 import java.util.List;
 
 /**
- * Represents an extensible model object.
+ * An extensible model object.
+ * TODO do we actually need this given we have the ability to load specializations of individual model objects
+ * TODO is this the bext interface for this?
  */
 public interface Extensible extends AssemblyModelObject {
 
     /**
      * Returns the extensibility elements.
-     * @return
      */
     List getExtensibilityElements();
 
     /**
      * Returns the extensibility attributes.
-     * @return
      */
     List getExtensibilityAttributes();
 

Modified: incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/ExternalService.java
URL: http://svn.apache.org/viewcvs/incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/ExternalService.java?rev=380937&r1=380936&r2=380937&view=diff
==============================================================================
--- incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/ExternalService.java (original)
+++ incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/ExternalService.java Sat Feb 25 07:38:24 2006
@@ -20,34 +20,40 @@
 
 
 /**
- * Represents an external service.
+ * An external service consumed by its containing {@link Aggregate}.
+ * All references used by the aggregate are specified as external services.
  */
 public interface ExternalService extends AggregatePart, Extensible {
 
     /**
-     * Returns the bindings configured on this external service.
+     * Returns the bindings that can be used by operations on this external service.
+     * A single external service may be bound to multiple transports.
      */
     List<Binding> getBindings();
 
     /**
-     * Returns the override option.
+     * Returns the override option that determines if any wiring for this external service
+     * that is contained in this aggregate can be overridden by wired supplied from outside.
      */
     OverrideOption getOverrideOption();
 
     /**
-     * Sets the override option.
+     * Set the override option that determines if any wiring for this external service
+     * that is contained in this aggregate can be overridden by wired supplied from outside.
+     *
+     * @param value the option that determines how wires can be overriden
      */
     void setOverrideOption(OverrideOption value);
 
     /**
-     * Returns the configured service exposed by this external service.
-     * @return
+     * Returns the configured service that this external service provides to other parts of the containing aggregate.
+     * @return the configured service that this external service provides to other parts of the containing aggregate
      */
     ConfiguredService getConfiguredService();
 
     /**
-     * Sets the configured service exposed by this external service.
-     * @param configuredService
+     * Sets  the configured service that this external service provides to other parts of the containing aggregate
+     * @param configuredService the configured service that this external service provides to other parts of the containing aggregate
      */
     void setConfiguredService(ConfiguredService configuredService);
 }

Modified: incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/ModelInitException.java
URL: http://svn.apache.org/viewcvs/incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/ModelInitException.java?rev=380937&r1=380936&r2=380937&view=diff
==============================================================================
--- incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/ModelInitException.java (original)
+++ incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/ModelInitException.java Sat Feb 25 07:38:24 2006
@@ -21,7 +21,8 @@
  * @version $Rev$ $Date$
  */
 public class ModelInitException extends ModelRuntimeException {
-
+    // todo serialuid
+    
     public ModelInitException() {
         super();
     }

Modified: incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/Module.java
URL: http://svn.apache.org/viewcvs/incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/Module.java?rev=380937&r1=380936&r2=380937&view=diff
==============================================================================
--- incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/Module.java (original)
+++ incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/Module.java Sat Feb 25 07:38:24 2006
@@ -18,22 +18,21 @@
 
 import java.util.List;
 
-
 /**
- * Represents a module.
+ * A specialized {@link ComponentImplementation} that defines a modular unit of assembly.
+ * A Module denotes the extent of assembly in which pass-by-reference semantics are supported.
  */
 public interface Module extends Aggregate, ComponentImplementation {
-
     /**
-     * Returns the module fragments
-     * @return
+     * Returns a list of assembly fragments that combine to form a single module.
+     * @return a list of assembly fragments that combine to form a single module
      */
     List<ModuleFragment> getModuleFragments();
 
     /**
-     * Returns the named module fragment
-     * @param name
-     * @return
+     * Returns the specified assembly fragment.
+     * @param name the name of the fragment
+     * @return the fragment with the specified name, or null if there is no fragment with that name
      */
     ModuleFragment getModuleFragment(String name);
 

Modified: incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/ModuleComponent.java
URL: http://svn.apache.org/viewcvs/incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/ModuleComponent.java?rev=380937&r1=380936&r2=380937&view=diff
==============================================================================
--- incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/ModuleComponent.java (original)
+++ incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/ModuleComponent.java Sat Feb 25 07:38:24 2006
@@ -17,30 +17,31 @@
 package org.apache.tuscany.model.assembly;
 
 /**
- * Represents a module component.
+ * Specialization of Component that represents a configured {@link Module}.
  */
 public interface ModuleComponent extends Component {
-
+    // todo do we need this or can we just override getComponentImplementation() ?
     /**
      * Returns the module implementing this module component.
-     * @return
+     * @return the module implementing this module component
      */
     Module getModuleImplementation();
 
     /**
      * Set the module implementing this module component.
-     * @param module
+     * @param module the module implementing this module component
      */
     void setModuleImplementation(Module module);
 
     /**
-     * Returns the uri of the module component.
+     * Returns the uri that uniquely identifies this module component.
+     * @return the uri that uniquely identifies this module component
      */
     String getURI();
 
     /**
-     * Sets the uri of the module component.
+     * Sets the uri that uniquely identifies this module component.
+     * @param uri the uri that uniquely identifies this module component
      */
-    void setURI(String value);
-
+    void setURI(String uri);
 }

Modified: incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/ModuleFragment.java
URL: http://svn.apache.org/viewcvs/incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/ModuleFragment.java?rev=380937&r1=380936&r2=380937&view=diff
==============================================================================
--- incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/ModuleFragment.java (original)
+++ incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/ModuleFragment.java Sat Feb 25 07:38:24 2006
@@ -16,11 +16,10 @@
  */
 package org.apache.tuscany.model.assembly;
 
-
-
 /**
- * Represents a module fragment.
+ * A fragment of assembly configuration within a module.
+ * To support flexibility and reuse, modules can be defined in multiple fragments that are
+ * then combined by the runtime to form the complete module definition.
  */
 public interface ModuleFragment extends Aggregate {
-
 }

Modified: incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/Multiplicity.java
URL: http://svn.apache.org/viewcvs/incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/Multiplicity.java?rev=380937&r1=380936&r2=380937&view=diff
==============================================================================
--- incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/Multiplicity.java (original)
+++ incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/Multiplicity.java Sat Feb 25 07:38:24 2006
@@ -21,10 +21,27 @@
  * Enumeration for multiplicity.
  */
 public enum Multiplicity {
-
+    /**
+     * Indicates a relationship that is optionally connected to the requestor and which, if supplied,
+     * must be connected to exactly one provider.
+     */
     ZERO_ONE,
+
+    /**
+     * Indicates a relationship that must be connected between exactly one requestor and
+     * exactly one provider.
+     */
     ONE_ONE,
+
+    /**
+     * Indicates a relationship that is optionally connects the requestor to zero to unbounded providers.
+     */
     ZERO_N,
-    ONE_N,
+
+    /**
+     * Indicates a relationship that must be connected at the requestor and which connects it to
+     * zero to unbounded providers.
+     */
+    ONE_N
 
 }

Modified: incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/OverrideOption.java
URL: http://svn.apache.org/viewcvs/incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/OverrideOption.java?rev=380937&r1=380936&r2=380937&view=diff
==============================================================================
--- incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/OverrideOption.java (original)
+++ incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/OverrideOption.java Sat Feb 25 07:38:24 2006
@@ -18,12 +18,23 @@
 package org.apache.tuscany.model.assembly;
 
 /**
- * Enumeration for override options.
+ * Enumeration for override options that are used to control whether configuration information
+ * can be overridden by larger grained definitions.
  */
 public enum OverrideOption {
-    
+    /**
+     * Indicates that the supplied configuration cannot be overridden.
+     */
     NO,
+
+    /**
+     * Indicates that the supplied configuration may be overriden.
+     */
     MAY,
-    MUST;
+
+    /**
+     * Indicates that the supplied configuration must be overriden.
+     */
+    MUST
 
 }

Modified: incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/Port.java
URL: http://svn.apache.org/viewcvs/incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/Port.java?rev=380937&r1=380936&r2=380937&view=diff
==============================================================================
--- incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/Port.java (original)
+++ incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/Port.java Sat Feb 25 07:38:24 2006
@@ -17,32 +17,31 @@
 package org.apache.tuscany.model.assembly;
 
 /**
- * Represents a port (e.g. a service or reference).
+ * Abstraction for the association of a service contract with a requestor or provider.
  */
 public interface Port extends AssemblyModelObject {
-
     /**
-     * Returns the port's service contract (interface and callback interface).
-     * @return 
+     * Returns the contract for invocations of a service using this port.
+     * @return the oontract for invocations of a service using this port
      */
     ServiceContract getServiceContract();
 
     /**
-     * Returns the port's service contract (interface and callback interface).
-     * @param value 
+     * Set the contract for invocations of a service using this port.
+     * @param contract the contract for invocations of a service using this port
      */
-    void setServiceContract(ServiceContract value);
+    void setServiceContract(ServiceContract contract);
 
     /**
-     * Returns the name of the port.
-     * @return
+     * Returns the name of the port where it is associated with a requestor or provider.
+     * @return the name of the port
      */
     String getName();
 
     /**
-     * Sets the name of the port.
-     * @param value
+     * Sets the name of the port where it is associated with a requestor or provider.
+     * @param name the name of the port where it is associated with a requestor or provider
      */
-    void setName(String value);
+    void setName(String name);
 
 }

Modified: incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/Property.java
URL: http://svn.apache.org/viewcvs/incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/Property.java?rev=380937&r1=380936&r2=380937&view=diff
==============================================================================
--- incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/Property.java (original)
+++ incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/Property.java Sat Feb 25 07:38:24 2006
@@ -18,68 +18,73 @@
 
 
 /**
- * Represents a property definition.
+ * A description of a property that can be used to configure a component.
  */
 public interface Property extends Extensible {
-    
+    // todo should we decalre this as Property<T> where T would be the type of this Property?
+
+    /**
+     * Returns the property name.
+     * @return the property name
+     */
+    String getName();
+
+    /**
+     * Sets the property name.
+     * @param name the property name
+     */
+    void setName(String name);
+
     /**
      * Returns the default value of the property.
-     * @return
+     * @return the default value of ths property
      */
     Object getDefaultValue();
 
     /**
      * Sets the default value of the property.
-     * @param value
+     * @param value the default value of ths property
      */
     void setDefaultValue(Object value);
 
     /**
      * Returns true if the property allows multiple values.
-     * @return
+     * @return true if the property allows multiple values
      */
     boolean isMany();
 
     /**
-     * Sets whether or not the property allows many values.
-     * @param value
+     * Sets whether or not the property allows multiple values.
+     * @param value true if the property should allow multiple values
      */
     void setMany(boolean value);
 
     /**
-     * Returns the property name.
-     * @return
-     */
-    String getName();
-
-    /**
-     * Sets the property name.
-     * @param value
-     */
-    void setName(String value);
-
-    /**
-     * Returns true if the property is required.
-     * @return
+     * Returns true if a value must be supplied for the property.
+     * @return true is a value must be supplied for the property
      */
     boolean isRequired();
 
     /**
-     * Sets the whether or not the property is required.
-     * @param value
+     * Sets whether a value must be supplied for the property.
+     * For ease of use, it is recommended that a meaningful default value should
+     * be supplied for all properties; users should only be required to specify
+     * a value if there is no reasonable default.
+     *
+     * @param value set to true to require that a value be supplied for uses of this property
      */
     void setRequired(boolean value);
 
     /**
-     * Returns the property type.
-     * @return
+     * Returns the type of this property as used by the runtime.
+     * @return the type of this property as used by the runtime
      */
     Class getType();
 
     /**
-     * Sets the property type.
-     * @param value
+     * Sets the type of this property as used by the runtime
+     * @param value the type of this property as used by the runtime
      */
     void setType(Class value);
 
-} // Property
+}

Modified: incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/Reference.java
URL: http://svn.apache.org/viewcvs/incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/Reference.java?rev=380937&r1=380936&r2=380937&view=diff
==============================================================================
--- incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/Reference.java (original)
+++ incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/Reference.java Sat Feb 25 07:38:24 2006
@@ -18,19 +18,18 @@
 
 
 /**
- * Represents a reference.
+ * The association of a port with a requestor.
  */
 public interface Reference extends Port {
-
     /**
-     * Returns the multiplicity.
-     * @return
+     * Returns the multiplicity allowed for wires connected to this reference.
+     * @return the multiplicity allowed for wires connected to this reference
      */
     Multiplicity getMultiplicity();
 
     /**
-     * Sets the multiplicity.
-     * @param multiplicity
+     * Sets the multiplicity allowed for wires connected to this reference.
+     * @param multiplicity the multiplicity allowed for wires connected to this reference
      */
     void setMultiplicity(Multiplicity multiplicity);
 

Modified: incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/RuntimeConfigurationHolder.java
URL: http://svn.apache.org/viewcvs/incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/RuntimeConfigurationHolder.java?rev=380937&r1=380936&r2=380937&view=diff
==============================================================================
--- incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/RuntimeConfigurationHolder.java (original)
+++ incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/RuntimeConfigurationHolder.java Sat Feb 25 07:38:24 2006
@@ -17,19 +17,19 @@
 package org.apache.tuscany.model.assembly;
 
 /**
- * Represents a model object that can hold a runtime configuration object.
+ * A model object that can hold a runtime configuration object.
  */
 public interface RuntimeConfigurationHolder {
 
     /**
-     * Sets the runtime configuration
-     * @param configuration
+     * Sets the runtime configuration object.
+     * @param configuration the runtime configuration object
      */
     void setRuntimeConfiguration(Object configuration);
 
     /**
-     * Returns the runtime configuration
-     * @return
+     * Returns the runtime configuration object.
+     * @return the runtime configuration object
      */
     Object getRuntimeConfiguration();
 

Modified: incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/Scope.java
URL: http://svn.apache.org/viewcvs/incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/Scope.java?rev=380937&r1=380936&r2=380937&view=diff
==============================================================================
--- incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/Scope.java (original)
+++ incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/Scope.java Sat Feb 25 07:38:24 2006
@@ -18,15 +18,15 @@
 package org.apache.tuscany.model.assembly;
 
 /**
- * A scope enumeration
+ * The types of scope supported by assemblies.
  */
 public enum Scope {
-    
+    // todo define what these are
     INSTANCE,
     REQUEST,
     SESSION,
     MODULE,
     AGGREGATE,
-    UNDEFINED;
+    UNDEFINED
 
 }

Modified: incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/Service.java
URL: http://svn.apache.org/viewcvs/incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/Service.java?rev=380937&r1=380936&r2=380937&view=diff
==============================================================================
--- incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/Service.java (original)
+++ incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/Service.java Sat Feb 25 07:38:24 2006
@@ -18,8 +18,7 @@
 
 
 /**
- * Represents a service.
+ * The association of a port with a provider.
  */
 public interface Service extends Port {
-
 }

Modified: incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/ServiceContract.java
URL: http://svn.apache.org/viewcvs/incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/ServiceContract.java?rev=380937&r1=380936&r2=380937&view=diff
==============================================================================
--- incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/ServiceContract.java (original)
+++ incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/ServiceContract.java Sat Feb 25 07:38:24 2006
@@ -16,46 +16,46 @@
  */
 package org.apache.tuscany.model.assembly;
 
-
-
 /**
- * Represents service contract.
+ * The contract specified by a requestor or provider for invocations across a port.
  */
 public interface ServiceContract extends Extensible {
 
     /**
-     * Returns the interface.
-     * @return
+     * Returns the interface for invocations from the requestor to the provider.
+     * @return the interface for invocations from the requestor to the provider
      */
     Class getInterface();
 
     /**
-     * Sets the interface.
-     * @param value
+     * Sets the interface for invocations from the requestor to the provider.
+     * @param value the interface for invocations from the requestor to the provider
      */
     void setInterface(Class value);
     
     /**
-     * Returns the callback interface.
-     * @return
+     * Returns the callback interface for invocation from the provider back to its requestor.
+     * @return the callback interface for invocation from the provider back to its requestor
      */
     Class getCallbackInterface();
 
     /**
-     * Sets the callback interface.
-     * @param value
+     * Sets the callback interface for invocation from the provider back to its requestor.
+     * @param value the callback interface for invocation from the provider back to its requestor
      */
     void setCallbackInterface(Class value);
     
     /**
      * Returns the scope of this service contract.
      * @return
+     * todo missing javadoc
      */
     Scope getScope();
 
     /**
      * Sets the scope.
      * @param scope of this service contract.
+     * todo missing javadoc
      */
     void setScope(Scope scope);
 

Modified: incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/SimpleComponent.java
URL: http://svn.apache.org/viewcvs/incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/SimpleComponent.java?rev=380937&r1=380936&r2=380937&view=diff
==============================================================================
--- incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/SimpleComponent.java (original)
+++ incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/SimpleComponent.java Sat Feb 25 07:38:24 2006
@@ -18,9 +18,8 @@
 
 
 /**
- * Represents a simple component (as opposed to a component implemented by an aggregate, like a module component)
+ * A simple component, specifically not an {@link Aggregate}.
  */
 public interface SimpleComponent extends Component {
-
 }
  

Modified: incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/Wire.java
URL: http://svn.apache.org/viewcvs/incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/Wire.java?rev=380937&r1=380936&r2=380937&view=diff
==============================================================================
--- incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/Wire.java (original)
+++ incubator/tuscany/java/sca/model/src/main/java/org/apache/tuscany/model/assembly/Wire.java Sat Feb 25 07:38:24 2006
@@ -18,31 +18,30 @@
 
 
 /**
- * Represents a wire.
+ * A connection between a requestor (source) and a provider (target).
  */
 public interface Wire extends  Extensible {
-
     /**
-     * Returns the source URI
-     * @return
+     * Returns the URI for the source of the request.
+     * @return the URI for the source of the request
      */
     ServiceURI getSource();
     
     /**
-     * Sets the source URI
-     * @param uri
+     * Sets the URI for the source of the request.
+     * @param uri the URI for the source of the request
      */
     void setSource(ServiceURI uri);
     
     /**
-     * Returns the target URI
-     * @return
+     * Returns the URI for the target of the request.
+     * @return the URI for the target of the request
      */
     ServiceURI getTarget();
     
     /**
-     * Sets the target URI
-     * @param uri
+     * Sets the URI for the target of the request.
+     * @param uri the URI for the target of the request
      */
     void setTarget(ServiceURI uri);
     



Mime
View raw message