Repository: incubator-tamaya Updated Branches: refs/heads/master 3ca337ebe -> d1e3d0220
Improved/calirified Javadoc. Project: http://git-wip-us.apache.org/repos/asf/incubator-tamaya/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-tamaya/commit/abbf0b5d Tree: http://git-wip-us.apache.org/repos/asf/incubator-tamaya/tree/abbf0b5d Diff: http://git-wip-us.apache.org/repos/asf/incubator-tamaya/diff/abbf0b5d Branch: refs/heads/master Commit: abbf0b5d7223317274ad8a834f0bdd010bce6bde Parents: 806bc09 Author: anatole <[email protected]> Authored: Wed Jan 21 22:22:37 2015 +0100 Committer: anatole <[email protected]> Committed: Wed Jan 21 22:22:37 2015 +0100 ---------------------------------------------------------------------- .../main/java/org/apache/tamaya/spi/PropertyConverter.java | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/abbf0b5d/java8/api/src/main/java/org/apache/tamaya/spi/PropertyConverter.java ---------------------------------------------------------------------- diff --git a/java8/api/src/main/java/org/apache/tamaya/spi/PropertyConverter.java b/java8/api/src/main/java/org/apache/tamaya/spi/PropertyConverter.java index a492424..235eebc 100644 --- a/java8/api/src/main/java/org/apache/tamaya/spi/PropertyConverter.java +++ b/java8/api/src/main/java/org/apache/tamaya/spi/PropertyConverter.java @@ -28,9 +28,14 @@ public interface PropertyConverter<T> { /** * Convert the given configuration keys from it's String representation into the required target type. + * <b>IMPORTANT NOTE: </b> Multiple instances of this type are ordered in a chain of converters that + * try to parse/convert a configured value. The first non-null result returned by a converter is + * used as the final result of the conversion. As a consequence implementations of this class must + * only return non-null values that are the result of a successful conversion of an entry. * * @param value the configuration value - * @return the converted value + * @return the converted value, or {@code null} if the value could not be converted. Returning a non-null + * value will stop the conversion process and return the value as result (converted value). */ T convert(String value);
