svn commit: r512440 - in /incubator/tuscany/java/spec/sca-api-r1.0/src/main/java/org/osoa/sca: ComponentContext.java Conversation.java annotations/Context.java

[jb...@apache.org]

Author: jboynes
Date: Tue Feb 27 14:08:01 2007
New Revision: 512440

URL: http://svn.apache.org/viewvc?view=rev&rev=512440
Log:
add Class Javadoc for ComponentContext and Conversation
fix typo in Conversation#getConversationID
clarify class JavaDoc for @Context

Modified:
    incubator/tuscany/java/spec/sca-api-r1.0/src/main/java/org/osoa/sca/ComponentContext.java
    incubator/tuscany/java/spec/sca-api-r1.0/src/main/java/org/osoa/sca/Conversation.java
    incubator/tuscany/java/spec/sca-api-r1.0/src/main/java/org/osoa/sca/annotations/Context.java

Modified: incubator/tuscany/java/spec/sca-api-r1.0/src/main/java/org/osoa/sca/ComponentContext.java
URL: http://svn.apache.org/viewvc/incubator/tuscany/java/spec/sca-api-r1.0/src/main/java/org/osoa/sca/ComponentContext.java?view=diff&rev=512440&r1=512439&r2=512440
==============================================================================
--- incubator/tuscany/java/spec/sca-api-r1.0/src/main/java/org/osoa/sca/ComponentContext.java (original)
+++ incubator/tuscany/java/spec/sca-api-r1.0/src/main/java/org/osoa/sca/ComponentContext.java Tue Feb 27 14:08:01 2007
@@ -19,6 +19,13 @@
 package org.osoa.sca;
 
 /**
+ * Interface providing programmatic access to a component's SCA context as an alternative to injection.
+ * It provides access to reference and property values for the component and provides a mechanism for
+ * obtaining a reference to a service that can be passed to other components.
+ * <p/>
+ * SCA components obtain an instance of this interface through injection. Non-SCA client code may also
+ * obtain an instance through runtime-specific mechanisms.
+ * 
  * @version $Rev$ $Date$
  */
 public interface ComponentContext {

Modified: incubator/tuscany/java/spec/sca-api-r1.0/src/main/java/org/osoa/sca/Conversation.java
URL: http://svn.apache.org/viewvc/incubator/tuscany/java/spec/sca-api-r1.0/src/main/java/org/osoa/sca/Conversation.java?view=diff&rev=512440&r1=512439&r2=512440
==============================================================================
--- incubator/tuscany/java/spec/sca-api-r1.0/src/main/java/org/osoa/sca/Conversation.java (original)
+++ incubator/tuscany/java/spec/sca-api-r1.0/src/main/java/org/osoa/sca/Conversation.java Tue Feb 27 14:08:01 2007
@@ -19,6 +19,9 @@
 package org.osoa.sca;
 
 /**
+ * Interface representing a Conversation providing access to the conversation id and and a mechanism
+ * to terminate the conversation.
+ * 
  * @version $Rev$ $Date$
  */
 public interface Conversation {
@@ -29,7 +32,7 @@
      *
      * @return the identifier for this conversation
      */
-    Object getConversionID();
+    Object getConversationID();
 
     /**
      * End this conversation.

Modified: incubator/tuscany/java/spec/sca-api-r1.0/src/main/java/org/osoa/sca/annotations/Context.java
URL: http://svn.apache.org/viewvc/incubator/tuscany/java/spec/sca-api-r1.0/src/main/java/org/osoa/sca/annotations/Context.java?view=diff&rev=512440&r1=512439&r2=512440
==============================================================================
--- incubator/tuscany/java/spec/sca-api-r1.0/src/main/java/org/osoa/sca/annotations/Context.java (original)
+++ incubator/tuscany/java/spec/sca-api-r1.0/src/main/java/org/osoa/sca/annotations/Context.java Tue Feb 27 14:08:01 2007
@@ -25,7 +25,9 @@
 import java.lang.annotation.Target;
 
 /**
- * Annotation used to indicate a field or method that is used to inject the component's CompositeContext.
+ * Annotation used to indicate a field or setter method that is used to inject an SCA context.
+ * The type of context injected is determined by the type of the field or the parameter
+ * to the setter method and is typically a ComponentContext or RequestContext.
  *
  * @version $Rev$ $Date$
  */



---------------------------------------------------------------------
To unsubscribe, e-mail: tuscany-commits-unsubscribe@ws.apache.org
For additional commands, e-mail: tuscany-commits-help@ws.apache.org