svn commit: r1552268 - in /sling/whiteboard/feature-flags/src/main/java/org/apache/sling/extensions/featureflags: FeatureProvider.java Features.java impl/FeatureManager.java impl/FeaturesImpl.java

[cziegeler]

Author: cziegeler
Date: Thu Dec 19 09:53:17 2013
New Revision: 1552268

URL: http://svn.apache.org/r1552268
Log:
Update javadocs

Modified:
    
sling/whiteboard/feature-flags/src/main/java/org/apache/sling/extensions/featureflags/FeatureProvider.java
    
sling/whiteboard/feature-flags/src/main/java/org/apache/sling/extensions/featureflags/Features.java
    
sling/whiteboard/feature-flags/src/main/java/org/apache/sling/extensions/featureflags/impl/FeatureManager.java
    
sling/whiteboard/feature-flags/src/main/java/org/apache/sling/extensions/featureflags/impl/FeaturesImpl.java

Modified: 
sling/whiteboard/feature-flags/src/main/java/org/apache/sling/extensions/featureflags/FeatureProvider.java
URL: 
http://svn.apache.org/viewvc/sling/whiteboard/feature-flags/src/main/java/org/apache/sling/extensions/featureflags/FeatureProvider.java?rev=1552268&r1=1552267&r2=1552268&view=diff
==============================================================================
--- 
sling/whiteboard/feature-flags/src/main/java/org/apache/sling/extensions/featureflags/FeatureProvider.java
 (original)
+++ 
sling/whiteboard/feature-flags/src/main/java/org/apache/sling/extensions/featureflags/FeatureProvider.java
 Thu Dec 19 09:53:17 2013
@@ -44,14 +44,20 @@ public interface FeatureProvider {
     /**
      * Returns the resource type mapping for a feature.
      * This mapping is only used if {@link #isEnabled(String, 
ExecutionContext)}
-     * return true for the given feature/context.
+     * return true for the given feature/context. The caller of this
+     * method must ensure to call {@link #isEnabled(String, ExecutionContext)}
+     * before calling this method and only call this method if
+     * {@link #isEnabled(String, ExecutionContext)} return <code>true</code>
      */
     Map<String, String> getResourceTypeMapping(String featureName);
 
     /**
      * Checks whether a resource should be hidden for a feature.
      * This check is only executed if {@link #isEnabled(String, 
ExecutionContext)}
-     * return true for the given feature/context.
+     * return true for the given feature/context. The caller of this
+     * method must ensure to call {@link #isEnabled(String, ExecutionContext)}
+     * before calling this method and only call this method if
+     * {@link #isEnabled(String, ExecutionContext)} return <code>true</code>
      */
     boolean hideResource(String featureName, Resource resource);
 }

Modified: 
sling/whiteboard/feature-flags/src/main/java/org/apache/sling/extensions/featureflags/Features.java
URL: 
http://svn.apache.org/viewvc/sling/whiteboard/feature-flags/src/main/java/org/apache/sling/extensions/featureflags/Features.java?rev=1552268&r1=1552267&r2=1552268&view=diff
==============================================================================
--- 
sling/whiteboard/feature-flags/src/main/java/org/apache/sling/extensions/featureflags/Features.java
 (original)
+++ 
sling/whiteboard/feature-flags/src/main/java/org/apache/sling/extensions/featureflags/Features.java
 Thu Dec 19 09:53:17 2013
@@ -32,9 +32,10 @@ import aQute.bnd.annotation.ProviderType
 public interface Features {
 
     /**
-     * Get the list of all active features
+     * Get the list of all available features. A feature is available
+     * if there is a {@link FeatureProvider}
      */
-    String[] getFeatureNames();
+    String[] getAvailableFeatureNames();
 
     /**
      * Checks whether a feature with the given name is available.

Modified: 
sling/whiteboard/feature-flags/src/main/java/org/apache/sling/extensions/featureflags/impl/FeatureManager.java
URL: 
http://svn.apache.org/viewvc/sling/whiteboard/feature-flags/src/main/java/org/apache/sling/extensions/featureflags/impl/FeatureManager.java?rev=1552268&r1=1552267&r2=1552268&view=diff
==============================================================================
--- 
sling/whiteboard/feature-flags/src/main/java/org/apache/sling/extensions/featureflags/impl/FeatureManager.java
 (original)
+++ 
sling/whiteboard/feature-flags/src/main/java/org/apache/sling/extensions/featureflags/impl/FeatureManager.java
 Thu Dec 19 09:53:17 2013
@@ -175,7 +175,7 @@ public class FeatureManager implements F
     }
 
     @Override
-    public String[] getFeatureNames() {
+    public String[] getAvailableFeatureNames() {
         return this.activeProviders.keySet().toArray(new 
String[this.activeProviders.size()]);
     }
 

Modified: 
sling/whiteboard/feature-flags/src/main/java/org/apache/sling/extensions/featureflags/impl/FeaturesImpl.java
URL: 
http://svn.apache.org/viewvc/sling/whiteboard/feature-flags/src/main/java/org/apache/sling/extensions/featureflags/impl/FeaturesImpl.java?rev=1552268&r1=1552267&r2=1552268&view=diff
==============================================================================
--- 
sling/whiteboard/feature-flags/src/main/java/org/apache/sling/extensions/featureflags/impl/FeaturesImpl.java
 (original)
+++ 
sling/whiteboard/feature-flags/src/main/java/org/apache/sling/extensions/featureflags/impl/FeaturesImpl.java
 Thu Dec 19 09:53:17 2013
@@ -37,8 +37,8 @@ public class FeaturesImpl implements Fea
     private FeatureManager manager;
 
     @Override
-    public String[] getFeatureNames() {
-        return this.manager.getFeatureNames();
+    public String[] getAvailableFeatureNames() {
+        return this.manager.getAvailableFeatureNames();
     }
 
     @Override