li.cil.oc.api

Class FileSystem

java.lang.Object

li.cil.oc.api.FileSystem

public final class FileSystem
extends java.lang.Object

This class provides factory methods for creating file systems that are compatible with the built-in file system driver.

File systems created this way and wrapped in a managed environment via asManagedEnvironment(li.cil.oc.api.fs.FileSystem, li.cil.oc.api.fs.Label, net.minecraft.tileentity.TileEntity) or its overloads will appear as filesystem components in the component network. Note that the component's visibility is set to Neighbors per default. If you wish to change the file system's visibility (e.g. like the disk drive does) you must cast the environment's node to Component and set the visibility to the desired value.

Note that these methods should not be called in the pre-init phase, since the instance may not have been initialized at that time. Only start calling these methods in the init phase or later.

Field Summary

Fields

Modifier and Type	Field and Description
static FileSystemAPI	instance

Method Summary

Methods

Modifier and Type	Method and Description
static ManagedEnvironment	asManagedEnvironment(FileSystem fileSystem) Like asManagedEnvironment(li.cil.oc.api.fs.FileSystem, Label), but creates an unlabeled file system (i.e.
static ManagedEnvironment	asManagedEnvironment(FileSystem fileSystem, Label label) Like asManagedEnvironment(li.cil.oc.api.fs.FileSystem, Label, TileEntity), but does not provide a container.
static ManagedEnvironment	asManagedEnvironment(FileSystem fileSystem, Label label, net.minecraft.tileentity.TileEntity container) Creates a network node that makes the specified file system available via the common file system driver.
static ManagedEnvironment	asManagedEnvironment(FileSystem fileSystem, java.lang.String label) Like asManagedEnvironment(li.cil.oc.api.fs.FileSystem, Label), but creates a read-only label initialized to the specified value.
static ManagedEnvironment	asManagedEnvironment(FileSystem fileSystem, java.lang.String label, net.minecraft.tileentity.TileEntity container) Like asManagedEnvironment(li.cil.oc.api.fs.FileSystem, Label, TileEntity), but creates a read-only label initialized to the specified value.
static FileSystem	fromClass(java.lang.Class<?> clazz, java.lang.String domain, java.lang.String root) Creates a new file system based on the location of a class.
static FileSystem	fromComputerCraft(dan200.computer.api.IMount mount) Creates a new file system based on a read-only ComputerCraft mount.
static FileSystem	fromComputerCraft(dan200.computer.api.IWritableMount mount) Creates a new file system based on a read-write ComputerCraft mount.
static FileSystem	fromComputerCraft(dan200.computercraft.api.filesystem.IMount mount) Creates a new file system based on a read-only ComputerCraft mount.
static FileSystem	fromComputerCraft(dan200.computercraft.api.filesystem.IWritableMount mount) Creates a new file system based on a read-write ComputerCraft mount.
static FileSystem	fromMemory(long capacity) Creates a new writable file system that resides in memory.
static FileSystem	fromSaveDirectory(java.lang.String root, long capacity) Same as fromSaveDirectory(String, long, boolean) with the buffered parameter being true, i.e.
static FileSystem	fromSaveDirectory(java.lang.String root, long capacity, boolean buffered) Creates a new writable file system in the save folder.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

instance

public static FileSystemAPI instance

Method Detail

fromClass

public static FileSystem fromClass(java.lang.Class<?> clazz,
                   java.lang.String domain,
                   java.lang.String root)

Creates a new file system based on the location of a class.

This can be used to wrap a folder in the assets folder of your mod's JAR. The actual path is built like this:

"/assets/" + domain + "/" + root

If the class is located in a JAR file, this will create a read-only file system based on that JAR file. If the class file is located in the native file system, this will create a read-only file system first trying from the actual location of the class file, and failing that by searching the class path (i.e. it'll look for a path constructed as described above).

If the specified path cannot be located, the creation fails and this returns null.

Parameters:

clazz - the class whose containing JAR to wrap.

domain - the domain, usually your mod's ID.

root - an optional subdirectory.

Returns:

a file system wrapping the specified folder.

fromSaveDirectory

public static FileSystem fromSaveDirectory(java.lang.String root,
                           long capacity,
                           boolean buffered)

Creates a new writable file system in the save folder.

This will create a folder, if necessary, and create a writable virtual file system based in that folder. The actual path is based in a sub- folder of the save folder. The actual path is built like this:

"saves/" + WORLD_NAME + "/opencomputers/" + root

The first part may differ, in particular for servers.

Usually the name will be the address of the node used to represent the file system.

Note that by default file systems are "buffered", meaning that any changes made to them are only saved to disk when the world is saved. This ensured that the file system contents do not go "out of sync" when the game crashes, but introduces additional memory overhead, since all files in the file system have to be kept in memory.

Parameters:

root - the name of the file system.

capacity - the amount of space in bytes to allow being used.

buffered - whether data should only be written to disk when saving.

Returns:

a file system wrapping the specified folder.

fromSaveDirectory

public static FileSystem fromSaveDirectory(java.lang.String root,
                           long capacity)

Same as fromSaveDirectory(String, long, boolean) with the buffered parameter being true, i.e. will always create a buffered file system.

Parameters:

root - the name of the file system.

capacity - the amount of space in bytes to allow being used.

Returns:

a file system wrapping the specified folder.

fromMemory

public static FileSystem fromMemory(long capacity)

Creates a new writable file system that resides in memory.

Any contents created and written on this file system will be lost when the node is removed from the network.

This is used for computers' /tmp mount, for example.

Parameters:

capacity - the capacity of the file system.

Returns:

a file system residing in memory.

fromComputerCraft

public static FileSystem fromComputerCraft(dan200.computer.api.IMount mount)

Creates a new file system based on a read-only ComputerCraft mount.

Parameters:

mount - the mount to wrap with a file system.

Returns:

a file system wrapping the specified mount.

fromComputerCraft

public static FileSystem fromComputerCraft(dan200.computer.api.IWritableMount mount)

Creates a new file system based on a read-write ComputerCraft mount.

Parameters:

mount - the mount to wrap with a file system.

Returns:

a file system wrapping the specified mount.

fromComputerCraft

public static FileSystem fromComputerCraft(dan200.computercraft.api.filesystem.IMount mount)

Creates a new file system based on a read-only ComputerCraft mount.

Parameters:

mount - the mount to wrap with a file system.

Returns:

a file system wrapping the specified mount.

fromComputerCraft

public static FileSystem fromComputerCraft(dan200.computercraft.api.filesystem.IWritableMount mount)

Creates a new file system based on a read-write ComputerCraft mount.

Parameters:

mount - the mount to wrap with a file system.

Returns:

a file system wrapping the specified mount.

asManagedEnvironment

public static ManagedEnvironment asManagedEnvironment(FileSystem fileSystem,
                                      Label label,
                                      net.minecraft.tileentity.TileEntity container)

Creates a network node that makes the specified file system available via the common file system driver.

This can be useful for providing some data if you don't wish to implement your own driver. Which will probably be most of the time. If you need more control over the node, implement your own, and connect this one to it. In that case you will have to forward any disk driver messages to the node, though.

The container parameter is used to give the file system some physical relation to the world, for example this is used by hard drives to send the disk event notifications to the client that are used to play disk access sounds.

The container may be null, if no such context can be provided.

Parameters:

fileSystem - the file system to wrap.

label - the label of the file system.

container - the tile entity containing the file system.

Returns:

the network node wrapping the file system.

asManagedEnvironment

public static ManagedEnvironment asManagedEnvironment(FileSystem fileSystem,
                                      java.lang.String label,
                                      net.minecraft.tileentity.TileEntity container)

Like asManagedEnvironment(li.cil.oc.api.fs.FileSystem, Label, TileEntity), but creates a read-only label initialized to the specified value.

Parameters:

fileSystem - the file system to wrap.

label - the read-only label of the file system.

Returns:

the network node wrapping the file system.

asManagedEnvironment

public static ManagedEnvironment asManagedEnvironment(FileSystem fileSystem,
                                      Label label)

Like asManagedEnvironment(li.cil.oc.api.fs.FileSystem, Label, TileEntity), but does not provide a container.

Parameters:

fileSystem - the file system to wrap.

label - the label of the file system.

Returns:

the network node wrapping the file system.

asManagedEnvironment

public static ManagedEnvironment asManagedEnvironment(FileSystem fileSystem,
                                      java.lang.String label)

Like asManagedEnvironment(li.cil.oc.api.fs.FileSystem, Label), but creates a read-only label initialized to the specified value.

Parameters:

fileSystem - the file system to wrap.

label - the read-only label of the file system.

Returns:

the network node wrapping the file system.

asManagedEnvironment

public static ManagedEnvironment asManagedEnvironment(FileSystem fileSystem)

Like asManagedEnvironment(li.cil.oc.api.fs.FileSystem, Label), but creates an unlabeled file system (i.e. the label can neither be read nor written).

Parameters:

fileSystem - the file system to wrap.

Returns:

the network node wrapping the file system.