Attachment 101355 Details for Bug 231399 – IDSService, IDSProvide, IDSReference and IDSImplementation updates

IDSService, IDSProvide, IDSReference and IDSImplementation updates

org.eclipse.pde.ds.core.83.patch (text/plain), 11.37 KB, created by Rafael Oliveira Nóbrega

on 2008-05-21 15:37:46 EDT

(hide)

Description:

Filename:

MIME Type:

Creator: Rafael Oliveira Nóbrega

Created: 2008-05-21 15:37:46 EDT

Size: 11.37 KB

patch

obsolete

>### Eclipse Workspace Patch 1.0
>#P org.eclipse.pde.ds.core
>Index: src/org/eclipse/pde/internal/ds/core/IDSService.java
>===================================================================
>RCS file: /cvsroot/eclipse/pde-incubator/ds/org.eclipse.pde.ds.core/src/org/eclipse/pde/internal/ds/core/IDSService.java,v
>retrieving revision 1.6
>diff -u -r1.6 IDSService.java
>--- src/org/eclipse/pde/internal/ds/core/IDSService.java	20 May 2008 12:49:27 -0000	1.6
>+++ src/org/eclipse/pde/internal/ds/core/IDSService.java	21 May 2008 19:34:43 -0000
>@@ -11,13 +11,55 @@
>  *******************************************************************************/
> package org.eclipse.pde.internal.ds.core;
> 
>+/**
>+ * Represents the service information to be used when a component configuration
>+ * is to be registered as a service.
>+ * 
>+ * @since 3.4
>+ * @see IDSComponent
>+ * @see IDSObject
>+ */
> public interface IDSService extends IDSObject {
> 
>+	/**
>+	 * Sets the attribute servicefactory
>+	 * 
>+	 * This attribute controls whether the service uses the ServiceFactory
>+	 * concept of the OSGi Framework.
>+	 * 
>+	 * The default value is false.
>+	 * 
>+	 * If servicefactory is set to true, a different component configuration is
>+	 * created, activated and its component instance returned as the service
>+	 * object for each distinct bundle that requests the service.Each of these
>+	 * component configurations has the same component properties.Otherwise, the
>+	 * same component instance from the single component configuration is
>+	 * returned as the service object for all bundles that request the service.
>+	 * 
>+	 * The servicefactory attribute must not be true if the component is a
>+	 * factory component or an immediate component. This is because SCR is not
>+	 * free to create component configurations as necessary to support
>+	 * servicefactory. A component description is ill-formed if it specifies
>+	 * that the component is a factory component or an immediate component and
>+	 * servicefactory is set to true.
>+	 * 
>+	 * @param bool
>+	 *            new boolean value of attribute servicefactory
>+	 */
> 	public void setServiceFactory(boolean bool);
> 
>+	/**
>+	 * Returns the value of attribute servicefactory
>+	 * 
>+	 * @return boolean containing the value of attribute servicefactory
>+	 */
> 	public boolean getServiceFactory();
> 
>+	/**
>+	 * Return all Service's interfaces
>+	 * 
>+	 * @return IDSProvide's array containing all provide elements
>+	 */
> 	public IDSProvide[] getProvidedServices();
>-	
> 
> }
>Index: src/org/eclipse/pde/internal/ds/core/IDSReference.java
>===================================================================
>RCS file: /cvsroot/eclipse/pde-incubator/ds/org.eclipse.pde.ds.core/src/org/eclipse/pde/internal/ds/core/IDSReference.java,v
>retrieving revision 1.2
>diff -u -r1.2 IDSReference.java
>--- src/org/eclipse/pde/internal/ds/core/IDSReference.java	5 May 2008 17:45:07 -0000	1.2
>+++ src/org/eclipse/pde/internal/ds/core/IDSReference.java	21 May 2008 19:34:43 -0000
>@@ -11,34 +11,170 @@
>  *******************************************************************************/
> package org.eclipse.pde.internal.ds.core;
> 
>+/**
>+ * Represents a dependency that a component has on a set of target services.
>+ * 
>+ * A component configuration is not satisfied, unless all its references are
>+ * satisfied. A reference specifies target services by specifying their
>+ * interface and an optional target filter.
>+ * 
>+ * @since 3.4
>+ * @see IDSComponent
>+ * @see IDSObject
>+ */
> public interface IDSReference extends IDSObject {
> 
>+	/**
>+	 * Sets the name of the reference.
>+	 * 
>+	 * This name is local to the component and can be used to locate a bound
>+	 * service of this reference with one of the locateService methods of
>+	 * ComponentContext.
>+	 * 
>+	 * @param name
>+	 *            new name of the reference
>+	 */
> 	public void setReferenceName(String name);
> 
>+	/**
>+	 * Returns the name of the reference.
>+	 * 
>+	 * @return String containing the name of the reference
>+	 */
> 	public String getReferenceName();
> 
>+	/**
>+	 * Sets the fully qualified name of the class that is used by the component
>+	 * to access the service.
>+	 * 
>+	 * The service provided to the component must be type compatible with this
>+	 * class. That is, the component must be able to cast the service object to
>+	 * this class. A service must be registered under this name to be considered
>+	 * for the set of target services.
>+	 * 
>+	 * @param interfaceName
>+	 *            new fully qualified name of the class used to access the
>+	 *            service
>+	 */
> 	public void setReferenceInterface(String interfaceName);
> 
>+	/**
>+	 * Returns the fully qualified name of the class that is used by the
>+	 * component to access the service.
>+	 * 
>+	 * @return String containing the fully qualified name of the class used to
>+	 *         access the service
>+	 */
> 	public String getReferenceInterface();
> 
>+	/**
>+	 * Sets if the reference is optional and if the component implementation
>+	 * support a single bound service or multiple bound services.
>+	 * 
>+	 * The cardinality for a reference can be specified as one of four choices:
>+	 * 0..1 â Optional and unary. 1..1 â Mandatory and unary (Default) 0..n â
>+	 * Optional and multiple. 1..n â Mandatory and multiple.
>+	 * 
>+	 * @param cardinality
>+	 *            new cardinality value
>+	 */
> 	public void setReferenceCardinality(String cardinality);
> 
>+	/**
>+	 * Returns if the reference is optional and if the component implementation
>+	 * support a single bound service or multiple bound services.
>+	 * 
>+	 * @return String containing one of four choices: 0..1 â Optional and unary.
>+	 *         1..1 â Mandatory and unary (Default) 0..n â Optional and
>+	 *         multiple. 1..n â Mandatory and multiple
>+	 */
> 	public String getReferenceCardinality();
> 
>+	/**
>+	 * Sets the assumption of the component about dynamicity.
>+	 * 
>+	 * The policy for a reference can be specified as one of two choices: The
>+	 * static policy is the most simple policy and is the default one. A
>+	 * component instance never sees any of the dynamics. The dynamic policy is
>+	 * the second option and is slightly more complex since the component
>+	 * implementation must properly handle changes in the set of bound services.
>+	 * 
>+	 * @param policy
>+	 *            new value of the policy (static or dynamic)
>+	 * 
>+	 */
> 	public void setReferencePolicy(String policy);
> 
>+	/**
>+	 * Return the policy of the component
>+	 * 
>+	 * @return String containing the policy value
>+	 */
> 	public String getReferencePolicy();
> 
>+	/**
>+	 * Sets the optional OSGi Framework filter expression that further
>+	 * constrains the set of target services.
>+	 * 
>+	 * The default is no filter, limiting the set of matched services to all
>+	 * service registered under the given reference interface. The value of this
>+	 * attribute is used to set a target property.
>+	 * 
>+	 * @param target
>+	 *            the new value of attribute target
>+	 */
> 	public void setReferenceTarget(String target);
> 
>+	/**
>+	 * Returns the target filter expression that further constrains the set of target
>+	 * services.
>+	 * 
>+	 * @return String containing the attribute target value
>+	 */
> 	public String getReferenceTarget();
> 
>+	/**
>+	 * Sets the name of a method in the component implementation class that is
>+	 * used to notify that a service is bound to the component configuration.
>+	 * 
>+	 * For static references, this method is only called before the activate
>+	 * method. For dynamic references, this method can also be called while the
>+	 * component configuration is active.
>+	 * 
>+	 * @param bind
>+	 *            new method's name to notify that a service is bound
>+	 */
> 	public void setReferenceBind(String bind);
> 
>+	/**
>+	 * Returns the name of a method in the component implementation class that
>+	 * is used to notify that a service is bound to the component configuration.
>+	 * 
>+	 * @return String containing the name of the method
>+	 */
> 	public String getReferenceBind();
> 
>+
>+	/**
>+	 * Sets the name of a method in the component implementation class that is
>+	 * used to notify the component configuration that the service is unbound.
>+	 * 
>+	 * For static references, the method is only called after the deactivate
>+	 * method. For dynamic references, this method can also be called while the
>+	 * component configuration is active.
>+	 * 
>+	 * @param unbind
>+	 *            new method's name to notify that a service is unbound
>+	 */
> 	public void setReferenceUnbind(String unbind);
> 
>+	/**
>+	 * Returns the name of a method in the component implementation class that
>+	 * is used to notify the component configuration that the service is
>+	 * unbound.
>+	 * 
>+	 * @return String containing the name of the method
>+	 */
> 	public String getReferenceUnbind();
> 
> }
>Index: src/org/eclipse/pde/internal/ds/core/IDSProvide.java
>===================================================================
>RCS file: /cvsroot/eclipse/pde-incubator/ds/org.eclipse.pde.ds.core/src/org/eclipse/pde/internal/ds/core/IDSProvide.java,v
>retrieving revision 1.2
>diff -u -r1.2 IDSProvide.java
>--- src/org/eclipse/pde/internal/ds/core/IDSProvide.java	5 May 2008 17:45:07 -0000	1.2
>+++ src/org/eclipse/pde/internal/ds/core/IDSProvide.java	21 May 2008 19:34:42 -0000
>@@ -11,10 +11,29 @@
>  *******************************************************************************/
> package org.eclipse.pde.internal.ds.core;
> 
>+/**
>+ * Represents the provide element that define the service interfaces.
>+ * 
>+ * @since 3.4
>+ * @see IDSService
>+ * @see IDSObject
>+ */
> public interface IDSProvide extends IDSObject {
> 
>+	/**
>+	 * Sets the name of the interface that this service is registered under.
>+	 * This name must be the fully qualified name of a Java class.
>+	 * 
>+	 * @param interfaceName
>+	 *            new fully qualified name of a Java class.
>+	 */
> 	public void setInterface(String interfaceName);
> 
>+	/**
>+	 * Returns the name of the interface that this service is registered under.
>+	 * 
>+	 * @return String containing a fully qualified name of a Java class.
>+	 */
> 	public String getInterface();
> 
> }
>Index: src/org/eclipse/pde/internal/ds/core/IDSImplementation.java
>===================================================================
>RCS file: /cvsroot/eclipse/pde-incubator/ds/org.eclipse.pde.ds.core/src/org/eclipse/pde/internal/ds/core/IDSImplementation.java,v
>retrieving revision 1.2
>diff -u -r1.2 IDSImplementation.java
>--- src/org/eclipse/pde/internal/ds/core/IDSImplementation.java	5 May 2008 17:45:07 -0000	1.2
>+++ src/org/eclipse/pde/internal/ds/core/IDSImplementation.java	21 May 2008 19:34:42 -0000
>@@ -11,10 +11,29 @@
>  *******************************************************************************/
> package org.eclipse.pde.internal.ds.core;
> 
>+/**
>+ * Represents the component implementation class
>+ * 
>+ * @since 3.4
>+ * @see IDSComponent
>+ * @see IDSObject
>+ * 
>+ */
> public interface IDSImplementation extends IDSObject {
> 
>+	/**
>+	 * Sets the java fully qualified name of the implementation class.
>+	 * 
>+	 * @param className
>+	 *            new java fully qualified name
>+	 */
> 	public void setClassName(String className);
> 
>+	/**
>+	 * Returns the java fully qualified name of the implementation class.
>+	 * 
>+	 * @return String containing the java fully qualified name
>+	 */
> 	public String getClassName();
> 
> }

Flags:

caniszczyk: iplog+

Actions: View

Attachments on bug 231399: 101041 | 101042 | 101329 | 101355 | 101517 | 101572 | 101655 | 101656