TFsShell (Tachyon Project Core 0.6.4 API)

java.lang.Object
- tachyon.command.TFsShell

All Implemented Interfaces:

Closeable, AutoCloseable
```
public class TFsShell
extends Object
implements Closeable
```
Class for handling command line inputs.

Constructor Summary

Constructors
Constructor and Description

TFsShell()

Constructors
Constructor and Description
`TFsShell()`

Method Summary

Methods
Modifier and Type	Method and Description
`int`	`cat(String[] argv)` Prints the file's contents to the console.
`void`	`close()`
`int`	`copyFromLocal(String[] argv)` Copies a file or directory specified by argv from the local filesystem to the filesystem.
`int`	`copyToLocal(String[] argv)` Copies a file specified by argv from the filesystem to the local filesystem.
`int`	`count(String[] argv)` Displays the number of folders and files matching the specified prefix in argv.
`int`	`fileinfo(String[] argv)` Displays the file's all blocks info
`int`	`free(String[] argv)` Free the file or Folder from tachyon in-memory specified by argv
`int`	`location(String[] argv)` Displays a list of hosts that have the file specified in argv stored.
`int`	`ls(String[] argv)` Displays information for all directories and files directly under the path specified in argv.
`int`	`lsr(String[] argv)` Displays information for all directories and files under the path specified in argv recursively.
`static void`	`main(String[] argv)` Main method, starts a new TFsShell
`int`	`mkdir(String[] argv)` Creates a new directory specified by the path in argv, including any parent folders that are required.
`int`	`pin(String[] argv)` Pins the given file or folder (recursively pinning all children if a folder).
`void`	`printUsage()` Method which prints the method to use all the commands.
`int`	`rename(String[] argv)` Renames a file or directory specified by argv.
`int`	`report(String[] argv)`
`int`	`request(String[] argv)`
`int`	`rm(String[] argv)` Removes the file specified by argv.
`int`	`rmr(String[] argv)` Removes the file or directory specified by argv.
`int`	`run(String[] argv)` Method which determines how to handle the user's request, will display usage help to the user if command format is incorrect.
`int`	`tail(String[] argv)` Prints the file's last 1KB of contents to the console.
`int`	`touch(String[] argv)` Creates a 0 byte file specified by argv.
`int`	`unpin(String[] argv)` Unpins the given file or folder (recursively unpinning all children if a folder).

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

- Constructor Detail
  - TFsShell
```
public TFsShell()
```
- Method Detail
  - main
```
public static void main(String[] argv)
                 throws IOException
```
    Main method, starts a new TFsShell
    
    Parameters:
    argv - [] Array of arguments given by the user's input from the terminal
    
    Throws:
    
    IOException
  - close
```
public void close()
           throws IOException
```
    Specified by:
    
    close in interface Closeable
    
    Specified by:
    
    close in interface AutoCloseable
    
    Throws:
    
    IOException
  - cat
```
public int cat(String[] argv)
        throws IOException
```
    Prints the file's contents to the console.
    
    Parameters:
    argv - [] Array of arguments given by the user's input from the terminal
    
    Returns:
    0 if command is successful, -1 if an error occurred.
    
    Throws:
    
    IOException
  - copyFromLocal
```
public int copyFromLocal(String[] argv)
                  throws IOException
```
    Copies a file or directory specified by argv from the local filesystem to the filesystem. Will fail if the path given already exists in the filesystem.
    
    Parameters:
    argv - [] Array of arguments given by the user's input from the terminal
    
    Returns:
    0 if command is successful, -1 if an error occurred.
    
    Throws:
    
    IOException
  - copyToLocal
```
public int copyToLocal(String[] argv)
                throws IOException
```
    Copies a file specified by argv from the filesystem to the local filesystem.
    
    Parameters:
    argv - [] Array of arguments given by the user's input from the terminal
    
    Returns:
    0 if command is successful, -1 if an error occurred.
    
    Throws:
    
    IOException
  - count
```
public int count(String[] argv)
          throws IOException
```
    Displays the number of folders and files matching the specified prefix in argv.
    
    Parameters:
    argv - [] Array of arguments given by the user's input from the terminal
    
    Returns:
    0 if command is successful, -1 if an error occurred.
    
    Throws:
    
    IOException
  - fileinfo
```
public int fileinfo(String[] argv)
             throws IOException
```
    Displays the file's all blocks info
    
    Parameters:
    argv - [] Array of arguments given by the user's input from the terminal
    
    Returns:
    0 if command is successful, -1 if an error occurred.
    
    Throws:
    
    IOException
  - location
```
public int location(String[] argv)
             throws IOException
```
    Displays a list of hosts that have the file specified in argv stored.
    
    Parameters:
    argv - [] Array of arguments given by the user's input from the terminal
    
    Returns:
    0 if command is successful, -1 if an error occurred.
    
    Throws:
    
    IOException
  - ls
```
public int ls(String[] argv)
       throws IOException
```
    Displays information for all directories and files directly under the path specified in argv.
    
    Parameters:
    argv - [] Array of arguments given by the user's input from the terminal
    
    Returns:
    0 if command is successful, -1 if an error occurred.
    
    Throws:
    
    IOException
  - lsr
```
public int lsr(String[] argv)
        throws IOException
```
    Displays information for all directories and files under the path specified in argv recursively.
    
    Parameters:
    argv - [] Array of arguments given by the user's input from the terminal
    
    Returns:
    0 if command is successful, -1 if an error occurred.
    
    Throws:
    
    IOException
  - mkdir
```
public int mkdir(String[] argv)
          throws IOException
```
    Creates a new directory specified by the path in argv, including any parent folders that are required. This method fails if a directory or file with the same path already exists.
    
    Parameters:
    argv - [] Array of arguments given by the user's input from the terminal
    
    Returns:
    0 if command is successful, -1 if an error occurred.
    
    Throws:
    
    IOException
  - pin
```
public int pin(String[] argv)
        throws IOException
```
    Pins the given file or folder (recursively pinning all children if a folder). Pinned files are never evicted from memory.
    
    Parameters:
    argv - [] Array of arguments given by the user's input from the terminal
    
    Returns:
    0 if command is successful, -1 if an error occurred.
    
    Throws:
    
    IOException
  - printUsage
```
public void printUsage()
```
    Method which prints the method to use all the commands.
  - rename
```
public int rename(String[] argv)
           throws IOException
```
    Renames a file or directory specified by argv. Will fail if the new path name already exists.
    
    Parameters:
    argv - [] Array of arguments given by the user's input from the terminal
    
    Returns:
    0 if command is successful, -1 if an error occurred.
    
    Throws:
    
    IOException
  - report
```
public int report(String[] argv)
           throws IOException
```
    Throws:
    
    IOException
  - request
```
public int request(String[] argv)
            throws IOException
```
    Throws:
    
    IOException
  - rm
```
public int rm(String[] argv)
       throws IOException
```
    Removes the file specified by argv.
    
    Parameters:
    argv - [] Array of arguments given by the user's input from the terminal
    
    Returns:
    0 if command is successful, -1 if an error occurred.
    
    Throws:
    
    IOException
  - rmr
```
public int rmr(String[] argv)
        throws IOException
```
    Removes the file or directory specified by argv. Will remove all files and directories in the directory if a directory is specified.
    
    Parameters:
    argv - [] Array of arguments given by the user's input from the terminal
    
    Returns:
    0 if command is successful, -1 if an error occurred.
    
    Throws:
    
    IOException
  - run
```
public int run(String[] argv)
```
    Method which determines how to handle the user's request, will display usage help to the user if command format is incorrect.
    
    Parameters:
    argv - [] Array of arguments given by the user's input from the terminal
    
    Returns:
    0 if command is successful, -1 if an error occurred
  - tail
```
public int tail(String[] argv)
         throws IOException
```
    Prints the file's last 1KB of contents to the console.
    
    Parameters:
    argv - [] Array of arguments given by the user's input from the terminal
    
    Returns:
    0 if command is successful, -1 if an error occurred.f
    
    Throws:
    
    IOException
  - touch
```
public int touch(String[] argv)
          throws IOException
```
    Creates a 0 byte file specified by argv.
    
    Parameters:
    argv - [] Array of arguments given by the user's input from the terminal
    
    Returns:
    0 if command if successful, -1 if an error occurred.
    
    Throws:
    
    IOException
  - unpin
```
public int unpin(String[] argv)
          throws IOException
```
    Unpins the given file or folder (recursively unpinning all children if a folder). Pinned files are never evicted from memory, so this method will allow such files to be evicted.
    
    Parameters:
    argv - [] Array of arguments given by the user's input from the terminal
    
    Returns:
    0 if command is successful, -1 if an error occurred.
    
    Throws:
    
    IOException
  - free
```
public int free(String[] argv)
         throws IOException
```
    Free the file or Folder from tachyon in-memory specified by argv
    
    Parameters:
    argv - [] Array of arguments given by the user's input from the terminal
    
    Returns:
    0 if command if successful, -1 if an error occurred.
    
    Throws:
    
    IOException

Class TFsShell

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TFsShell

Method Detail

main

close

cat

copyFromLocal

copyToLocal

count

fileinfo

location

ls

lsr

mkdir

pin

printUsage

rename

report

request

rm

rmr

run

tail

touch

unpin

free