Package org.apache.commons.beanutils2.converters

# Class PatternConverter

java.lang.Object
org.apache.commons.beanutils2.converters.AbstractConverter<Pattern>
org.apache.commons.beanutils2.converters.PatternConverter

All Implemented Interfaces:
  `Converter<Pattern>`

public class PatternConverter extends AbstractConverter<Pattern>
`Converter` implementation that handles conversion to and from `Pattern`.

Since:
  2.0.0

- ## Constructor Summary

  Constructors
  Constructor
  Description
  `PatternConverter()`
  Construct a `Pattern` Converter that throws a `ConversionException` if an error occurs.
  `PatternConverter(Pattern defaultValue)`
  Constructs a `Converter` that will return the specified default value if a conversion error occurs.

- ## Method Summary

  Modifier and Type
  Method
  Description
  `protected <T> T`
  `convertToType(Class<T> type, Object value)`
  Converts the specified input object into an output object of the specified type.
  `protected Class<Pattern>`
  `getDefaultType()`
  Gets the default type this `Converter` handles.

  ### Methods inherited from class org.apache.commons.beanutils2.converters.AbstractConverter

  `conversionException, convert, convertArray, convertToString, getDefault, handleError, handleMissing, isUseDefault, setDefaultValue, toLowerCase, toString, toString, toTrim`

  ### Methods inherited from class java.lang.Object

  `clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

- ## Constructor Details

  - ### PatternConverter

    public PatternConverter()
    Construct a `Pattern` Converter that throws a `ConversionException` if an error occurs.

  - ### PatternConverter

    public PatternConverter(Pattern defaultValue)
    Constructs a `Converter` that will return the specified default value if a conversion error occurs.
    Parameters:
      `defaultValue` - The default value to be returned if the value to be converted is missing or an error occurs converting the value.

- ## Method Details

  - ### convertToType

    protected <T> T convertToType(Class<T> type, Object value) throws Throwable
    Converts the specified input object into an output object of the specified type.
    Specified by:
      `convertToType` in class `AbstractConverter<Pattern>`
    Type Parameters:
      `T` - Target type of the conversion.
    Parameters:
      `type` - Data type to which this value should be converted.
      `value` - The String property value to convert.
    Returns:
      A `Pattern` which represents the compiled configuration property.
    Throws:
      `NullPointerException` - If the value is null.
      `PatternSyntaxException` - If the regular expression `String` provided is malformed.
      `Throwable` - if an error occurs converting to the specified type

  - ### getDefaultType

    protected Class<Pattern> getDefaultType()
    Gets the default type this `Converter` handles.
    Specified by:
      `getDefaultType` in class `AbstractConverter<Pattern>`
    Returns:
      The default type this `Converter` handles.
    Since:
      2.0.0