org.apache.commons.configuration2.ImmutableConfiguration Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of commons-configuration2 Show documentation
Show all versions of commons-configuration2 Show documentation
Tools to assist in the reading of configuration/preferences files in
various formats
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.commons.configuration2;
import java.math.BigDecimal;
import java.math.BigInteger;
import java.time.Duration;
import java.util.Collection;
import java.util.Iterator;
import java.util.List;
import java.util.NoSuchElementException;
import java.util.Objects;
import java.util.Properties;
import org.apache.commons.configuration2.convert.PropertyConverter;
import org.apache.commons.configuration2.ex.ConversionException;
/**
*
* The main interface for accessing configuration data in a read-only fashion.
*
*
* The major part of the methods defined in this interface deals with accessing properties of various data types. There
* is a generic {@code getProperty()} method, which returns the value of the queried property in its raw data type.
* Other getter methods try to convert this raw data type into a specific data type. If this fails, a
* {@code ConversionException} will be thrown.
*
*
* For most of the property getter methods an overloaded version exists that allows to specify a default value, which
* will be returned if the queried property cannot be found in the configuration. The behavior of the methods that do
* not take a default value in case of a missing property is not defined by this interface and depends on a concrete
* implementation. E.g. the {@link AbstractConfiguration} class, which is the base class of most configuration
* implementations provided by this package, per default returns null if a property is not found, but provides
* the {@link AbstractConfiguration#setThrowExceptionOnMissing(boolean) setThrowExceptionOnMissing()} method, with which
* it can be configured to throw a {@code NoSuchElementException} exception in that case. (Note that getter methods for
* primitive types in {@code AbstractConfiguration} always throw an exception for missing properties because there is no
* way of overloading the return value.)
*
*
* @since 2.0
*/
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);
/**
* Tests whether this configuration contains one or more matches to this value. This operation stops at first
* match but may be more expensive than the {@link #containsKey containsKey} method.
*
* @param value value whose presence in this configuration is to be tested
* @return {@code true} if this configuration maps one or more keys to the specified value, false otherwise.
* @since 2.11.0
*/
default boolean containsValue(final Object value) {
final Iterator keys = getKeys();
while (keys.hasNext()) {
if (Objects.equals(value, getProperty(keys.next()))) {
return true;
}
}
return false;
}
/**
* Gets an object of the specified type associated with the given configuration key. If the key doesn't map to an
* existing object, the method returns null unless {@link AbstractConfiguration#isThrowExceptionOnMissing()} is set to
* {@code true}.
*
* @param the target type of the value
* @param cls the target class of the value
* @param key the key of the value
* @return the value of the requested type for the key
* @throws java.util.NoSuchElementException if the key doesn't map to an existing object and
* {@code throwExceptionOnMissing=true}
* @throws org.apache.commons.configuration2.ex.ConversionException if the value is not compatible with the requested
* type
* @since 2.0
*/
T get(Class cls, String key);
/**
* Gets an object of the specified type associated with the given configuration key using a default value. If the key
* doesn't map to an existing object, the default value is returned.
*
* @param the target type of the value
* @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
*
* @since 2.0
*/
T get(Class cls, String key, T defaultValue);
/**
* Gets an array of typed objects associated with the given configuration key. If the key doesn't map to an existing
* object, an empty list is returned.
*
* @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.
*
* @since 2.0
*/
Object getArray(Class cls, String key);
/**
* Gets an array of typed objects associated with the given configuration key. If the key doesn't map to an existing
* object, the default value is returned.
*
* @param cls the type expected for the elements of the array
* @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
* for an array of ints use {@code int[] result = config.get(int[].class, "myArrayKey", someDefault);}.
*/
@Deprecated
Object getArray(Class cls, String key, Object defaultValue);
/**
* Gets a {@link BigDecimal} associated with the given configuration key.
*
* @param key The configuration key.
* @return The associated BigDecimal if key is found and has valid format
*/
BigDecimal getBigDecimal(String key);
/**
* Gets a {@link BigDecimal} associated with the given configuration key. If the key doesn't map to an existing object,
* the default value is returned.
*
* @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);
/**
* 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);
/**
* Gets a {@link BigInteger} associated with the given configuration key. If the key doesn't map to an existing object,
* the default value is returned.
*
* @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);
/**
* Gets a boolean associated with the given configuration key.
*
* @param key The configuration key.
* @return The associated boolean.
* @throws org.apache.commons.configuration2.ex.ConversionException is thrown if the key maps to an object that is not a
* Boolean.
*/
boolean getBoolean(String key);
/**
* Gets a boolean associated with the given configuration key. If the key doesn't map to an existing object, the default
* value is returned.
*
* @param key The configuration key.
* @param defaultValue The default value.
* @return The associated boolean.
* @throws org.apache.commons.configuration2.ex.ConversionException is thrown if the key maps to an object that is not a
* Boolean.
*/
boolean getBoolean(String key, boolean defaultValue);
/**
* Gets a {@link Boolean} associated with the given configuration key.
*
* @param key The configuration key.
* @param defaultValue The default value.
* @return The associated boolean 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
* Boolean.
*/
Boolean getBoolean(String key, Boolean defaultValue);
/**
* Gets a byte associated with the given configuration key.
*
* @param key The configuration key.
* @return The associated byte.
* @throws org.apache.commons.configuration2.ex.ConversionException is thrown if the key maps to an object that is not a
* Byte.
*/
byte getByte(String key);
/**
* Gets a byte associated with the given configuration key. If the key doesn't map to an existing object, the default
* value is returned.
*
* @param key The configuration key.
* @param defaultValue The default value.
* @return The associated byte.
* @throws org.apache.commons.configuration2.ex.ConversionException is thrown if the key maps to an object that is not a
* Byte.
*/
byte getByte(String key, byte defaultValue);
/**
* Gets a {@link Byte} associated with the given configuration key.
*
* @param key The configuration key.
* @param defaultValue The default value.
* @return The associated byte 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
* Byte.
*/
Byte getByte(String key, Byte defaultValue);
/**
* Gets a collection of typed objects associated with the given configuration key. This method works like
* {@link #getCollection(Class, String, Collection, Collection)} passing in null as default value.
*
* @param the element type of the result list
* @param cls the element class of the result list
* @param key the configuration key
* @param target the target collection (may be null)
* @return the collection to which data was added
* @throws org.apache.commons.configuration2.ex.ConversionException if the conversion is not possible
* @since 2.0
*/
Collection getCollection(Class cls, String key, Collection target);
/**
* Gets a collection of typed objects associated with the given configuration key using the values in the specified
* default collection if the key does not map to an existing object. This method is similar to {@code getList()},
* however, it allows specifying a target collection. Results are added to this collection. This is useful if the data
* retrieved should be added to a specific kind of collection, for example a set to remove duplicates. The return value is as
* follows:
*
* - If the key does not map to an existing object and the default value is null, the method returns
* null.
* - If the target collection is not null and data has been added (either from the resolved property value or
* from the default collection), the target collection is returned.
* - If the target collection is null and data has been added (either from the resolved property value or from
* the default collection), return value is the target collection created by this method.
*
*
* @param the element type of the result list
* @param cls the element class of the result list
* @param key the configuration key
* @param target the target collection (may be null)
* @param defaultValue the default value (may be null)
* @return the collection to which data was added
* @throws org.apache.commons.configuration2.ex.ConversionException if the conversion is not possible
* @since 2.0
*/
Collection getCollection(Class cls, String key, Collection target, Collection defaultValue);
/**
* Gets a double associated with the given configuration key.
*
* @param key The configuration key.
* @return The associated double.
* @throws org.apache.commons.configuration2.ex.ConversionException is thrown if the key maps to an object that is not a
* Double.
*/
double getDouble(String key);
/**
* Gets a double associated with the given configuration key. If the key doesn't map to an existing object, the default
* value is returned.
*
* @param key The configuration key.
* @param defaultValue The default value.
* @return The associated double.
* @throws org.apache.commons.configuration2.ex.ConversionException is thrown if the key maps to an object that is not a
* Double.
*/
double getDouble(String key, double defaultValue);
/**
* Gets a {@link Double} associated with the given configuration key.
*
* @param key The configuration key.
* @param defaultValue The default value.
* @return The associated double 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
* Double.
*/
Double getDouble(String key, Double defaultValue);
/**
* Gets a {@link Duration} associated with the given configuration key.
*
* @param key The configuration key.
* @return The associated Duration 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
* Duration.
* @since 2.8.0
*/
default Duration getDuration(final String key) {
final String string = getString(key);
if (string == null) {
throw new NoSuchElementException(key);
}
return PropertyConverter.toDuration(string);
}
/**
* Gets a {@link Duration} associated with the given configuration key.
*
* @param key The configuration key.
* @param defaultValue The default value.
* @return The associated Duration 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
* Duration.
* @since 2.8.0
*/
default Duration getDuration(final String key, final Duration defaultValue) {
final Object value = getProperty(key);
return value == null ? defaultValue : PropertyConverter.toDuration(value);
}
/**
* Gets the value of a string property that is stored in encoded form in this configuration using a default
* {@code ConfigurationDecoder}. This method works like the method with the same name, but it uses a default
* {@code ConfigurationDecoder} associated with this configuration. It depends on a specific implementation how this
* default decoder is obtained.
*
* @param key the configuration key
* @return the plain string value of the specified encoded property
*/
String getEncodedString(String key);
/**
* Gets the value of a string property that is stored in encoded form in this configuration. This method obtains the
* value of the string property identified by the given key. This value is then passed to the provided
* {@code ConfigurationDecoder}. The value returned by the {@code ConfigurationDecoder} is passed to the caller. If the
* key is not associated with a value, the decoder is not invoked; depending on this configuration's settings either
* null is returned or an exception is thrown.
*
* @param key the configuration key
* @param decoder the {@code ConfigurationDecoder} (must not be null)
* @return the plain string value of the specified encoded property
* @throws IllegalArgumentException if a null decoder is passed
*/
String getEncodedString(String key, ConfigurationDecoder decoder);
/**
* Gets an enum associated with the given configuration key.
*
* @param The enum type whose constant is to be returned.
* @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
*/
default > T getEnum(final String key, final Class enumType) {
try {
return Enum.valueOf(enumType, getString(key));
} catch (final IllegalArgumentException e) {
throw new ConversionException(e);
}
}
/**
* Gets the enum associated with the given configuration key. If the key doesn't map to an existing object, the default
* value is returned.
*
* @param The enum type whose constant is to be returned.
* @param key The configuration key.
* @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
*/
default > T getEnum(final String key, final Class enumType, final T defaultValue) {
final String strValue = getString(key, null);
if (strValue == null) {
return defaultValue;
}
try {
return Enum.valueOf(enumType, strValue);
} catch (final IllegalArgumentException e) {
throw new ConversionException(e);
}
}
/**
* Gets a float associated with the given configuration key.
*
* @param key The configuration key.
* @return The associated float.
* @throws org.apache.commons.configuration2.ex.ConversionException is thrown if the key maps to an object that is not a
* Float.
*/
float getFloat(String key);
/**
* Gets a float associated with the given configuration key. If the key doesn't map to an existing object, the default
* value is returned.
*
* @param key The configuration key.
* @param defaultValue The default value.
* @return The associated float.
* @throws org.apache.commons.configuration2.ex.ConversionException is thrown if the key maps to an object that is not a
* Float.
*/
float getFloat(String key, float defaultValue);
/**
* Gets a {@link Float} associated with the given configuration key. If the key doesn't map to an existing object, the
* default value is returned.
*
* @param key The configuration key.
* @param defaultValue The default value.
* @return The associated float 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
* Float.
*/
Float getFloat(String key, Float defaultValue);
/**
* Gets a int associated with the given configuration key.
*
* @param key The configuration key.
* @return The associated int.
* @throws org.apache.commons.configuration2.ex.ConversionException is thrown if the key maps to an object that is not a
* Integer.
*/
int getInt(String key);
/**
* Gets a int associated with the given configuration key. If the key doesn't map to an existing object, the default
* value is returned.
*
* @param key The configuration key.
* @param defaultValue The default value.
* @return The associated int.
* @throws org.apache.commons.configuration2.ex.ConversionException is thrown if the key maps to an object that is not a
* Integer.
*/
int getInt(String key, int defaultValue);
/**
* Gets an {@link Integer} associated with the given configuration key. If the key doesn't map to an existing object,
* the default value is returned.
*
* @param key The configuration key.
* @param defaultValue The default value.
* @return The associated int 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
* Integer.
*/
Integer getInteger(String key, Integer defaultValue);
/**
* Gets the list of the keys contained in the configuration. The returned iterator can be used to obtain all defined
* keys. It does not allow removing elements from this configuration via its {@code remove()} method. Note that the keys
* of this configuration are returned in a form, so that they can be directly evaluated; escaping of special characters
* (if necessary) has already been performed.
*
* @return An Iterator.
*/
Iterator getKeys();
/**
* Gets the list of the keys contained in the configuration that match the specified prefix. For instance, if the
* configuration contains the following keys:
* {@code db.user, db.pwd, db.url, window.xpos, window.ypos},
* an invocation of {@code getKeys("db");}
* will return the keys below:
* {@code db.user, db.pwd, db.url}.
* Note that the prefix itself is included in the result set if there is a matching key. The exact behavior - how the
* prefix is actually interpreted - depends on a concrete implementation.
*
* @param prefix The prefix to test against.
* @return An Iterator of keys that match the prefix.
* @see #getKeys()
*/
Iterator getKeys(String prefix);
/**
* Gets the list of the keys contained in the configuration that match the specified prefix. For instance, if the
* configuration contains the following keys:
* {@code db@user, db@pwd, db@url, window.xpos, window.ypos},
* an invocation of {@code getKeys("db","@");}
* will return the keys below:
* {@code db@user, db@pwd, db@url}.
* Note that the prefix itself is included in the result set if there is a matching key. The exact behavior - how the
* prefix is actually interpreted - depends on a concrete implementation.
*
* @param prefix The prefix to test against.
* @param delimiter The prefix delimiter.
* @return An Iterator of keys that match the prefix.
* @see #getKeys()
* @since 2.10.0
*/
default Iterator getKeys(final String prefix, final String delimiter) {
return null;
}
/**
* Gets a list of typed objects associated with the given configuration key returning a null if the key doesn't map to
* an existing object.
*
* @param the type expected for the elements of the list
* @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.
*
* @since 2.0
*/
List getList(Class cls, String key);
/**
* Gets a list of typed objects associated with the given configuration key returning the specified default value if the
* key doesn't map to an existing object. This method recursively retrieves all values stored for the passed in key,
* i.e. if one of these values is again a complex object like an array or a collection (which may be the case for some
* concrete subclasses), all values are extracted and added to the resulting list - performing a type conversion if
* necessary.
*
* @param the type expected for the elements of the list
* @param cls the class expected for the elements of the list
* @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.
*
* @since 2.0
*/
List getList(Class cls, String key, List defaultValue);
/**
* Gets a List of the values associated with the given configuration key. This method is different from the generic
* {@code getList()} method in that it does not recursively obtain all values stored for the specified property key.
* Rather, only the first level of the hierarchy is processed. So the resulting list may contain complex objects like
* arrays or collections - depending on the storage structure used by a concrete subclass. If the key doesn't map to an
* existing object, an empty List is returned.
*
* @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.
*/
List © 2015 - 2025 Weber Informatics LLC | Privacy Policy