org.apache.hadoop.fs

Class ContentSummary

java.lang.Object

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

Constructors

Constructor and Description
ContentSummary() Deprecated.
ContentSummary(long length, long fileCount, long directoryCount) Deprecated.
ContentSummary(long length, long fileCount, long directoryCount, long quota, long spaceConsumed, long spaceQuota) Deprecated.

Method Summary

Methods

Modifier and Type	Method and Description
long	getDirectoryCount()
long	getFileCount()
static String	getHeader(boolean qOption) Return the header of the output.
static String[]	getHeaderFields() Returns the names of the fields from the summary header.
long	getLength()
long	getQuota() Return the directory quota
static String[]	getQuotaHeaderFields() Returns the names of the fields used in the quota summary.
long	getSpaceConsumed() Returns storage space consumed
long	getSpaceQuota() Returns storage space quota
static String	getStorageTypeHeader(List<StorageType> storageTypes) return the header of with the StorageTypes
long	getTypeConsumed(StorageType type) Returns storage type consumed
long	getTypeQuota(StorageType type) Returns storage type quota
boolean	isTypeConsumedAvailable() Returns true if any storage type consumption information is available
boolean	isTypeQuotaSet() Returns true if any storage type quota has been set
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.
String	toString(boolean qOption, boolean hOption, boolean tOption, List<StorageType> types) 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

@Deprecated
public ContentSummary()

Deprecated.

Constructor deprecated by ContentSummary.Builder

ContentSummary

@Deprecated
public ContentSummary(long length,
                         long fileCount,
                         long directoryCount)

Deprecated.

Constructor, deprecated by ContentSummary.Builder This constructor implicitly set spaceConsumed the same as length. spaceConsumed and length must be set explicitly with ContentSummary.Builder

ContentSummary

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

Deprecated.

Constructor, deprecated by ContentSummary.Builder

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()

Returns storage space consumed

getSpaceQuota

public long getSpaceQuota()

Returns storage space quota

getTypeQuota

public long getTypeQuota(StorageType type)

Returns storage type quota

getTypeConsumed

public long getTypeConsumed(StorageType type)

Returns storage type consumed

isTypeQuotaSet

public boolean isTypeQuotaSet()

Returns true if any storage type quota has been set

isTypeConsumedAvailable

public boolean isTypeConsumedAvailable()

Returns true if any storage type consumption information is available

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

getStorageTypeHeader

public static String getStorageTypeHeader(List<StorageType> storageTypes)

return the header of with the StorageTypes

Parameters:

storageTypes -

Returns:

storage header string

getHeaderFields

public static String[] getHeaderFields()

Returns the names of the fields from the summary header.

Returns:

names of fields as displayed in the header

getQuotaHeaderFields

public static String[] getQuotaHeaderFields()

Returns the names of the fields used in the quota summary.

Returns:

names of quota fields as displayed in the header

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

toString

public String toString(boolean qOption,
              boolean hOption,
              boolean tOption,
              List<StorageType> types)

Return the string representation of the object in the output format. if tOption is true, display the quota by storage types, Otherwise, same logic with #toString(boolean,boolean)

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

tOption - a flag indicating if display quota by storage types

types - Storage types to display

Returns:

the string representation of the object