Class RamFileObject
- All Implemented Interfaces:
Closeable
,AutoCloseable
,Comparable<FileObject>
,Iterable<FileObject>
,FileObject
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected void
doAttach()
Attaches this file object to its file resource.protected void
Creates this file as a folder.protected void
doDelete()
Deletes the file.protected long
Returns the size of the file content (in bytes).protected InputStream
Creates an input stream to read the file content from.protected long
Returns 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
Determines the type of this file.protected String[]
Lists the children of this file.protected void
doRename
(FileObject newFile) Renames the file.protected boolean
doSetLastModifiedTime
(long modtime) Sets the last modified time of this file.protected void
Called when the output stream for this file is closed.protected void
injectType
(FileType fileType) Methods inherited from class org.apache.commons.vfs2.provider.AbstractFileObject
canRenameTo, childrenChanged, close, compareTo, copyFrom, createFile, createFolder, delete, delete, deleteAll, doCreateFileContent, doDetach, doGetAttributes, doGetCertificates, doIsExecutable, doIsHidden, doIsReadable, doIsSameFile, doIsWriteable, doListChildrenResolved, doRemoveAttribute, doSetAttribute, doSetExecutable, doSetReadable, doSetWritable, exists, finalize, findFiles, findFiles, getAbstractFileSystem, getChild, getChildren, getContent, getFileContentInfoFactory, getFileOperations, getFileSystem, getInputStream, getName, getOutputStream, getOutputStream, getParent, getPublicURIString, getRandomAccessContent, getType, getURL, handleChanged, handleCreate, handleDelete, holdObject, isAttached, isContentOpen, isExecutable, isFile, isFolder, isHidden, isReadable, isSameFile, isWriteable, iterator, listFiles, moveTo, notifyAllStreamsClosed, onChange, onChildrenChanged, refresh, resolveFile, resolveFile, setExecutable, setReadable, setWritable, toString
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
-
RamFileObject
- Parameters:
name
- The name of the file.fs
- The FileSystem.
-
-
Method Details
-
doGetType
Description copied from class:AbstractFileObject
Determines the type of this file. Must not return null. The return value of this method is cached, so the implementation can be expensive.- Specified by:
doGetType
in classAbstractFileObject<RamFileSystem>
- Returns:
- the type of the file.
- Throws:
Exception
- if an error occurs.
-
doListChildren
Description copied from class:AbstractFileObject
Lists the children of this file. Is only called ifAbstractFileObject.doGetType()
returnsFileType.FOLDER
. The return value of this method is cached, so the implementation can be expensive.- Specified by:
doListChildren
in classAbstractFileObject<RamFileSystem>
- 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.
-
doGetContentSize
Description copied from class:AbstractFileObject
Returns the size of the file content (in bytes). Is only called ifAbstractFileObject.doGetType()
returnsFileType.FILE
.- Specified by:
doGetContentSize
in classAbstractFileObject<RamFileSystem>
- Returns:
- The size of the file in bytes.
- Throws:
Exception
- if an error occurs.
-
doGetInputStream
Description copied from class:AbstractFileObject
Creates an input stream to read the file content from. 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.
The returned stream does not have to be buffered.
- Specified by:
doGetInputStream
in classAbstractFileObject<RamFileSystem>
- Returns:
- An InputStream to read the file content.
- Throws:
Exception
- if an error occurs.
-
doGetOutputStream
Description copied from class:AbstractFileObject
Creates an output stream to write the file content to. Is only called if:AbstractFileObject.doIsWriteable()
returns true.AbstractFileObject.doGetType()
returnsFileType.FILE
, orAbstractFileObject.doGetType()
returnsFileType.IMAGINARY
, and the file's parent exists and is a folder.
The returned stream does not have to be buffered.
This implementation throws an exception.
- Overrides:
doGetOutputStream
in classAbstractFileObject<RamFileSystem>
- 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.
-
doDelete
Description copied from class:AbstractFileObject
Deletes the file. Is only called when:AbstractFileObject.doGetType()
does not returnFileType.IMAGINARY
.AbstractFileObject.doIsWriteable()
returns true.- This file has no children, if a folder.
- Overrides:
doDelete
in classAbstractFileObject<RamFileSystem>
- Throws:
Exception
- if an error occurs.
-
doGetLastModifiedTime
Description copied from class:AbstractFileObject
Returns the last modified time of this file. Is only called ifAbstractFileObject.doGetType()
does not returnFileType.IMAGINARY
.This implementation throws an exception.
- Overrides:
doGetLastModifiedTime
in classAbstractFileObject<RamFileSystem>
- Returns:
- The last modification time.
- Throws:
Exception
- if an error occurs.
-
doSetLastModifiedTime
Description copied from class:AbstractFileObject
Sets the last modified time of this file.Is only called if
AbstractFileObject.doGetType()
does not returnFileType.IMAGINARY
.This implementation throws an exception.
- Overrides:
doSetLastModifiedTime
in classAbstractFileObject<RamFileSystem>
- Parameters:
modtime
- The last modification time.- Returns:
- true if the time was set.
- Throws:
Exception
- Any Exception thrown is wrapped in FileSystemException.- Since:
- 2.0
-
doCreateFolder
Description copied from class:AbstractFileObject
Creates this file as a folder. Is only called when:AbstractFileObject.doGetType()
returnsFileType.IMAGINARY
.- The parent folder exists and is writeable, or this file is the root of the file system.
- Overrides:
doCreateFolder
in classAbstractFileObject<RamFileSystem>
- Throws:
Exception
- if an error occurs.
-
doRename
Description copied from class:AbstractFileObject
Renames the file.Is only called when:
AbstractFileObject.doIsWriteable()
returns true.
This implementation throws an exception.
- Overrides:
doRename
in classAbstractFileObject<RamFileSystem>
- Parameters:
newFile
- A FileObject with the new file name.- 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<RamFileSystem>
- Parameters:
mode
- The mode to access the file.- Returns:
- The RandomAccessContext.
- Throws:
Exception
- if an error occurs.
-
doAttach
Description copied from class:AbstractFileObject
Attaches this file object to its file resource.This method is called before any of the doBlah() or onBlah() methods. Sub-classes can use this method to perform lazy initialisation.
This implementation does nothing.
- Overrides:
doAttach
in classAbstractFileObject<RamFileSystem>
- Throws:
Exception
- if an error occurs.
-
injectType
- Overrides:
injectType
in classAbstractFileObject<RamFileSystem>
-
endOutput
Description copied from class:AbstractFileObject
Called when the output stream for this file is closed.- Overrides:
endOutput
in classAbstractFileObject<RamFileSystem>
- Throws:
Exception
- if an error occurs.
-