incubator-tamaya git commit: Even more clarifications for PropertySource#isScannable()

[st...@apache.org]

Repository: incubator-tamaya
Updated Branches:
  refs/heads/master 37be11acb -> 70c9ae457


Even more clarifications for PropertySource#isScannable()


Project: http://git-wip-us.apache.org/repos/asf/incubator-tamaya/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-tamaya/commit/70c9ae45
Tree: http://git-wip-us.apache.org/repos/asf/incubator-tamaya/tree/70c9ae45
Diff: http://git-wip-us.apache.org/repos/asf/incubator-tamaya/diff/70c9ae45

Branch: refs/heads/master
Commit: 70c9ae4571275bf7d83d72bdda3ec2a1891cbb4b
Parents: 37be11a
Author: Mark Struberg <st...@apache.org>
Authored: Tue Jan 6 18:50:43 2015 +0100
Committer: Mark Struberg <st...@apache.org>
Committed: Tue Jan 6 18:50:43 2015 +0100

----------------------------------------------------------------------
 api/src/main/java/org/apache/tamaya/spi/PropertySource.java | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/70c9ae45/api/src/main/java/org/apache/tamaya/spi/PropertySource.java
----------------------------------------------------------------------
diff --git a/api/src/main/java/org/apache/tamaya/spi/PropertySource.java b/api/src/main/java/org/apache/tamaya/spi/PropertySource.java
index bfa0252..ae80159 100644
--- a/api/src/main/java/org/apache/tamaya/spi/PropertySource.java
+++ b/api/src/main/java/org/apache/tamaya/spi/PropertySource.java
@@ -112,7 +112,11 @@ public interface PropertySource {
     /**
      * Determines if this config source could be scanned for its list of properties.
      *
-     * Generally, slow PropertySources should return {@code false} here.
+     * <p>
+     * PropertySources which are not scannable might not be able to find all the
+     * configured values to provide via {@link #getProperties()}. This can e.g. happen
+     * if the underlying storage doesn't support listing.
+     * </p>
      *
      * @return {@code true} if this PropertySource could be scanned for its list of properties,
      *         {@code false} if it should not be scanned.