Package org.springframework.beans.propertyeditors

Class StringArrayPropertyEditor

java.lang.Object
java.beans.PropertyEditorSupport
org.springframework.beans.propertyeditors.StringArrayPropertyEditor
All Implemented Interfaces:
PropertyEditor
public class StringArrayPropertyEditor extends PropertyEditorSupport
Custom PropertyEditor for String arrays.

Strings must be in CSV format, with a customizable separator. By default, values in the result are trimmed of whitespace.

Author:
Rod Johnson, Juergen Hoeller, Dave Syer
See Also:

  • Field Details

    • DEFAULT_SEPARATOR

      public static final String DEFAULT_SEPARATOR
      Default separator for splitting a String: a comma (",").
      See Also:

  • Constructor Details

    • StringArrayPropertyEditor

      public StringArrayPropertyEditor()
      Create a new StringArrayPropertyEditor with the default separator (a comma).

      An empty text (without elements) will be turned into an empty array.

    • StringArrayPropertyEditor

      public StringArrayPropertyEditor(String separator)
      Create a new StringArrayPropertyEditor with the given separator.

      An empty text (without elements) will be turned into an empty array.

      Parameters:
      separator - the separator to use for splitting a String

    • StringArrayPropertyEditor

      public StringArrayPropertyEditor(String separator, boolean emptyArrayAsNull)
      Create a new StringArrayPropertyEditor with the given separator.
      Parameters:
      separator - the separator to use for splitting a String
      emptyArrayAsNull - true if an empty String array is to be transformed into null

    • StringArrayPropertyEditor

      public StringArrayPropertyEditor(String separator, boolean emptyArrayAsNull, boolean trimValues)
      Create a new StringArrayPropertyEditor with the given separator.
      Parameters:
      separator - the separator to use for splitting a String
      emptyArrayAsNull - true if an empty String array is to be transformed into null
      trimValues - true if the values in the parsed arrays are to be trimmed of whitespace (default is true)

    • StringArrayPropertyEditor

      public StringArrayPropertyEditor(String separator, @Nullable String charsToDelete, boolean emptyArrayAsNull)
      Create a new StringArrayPropertyEditor with the given separator.
      Parameters:
      separator - the separator to use for splitting a String
      charsToDelete - a set of characters to delete, in addition to trimming an input String. Useful for deleting unwanted line breaks: e.g. "\r\n\f" will delete all new lines and line feeds in a String.
      emptyArrayAsNull - true if an empty String array is to be transformed into null

    • StringArrayPropertyEditor

      public StringArrayPropertyEditor(String separator, @Nullable String charsToDelete, boolean emptyArrayAsNull, boolean trimValues)
      Create a new StringArrayPropertyEditor with the given separator.
      Parameters:
      separator - the separator to use for splitting a String
      charsToDelete - a set of characters to delete, in addition to trimming an input String. Useful for deleting unwanted line breaks: e.g. "\r\n\f" will delete all new lines and line feeds in a String.
      emptyArrayAsNull - true if an empty String array is to be transformed into null
      trimValues - true if the values in the parsed arrays are to be trimmed of whitespace (default is true)

  • Method Details