You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@tuscany.apache.org by jb...@apache.org on 2007/02/13 19:05:38 UTC

svn commit: r507125 - in /incubator/tuscany/java/spec/sca-api-r1.0/src/main/java/org/osoa/sca: CallableReference.java ComponentContext.java RequestContext.java ServiceReference.java

Author: jboynes
Date: Tue Feb 13 10:05:37 2007
New Revision: 507125

URL: http://svn.apache.org/viewvc?view=rev&rev=507125
Log:
add JavaDoc for type parameters

Modified:
    incubator/tuscany/java/spec/sca-api-r1.0/src/main/java/org/osoa/sca/CallableReference.java
    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/RequestContext.java
    incubator/tuscany/java/spec/sca-api-r1.0/src/main/java/org/osoa/sca/ServiceReference.java

Modified: incubator/tuscany/java/spec/sca-api-r1.0/src/main/java/org/osoa/sca/CallableReference.java
URL: http://svn.apache.org/viewvc/incubator/tuscany/java/spec/sca-api-r1.0/src/main/java/org/osoa/sca/CallableReference.java?view=diff&rev=507125&r1=507124&r2=507125
==============================================================================
--- incubator/tuscany/java/spec/sca-api-r1.0/src/main/java/org/osoa/sca/CallableReference.java (original)
+++ incubator/tuscany/java/spec/sca-api-r1.0/src/main/java/org/osoa/sca/CallableReference.java Tue Feb 13 10:05:37 2007
@@ -4,6 +4,7 @@
  * Common superclass for references that can be passed between components.
  * 
  * @version $Rev$ $Date$
+ * @param <B> the Java interface associated with this reference
  */
 public interface CallableReference<B> {
     /**

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=507125&r1=507124&r2=507125
==============================================================================
--- 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 13 10:05:37 2007
@@ -13,9 +13,13 @@
 
     /**
      * Cast a type-safe reference to a CallableReference.
-     * Converts a type-safe reference to an equivalent CallableReference.
+     * Converts a type-safe reference to an equivalent CallableReference; if the target refers to a service
+     * then a ServiceReference will be returned, if the target refers to a callback then a CallableReference
+     * will be returned.
      *
      * @param target a reference proxy provided by the SCA runtime
+     * @param <B> the Java type of the business interface for the reference
+     * @param <R> the type of reference to be returned
      * @return a CallableReference equivalent for the proxy
      * @throws IllegalArgumentException if the supplied instance is not a reference supplied by the SCA runtime
      */
@@ -26,6 +30,7 @@
      *
      * @param businessInterface the interface that will be used to invoke the service
      * @param referenceName the name of the reference
+     * @param <B> the Java type of the business interface for the reference
      * @return an object that implements the business interface
      */
     <B> B getService(Class<B> businessInterface, String referenceName);
@@ -35,6 +40,7 @@
      *
      * @param businessInterface the interface that will be used to invoke the service
      * @param referenceName the name of the reference
+     * @param <B> the Java type of the business interface for the reference
      * @return a ServiceReference for the designated reference
      */
     <B> ServiceReference<B> getServiceReference(Class<B> businessInterface, String referenceName);
@@ -44,6 +50,7 @@
      *
      * @param type the Java type to be returned for the property
      * @param propertyName the name of the property whose value should be returned
+     * @param <B> the Java type of the property
      * @return the property value
      */
     <B> B getProperty(Class<B> type, String propertyName);
@@ -52,6 +59,7 @@
      * Returns a ServiceReference that can be used to invoke this component over the default service.
      *
      * @param businessInterface the interface that will be used to invoke the service
+     * @param <B> the Java type of the business interface for the reference
      * @return a ServiceReference that will invoke this component
      */
     <B> ServiceReference<B> createSelfReference(Class<B> businessInterface);
@@ -61,6 +69,7 @@
      *
      * @param businessInterface the interface that will be used to invoke the service
      * @param serviceName the name of the service to invoke
+     * @param <B> the Java type of the business interface for the reference
      * @return a ServiceReference that will invoke this component
      */
     <B> ServiceReference<B> createSelfReference(Class<B> businessInterface, String serviceName);

Modified: incubator/tuscany/java/spec/sca-api-r1.0/src/main/java/org/osoa/sca/RequestContext.java
URL: http://svn.apache.org/viewvc/incubator/tuscany/java/spec/sca-api-r1.0/src/main/java/org/osoa/sca/RequestContext.java?view=diff&rev=507125&r1=507124&r2=507125
==============================================================================
--- incubator/tuscany/java/spec/sca-api-r1.0/src/main/java/org/osoa/sca/RequestContext.java (original)
+++ incubator/tuscany/java/spec/sca-api-r1.0/src/main/java/org/osoa/sca/RequestContext.java Tue Feb 13 10:05:37 2007
@@ -43,6 +43,7 @@
     /**
      * Returns a ServiceReference for the service that was invoked by the caller.
      *
+     * @param <B> the Java type of the business interface for the reference
      * @return a ServiceReference for the service that was invoked by the caller
      */
     <B> ServiceReference<B> getServiceReference();
@@ -50,6 +51,7 @@
     /**
      * Returns a type-safe reference to the callback provided by the caller.
      *
+     * @param <CB> the Java type of the business interface for the callback
      * @return a type-safe reference to the callback provided by the caller
      */
     <CB> CB getCallback();
@@ -57,6 +59,7 @@
     /**
      * Returns a CallbackReference to the callback provided by the caller.
      *
+     * @param <CB> the Java type of the business interface for the callback
      * @return a CallbackReference to the callback provided by the caller
      */
     <CB> CallableReference<CB> getCallbackReference();

Modified: incubator/tuscany/java/spec/sca-api-r1.0/src/main/java/org/osoa/sca/ServiceReference.java
URL: http://svn.apache.org/viewvc/incubator/tuscany/java/spec/sca-api-r1.0/src/main/java/org/osoa/sca/ServiceReference.java?view=diff&rev=507125&r1=507124&r2=507125
==============================================================================
--- incubator/tuscany/java/spec/sca-api-r1.0/src/main/java/org/osoa/sca/ServiceReference.java (original)
+++ incubator/tuscany/java/spec/sca-api-r1.0/src/main/java/org/osoa/sca/ServiceReference.java Tue Feb 13 10:05:37 2007
@@ -23,6 +23,7 @@
  * A ServiceReference represents a client's perspective of a reference to another service.
  *
  * @version $Rev$ $Date$
+ * @param <B> the Java interface associated with this reference
  */
 public interface ServiceReference<B> extends CallableReference<B> {
     /**



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