You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@tamaya.apache.org by pl...@apache.org on 2016/09/16 22:03:39 UTC
[29/50] [abbrv] incubator-tamaya-extensions git commit: TAMAYA-154:
Fix javadoc warnings and typos.
TAMAYA-154: Fix javadoc warnings and typos.
Project: http://git-wip-us.apache.org/repos/asf/incubator-tamaya-extensions/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-tamaya-extensions/commit/dff68de4
Tree: http://git-wip-us.apache.org/repos/asf/incubator-tamaya-extensions/tree/dff68de4
Diff: http://git-wip-us.apache.org/repos/asf/incubator-tamaya-extensions/diff/dff68de4
Branch: refs/heads/master
Commit: dff68de45c8d850655d731f054408ed1d3df1cea
Parents: 4f8b06f
Author: Phil Ottlinger <po...@apache.org>
Authored: Tue Jul 5 23:48:26 2016 +0200
Committer: Phil Ottlinger <po...@apache.org>
Committed: Tue Jul 5 23:48:26 2016 +0200
----------------------------------------------------------------------
.../java/org/apache/tamaya/model/ConfigModelManager.java | 1 +
.../java/org/apache/tamaya/model/ConfigUsageStats.java | 5 +++--
model/src/main/java/org/apache/tamaya/model/Usage.java | 6 ++++--
.../org/apache/tamaya/model/spi/ConfigUsageStatsSpi.java | 9 ++++++---
.../resolver/internal/DefaultExpressionEvaluator.java | 10 ++++++----
5 files changed, 20 insertions(+), 11 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-tamaya-extensions/blob/dff68de4/model/src/main/java/org/apache/tamaya/model/ConfigModelManager.java
----------------------------------------------------------------------
diff --git a/model/src/main/java/org/apache/tamaya/model/ConfigModelManager.java b/model/src/main/java/org/apache/tamaya/model/ConfigModelManager.java
index 8723527..b8ece0c 100644
--- a/model/src/main/java/org/apache/tamaya/model/ConfigModelManager.java
+++ b/model/src/main/java/org/apache/tamaya/model/ConfigModelManager.java
@@ -48,6 +48,7 @@ public final class ConfigModelManager {
/**
* Access the usage statistics for the recorded uses of configuration.
+ * @return usage statistics
*/
public static String getConfigInfoText(){
StringBuilder b = new StringBuilder();
http://git-wip-us.apache.org/repos/asf/incubator-tamaya-extensions/blob/dff68de4/model/src/main/java/org/apache/tamaya/model/ConfigUsageStats.java
----------------------------------------------------------------------
diff --git a/model/src/main/java/org/apache/tamaya/model/ConfigUsageStats.java b/model/src/main/java/org/apache/tamaya/model/ConfigUsageStats.java
index 372150d..b502242 100644
--- a/model/src/main/java/org/apache/tamaya/model/ConfigUsageStats.java
+++ b/model/src/main/java/org/apache/tamaya/model/ConfigUsageStats.java
@@ -46,7 +46,7 @@ public final class ConfigUsageStats {
}
/**
- * Returnes a set fo package names tha are to be ignored when collecting usage data.
+ * Returns a set of package names that are to be ignored when collecting usage data.
* @return the ignored package names, not null.
*/
public static Set<String> getIgnoredUsagePackages(){
@@ -110,7 +110,7 @@ public final class ConfigUsageStats {
}
/**
- * Allows to check if usage tracking is enabled /should be disbled by default).
+ * Allows to check if usage tracking is enabled (should be disbled by default).
* @return true, if usage tracking is enabled.
*/
public static boolean isUsageTrackingEnabled(){
@@ -120,6 +120,7 @@ public final class ConfigUsageStats {
/**
* Access the usage statistics for the recorded uses of configuration.
+ * @return usage info or default message.
*/
public static String getUsageInfo(){
return Objects.requireNonNull(usageTracker, NO_USAGE_TRACKER_SPI_COMPONENT_MESSAGE).getUsageInfo();
http://git-wip-us.apache.org/repos/asf/incubator-tamaya-extensions/blob/dff68de4/model/src/main/java/org/apache/tamaya/model/Usage.java
----------------------------------------------------------------------
diff --git a/model/src/main/java/org/apache/tamaya/model/Usage.java b/model/src/main/java/org/apache/tamaya/model/Usage.java
index 08358af..aad0ff2 100644
--- a/model/src/main/java/org/apache/tamaya/model/Usage.java
+++ b/model/src/main/java/org/apache/tamaya/model/Usage.java
@@ -31,7 +31,7 @@ import java.util.concurrent.atomic.AtomicLong;
import java.util.logging.Logger;
/**
- * Metrics container containing access statistics for a given vonfiguration key.
+ * Metrics container containing access statistics for a given configuration key.
*/
public final class Usage {
private static final Logger LOG = Logger.getLogger(Usage.class.getName());
@@ -115,6 +115,7 @@ public final class Usage {
/**
* Access a usage reference for a given class.
+ * @param type class to get usage references for, not null.
* @return the usage ref, if present, or null.
*/
public Collection<AccessDetail> getAccessDetails(Class type){
@@ -123,6 +124,7 @@ public final class Usage {
/**
* Access a usage reference for a given package.
+ * @param pack package to get usage references for, not null.
* @return the usage ref, if present, or null.
*/
public Collection<AccessDetail> getAccessDetails(Package pack){
@@ -152,7 +154,7 @@ public final class Usage {
}
/**
- * Get the access details (stacktrace etrc) for this reference.
+ * Get the access details (stacktrace etc) for this reference.
* @return return the access details, not null.
*/
public Collection<AccessDetail> getAccessDetails(){
http://git-wip-us.apache.org/repos/asf/incubator-tamaya-extensions/blob/dff68de4/model/src/main/java/org/apache/tamaya/model/spi/ConfigUsageStatsSpi.java
----------------------------------------------------------------------
diff --git a/model/src/main/java/org/apache/tamaya/model/spi/ConfigUsageStatsSpi.java b/model/src/main/java/org/apache/tamaya/model/spi/ConfigUsageStatsSpi.java
index 90753d2..5617b73 100644
--- a/model/src/main/java/org/apache/tamaya/model/spi/ConfigUsageStatsSpi.java
+++ b/model/src/main/java/org/apache/tamaya/model/spi/ConfigUsageStatsSpi.java
@@ -24,7 +24,7 @@ import java.util.Collection;
import java.util.Set;
/**
- * SPI to implemented by the component responsible for usage tracking of
+ * SPI to be implemented by the component responsible for usage tracking of
* configuration.
*/
public interface ConfigUsageStatsSpi {
@@ -36,13 +36,13 @@ public interface ConfigUsageStatsSpi {
void enableUsageTracking(boolean enable);
/**
- * Allows to check if usage tracking is enabled /should be disbled by default).
+ * Allows to check if usage tracking is enabled (should be disbled by default).
* @return true, if usage tracking is enabled.
*/
boolean isUsageTrackingEnabled();
/**
- * Get the list of package, which are not evaluated for tracking configuration access and usage statistics.
+ * Get the list of packages, which are not evaluated for tracking configuration access and usage statistics.
* @return the set of ignored package names.
*/
Set<String> getIgnoredPackages();
@@ -83,11 +83,14 @@ public interface ConfigUsageStatsSpi {
/**
* Track the access of {@code Configuration#get(String)} for
* usage statistics.
+ * @param key key to track for
+ * @param value value to track for
*/
void trackSingleKeyAccess(String key, String value);
/**
* Access the usage statistics for the recorded uses of configuration.
+ * @return usage statistics info
*/
String getUsageInfo();
http://git-wip-us.apache.org/repos/asf/incubator-tamaya-extensions/blob/dff68de4/resolver/src/main/java/org/apache/tamaya/resolver/internal/DefaultExpressionEvaluator.java
----------------------------------------------------------------------
diff --git a/resolver/src/main/java/org/apache/tamaya/resolver/internal/DefaultExpressionEvaluator.java b/resolver/src/main/java/org/apache/tamaya/resolver/internal/DefaultExpressionEvaluator.java
index b01992d..983b10b 100644
--- a/resolver/src/main/java/org/apache/tamaya/resolver/internal/DefaultExpressionEvaluator.java
+++ b/resolver/src/main/java/org/apache/tamaya/resolver/internal/DefaultExpressionEvaluator.java
@@ -120,7 +120,8 @@ public class DefaultExpressionEvaluator implements ExpressionEvaluator {
*
* @param key the key to be filtered
* @param value value to be analyzed for expressions
- * @param maskUnresolved
+ * @param maskUnresolved if true, not found expression parts will be replaced by surrounding with [].
+ * Setting to false will replace the value with an empty String.
* @return the resolved value, or the input in case where no expression was detected.
*/
@Override
@@ -165,7 +166,8 @@ public class DefaultExpressionEvaluator implements ExpressionEvaluator {
/**
* Parses subexpression from tokenizer, hereby counting all open and closed brackets, but ignoring any
* meta characters.
- * @param tokenizer the current tokniezer instance
+ * @param tokenizer the current tokenizer instance
+ * @param valueToBeFiltered subexpression to be filtered for
* @return the parsed sub expression
*/
private String parseSubExpression(StringTokenizer tokenizer, String valueToBeFiltered) {
@@ -216,10 +218,10 @@ public class DefaultExpressionEvaluator implements ExpressionEvaluator {
}
/**
- * Evalutes the expression parsed, hereby checking for prefixes and trying otherwise all available resolvers,
+ * Evaluates the expression parsed, hereby checking for prefixes and trying otherwise all available resolvers,
* based on priority.
* @param unresolvedExpression the parsed, but unresolved expression
- * @param maskUnresolved if true, not found expression parts will be replaced vy surrounding with [].
+ * @param maskUnresolved if true, not found expression parts will be replaced by surrounding with [].
* Setting to false will replace the value with an empty String.
* @return the resolved expression, or null.
*/