com.vaadin.flow.data.converter.StringToDateConverter API 24.7.0.beta2 | Vaadin

com.vaadin.flow.data.converter.

java.lang.Object

com.vaadin.flow.data.converter.StringToDateConverter

All Implemented Interfaces:

Converter<String,Date>, Serializable

public class StringToDateConverter extends Object implements Converter<String,Date>

A converter that converts from Date to String and back. Uses the given locale and DateFormat for formatting and parsing.

Leading and trailing white spaces are ignored when converting from a String.

Override and overwrite getFormat(Locale) to use a different format.

Since:

1.0

Author:

Vaadin Ltd

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor

Description

StringToDateConverter()
Method Summary

Modifier and Type

Method

Description

Result<Date>

convertToModel(String value, ValueContext context)

Converts the given value from presentation type to model type.

String

convertToPresentation(Date value, ValueContext context)

Converts the given value from model type to presentation type.

protected DateFormat

getFormat(Locale locale)

Returns the format used by convertToPresentation(Date, ValueContext) and convertToModel(String, ValueContext).

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

Methods inherited from interface com.vaadin.flow.data.converter.Converter
chain

Constructor Details
- StringToDateConverter
  
  public StringToDateConverter()
Method Details
- getFormat
  
  protected DateFormat getFormat(Locale locale)
  
  Returns the format used by convertToPresentation(Date, ValueContext) and convertToModel(String, ValueContext).
  
  Parameters:
  
  locale - The locale to use
  
  Returns:
  
  A DateFormat instance
- convertToModel
  
  public Result<Date> convertToModel(String value, ValueContext context)
  
  Description copied from interface: Converter
  
  Converts the given value from presentation type to model type.
  A converter can optionally use locale to do the conversion.
  
  Specified by:
  
  convertToModel in interface Converter<String,Date>
  
  Parameters:
  
  value - The value to convert. Can be null
  
  context - The value context for the conversion.
  
  Returns:
  
  The converted value compatible with the source type
- convertToPresentation
  
  public String convertToPresentation(Date value, ValueContext context)
  
  Description copied from interface: Converter
  
  Converts the given value from model type to presentation type.
  A converter can optionally use locale to do the conversion.
  
  Specified by:
  
  convertToPresentation in interface Converter<String,Date>
  
  Parameters:
  
  value - The value to convert. Can be null
  
  context - The value context for the conversion.
  
  Returns:
  
  The converted value compatible with the source type