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.
-
Field Summary
Fields inherited from class org.apache.commons.vfs2.provider.AbstractFileObject
DEFAULT_BUFFER_SIZEFields inherited from interface org.apache.commons.vfs2.FileObject
EMPTY_ARRAY -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedLocalFile(LocalFileSystem fileSystem, String rootFile, AbstractFileName name) Creates a non-root file. -
Method Summary
Modifier and TypeMethodDescriptionprotected voiddoAttach()Attaches this file object to its file resource.protected voidCreates this folder.protected voiddoDelete()Deletes this file, and all children.protected longReturns the size of the file content (in bytes).protected InputStreamdoGetInputStream(int bufferSize) Creates an input stream to read the file contents.protected longGets the last modified time of this file.protected OutputStreamdoGetOutputStream(boolean append) Creates an output stream to write the file content to.protected RandomAccessContentCreates access to the file for random i/o.protected FileTypeReturns the file's type.protected booleanDetermines if this file is hidden.protected booleanDetermines if this file is hidden.protected booleanDetermines if this file can be read.protected booleandoIsSameFile(FileObject destFile) Checks if this fileObject is the same file asdestFilejust with a different name.protected booleanDetermines if this file is a symbolic link.protected booleanDetermines if this file can be written to.protected String[]Returns the children of the file.protected voiddoRename(FileObject newFile) rename this fileprotected booleandoSetExecutable(boolean executable, boolean ownerOnly) Make the file executable.protected booleandoSetLastModifiedTime(long modtime) Sets the last modified time of this file.protected booleandoSetReadable(boolean readable, boolean ownerOnly) Make the file or folder readable.protected booleandoSetWritable(boolean writable, boolean ownerOnly) Make the file or folder writable.protected FileGets 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, doGetInputStream, doListChildrenResolved, doRemoveAttribute, doSetAttribute, endOutput, exists, finalize, findFiles, findFiles, getAbstractFileSystem, getChild, getChildren, getContent, getFileContentInfoFactory, getFileOperations, getFileSystem, getInputStream, getInputStream, getName, getOutputStream, getOutputStream, getParent, getPublicURIString, getRandomAccessContent, getType, getURL, handleChanged, handleCreate, handleDelete, holdObject, injectType, isAttached, isContentOpen, isExecutable, isFile, isFolder, isHidden, isReadable, isSameFile, isSymbolicLink, isWriteable, iterator, listFiles, moveTo, notifyAllStreamsClosed, onChange, onChildrenChanged, refresh, resolveFile, resolveFile, setExecutable, setReadable, setWritableMethods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface org.apache.commons.vfs2.FileObject
getPath, getURIMethods inherited from interface java.lang.Iterable
forEach, spliterator
-
Constructor Details
-
LocalFile
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.
-
-
Method Details
-
doAttach
Attaches this file object to its file resource.- Overrides:
doAttachin classAbstractFileObject<LocalFileSystem>- Throws:
Exception- if an error occurs.
-
doCreateFolder
Creates this folder.- Overrides:
doCreateFolderin classAbstractFileObject<LocalFileSystem>- Throws:
Exception- if an error occurs.
-
doDelete
Deletes this file, and all children.- Overrides:
doDeletein classAbstractFileObject<LocalFileSystem>- Throws:
Exception- if an error occurs.
-
doGetContentSize
Returns the size of the file content (in bytes).- Specified by:
doGetContentSizein classAbstractFileObject<LocalFileSystem>- Returns:
- The size of the file in bytes.
- Throws:
Exception- if an error occurs.
-
doGetInputStream
Creates an input stream to read the file contents.- Overrides:
doGetInputStreamin classAbstractFileObject<LocalFileSystem>- Parameters:
bufferSize- Buffer size hint.- Returns:
- An InputStream to read the file content.
- Throws:
Exception- if an error occurs.
-
doGetLastModifiedTime
Gets the last modified time of this file.- Overrides:
doGetLastModifiedTimein classAbstractFileObject<LocalFileSystem>- Returns:
- The last modification time.
- Throws:
FileSystemException
-
doGetOutputStream
Creates an output stream to write the file content to.- Overrides:
doGetOutputStreamin classAbstractFileObject<LocalFileSystem>- Parameters:
append- true if the file should be appended to, false if it should be overwritten.- Returns:
- An OutputStream to write to the file.
- Throws:
IOException
-
doGetRandomAccessContent
Description copied from class:AbstractFileObjectCreates 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:
doGetRandomAccessContentin classAbstractFileObject<LocalFileSystem>- Parameters:
mode- The mode to access the file.- Returns:
- The RandomAccessContext.
- Throws:
Exception- if an error occurs.
-
doGetType
Returns the file's type.- Specified by:
doGetTypein classAbstractFileObject<LocalFileSystem>- Returns:
- the type of the file.
-
doIsExecutable
Determines if this file is hidden.- Overrides:
doIsExecutablein classAbstractFileObject<LocalFileSystem>- Returns:
- true if the file is executable, false otherwise.
-
doIsHidden
Determines if this file is hidden.- Overrides:
doIsHiddenin classAbstractFileObject<LocalFileSystem>- Returns:
- true if the file is hidden, false otherwise.
-
doIsReadable
Determines if this file can be read.- Overrides:
doIsReadablein classAbstractFileObject<LocalFileSystem>- Returns:
- true if the file is readable, false otherwise.
- Throws:
FileSystemException
-
doIsSameFile
Description copied from class:AbstractFileObjectChecks if this fileObject is the same file asdestFilejust with a different name. E.g. for case-insensitive file systems like Windows.- Overrides:
doIsSameFilein classAbstractFileObject<LocalFileSystem>- Parameters:
destFile- The file to compare to.- Returns:
- true if the FileObjects are the same.
- Throws:
FileSystemException- if an error occurs.
-
doIsSymbolicLink
Determines if this file is a symbolic link.- Overrides:
doIsSymbolicLinkin classAbstractFileObject<LocalFileSystem>- Returns:
- true if the file is readable, false otherwise.
- Throws:
FileSystemException- Since:
- 2.4
-
doIsWriteable
Determines if this file can be written to.- Overrides:
doIsWriteablein classAbstractFileObject<LocalFileSystem>- Returns:
- true if the file is writable.
- Throws:
FileSystemException
-
doListChildren
Returns the children of the file.- Specified by:
doListChildrenin 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.
-
doRename
rename this file- Overrides:
doRenamein classAbstractFileObject<LocalFileSystem>- Parameters:
newFile- A FileObject with the new file name.- Throws:
Exception- if an error occurs.
-
doSetExecutable
Description copied from class:AbstractFileObjectMake the file executable.Only called if
AbstractFileObject.doGetType()does not returnFileType.IMAGINARY.This implementation returns false.
- Overrides:
doSetExecutablein 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:
-
doSetLastModifiedTime
Sets the last modified time of this file.- Overrides:
doSetLastModifiedTimein classAbstractFileObject<LocalFileSystem>- Parameters:
modtime- The last modification time.- Returns:
- true if the time was set.
- Throws:
FileSystemException- Since:
- 2.0
-
doSetReadable
Description copied from class:AbstractFileObjectMake the file or folder readable.Only called if
AbstractFileObject.doGetType()does not returnFileType.IMAGINARY.This implementation returns false.
- Overrides:
doSetReadablein 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:
-
doSetWritable
Description copied from class:AbstractFileObjectMake the file or folder writable.Only called if
AbstractFileObject.doGetType()does not returnFileType.IMAGINARY.- Overrides:
doSetWritablein 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:
-
getLocalFile
Gets the local file that this file object represents.- Returns:
- the local file that this file object represents.
-
toString
Returns the URI of the file.- Overrides:
toStringin classAbstractFileObject<LocalFileSystem>- Returns:
- The URI of the file.
-