alluxio.cli.fs.command

Class DuCommand

java.lang.Object

alluxio.cli.fs.command.AbstractFileSystemCommand

alluxio.cli.fs.command.DuCommand

All Implemented Interfaces:

Command, Closeable, AutoCloseable

@ThreadSafe
 @PublicApi
public final class DuCommand
extends AbstractFileSystemCommand

Displays the size of a file or a directory specified by argv.

Field Summary

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

mFileSystem, mFsContext

Constructor Summary

Constructors

Constructor and Description
DuCommand(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()
protected static void	getSizeInfo(AlluxioURI path, List<URIStatus> statuses, boolean readable, boolean summarize, boolean addMemory) Gets and prints the size information of the input path according to options.
String	getUsage()
protected void	processHeader(org.apache.commons.cli.CommandLine cl) Processes the header of the command.
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

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

Constructor Detail

DuCommand

public DuCommand(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

processHeader

protected void processHeader(org.apache.commons.cli.CommandLine cl)

Description copied from class: AbstractFileSystemCommand

Processes the header of the command. Our input path may contain wildcard but we only want to print the header for once.

Overrides:

processHeader in class AbstractFileSystemCommand

Parameters:

cl - object containing the original commandLine

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

getSizeInfo

protected static void getSizeInfo(AlluxioURI path,
                                  List<URIStatus> statuses,
                                  boolean readable,
                                  boolean summarize,
                                  boolean addMemory)

Gets and prints the size information of the input path according to options.

Parameters:

path - the path to get size info of

statuses - the statuses of files and folders

readable - whether to print info of human readable format

summarize - whether to display the aggregate summary lengths

addMemory - whether to display the memory size and percentage information

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

getOptions

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

Returns:

the supported Options of the command

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