Package org.apache.commons.configuration2.convert

Class PropertyConverter

java.lang.Object
org.apache.commons.configuration2.convert.PropertyConverter
public final class PropertyConverter extends Object
A utility class to convert the configuration properties into any type.
Since:
2.8.0

  • Field Details

    • HEX_PREFIX

      private static final String HEX_PREFIX
      Constant for the prefix of hex numbers.
      See Also:

    • HEX_RADIX

      private static final int HEX_RADIX
      Constant for the radix of hex numbers.
      See Also:

    • BIN_PREFIX

      private static final String BIN_PREFIX
      Constant for the prefix of binary numbers.
      See Also:

    • BIN_RADIX

      private static final int BIN_RADIX
      Constant for the radix of binary numbers.
      See Also:

    • CONSTR_ARGS

      private static final Class<?>[] CONSTR_ARGS
      Constant for the argument classes of the Number constructor that takes a String.

    • INTERNET_ADDRESS_CLASSNAME_JAVAX

      private static final String INTERNET_ADDRESS_CLASSNAME_JAVAX
      The fully qualified name of javax.mail.internet.InternetAddress, as used in the javamail-1.* API.
      See Also:

    • INTERNET_ADDRESS_CLASSNAME_JAKARTA

      private static final String INTERNET_ADDRESS_CLASSNAME_JAKARTA
      The fully qualified name of jakarta.mail.internet.InternetAddress, as used in the javamail-2.0+ API.
      See Also:

  • Constructor Details

    • PropertyConverter

      private PropertyConverter()
      Private constructor prevents instances from being created.

  • Method Details

    • convertToEnum

      private static Object convertToEnum(Class<?> enumClass, Object value)
      Converts a value to a constant of an enumeration class.
      Parameters:
      enumClass - the enumeration class
      value - the value to be converted
      Returns:
      the converted value

    • to

      public static Object to(Class<?> cls, Object value, DefaultConversionHandler convHandler) throws ConversionException
      Converts the specified value object to the given target data class. If additional information is required for this conversion, it is obtained from the passed in DefaultConversionHandler object. If the class is a primitive type (Integer.TYPE, Boolean.TYPE, etc), the value returned will use the wrapper type (Integer.class, Boolean.class, etc).
      Parameters:
      cls - the target class of the converted value
      value - the value to convert
      convHandler - the conversion handler object
      Returns:
      the converted value
      Throws:
      ConversionException - if the value is not compatible with the requested type

    • toBigDecimal

      public static BigDecimal toBigDecimal(Object value) throws ConversionException
      Converts 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

    • toBigInteger

      public static BigInteger toBigInteger(Object value) throws ConversionException
      Converts 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

    • toBoolean

      public static Boolean toBoolean(Object value) throws ConversionException
      Converts the specified object into a Boolean. Internally the org.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 and on. 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

    • toByte

      public static Byte toByte(Object value) throws ConversionException
      Converts 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

    • toCalendar

      public static Calendar toCalendar(Object value, String format) throws ConversionException
      Converts the specified object into a Calendar.
      Parameters:
      value - the value to convert
      format - the DateFormat pattern to parse String values
      Returns:
      the converted value
      Throws:
      ConversionException - thrown if the value cannot be converted to a Calendar

    • toCharacter

      public static Character toCharacter(Object value) throws ConversionException
      Converts the specified value object to a Character. 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

    • toColor

      public static Color toColor(Object value) throws ConversionException
      Converts 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

      public static Date toDate(Object value, String format) throws ConversionException
      Converts the specified object into a Date.
      Parameters:
      value - the value to convert
      format - the DateFormat pattern to parse String values
      Returns:
      the converted value
      Throws:
      ConversionException - thrown if the value cannot be converted to a Calendar

    • toDouble

      public static Double toDouble(Object value) throws ConversionException
      Converts 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

    • toDuration

      public static Duration toDuration(Object value) throws ConversionException
      Converts the specified object into a Duration.
      Parameters:
      value - the value to convert
      Returns:
      the converted value
      Throws:
      ConversionException - thrown if the value cannot be converted to a Duration
      Since:
      2.8.0

    • toEnum

      static <E extends Enum<E>> E toEnum(Object value, Class<E> cls) throws ConversionException
      Converts the specified value into an Enum.
      Parameters:
      value - the value to convert
      cls - the type of the enumeration
      Returns:
      the converted value
      Throws:
      ConversionException - thrown if the value cannot be converted to an enumeration
      Since:
      1.5

    • toFile

      public static File toFile(Object value) throws ConversionException
      Converts the specified object into a File.
      Parameters:
      value - the value to convert
      Returns:
      the converted value
      Throws:
      ConversionException - thrown if the value cannot be converted to a File
      Since:
      2.3

    • toFloat

      public static Float toFloat(Object value) throws ConversionException
      Converts 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

    • toInetAddress

      static InetAddress toInetAddress(Object value) throws ConversionException
      Converts the specified value into an internet address.
      Parameters:
      value - the value to convert
      Returns:
      the converted value
      Throws:
      ConversionException - thrown if the value cannot be converted to a InetAddress
      Since:
      1.5

    • toInteger

      public static Integer toInteger(Object value) throws ConversionException
      Converts 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

    • toInternetAddress

      static Object toInternetAddress(Object value, String targetClassName) throws ConversionException
      Converts the specified value into an email address with the given class name.
      Parameters:
      value - the value to convert
      targetClassName - the fully qualified name of the InternetAddress class to convert to, e.g., "javax.mail.internet.InternetAddress" or "jakarta.mail.internet.InternetAddress"
      Returns:
      the converted value
      Throws:
      ConversionException - thrown if the value cannot be converted to an email address
      Since:
      1.5

    • toLocale

      public static Locale toLocale(Object value) throws ConversionException
      Converts 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

    • toLong

      public static Long toLong(Object value) throws ConversionException
      Converts 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

    • toNumber

      static Number toNumber(Object value, Class<?> targetClass) throws ConversionException
      Tries to convert the specified object into a number object. This method is used by the conversion methods for number types. Note that the return value is not in always of the specified target class, but only if a new object has to be created.
      Parameters:
      value - the value to be converted (must not be null)
      targetClass - the target class of the conversion (must be derived from Number)
      Returns:
      the converted number
      Throws:
      ConversionException - if the object cannot be converted

    • toPath

      public static Path toPath(Object value) throws ConversionException
      Converts the specified object into a Path.
      Parameters:
      value - the value to convert
      Returns:
      the converted value
      Throws:
      ConversionException - thrown if the value cannot be converted to a Path
      Since:
      2.3

    • toPattern

      public static Pattern toPattern(Object value) throws ConversionException
      Converts the specified object into a Pattern.
      Parameters:
      value - the value to convert
      Returns:
      the converted value
      Throws:
      ConversionException - thrown if the value cannot be converted to a Pattern

    • toShort

      public static Short toShort(Object value) throws ConversionException
      Converts 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

    • toURI

      public static URI toURI(Object value) throws ConversionException
      Converts the specified object into an URI.
      Parameters:
      value - the value to convert
      Returns:
      the converted value
      Throws:
      ConversionException - thrown if the value cannot be converted to an URI

    • toURL

      public static URL toURL(Object value) throws ConversionException
      Converts 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