org.springframework.core.io: public class: ResourceEditor

org.springframework.core.io
public class: ResourceEditor [javadoc | source]

java.lang.Object
   java.beans.PropertyEditorSupport
      org.springframework.core.io.ResourceEditor

All Implemented Interfaces:
PropertyEditor

Editor for Resource descriptors, to automatically convert String locations e.g. "file:C:/myfile.txt" or "classpath:myfile.txt") to Resource properties instead of using a String location property.

The path may contain ${...} placeholders, to be resolved as system properties: e.g. ${user.dir}.

Delegates to a ResourceLoader to do the heavy lifting, by default using a DefaultResourceLoader .

Also see:

Resource

ResourceLoader

DefaultResourceLoader

org.springframework.util.SystemPropertyUtils#resolvePlaceholders

System#getProperty(String)

author: Juergen - Hoeller

since: 28.12.2003 -

Constructor:

Constructor:
public ResourceEditor() { this(new DefaultResourceLoader()); } Create a new instance of the ResourceEditor class using a DefaultResourceLoader .
public ResourceEditor(ResourceLoader resourceLoader) { Assert.notNull(resourceLoader, "ResourceLoader must not be null"); this.resourceLoader = resourceLoader; } Create a new instance of the ResourceEditor class using the given ResourceLoader . Parameters: `resourceLoader` - the `ResourceLoader` to use

 public ResourceEditor() {
		this(new DefaultResourceLoader());
}

Create a new instance of the

ResourceEditor

DefaultResourceLoader

 public ResourceEditor(ResourceLoader resourceLoader) {
		Assert.notNull(resourceLoader, "ResourceLoader must not be null");
		this.resourceLoader = resourceLoader;
}

ResourceEditor

ResourceLoader

Parameters:

resourceLoader - the ResourceLoader to use

Method from org.springframework.core.io.ResourceEditor Summary:
getAsText, resolvePath, setAsText

Methods from java.beans.PropertyEditorSupport:
addPropertyChangeListener, firePropertyChange, getAsText, getCustomEditor, getJavaInitializationString, getSource, getTags, getValue, isPaintable, paintValue, removePropertyChangeListener, setAsText, setSource, setValue, supportsCustomEditor

Methods from java.lang.Object:
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from org.springframework.core.io.ResourceEditor Detail:
public String getAsText() { Resource value = (Resource) getValue(); try { // Try to determine URL for resource. return (value != null ? value.getURL().toExternalForm() : ""); } catch (IOException ex) { // Couldn't determine resource URL - return null to indicate // that there is no appropriate text representation. return null; } }
protected String resolvePath(String path) { return SystemPropertyUtils.resolvePlaceholders(path); } Resolve the given path, replacing placeholders with corresponding system property values if necessary.
public void setAsText(String text) { if (StringUtils.hasText(text)) { String locationToUse = resolvePath(text).trim(); setValue(this.resourceLoader.getResource(locationToUse)); } else { setValue(null); } }

Method from org.springframework.core.io.ResourceEditor Detail:

 public String getAsText() {
		Resource value = (Resource) getValue();
		try {
			// Try to determine URL for resource.
			return (value != null ? value.getURL().toExternalForm() : "");
		}
		catch (IOException ex) {
			// Couldn't determine resource URL - return null to indicate
			// that there is no appropriate text representation.
			return null;
		}
}

 protected String resolvePath(String path) {
		return SystemPropertyUtils.resolvePlaceholders(path);
}

Resolve the given path, replacing placeholders with corresponding system property values if necessary.

 public  void setAsText(String text) {
		if (StringUtils.hasText(text)) {
			String locationToUse = resolvePath(text).trim();
			setValue(this.resourceLoader.getResource(locationToUse));
		}
		else {
			setValue(null);
		}
}