jsimple.io

Class FileSystemFile

java.lang.Object

jsimple.io.Path

jsimple.io.File

jsimple.io.FileSystemFile

public class FileSystemFile
extends File

Since:

11/22/12 12:29 AM

Constructor Summary

Constructors

Constructor and Description
FileSystemFile(FileSystemDirectory parent, java.io.File javaFile)
FileSystemFile(FileSystemDirectory parent, java.lang.String filePath)

Method Summary

Modifier and Type	Method and Description
void	delete() Delete this file if it exists.
boolean	exists() See if the file exists.
long	getLastModifiedTime() Get the last modified / last write timestamp of this file.
java.lang.String	getName() Get the name of this file/directory--the last component of the path.
Directory	getParent()
java.lang.String	getPathString() Get the string representation of the full path for this file/directory.
long	getSize() Get the size of this file.
void	moveTo(File destination)
OutputStream	openForCreate() Open the file for writing.
InputStream	openForRead()
void	renameTo(java.lang.String newName) Rename this file, giving it a new name in the same directory.
void	setLastModifiedTime(long time) Set the last modified / last write timestamp of this file.

Methods inherited from class jsimple.io.File

copyTo, openForCreateAtomic, openForCreateAtomic, openUtf8ForCreate, openUtf8ForCreateAtomic, openUtf8ForRead

Methods inherited from class jsimple.io.Path

getNameExtension, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

FileSystemFile

public FileSystemFile(FileSystemDirectory parent,
                      java.lang.String filePath)

FileSystemFile

public FileSystemFile(FileSystemDirectory parent,
                      java.io.File javaFile)

Method Detail

getParent

public Directory getParent()

Specified by:

getParent in class File

openForRead

public InputStream openForRead()

Specified by:

openForRead in class File

openForCreate

public OutputStream openForCreate()

Description copied from class: File

Open the file for writing. If the file already exists, it is truncated. If the file doesn't exist, it is created. Note that the current JSimple file I/O model is that files, when written, are completely rewritten.

Specified by:

openForCreate in class File

Returns:

output stream, to write the file contents

getName

public java.lang.String getName()

Description copied from class: Path

Get the name of this file/directory--the last component of the path.

Specified by:

getName in class Path

Returns:

name of this file/directory

getPathString

public java.lang.String getPathString()

Description copied from class: Path

Get the string representation of the full path for this file/directory.

Specified by:

getPathString in class Path

Returns:

string representation of path

exists

public boolean exists()

Description copied from class: File

See if the file exists. If there's an error checking if the file exists, this method throws an exception when possible, though for some platform implementations it'll just return false if platform can't distinguish not existing from there being an error checking.

Specified by:

exists in class File

Returns:

true if the file exists

delete

public void delete()

Description copied from class: File

Delete this file if it exists. If the file doesn't exist, no exception is thrown.

Specified by:

delete in class File

renameTo

public void renameTo(java.lang.String newName)

Description copied from class: File

Rename this file, giving it a new name in the same directory. If a file with the specified name already exists, it's replaced. If/when there's the need to move a File to a different directory, we'll add separate support for that.

Specified by:

renameTo in class File

moveTo

public void moveTo(File destination)

Specified by:

moveTo in class File

getLastModifiedTime

public long getLastModifiedTime()

Description copied from class: File

Get the last modified / last write timestamp of this file. Of the 3 file timestamps (created, modified, and accessed) on files, modified is most important in Windows. It's the one displayed by default with the "dir" command and shown in file details in Explorer. It's also the timestamp used for most other applications. So that's the timestamp that JSimple best supports querying and changing.

Specified by:

getLastModifiedTime in class File

Returns:

last modified timestamp for file

setLastModifiedTime

public void setLastModifiedTime(long time)

Description copied from class: File

Set the last modified / last write timestamp of this file. Of the 3 file timestamps (created, modified, and accessed) on files, modified is most important in Windows. It's the one displayed by default with the "dir" command and shown in file details in Explorer. It's also the timestamp used for most other applications. So that's the timestamp that JSimple best supports querying and changing.

Specified by:

setLastModifiedTime in class File

Parameters:

time - time in millis (milliseconds since Jan 1, 1970 UTC)

getSize

public long getSize()

Description copied from class: File

Get the size of this file.

Specified by:

getSize in class File

Returns:

file size