public class LocalFile extends AbstractFileObject<LocalFileSystem>
Modifier and Type | Field and Description |
---|---|
private java.io.File |
file |
private java.lang.String |
rootFile |
Modifier | Constructor and Description |
---|---|
protected |
LocalFile(LocalFileSystem fileSystem,
java.lang.String rootFile,
AbstractFileName name)
Creates a non-root file.
|
Modifier and Type | Method and Description |
---|---|
protected void |
doAttach()
Attaches this file object to its file resource.
|
protected void |
doCreateFolder()
Creates this folder.
|
protected void |
doDelete()
Deletes this file, and all children.
|
protected long |
doGetContentSize()
Returns the size of the file content (in bytes).
|
protected java.io.InputStream |
doGetInputStream()
Creates an input stream to read the content from.
|
protected long |
doGetLastModifiedTime()
Gets the last modified time of this file.
|
protected java.io.OutputStream |
doGetOutputStream(boolean bAppend)
Creates an output stream to write the file content to.
|
protected RandomAccessContent |
doGetRandomAccessContent(RandomAccessMode mode)
Creates access to the file for random i/o.
|
protected FileType |
doGetType()
Returns the file's type.
|
protected boolean |
doIsExecutable()
Determines if this file is hidden.
|
protected boolean |
doIsHidden()
Determines if this file is hidden.
|
protected boolean |
doIsReadable()
Determines if this file can be read.
|
protected boolean |
doIsSameFile(FileObject destFile)
Checks if this fileObject is the same file as
destFile just with a different
name. |
protected boolean |
doIsWriteable()
Determines if this file can be written to.
|
protected java.lang.String[] |
doListChildren()
Returns the children of the file.
|
protected void |
doRename(FileObject newFile)
rename this file
|
protected boolean |
doSetExecutable(boolean executable,
boolean ownerOnly)
Make the file executable.
|
protected boolean |
doSetLastModifiedTime(long modtime)
Sets the last modified time of this file.
|
protected boolean |
doSetReadable(boolean readable,
boolean ownerOnly)
Make the file or folder readable.
|
protected boolean |
doSetWritable(boolean writable,
boolean ownerOnly)
Make the file or folder writeable.
|
protected java.io.File |
getLocalFile()
Returns the local file that this file object represents.
|
java.lang.String |
toString()
Returns the URI of the file.
|
canRenameTo, childrenChanged, close, compareTo, copyFrom, createFile, createFolder, delete, delete, deleteAll, doCreateFileContent, doDetach, doGetAttributes, doGetCertificates, doListChildrenResolved, doRemoveAttribute, doSetAttribute, endOutput, exists, finalize, findFiles, findFiles, getAbstractFileSystem, getChild, getChildren, getContent, getFileContentInfoFactory, getFileOperations, getFileSystem, getInputStream, getName, getOutputStream, getOutputStream, getParent, getPublicURIString, getRandomAccessContent, getType, getURL, handleChanged, handleCreate, handleDelete, holdObject, injectType, isAttached, isContentOpen, isExecutable, isFile, isFolder, isHidden, isReadable, isSameFile, isWriteable, iterator, listFiles, moveTo, notifyAllStreamsClosed, onChange, onChildrenChanged, refresh, resolveFile, resolveFile, setExecutable, setReadable, setWritable
protected LocalFile(LocalFileSystem fileSystem, java.lang.String rootFile, AbstractFileName name) throws FileSystemException
fileSystem
- the file system this file belongs to.rootFile
- the root file for the file system.name
- the file name on this file system.FileSystemException
- if an error occurs.protected java.io.File getLocalFile()
protected void doAttach() throws java.lang.Exception
doAttach
in class AbstractFileObject<LocalFileSystem>
java.lang.Exception
- if an error occurs.protected FileType doGetType() throws java.lang.Exception
doGetType
in class AbstractFileObject<LocalFileSystem>
java.lang.Exception
- if an error occurs.protected java.lang.String[] doListChildren() throws java.lang.Exception
doListChildren
in class AbstractFileObject<LocalFileSystem>
java.lang.Exception
- if an error occurs.protected void doDelete() throws java.lang.Exception
doDelete
in class AbstractFileObject<LocalFileSystem>
java.lang.Exception
- if an error occurs.protected void doRename(FileObject newFile) throws java.lang.Exception
doRename
in class AbstractFileObject<LocalFileSystem>
newFile
- A FileObject with the new file name.java.lang.Exception
- if an error occurs.protected void doCreateFolder() throws java.lang.Exception
doCreateFolder
in class AbstractFileObject<LocalFileSystem>
java.lang.Exception
- if an error occurs.protected boolean doIsWriteable() throws FileSystemException
doIsWriteable
in class AbstractFileObject<LocalFileSystem>
FileSystemException
protected boolean doSetWritable(boolean writable, boolean ownerOnly) throws java.lang.Exception
AbstractFileObject
Only called if AbstractFileObject.doGetType()
does not return FileType.IMAGINARY
.
doSetWritable
in class AbstractFileObject<LocalFileSystem>
writable
- True to allow access, false to disallowownerOnly
- If true
, the permission applies only to the owner; otherwise, it applies to everybody.java.lang.Exception
- Any Exception thrown is wrapped in FileSystemException.AbstractFileObject.setWritable(boolean, boolean)
protected boolean doIsExecutable()
doIsExecutable
in class AbstractFileObject<LocalFileSystem>
protected boolean doIsHidden()
doIsHidden
in class AbstractFileObject<LocalFileSystem>
protected boolean doIsReadable() throws FileSystemException
doIsReadable
in class AbstractFileObject<LocalFileSystem>
FileSystemException
protected boolean doSetReadable(boolean readable, boolean ownerOnly) throws java.lang.Exception
AbstractFileObject
Only called if AbstractFileObject.doGetType()
does not return FileType.IMAGINARY
.
This implementation returns false.
doSetReadable
in class AbstractFileObject<LocalFileSystem>
readable
- True to allow access, false to disallowownerOnly
- If true
, the permission applies only to the owner; otherwise, it applies to everybody.java.lang.Exception
- Any Exception thrown is wrapped in FileSystemException.AbstractFileObject.setReadable(boolean, boolean)
protected boolean doSetExecutable(boolean executable, boolean ownerOnly) throws java.lang.Exception
AbstractFileObject
Only called if AbstractFileObject.doGetType()
does not return FileType.IMAGINARY
.
This implementation returns false.
doSetExecutable
in class AbstractFileObject<LocalFileSystem>
executable
- True to allow access, false to disallow.ownerOnly
- If true
, the permission applies only to the owner; otherwise, it applies to everybody.java.lang.Exception
- Any Exception thrown is wrapped in FileSystemException.AbstractFileObject.setExecutable(boolean, boolean)
protected long doGetLastModifiedTime() throws FileSystemException
doGetLastModifiedTime
in class AbstractFileObject<LocalFileSystem>
FileSystemException
protected boolean doSetLastModifiedTime(long modtime) throws FileSystemException
doSetLastModifiedTime
in class AbstractFileObject<LocalFileSystem>
modtime
- The last modification time.FileSystemException
protected java.io.InputStream doGetInputStream() throws java.lang.Exception
doGetInputStream
in class AbstractFileObject<LocalFileSystem>
java.lang.Exception
- if an error occurs.protected java.io.OutputStream doGetOutputStream(boolean bAppend) throws java.lang.Exception
doGetOutputStream
in class AbstractFileObject<LocalFileSystem>
bAppend
- true if the file should be appended to, false if it should be overwritten.java.lang.Exception
- if an error occurs.protected long doGetContentSize() throws java.lang.Exception
doGetContentSize
in class AbstractFileObject<LocalFileSystem>
java.lang.Exception
- if an error occurs.protected RandomAccessContent doGetRandomAccessContent(RandomAccessMode mode) throws java.lang.Exception
AbstractFileObject
AbstractFileObject.doGetType()
returns FileType.FILE
.
It is guaranteed that there are no open output streams for this file when this method is called.
doGetRandomAccessContent
in class AbstractFileObject<LocalFileSystem>
mode
- The mode to access the file.java.lang.Exception
- if an error occurs.protected boolean doIsSameFile(FileObject destFile) throws FileSystemException
AbstractFileObject
destFile
just with a different
name. E.g. for case insensitive filesystems like windows.doIsSameFile
in class AbstractFileObject<LocalFileSystem>
destFile
- The file to compare to.FileSystemException
- if an error occurs.public java.lang.String toString()
toString
in class AbstractFileObject<LocalFileSystem>