org.springframework.core.io
Class UrlResource

java.lang.Object
  org.springframework.core.io.AbstractResource
      org.springframework.core.io.UrlResource

All Implemented Interfaces:

InputStreamSource, Resource

public class UrlResource

extends AbstractResource

Resource implementation for java.net.URL locators. Obviously supports resolution as URL, and also as File in case of the "file:" protocol.

Since:

28.12.2003

Author:

Juergen Hoeller

See Also:

URL

Field Summary

static String

PROTOCOL_FILE

Fields inherited from class org.springframework.core.io.AbstractResource

URL_PROTOCOL_FILE

Constructor Summary

UrlResource(String path)
Create a new UrlResource.

UrlResource(URL url)
Create a new UrlResource.

Method Summary

Resource	createRelative(String relativePath) This implementation throws a FileNotFoundException, assuming that relative resources cannot be created for this resource.
boolean	equals(Object obj) This implementation compares description strings.
String	getDescription() Return a description for this resource, to be used for error output when working with the resource.
File	getFile() This implementation throws a FileNotFoundException, assuming that the resource cannot be resolved to an absolute file path.
String	getFilename() This implementation always throws IllegalStateException, assuming that the resource does not carry a filename.
InputStream	getInputStream() Return an InputStream.
URL	getURL() This implementation throws a FileNotFoundException, assuming that the resource cannot be resolved to a URL.
int	hashCode() This implementation returns the description's hash code.

Methods inherited from class org.springframework.core.io.AbstractResource

exists, isOpen, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

PROTOCOL_FILE

public static final String PROTOCOL_FILE

See Also:

Constant Field Values

Constructor Detail

UrlResource

public UrlResource(URL url)

Create a new UrlResource.

Parameters:

url - a URL

UrlResource

public UrlResource(String path)
            throws MalformedURLException

Create a new UrlResource.

Parameters:

path - a URL path

Method Detail

getInputStream

public InputStream getInputStream()
                           throws IOException

Description copied from interface: InputStreamSource

Return an InputStream. It is expected that each call creates a fresh stream.

Throws:

IOException - if the stream could not be opened

getURL

public URL getURL()
           throws IOException

Description copied from class: AbstractResource

This implementation throws a FileNotFoundException, assuming that the resource cannot be resolved to a URL.

Specified by:

getURL in interface Resource

Overrides:

getURL in class AbstractResource

Throws:

IOException

getFile

public File getFile()
             throws IOException

Description copied from class: AbstractResource

This implementation throws a FileNotFoundException, assuming that the resource cannot be resolved to an absolute file path.

Specified by:

getFile in interface Resource

Overrides:

getFile in class AbstractResource

Throws:

IOException

createRelative

public Resource createRelative(String relativePath)
                        throws MalformedURLException

Description copied from class: AbstractResource

This implementation throws a FileNotFoundException, assuming that relative resources cannot be created for this resource.

Specified by:

createRelative in interface Resource

Overrides:

createRelative in class AbstractResource

Throws:

MalformedURLException

getFilename

public String getFilename()

Description copied from class: AbstractResource

This implementation always throws IllegalStateException, assuming that the resource does not carry a filename.

Specified by:

getFilename in interface Resource

Overrides:

getFilename in class AbstractResource

getDescription

public String getDescription()

Description copied from interface: Resource

Return a description for this resource, to be used for error output when working with the resource.

Implementations are also encouraged to return this value from their toString method.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Description copied from class: AbstractResource

This implementation compares description strings.

Overrides:

equals in class AbstractResource

See Also:

Resource.getDescription()

hashCode

public int hashCode()

Description copied from class: AbstractResource

This implementation returns the description's hash code.

Overrides:

hashCode in class AbstractResource

See Also:

Resource.getDescription()