Top Description Fields Constructors Methods
org.springframework.beans.propertyeditors

public Class PathEditor

extends PropertyEditorSupport
Class Inheritance
Imports
java.beans.PropertyEditorSupport, java.io.IOException, java.net.URI, .URISyntaxException, java.nio.file.FileSystemNotFoundException, .Path, .Paths, org.springframework.core.io.Resource, .ResourceEditor, org.springframework.util.Assert, .ResourceUtils
Editor for java.nio.file.Path, to directly populate a Path property instead of using a String property as bridge.

Based on Paths#get(URI)'s resolution algorithm, checking registered NIO file system providers, including the default file system for "file:..." paths. Also supports Spring-style URL notation: any fully qualified standard URL and Spring's special "classpath:" pseudo-URL, as well as Spring's context-specific relative file paths. As a fallback, a path will be resolved in the file system via Paths#get(String) if no existing context-relative resource could be found.

Author
Juergen Hoeller
Since
4.3.2
See Also
java.nio.file.Path, Paths#get(URI), ResourceEditor, org.springframework.core.io.ResourceLoader, FileEditor, URLEditor

Field Summary

Modifier and TypeField and Description
private final ResourceEditor
resourceEditor

Constructor Summary

AccessConstructor and Description
public
PathEditor()

Create a new PathEditor, using the default ResourceEditor underneath.

public
PathEditor(ResourceEditor
the ResourceEditor to use
resourceEditor)

Create a new PathEditor, using the given ResourceEditor underneath.

Method Summary

Modifier and TypeMethod 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.
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.
Inherited from java.beans.PropertyEditorSupport:
addPropertyChangeListenerfirePropertyChangegetCustomEditorgetJavaInitializationStringgetSourcegetTagsgetValueisPaintablepaintValueremovePropertyChangeListenersetSourcesetValuesupportsCustomEditor

Field Detail

resourceEditorback to summary
private final ResourceEditor resourceEditor

Constructor Detail

PathEditorback to summary
public PathEditor()

Create a new PathEditor, using the default ResourceEditor underneath.

PathEditorback to summary
public PathEditor(ResourceEditor resourceEditor)

Create a new PathEditor, using the given ResourceEditor underneath.

Parameters
resourceEditor:ResourceEditor

the ResourceEditor to use

Method Detail

getAsTextback 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
setAsTextback 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