org.jboss.aesh.io

Class FileResource

java.lang.Object

org.jboss.aesh.io.FileResource

All Implemented Interfaces:

Resource

public class FileResource
extends Object
implements Resource

Default impl of FileResource, using java.io.File

Author:

Ståle W. Pedersen

Constructor Summary

Constructors

Constructor and Description
FileResource(File file)
FileResource(String file)

Method Summary

Modifier and Type	Method and Description
Resource	copy(Resource destination) Copy a file/directory to destination;
boolean	delete() Deletes the file resource.
boolean	exists() Check if this file resource exists.
String	getAbsolutePath() Returns the absolute file resource string of this
File	getFile()
String	getName() Returns the name of this file resource
Resource	getParent() Returns the file resource of this parent, or null if this file resource does not name a parent directory.
boolean	isDirectory() Check if the file denoted is a directory.
boolean	isLeaf() Return true if this file resource is a file, not a directory.
boolean	isSymbolicLink() Return true if this resource is a symbolic link.
long	lastAccessed() Returns the last accessed time of the file or directory
long	lastModified() Returns the last modified time of the file or directory
List<Resource>	list() Returns a list of file resources denoting the files in the directory denoted by this file resource.
List<Resource>	list(ResourceFilter filter) Returns a list of path names denoting the files in the directory denoted by this file resource filtered by argument.
List<Resource>	listRoots() List the available filesystem roots.
boolean	mkdirs() Creates the directory named by this file resource, including any necessary but nonexistent parent directories.
void	move(Resource target) Move a file/directory.
Resource	newInstance(String path) Return a new instance of FileResource with String as argument
InputStream	read() InputStream from this FileResource
<A extends BasicFileAttributes> A	readAttributes(Class<A> type, LinkOption... options)
Resource	readSymbolicLink() If the Resource system support symbolic links and this is a symbolic link, return the link target.
List<Resource>	resolve(Resource cwd) Resolve a file that might contain (~,*,?) based on this instance and a given current working directory as argument.
void	setLastAccessed(long time) Sets the last-accessed time of the file or directory named by this abstract pathname.
boolean	setLastModified(long time) Sets the last-modified time of the file or directory named by this abstract pathname.
String	toString()
OutputStream	write(boolean append) OutputStream that will be written to this FileResource

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

FileResource

public FileResource(File file)

FileResource

public FileResource(String file)

Method Detail

getName

public String getName()

Description copied from interface: Resource

Returns the name of this file resource

Specified by:

getName in interface Resource

Returns:

name

getAbsolutePath

public String getAbsolutePath()

Description copied from interface: Resource

Returns the absolute file resource string of this

Specified by:

getAbsolutePath in interface Resource

Returns:

absolute path

isLeaf

public boolean isLeaf()

Description copied from interface: Resource

Return true if this file resource is a file, not a directory. exists() must return true for isLeaf() to return true.

Specified by:

isLeaf in interface Resource

Returns:

true if file

isDirectory

public boolean isDirectory()

Description copied from interface: Resource

Check if the file denoted is a directory.

Specified by:

isDirectory in interface Resource

Returns:

true if directory

isSymbolicLink

public boolean isSymbolicLink()

Description copied from interface: Resource

Return true if this resource is a symbolic link.

Specified by:

isSymbolicLink in interface Resource

Returns:

true if symbolic link

readSymbolicLink

public Resource readSymbolicLink()
                          throws IOException

Description copied from interface: Resource

If the Resource system support symbolic links and this is a symbolic link, return the link target. The target does not need to exist.

Specified by:

readSymbolicLink in interface Resource

Returns:

link target

Throws:

IOException

exists

public boolean exists()

Description copied from interface: Resource

Check if this file resource exists.

Specified by:

exists in interface Resource

Returns:

true if exists

mkdirs

public boolean mkdirs()

Description copied from interface: Resource

Creates the directory named by this file resource, including any necessary but nonexistent parent directories. Note that if this operation fails it may have succeeded in creating some of the necessary parent directories.

Specified by:

mkdirs in interface Resource

Returns:

true if all directories have been successfully created

delete

public boolean delete()

Description copied from interface: Resource

Deletes the file resource. If this denotes a directory, then the directory must be empty in order to be deleted.

Specified by:

delete in interface Resource

Returns:

true if the file is deleted

move

public void move(Resource target)
          throws IOException

Description copied from interface: Resource

Move a file/directory.

Specified by:

move in interface Resource

Parameters:

target - the target file/directory.

Throws:

IOException

getParent

public Resource getParent()

Description copied from interface: Resource

Returns the file resource of this parent, or null if this file resource does not name a parent directory.

Specified by:

getParent in interface Resource

Returns:

parent

list

public List<Resource> list()

Description copied from interface: Resource

Returns a list of file resources denoting the files in the directory denoted by this file resource.

Specified by:

list in interface Resource

Returns:

files and sub folders

list

public List<Resource> list(ResourceFilter filter)

Description copied from interface: Resource

Returns a list of path names denoting the files in the directory denoted by this file resource filtered by argument.

Specified by:

list in interface Resource

Parameters:

filter - filter

Returns:

files and sub folders filtered

listRoots

public List<Resource> listRoots()

Description copied from interface: Resource

List the available filesystem roots. Can return an empty list, but never null.

Specified by:

listRoots in interface Resource

Returns:

filesystem roots

resolve

public List<Resource> resolve(Resource cwd)

Description copied from interface: Resource

Resolve a file that might contain (~,*,?) based on this instance and a given current working directory as argument. The argument can be null.

Specified by:

resolve in interface Resource

Parameters:

cwd - current working directory

Returns:

resolved files

read

public InputStream read()
                 throws FileNotFoundException

Description copied from interface: Resource

InputStream from this FileResource

Specified by:

read in interface Resource

Returns:

stream

Throws:

FileNotFoundException - if the file doesn't exist

readAttributes

public <A extends BasicFileAttributes> A readAttributes(Class<A> type,
                                                        LinkOption... options)
                                                 throws IOException

Specified by:

readAttributes in interface Resource

Throws:

IOException

write

public OutputStream write(boolean append)
                   throws FileNotFoundException

Description copied from interface: Resource

OutputStream that will be written to this FileResource

Specified by:

write in interface Resource

Returns:

stream

Throws:

FileNotFoundException - if file cannot be written to or is !isLeaf()

toString

public String toString()

Overrides:

toString in class Object

newInstance

public Resource newInstance(String path)

Description copied from interface: Resource

Return a new instance of FileResource with String as argument

Specified by:

newInstance in interface Resource

Parameters:

path - argument

Returns:

new instance

copy

public Resource copy(Resource destination)
              throws IOException

Description copied from interface: Resource

Copy a file/directory to destination;

Specified by:

copy in interface Resource

Parameters:

destination - local that you want copy file

Throws:

IOException

setLastModified

public boolean setLastModified(long time)

Description copied from interface: Resource

Sets the last-modified time of the file or directory named by this abstract pathname.

Specified by:

setLastModified in interface Resource

Parameters:

time - The new last-modified time, measured in milliseconds

Returns:

true if and only if the operation succeeded; false otherwise

lastModified

public long lastModified()

Description copied from interface: Resource

Returns the last modified time of the file or directory

Specified by:

lastModified in interface Resource

Returns:

the new last modified time, in milliseconds

setLastAccessed

public void setLastAccessed(long time)
                     throws IOException

Description copied from interface: Resource

Sets the last-accessed time of the file or directory named by this abstract pathname.

Specified by:

setLastAccessed in interface Resource

Parameters:

time - The new last-accessed time, measured in milliseconds

Throws:

IOException

lastAccessed

public long lastAccessed()
                  throws IOException

Description copied from interface: Resource

Returns the last accessed time of the file or directory

Specified by:

lastAccessed in interface Resource

Returns:

the last accessed time, in milliseconds

Throws:

IOException

getFile

public File getFile()