org.apache.hadoop.fs.s3a.s3guard

Class PathMetadata

java.lang.Object

org.apache.hadoop.fs.s3a.s3guard.PathMetadata

Direct Known Subclasses:

DDBPathMetadata

@InterfaceAudience.Private
 @InterfaceStability.Evolving
public class PathMetadata
extends Object

PathMetadata models path metadata stored in the MetadataStore.

Constructor Summary

Constructors

Constructor and Description
PathMetadata(org.apache.hadoop.fs.FileStatus fileStatus) Creates a new PathMetadata containing given FileStatus.
PathMetadata(org.apache.hadoop.fs.FileStatus fileStatus, Tristate isEmptyDir)
PathMetadata(org.apache.hadoop.fs.FileStatus fileStatus, Tristate isEmptyDir, boolean isDeleted)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
org.apache.hadoop.fs.FileStatus	getFileStatus()
int	hashCode()
boolean	isDeleted()
Tristate	isEmptyDirectory() Query if a directory is empty.
String	prettyPrint()
void	prettyPrint(StringBuilder sb) Log contents to supplied StringBuilder in a pretty fashion.
static PathMetadata	tombstone(org.apache.hadoop.fs.Path path) Create a tombstone from the current time.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

PathMetadata

public PathMetadata(org.apache.hadoop.fs.FileStatus fileStatus)

Creates a new PathMetadata containing given FileStatus.

Parameters:

fileStatus - file status containing an absolute path.

PathMetadata

public PathMetadata(org.apache.hadoop.fs.FileStatus fileStatus,
                    Tristate isEmptyDir)

PathMetadata

public PathMetadata(org.apache.hadoop.fs.FileStatus fileStatus,
                    Tristate isEmptyDir,
                    boolean isDeleted)

Method Detail

tombstone

public static PathMetadata tombstone(org.apache.hadoop.fs.Path path)

Create a tombstone from the current time.

Parameters:

path - path to tombstone

Returns:

the entry.

getFileStatus

public final org.apache.hadoop.fs.FileStatus getFileStatus()

Returns:

FileStatus contained in this PathMetadata.

isEmptyDirectory

public Tristate isEmptyDirectory()

Query if a directory is empty.

Returns:

Tristate.TRUE if this is known to be an empty directory, Tristate.FALSE if known to not be empty, and Tristate.UNKNOWN if the MetadataStore does have enough information to determine either way.

isDeleted

public boolean isDeleted()

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

prettyPrint

public void prettyPrint(StringBuilder sb)

Log contents to supplied StringBuilder in a pretty fashion.

Parameters:

sb - target StringBuilder

prettyPrint

public String prettyPrint()