VirtualFile (SIRIUS biz 7.0-rc3 API)

java.lang.Object
- sirius.biz.vfs.VirtualFile

```
public class VirtualFile
extends Object
```
Represents a file or directory in the VirtualFileSystem.
The way this file can be modified, can be controlled by providing the appropriate callbacks. If no appropriate handler is given, the operation is blocked for that file. Therefore, by default, a file is unmodifyable unless some handlers are provided.

Constructor Summary

Constructors
Constructor and Description

VirtualFile(VirtualFile parent, String name)
Creates a new file with the given name.

Constructors
Constructor and Description
`VirtualFile(VirtualFile parent, String name)` Creates a new file with the given name.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`createChildDirectory(String name)` Tries to create a subdirectory with the given name.
`OutputStream`	`createChildFile(String childName)` Creates a child file with the given name.
`InputStream`	`createInputStream()` Creates an input stream to read the contents of the file.
`OutputStream`	`createOutputStream()` Creates an output stream to write to the file.
`static VirtualFile`	`createRootNode()` Creates a root node, which represents "/".
`boolean`	`delete()` Tries to delete this file.
`void`	`enumerateChildren(Consumer<VirtualFile> childCollector)` Enumerates all children of this file.
`Optional<VirtualFile>`	`findChild(String name)` Tries to find a child with the given name.
`long`	`getLastModified()` Returns the last modification timestamp.
`String`	`getName()` Returns the name of this file.
`VirtualFile`	`getParent()` Returns the parent file of this file.
`String`	`getPath()` Returns the absolute path of this file within the virtual file system.
`long`	`getSize()` Returns the size of this file.
`boolean`	`isDirectory()` Determines if the file represents a directory.
`boolean`	`isReadable()` Determines if the file is readable.
`boolean`	`isWriteable()` Determines if the file is writeable.
`String`	`toString()`
`VirtualFile`	`withChildren(BiConsumer<VirtualFile,Consumer<VirtualFile>> childProvider)` Used to retrieve all child files of a directory.
`VirtualFile`	`withCreateDirectoryHandler(Function<String,Boolean> createDirectoryHandler)` Permits to create sub directories by invoking the given handler.
`VirtualFile`	`withCreateFileHandler(Function<String,OutputStream> createFileHandler)` Permits to create a child file with the given name and contents.
`VirtualFile`	`withDeleteHandler(Supplier<Boolean> deleteHandler)` Permits to delete a file.
`VirtualFile`	`withInputStreamSupplier(Supplier<InputStream> inputStreamSupplier)` Permits to read the contents of a file.
`VirtualFile`	`withLastModified(long lastModified)` Specifies the timestamp which represents the last modification.
`VirtualFile`	`withOutputStreamSupplier(Supplier<OutputStream> outputStreamSupplier)` Permits to write the contents of a file.
`VirtualFile`	`withSize(long size)` Specifies the file size in bytes.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - VirtualFile
```
public VirtualFile(@Nonnull
                   VirtualFile parent,
                   @Nonnull
                   String name)
```
    Creates a new file with the given name.
    
    Parameters:
    
    parent - the parent of the file
    
    name - the name of the file
- Method Detail
  - createRootNode
```
public static VirtualFile createRootNode()
```
    Creates a root node, which represents "/".
    
    Returns:
    
    now file, which can be used as root node for a virtual file system
  - withChildren
```
public VirtualFile withChildren(BiConsumer<VirtualFile,Consumer<VirtualFile>> childProvider)
```
    Used to retrieve all child files of a directory.
    
    Parameters:
    
    childProvider - the provider which supplies all children to a consumer
    
    Returns:
    
    the file itself for fluent method calls
  - withLastModified
```
public VirtualFile withLastModified(long lastModified)
```
    Specifies the timestamp which represents the last modification.
    
    Parameters:
    
    lastModified - the timestamp of the last modification
    
    Returns:
    
    the file itself for fluent method calls
    
    See Also:
    
    File.lastModified()
  - withSize
```
public VirtualFile withSize(long size)
```
    Specifies the file size in bytes.
    
    Parameters:
    
    size - the size in bytes
    
    Returns:
    
    the file itself for fluent method calls
  - withCreateDirectoryHandler
```
public VirtualFile withCreateDirectoryHandler(Function<String,Boolean> createDirectoryHandler)
```
    Permits to create sub directories by invoking the given handler.
    
    Parameters:
    
    createDirectoryHandler - the handler to create a sub directory with the given name
    
    Returns:
    
    the file itself for fluent method calls
  - withCreateFileHandler
```
public VirtualFile withCreateFileHandler(Function<String,OutputStream> createFileHandler)
```
    Permits to create a child file with the given name and contents.
    
    Parameters:
    
    createFileHandler - the handler to create a child file
    
    Returns:
    
    the file itself for fluent method calls
  - withDeleteHandler
```
public VirtualFile withDeleteHandler(Supplier<Boolean> deleteHandler)
```
    Permits to delete a file.
    
    Parameters:
    
    deleteHandler - the handler to delete the file
    
    Returns:
    
    the file itself for fluent method calls
  - withInputStreamSupplier
```
public VirtualFile withInputStreamSupplier(Supplier<InputStream> inputStreamSupplier)
```
    Permits to read the contents of a file.
    
    Parameters:
    
    inputStreamSupplier - the handler which provides an input stream of the files contents.
    
    Returns:
    
    the file itself for fluent method calls
  - withOutputStreamSupplier
```
public VirtualFile withOutputStreamSupplier(Supplier<OutputStream> outputStreamSupplier)
```
    Permits to write the contents of a file.
    
    Parameters:
    
    outputStreamSupplier - the handler which provides an output stream to write into the file.
    
    Returns:
    
    the file itself for fluent method calls
  - isDirectory
```
public boolean isDirectory()
```
    Determines if the file represents a directory.
    
    Returns:
    
    true if the file represents a directory, false otherwise
  - getParent
```
public VirtualFile getParent()
```
    Returns the parent file of this file.
    
    Returns:
    
    the parent of this file
  - getPath
```
public String getPath()
```
    Returns the absolute path of this file within the virtual file system.
    
    Returns:
    
    the absolute path of this file
  - getName
```
public String getName()
```
    Returns the name of this file.
    
    Returns:
    
    the name of this file
  - getLastModified
```
public long getLastModified()
```
    Returns the last modification timestamp.
    
    Returns:
    
    the last modification as in File.lastModified()
  - getSize
```
public long getSize()
```
    Returns the size of this file.
    
    Returns:
    
    the size in bytes
  - delete
```
public boolean delete()
```
    Tries to delete this file.
    
    Returns:
    
    true if the operation was successful, false otherwise
  - enumerateChildren
```
public void enumerateChildren(Consumer<VirtualFile> childCollector)
```
    Enumerates all children of this file.
    
    Parameters:
    
    childCollector - the consumer collecting all children of this file
  - findChild
```
public Optional<VirtualFile> findChild(String name)
```
    Tries to find a child with the given name.
    
    Parameters:
    
    name - the name of the child to find
    
    Returns:
    
    the child wrapped as optional or an empty optional if no child with the given name was found
  - createChildDirectory
```
public boolean createChildDirectory(String name)
```
    Tries to create a subdirectory with the given name.
    
    Parameters:
    
    name - the name of the subdirectory to create
    
    Returns:
    
    true if the operation was successful, false otherwise
  - createChildFile
```
public OutputStream createChildFile(String childName)
```
    Creates a child file with the given name.
    
    Parameters:
    
    childName - the name of the child.
    
    Returns:
    
    an output stream to provide the contents of the child
  - createOutputStream
```
public OutputStream createOutputStream()
```
    Creates an output stream to write to the file.
    
    Returns:
    
    an output stream to provide the contents of the child
  - isReadable
```
public boolean isReadable()
```
    Determines if the file is readable.
    
    Returns:
    
    true if the file is readable, false otherwise
  - isWriteable
```
public boolean isWriteable()
```
    Determines if the file is writeable.
    
    Returns:
    
    true if the file is writeable, false otherwise
  - createInputStream
```
public InputStream createInputStream()
```
    Creates an input stream to read the contents of the file.
    
    Returns:
    
    an input stream to read the contents of the file
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class VirtualFile

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

VirtualFile

Method Detail

createRootNode

withChildren

withLastModified

withSize

withCreateDirectoryHandler

withCreateFileHandler

withDeleteHandler

withInputStreamSupplier

withOutputStreamSupplier

isDirectory

getParent

getPath

getName

getLastModified

getSize

delete

enumerateChildren

findChild

createChildDirectory

createChildFile

createOutputStream

isReadable

isWriteable

createInputStream

toString