org.apache.hudi.storage

Class StoragePathInfo

java.lang.Object

org.apache.hudi.storage.StoragePathInfo

All Implemented Interfaces:

Serializable, Comparable<StoragePathInfo>

@PublicAPIClass(maturity=EVOLVING)
public class StoragePathInfo
extends Object
implements Serializable, Comparable<StoragePathInfo>

Represents the information of a storage path representing a directory or a file. The APIs are mainly based on org.apache.hadoop.fs.FileStatus class with simplification based on what Hudi needs.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
StoragePathInfo(StoragePath path, long length, boolean isDirectory, short blockReplication, long blockSize, long modificationTime)
StoragePathInfo(StoragePath path, long length, boolean isDirectory, short blockReplication, long blockSize, long modificationTime, String[] locations)

Method Summary

Modifier and Type	Method and Description
int	compareTo(StoragePathInfo o)
boolean	equals(Object o)
short	getBlockReplication()
long	getBlockSize()
long	getLength()
String[]	getLocations()
long	getModificationTime()
StoragePath	getPath()
int	hashCode()
boolean	isDirectory()
boolean	isFile()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

StoragePathInfo

public StoragePathInfo(StoragePath path,
                       long length,
                       boolean isDirectory,
                       short blockReplication,
                       long blockSize,
                       long modificationTime)

StoragePathInfo

public StoragePathInfo(StoragePath path,
                       long length,
                       boolean isDirectory,
                       short blockReplication,
                       long blockSize,
                       long modificationTime,
                       String[] locations)

Method Detail

getPath

@PublicAPIMethod(maturity=EVOLVING)
public StoragePath getPath()

Returns:

the path.

getLength

@PublicAPIMethod(maturity=EVOLVING)
public long getLength()

Returns:

the length of a file in bytes.

isFile

@PublicAPIMethod(maturity=EVOLVING)
public boolean isFile()

Returns:

whether this is a file.

isDirectory

@PublicAPIMethod(maturity=EVOLVING)
public boolean isDirectory()

Returns:

whether this is a directory.

getBlockReplication

@PublicAPIMethod(maturity=EVOLVING)
public short getBlockReplication()

Returns:

the block replication if applied.

getBlockSize

@PublicAPIMethod(maturity=EVOLVING)
public long getBlockSize()

Returns:

the block size in bytes if applied.

getModificationTime

@PublicAPIMethod(maturity=EVOLVING)
public long getModificationTime()

Returns:

the modification of a file.

getLocations

@PublicAPIMethod(maturity=EVOLVING)
public String[] getLocations()

Returns:

the locations of the file in the file system, possibly null.

compareTo

public int compareTo(StoragePathInfo o)

Specified by:

compareTo in interface Comparable<StoragePathInfo>

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