org.springframework.beans.propertyeditors

Class CustomBooleanEditor

  • java.lang.Object
    • java.beans.PropertyEditorSupport
      • org.springframework.beans.propertyeditors.CustomBooleanEditor
  • All Implemented Interfaces:
    java.beans.PropertyEditor


    public class CustomBooleanEditor
    extends java.beans.PropertyEditorSupport
    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.

    Since:
    10.06.2003
    Author:
    Juergen Hoeller
    See Also:
    DataBinder.registerCustomEditor(java.lang.Class<?>, java.beans.PropertyEditor)
    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.lang.String VALUE_0
      Value of "0".
      static java.lang.String VALUE_1
      Value of "1".
      static java.lang.String VALUE_FALSE
      Value of "false".
      static java.lang.String VALUE_NO
      Value of "no".
      static java.lang.String VALUE_OFF
      Value of "off".
      static java.lang.String VALUE_ON
      Value of "on".
      static java.lang.String VALUE_TRUE
      Value of "true".
      static java.lang.String VALUE_YES
      Value of "yes".
    • Constructor Summary

      Constructors 
      Constructor and Description
      CustomBooleanEditor(boolean allowEmpty)
      Create a new CustomBooleanEditor instance, with "true"/"on"/"yes" and "false"/"off"/"no" as recognized String values.
      CustomBooleanEditor(java.lang.String trueString, java.lang.String falseString, boolean allowEmpty)
      Create a new CustomBooleanEditor instance, with configurable String values for true and false.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      java.lang.String getAsText() 
      void setAsText(java.lang.String text) 
      • Methods inherited from class java.beans.PropertyEditorSupport

        addPropertyChangeListener, firePropertyChange, getCustomEditor, getJavaInitializationString, getSource, getTags, getValue, isPaintable, paintValue, removePropertyChangeListener, setSource, setValue, supportsCustomEditor
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • CustomBooleanEditor

        public CustomBooleanEditor(boolean allowEmpty)
        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
      • CustomBooleanEditor

        public CustomBooleanEditor(@Nullable
                                   java.lang.String trueString,
                                   @Nullable
                                   java.lang.String falseString,
                                   boolean allowEmpty)
        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
        See Also:
        VALUE_TRUE, VALUE_FALSE, VALUE_ON, VALUE_OFF, VALUE_YES, VALUE_NO
    • Method Detail

      • setAsText

        public void setAsText(@Nullable
                              java.lang.String text)
                       throws java.lang.IllegalArgumentException
        Specified by:
        setAsText in interface java.beans.PropertyEditor
        Overrides:
        setAsText in class java.beans.PropertyEditorSupport
        Throws:
        java.lang.IllegalArgumentException
      • getAsText

        public java.lang.String getAsText()
        Specified by:
        getAsText in interface java.beans.PropertyEditor
        Overrides:
        getAsText in class java.beans.PropertyEditorSupport