Package org.apache.commons.configuration
Class PropertyConverter
java.lang.Object
org.apache.commons.configuration.PropertyConverter
A utility class to convert the configuration properties into any type.
- Since:
- 1.1
- Version:
- $Id: PropertyConverter.java 1534376 2013-10-21 21:14:18Z henning $
- Author:
- Emmanuel Bourg
-
Method Summary
Modifier and TypeMethodDescriptionstatic String
escapeDelimiters
(String s, char delimiter) Escapes the delimiters that might be contained in the given string.static String
escapeListDelimiter
(String s, char delimiter) Escapes the list delimiter if it is contained in the given string.static Object
interpolate
(Object value, AbstractConfiguration config) Performs interpolation of the specified value.Split a string on the specified delimiter always trimming the elements.Split a string on the specified delimiter.static BigDecimal
toBigDecimal
(Object value) Convert the specified object into a BigDecimal.static BigInteger
toBigInteger
(Object value) Convert the specified object into a BigInteger.static Boolean
Convert the specified object into a Boolean.static Byte
Convert the specified object into a Byte.static Calendar
toCalendar
(Object value, String format) Convert the specified object into a Calendar.static Character
toCharacter
(Object value) Converts the specified value object to aCharacter
.static Color
Convert the specified object into a Color.static Date
Convert the specified object into a Date.static Double
Convert the specified object into a Double.static Float
Convert the specified object into a Float.static Integer
Convert the specified object into an Integer.static Iterator
<?> toIterator
(Object value, char delimiter) Returns an iterator over the simple values of a composite value.static Locale
Convert the specified object into a Locale.static Long
Convert the specified object into a Long.static Short
Convert the specified object into a Short.static URL
Convert the specified object into an URL.
-
Method Details
-
toBoolean
Convert the specified object into a Boolean. Internally theorg.apache.commons.lang.BooleanUtils
class from the Commons Lang project is used to perform this conversion. This class accepts some more tokens for the boolean value of true, e.g.yes
andon
. Please refer to the documentation of this class for more details.- Parameters:
value
- the value to convert- Returns:
- the converted value
- Throws:
ConversionException
- thrown if the value cannot be converted to a boolean
-
toCharacter
Converts the specified value object to aCharacter
. This method converts the passed in object to a string. If the string has exactly one character, this character is returned as result. Otherwise, conversion fails.- Parameters:
value
- the value to be converted- Returns:
- the resulting
Character
object - Throws:
ConversionException
- if the conversion is not possible
-
toByte
Convert the specified object into a Byte.- Parameters:
value
- the value to convert- Returns:
- the converted value
- Throws:
ConversionException
- thrown if the value cannot be converted to a byte
-
toShort
Convert the specified object into a Short.- Parameters:
value
- the value to convert- Returns:
- the converted value
- Throws:
ConversionException
- thrown if the value cannot be converted to a short
-
toInteger
Convert the specified object into an Integer.- Parameters:
value
- the value to convert- Returns:
- the converted value
- Throws:
ConversionException
- thrown if the value cannot be converted to an integer
-
toLong
Convert the specified object into a Long.- Parameters:
value
- the value to convert- Returns:
- the converted value
- Throws:
ConversionException
- thrown if the value cannot be converted to a Long
-
toFloat
Convert the specified object into a Float.- Parameters:
value
- the value to convert- Returns:
- the converted value
- Throws:
ConversionException
- thrown if the value cannot be converted to a Float
-
toDouble
Convert the specified object into a Double.- Parameters:
value
- the value to convert- Returns:
- the converted value
- Throws:
ConversionException
- thrown if the value cannot be converted to a Double
-
toBigInteger
Convert the specified object into a BigInteger.- Parameters:
value
- the value to convert- Returns:
- the converted value
- Throws:
ConversionException
- thrown if the value cannot be converted to a BigInteger
-
toBigDecimal
Convert the specified object into a BigDecimal.- Parameters:
value
- the value to convert- Returns:
- the converted value
- Throws:
ConversionException
- thrown if the value cannot be converted to a BigDecimal
-
toURL
Convert the specified object into an URL.- Parameters:
value
- the value to convert- Returns:
- the converted value
- Throws:
ConversionException
- thrown if the value cannot be converted to an URL
-
toLocale
Convert the specified object into a Locale.- Parameters:
value
- the value to convert- Returns:
- the converted value
- Throws:
ConversionException
- thrown if the value cannot be converted to a Locale
-
split
Split a string on the specified delimiter. To be removed when commons-lang has a better replacement available (Tokenizer?). todo: replace with a commons-lang equivalent- Parameters:
s
- the string to splitdelimiter
- the delimitertrim
- a flag whether the single elements should be trimmed- Returns:
- a list with the single tokens
-
split
Split a string on the specified delimiter always trimming the elements. This is a shortcut forsplit(s, delimiter, true)
.- Parameters:
s
- the string to splitdelimiter
- the delimiter- Returns:
- a list with the single tokens
-
escapeDelimiters
Escapes the delimiters that might be contained in the given string. This method works likeescapeListDelimiter(String, char)
. In addition, a single backslash will also be escaped.- Parameters:
s
- the string with the valuedelimiter
- the list delimiter to use- Returns:
- the correctly escaped string
-
escapeListDelimiter
Escapes the list delimiter if it is contained in the given string. This method ensures that list delimiter characters that are part of a property's value are correctly escaped when a configuration is saved to a file. Otherwise when loaded again the property will be treated as a list property.- Parameters:
s
- the string with the valuedelimiter
- the list delimiter to use- Returns:
- the escaped string
- Since:
- 1.7
-
toColor
Convert the specified object into a Color. If the value is a String, the format allowed is (#)?[0-9A-F]{6}([0-9A-F]{2})?. Examples:- FF0000 (red)
- 0000FFA0 (semi transparent blue)
- #CCCCCC (gray)
- #00FF00A0 (semi transparent green)
- Parameters:
value
- the value to convert- Returns:
- the converted value
- Throws:
ConversionException
- thrown if the value cannot be converted to a Color
-
toDate
Convert the specified object into a Date.- Parameters:
value
- the value to convertformat
- the DateFormat pattern to parse String values- Returns:
- the converted value
- Throws:
ConversionException
- thrown if the value cannot be converted to a Calendar
-
toCalendar
Convert the specified object into a Calendar.- Parameters:
value
- the value to convertformat
- the DateFormat pattern to parse String values- Returns:
- the converted value
- Throws:
ConversionException
- thrown if the value cannot be converted to a Calendar
-
toIterator
Returns an iterator over the simple values of a composite value. This implementation callsinvalid reference
#flatten(Object, char)
- Parameters:
value
- the value to "split"delimiter
- the delimiter for String values- Returns:
- an iterator for accessing the single values
-
interpolate
Performs interpolation of the specified value. This method checks if the given value contains variables of the form${...}
. If this is the case, all occurrences will be substituted by their current values.- Parameters:
value
- the value to be interpolatedconfig
- the current configuration object- Returns:
- the interpolated value
-