1
0
mirror of https://github.com/SquidDev-CC/CC-Tweaked synced 2025-11-17 13:47:11 +00:00

Reformat everything

This commit is contained in:
Jonathan Coates
2021-06-09 07:53:21 +01:00
parent a6c7236fa0
commit b429095f88
409 changed files with 20797 additions and 15102 deletions

View File

@@ -6,18 +6,16 @@
package dan200.computercraft.api.filesystem;
import dan200.computercraft.api.ComputerCraftAPI;
import dan200.computercraft.api.peripheral.IComputerAccess;
import net.minecraft.world.World;
import javax.annotation.Nonnull;
import java.io.IOException;
import java.nio.channels.ReadableByteChannel;
import java.nio.file.attribute.BasicFileAttributes;
import java.util.List;
import javax.annotation.Nonnull;
import dan200.computercraft.api.ComputerCraftAPI;
import dan200.computercraft.api.peripheral.IComputerAccess;
import net.minecraft.world.World;
/**
* Represents a read only part of a virtual filesystem that can be mounted onto a computer using {@link IComputerAccess#mount(String, IMount)}.
*
@@ -29,26 +27,27 @@ import net.minecraft.world.World;
* @see IComputerAccess#mount(String, IMount)
* @see IWritableMount
*/
public interface IMount {
public interface IMount
{
/**
* Returns the file names of all the files in a directory.
*
* @param path A file path in normalised format, relative to the mount location. ie: "programs/myprograms".
* @param path A file path in normalised format, relative to the mount location. ie: "programs/myprograms".
* @param contents A list of strings. Add all the file names to this list.
* @throws IOException If the file was not a directory, or could not be listed.
*/
void list(@Nonnull String path, @Nonnull List<String> contents) throws IOException;
void list( @Nonnull String path, @Nonnull List<String> contents ) throws IOException;
/**
* Opens a file with a given path, and returns an {@link ReadableByteChannel} representing its contents.
*
* @param path A file path in normalised format, relative to the mount location. ie: "programs/myprogram".
* @return A channel representing the contents of the file. If the channel implements {@link java.nio.channels.SeekableByteChannel}, one will be able to
* seek to arbitrary positions when using binary mode.
* seek to arbitrary positions when using binary mode.
* @throws IOException If the file does not exist, or could not be opened.
*/
@Nonnull
ReadableByteChannel openForRead(@Nonnull String path) throws IOException;
ReadableByteChannel openForRead( @Nonnull String path ) throws IOException;
/**
* Get attributes about the given file.
@@ -58,11 +57,13 @@ public interface IMount {
* @throws IOException If the file does not exist, or attributes could not be fetched.
*/
@Nonnull
default BasicFileAttributes getAttributes(@Nonnull String path) throws IOException {
if (!this.exists(path)) {
throw new FileOperationException(path, "No such file");
default BasicFileAttributes getAttributes( @Nonnull String path ) throws IOException
{
if( !this.exists( path ) )
{
throw new FileOperationException( path, "No such file" );
}
return new FileAttributes(this.isDirectory(path), this.getSize(path));
return new FileAttributes( this.isDirectory( path ), this.getSize( path ) );
}
/**
@@ -72,7 +73,7 @@ public interface IMount {
* @return If the file exists.
* @throws IOException If an error occurs when checking the existence of the file.
*/
boolean exists(@Nonnull String path) throws IOException;
boolean exists( @Nonnull String path ) throws IOException;
/**
* Returns whether a file with a given path is a directory or not.
@@ -81,7 +82,7 @@ public interface IMount {
* @return If the file exists and is a directory
* @throws IOException If an error occurs when checking whether the file is a directory.
*/
boolean isDirectory(@Nonnull String path) throws IOException;
boolean isDirectory( @Nonnull String path ) throws IOException;
/**
* Returns the size of a file with a given path, in bytes.
@@ -90,5 +91,5 @@ public interface IMount {
* @return The size of the file, in bytes.
* @throws IOException If the file does not exist, or its size could not be determined.
*/
long getSize(@Nonnull String path) throws IOException;
long getSize( @Nonnull String path ) throws IOException;
}