This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-configuration.git
The following commit(s) were added to refs/heads/master by this push: new 64a4a812 No need for blank Javadoc lines between Javadoc @ tags 64a4a812 is described below commit 64a4a812441cd69bb933ffb7ec365f5fb8091a09 Author: Gary Gregory <garydgreg...@gmail.com> AuthorDate: Thu Nov 28 12:29:01 2024 -0500 No need for blank Javadoc lines between Javadoc @ tags --- .../configuration2/AbstractConfiguration.java | 5 -- .../commons/configuration2/BaseConfiguration.java | 2 - .../configuration2/CompositeConfiguration.java | 1 - .../commons/configuration2/Configuration.java | 1 - .../commons/configuration2/DataConfiguration.java | 83 ---------------------- .../configuration2/ImmutableConfiguration.java | 23 ------ .../commons/configuration2/JNDIConfiguration.java | 1 - .../configuration2/PropertiesConfiguration.java | 3 - .../configuration2/convert/PropertyConverter.java | 3 - .../commons/configuration2/io/FileSystem.java | 1 - .../commons/configuration2/tree/ImmutableNode.java | 1 - 11 files changed, 124 deletions(-) diff --git a/src/main/java/org/apache/commons/configuration2/AbstractConfiguration.java b/src/main/java/org/apache/commons/configuration2/AbstractConfiguration.java index 1992b13c..89600a74 100644 --- a/src/main/java/org/apache/commons/configuration2/AbstractConfiguration.java +++ b/src/main/java/org/apache/commons/configuration2/AbstractConfiguration.java @@ -1032,11 +1032,8 @@ public abstract class AbstractConfiguration extends BaseEventSource implements C * * @param key The configuration key. * @param defaults Any default values for the returned {@code Properties} object. Ignored if {@code null}. - * * @return The associated properties if key is found. - * * @throws ConversionException is thrown if the key maps to an object that is not a String/List of Strings. - * * @throws IllegalArgumentException if one of the tokens is malformed (does not contain an equals sign). */ public Properties getProperties(final String key, final Properties defaults) { @@ -1125,7 +1122,6 @@ public abstract class AbstractConfiguration extends BaseEventSource implements C * * @param key The configuration key. * @return The associated string array if key is found. - * * @throws ConversionException is thrown if the key maps to an object that is not a String/List of Strings. * @see #setListDelimiterHandler(ListDelimiterHandler) */ @@ -1204,7 +1200,6 @@ public abstract class AbstractConfiguration extends BaseEventSource implements C * interpolate key names to handle ${key} stuff * * @param base string to interpolate - * * @return returns the key name with the ${key} substituted */ protected String interpolate(final String base) { diff --git a/src/main/java/org/apache/commons/configuration2/BaseConfiguration.java b/src/main/java/org/apache/commons/configuration2/BaseConfiguration.java index 16122c15..1a0405a0 100644 --- a/src/main/java/org/apache/commons/configuration2/BaseConfiguration.java +++ b/src/main/java/org/apache/commons/configuration2/BaseConfiguration.java @@ -128,7 +128,6 @@ public class BaseConfiguration extends AbstractConfiguration implements Cloneabl * check if the configuration contains the key * * @param key the configuration key - * * @return {@code true} if Configuration contain given key, {@code false} otherwise. */ @Override @@ -160,7 +159,6 @@ public class BaseConfiguration extends AbstractConfiguration implements Cloneabl * Read property from underlying map. * * @param key key to use for mapping - * * @return object associated with the given configuration key. */ @Override diff --git a/src/main/java/org/apache/commons/configuration2/CompositeConfiguration.java b/src/main/java/org/apache/commons/configuration2/CompositeConfiguration.java index b349e7be..902d062f 100644 --- a/src/main/java/org/apache/commons/configuration2/CompositeConfiguration.java +++ b/src/main/java/org/apache/commons/configuration2/CompositeConfiguration.java @@ -383,7 +383,6 @@ public class CompositeConfiguration extends AbstractConfiguration implements Clo * Read property from underlying composite * * @param key key to use for mapping - * * @return object associated with the given configuration key. */ @Override diff --git a/src/main/java/org/apache/commons/configuration2/Configuration.java b/src/main/java/org/apache/commons/configuration2/Configuration.java index 18dbf6e9..56877cd6 100644 --- a/src/main/java/org/apache/commons/configuration2/Configuration.java +++ b/src/main/java/org/apache/commons/configuration2/Configuration.java @@ -156,7 +156,6 @@ public interface Configuration extends ImmutableConfiguration, SynchronizerSuppo * * @param prefix The prefix used to select the properties. * @return a subset configuration - * * @see SubsetConfiguration */ Configuration subset(String prefix); diff --git a/src/main/java/org/apache/commons/configuration2/DataConfiguration.java b/src/main/java/org/apache/commons/configuration2/DataConfiguration.java index 3c8622b4..81f258e7 100644 --- a/src/main/java/org/apache/commons/configuration2/DataConfiguration.java +++ b/src/main/java/org/apache/commons/configuration2/DataConfiguration.java @@ -229,7 +229,6 @@ public class DataConfiguration extends AbstractConfiguration { * * @param key The configuration key. * @return The associated BigDecimal array if the key is found. - * * @throws ConversionException is thrown if the key maps to an object that is not a list of BigDecimals. */ public BigDecimal[] getBigDecimalArray(final String key) { @@ -243,7 +242,6 @@ public class DataConfiguration extends AbstractConfiguration { * @param key The configuration key. * @param defaultValue the default value, which will be returned if the property is not found * @return The associated BigDecimal array if the key is found. - * * @throws ConversionException is thrown if the key maps to an object that is not a list of BigDecimals. */ public BigDecimal[] getBigDecimalArray(final String key, final BigDecimal... defaultValue) { @@ -256,7 +254,6 @@ public class DataConfiguration extends AbstractConfiguration { * * @param key The configuration key. * @return The associated BigDecimal list if the key is found. - * * @throws ConversionException is thrown if the key maps to an object that is not a list of BigDecimals. */ public List<BigDecimal> getBigDecimalList(final String key) { @@ -270,7 +267,6 @@ public class DataConfiguration extends AbstractConfiguration { * @param key The configuration key. * @param defaultValue The default value. * @return The associated List of BigDecimals. - * * @throws ConversionException is thrown if the key maps to an object that is not a list of BigDecimals. */ public List<BigDecimal> getBigDecimalList(final String key, final List<BigDecimal> defaultValue) { @@ -283,7 +279,6 @@ public class DataConfiguration extends AbstractConfiguration { * * @param key The configuration key. * @return The associated BigInteger array if the key is found. - * * @throws ConversionException is thrown if the key maps to an object that is not a list of BigIntegers. */ public BigInteger[] getBigIntegerArray(final String key) { @@ -297,7 +292,6 @@ public class DataConfiguration extends AbstractConfiguration { * @param key The configuration key. * @param defaultValue the default value, which will be returned if the property is not found * @return The associated BigInteger array if the key is found. - * * @throws ConversionException is thrown if the key maps to an object that is not a list of BigIntegers. */ public BigInteger[] getBigIntegerArray(final String key, final BigInteger... defaultValue) { @@ -310,7 +304,6 @@ public class DataConfiguration extends AbstractConfiguration { * * @param key The configuration key. * @return The associated BigInteger list if the key is found. - * * @throws ConversionException is thrown if the key maps to an object that is not a list of BigIntegers. */ public List<BigInteger> getBigIntegerList(final String key) { @@ -324,7 +317,6 @@ public class DataConfiguration extends AbstractConfiguration { * @param key The configuration key. * @param defaultValue The default value. * @return The associated List of BigIntegers. - * * @throws ConversionException is thrown if the key maps to an object that is not a list of BigIntegers. */ public List<BigInteger> getBigIntegerList(final String key, final List<BigInteger> defaultValue) { @@ -337,7 +329,6 @@ public class DataConfiguration extends AbstractConfiguration { * * @param key The configuration key. * @return The associated boolean array if the key is found. - * * @throws ConversionException is thrown if the key maps to an object that is not a list of booleans. */ public boolean[] getBooleanArray(final String key) { @@ -351,7 +342,6 @@ public class DataConfiguration extends AbstractConfiguration { * @param key The configuration key. * @param defaultValue The default value. * @return The associated boolean array if the key is found. - * * @throws ConversionException is thrown if the key maps to an object that is not a list of booleans. */ public boolean[] getBooleanArray(final String key, final boolean... defaultValue) { @@ -364,7 +354,6 @@ public class DataConfiguration extends AbstractConfiguration { * * @param key The configuration key. * @return The associated Boolean list if the key is found. - * * @throws ConversionException is thrown if the key maps to an object that is not a list of booleans. */ public List<Boolean> getBooleanList(final String key) { @@ -378,7 +367,6 @@ public class DataConfiguration extends AbstractConfiguration { * @param key The configuration key. * @param defaultValue The default value. * @return The associated List of Booleans. - * * @throws ConversionException is thrown if the key maps to an object that is not a list of booleans. */ public List<Boolean> getBooleanList(final String key, final List<Boolean> defaultValue) { @@ -391,7 +379,6 @@ public class DataConfiguration extends AbstractConfiguration { * * @param key The configuration key. * @return The associated byte array if the key is found. - * * @throws ConversionException is thrown if the key maps to an object that is not a list of bytes. */ public byte[] getByteArray(final String key) { @@ -405,7 +392,6 @@ public class DataConfiguration extends AbstractConfiguration { * @param key The configuration key. * @param defaultValue the default value, which will be returned if the property is not found * @return The associated byte array if the key is found. - * * @throws ConversionException is thrown if the key maps to an object that is not a list of bytes. */ public byte[] getByteArray(final String key, final byte... defaultValue) { @@ -418,7 +404,6 @@ public class DataConfiguration extends AbstractConfiguration { * * @param key The configuration key. * @return The associated Byte list if the key is found. - * * @throws ConversionException is thrown if the key maps to an object that is not a list of bytes. */ public List<Byte> getByteList(final String key) { @@ -432,7 +417,6 @@ public class DataConfiguration extends AbstractConfiguration { * @param key The configuration key. * @param defaultValue The default value. * @return The associated List of Bytes. - * * @throws ConversionException is thrown if the key maps to an object that is not a list of bytes. */ public List<Byte> getByteList(final String key, final List<Byte> defaultValue) { @@ -446,7 +430,6 @@ public class DataConfiguration extends AbstractConfiguration { * * @param key The configuration key. * @return The associated Calendar. - * * @throws ConversionException is thrown if the key maps to an object that is not a Calendar. */ public Calendar getCalendar(final String key) { @@ -461,7 +444,6 @@ public class DataConfiguration extends AbstractConfiguration { * @param key The configuration key. * @param defaultValue The default value. * @return The associated Calendar. - * * @throws ConversionException is thrown if the key maps to an object that is not a Calendar. */ public Calendar getCalendar(final String key, final Calendar defaultValue) { @@ -476,7 +458,6 @@ public class DataConfiguration extends AbstractConfiguration { * @param defaultValue The default value. * @param format The non-localized {@link java.text.DateFormat} pattern. * @return The associated Calendar. - * * @throws ConversionException is thrown if the key maps to an object that is not a Calendar. */ public Calendar getCalendar(final String key, final Calendar defaultValue, final String format) { @@ -490,7 +471,6 @@ public class DataConfiguration extends AbstractConfiguration { * @param key The configuration key. * @param format The non-localized {@link java.text.DateFormat} pattern. * @return The associated Calendar - * * @throws ConversionException is thrown if the key maps to an object that is not a Calendar. */ public Calendar getCalendar(final String key, final String format) { @@ -512,7 +492,6 @@ public class DataConfiguration extends AbstractConfiguration { * * @param key The configuration key. * @return The associated Calendar array if the key is found. - * * @throws ConversionException is thrown if the key maps to an object that is not a list of Calendars. */ public Calendar[] getCalendarArray(final String key) { @@ -528,7 +507,6 @@ public class DataConfiguration extends AbstractConfiguration { * @param key The configuration key. * @param defaultValue the default value, which will be returned if the property is not found * @return The associated Calendar array if the key is found. - * * @throws ConversionException is thrown if the key maps to an object that is not a list of Calendars. */ public Calendar[] getCalendarArray(final String key, final Calendar... defaultValue) { @@ -544,7 +522,6 @@ public class DataConfiguration extends AbstractConfiguration { * @param defaultValue The default value. * @param format The non-localized {@link java.text.DateFormat} pattern. * @return The associated Calendar array if the key is found. - * * @throws ConversionException is thrown if the key maps to an object that is not a list of Calendars. */ public Calendar[] getCalendarArray(final String key, final Calendar[] defaultValue, final String format) { @@ -559,7 +536,6 @@ public class DataConfiguration extends AbstractConfiguration { * @param key The configuration key. * @param format The non-localized {@link java.text.DateFormat} pattern. * @return The associated Calendar array if the key is found. - * * @throws ConversionException is thrown if the key maps to an object that is not a list of Calendars. */ public Calendar[] getCalendarArray(final String key, final String format) { @@ -573,7 +549,6 @@ public class DataConfiguration extends AbstractConfiguration { * * @param key The configuration key. * @return The associated Calendar list if the key is found. - * * @throws ConversionException is thrown if the key maps to an object that is not a list of Calendars. */ public List<Calendar> getCalendarList(final String key) { @@ -589,7 +564,6 @@ public class DataConfiguration extends AbstractConfiguration { * @param key The configuration key. * @param defaultValue The default value. * @return The associated Calendar list if the key is found. - * * @throws ConversionException is thrown if the key maps to an object that is not a list of Calendars. */ public List<Calendar> getCalendarList(final String key, final List<Calendar> defaultValue) { @@ -605,7 +579,6 @@ public class DataConfiguration extends AbstractConfiguration { * @param defaultValue The default value. * @param format The non-localized {@link java.text.DateFormat} pattern. * @return The associated Calendar list if the key is found. - * * @throws ConversionException is thrown if the key maps to an object that is not a list of Calendars. */ public List<Calendar> getCalendarList(final String key, final List<Calendar> defaultValue, final String format) { @@ -619,7 +592,6 @@ public class DataConfiguration extends AbstractConfiguration { * @param key The configuration key. * @param format The non-localized {@link java.text.DateFormat} pattern. * @return The associated Calendar list if the key is found. - * * @throws ConversionException is thrown if the key maps to an object that is not a list of Calendars. */ public List<Calendar> getCalendarList(final String key, final String format) { @@ -631,7 +603,6 @@ public class DataConfiguration extends AbstractConfiguration { * * @param key The configuration key. * @return The associated Color. - * * @throws ConversionException is thrown if the key maps to an object that is not a Color. */ public Color getColor(final String key) { @@ -645,7 +616,6 @@ public class DataConfiguration extends AbstractConfiguration { * @param key The configuration key. * @param defaultValue The default value. * @return The associated Color. - * * @throws ConversionException is thrown if the key maps to an object that is not a Color. */ public Color getColor(final String key, final Color defaultValue) { @@ -658,7 +628,6 @@ public class DataConfiguration extends AbstractConfiguration { * * @param key The configuration key. * @return The associated Color array if the key is found. - * * @throws ConversionException is thrown if the key maps to an object that is not a list of Colors. */ public Color[] getColorArray(final String key) { @@ -672,7 +641,6 @@ public class DataConfiguration extends AbstractConfiguration { * @param key The configuration key. * @param defaultValue the default value, which will be returned if the property is not found * @return The associated Color array if the key is found. - * * @throws ConversionException is thrown if the key maps to an object that is not a list of Colors. */ public Color[] getColorArray(final String key, final Color... defaultValue) { @@ -685,7 +653,6 @@ public class DataConfiguration extends AbstractConfiguration { * * @param key The configuration key. * @return The associated Color list if the key is found. - * * @throws ConversionException is thrown if the key maps to an object that is not a list of Colors. */ public List<Color> getColorList(final String key) { @@ -699,7 +666,6 @@ public class DataConfiguration extends AbstractConfiguration { * @param key The configuration key. * @param defaultValue The default value. * @return The associated List of Colors. - * * @throws ConversionException is thrown if the key maps to an object that is not a list of Colors. */ public List<Color> getColorList(final String key, final List<Color> defaultValue) { @@ -730,7 +696,6 @@ public class DataConfiguration extends AbstractConfiguration { * * @param key The configuration key. * @return The associated Date. - * * @throws ConversionException is thrown if the key maps to an object that is not a Date. */ public Date getDate(final String key) { @@ -745,7 +710,6 @@ public class DataConfiguration extends AbstractConfiguration { * @param key The configuration key. * @param defaultValue The default value. * @return The associated Date. - * * @throws ConversionException is thrown if the key maps to an object that is not a Date. */ public Date getDate(final String key, final Date defaultValue) { @@ -760,7 +724,6 @@ public class DataConfiguration extends AbstractConfiguration { * @param defaultValue The default value. * @param format The non-localized {@link java.text.DateFormat} pattern. * @return The associated Date. - * * @throws ConversionException is thrown if the key maps to an object that is not a Date. */ public Date getDate(final String key, final Date defaultValue, final String format) { @@ -774,7 +737,6 @@ public class DataConfiguration extends AbstractConfiguration { * @param key The configuration key. * @param format The non-localized {@link java.text.DateFormat} pattern. * @return The associated Date - * * @throws ConversionException is thrown if the key maps to an object that is not a Date. */ public Date getDate(final String key, final String format) { @@ -795,7 +757,6 @@ public class DataConfiguration extends AbstractConfiguration { * * @param key The configuration key. * @return The associated Date array if the key is found. - * * @throws ConversionException is thrown if the key maps to an object that is not a list of Dates. */ public Date[] getDateArray(final String key) { @@ -810,7 +771,6 @@ public class DataConfiguration extends AbstractConfiguration { * @param key The configuration key. * @param defaultValue the default value, which will be returned if the property is not found * @return The associated Date array if the key is found. - * * @throws ConversionException is thrown if the key maps to an object that is not a list of Dates. */ public Date[] getDateArray(final String key, final Date... defaultValue) { @@ -826,7 +786,6 @@ public class DataConfiguration extends AbstractConfiguration { * @param defaultValue The default value. * @param format The non-localized {@link java.text.DateFormat} pattern. * @return The associated Date array if the key is found. - * * @throws ConversionException is thrown if the key maps to an object that is not a list of Dates. */ public Date[] getDateArray(final String key, final Date[] defaultValue, final String format) { @@ -840,7 +799,6 @@ public class DataConfiguration extends AbstractConfiguration { * @param key The configuration key. * @param format The non-localized {@link java.text.DateFormat} pattern. * @return The associated Date array if the key is found. - * * @throws ConversionException is thrown if the key maps to an object that is not a list of Dates. */ public Date[] getDateArray(final String key, final String format) { @@ -859,7 +817,6 @@ public class DataConfiguration extends AbstractConfiguration { * @param key The configuration key. * @param defaultValue The default value. * @return The associated Date list if the key is found. - * * @throws ConversionException is thrown if the key maps to an object that is not a list of Dates. */ public List<Date> getDateList(final String key, final List<Date> defaultValue) { @@ -875,7 +832,6 @@ public class DataConfiguration extends AbstractConfiguration { * @param defaultValue The default value. * @param format The non-localized {@link java.text.DateFormat} pattern. * @return The associated Date list if the key is found. - * * @throws ConversionException is thrown if the key maps to an object that is not a list of Dates. */ public List<Date> getDateList(final String key, final List<Date> defaultValue, final String format) { @@ -889,7 +845,6 @@ public class DataConfiguration extends AbstractConfiguration { * @param key The configuration key. * @param format The non-localized {@link java.text.DateFormat} pattern. * @return The associated Date list if the key is found. - * * @throws ConversionException is thrown if the key maps to an object that is not a list of Dates. */ public List<Date> getDateList(final String key, final String format) { @@ -911,7 +866,6 @@ public class DataConfiguration extends AbstractConfiguration { * * @param key The configuration key. * @return The associated double array if the key is found. - * * @throws ConversionException is thrown if the key maps to an object that is not a list of doubles. */ public double[] getDoubleArray(final String key) { @@ -925,7 +879,6 @@ public class DataConfiguration extends AbstractConfiguration { * @param key The configuration key. * @param defaultValue the default value, which will be returned if the property is not found * @return The associated double array if the key is found. - * * @throws ConversionException is thrown if the key maps to an object that is not a list of doubles. */ public double[] getDoubleArray(final String key, final double... defaultValue) { @@ -938,7 +891,6 @@ public class DataConfiguration extends AbstractConfiguration { * * @param key The configuration key. * @return The associated Double list if the key is found. - * * @throws ConversionException is thrown if the key maps to an object that is not a list of doubles. */ public List<Double> getDoubleList(final String key) { @@ -952,7 +904,6 @@ public class DataConfiguration extends AbstractConfiguration { * @param key The configuration key. * @param defaultValue The default value. * @return The associated List of Doubles. - * * @throws ConversionException is thrown if the key maps to an object that is not a list of doubles. */ public List<Double> getDoubleList(final String key, final List<Double> defaultValue) { @@ -965,7 +916,6 @@ public class DataConfiguration extends AbstractConfiguration { * * @param key The configuration key. * @return The associated float array if the key is found. - * * @throws ConversionException is thrown if the key maps to an object that is not a list of floats. */ public float[] getFloatArray(final String key) { @@ -979,7 +929,6 @@ public class DataConfiguration extends AbstractConfiguration { * @param key The configuration key. * @param defaultValue the default value, which will be returned if the property is not found * @return The associated float array if the key is found. - * * @throws ConversionException is thrown if the key maps to an object that is not a list of floats. */ public float[] getFloatArray(final String key, final float... defaultValue) { @@ -992,7 +941,6 @@ public class DataConfiguration extends AbstractConfiguration { * * @param key The configuration key. * @return The associated Float list if the key is found. - * * @throws ConversionException is thrown if the key maps to an object that is not a list of floats. */ public List<Float> getFloatList(final String key) { @@ -1006,7 +954,6 @@ public class DataConfiguration extends AbstractConfiguration { * @param key The configuration key. * @param defaultValue The default value. * @return The associated List of Floats. - * * @throws ConversionException is thrown if the key maps to an object that is not a list of floats. */ public List<Float> getFloatList(final String key, final List<Float> defaultValue) { @@ -1019,7 +966,6 @@ public class DataConfiguration extends AbstractConfiguration { * * @param key The configuration key. * @return The associated int array if the key is found. - * * @throws ConversionException is thrown if the key maps to an object that is not a list of integers. */ public int[] getIntArray(final String key) { @@ -1033,7 +979,6 @@ public class DataConfiguration extends AbstractConfiguration { * @param key The configuration key. * @param defaultValue the default value, which will be returned if the property is not found * @return The associated int array if the key is found. - * * @throws ConversionException is thrown if the key maps to an object that is not a list of integers. */ public int[] getIntArray(final String key, final int... defaultValue) { @@ -1046,7 +991,6 @@ public class DataConfiguration extends AbstractConfiguration { * * @param key The configuration key. * @return The associated Integer list if the key is found. - * * @throws ConversionException is thrown if the key maps to an object that is not a list of integers. */ public List<Integer> getIntegerList(final String key) { @@ -1060,7 +1004,6 @@ public class DataConfiguration extends AbstractConfiguration { * @param key The configuration key. * @param defaultValue The default value. * @return The associated List of Integers. - * * @throws ConversionException is thrown if the key maps to an object that is not a list of integers. */ public List<Integer> getIntegerList(final String key, final List<Integer> defaultValue) { @@ -1077,7 +1020,6 @@ public class DataConfiguration extends AbstractConfiguration { * * @param key The configuration key. * @return The associated Locale. - * * @throws ConversionException is thrown if the key maps to an object that is not a Locale. */ public Locale getLocale(final String key) { @@ -1091,7 +1033,6 @@ public class DataConfiguration extends AbstractConfiguration { * @param key The configuration key. * @param defaultValue The default value. * @return The associated Locale. - * * @throws ConversionException is thrown if the key maps to an object that is not a Locale. */ public Locale getLocale(final String key, final Locale defaultValue) { @@ -1104,7 +1045,6 @@ public class DataConfiguration extends AbstractConfiguration { * * @param key The configuration key. * @return The associated Locale array if the key is found. - * * @throws ConversionException is thrown if the key maps to an object that is not a list of Locales. */ public Locale[] getLocaleArray(final String key) { @@ -1118,7 +1058,6 @@ public class DataConfiguration extends AbstractConfiguration { * @param key The configuration key. * @param defaultValue the default value, which will be returned if the property is not found * @return The associated Locale array if the key is found. - * * @throws ConversionException is thrown if the key maps to an object that is not a list of Locales. */ public Locale[] getLocaleArray(final String key, final Locale... defaultValue) { @@ -1131,7 +1070,6 @@ public class DataConfiguration extends AbstractConfiguration { * * @param key The configuration key. * @return The associated Locale list if the key is found. - * * @throws ConversionException is thrown if the key maps to an object that is not a list of Locales. */ public List<Locale> getLocaleList(final String key) { @@ -1145,7 +1083,6 @@ public class DataConfiguration extends AbstractConfiguration { * @param key The configuration key. * @param defaultValue The default value. * @return The associated List of Locales. - * * @throws ConversionException is thrown if the key maps to an object that is not a list of Locales. */ public List<Locale> getLocaleList(final String key, final List<Locale> defaultValue) { @@ -1158,7 +1095,6 @@ public class DataConfiguration extends AbstractConfiguration { * * @param key The configuration key. * @return The associated long array if the key is found. - * * @throws ConversionException is thrown if the key maps to an object that is not a list of longs. */ public long[] getLongArray(final String key) { @@ -1172,7 +1108,6 @@ public class DataConfiguration extends AbstractConfiguration { * @param key The configuration key. * @param defaultValue the default value, which will be returned if the property is not found * @return The associated long array if the key is found. - * * @throws ConversionException is thrown if the key maps to an object that is not a list of longs. */ public long[] getLongArray(final String key, final long... defaultValue) { @@ -1185,7 +1120,6 @@ public class DataConfiguration extends AbstractConfiguration { * * @param key The configuration key. * @return The associated Long list if the key is found. - * * @throws ConversionException is thrown if the key maps to an object that is not a list of longs. */ public List<Long> getLongList(final String key) { @@ -1199,7 +1133,6 @@ public class DataConfiguration extends AbstractConfiguration { * @param key The configuration key. * @param defaultValue The default value. * @return The associated List of Longs. - * * @throws ConversionException is thrown if the key maps to an object that is not a list of longs. */ public List<Long> getLongList(final String key, final List<Long> defaultValue) { @@ -1228,7 +1161,6 @@ public class DataConfiguration extends AbstractConfiguration { * * @param key The configuration key. * @return The associated short array if the key is found. - * * @throws ConversionException is thrown if the key maps to an object that is not a list of shorts. */ public short[] getShortArray(final String key) { @@ -1242,7 +1174,6 @@ public class DataConfiguration extends AbstractConfiguration { * @param key The configuration key. * @param defaultValue the default value, which will be returned if the property is not found * @return The associated short array if the key is found. - * * @throws ConversionException is thrown if the key maps to an object that is not a list of shorts. */ public short[] getShortArray(final String key, final short... defaultValue) { @@ -1255,7 +1186,6 @@ public class DataConfiguration extends AbstractConfiguration { * * @param key The configuration key. * @return The associated Short list if the key is found. - * * @throws ConversionException is thrown if the key maps to an object that is not a list of shorts. */ public List<Short> getShortList(final String key) { @@ -1269,7 +1199,6 @@ public class DataConfiguration extends AbstractConfiguration { * @param key The configuration key. * @param defaultValue The default value. * @return The associated List of Shorts. - * * @throws ConversionException is thrown if the key maps to an object that is not a list of shorts. */ public List<Short> getShortList(final String key, final List<Short> defaultValue) { @@ -1281,7 +1210,6 @@ public class DataConfiguration extends AbstractConfiguration { * * @param key The configuration key. * @return The associated URI. - * * @throws ConversionException is thrown if the key maps to an object that is not an URI. */ public URI getURI(final String key) { @@ -1295,7 +1223,6 @@ public class DataConfiguration extends AbstractConfiguration { * @param key The configuration key. * @param defaultValue The default value. * @return The associated URI. - * * @throws ConversionException is thrown if the key maps to an object that is not an URI. */ public URI getURI(final String key, final URI defaultValue) { @@ -1308,7 +1235,6 @@ public class DataConfiguration extends AbstractConfiguration { * * @param key The configuration key. * @return The associated URI array if the key is found. - * * @throws ConversionException is thrown if the key maps to an object that is not a list of URIs. */ public URI[] getURIArray(final String key) { @@ -1322,7 +1248,6 @@ public class DataConfiguration extends AbstractConfiguration { * @param key The configuration key. * @param defaultValue the default value, which will be returned if the property is not found * @return The associated URI array if the key is found. - * * @throws ConversionException is thrown if the key maps to an object that is not a list of URIs. */ public URI[] getURIArray(final String key, final URI... defaultValue) { @@ -1335,7 +1260,6 @@ public class DataConfiguration extends AbstractConfiguration { * * @param key The configuration key. * @return The associated URI list if the key is found. - * * @throws ConversionException is thrown if the key maps to an object that is not a list of URIs. */ public List<URI> getURIList(final String key) { @@ -1349,7 +1273,6 @@ public class DataConfiguration extends AbstractConfiguration { * @param key The configuration key. * @param defaultValue The default value. * @return The associated List of URIs. - * * @throws ConversionException is thrown if the key maps to an object that is not a list of URIs. */ public List<URI> getURIList(final String key, final List<URI> defaultValue) { @@ -1361,7 +1284,6 @@ public class DataConfiguration extends AbstractConfiguration { * * @param key The configuration key. * @return The associated URL. - * * @throws ConversionException is thrown if the key maps to an object that is not an URL. */ public URL getURL(final String key) { @@ -1375,7 +1297,6 @@ public class DataConfiguration extends AbstractConfiguration { * @param key The configuration key. * @param defaultValue The default value. * @return The associated URL. - * * @throws ConversionException is thrown if the key maps to an object that is not an URL. */ public URL getURL(final String key, final URL defaultValue) { @@ -1388,7 +1309,6 @@ public class DataConfiguration extends AbstractConfiguration { * * @param key The configuration key. * @return The associated URL array if the key is found. - * * @throws ConversionException is thrown if the key maps to an object that is not a list of URLs. */ public URL[] getURLArray(final String key) { @@ -1402,7 +1322,6 @@ public class DataConfiguration extends AbstractConfiguration { * @param key The configuration key. * @param defaultValue the default value, which will be returned if the property is not found * @return The associated URL array if the key is found. - * * @throws ConversionException is thrown if the key maps to an object that is not a list of URLs. */ public URL[] getURLArray(final String key, final URL... defaultValue) { @@ -1415,7 +1334,6 @@ public class DataConfiguration extends AbstractConfiguration { * * @param key The configuration key. * @return The associated URL list if the key is found. - * * @throws ConversionException is thrown if the key maps to an object that is not a list of URLs. */ public List<URL> getURLList(final String key) { @@ -1429,7 +1347,6 @@ public class DataConfiguration extends AbstractConfiguration { * @param key The configuration key. * @param defaultValue The default value. * @return The associated List of URLs. - * * @throws ConversionException is thrown if the key maps to an object that is not a list of URLs. */ public List<URL> getURLList(final String key, final List<URL> defaultValue) { diff --git a/src/main/java/org/apache/commons/configuration2/ImmutableConfiguration.java b/src/main/java/org/apache/commons/configuration2/ImmutableConfiguration.java index 913068d0..74e577ed 100644 --- a/src/main/java/org/apache/commons/configuration2/ImmutableConfiguration.java +++ b/src/main/java/org/apache/commons/configuration2/ImmutableConfiguration.java @@ -58,7 +58,6 @@ public interface ImmutableConfiguration { * Checks if the configuration contains the specified key. * * @param key the key whose presence in this configuration is to be tested - * * @return {@code true} if the configuration contains a value for this key, {@code false} otherwise */ boolean containsKey(String key); @@ -106,9 +105,7 @@ public interface ImmutableConfiguration { * @param cls the target class of the value * @param key the key of the value * @param defaultValue the default value - * * @return the value of the requested type for the key - * * @throws org.apache.commons.configuration2.ex.ConversionException if the value is not compatible with the requested * type * @@ -123,7 +120,6 @@ public interface ImmutableConfiguration { * @param cls the type expected for the elements of the array * @param key The configuration key. * @return The associated array if the key is found, and the value compatible with the type specified. - * * @throws org.apache.commons.configuration2.ex.ConversionException is thrown if the key maps to an object that is not * compatible with a list of the specified class. * @@ -139,11 +135,9 @@ public interface ImmutableConfiguration { * @param key the configuration key. * @param defaultValue the default value * @return The associated array if the key is found, and the value compatible with the type specified. - * * @throws org.apache.commons.configuration2.ex.ConversionException is thrown if the key maps to an object that is not * compatible with an array of the specified class. * @throws IllegalArgumentException if the default value is not an array of the specified type - * * @since 2.0 * @deprecated This method should not be used any more because its signature does not allow type-safe invocations; use * {@link #get(Class, String, Object)} instead which offers the same functionality; for instance, to query @@ -166,7 +160,6 @@ public interface ImmutableConfiguration { * * @param key The configuration key. * @param defaultValue The default value. - * * @return The associated BigDecimal if key is found and has valid format, default value otherwise. */ BigDecimal getBigDecimal(String key, BigDecimal defaultValue); @@ -175,7 +168,6 @@ public interface ImmutableConfiguration { * Gets a {@link BigInteger} associated with the given configuration key. * * @param key The configuration key. - * * @return The associated BigInteger if key is found and has valid format */ BigInteger getBigInteger(String key); @@ -186,7 +178,6 @@ public interface ImmutableConfiguration { * * @param key The configuration key. * @param defaultValue The default value. - * * @return The associated BigInteger if key is found and has valid format, default value otherwise. */ BigInteger getBigInteger(String key, BigInteger defaultValue); @@ -394,7 +385,6 @@ public interface ImmutableConfiguration { * @param enumType the {@code Class} object of the enum type from which to return a constant * @param key The configuration key. * @return The associated enum. - * * @throws org.apache.commons.configuration2.ex.ConversionException is thrown if the key maps to an object that is not a * String. * @since 2.8.0 @@ -416,7 +406,6 @@ public interface ImmutableConfiguration { * @param enumType the {@code Class} object of the enum type from which to return a constant * @param defaultValue The default value. * @return The associated enum if key is found and has valid format, default value otherwise. - * * @throws org.apache.commons.configuration2.ex.ConversionException is thrown if the key maps to an object that is not a * Enum. * @since 2.8.0 @@ -555,7 +544,6 @@ public interface ImmutableConfiguration { * @param cls the class expected for the elements of the list * @param key The configuration key. * @return The associated list if the key is found. - * * @throws org.apache.commons.configuration2.ex.ConversionException is thrown if the key maps to an object that is not * compatible with a list of the specified class. * @@ -575,7 +563,6 @@ public interface ImmutableConfiguration { * @param key the configuration key. * @param defaultValue the default value. * @return The associated List. - * * @throws org.apache.commons.configuration2.ex.ConversionException is thrown if the key maps to an object that is not * compatible with a list of the specified class. * @@ -592,7 +579,6 @@ public interface ImmutableConfiguration { * * @param key The configuration key. * @return The associated List. - * * @throws org.apache.commons.configuration2.ex.ConversionException is thrown if the key maps to an object that is not a * List. */ @@ -605,7 +591,6 @@ public interface ImmutableConfiguration { * @param key The configuration key. * @param defaultValue The default value. * @return The associated List of strings. - * * @throws org.apache.commons.configuration2.ex.ConversionException is thrown if the key maps to an object that is not a * List. * @see #getList(Class, String, List) @@ -629,7 +614,6 @@ public interface ImmutableConfiguration { * @param key The configuration key. * @param defaultValue The default value. * @return The associated long. - * * @throws org.apache.commons.configuration2.ex.ConversionException is thrown if the key maps to an object that is not a * Long. */ @@ -642,7 +626,6 @@ public interface ImmutableConfiguration { * @param key The configuration key. * @param defaultValue The default value. * @return The associated long if key is found and has valid format, default value otherwise. - * * @throws org.apache.commons.configuration2.ex.ConversionException is thrown if the key maps to an object that is not a * Long. */ @@ -681,7 +664,6 @@ public interface ImmutableConfiguration { * * @param key The configuration key. * @return The associated short. - * * @throws org.apache.commons.configuration2.ex.ConversionException is thrown if the key maps to an object that is not a * Short. */ @@ -693,7 +675,6 @@ public interface ImmutableConfiguration { * @param key The configuration key. * @param defaultValue The default value. * @return The associated short. - * * @throws org.apache.commons.configuration2.ex.ConversionException is thrown if the key maps to an object that is not a * Short. */ @@ -706,7 +687,6 @@ public interface ImmutableConfiguration { * @param key The configuration key. * @param defaultValue The default value. * @return The associated short if key is found and has valid format, default value otherwise. - * * @throws org.apache.commons.configuration2.ex.ConversionException is thrown if the key maps to an object that is not a * Short. */ @@ -717,7 +697,6 @@ public interface ImmutableConfiguration { * * @param key The configuration key. * @return The associated string. - * * @throws org.apache.commons.configuration2.ex.ConversionException is thrown if the key maps to an object that is not a * String. */ @@ -730,7 +709,6 @@ public interface ImmutableConfiguration { * @param key The configuration key. * @param defaultValue The default value. * @return The associated string if key is found and has valid format, default value otherwise. - * * @throws org.apache.commons.configuration2.ex.ConversionException is thrown if the key maps to an object that is not a * String. */ @@ -742,7 +720,6 @@ public interface ImmutableConfiguration { * * @param key The configuration key. * @return The associated string array if key is found. - * * @throws org.apache.commons.configuration2.ex.ConversionException is thrown if the key maps to an object that is not a * String/List of Strings. */ diff --git a/src/main/java/org/apache/commons/configuration2/JNDIConfiguration.java b/src/main/java/org/apache/commons/configuration2/JNDIConfiguration.java index 5de9413d..d5669840 100644 --- a/src/main/java/org/apache/commons/configuration2/JNDIConfiguration.java +++ b/src/main/java/org/apache/commons/configuration2/JNDIConfiguration.java @@ -91,7 +91,6 @@ public class JNDIConfiguration extends AbstractConfiguration { * properties. * * @param prefix the prefix - * * @throws NamingException thrown if an error occurs when initializing the default context */ public JNDIConfiguration(final String prefix) throws NamingException { diff --git a/src/main/java/org/apache/commons/configuration2/PropertiesConfiguration.java b/src/main/java/org/apache/commons/configuration2/PropertiesConfiguration.java index 10cb0bb4..41b947c8 100644 --- a/src/main/java/org/apache/commons/configuration2/PropertiesConfiguration.java +++ b/src/main/java/org/apache/commons/configuration2/PropertiesConfiguration.java @@ -648,7 +648,6 @@ public class PropertiesConfiguration extends BaseConfiguration implements FileBa * {@code <value>}) * * @return A string containing a property value or null - * * @throws IOException in case of an I/O error */ public String readProperty() throws IOException { @@ -916,7 +915,6 @@ public class PropertiesConfiguration extends BaseConfiguration implements FileBa * * @param key The key of the property * @param values The array of values of the property - * * @throws IOException if an I/O error occurs. */ public void writeProperty(final String key, final List<?> values) throws IOException { @@ -930,7 +928,6 @@ public class PropertiesConfiguration extends BaseConfiguration implements FileBa * * @param key the key of the property * @param value the value of the property - * * @throws IOException if an I/O error occurs. */ public void writeProperty(final String key, final Object value) throws IOException { diff --git a/src/main/java/org/apache/commons/configuration2/convert/PropertyConverter.java b/src/main/java/org/apache/commons/configuration2/convert/PropertyConverter.java index eae4d730..a9482ad8 100644 --- a/src/main/java/org/apache/commons/configuration2/convert/PropertyConverter.java +++ b/src/main/java/org/apache/commons/configuration2/convert/PropertyConverter.java @@ -413,7 +413,6 @@ public final class PropertyConverter { * @param cls the type of the enumeration * @return the converted value * @throws ConversionException thrown if the value cannot be converted to an enumeration - * * @since 1.5 */ static <E extends Enum<E>> E toEnum(final Object value, final Class<E> cls) throws ConversionException { @@ -480,7 +479,6 @@ public final class PropertyConverter { * @param value the value to convert * @return the converted value * @throws ConversionException thrown if the value cannot be converted to a InetAddress - * * @since 1.5 */ static InetAddress toInetAddress(final Object value) throws ConversionException { @@ -520,7 +518,6 @@ public final class PropertyConverter { * {@value #INTERNET_ADDRESS_CLASSNAME_JAVAX} or {@value #INTERNET_ADDRESS_CLASSNAME_JAKARTA} * @return the converted value * @throws ConversionException thrown if the value cannot be converted to an email address - * * @since 1.5 */ static Object toInternetAddress(final Object value, final String targetClassName) throws ConversionException { diff --git a/src/main/java/org/apache/commons/configuration2/io/FileSystem.java b/src/main/java/org/apache/commons/configuration2/io/FileSystem.java index 682538a1..4db8450f 100644 --- a/src/main/java/org/apache/commons/configuration2/io/FileSystem.java +++ b/src/main/java/org/apache/commons/configuration2/io/FileSystem.java @@ -56,7 +56,6 @@ public abstract class FileSystem { * @param urlConnectionOptions Ignored. * @return TODO * @throws ConfigurationException TODO - * * @since 2.8.0 */ public InputStream getInputStream(final URL url, final URLConnectionOptions urlConnectionOptions) throws ConfigurationException { diff --git a/src/main/java/org/apache/commons/configuration2/tree/ImmutableNode.java b/src/main/java/org/apache/commons/configuration2/tree/ImmutableNode.java index c8b9ac82..4f22f793 100644 --- a/src/main/java/org/apache/commons/configuration2/tree/ImmutableNode.java +++ b/src/main/java/org/apache/commons/configuration2/tree/ImmutableNode.java @@ -393,7 +393,6 @@ public final class ImmutableNode implements Iterable<ImmutableNode> { * Returns a list with the children of this node. * * @param name the node name to find - * * @return a list with the child nodes */ public List<ImmutableNode> getChildren(final String name) {