Package net.runelite.client.util

Class Filepath

java.lang.Object

net.runelite.client.util.Filepath

All Implemented Interfaces:

Comparable<Filepath>

public class Filepath
extends Object
implements Comparable<Filepath>

A path to a file or directory that cannot escape its original location. A Filepath wraps Path in a way that prevents Plugins from writing to unexpected locations. Plugins may obtain a Filepath by calling Plugin.getPluginDirectory() or using a Filepath.Chooser

See Also:

Path

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Filepath.Chooser	Provides a dialog for users to select a Filepath
static class	Filepath.Unchecked	Interacting with these methods prevent PluginHub plugins from being automatically reviewed

Method Summary

Modifier and Type	Method	Description
int	compareTo(Filepath o)
void	copyTo(Filepath target, CopyOption... options)	Copies this file to target
void	createDirectories()
void	createDirectory()
Filepath	createTempDir(String prefix)
Filepath	createTempFile(String prefix, String suffix)
void	delete()
void	deleteIfExists()
void	deleteRecursively()	Deletes this file/directory, and all of the files inside it.
boolean	equals(Object obj)
boolean	exists()
String	getFileName()
FileTime	getLastModifiedTime()
Filepath	getParent()	Gets the parent directory of this filepath.
Filepath	getRoot()	Gets the highest level Filepath this can access.
int	hashCode()
boolean	isDirectory()
boolean	isFile()
boolean	isRoot()
Filepath	join(String append, String... more)	Append the given path segments to this path
Filepath	joinSegment(String append)	Append a single segment to this path, throwing if append is not a single segment
void	moveTo(Filepath target, CopyOption... options)	Moves this file to target
BufferedReader	openBufferedReader(OpenOption... options)	Opens a file, returning a buffered UTF-8 Reader
BufferedWriter	openBufferedWriter(OpenOption... options)	Opens or creates a file, returning an buffered UTF-8 Writer
FileChannel	openFileChannel(OpenOption... options)
InputStream	openInputStream(OpenOption... options)
OutputStream	openOutputStream(OpenOption... options)
Reader	openReader(OpenOption... options)	Opens a file, returning an unbuffered UTF-8 Reader
Writer	openWriter(OpenOption... options)	Opens or creates a file, returning an unbuffered UTF-8 Writer
Filepath	rooted()	Create a new filepath with its root set to this filepath
long	size()
boolean	startsWith(Filepath other)
String	toString()
Stream<Filepath>	walk(int maxDepth, FileVisitOption... options)
Stream<Filepath>	walk(FileVisitOption... options)
void	write(byte @NonNull [] bytes, OpenOption... options)
void	write(@NonNull String string, OpenOption... options)	Writes string to this filepath as UTF-8.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

join

public Filepath join(String append,
                     String... more)

Append the given path segments to this path

See Also:

Path.resolve(java.nio.file.Path)

joinSegment

public Filepath joinSegment(String append)

Append a single segment to this path, throwing if append is not a single segment

getParent

public Filepath getParent()

Gets the parent directory of this filepath.

Throws:

IllegalArgumentException - if this filepath isRoot()

See Also:

Path.getParent()

isRoot

public boolean isRoot()

Returns:

true if this path can't be used to access it's parent

getRoot

public Filepath getRoot()

Gets the highest level Filepath this can access.

rooted

public Filepath rooted()

Create a new filepath with its root set to this filepath

getFileName

public String getFileName()

See Also:

Path.getFileName()

startsWith

public boolean startsWith(Filepath other)

See Also:

Path.startsWith(Path)

createTempFile

public Filepath createTempFile(String prefix,
                               String suffix)
                        throws IOException

Throws:

IOException

See Also:

Files.createTempFile(java.nio.file.Path, java.lang.String, java.lang.String, java.nio.file.attribute.FileAttribute<?>...)

createTempDir

public Filepath createTempDir(String prefix)
                       throws IOException

Throws:

IOException

See Also:

Files.createTempDirectory(java.nio.file.Path, java.lang.String, java.nio.file.attribute.FileAttribute<?>...)

walk

public Stream<Filepath> walk(FileVisitOption... options)
                      throws IOException

Throws:

IOException

See Also:

The resulting Stream must be ed or used in a try-with-resources statement

walk

public Stream<Filepath> walk(int maxDepth,
                             FileVisitOption... options)
                      throws IOException

Throws:

IOException

See Also:

The resulting Stream must be ed or used in a try-with-resources statement

exists

public boolean exists()

See Also:

Files.exists(Path, LinkOption...)

isFile

public boolean isFile()

See Also:

Files.isRegularFile(Path, LinkOption...)

isDirectory

public boolean isDirectory()

See Also:

Files.isDirectory(Path, LinkOption...)

size

public long size()
          throws IOException

Throws:

IOException

See Also:

Files.size(Path)

getLastModifiedTime

public FileTime getLastModifiedTime()
                             throws IOException

Throws:

IOException

See Also:

Files.getLastModifiedTime(Path, LinkOption...)

delete

public void delete()
            throws IOException

Throws:

IOException

See Also:

Files.delete(Path)

deleteIfExists

public void deleteIfExists()
                    throws IOException

Throws:

IOException

See Also:

Files.deleteIfExists(Path)

deleteRecursively

public void deleteRecursively()
                       throws IOException

Deletes this file/directory, and all of the files inside it.

Throws:

IOException

createDirectory

public void createDirectory()
                     throws IOException

Throws:

IOException

See Also:

Files.createDirectory(java.nio.file.Path, java.nio.file.attribute.FileAttribute<?>...)

createDirectories

public void createDirectories()
                       throws IOException

Throws:

IOException

See Also:

Files.createDirectories(java.nio.file.Path, java.nio.file.attribute.FileAttribute<?>...)

copyTo

public void copyTo(Filepath target,
                   CopyOption... options)
            throws IOException

Copies this file to target

Throws:

IOException

See Also:

Files.copy(Path, Path, CopyOption...)

moveTo

public void moveTo(Filepath target,
                   CopyOption... options)
            throws IOException

Moves this file to target

Throws:

IOException

See Also:

Files.move(Path, Path, CopyOption...)

openFileChannel

public FileChannel openFileChannel(OpenOption... options)
                            throws IOException

Throws:

IOException

See Also:

FileChannel.open(Path, OpenOption...)

openInputStream

public InputStream openInputStream(OpenOption... options)
                            throws IOException

Throws:

IOException

See Also:

Files.newInputStream(Path, OpenOption...)

openOutputStream

public OutputStream openOutputStream(OpenOption... options)
                              throws IOException

Throws:

IOException

See Also:

Files.newOutputStream(Path, OpenOption...)

openReader

public Reader openReader(OpenOption... options)
                  throws IOException

Opens a file, returning an unbuffered UTF-8 Reader

Throws:

IOException

openBufferedReader

public BufferedReader openBufferedReader(OpenOption... options)
                                  throws IOException

Opens a file, returning a buffered UTF-8 Reader

Throws:

IOException

openWriter

public Writer openWriter(OpenOption... options)
                  throws IOException

Opens or creates a file, returning an unbuffered UTF-8 Writer

Throws:

IOException

openBufferedWriter

public BufferedWriter openBufferedWriter(OpenOption... options)
                                  throws IOException

Opens or creates a file, returning an buffered UTF-8 Writer

Throws:

IOException

write

public void write(byte @NonNull [] bytes,
                  OpenOption... options)
           throws IOException

Throws:

IOException

See Also:

Files.write(Path, byte[], OpenOption...)

write

public void write(@NonNull
                  @NonNull String string,
                  OpenOption... options)
           throws IOException

Writes string to this filepath as UTF-8.

Throws:

IOException

See Also:

Files.write(Path, byte[], OpenOption...)

compareTo

public int compareTo(Filepath o)

Specified by:

compareTo in interface Comparable<Filepath>

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object