jetbrains.exodus.vfs

Class File

java.lang.Object

jetbrains.exodus.vfs.File

public class File
extends java.lang.Object

Describes a file of a VirtualFileSystem. File is identified by its getPath(). Path is an abstract string, it can be used to codify a hierarchy, though VirtualFileSystem doesn't contain methods to enumerate files by a path prefix.

In addition, File can be identified by a file descriptor which an internal VirtualFileSystem long unique id. Identifying by file descriptor allows to rename a file.

File has its created and last modified time.

See Also:

VirtualFileSystem, VirtualFileSystem.createFile(Transaction, String), VirtualFileSystem.openFile(Transaction, String, boolean)

Method Summary

Modifier and Type	Method and Description
long	getCreated() Returns the time when the File was created.
long	getDescriptor()
long	getLastModified() Returns the time when the File was modified last time or explicitly touched.
@NotNull java.lang.String	getPath() Returns the path which the File is identified by.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getPath

@NotNull
public @NotNull java.lang.String getPath()

Returns the path which the File is identified by. Path is an abstract string, it can be used to codify a hierarchy, though VirtualFileSystem doesn't contain methods to enumerate files by a path prefix.

Returns:

path of the File

getDescriptor

public long getDescriptor()

Returns:

the File's internal unique id

getCreated

public long getCreated()

Returns the time when the File was created. This value never changes.

Returns:

the time when the File was created

See Also:

VirtualFileSystem.createFile(Transaction, String), VirtualFileSystem.createFile(Transaction, long, String), VirtualFileSystem.openFile(Transaction, String, boolean)

getLastModified

public long getLastModified()

Returns the time when the File was modified last time or explicitly touched. VirtualFileSystem's methods that open OutputStream by file descriptor, not File instance, return the stream which doesn't update last modified time.

The returned value is actual to the moment of the File instance creation, open new File instance to get consistent value of last modified time.

Returns:

the time when the File was modified last time or explicitly touched

See Also:

VirtualFileSystem.touchFile(Transaction, File)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object