ConverterManager (JBoss Application Server: Build 7.1.2.Final API)

java.lang.Object
- org.joda.time.convert.ConverterManager

```
public final class ConverterManager
extends Object
```
ConverterManager controls the date and time converters.
This class enables additional conversion classes to be added via addInstantConverter(InstantConverter), which may replace an existing converter. Similar methods exist for duration, time period and interval converters.
This class is threadsafe, so adding/removing converters can be done at any time. Updating the set of convertors is relatively expensive, and so should not be performed often.
The default instant converters are:
- ReadableInstant
- String
- Calendar
- Date (includes sql package subclasses)
- Long (milliseconds)
- null (now)
The default partial converters are:
- ReadablePartial
- ReadableInstant
- String
- Calendar
- Date (includes sql package subclasses)
- Long (milliseconds)
- null (now)
The default duration converters are:
- ReadableDuration
- ReadableInterval
- String
- Long (milliseconds)
- null (zero ms)
The default time period converters are:
- ReadablePeriod
- ReadableInterval
- String
- null (zero)
The default interval converters are:
- ReadableInterval
- String
- null (zero-length from now to now)
Since:

1.0

Author:

Stephen Colebourne, Brian S O'Neill

Constructor Summary

Constructors
Modifier Constructor and Description

protected ConverterManager()
Restricted constructor.

Constructors
Modifier	Constructor and Description
`protected`	`ConverterManager()` Restricted constructor.

Method Summary

Methods
Modifier and Type	Method and Description
`DurationConverter`	`addDurationConverter(DurationConverter converter)` Adds a converter to the set of converters.
`InstantConverter`	`addInstantConverter(InstantConverter converter)` Adds a converter to the set of converters.
`IntervalConverter`	`addIntervalConverter(IntervalConverter converter)` Adds a converter to the set of converters.
`PartialConverter`	`addPartialConverter(PartialConverter converter)` Adds a converter to the set of converters.
`PeriodConverter`	`addPeriodConverter(PeriodConverter converter)` Adds a converter to the set of converters.
`DurationConverter`	`getDurationConverter(Object object)` Gets the best converter for the object specified.
`DurationConverter[]`	`getDurationConverters()` Gets a copy of the list of converters.
`static ConverterManager`	`getInstance()`
`InstantConverter`	`getInstantConverter(Object object)` Gets the best converter for the object specified.
`InstantConverter[]`	`getInstantConverters()` Gets a copy of the set of converters.
`IntervalConverter`	`getIntervalConverter(Object object)` Gets the best converter for the object specified.
`IntervalConverter[]`	`getIntervalConverters()` Gets a copy of the list of converters.
`PartialConverter`	`getPartialConverter(Object object)` Gets the best converter for the object specified.
`PartialConverter[]`	`getPartialConverters()` Gets a copy of the set of converters.
`PeriodConverter`	`getPeriodConverter(Object object)` Gets the best converter for the object specified.
`PeriodConverter[]`	`getPeriodConverters()` Gets a copy of the list of converters.
`DurationConverter`	`removeDurationConverter(DurationConverter converter)` Removes a converter from the set of converters.
`InstantConverter`	`removeInstantConverter(InstantConverter converter)` Removes a converter from the set of converters.
`IntervalConverter`	`removeIntervalConverter(IntervalConverter converter)` Removes a converter from the set of converters.
`PartialConverter`	`removePartialConverter(PartialConverter converter)` Removes a converter from the set of converters.
`PeriodConverter`	`removePeriodConverter(PeriodConverter converter)` Removes a converter from the set of converters.
`String`	`toString()` Gets a debug representation of the object.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ConverterManager
```
protected ConverterManager()
```
    Restricted constructor.
- Method Detail
  - getInstance
```
public static ConverterManager getInstance()
```
  - getInstantConverter
```
public InstantConverter getInstantConverter(Object object)
```
    Gets the best converter for the object specified.
    
    Parameters:
    object - the object to convert
    
    Returns:
    the converter to use
    
    Throws:
    
    IllegalArgumentException - if no suitable converter
    
    IllegalStateException - if multiple converters match the type equally well
  - getInstantConverters
```
public InstantConverter[] getInstantConverters()
```
    Gets a copy of the set of converters.
    
    Returns:
    the converters, a copy of the real data, never null
  - addInstantConverter
```
public InstantConverter addInstantConverter(InstantConverter converter)
                                     throws SecurityException
```
    Adds a converter to the set of converters. If a matching converter is already in the set, the given converter replaces it. If the converter is exactly the same as one already in the set, no changes are made.
    The order in which converters are added is not relevent. The best converter is selected by examining the object hierarchy.
    
    Parameters:
    converter - the converter to add, null ignored
    
    Returns:
    replaced converter, or null
    
    Throws:
    
    SecurityException
  - removeInstantConverter
```
public InstantConverter removeInstantConverter(InstantConverter converter)
                                        throws SecurityException
```
    Removes a converter from the set of converters. If the converter was not in the set, no changes are made.
    
    Parameters:
    converter - the converter to remove, null ignored
    
    Returns:
    replaced converter, or null
    
    Throws:
    
    SecurityException
  - getPartialConverter
```
public PartialConverter getPartialConverter(Object object)
```
    Gets the best converter for the object specified.
    
    Parameters:
    object - the object to convert
    
    Returns:
    the converter to use
    
    Throws:
    
    IllegalArgumentException - if no suitable converter
    
    IllegalStateException - if multiple converters match the type equally well
  - getPartialConverters
```
public PartialConverter[] getPartialConverters()
```
    Gets a copy of the set of converters.
    
    Returns:
    the converters, a copy of the real data, never null
  - addPartialConverter
```
public PartialConverter addPartialConverter(PartialConverter converter)
                                     throws SecurityException
```
    Adds a converter to the set of converters. If a matching converter is already in the set, the given converter replaces it. If the converter is exactly the same as one already in the set, no changes are made.
    The order in which converters are added is not relevent. The best converter is selected by examining the object hierarchy.
    
    Parameters:
    converter - the converter to add, null ignored
    
    Returns:
    replaced converter, or null
    
    Throws:
    
    SecurityException
  - removePartialConverter
```
public PartialConverter removePartialConverter(PartialConverter converter)
                                        throws SecurityException
```
    Removes a converter from the set of converters. If the converter was not in the set, no changes are made.
    
    Parameters:
    converter - the converter to remove, null ignored
    
    Returns:
    replaced converter, or null
    
    Throws:
    
    SecurityException
  - getDurationConverter
```
public DurationConverter getDurationConverter(Object object)
```
    Gets the best converter for the object specified.
    
    Parameters:
    object - the object to convert
    
    Returns:
    the converter to use
    
    Throws:
    
    IllegalArgumentException - if no suitable converter
    
    IllegalStateException - if multiple converters match the type equally well
  - getDurationConverters
```
public DurationConverter[] getDurationConverters()
```
    Gets a copy of the list of converters.
    
    Returns:
    the converters, a copy of the real data, never null
  - addDurationConverter
```
public DurationConverter addDurationConverter(DurationConverter converter)
                                       throws SecurityException
```
    Adds a converter to the set of converters. If a matching converter is already in the set, the given converter replaces it. If the converter is exactly the same as one already in the set, no changes are made.
    The order in which converters are added is not relevent. The best converter is selected by examining the object hierarchy.
    
    Parameters:
    converter - the converter to add, null ignored
    
    Returns:
    replaced converter, or null
    
    Throws:
    
    SecurityException
  - removeDurationConverter
```
public DurationConverter removeDurationConverter(DurationConverter converter)
                                          throws SecurityException
```
    Removes a converter from the set of converters. If the converter was not in the set, no changes are made.
    
    Parameters:
    converter - the converter to remove, null ignored
    
    Returns:
    replaced converter, or null
    
    Throws:
    
    SecurityException
  - getPeriodConverter
```
public PeriodConverter getPeriodConverter(Object object)
```
    Gets the best converter for the object specified.
    
    Parameters:
    object - the object to convert
    
    Returns:
    the converter to use
    
    Throws:
    
    IllegalArgumentException - if no suitable converter
    
    IllegalStateException - if multiple converters match the type equally well
  - getPeriodConverters
```
public PeriodConverter[] getPeriodConverters()
```
    Gets a copy of the list of converters.
    
    Returns:
    the converters, a copy of the real data, never null
  - addPeriodConverter
```
public PeriodConverter addPeriodConverter(PeriodConverter converter)
                                   throws SecurityException
```
    Adds a converter to the set of converters. If a matching converter is already in the set, the given converter replaces it. If the converter is exactly the same as one already in the set, no changes are made.
    The order in which converters are added is not relevent. The best converter is selected by examining the object hierarchy.
    
    Parameters:
    converter - the converter to add, null ignored
    
    Returns:
    replaced converter, or null
    
    Throws:
    
    SecurityException
  - removePeriodConverter
```
public PeriodConverter removePeriodConverter(PeriodConverter converter)
                                      throws SecurityException
```
    Removes a converter from the set of converters. If the converter was not in the set, no changes are made.
    
    Parameters:
    converter - the converter to remove, null ignored
    
    Returns:
    replaced converter, or null
    
    Throws:
    
    SecurityException
  - getIntervalConverter
```
public IntervalConverter getIntervalConverter(Object object)
```
    Gets the best converter for the object specified.
    
    Parameters:
    object - the object to convert
    
    Returns:
    the converter to use
    
    Throws:
    
    IllegalArgumentException - if no suitable converter
    
    IllegalStateException - if multiple converters match the type equally well
  - getIntervalConverters
```
public IntervalConverter[] getIntervalConverters()
```
    Gets a copy of the list of converters.
    
    Returns:
    the converters, a copy of the real data, never null
  - addIntervalConverter
```
public IntervalConverter addIntervalConverter(IntervalConverter converter)
                                       throws SecurityException
```
    Adds a converter to the set of converters. If a matching converter is already in the set, the given converter replaces it. If the converter is exactly the same as one already in the set, no changes are made.
    The order in which converters are added is not relevent. The best converter is selected by examining the object hierarchy.
    
    Parameters:
    converter - the converter to add, null ignored
    
    Returns:
    replaced converter, or null
    
    Throws:
    
    SecurityException
  - removeIntervalConverter
```
public IntervalConverter removeIntervalConverter(IntervalConverter converter)
                                          throws SecurityException
```
    Removes a converter from the set of converters. If the converter was not in the set, no changes are made.
    
    Parameters:
    converter - the converter to remove, null ignored
    
    Returns:
    replaced converter, or null
    
    Throws:
    
    SecurityException
  - toString
```
public String toString()
```
    Gets a debug representation of the object.
    
    Overrides:
    
    toString in class Object

Class ConverterManager

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ConverterManager

Method Detail

getInstance

getInstantConverter

getInstantConverters

addInstantConverter

removeInstantConverter

getPartialConverter

getPartialConverters

addPartialConverter

removePartialConverter

getDurationConverter

getDurationConverters

addDurationConverter

removeDurationConverter

getPeriodConverter

getPeriodConverters

addPeriodConverter

removePeriodConverter

getIntervalConverter

getIntervalConverters

addIntervalConverter

removeIntervalConverter

toString