DateFormatConverter (SNAP Engine API)

java.lang.Object
- com.bc.ceres.binding.converters.DateFormatConverter

All Implemented Interfaces:: Converter<Date>

public class DateFormatConverter
extends Object
implements Converter<Date>

Constructor Summary

Constructors
Constructor Description

DateFormatConverter()

DateFormatConverter(DateFormat format)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`format(Date value)`	Converts a value of the type returned by `Converter.getValueType()` to its plain text representation.
`Class<Date>`	`getValueType()`	Gets the value type.
`Date`	`parse(String text)`	Converts a value from its plain text representation to a Java object instance of the type returned by `Converter.getValueType()`.

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

- Constructor Detail
  - DateFormatConverter
```
public DateFormatConverter()
```
  - DateFormatConverter
```
public DateFormatConverter(DateFormat format)
```
- Method Detail
  - getValueType
```
public Class<Date> getValueType()
```
    Description copied from interface: Converter
    
    Gets the value type.
    
    Specified by:
    
    getValueType in interface Converter<Date>
    
    Returns:
    
    The value type.
  - parse
```
public Date parse(String text)
           throws ConversionException
```
    Description copied from interface: Converter
    
    Converts a value from its plain text representation to a Java object instance of the type returned by Converter.getValueType().
    
    Specified by:
    
    parse in interface Converter<Date>
    
    Parameters:
    
    text - The textual representation of the value.
    
    Returns:
    
    The converted value.
    
    Throws:
    
    ConversionException - If the conversion fails.
  - format
```
public String format(Date value)
```
    Description copied from interface: Converter
    
    Converts a value of the type returned by Converter.getValueType() to its plain text representation.
    
    Specified by:
    
    format in interface Converter<Date>
    
    Parameters:
    
    value - The value to be converted to text.
    
    Returns:
    
    The textual representation of the value.