You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@tamaya.apache.org by po...@apache.org on 2017/02/27 21:08:42 UTC
incubator-tamaya git commit: TAMAYA-236: Fix minor Javadoc issues
Repository: incubator-tamaya
Updated Branches:
refs/heads/master dbb9f101f -> b59c1ae26
TAMAYA-236: Fix minor Javadoc issues
Project: http://git-wip-us.apache.org/repos/asf/incubator-tamaya/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-tamaya/commit/b59c1ae2
Tree: http://git-wip-us.apache.org/repos/asf/incubator-tamaya/tree/b59c1ae2
Diff: http://git-wip-us.apache.org/repos/asf/incubator-tamaya/diff/b59c1ae2
Branch: refs/heads/master
Commit: b59c1ae261cd9258925eb8eaf7cbacb63f394c9b
Parents: dbb9f10
Author: Phil Ottlinger <po...@apache.org>
Authored: Mon Feb 27 22:08:27 2017 +0100
Committer: Phil Ottlinger <po...@apache.org>
Committed: Mon Feb 27 22:08:27 2017 +0100
----------------------------------------------------------------------
.../main/java/org/apache/tamaya/spi/PropertySource.java | 10 +++++-----
.../tamaya/core/propertysource/BasePropertySource.java | 2 +-
.../core/propertysource/EnvironmentPropertySource.java | 2 +-
3 files changed, 7 insertions(+), 7 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/b59c1ae2/code/api/src/main/java/org/apache/tamaya/spi/PropertySource.java
----------------------------------------------------------------------
diff --git a/code/api/src/main/java/org/apache/tamaya/spi/PropertySource.java b/code/api/src/main/java/org/apache/tamaya/spi/PropertySource.java
index 32f5a6a..83b2f7a 100644
--- a/code/api/src/main/java/org/apache/tamaya/spi/PropertySource.java
+++ b/code/api/src/main/java/org/apache/tamaya/spi/PropertySource.java
@@ -25,7 +25,7 @@ import java.util.Map;
/**
* <p>This interface models a provider that serves configuration properties. The contained
- * properties may be read fromMap single or several sources (composite).
+ * properties may be read from a Map of single or several sources (composite).
* PropertySources are the building blocks of the final configuration. </p>
* <h3>Implementation Requirements</h3>
* <p>Implementations of this interface must be</p>
@@ -35,7 +35,7 @@ import java.util.Map;
*
* <p>A PropertySourceProvider will get picked up via the
* {@link java.util.ServiceLoader} mechanism and can be registered via
- * META-INF/services/org.apache.tamaya.spi.PropertySource
+ * {@code META-INF/services/org.apache.tamaya.spi.PropertySource}
* </p>
* <p>
* If you like to register multiple PropertySources at the same time
@@ -106,7 +106,7 @@ public interface PropertySource {
* Access the current properties as Map. The resulting Map may not return all items accessible, e.g.
* when the underlying storage does not support iteration of its entries.
*
- * @return the a corresponding map, never null.
+ * @return the corresponding map, never null.
*/
Map<String,String> getProperties();
@@ -115,12 +115,12 @@ public interface PropertySource {
*
* <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
+ * configured values to provide via {@link #getProperties()}. This might happen
* if the underlying storage doesn't support listing.
* </p>
*
* @return {@code true} if this PropertySource can be scanned for its list of properties,
- * {@code false} if it should not be scanned.
+ * {@code false} if it cannot/should not be scanned.
*/
boolean isScannable();
http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/b59c1ae2/code/core/src/main/java/org/apache/tamaya/core/propertysource/BasePropertySource.java
----------------------------------------------------------------------
diff --git a/code/core/src/main/java/org/apache/tamaya/core/propertysource/BasePropertySource.java b/code/core/src/main/java/org/apache/tamaya/core/propertysource/BasePropertySource.java
index 87aaefc..5a41848 100644
--- a/code/core/src/main/java/org/apache/tamaya/core/propertysource/BasePropertySource.java
+++ b/code/core/src/main/java/org/apache/tamaya/core/propertysource/BasePropertySource.java
@@ -119,7 +119,7 @@ public abstract class BasePropertySource implements PropertySource {
return Integer.parseInt(configuredOrdinal.getValue());
} catch (Exception e) {
Logger.getLogger(getClass().getName()).log(Level.WARNING,
- "Configured Ordinal is not an int number: " + configuredOrdinal, e);
+ "Configured ordinal is not an int number: " + configuredOrdinal, e);
}
}
return getDefaultOrdinal();
http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/b59c1ae2/code/core/src/main/java/org/apache/tamaya/core/propertysource/EnvironmentPropertySource.java
----------------------------------------------------------------------
diff --git a/code/core/src/main/java/org/apache/tamaya/core/propertysource/EnvironmentPropertySource.java b/code/core/src/main/java/org/apache/tamaya/core/propertysource/EnvironmentPropertySource.java
index 0598667..3bab3b2 100644
--- a/code/core/src/main/java/org/apache/tamaya/core/propertysource/EnvironmentPropertySource.java
+++ b/code/core/src/main/java/org/apache/tamaya/core/propertysource/EnvironmentPropertySource.java
@@ -26,7 +26,7 @@ import java.util.Map;
import java.util.logging.Logger;
/**
- * This {@link org.apache.tamaya.spi.PropertySource} provides all Properties which are set
+ * This {@link org.apache.tamaya.spi.PropertySource} provides all properties which are set
* via
* {@code export myprop=myval} on UNIX Systems or
* {@code set myprop=myval} on Windows. You can disable this feature by setting {@code tamaya.envprops.disable}