Resource

All Known Implementing Classes:

FileResource
```
public interface Resource
```
FileResource is a Aesh native io class. The default implementation is based on java.io.File, but it can be specified by the Settings object when it needs to be overridden.

Method Summary

All Methods Instance Methods Abstract Methods
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.
`java.lang.String`	`getAbsolutePath()` Returns the absolute file resource string of this
`java.lang.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
`java.util.List<Resource>`	`list()` Returns a list of file resources denoting the files in the directory denoted by this file resource.
`java.util.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.
`java.util.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(java.lang.String path)` Return a new instance of FileResource with String as argument
`java.io.InputStream`	`read()` InputStream from this FileResource
`<A extends java.nio.file.attribute.BasicFileAttributes> A`	`readAttributes(java.lang.Class<A> type, java.nio.file.LinkOption... options)`
`Resource`	`readSymbolicLink()` If the Resource system support symbolic links and this is a symbolic link, return the link target.
`java.util.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.
`java.io.OutputStream`	`write(boolean append)` OutputStream that will be written to this FileResource

- Method Detail
  - getName
```
java.lang.String getName()
```
    Returns the name of this file resource
    
    Returns:
    
    name
  - getAbsolutePath
```
java.lang.String getAbsolutePath()
```
    Returns the absolute file resource string of this
    
    Returns:
    
    absolute path
  - isLeaf
```
boolean isLeaf()
```
    Return true if this file resource is a file, not a directory. exists() must return true for isLeaf() to return true.
    
    Returns:
    
    true if file
  - isDirectory
```
boolean isDirectory()
```
    Check if the file denoted is a directory.
    
    Returns:
    
    true if directory
  - isSymbolicLink
```
boolean isSymbolicLink()
```
    Return true if this resource is a symbolic link.
    
    Returns:
    
    true if symbolic link
  - readSymbolicLink
```
Resource readSymbolicLink()
                   throws java.io.IOException
```
    If the Resource system support symbolic links and this is a symbolic link, return the link target. The target does not need to exist.
    
    Returns:
    
    link target
    
    Throws:
    
    java.io.IOException
  - exists
```
boolean exists()
```
    Check if this file resource exists.
    
    Returns:
    
    true if exists
  - mkdirs
```
boolean mkdirs()
```
    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.
    
    Returns:
    
    true if all directories have been successfully created
  - delete
```
boolean delete()
```
    Deletes the file resource. If this denotes a directory, then the directory must be empty in order to be deleted.
    
    Returns:
    
    true if the file is deleted
  - move
```
void move(Resource target)
   throws java.io.IOException
```
    Move a file/directory.
    
    Parameters:
    
    target - the target file/directory.
    
    Throws:
    
    java.io.IOException
  - getParent
```
Resource getParent()
```
    Returns the file resource of this parent, or null if this file resource does not name a parent directory.
    
    Returns:
    
    parent
  - list
```
java.util.List<Resource> list()
```
    Returns a list of file resources denoting the files in the directory denoted by this file resource.
    
    Returns:
    
    files and sub folders
  - list
```
java.util.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.
    
    Parameters:
    
    filter - filter
    
    Returns:
    
    files and sub folders filtered
  - listRoots
```
java.util.List<Resource> listRoots()
```
    List the available filesystem roots. Can return an empty list, but never null.
    
    Returns:
    
    filesystem roots
  - resolve
```
java.util.List<Resource> resolve(Resource cwd)
```
    Resolve a file that might contain (~,*,?) based on this instance and a given current working directory as argument. The argument can be null.
    
    Parameters:
    
    cwd - current working directory
    
    Returns:
    
    resolved files
  - write
```
java.io.OutputStream write(boolean append)
                    throws java.io.FileNotFoundException
```
    OutputStream that will be written to this FileResource
    
    Parameters:
    
    append -
    
    Returns:
    
    stream
    
    Throws:
    
    java.io.FileNotFoundException - if file cannot be written to or is !isLeaf()
  - read
```
java.io.InputStream read()
                  throws java.io.FileNotFoundException
```
    InputStream from this FileResource
    
    Returns:
    
    stream
    
    Throws:
    
    java.io.FileNotFoundException - if the file doesn't exist
  - readAttributes
```
<A extends java.nio.file.attribute.BasicFileAttributes> A readAttributes(java.lang.Class<A> type,
                                                                         java.nio.file.LinkOption... options)
                                                                  throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - newInstance
```
Resource newInstance(java.lang.String path)
```
    Return a new instance of FileResource with String as argument
    
    Parameters:
    
    path - argument
    
    Returns:
    
    new instance
  - copy
```
Resource copy(Resource destination)
       throws java.io.IOException
```
    Copy a file/directory to destination;
    
    Parameters:
    
    destination - local that you want copy file
    
    Throws:
    
    java.io.IOException
  - setLastModified
```
boolean setLastModified(long time)
```
    Sets the last-modified time of the file or directory named by this abstract pathname.
    
    Parameters:
    
    time - The new last-modified time, measured in milliseconds
    
    Returns:
    
    true if and only if the operation succeeded; false otherwise
  - lastModified
```
long lastModified()
```
    Returns the last modified time of the file or directory
    
    Returns:
    
    the new last modified time, in milliseconds
  - setLastAccessed
```
void setLastAccessed(long time)
              throws java.io.IOException
```
    Sets the last-accessed time of the file or directory named by this abstract pathname.
    
    Parameters:
    
    time - The new last-accessed time, measured in milliseconds
    
    Throws:
    
    java.io.IOException
  - lastAccessed
```
long lastAccessed()
           throws java.io.IOException
```
    Returns the last accessed time of the file or directory
    
    Returns:
    
    the last accessed time, in milliseconds
    
    Throws:
    
    java.io.IOException

Interface Resource

Method Summary

Method Detail

getName

getAbsolutePath

isLeaf

isDirectory

isSymbolicLink

readSymbolicLink

exists

mkdirs

delete

move

getParent

list

list

listRoots

resolve

write

read

readAttributes

newInstance

copy

setLastModified

lastModified

setLastAccessed

lastAccessed