You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@tamaya.apache.org by an...@apache.org on 2015/01/31 01:39:03 UTC
incubator-tamaya git commit: TAMAYA-63: Improved Javadocs.
Repository: incubator-tamaya
Updated Branches:
refs/heads/master c5415ce48 -> 6ad58f0b9
TAMAYA-63: Improved Javadocs.
Project: http://git-wip-us.apache.org/repos/asf/incubator-tamaya/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-tamaya/commit/6ad58f0b
Tree: http://git-wip-us.apache.org/repos/asf/incubator-tamaya/tree/6ad58f0b
Diff: http://git-wip-us.apache.org/repos/asf/incubator-tamaya/diff/6ad58f0b
Branch: refs/heads/master
Commit: 6ad58f0b93e82c30aaf314ee690c0e9ff5faa3e4
Parents: c5415ce
Author: anatole <an...@apache.org>
Authored: Sat Jan 31 01:38:57 2015 +0100
Committer: anatole <an...@apache.org>
Committed: Sat Jan 31 01:38:57 2015 +0100
----------------------------------------------------------------------
.../core/internal/converters/ByteConverter.java | 16 ++++++++++++-
.../core/internal/converters/CharConverter.java | 9 ++++++-
.../internal/converters/CurrencyConverter.java | 8 ++++++-
.../internal/converters/DoubleConverter.java | 25 +++++++++++++-------
.../internal/converters/FloatConverter.java | 7 +++++-
.../internal/converters/IntegerConverter.java | 16 ++++++++++++-
.../core/internal/converters/LongConverter.java | 16 ++++++++++++-
.../internal/converters/ShortConverter.java | 16 ++++++++++++-
.../internal/converters/BooleanConverter.java | 12 +++++++++-
.../core/internal/converters/ByteConverter.java | 9 ++++++-
.../core/internal/converters/CharConverter.java | 11 +++++++--
.../internal/converters/IntegerConverter.java | 16 ++++++++++++-
.../core/internal/converters/LongConverter.java | 16 ++++++++++++-
.../internal/converters/ShortConverter.java | 16 ++++++++++++-
14 files changed, 171 insertions(+), 22 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/6ad58f0b/java7/core/src/main/java/org/apache/tamaya/core/internal/converters/ByteConverter.java
----------------------------------------------------------------------
diff --git a/java7/core/src/main/java/org/apache/tamaya/core/internal/converters/ByteConverter.java b/java7/core/src/main/java/org/apache/tamaya/core/internal/converters/ByteConverter.java
index d280746..7b695bf 100644
--- a/java7/core/src/main/java/org/apache/tamaya/core/internal/converters/ByteConverter.java
+++ b/java7/core/src/main/java/org/apache/tamaya/core/internal/converters/ByteConverter.java
@@ -24,7 +24,21 @@ import java.util.Locale;
import java.util.Objects;
/**
- * Converter, converting from String to Byte.
+ * Converter, converting from String to Byte, the supported format is one of the following:
+ * <ul>
+ * <li>123 (byte value)</li>
+ * <li>0xFF (byte value)</li>
+ * <li>0XDF (byte value)</li>
+ * <li>0D1 (byte value)</li>
+ * <li>-123 (byte value)</li>
+ * <li>-0xFF (byte value)</li>
+ * <li>-0XDF (byte value)</li>
+ * <li>-0D1 (byte value)</li>
+ * <li>MIN_VALUE (ignoring case)</li>
+ * <li>MIN (ignoring case)</li>
+ * <li>MAX_VALUE (ignoring case)</li>
+ * <li>MAX (ignoring case)</li>
+ * </ul>
*/
public class ByteConverter implements PropertyConverter<Byte>{
http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/6ad58f0b/java7/core/src/main/java/org/apache/tamaya/core/internal/converters/CharConverter.java
----------------------------------------------------------------------
diff --git a/java7/core/src/main/java/org/apache/tamaya/core/internal/converters/CharConverter.java b/java7/core/src/main/java/org/apache/tamaya/core/internal/converters/CharConverter.java
index a2c718f..3e59cb8 100644
--- a/java7/core/src/main/java/org/apache/tamaya/core/internal/converters/CharConverter.java
+++ b/java7/core/src/main/java/org/apache/tamaya/core/internal/converters/CharConverter.java
@@ -24,7 +24,14 @@ import java.util.Objects;
import java.util.logging.Logger;
/**
- * Converter, converting from String to Character.
+ * Converter, converting from String to Character, the supported format is one of the following:
+ * <ul>
+ * <li>'a'</li>
+ * <li>123 (byte value)</li>
+ * <li>0xFF (byte value)</li>
+ * <li>0XDF (byte value)</li>
+ * <li>0D1 (byte value)</li>
+ * </ul>
*/
public class CharConverter implements PropertyConverter<Character>{
http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/6ad58f0b/java7/core/src/main/java/org/apache/tamaya/core/internal/converters/CurrencyConverter.java
----------------------------------------------------------------------
diff --git a/java7/core/src/main/java/org/apache/tamaya/core/internal/converters/CurrencyConverter.java b/java7/core/src/main/java/org/apache/tamaya/core/internal/converters/CurrencyConverter.java
index 4e3248d..cd4ab04 100644
--- a/java7/core/src/main/java/org/apache/tamaya/core/internal/converters/CurrencyConverter.java
+++ b/java7/core/src/main/java/org/apache/tamaya/core/internal/converters/CurrencyConverter.java
@@ -27,7 +27,13 @@ import java.util.logging.Level;
import java.util.logging.Logger;
/**
- * Converter, converting from String to Currency.
+ * Converter, converting from String to Currency, the supported format is one of the following:
+ * <ul>
+ * <li>CHF (currency code)</li>
+ * <li>123 (numeric currency value >= 0)</li>
+ * <li>DE (ISO 2-digit country)</li>
+ * <li>de_DE, de_DE_123 (Locale)</li>
+ * </ul>
*/
public class CurrencyConverter implements PropertyConverter<Currency> {
http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/6ad58f0b/java7/core/src/main/java/org/apache/tamaya/core/internal/converters/DoubleConverter.java
----------------------------------------------------------------------
diff --git a/java7/core/src/main/java/org/apache/tamaya/core/internal/converters/DoubleConverter.java b/java7/core/src/main/java/org/apache/tamaya/core/internal/converters/DoubleConverter.java
index eb74278..27f2cbd 100644
--- a/java7/core/src/main/java/org/apache/tamaya/core/internal/converters/DoubleConverter.java
+++ b/java7/core/src/main/java/org/apache/tamaya/core/internal/converters/DoubleConverter.java
@@ -28,18 +28,27 @@ import java.util.logging.Logger;
/**
* Converter, converting from String to Double, using the Java number syntax:
* (-)?[0-9]*\.[0-9]*. In case of error the value given also is tried being parsed as integral number using
- * {@link LongConverter}.
+ * {@link LongConverter}. Additionally the following values are supported:
+ * <ul>
+ * <li>NaN (ignoring case)</li>
+ * <li>POSITIVE_INFINITY (ignoring case)</li>
+ * <li>NEGATIVE_INFINITY (ignoring case)</li>
+ * </ul>
*/
-public class DoubleConverter implements PropertyConverter<Double>{
- /** The logger. */
+public class DoubleConverter implements PropertyConverter<Double> {
+ /**
+ * The logger.
+ */
private static final Logger LOG = Logger.getLogger(DoubleConverter.class.getName());
- /** The converter used, when floating point parse failed. */
+ /**
+ * The converter used, when floating point parse failed.
+ */
private LongConverter integerConverter = new LongConverter();
@Override
public Double convert(String value) {
String trimmed = Objects.requireNonNull(value).trim();
- switch(trimmed.toUpperCase(Locale.ENGLISH)){
+ switch (trimmed.toUpperCase(Locale.ENGLISH)) {
case "POSITIVE_INFINITY":
return Double.POSITIVE_INFINITY;
case "NEGATIVE_INFINITY":
@@ -55,14 +64,14 @@ public class DoubleConverter implements PropertyConverter<Double>{
default:
try {
return Double.valueOf(trimmed);
- } catch(Exception e){
+ } catch (Exception e) {
// OK perhaps we have an integral number that must be converted to the double type...
LOG.log(Level.FINER, "Parsing of double as floating number failed, trying parsing integral" +
" number instead...", e);
}
- try{
+ try {
return integerConverter.convert(trimmed).doubleValue();
- } catch(Exception e){
+ } catch (Exception e) {
LOG.log(Level.INFO, "Unexpected error from LongConverter for " + trimmed, e);
return null;
}
http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/6ad58f0b/java7/core/src/main/java/org/apache/tamaya/core/internal/converters/FloatConverter.java
----------------------------------------------------------------------
diff --git a/java7/core/src/main/java/org/apache/tamaya/core/internal/converters/FloatConverter.java b/java7/core/src/main/java/org/apache/tamaya/core/internal/converters/FloatConverter.java
index 918c9a9..c895634 100644
--- a/java7/core/src/main/java/org/apache/tamaya/core/internal/converters/FloatConverter.java
+++ b/java7/core/src/main/java/org/apache/tamaya/core/internal/converters/FloatConverter.java
@@ -28,7 +28,12 @@ import java.util.logging.Logger;
/**
* Converter, converting from String to Float, using the Java number syntax:
* (-)?[0-9]*\.[0-9]*. In case of error the value given also is tried being parsed as integral number using
- * {@link LongConverter}.
+ * {@link LongConverter}. Additionally the following values are supported:
+ * <ul>
+ * <li>NaN (ignoring case)</li>
+ * <li>POSITIVE_INFINITY (ignoring case)</li>
+ * <li>NEGATIVE_INFINITY (ignoring case)</li>
+ * </ul>
*/
public class FloatConverter implements PropertyConverter<Float> {
/**
http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/6ad58f0b/java7/core/src/main/java/org/apache/tamaya/core/internal/converters/IntegerConverter.java
----------------------------------------------------------------------
diff --git a/java7/core/src/main/java/org/apache/tamaya/core/internal/converters/IntegerConverter.java b/java7/core/src/main/java/org/apache/tamaya/core/internal/converters/IntegerConverter.java
index 94d3427..75bf838 100644
--- a/java7/core/src/main/java/org/apache/tamaya/core/internal/converters/IntegerConverter.java
+++ b/java7/core/src/main/java/org/apache/tamaya/core/internal/converters/IntegerConverter.java
@@ -24,7 +24,21 @@ import java.util.Locale;
import java.util.Objects;
/**
- * Converter, converting from String to Integer.
+ * Converter, converting from String to Integer, the supported format is one of the following:
+ * <ul>
+ * <li>123 (byte value)</li>
+ * <li>0xFF (byte value)</li>
+ * <li>0XDF (byte value)</li>
+ * <li>0D1 (byte value)</li>
+ * <li>-123 (byte value)</li>
+ * <li>-0xFF (byte value)</li>
+ * <li>-0XDF (byte value)</li>
+ * <li>-0D1 (byte value)</li>
+ * <li>MIN_VALUE (ignoring case)</li>
+ * <li>MIN (ignoring case)</li>
+ * <li>MAX_VALUE (ignoring case)</li>
+ * <li>MAX (ignoring case)</li>
+ * </ul>
*/
public class IntegerConverter implements PropertyConverter<Integer>{
http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/6ad58f0b/java7/core/src/main/java/org/apache/tamaya/core/internal/converters/LongConverter.java
----------------------------------------------------------------------
diff --git a/java7/core/src/main/java/org/apache/tamaya/core/internal/converters/LongConverter.java b/java7/core/src/main/java/org/apache/tamaya/core/internal/converters/LongConverter.java
index 673076f..1578254 100644
--- a/java7/core/src/main/java/org/apache/tamaya/core/internal/converters/LongConverter.java
+++ b/java7/core/src/main/java/org/apache/tamaya/core/internal/converters/LongConverter.java
@@ -24,7 +24,21 @@ import java.util.Locale;
import java.util.Objects;
/**
- * Converter, converting from String to Long.
+ * Converter, converting from String to Long, the supported format is one of the following:
+ * <ul>
+ * <li>123 (byte value)</li>
+ * <li>0xFF (byte value)</li>
+ * <li>0XDF (byte value)</li>
+ * <li>0D1 (byte value)</li>
+ * <li>-123 (byte value)</li>
+ * <li>-0xFF (byte value)</li>
+ * <li>-0XDF (byte value)</li>
+ * <li>-0D1 (byte value)</li>
+ * <li>MIN_VALUE (ignoring case)</li>
+ * <li>MIN (ignoring case)</li>
+ * <li>MAX_VALUE (ignoring case)</li>
+ * <li>MAX (ignoring case)</li>
+ * </ul>
*/
public class LongConverter implements PropertyConverter<Long>{
http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/6ad58f0b/java7/core/src/main/java/org/apache/tamaya/core/internal/converters/ShortConverter.java
----------------------------------------------------------------------
diff --git a/java7/core/src/main/java/org/apache/tamaya/core/internal/converters/ShortConverter.java b/java7/core/src/main/java/org/apache/tamaya/core/internal/converters/ShortConverter.java
index f9ae732..6495ccd 100644
--- a/java7/core/src/main/java/org/apache/tamaya/core/internal/converters/ShortConverter.java
+++ b/java7/core/src/main/java/org/apache/tamaya/core/internal/converters/ShortConverter.java
@@ -24,7 +24,21 @@ import java.util.Locale;
import java.util.Objects;
/**
- * Converter, converting from String to Short.
+ * Converter, converting from String to Short, the supported format is one of the following:
+ * <ul>
+ * <li>123 (byte value)</li>
+ * <li>0xFF (byte value)</li>
+ * <li>0XDF (byte value)</li>
+ * <li>0D1 (byte value)</li>
+ * <li>-123 (byte value)</li>
+ * <li>-0xFF (byte value)</li>
+ * <li>-0XDF (byte value)</li>
+ * <li>-0D1 (byte value)</li>
+ * <li>MIN_VALUE (ignoring case)</li>
+ * <li>MIN (ignoring case)</li>
+ * <li>MAX_VALUE (ignoring case)</li>
+ * <li>MAX (ignoring case)</li>
+ * </ul>
*/
public class ShortConverter implements PropertyConverter<Short>{
http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/6ad58f0b/java8/core/src/main/java/org/apache/tamaya/core/internal/converters/BooleanConverter.java
----------------------------------------------------------------------
diff --git a/java8/core/src/main/java/org/apache/tamaya/core/internal/converters/BooleanConverter.java b/java8/core/src/main/java/org/apache/tamaya/core/internal/converters/BooleanConverter.java
index 7ff8406..8c935b0 100644
--- a/java8/core/src/main/java/org/apache/tamaya/core/internal/converters/BooleanConverter.java
+++ b/java8/core/src/main/java/org/apache/tamaya/core/internal/converters/BooleanConverter.java
@@ -26,7 +26,15 @@ import java.util.Objects;
import java.util.logging.Logger;
/**
- * Converter, converting from String to Boolean.
+ * Converter, converting from String to Boolean, the supported format is one of the following:
+ * <ul>
+ * <li>true</li>
+ * <li>t</li>
+ * <li>yes</li>
+ * <li>y</li>
+ * <li>1</li>
+ * <li>0</li>
+ * </ul>
*/
public class BooleanConverter implements PropertyConverter<Boolean> {
@@ -44,11 +52,13 @@ public class BooleanConverter implements PropertyConverter<Boolean> {
case "y":
case "true":
case "t":
+ case "1":
return Boolean.TRUE;
case "no":
case "n":
case "false":
case "f":
+ case "0":
return Boolean.FALSE;
default:
LOG.warning("Unknown boolean value encountered: " + value);
http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/6ad58f0b/java8/core/src/main/java/org/apache/tamaya/core/internal/converters/ByteConverter.java
----------------------------------------------------------------------
diff --git a/java8/core/src/main/java/org/apache/tamaya/core/internal/converters/ByteConverter.java b/java8/core/src/main/java/org/apache/tamaya/core/internal/converters/ByteConverter.java
index d280746..f485c06 100644
--- a/java8/core/src/main/java/org/apache/tamaya/core/internal/converters/ByteConverter.java
+++ b/java8/core/src/main/java/org/apache/tamaya/core/internal/converters/ByteConverter.java
@@ -24,7 +24,14 @@ import java.util.Locale;
import java.util.Objects;
/**
- * Converter, converting from String to Byte.
+ * Converter, converting from String to Byte, the supported format is one of the following:
+ * <ul>
+ * <li>0xFF</li>
+ * <li>0XFF</li>
+ * <li>45</li>
+ * <li>-34</li>
+ * <li>0D1</li>
+ * </ul>
*/
public class ByteConverter implements PropertyConverter<Byte>{
http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/6ad58f0b/java8/core/src/main/java/org/apache/tamaya/core/internal/converters/CharConverter.java
----------------------------------------------------------------------
diff --git a/java8/core/src/main/java/org/apache/tamaya/core/internal/converters/CharConverter.java b/java8/core/src/main/java/org/apache/tamaya/core/internal/converters/CharConverter.java
index 5dfea5b..c3e3004 100644
--- a/java8/core/src/main/java/org/apache/tamaya/core/internal/converters/CharConverter.java
+++ b/java8/core/src/main/java/org/apache/tamaya/core/internal/converters/CharConverter.java
@@ -24,7 +24,14 @@ import java.util.Objects;
import java.util.logging.Logger;
/**
- * Converter, converting from String to Character.
+ * Converter, converting from String to Character, the supported format is one of the following:
+ * <ul>
+ * <li>'a'</li>
+ * <li>123 (byte value)</li>
+ * <li>0xFF (byte value)</li>
+ * <li>0XDF (byte value)</li>
+ * <li>0D1 (byte value)</li>
+ * </ul>
*/
public class CharConverter implements PropertyConverter<Character>{
@@ -49,7 +56,7 @@ public class CharConverter implements PropertyConverter<Character>{
}
}
try {
- Integer val = Integer.parseInt(trimmed);
+ Integer val = Integer.decode(trimmed);
return (char) val.shortValue();
} catch (Exception e) {
LOG.finest("Character format is not numeric: '" + value + "', using first character.");
http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/6ad58f0b/java8/core/src/main/java/org/apache/tamaya/core/internal/converters/IntegerConverter.java
----------------------------------------------------------------------
diff --git a/java8/core/src/main/java/org/apache/tamaya/core/internal/converters/IntegerConverter.java b/java8/core/src/main/java/org/apache/tamaya/core/internal/converters/IntegerConverter.java
index 10bed68..0a20e63 100644
--- a/java8/core/src/main/java/org/apache/tamaya/core/internal/converters/IntegerConverter.java
+++ b/java8/core/src/main/java/org/apache/tamaya/core/internal/converters/IntegerConverter.java
@@ -24,7 +24,21 @@ import java.util.Locale;
import java.util.Objects;
/**
- * Converter, converting from String to Integer.
+ * Converter, converting from String to Integer, the supported format is one of the following:
+ * <ul>
+ * <li>123 (byte value)</li>
+ * <li>0xFF (byte value)</li>
+ * <li>0XDF (byte value)</li>
+ * <li>0D1 (byte value)</li>
+ * <li>-123 (byte value)</li>
+ * <li>-0xFF (byte value)</li>
+ * <li>-0XDF (byte value)</li>
+ * <li>-0D1 (byte value)</li>
+ * <li>MIN_VALUE (ignoring case)</li>
+ * <li>MIN (ignoring case)</li>
+ * <li>MAX_VALUE (ignoring case)</li>
+ * <li>MAX (ignoring case)</li>
+ * </ul>
*/
public class IntegerConverter implements PropertyConverter<Integer>{
http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/6ad58f0b/java8/core/src/main/java/org/apache/tamaya/core/internal/converters/LongConverter.java
----------------------------------------------------------------------
diff --git a/java8/core/src/main/java/org/apache/tamaya/core/internal/converters/LongConverter.java b/java8/core/src/main/java/org/apache/tamaya/core/internal/converters/LongConverter.java
index 91af6fe..b1ca144 100644
--- a/java8/core/src/main/java/org/apache/tamaya/core/internal/converters/LongConverter.java
+++ b/java8/core/src/main/java/org/apache/tamaya/core/internal/converters/LongConverter.java
@@ -24,7 +24,21 @@ import java.util.Locale;
import java.util.Objects;
/**
- * Converter, converting from String to Long.
+ * Converter, converting from String to Long, the supported format is one of the following:
+ * <ul>
+ * <li>123 (byte value)</li>
+ * <li>0xFF (byte value)</li>
+ * <li>0XDF (byte value)</li>
+ * <li>0D1 (byte value)</li>
+ * <li>-123 (byte value)</li>
+ * <li>-0xFF (byte value)</li>
+ * <li>-0XDF (byte value)</li>
+ * <li>-0D1 (byte value)</li>
+ * <li>MIN_VALUE (ignoring case)</li>
+ * <li>MIN (ignoring case)</li>
+ * <li>MAX_VALUE (ignoring case)</li>
+ * <li>MAX (ignoring case)</li>
+ * </ul>
*/
public class LongConverter implements PropertyConverter<Long>{
http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/6ad58f0b/java8/core/src/main/java/org/apache/tamaya/core/internal/converters/ShortConverter.java
----------------------------------------------------------------------
diff --git a/java8/core/src/main/java/org/apache/tamaya/core/internal/converters/ShortConverter.java b/java8/core/src/main/java/org/apache/tamaya/core/internal/converters/ShortConverter.java
index f9ae732..6495ccd 100644
--- a/java8/core/src/main/java/org/apache/tamaya/core/internal/converters/ShortConverter.java
+++ b/java8/core/src/main/java/org/apache/tamaya/core/internal/converters/ShortConverter.java
@@ -24,7 +24,21 @@ import java.util.Locale;
import java.util.Objects;
/**
- * Converter, converting from String to Short.
+ * Converter, converting from String to Short, the supported format is one of the following:
+ * <ul>
+ * <li>123 (byte value)</li>
+ * <li>0xFF (byte value)</li>
+ * <li>0XDF (byte value)</li>
+ * <li>0D1 (byte value)</li>
+ * <li>-123 (byte value)</li>
+ * <li>-0xFF (byte value)</li>
+ * <li>-0XDF (byte value)</li>
+ * <li>-0D1 (byte value)</li>
+ * <li>MIN_VALUE (ignoring case)</li>
+ * <li>MIN (ignoring case)</li>
+ * <li>MAX_VALUE (ignoring case)</li>
+ * <li>MAX (ignoring case)</li>
+ * </ul>
*/
public class ShortConverter implements PropertyConverter<Short>{