org.apache.hadoop.fs
Class ContentSummary

java.lang.Object
  extended by org.apache.hadoop.fs.ContentSummary
All Implemented Interfaces:
Writable

@InterfaceAudience.Public
@InterfaceStability.Evolving
public class ContentSummary
extends Object
implements Writable

Store the summary of a content (a directory or a file).


Constructor Summary
ContentSummary()
          Constructor
ContentSummary(long length, long fileCount, long directoryCount)
          Constructor
ContentSummary(long length, long fileCount, long directoryCount, long quota, long spaceConsumed, long spaceQuota)
          Constructor
 
Method Summary
 long getDirectoryCount()
           
 long getFileCount()
           
static String getHeader(boolean qOption)
          Return the header of the output.
 long getLength()
           
 long getQuota()
          Return the directory quota
 long getSpaceConsumed()
          Retuns (disk) space consumed
 long getSpaceQuota()
          Returns (disk) space quota
 String toString()
           
 String toString(boolean qOption)
          Return the string representation of the object in the output format.
 String toString(boolean qOption, boolean hOption)
          Return the string representation of the object in the output format.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ContentSummary

public ContentSummary()
Constructor


ContentSummary

public ContentSummary(long length,
                      long fileCount,
                      long directoryCount)
Constructor


ContentSummary

public ContentSummary(long length,
                      long fileCount,
                      long directoryCount,
                      long quota,
                      long spaceConsumed,
                      long spaceQuota)
Constructor

Method Detail

getLength

public long getLength()
Returns:
the length

getDirectoryCount

public long getDirectoryCount()
Returns:
the directory count

getFileCount

public long getFileCount()
Returns:
the file count

getQuota

public long getQuota()
Return the directory quota


getSpaceConsumed

public long getSpaceConsumed()
Retuns (disk) space consumed


getSpaceQuota

public long getSpaceQuota()
Returns (disk) space quota


getHeader

public static String getHeader(boolean qOption)
Return the header of the output. if qOption is false, output directory count, file count, and content size; if qOption is true, output quota and remaining quota as well.

Parameters:
qOption - a flag indicating if quota needs to be printed or not
Returns:
the header of the output

toString

public String toString()
Overrides:
toString in class Object

toString

public String toString(boolean qOption)
Return the string representation of the object in the output format. if qOption is false, output directory count, file count, and content size; if qOption is true, output quota and remaining quota as well.

Parameters:
qOption - a flag indicating if quota needs to be printed or not
Returns:
the string representation of the object

toString

public String toString(boolean qOption,
                       boolean hOption)
Return the string representation of the object in the output format. if qOption is false, output directory count, file count, and content size; if qOption is true, output quota and remaining quota as well. if hOption is false file sizes are returned in bytes if hOption is true file sizes are returned in human readable

Parameters:
qOption - a flag indicating if quota needs to be printed or not
hOption - a flag indicating if human readable output if to be used
Returns:
the string representation of the object


Copyright © 2014 Apache Software Foundation. All Rights Reserved.