当前页面: 在线文档首页 > Spring Framework 2.1.0 API 文档英文版

FileSystemResource (Spring Framework API 2.1) - Spring Framework 2.1.0 API 文档英文版

---

Overview  Package   Class  Use  Tree  Deprecated  Index  Help		The Spring Framework
PREV CLASS   NEXT CLASS	FRAMES    NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

org.springframework.core.io
Class FileSystemResource

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

All Implemented Interfaces:

InputStreamSource, Resource

---

public class FileSystemResource
extends AbstractResource

Resource implementation for java.io.File handles. Obviously supports resolution as File, and also as URL.

Since:

28.12.2003

Author:

Juergen Hoeller

See Also:

File

---

Constructor Summary
FileSystemResource(File file)           Create a new FileSystemResource.
FileSystemResource(String path)           Create a new FileSystemResource.

 

Method Summary
Resource	createRelative(String relativePath)           This implementation creates a FileSystemResource, applying the given path relative to the path of the underlying file of this resource descriptor.
boolean	equals(Object obj)           This implementation compares the underlying File references.
boolean	exists()           This implementation returns whether the underlying file exists.
String	getDescription()           This implementation returns a description that includes the absolute path of the file.
File	getFile()           This implementation returns the underlying File reference.
String	getFilename()           This implementation returns the name of the file.
InputStream	getInputStream()           This implementation opens a FileInputStream for the underlying file.
String	getPath()           Return the file path for this resource.
URL	getURL()           This implementation returns a URL for the underlying file.
int	hashCode()           This implementation returns the hash code of the underlying File reference.

 

Methods inherited from class org.springframework.core.io.AbstractResource
isOpen, toString

 

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

 

Constructor Detail

FileSystemResource

public FileSystemResource(File file)

Create a new FileSystemResource.

Parameters:

file - a File handle

---

FileSystemResource

public FileSystemResource(String path)

Create a new FileSystemResource.

Parameters:

path - a file path

Method Detail

getPath

public final String getPath()

Return the file path for this resource.

---

exists

public boolean exists()

This implementation returns whether the underlying file exists.

Specified by:

exists in interface Resource

Overrides:

exists in class AbstractResource

See Also:

File.exists()

---

getInputStream

public InputStream getInputStream()
                           throws IOException

This implementation opens a FileInputStream for the underlying file.

Throws:

IOException - if the stream could not be opened

See Also:

FileInputStream

---

getURL

public URL getURL()
           throws IOException

This implementation returns a URL for the underlying file.

Specified by:

getURL in interface Resource

Overrides:

getURL in class AbstractResource

Throws:

IOException - if the resource cannot be resolved as URL, i.e. if the resource is not available as descriptor

See Also:

File.getAbsolutePath()

---

getFile

public File getFile()

This implementation returns the underlying File reference.

Specified by:

getFile in interface Resource

Overrides:

getFile in class AbstractResource

---

createRelative

public Resource createRelative(String relativePath)

This implementation creates a FileSystemResource, applying the given path relative to the path of the underlying file of this resource descriptor.

Specified by:

createRelative in interface Resource

Overrides:

createRelative in class AbstractResource

Parameters:

relativePath - the relative path (relative to this resource)

Returns:

the resource handle for the relative resource

See Also:

StringUtils.applyRelativePath(String, String)

---

getFilename

public String getFilename()

This implementation returns the name of the file.

Specified by:

getFilename in interface Resource

Overrides:

getFilename in class AbstractResource

See Also:

File.getName()

---

getDescription

public String getDescription()

This implementation returns a description that includes the absolute path of the file.

See Also:

File.getAbsolutePath()

---

equals

public boolean equals(Object obj)

This implementation compares the underlying File references.

Overrides:

equals in class AbstractResource

See Also:

Resource.getDescription()

---

hashCode

public int hashCode()

This implementation returns the hash code of the underlying File reference.

Overrides:

hashCode in class AbstractResource

See Also:

Resource.getDescription()

---

Overview  Package   Class  Use  Tree  Deprecated  Index  Help		The Spring Framework
PREV CLASS   NEXT CLASS	FRAMES    NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

Copyright © 2002-2007 The Spring Framework.