public class

CustomDateEditor

extends PropertyEditorSupport
java.lang.Object
   ↳ java.beans.PropertyEditorSupport
     ↳ org.springframework.beans.propertyeditors.CustomDateEditor

Class Overview

Property editor for java.util.Date, supporting a custom java.text.DateFormat.

This is not meant to be used as system PropertyEditor but rather as locale-specific date editor within custom controller code, parsing user-entered number strings into Date properties of beans and rendering them in the UI form.

In web MVC code, this editor will typically be registered with binder.registerCustomEditor calls in a custom initBinder method.

Summary

Public Constructors
CustomDateEditor(DateFormat dateFormat, boolean allowEmpty)
Create a new CustomDateEditor instance, using the given DateFormat for parsing and rendering.
CustomDateEditor(DateFormat dateFormat, boolean allowEmpty, int exactDateLength)
Create a new CustomDateEditor instance, using the given DateFormat for parsing and rendering.
Public Methods
String getAsText()
Format the Date as String, using the specified DateFormat.
void setAsText(String text)
Parse the Date from the given text, using the specified DateFormat.
[Expand]
Inherited Methods
From class java.beans.PropertyEditorSupport
From class java.lang.Object
From interface java.beans.PropertyEditor

Public Constructors

public CustomDateEditor (DateFormat dateFormat, boolean allowEmpty)

Also: SpringBeans

Create a new CustomDateEditor instance, using the given DateFormat for parsing and rendering.

The "allowEmpty" parameter states if an empty String should be allowed for parsing, i.e. get interpreted as null value. Otherwise, an IllegalArgumentException gets thrown in that case.

Parameters
dateFormat DateFormat to use for parsing and rendering
allowEmpty if empty strings should be allowed

public CustomDateEditor (DateFormat dateFormat, boolean allowEmpty, int exactDateLength)

Also: SpringBeans

Create a new CustomDateEditor instance, using the given DateFormat for parsing and rendering.

The "allowEmpty" parameter states if an empty String should be allowed for parsing, i.e. get interpreted as null value. Otherwise, an IllegalArgumentException gets thrown in that case.

The "exactDateLength" parameter states that IllegalArgumentException gets thrown if the String does not exactly match the length specified. This is useful because SimpleDateFormat does not enforce strict parsing of the year part, not even with setLenient(false). Without an "exactDateLength" specified, the "01/01/05" would get parsed to "01/01/0005". However, even with an "exactDateLength" specified, prepended zeros in the day or month part may still allow for a shorter year part, so consider this as just one more assertion that gets you closer to the intended date format.

Parameters
dateFormat DateFormat to use for parsing and rendering
allowEmpty if empty strings should be allowed
exactDateLength the exact expected length of the date String

Public Methods

public String getAsText ()

Format the Date as String, using the specified DateFormat.

public void setAsText (String text)

Parse the Date from the given text, using the specified DateFormat.