Spring Framework 6.1.4 · org.springframework.beans.propertyeditors.CharacterEditor

Editor for a Character, to populate a property of type Character or char from a String value.

Note that the JDK does not contain a default property editor for char! org.springframework.beans.BeanWrapperImpl will register this editor by default.

Also supports conversion from a Unicode character sequence; e.g. u0041 ('A').

Field Summary

Modifier and Type	Field and Description
private final boolean	allowEmpty
private static final int	UNICODE_LENGTH The length of a Unicode character sequence.
private static final String	UNICODE_PREFIX The prefix that identifies a string as being a Unicode character sequence.

Constructor Summary

Access	Constructor and Description
public	CharacterEditor(boolean if empty strings are to be allowed allowEmpty) Create a new CharacterEditor instance.

Method Summary

Modifier and Type	Method and Description
public String	getAsText() Overrides java.beans.PropertyEditorSupport.getAsText. Implements java.beans.PropertyEditor.getAsText. Gets the property value as a string suitable for presentation to a human to edit.
private boolean	isUnicodeCharacterSequence(String sequence)
public void	setAsText(String The string to be parsed. text) Overrides java.beans.PropertyEditorSupport.setAsText. Implements java.beans.PropertyEditor.setAsText. Sets the property value by parsing a given String.
private void	setAsUnicode(String text)

Inherited from java.beans.PropertyEditorSupport:: addPropertyChangeListener firePropertyChange getCustomEditor getJavaInitializationString getSource getTags getValue isPaintable paintValue removePropertyChangeListener setSource setValue supportsCustomEditor

Field Detail

allowEmpty	back to summary
private final boolean allowEmpty

UNICODE_LENGTH	back to summary
private static final int UNICODE_LENGTH The length of a Unicode character sequence.

UNICODE_PREFIX	back to summary
private static final String UNICODE_PREFIX The prefix that identifies a string as being a Unicode character sequence.

Constructor Detail

CharacterEditor back to summary

CharacterEditor	back to summary
public CharacterEditor(boolean allowEmpty) Create a new CharacterEditor instance. The "allowEmpty" parameter controls whether an empty String is to be allowed in parsing, i.e. be interpreted as the `null` value when `text is being converted`. If `false`, an `IllegalArgumentException` will be thrown at that time. Parameters allowEmpty:boolean if empty strings are to be allowed

public CharacterEditor(boolean allowEmpty)

Create a new CharacterEditor instance.

The "allowEmpty" parameter controls whether an empty String is to be allowed in parsing, i.e. be interpreted as the null value when text is being converted. If false, an IllegalArgumentException will be thrown at that time.

Parameters

allowEmpty:boolean: if empty strings are to be allowed

Method Detail

getAsText	back to summary
public String getAsText() Overrides java.beans.PropertyEditorSupport.getAsText. Implements java.beans.PropertyEditor.getAsText. Doc from java.beans.PropertyEditorSupport.getAsText. Gets the property value as a string suitable for presentation to a human to edit. Returns:String The property value as a string suitable for presentation to a human to edit. Returns null if the value can't be expressed as a string. If a non-null value is returned, then the PropertyEditor should be prepared to parse that string back in setAsText(). Annotations @Override

getAsText

back to summary

public String getAsText()

Overrides java.beans.PropertyEditorSupport.getAsText.

Implements java.beans.PropertyEditor.getAsText.

Doc from java.beans.PropertyEditorSupport.getAsText.

Gets the property value as a string suitable for presentation to a human to edit.

Returns:String

The property value as a string suitable for presentation to a human to edit.

Returns null if the value can't be expressed as a string.

If a non-null value is returned, then the PropertyEditor should be prepared to parse that string back in setAsText().

Annotations

@Override

isUnicodeCharacterSequence	back to summary
private boolean isUnicodeCharacterSequence(String sequence)

setAsText	back to summary
public void setAsText(String text) throws IllegalArgumentException Overrides java.beans.PropertyEditorSupport.setAsText. Implements java.beans.PropertyEditor.setAsText. Doc from java.beans.PropertyEditorSupport.setAsText. Sets the property value by parsing a given String. May raise java.lang.IllegalArgumentException if either the String is badly formatted or if this kind of property can't be expressed as text. Parameters text:String The string to be parsed. Annotations @Override

setAsText

back to summary

public void setAsText(String text) throws IllegalArgumentException

Overrides java.beans.PropertyEditorSupport.setAsText.

Implements java.beans.PropertyEditor.setAsText.

Doc from java.beans.PropertyEditorSupport.setAsText.

Sets the property value by parsing a given String. May raise java.lang.IllegalArgumentException if either the String is badly formatted or if this kind of property can't be expressed as text.