Class RamFileObject
- All Implemented Interfaces:
Closeable,AutoCloseable,Comparable<FileObject>,Iterable<FileObject>,FileObject
-
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
ConstructorsModifierConstructorDescriptionprotectedRamFileObject(AbstractFileName fileName, RamFileSystem fileSystem) Constructs a new instance. -
Method Summary
Modifier and TypeMethodDescriptionprotected voiddoAttach()Attaches this file object to its file resource.protected voidCreates this file as a folder.protected voiddoDelete()Deletes the file.protected longReturns the size of the file content (in bytes).protected InputStreamdoGetInputStream(int bufferSize) Creates an input stream to read the file content from.protected longReturns the last modified time of this file.protected OutputStreamdoGetOutputStream(boolean bAppend) Creates an output stream to write the file content to.protected RandomAccessContentCreates access to the file for random i/o.protected FileTypeDetermines the type of this file.protected String[]Lists the children of this file.protected voiddoRename(FileObject newFile) Renames the file.protected booleandoSetLastModifiedTime(long modtime) Sets the last modified time of this file.protected voidCalled when the output stream for this file is closed.protected voidinjectType(FileType fileType) Sets the file type.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, doIsExecutable, doIsHidden, doIsReadable, doIsSameFile, doIsSymbolicLink, doIsWriteable, doListChildrenResolved, doRemoveAttribute, doSetAttribute, doSetExecutable, doSetReadable, doSetWritable, 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, isAttached, isContentOpen, isExecutable, isFile, isFolder, isHidden, isReadable, isSameFile, isSymbolicLink, isWriteable, iterator, listFiles, moveTo, notifyAllStreamsClosed, onChange, onChildrenChanged, refresh, resolveFile, resolveFile, setExecutable, setReadable, setWritable, toStringMethods 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
-
RamFileObject
Constructs a new instance.- Parameters:
fileName- the file name.fileSystem- the file system.
-
-
Method Details
-
doAttach
Description copied from class:AbstractFileObjectAttaches 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 initialization.
This implementation does nothing.
- Overrides:
doAttachin classAbstractFileObject<RamFileSystem>- Throws:
Exception- if an error occurs.
-
doCreateFolder
Description copied from class:AbstractFileObjectCreates this file as a folder. Is only called when:AbstractFileObject.doGetType()returnsFileType.IMAGINARY.- The parent folder exists and is writable, or this file is the root of the file system.
- Overrides:
doCreateFolderin classAbstractFileObject<RamFileSystem>- Throws:
Exception- if an error occurs.
-
doDelete
Description copied from class:AbstractFileObjectDeletes 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:
doDeletein classAbstractFileObject<RamFileSystem>- Throws:
Exception- if an error occurs.
-
doGetContentSize
Description copied from class:AbstractFileObjectReturns the size of the file content (in bytes). Is only called ifAbstractFileObject.doGetType()returnsFileType.FILE.- Specified by:
doGetContentSizein classAbstractFileObject<RamFileSystem>- Returns:
- The size of the file in bytes.
- Throws:
Exception- if an error occurs.
-
doGetInputStream
Description copied from class:AbstractFileObjectCreates 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.
- Overrides:
doGetInputStreamin classAbstractFileObject<RamFileSystem>- Parameters:
bufferSize- Buffer size hint.- Returns:
- An InputStream to read the file content.
- Throws:
Exception- if an error occurs.
-
doGetLastModifiedTime
Description copied from class:AbstractFileObjectReturns the last modified time of this file. Is only called ifAbstractFileObject.doGetType()does not returnThis implementation throws an exception.
- Overrides:
doGetLastModifiedTimein classAbstractFileObject<RamFileSystem>- Returns:
- The last modification time.
- Throws:
Exception- if an error occurs.
-
doGetOutputStream
Description copied from class:AbstractFileObjectCreates 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:
doGetOutputStreamin 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.
-
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<RamFileSystem>- Parameters:
mode- The mode to access the file.- Returns:
- The RandomAccessContext.
- Throws:
Exception- if an error occurs.
-
doGetType
Description copied from class:AbstractFileObjectDetermines 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:
doGetTypein classAbstractFileObject<RamFileSystem>- Returns:
- the type of the file.
- Throws:
Exception- if an error occurs.
-
doListChildren
Description copied from class:AbstractFileObjectLists 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:
doListChildrenin 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.
-
doRename
Description copied from class:AbstractFileObjectRenames the file.Is only called when:
AbstractFileObject.doIsWriteable()returns true.
This implementation throws an exception.
- Overrides:
doRenamein classAbstractFileObject<RamFileSystem>- Parameters:
newFile- A FileObject with the new file name.- Throws:
Exception- if an error occurs.
-
doSetLastModifiedTime
Description copied from class:AbstractFileObjectSets the last modified time of this file.Is only called if
AbstractFileObject.doGetType()does not returnFileType.IMAGINARY.This implementation throws an exception.
- Overrides:
doSetLastModifiedTimein 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
-
endOutput
Description copied from class:AbstractFileObjectCalled when the output stream for this file is closed.- Overrides:
endOutputin classAbstractFileObject<RamFileSystem>- Throws:
Exception- if an error occurs.
-
injectType
Description copied from class:AbstractFileObjectSets the file type.- Overrides:
injectTypein classAbstractFileObject<RamFileSystem>- Parameters:
fileType- the file type.
-