public class

CustomNumberEditor

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

Class Overview

Property editor for any Number subclass such as Short, Integer, Long, BigInteger, Float, Double, BigDecimal. Can use a given NumberFormat for (locale-specific) parsing and rendering, or alternatively the default decode / valueOf / toString methods.

This is not meant to be used as system PropertyEditor but rather as locale-specific number editor within custom controller code, parsing user-entered number strings into Number 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.

See Also

Summary

Public Constructors
CustomNumberEditor(Class numberClass, boolean allowEmpty)
Create a new CustomNumberEditor instance, using the default valueOf methods for parsing and toString methods for rendering.
CustomNumberEditor(Class numberClass, NumberFormat numberFormat, boolean allowEmpty)
Create a new CustomNumberEditor instance, using the given NumberFormat for parsing and rendering.
Public Methods
String getAsText()
Format the Number as String, using the specified NumberFormat.
void setAsText(String text)
Parse the Number from the given text, using the specified NumberFormat.
void setValue(Object value)
Coerce a Number value into the required target class, if necessary.
[Expand]
Inherited Methods
From class java.beans.PropertyEditorSupport
From class java.lang.Object
From interface java.beans.PropertyEditor

Public Constructors

public CustomNumberEditor (Class numberClass, boolean allowEmpty)

Also: SpringBeans

Create a new CustomNumberEditor instance, using the default valueOf methods for parsing and toString methods for rendering.

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

Parameters
numberClass Number subclass to generate
allowEmpty if empty strings should be allowed
Throws
IllegalArgumentException if an invalid numberClass has been specified
See Also

public CustomNumberEditor (Class numberClass, NumberFormat numberFormat, boolean allowEmpty)

Also: SpringBeans

Create a new CustomNumberEditor instance, using the given NumberFormat for parsing and rendering.

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

Parameters
numberClass Number subclass to generate
numberFormat NumberFormat to use for parsing and rendering
allowEmpty if empty strings should be allowed
Throws
IllegalArgumentException if an invalid numberClass has been specified
See Also

Public Methods

public String getAsText ()

Format the Number as String, using the specified NumberFormat.

public void setAsText (String text)

Parse the Number from the given text, using the specified NumberFormat.

Throws
IllegalArgumentException

public void setValue (Object value)

Coerce a Number value into the required target class, if necessary.