alluxio.cli.fs.command

Class PinCommand

java.lang.Object

alluxio.cli.fs.command.AbstractFileSystemCommand

alluxio.cli.fs.command.PinCommand

All Implemented Interfaces:

Command, java.io.Closeable, java.lang.AutoCloseable

@ThreadSafe
 @PublicApi
public final class PinCommand
extends AbstractFileSystemCommand

Pins the given file or folder (recursively pinning all children if a folder). Pinned files are never evicted from memory.

Field Summary

Fields inherited from class alluxio.cli.fs.command.AbstractFileSystemCommand

mFileSystem, mFsContext

Constructor Summary

Constructors

Constructor and Description
PinCommand(FileSystemContext fsContext)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCommandName()
java.lang.String	getDescription()
java.lang.String	getUsage()
int	run(org.apache.commons.cli.CommandLine cl)
protected void	runPlainPath(AlluxioURI path, org.apache.commons.cli.CommandLine cl) Runs the command for a particular URI that does not contain wildcard in its path.
void	validateArgs(org.apache.commons.cli.CommandLine cl)

Methods inherited from class alluxio.cli.fs.command.AbstractFileSystemCommand

processHeader, runWildCardCmd

Methods inherited from class java.lang.Object

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

Methods inherited from interface alluxio.cli.Command

close, getOptions, getSubCommands, hasSubCommand, parseAndValidateArgs

Constructor Detail

PinCommand

public PinCommand(FileSystemContext fsContext)

Parameters:

fsContext - the filesystem of Alluxio

Method Detail

getCommandName

public java.lang.String getCommandName()

runPlainPath

protected void runPlainPath(AlluxioURI path,
                            org.apache.commons.cli.CommandLine cl)
                     throws AlluxioException,
                            java.io.IOException

Description copied from class: AbstractFileSystemCommand

Runs the command for a particular URI that does not contain wildcard in its path.

Overrides:

runPlainPath in class AbstractFileSystemCommand

Parameters:

path - an AlluxioURI that does not contain wildcard

cl - object containing the original commandLine

Throws:

AlluxioException

java.io.IOException

run

public int run(org.apache.commons.cli.CommandLine cl)
        throws AlluxioException,
               java.io.IOException

Throws:

AlluxioException

java.io.IOException

getUsage

public java.lang.String getUsage()

getDescription

public java.lang.String getDescription()

validateArgs

public void validateArgs(org.apache.commons.cli.CommandLine cl)
                  throws InvalidArgumentException

Throws:

InvalidArgumentException