alluxio.client.file.cache

Class CacheUsageView.ImmutableCacheUsageView

java.lang.Object

alluxio.client.file.cache.CacheUsageView.ImmutableCacheUsageView

All Implemented Interfaces:

CacheUsage, CacheUsageView

Enclosing interface:

CacheUsageView

public static final class CacheUsageView.ImmutableCacheUsageView
extends Object
implements CacheUsage

Immutable holder of cache stats.

Nested Class Summary

Nested classes/interfaces inherited from interface alluxio.client.file.cache.CacheUsage

CacheUsage.DirPartition, CacheUsage.FilePartition, CacheUsage.PartitionDescriptor<T>, CacheUsage.ScopePartition

Nested classes/interfaces inherited from interface alluxio.client.file.cache.CacheUsageView

CacheUsageView.ImmutableCacheUsageView

Constructor Summary

Constructors

Constructor and Description
ImmutableCacheUsageView(long used, long available, long capacity) Constructor.

Method Summary

Modifier and Type	Method and Description
long	available() Bytes that are available for caching.
long	capacity() Total capacity of the cache.
boolean	equals(Object o)
int	hashCode()
Optional<CacheUsage>	partitionedBy(CacheUsage.PartitionDescriptor<?> partition) Gets a finer-grained view of cache usage.
CacheUsageView	snapshot() Creates an immutable snapshot of the current cache usage.
String	toString()
long	used() Bytes currently used by the cache.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ImmutableCacheUsageView

public ImmutableCacheUsageView(long used,
                               long available,
                               long capacity)

Constructor.

Parameters:

used - used

available - available

capacity - capacity

Method Detail

used

public long used()

Description copied from interface: CacheUsageView

Bytes currently used by the cache. This includes both evictable and inevitable pages.

Specified by:

used in interface CacheUsageView

Returns:

number of bytes being used

available

public long available()

Description copied from interface: CacheUsageView

Bytes that are available for caching. This includes free space, as well as the space occupied by evictable pages.

Specified by:

available in interface CacheUsageView

Returns:

number of bytes that can be used for caching

capacity

public long capacity()

Description copied from interface: CacheUsageView

Total capacity of the cache.

Specified by:

capacity in interface CacheUsageView

Returns:

total number of bytes the cache is allowed to use

snapshot

public CacheUsageView snapshot()

Description copied from interface: CacheUsage

Creates an immutable snapshot of the current cache usage.

Specified by:

snapshot in interface CacheUsage

Returns:

the snapshot

partitionedBy

public Optional<CacheUsage> partitionedBy(CacheUsage.PartitionDescriptor<?> partition)

Description copied from interface: CacheUsage

Gets a finer-grained view of cache usage.
Example of getting cache usage of a particular file:

 cacheManager.getUsage()
     .flatMap(usage -> usage.partitionedBy(PartitionDescriptor.file(fileId))
     .map(CacheUsage::used)
     .orElse(0)
 

Specified by:

partitionedBy in interface CacheUsage

Parameters:

partition - how to partition the cache

Returns:

partitioned view of cache usage, none if this usage object does not support partitioning, or usage info for the specified partition is not found

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object