Class RamFileObject
- All Implemented Interfaces:
- Closeable,- AutoCloseable,- Comparable<FileObject>,- Iterable<FileObject>,- FileObject
- 
Field SummaryFields inherited from class org.apache.commons.vfs2.provider.AbstractFileObjectDEFAULT_BUFFER_SIZEFields inherited from interface org.apache.commons.vfs2.FileObjectEMPTY_ARRAY
- 
Constructor SummaryConstructorsModifierConstructorDescriptionprotectedRamFileObject(AbstractFileName fileName, RamFileSystem fileSystem) Constructs a new instance.
- 
Method SummaryModifier 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.AbstractFileObjectcanRenameTo, 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.Objectclone, equals, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface org.apache.commons.vfs2.FileObjectgetPath, getURIMethods inherited from interface java.lang.IterableforEach, spliterator
- 
Constructor Details- 
RamFileObjectConstructs a new instance.- Parameters:
- fileName- the file name.
- fileSystem- the file system.
 
 
- 
- 
Method Details- 
doAttachDescription 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 class- AbstractFileObject<RamFileSystem>
- Throws:
- Exception- if an error occurs.
 
- 
doCreateFolderDescription copied from class:AbstractFileObjectCreates this file as a folder. Is only called when:- AbstractFileObject.doGetType()returns- FileType.IMAGINARY.
- The parent folder exists and is writable, or this file is the root of the file system.
 - Overrides:
- doCreateFolderin class- AbstractFileObject<RamFileSystem>
- Throws:
- Exception- if an error occurs.
 
- 
doDeleteDescription copied from class:AbstractFileObjectDeletes the file. Is only called when:- AbstractFileObject.doGetType()does not return- FileType.IMAGINARY.
- AbstractFileObject.doIsWriteable()returns true.
- This file has no children, if a folder.
 - Overrides:
- doDeletein class- AbstractFileObject<RamFileSystem>
- Throws:
- Exception- if an error occurs.
 
- 
doGetContentSizeDescription copied from class:AbstractFileObjectReturns the size of the file content (in bytes). Is only called ifAbstractFileObject.doGetType()returnsFileType.FILE.- Specified by:
- doGetContentSizein class- AbstractFileObject<RamFileSystem>
- Returns:
- The size of the file in bytes.
- Throws:
- Exception- if an error occurs.
 
- 
doGetInputStreamDescription 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 class- AbstractFileObject<RamFileSystem>
- Parameters:
- bufferSize- Buffer size hint.
- Returns:
- An InputStream to read the file content.
- Throws:
- Exception- if an error occurs.
 
- 
doGetLastModifiedTimeDescription 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 class- AbstractFileObject<RamFileSystem>
- Returns:
- The last modification time.
- Throws:
- Exception- if an error occurs.
 
- 
doGetOutputStreamDescription copied from class:AbstractFileObjectCreates an output stream to write the file content to. Is only called if:- AbstractFileObject.doIsWriteable()returns true.
- AbstractFileObject.doGetType()returns- FileType.FILE, or- AbstractFileObject.doGetType()returns- FileType.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 class- AbstractFileObject<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.
 
- 
doGetRandomAccessContentDescription 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 class- AbstractFileObject<RamFileSystem>
- Parameters:
- mode- The mode to access the file.
- Returns:
- The RandomAccessContext.
- Throws:
- Exception- if an error occurs.
 
- 
doGetTypeDescription 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 class- AbstractFileObject<RamFileSystem>
- Returns:
- the type of the file.
- Throws:
- Exception- if an error occurs.
 
- 
doListChildrenDescription 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 class- AbstractFileObject<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.
 
- 
doRenameDescription copied from class:AbstractFileObjectRenames the file.Is only called when: - AbstractFileObject.doIsWriteable()returns true.
 This implementation throws an exception. - Overrides:
- doRenamein class- AbstractFileObject<RamFileSystem>
- Parameters:
- newFile- A FileObject with the new file name.
- Throws:
- Exception- if an error occurs.
 
- 
doSetLastModifiedTimeDescription 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 class- AbstractFileObject<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
 
- 
endOutputDescription copied from class:AbstractFileObjectCalled when the output stream for this file is closed.- Overrides:
- endOutputin class- AbstractFileObject<RamFileSystem>
- Throws:
- Exception- if an error occurs.
 
- 
injectTypeDescription copied from class:AbstractFileObjectSets the file type.- Overrides:
- injectTypein class- AbstractFileObject<RamFileSystem>
- Parameters:
- fileType- the file type.
 
 
-