svn commit: r1654141 - /sling/trunk/contrib/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/use/UseProvider.java

[fm...@apache.org]

Author: fmeschbe
Date: Fri Jan 23 08:42:05 2015
New Revision: 1654141

URL: http://svn.apache.org/r1654141
Log:
Add JavaDoc indicating the use of service.ranking service property
to order UseProvider services

Modified:
    sling/trunk/contrib/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/use/UseProvider.java

Modified: sling/trunk/contrib/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/use/UseProvider.java
URL: http://svn.apache.org/viewvc/sling/trunk/contrib/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/use/UseProvider.java?rev=1654141&r1=1654140&r2=1654141&view=diff
==============================================================================
--- sling/trunk/contrib/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/use/UseProvider.java (original)
+++ sling/trunk/contrib/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/use/UseProvider.java Fri Jan 23 08:42:05 2015
@@ -26,8 +26,14 @@ import org.apache.sling.scripting.sightl
 import aQute.bnd.annotation.ConsumerType;
 
 /**
- * Provides instances for the use API. Providers are tried in the order
- * of their priority until one is found which can provide a non-null instance
+ * Provides instances for the use API. Providers are tried in the order of their
+ * service ranking until one is found which can provide a non-null instance
+ * <p>
+ * {@code UseProvider} services are ranked according to the OSGi service
+ * registration propertiy {@code service.ranking} which is an integer value.
+ * {@code UseProvider} servies with lower ranking values are tried before
+ * services with higher ranking values. The default value for the ranking if the
+ * property is missing is zero.
  */
 @ConsumerType
 public interface UseProvider {