Class LocalFile
java.lang.Object
org.apache.commons.vfs2.provider.AbstractFileObject<LocalFileSystem>
org.apache.commons.vfs2.provider.local.LocalFile
- All Implemented Interfaces:
Closeable
,AutoCloseable
,Comparable<FileObject>
,Iterable<FileObject>
,FileObject
A file object implementation which uses direct file access.
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
LocalFile
(LocalFileSystem fileSystem, String rootFile, AbstractFileName name) Creates a non-root file. -
Method Summary
Modifier and TypeMethodDescriptionprotected void
doAttach()
Attaches this file object to its file resource.protected void
Creates this folder.protected void
doDelete()
Deletes this file, and all children.protected long
Returns the size of the file content (in bytes).protected InputStream
Creates an input stream to read the content from.protected long
Gets the last modified time of this file.protected OutputStream
doGetOutputStream
(boolean bAppend) Creates an output stream to write the file content to.protected RandomAccessContent
Creates access to the file for random i/o.protected FileType
Returns the file's type.protected boolean
Determines if this file is hidden.protected boolean
Determines if this file is hidden.protected boolean
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.protected boolean
Determines if this file can be written to.protected String[]
Returns the children of the file.protected void
doRename
(FileObject newFile) rename this fileprotected 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 File
Returns the local file that this file object represents.toString()
Returns the URI of the file.Methods inherited from class org.apache.commons.vfs2.provider.AbstractFileObject
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
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface java.lang.Iterable
forEach, spliterator
-
Constructor Details
-
LocalFile
protected LocalFile(LocalFileSystem fileSystem, String rootFile, AbstractFileName name) throws FileSystemException Creates a non-root file.- Parameters:
fileSystem
- the file system this file belongs to.rootFile
- the root file for the file system.name
- the file name on this file system.- Throws:
FileSystemException
- if an error occurs.
-
-
Method Details
-
getLocalFile
Returns the local file that this file object represents.- Returns:
- the local file that this file object represents.
-
doAttach
Attaches this file object to its file resource.- Overrides:
doAttach
in classAbstractFileObject<LocalFileSystem>
- Throws:
Exception
- if an error occurs.
-
doGetType
Returns the file's type.- Specified by:
doGetType
in classAbstractFileObject<LocalFileSystem>
- Returns:
- the type of the file.
- Throws:
Exception
- if an error occurs.
-
doListChildren
Returns the children of the file.- Specified by:
doListChildren
in classAbstractFileObject<LocalFileSystem>
- Returns:
- a possible empty String array if the file is a directory or null or an exception if the file is not a directory or can't be read.
- Throws:
Exception
- if an error occurs.
-
doDelete
Deletes this file, and all children.- Overrides:
doDelete
in classAbstractFileObject<LocalFileSystem>
- Throws:
Exception
- if an error occurs.
-
doRename
rename this file- Overrides:
doRename
in classAbstractFileObject<LocalFileSystem>
- Parameters:
newFile
- A FileObject with the new file name.- Throws:
Exception
- if an error occurs.
-
doCreateFolder
Creates this folder.- Overrides:
doCreateFolder
in classAbstractFileObject<LocalFileSystem>
- Throws:
Exception
- if an error occurs.
-
doIsWriteable
Determines if this file can be written to.- Overrides:
doIsWriteable
in classAbstractFileObject<LocalFileSystem>
- Returns:
- true if the file is writable.
- Throws:
FileSystemException
-
doSetWritable
Description copied from class:AbstractFileObject
Make the file or folder writeable.Only called if
AbstractFileObject.doGetType()
does not returnFileType.IMAGINARY
.- Overrides:
doSetWritable
in classAbstractFileObject<LocalFileSystem>
- Parameters:
writable
- True to allow access, false to disallowownerOnly
- Iftrue
, the permission applies only to the owner; otherwise, it applies to everybody.- Returns:
- true if the operation succeeded
- Throws:
Exception
- Any Exception thrown is wrapped in FileSystemException.- See Also:
-
doIsExecutable
Determines if this file is hidden.- Overrides:
doIsExecutable
in classAbstractFileObject<LocalFileSystem>
- Returns:
- true if the file is executable, false otherwise.
-
doIsHidden
Determines if this file is hidden.- Overrides:
doIsHidden
in classAbstractFileObject<LocalFileSystem>
- Returns:
- true if the file is hidden, false otherwise.
-
doIsReadable
Determines if this file can be read.- Overrides:
doIsReadable
in classAbstractFileObject<LocalFileSystem>
- Returns:
- true if the file is readable, false otherwise.
- Throws:
FileSystemException
-
doSetReadable
Description copied from class:AbstractFileObject
Make the file or folder readable.Only called if
AbstractFileObject.doGetType()
does not returnFileType.IMAGINARY
.This implementation returns false.
- Overrides:
doSetReadable
in classAbstractFileObject<LocalFileSystem>
- Parameters:
readable
- True to allow access, false to disallowownerOnly
- Iftrue
, the permission applies only to the owner; otherwise, it applies to everybody.- Returns:
- true if the operation succeeded
- Throws:
Exception
- Any Exception thrown is wrapped in FileSystemException.- See Also:
-
doSetExecutable
Description copied from class:AbstractFileObject
Make the file executable.Only called if
AbstractFileObject.doGetType()
does not returnFileType.IMAGINARY
.This implementation returns false.
- Overrides:
doSetExecutable
in classAbstractFileObject<LocalFileSystem>
- Parameters:
executable
- True to allow access, false to disallow.ownerOnly
- Iftrue
, the permission applies only to the owner; otherwise, it applies to everybody.- Returns:
- true if the operation succeeded.
- Throws:
Exception
- Any Exception thrown is wrapped in FileSystemException.- See Also:
-
doGetLastModifiedTime
Gets the last modified time of this file.- Overrides:
doGetLastModifiedTime
in classAbstractFileObject<LocalFileSystem>
- Returns:
- The last modification time.
- Throws:
FileSystemException
-
doSetLastModifiedTime
Sets the last modified time of this file.- Overrides:
doSetLastModifiedTime
in classAbstractFileObject<LocalFileSystem>
- Parameters:
modtime
- The last modification time.- Returns:
- true if the time was set.
- Throws:
FileSystemException
- Since:
- 2.0
-
doGetInputStream
Creates an input stream to read the content from.- Specified by:
doGetInputStream
in classAbstractFileObject<LocalFileSystem>
- Returns:
- An InputStream to read the file content.
- Throws:
Exception
- if an error occurs.
-
doGetOutputStream
Creates an output stream to write the file content to.- Overrides:
doGetOutputStream
in classAbstractFileObject<LocalFileSystem>
- Parameters:
bAppend
- true if the file should be appended to, false if it should be overwritten.- Returns:
- An OutputStream to write to the file.
- Throws:
Exception
- if an error occurs.
-
doGetContentSize
Returns the size of the file content (in bytes).- Specified by:
doGetContentSize
in classAbstractFileObject<LocalFileSystem>
- Returns:
- The size of the file in bytes.
- Throws:
Exception
- if an error occurs.
-
doGetRandomAccessContent
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<LocalFileSystem>
- Parameters:
mode
- The mode to access the file.- Returns:
- The RandomAccessContext.
- Throws:
Exception
- if an error occurs.
-
doIsSameFile
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<LocalFileSystem>
- Parameters:
destFile
- The file to compare to.- Returns:
- true if the FileObjects are the same.
- Throws:
FileSystemException
- if an error occurs.
-
toString
Returns the URI of the file.- Overrides:
toString
in classAbstractFileObject<LocalFileSystem>
- Returns:
- The URI of the file.
-