alluxio.underfs

Class UfsStatus

java.lang.Object

alluxio.underfs.UfsStatus

Direct Known Subclasses:

UfsDirectoryStatus, UfsFileStatus

@NotThreadSafe
public abstract class UfsStatus
extends Object

Information about a file or a directory in the under file system. Listing contents in a UnderFileSystem returns entries of this class.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	mGroup
protected boolean	mIsDirectory
protected Long	mLastModifiedTimeMs Last modified epoch time in ms, or null if it is not available.
protected short	mMode
protected String	mName
protected String	mOwner
protected AlluxioURI	mUfsFullPath
protected Map<String,byte[]>	mXAttr

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	UfsStatus(String name, boolean isDirectory, String owner, String group, short mode, Long lastModifiedTimeMs, Map<String,byte[]> xAttrs) Creates new instance of UfsStatus.
protected	UfsStatus(UfsStatus status) Creates a new instance of UfsStatus as a copy.

Method Summary

Modifier and Type	Method and Description
UfsFileStatus	asUfsFileStatus()
static String[]	convertToNames(UfsStatus[] children) Converts an array of UFS file status to a listing result where each element in the array is a file or directory name.
abstract UfsStatus	copy() Create a copy of UfsStatus.
boolean	equals(Object o)
static UfsStatus	fromProto(UfsStatus ufsStatus)
String	getGroup() Gets the group of the given path.
Long	getLastModifiedTime() Gets the UTC time of when the indicated path was modified recently in ms, or null if the last modified time is not available.
short	getMode() Gets the mode of the given path in short format, e.g 0700.
String	getName()
String	getOwner() Gets the owner of the given path.
AlluxioURI	getUfsFullPath()
Map<String,byte[]>	getXAttr() Returns the extended attributes from the Ufs, if any.
int	hashCode()
boolean	isDirectory()
boolean	isFile()
UfsStatus	setName(String name) Set the name of file or directory.
void	setUfsFullPath(AlluxioURI ufsFullPath)
UfsStatus	toProto()
protected com.google.common.base.MoreObjects.ToStringHelper	toStringHelper()

Methods inherited from class java.lang.Object

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

Field Detail

mIsDirectory

protected final boolean mIsDirectory

mLastModifiedTimeMs

protected final Long mLastModifiedTimeMs

Last modified epoch time in ms, or null if it is not available.

mName

protected String mName

mUfsFullPath

protected AlluxioURI mUfsFullPath

mOwner

protected final String mOwner

mGroup

protected final String mGroup

mMode

protected final short mMode

mXAttr

protected final Map<String,byte[]> mXAttr

Constructor Detail

UfsStatus

protected UfsStatus(String name,
                    boolean isDirectory,
                    String owner,
                    String group,
                    short mode,
                    @Nullable
                    Long lastModifiedTimeMs,
                    @Nullable
                    Map<String,byte[]> xAttrs)

Creates new instance of UfsStatus.

Parameters:

name - relative path of file or directory

isDirectory - whether the path is a directory

owner - of the file

group - of the file

mode - of the file

lastModifiedTimeMs - last modified epoch time in ms, or null if it is not available

xAttrs - any extended attributes on the inode

UfsStatus

protected UfsStatus(UfsStatus status)

Creates a new instance of UfsStatus as a copy.

Parameters:

status - file information to copy

Method Detail

getUfsFullPath

public AlluxioURI getUfsFullPath()

Returns:

the full ufs path

setUfsFullPath

public void setUfsFullPath(AlluxioURI ufsFullPath)

Parameters:

ufsFullPath - the ufs full path

copy

public abstract UfsStatus copy()

Create a copy of UfsStatus.

Returns:

new instance as a copy

convertToNames

@Nullable
public static String[] convertToNames(UfsStatus[] children)

Converts an array of UFS file status to a listing result where each element in the array is a file or directory name.

Parameters:

children - array of listing statuses

Returns:

array of file or directory names, or null if the input is null

isDirectory

public boolean isDirectory()

Returns:

true, if the path is a directory

isFile

public boolean isFile()

Returns:

true, if the path is a file

getGroup

public String getGroup()

Gets the group of the given path.

Returns:

the group of the file

getLastModifiedTime

@Nullable
public Long getLastModifiedTime()

Gets the UTC time of when the indicated path was modified recently in ms, or null if the last modified time is not available.

Returns:

modification time in milliseconds

getMode

public short getMode()

Gets the mode of the given path in short format, e.g 0700.

Returns:

the mode of the file

getName

public String getName()

Returns:

name of file or directory

getOwner

public String getOwner()

Gets the owner of the given path.

Returns:

the owner of the path

getXAttr

@Nullable
public Map<String,byte[]> getXAttr()

Returns the extended attributes from the Ufs, if any.

Returns:

a map of the extended attributes. If none, the map will be empty

hashCode

public int hashCode()

Overrides:

hashCode in class Object

setName

public UfsStatus setName(String name)

Set the name of file or directory.

Parameters:

name - of entry

Returns:

this object

toStringHelper

protected com.google.common.base.MoreObjects.ToStringHelper toStringHelper()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

toProto

public UfsStatus toProto()

Returns:

the UfsStatus protobuf

fromProto

public static UfsStatus fromProto(UfsStatus ufsStatus)

Parameters:

ufsStatus - the UfsStatus protobuf

Returns:

the UfsStatus model

asUfsFileStatus

public UfsFileStatus asUfsFileStatus()

Returns:

the object converted to UfsFileStatus type