alluxio.cli.fs.command

Class StatCommand

java.lang.Object

alluxio.cli.fs.command.AbstractFileSystemCommand

alluxio.cli.fs.command.StatCommand

All Implemented Interfaces:

Command, Closeable, AutoCloseable

@ThreadSafe
 @PublicApi
public final class StatCommand
extends AbstractFileSystemCommand

Displays the path's info. If path is a directory it displays the directory's info. If path is a file, it displays the file's all blocks info.

Field Summary

Fields

Modifier and Type	Field and Description
static org.apache.commons.cli.Option	FILE_ID_OPTION
static org.apache.commons.cli.Option	FORMAT_OPTION

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

mFileSystem, mFsContext

Constructor Summary

Constructors

Constructor and Description
StatCommand(FileSystemContext fsContext)

Method Summary

Modifier and Type	Method and Description
String	getCommandName() Gets the command name as input from the shell.
String	getDescription()
org.apache.commons.cli.Options	getOptions()
String	getUsage()
int	run(org.apache.commons.cli.CommandLine cl) Runs the command.
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) Checks if the arguments are valid or throw InvalidArgumentException.

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, getSubCommands, hasSubCommand, parseAndValidateArgs

Field Detail

FORMAT_OPTION

public static final org.apache.commons.cli.Option FORMAT_OPTION

FILE_ID_OPTION

public static final org.apache.commons.cli.Option FILE_ID_OPTION

Constructor Detail

StatCommand

public StatCommand(FileSystemContext fsContext)

Parameters:

fsContext - the filesystem of Alluxio

Method Detail

getCommandName

public String getCommandName()

Description copied from interface: Command

Gets the command name as input from the shell.

Returns:

the command name

getOptions

public org.apache.commons.cli.Options getOptions()

Returns:

the supported Options of the command

runPlainPath

protected void runPlainPath(AlluxioURI path,
                            org.apache.commons.cli.CommandLine cl)
                     throws AlluxioException,
                            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

IOException

run

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

Description copied from interface: Command

Runs the command.

Parameters:

cl - the parsed command line for the arguments

Returns:

the result of running the command

Throws:

AlluxioException

IOException

getUsage

public String getUsage()

Returns:

the usage information of the command

getDescription

public String getDescription()

Returns:

the description information of the command

validateArgs

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

Description copied from interface: Command

Checks if the arguments are valid or throw InvalidArgumentException.

Parameters:

cl - the parsed command line for the arguments

Throws:

InvalidArgumentException - when arguments are not valid