public class

CustomBooleanEditor

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

Class Overview

Property editor for Boolean/boolean properties.

This is not meant to be used as system PropertyEditor but rather as locale-specific Boolean editor within custom controller code, to parse UI-caused boolean strings into boolean properties of beans and check them in the UI form.

In web MVC code, this editor will typically be registered with binder.registerCustomEditor calls in an implementation of BaseCommandController's initBinder method.

Summary

Constants
String VALUE_0
String VALUE_1
String VALUE_FALSE
String VALUE_NO
String VALUE_OFF
String VALUE_ON
String VALUE_TRUE
String VALUE_YES
Public Constructors
CustomBooleanEditor(boolean allowEmpty)
Create a new CustomBooleanEditor instance, with "true"/"on"/"yes" and "false"/"off"/"no" as recognized String values.
CustomBooleanEditor(String trueString, String falseString, boolean allowEmpty)
Create a new CustomBooleanEditor instance, with configurable String values for true and false.
Public Methods
String getAsText()
void setAsText(String text)
[Expand]
Inherited Methods
From class java.beans.PropertyEditorSupport
From class java.lang.Object
From interface java.beans.PropertyEditor

Constants

public static final String VALUE_0

Also: SpringBeans

Constant Value: "0"

public static final String VALUE_1

Also: SpringBeans

Constant Value: "1"

public static final String VALUE_FALSE

Also: SpringBeans

Constant Value: "false"

public static final String VALUE_NO

Also: SpringBeans

Constant Value: "no"

public static final String VALUE_OFF

Also: SpringBeans

Constant Value: "off"

public static final String VALUE_ON

Also: SpringBeans

Constant Value: "on"

public static final String VALUE_TRUE

Also: SpringBeans

Constant Value: "true"

public static final String VALUE_YES

Also: SpringBeans

Constant Value: "yes"

Public Constructors

public CustomBooleanEditor (boolean allowEmpty)

Also: SpringBeans

Create a new CustomBooleanEditor instance, with "true"/"on"/"yes" and "false"/"off"/"no" as recognized String values.

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
allowEmpty if empty strings should be allowed

public CustomBooleanEditor (String trueString, String falseString, boolean allowEmpty)

Also: SpringBeans

Create a new CustomBooleanEditor instance, with configurable String values for true and false.

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
trueString the String value that represents true: for example, "true" (VALUE_TRUE), "on" (VALUE_ON), "yes" (VALUE_YES) or some custom value
falseString the String value that represents false: for example, "false" (VALUE_FALSE), "off" (VALUE_OFF), "no" (VALUE_NO) or some custom value
allowEmpty if empty strings should be allowed

Public Methods

public String getAsText ()

public void setAsText (String text)