FileCommand (Mule File Extension Common 0.9.0-rc.aquaman API)

java.lang.Object
- org.mule.extension.file.common.api.command.FileCommand<F>

Type Parameters:

F - the generic type of the FileSystem on which the operation is performed
```
public abstract class FileCommand<F extends FileSystem>
extends Object
```
Base class for implementations of the Command design pattern which performs operations on a file system

Since:

1.0

Field Summary

Fields
Modifier and Type Field and Description

protected F fileSystem

Fields
Modifier and Type	Field and Description
`protected F`	`fileSystem`

Constructor Summary

Constructors
Modifier Constructor and Description

protected FileCommand(F fileSystem)
Creates a new instance

Constructors
Modifier	Constructor and Description
`protected`	`FileCommand(F fileSystem)` Creates a new instance

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`FileAlreadyExistsException`	`alreadyExistsException(Path path)` Returns a `IllegalPathException` explaining that an operation is trying to write to the given `path` but it already exists and no overwrite instruction was provided.
`protected void`	`assureParentFolderExists(Path path, boolean createParentFolder)`
`protected IllegalPathException`	`cannotListFileException(Path path)` Returns a `IllegalPathException` explaining that a `FileSystem#list(FileConnectorConfig, String, boolean, Message, Predicate)` operation was attempted on a `path` pointing to a file.
`protected IllegalPathException`	`cannotReadDirectoryException(Path path)` Returns an `IllegalPathException` explaining that a `FileSystem#read(FileConnectorConfig, Message, String, boolean)` operation was attempted on a `path` pointing to a directory
`protected abstract void`	`doMkDirs(Path directoryPath)`
`RuntimeException`	`exception(String message)` Returns a properly formatted `MuleRuntimeException` for the given `message` and `cause`
`RuntimeException`	`exception(String message, Exception cause)` Returns a properly formatted `MuleRuntimeException` for the given `message` and `cause`
`protected abstract boolean`	`exists(Path path)` Returns true if the given `path` exists
`protected abstract Path`	`getBasePath(FileSystem fileSystem)` Returns a `Path` to which all non absolute paths are relative to
`protected boolean`	`isVirtualDirectory(String fileName)`
`protected void`	`mkdirs(Path directoryPath)` Creates the directory pointed by `directoryPath` also creating any missing parent directories
`protected IllegalPathException`	`pathNotFoundException(Path path)` Returns a `IllegalPathException` explaining that a `FileSystem#list(FileConnectorConfig, String, boolean, Message, Predicate)` operation was attempted on a `path` pointing to a file.
`protected Path`	`resolveExistingPath(String filePath)` Similar to `resolvePath(String)` only that it throws a `IllegalArgumentException` if the given path doesn't exists.
`protected Path`	`resolvePath(String filePath)` Returns an absolute `Path` to the given `filePath`

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

- Field Detail
  - fileSystem
```
protected final F extends FileSystem fileSystem
```
- Constructor Detail
  - FileCommand
```
protected FileCommand(F fileSystem)
```
    Creates a new instance
    
    Parameters:
    
    fileSystem - the FileSystem on which the operation is performed
- Method Detail
  - exists
```
protected abstract boolean exists(Path path)
```
    Returns true if the given path exists
    
    Parameters:
    
    path - the Path to test
    
    Returns:
    
    whether the path exists
  - assureParentFolderExists
```
protected void assureParentFolderExists(Path path,
                                        boolean createParentFolder)
```
  - mkdirs
```
protected final void mkdirs(Path directoryPath)
```
    Creates the directory pointed by directoryPath also creating any missing parent directories
    
    Parameters:
    
    directoryPath - the Path to the directory you want to create
  - doMkDirs
```
protected abstract void doMkDirs(Path directoryPath)
```
  - resolvePath
```
protected Path resolvePath(String filePath)
```
    Returns an absolute Path to the given filePath
    
    Parameters:
    
    filePath - the path to a file or directory
    
    Returns:
    
    an absolute Path
  - getBasePath
```
protected abstract Path getBasePath(FileSystem fileSystem)
```
    Returns a Path to which all non absolute paths are relative to
    
    Parameters:
    
    fileSystem - the file system that we're connecting to
    
    Returns:
    
    a not null Path
  - resolveExistingPath
```
protected Path resolveExistingPath(String filePath)
```
    Similar to resolvePath(String) only that it throws a IllegalArgumentException if the given path doesn't exists.
    The existence of the obtained path is verified by delegating into exists(Path)
    
    Parameters:
    
    filePath - the path to a file or directory
    
    Returns:
    
    an absolute Path
  - exception
```
public RuntimeException exception(String message)
```
    Returns a properly formatted MuleRuntimeException for the given message and cause
    
    Parameters:
    
    message - the exception's message
    
    Returns:
    
    a RuntimeException
  - exception
```
public RuntimeException exception(String message,
                                  Exception cause)
```
    Returns a properly formatted MuleRuntimeException for the given message and cause
    
    Parameters:
    
    message - the exception's message
    
    cause - the exception's cause
    
    Returns:
    
    RuntimeException
  - isVirtualDirectory
```
protected boolean isVirtualDirectory(String fileName)
```
    Parameters:
    
    fileName - the name of a file
    
    Returns:
    
    true if fileName equals to "." or ".."
  - cannotReadDirectoryException
```
protected IllegalPathException cannotReadDirectoryException(Path path)
```
    Returns an IllegalPathException explaining that a FileSystem#read(FileConnectorConfig, Message, String, boolean) operation was attempted on a path pointing to a directory
    
    Parameters:
    
    path - the Path on which a read was attempted
    
    Returns:
    
    IllegalPathException
  - cannotListFileException
```
protected IllegalPathException cannotListFileException(Path path)
```
    Returns a IllegalPathException explaining that a FileSystem#list(FileConnectorConfig, String, boolean, Message, Predicate) operation was attempted on a path pointing to a file.
    
    Parameters:
    
    path - the Path on which a list was attempted
    
    Returns:
    
    IllegalPathException
  - pathNotFoundException
```
protected IllegalPathException pathNotFoundException(Path path)
```
    Returns a IllegalPathException explaining that a FileSystem#list(FileConnectorConfig, String, boolean, Message, Predicate) operation was attempted on a path pointing to a file.
    
    Parameters:
    
    path - the Path on which a list was attempted
    
    Returns:
    
    RuntimeException
  - alreadyExistsException
```
public FileAlreadyExistsException alreadyExistsException(Path path)
```
    Returns a IllegalPathException explaining that an operation is trying to write to the given path but it already exists and no overwrite instruction was provided.
    
    Parameters:
    
    path - the Path that the operation tried to modify
    
    Returns:
    
    IllegalPathException

Class FileCommand<F extends FileSystem>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

fileSystem

Constructor Detail

FileCommand

Method Detail

exists

assureParentFolderExists

mkdirs

doMkDirs

resolvePath

getBasePath

resolveExistingPath

exception

exception

isVirtualDirectory

cannotReadDirectoryException

cannotListFileException

pathNotFoundException

alreadyExistsException