FileStatus (Apache Hadoop Common 3.4.1.200-dep-1000 API)

java.lang.Object
- org.apache.hadoop.fs.FileStatus

All Implemented Interfaces:

java.io.ObjectInputValidation, java.io.Serializable, java.lang.Comparable<java.lang.Object>, Writable

Direct Known Subclasses:

LocatedFileStatus
```
@Public
@Stable
public class FileStatus
extends java.lang.Object
implements Writable, java.lang.Comparable<java.lang.Object>, java.io.Serializable, java.io.ObjectInputValidation
```
Interface that represents the client side information for a file.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class FileStatus.AttrFlags
Flags for entity attributes.

Nested Classes
Modifier and Type	Class	Description
`static class`	`FileStatus.AttrFlags`	Flags for entity attributes.

Field Summary

Fields
Modifier and Type Field Description

static java.util.Set<FileStatus.AttrFlags> NONE
Shared, empty set of attributes (a common case for FileStatus).

Fields
Modifier and Type	Field	Description
`static java.util.Set<FileStatus.AttrFlags>`	`NONE`	Shared, empty set of attributes (a common case for FileStatus).

Constructor Summary

Constructors
Constructor	Description
`FileStatus()`
`FileStatus(long length, boolean isdir, int block_replication, long blocksize, long modification_time, long access_time, FsPermission permission, java.lang.String owner, java.lang.String group, Path path)`	Constructor for file systems on which symbolic links are not supported
`FileStatus(long length, boolean isdir, int block_replication, long blocksize, long modification_time, long access_time, FsPermission permission, java.lang.String owner, java.lang.String group, Path symlink, Path path)`
`FileStatus(long length, boolean isdir, int block_replication, long blocksize, long modification_time, long access_time, FsPermission permission, java.lang.String owner, java.lang.String group, Path symlink, Path path, boolean hasAcl, boolean isEncrypted, boolean isErasureCoded)`
`FileStatus(long length, boolean isdir, int block_replication, long blocksize, long modification_time, long access_time, FsPermission permission, java.lang.String owner, java.lang.String group, Path symlink, Path path, java.util.Set<FileStatus.AttrFlags> attr)`
`FileStatus(long length, boolean isdir, int block_replication, long blocksize, long modification_time, Path path)`
`FileStatus(FileStatus other)`	Copy constructor.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`static java.util.Set<FileStatus.AttrFlags>`	`attributes(boolean acl, boolean crypt, boolean ec, boolean sn)`	Convert boolean attributes to a set of flags.
`int`	`compareTo(java.lang.Object o)`	Compare this FileStatus to another FileStatus based on lexicographical order of path.
`int`	`compareTo(FileStatus o)`	Compare this FileStatus to another FileStatus based on lexicographical order of path.
`boolean`	`equals(java.lang.Object o)`	Compare if this object is equal to another object
`long`	`getAccessTime()`	Get the access time of the file.
`long`	`getBlockSize()`	Get the block size of the file.
`java.lang.String`	`getGroup()`	Get the group associated with the file.
`long`	`getLen()`	Get the length of this file, in bytes.
`long`	`getModificationTime()`	Get the modification time of the file.
`java.lang.String`	`getOwner()`	Get the owner of the file.
`Path`	`getPath()`
`FsPermission`	`getPermission()`	Get FsPermission associated with the file.
`short`	`getReplication()`	Get the replication factor of a file.
`Path`	`getSymlink()`
`boolean`	`hasAcl()`	Tell whether the underlying file or directory has ACLs set.
`int`	`hashCode()`	Returns a hash code value for the object, which is defined as the hash code of the path name.
`boolean`	`isDir()`	Deprecated. Use `isFile()`, `isDirectory()`, and `isSymlink()` instead.
`boolean`	`isDirectory()`	Is this a directory?
`boolean`	`isEncrypted()`	Tell whether the underlying file or directory is encrypted or not.
`boolean`	`isErasureCoded()`	Tell whether the underlying file or directory is erasure coded or not.
`boolean`	`isFile()`	Is this a file?
`boolean`	`isSnapshotEnabled()`	Check if directory is Snapshot enabled or not.
`boolean`	`isSymlink()`	Is this a symbolic link?
`boolean`	`isTable()`	Is this a table type
`void`	`readFields(java.io.DataInput in)`	Deprecated. Use the `PBHelper` and protobuf serialization directly.
`protected void`	`setGroup(java.lang.String group)`	Sets group.
`protected void`	`setOwner(java.lang.String owner)`	Sets owner.
`void`	`setPath(Path p)`
`protected void`	`setPermission(FsPermission permission)`	Sets permission.
`void`	`setSymlink(Path p)`
`java.lang.String`	`toString()`
`void`	`validateObject()`
`void`	`write(java.io.DataOutput out)`	Deprecated. Use the `PBHelper` and protobuf serialization directly.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - NONE
```
public static final java.util.Set<FileStatus.AttrFlags> NONE
```
    Shared, empty set of attributes (a common case for FileStatus).
- Constructor Detail
  - FileStatus
```
public FileStatus()
```
  - FileStatus
```
public FileStatus(long length,
                  boolean isdir,
                  int block_replication,
                  long blocksize,
                  long modification_time,
                  Path path)
```
  - FileStatus
```
public FileStatus(long length,
                  boolean isdir,
                  int block_replication,
                  long blocksize,
                  long modification_time,
                  long access_time,
                  FsPermission permission,
                  java.lang.String owner,
                  java.lang.String group,
                  Path path)
```
    Constructor for file systems on which symbolic links are not supported
    
    Parameters:
    
    length - length.
    
    isdir - isdir.
    
    block_replication - block replication.
    
    blocksize - block size.
    
    modification_time - modification time.
    
    access_time - access_time.
    
    permission - permission.
    
    owner - owner.
    
    group - group.
    
    path - the path.
  - FileStatus
```
public FileStatus(long length,
                  boolean isdir,
                  int block_replication,
                  long blocksize,
                  long modification_time,
                  long access_time,
                  FsPermission permission,
                  java.lang.String owner,
                  java.lang.String group,
                  Path symlink,
                  Path path)
```
  - FileStatus
```
public FileStatus(long length,
                  boolean isdir,
                  int block_replication,
                  long blocksize,
                  long modification_time,
                  long access_time,
                  FsPermission permission,
                  java.lang.String owner,
                  java.lang.String group,
                  Path symlink,
                  Path path,
                  boolean hasAcl,
                  boolean isEncrypted,
                  boolean isErasureCoded)
```
  - FileStatus
```
public FileStatus(long length,
                  boolean isdir,
                  int block_replication,
                  long blocksize,
                  long modification_time,
                  long access_time,
                  FsPermission permission,
                  java.lang.String owner,
                  java.lang.String group,
                  Path symlink,
                  Path path,
                  java.util.Set<FileStatus.AttrFlags> attr)
```
  - FileStatus
```
public FileStatus(FileStatus other)
           throws java.io.IOException
```
    Copy constructor.
    
    Parameters:
    
    other - FileStatus to copy
    
    Throws:
    
    java.io.IOException - raised on errors performing I/O.
- Method Detail
  - attributes
```
public static java.util.Set<FileStatus.AttrFlags> attributes(boolean acl,
                                                             boolean crypt,
                                                             boolean ec,
                                                             boolean sn)
```
    Convert boolean attributes to a set of flags.
    
    Parameters:
    
    acl - See FileStatus.AttrFlags.HAS_ACL.
    
    crypt - See FileStatus.AttrFlags.HAS_CRYPT.
    
    ec - See FileStatus.AttrFlags.HAS_EC.
    
    sn - See FileStatus.AttrFlags.SNAPSHOT_ENABLED.
    
    Returns:
    
    converted set of flags.
  - getLen
```
public long getLen()
```
    Get the length of this file, in bytes.
    
    Returns:
    
    the length of this file, in bytes.
  - isFile
```
public boolean isFile()
```
    Is this a file?
    
    Returns:
    
    true if this is a file
  - isDirectory
```
public boolean isDirectory()
```
    Is this a directory?
    
    Returns:
    
    true if this is a directory
  - isDir
```
@Deprecated
public boolean isDir()
```
    Deprecated.
    Use isFile(), isDirectory(), and isSymlink() instead.
    
    Old interface, instead use the explicit isFile(), isDirectory(), and isSymlink()
    
    Returns:
    
    true if this is a directory.
  - isTable
```
public boolean isTable()
```
    Is this a table type
    
    Returns:
    
    true if this is a table object, it cannot be a diretory.
  - isSymlink
```
public boolean isSymlink()
```
    Is this a symbolic link?
    
    Returns:
    
    true if this is a symbolic link
  - getBlockSize
```
public long getBlockSize()
```
    Get the block size of the file.
    
    Returns:
    
    the number of bytes
  - getReplication
```
public short getReplication()
```
    Get the replication factor of a file.
    
    Returns:
    
    the replication factor of a file.
  - getModificationTime
```
public long getModificationTime()
```
    Get the modification time of the file.
    
    Returns:
    
    the modification time of file in milliseconds since January 1, 1970 UTC.
  - getAccessTime
```
public long getAccessTime()
```
    Get the access time of the file.
    
    Returns:
    
    the access time of file in milliseconds since January 1, 1970 UTC.
  - getPermission
```
public FsPermission getPermission()
```
    Get FsPermission associated with the file.
    
    Returns:
    
    permission. If a filesystem does not have a notion of permissions or if permissions could not be determined, then default permissions equivalent of "rwxrwxrwx" is returned.
  - hasAcl
```
public boolean hasAcl()
```
    Tell whether the underlying file or directory has ACLs set.
    
    Returns:
    
    true if the underlying file or directory has ACLs set.
  - isEncrypted
```
public boolean isEncrypted()
```
    Tell whether the underlying file or directory is encrypted or not.
    
    Returns:
    
    true if the underlying file is encrypted.
  - isErasureCoded
```
public boolean isErasureCoded()
```
    Tell whether the underlying file or directory is erasure coded or not.
    
    Returns:
    
    true if the underlying file or directory is erasure coded.
  - isSnapshotEnabled
```
public boolean isSnapshotEnabled()
```
    Check if directory is Snapshot enabled or not.
    
    Returns:
    
    true if directory is snapshot enabled
  - getOwner
```
public java.lang.String getOwner()
```
    Get the owner of the file.
    
    Returns:
    
    owner of the file. The string could be empty if there is no notion of owner of a file in a filesystem or if it could not be determined (rare).
  - getGroup
```
public java.lang.String getGroup()
```
    Get the group associated with the file.
    
    Returns:
    
    group for the file. The string could be empty if there is no notion of group of a file in a filesystem or if it could not be determined (rare).
  - getPath
```
public Path getPath()
```
  - setPath
```
public void setPath(Path p)
```
  - setPermission
```
protected void setPermission(FsPermission permission)
```
    Sets permission.
    
    Parameters:
    
    permission - if permission is null, default value is set
  - setOwner
```
protected void setOwner(java.lang.String owner)
```
    Sets owner.
    
    Parameters:
    
    owner - if it is null, default value is set
  - setGroup
```
protected void setGroup(java.lang.String group)
```
    Sets group.
    
    Parameters:
    
    group - if it is null, default value is set
  - getSymlink
```
public Path getSymlink()
                throws java.io.IOException
```
    Returns:
    
    The contents of the symbolic link.
    
    Throws:
    
    java.io.IOException - raised on errors performing I/O.
  - setSymlink
```
public void setSymlink(Path p)
```
  - compareTo
```
public int compareTo(FileStatus o)
```
    Compare this FileStatus to another FileStatus based on lexicographical order of path.
    
    Parameters:
    
    o - the FileStatus to be compared.
    
    Returns:
    
    a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.
  - compareTo
```
public int compareTo(java.lang.Object o)
```
    Compare this FileStatus to another FileStatus based on lexicographical order of path. This method was added back by HADOOP-14683 to keep binary compatibility.
    
    Specified by:
    
    compareTo in interface java.lang.Comparable<java.lang.Object>
    
    Parameters:
    
    o - the FileStatus to be compared.
    
    Returns:
    
    a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.
    
    Throws:
    
    java.lang.ClassCastException - if the specified object is not FileStatus
  - equals
```
public boolean equals(java.lang.Object o)
```
    Compare if this object is equal to another object
    
    Overrides:
    
    equals in class java.lang.Object
    
    Parameters:
    
    o - the object to be compared.
    
    Returns:
    
    true if two file status has the same path name; false if not.
  - hashCode
```
public int hashCode()
```
    Returns a hash code value for the object, which is defined as the hash code of the path name.
    
    Overrides:
    
    hashCode in class java.lang.Object
    
    Returns:
    
    a hash code value for the path name.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - readFields
```
@Deprecated
public void readFields(java.io.DataInput in)
                throws java.io.IOException
```
    Deprecated.
    Use the PBHelper and protobuf serialization directly.
    
    Read instance encoded as protobuf from stream.
    
    Specified by:
    
    readFields in interface Writable
    
    Parameters:
    
    in - Input stream
    
    Throws:
    
    java.io.IOException - any other problem for readFields.
    
    See Also:
    
    PBHelper.convert(FileStatus)
  - write
```
@Deprecated
public void write(java.io.DataOutput out)
           throws java.io.IOException
```
    Deprecated.
    Use the PBHelper and protobuf serialization directly.
    
    Write instance encoded as protobuf to stream.
    
    Specified by:
    
    write in interface Writable
    
    Parameters:
    
    out - Output stream
    
    Throws:
    
    java.io.IOException - any other problem for write.
    
    See Also:
    
    PBHelper.convert(FileStatus)
  - validateObject
```
public void validateObject()
                    throws java.io.InvalidObjectException
```
    Specified by:
    
    validateObject in interface java.io.ObjectInputValidation
    
    Throws:
    
    java.io.InvalidObjectException

Class FileStatus

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NONE

Constructor Detail

FileStatus

FileStatus

FileStatus

FileStatus

FileStatus

FileStatus

FileStatus

Method Detail

attributes

getLen

isFile

isDirectory

isDir

isTable

isSymlink

getBlockSize

getReplication

getModificationTime

getAccessTime

getPermission

hasAcl

isEncrypted

isErasureCoded

isSnapshotEnabled

getOwner

getGroup

getPath

setPath

setPermission

setOwner

setGroup

getSymlink

setSymlink

compareTo

compareTo

equals

hashCode

toString

readFields

write

validateObject