Class LocalFile
- java.lang.Object
-
- org.apache.commons.vfs.provider.AbstractFileObject
-
- org.apache.commons.vfs.provider.local.LocalFile
-
- All Implemented Interfaces:
FileObject
public class LocalFile extends AbstractFileObject implements FileObject
A file object implementation which uses direct file access.- Version:
- $Revision: 480428 $ $Date: 2006-11-29 07:15:24 +0100 (Wed, 29 Nov 2006) $
- Author:
- Adam Murdoch, Gary D. Gregory
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
LocalFile(LocalFileSystem fileSystem, java.lang.String rootFile, FileName name)
Creates a non-root file.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method 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
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 asdestFile
just with a different name.
E.g.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 fileprotected void
doSetLastModifiedTime(long modtime)
Sets the last modified time of this file.protected java.io.File
getLocalFile()
Returns the local file that this file object represents.-
Methods inherited from class org.apache.commons.vfs.provider.AbstractFileObject
canRenameTo, childrenChanged, childrenChanged, close, copyFrom, createFile, createFolder, delete, delete, doDetach, doGetAttributes, doGetCertificates, doListChildrenResolved, doSetAttribute, endOutput, exists, finalize, findFiles, findFiles, getChild, getChildren, getContent, getFileContentInfoFactory, getFileOperations, getFileSystem, getInputStream, getName, getOutputStream, getOutputStream, getParent, getRandomAccessContent, getType, getURL, handleChanged, handleCreate, handleDelete, holdObject, injectType, isAttached, isContentOpen, isHidden, isReadable, isSameFile, isWriteable, moveTo, notifyAllStreamsClosed, onChange, onChildrenChanged, refresh, resolveFile, resolveFile, toString
-
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.apache.commons.vfs.FileObject
canRenameTo, close, copyFrom, createFile, createFolder, delete, delete, exists, findFiles, findFiles, getChild, getChildren, getContent, getFileOperations, getFileSystem, getName, getParent, getType, getURL, isAttached, isContentOpen, isHidden, isReadable, isWriteable, moveTo, refresh, resolveFile, resolveFile
-
-
-
-
Constructor Detail
-
LocalFile
protected LocalFile(LocalFileSystem fileSystem, java.lang.String rootFile, FileName name) throws FileSystemException
Creates a non-root file.- Throws:
FileSystemException
-
-
Method Detail
-
getLocalFile
protected java.io.File getLocalFile()
Returns the local file that this file object represents.
-
doAttach
protected void doAttach() throws java.lang.Exception
Attaches this file object to its file resource.- Overrides:
doAttach
in classAbstractFileObject
- Throws:
java.lang.Exception
-
doGetType
protected FileType doGetType() throws java.lang.Exception
Returns the file's type.- Specified by:
doGetType
in classAbstractFileObject
- Throws:
java.lang.Exception
-
doListChildren
protected java.lang.String[] doListChildren() throws java.lang.Exception
Returns the children of the file.- Specified by:
doListChildren
in classAbstractFileObject
- Throws:
java.lang.Exception
-
doDelete
protected void doDelete() throws java.lang.Exception
Deletes this file, and all children.- Overrides:
doDelete
in classAbstractFileObject
- Throws:
java.lang.Exception
-
doRename
protected void doRename(FileObject newfile) throws java.lang.Exception
rename this file- Overrides:
doRename
in classAbstractFileObject
- Throws:
java.lang.Exception
-
doCreateFolder
protected void doCreateFolder() throws java.lang.Exception
Creates this folder.- Overrides:
doCreateFolder
in classAbstractFileObject
- Throws:
java.lang.Exception
-
doIsWriteable
protected boolean doIsWriteable() throws FileSystemException
Determines if this file can be written to.- Overrides:
doIsWriteable
in classAbstractFileObject
- Throws:
FileSystemException
-
doIsHidden
protected boolean doIsHidden()
Determines if this file is hidden.- Overrides:
doIsHidden
in classAbstractFileObject
-
doIsReadable
protected boolean doIsReadable() throws FileSystemException
Determines if this file can be read.- Overrides:
doIsReadable
in classAbstractFileObject
- Throws:
FileSystemException
-
doGetLastModifiedTime
protected long doGetLastModifiedTime() throws FileSystemException
Gets the last modified time of this file.- Overrides:
doGetLastModifiedTime
in classAbstractFileObject
- Throws:
FileSystemException
-
doSetLastModifiedTime
protected void doSetLastModifiedTime(long modtime) throws FileSystemException
Sets the last modified time of this file.- Overrides:
doSetLastModifiedTime
in classAbstractFileObject
- Throws:
FileSystemException
-
doGetInputStream
protected java.io.InputStream doGetInputStream() throws java.lang.Exception
Creates an input stream to read the content from.- Specified by:
doGetInputStream
in classAbstractFileObject
- Throws:
java.lang.Exception
-
doGetOutputStream
protected java.io.OutputStream doGetOutputStream(boolean bAppend) throws java.lang.Exception
Creates an output stream to write the file content to.- Overrides:
doGetOutputStream
in classAbstractFileObject
- Throws:
java.lang.Exception
-
doGetContentSize
protected long doGetContentSize() throws java.lang.Exception
Returns the size of the file content (in bytes).- Specified by:
doGetContentSize
in classAbstractFileObject
- Throws:
java.lang.Exception
-
doGetRandomAccessContent
protected RandomAccessContent doGetRandomAccessContent(RandomAccessMode mode) throws java.lang.Exception
Description copied from class:AbstractFileObject
Creates access to the file for random i/o. Is only called ifAbstractFileObject.doGetType()
returnsFileType.FILE
.It is guaranteed that there are no open output streams for this file when this method is called.
- Overrides:
doGetRandomAccessContent
in classAbstractFileObject
- Throws:
java.lang.Exception
-
doIsSameFile
protected boolean doIsSameFile(FileObject destFile) throws FileSystemException
Description copied from class:AbstractFileObject
Checks if this fileObject is the same file asdestFile
just with a different name.
E.g. for case insensitive filesystems like windows.- Overrides:
doIsSameFile
in classAbstractFileObject
- Throws:
FileSystemException
-
-