Package alluxio.cli.fs.command

Class FreeCommand

  • All Implemented Interfaces:
    alluxio.cli.Command, java.io.Closeable, java.lang.AutoCloseable
    @ThreadSafe
@PublicApi
public final class FreeCommand
extends AbstractFileSystemCommand
    Frees the given file or folder from Alluxio storage (recursively freeing all children if a folder).

    • Constructor Summary

      Constructors 
      Constructor Description
      FreeCommand​(alluxio.client.file.FileSystemContext fsContext)
      Constructs a new instance to free the given file or folder from Alluxio.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getCommandName()  
      java.lang.String getDescription()  
      org.apache.commons.cli.Options getOptions()  
      java.lang.String getUsage()  
      int run​(org.apache.commons.cli.CommandLine cl)  
      protected void runPlainPath​(alluxio.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 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

      • FreeCommand

        public FreeCommand​(alluxio.client.file.FileSystemContext fsContext)
        Constructs a new instance to free the given file or folder from Alluxio.
        Parameters:
        fsContext - the filesystem of Alluxio

    • Method Detail

      • getOptions

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

      • getCommandName

        public java.lang.String getCommandName()

      • runPlainPath

        protected void runPlainPath​(alluxio.AlluxioURI path,
                            org.apache.commons.cli.CommandLine cl)
                     throws alluxio.exception.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:
        alluxio.exception.AlluxioException
        java.io.IOException

      • getUsage

        public java.lang.String getUsage()

      • getDescription

        public java.lang.String getDescription()

      • run

        public int run​(org.apache.commons.cli.CommandLine cl)
        throws alluxio.exception.AlluxioException,
               java.io.IOException
        Throws:
        alluxio.exception.AlluxioException
        java.io.IOException

      • validateArgs

        public void validateArgs​(org.apache.commons.cli.CommandLine cl)
                  throws alluxio.exception.status.InvalidArgumentException
        Throws:
        alluxio.exception.status.InvalidArgumentException