net.risingworld.api.utils

Class Utils.FileUtils

java.lang.Object

net.risingworld.api.utils.Utils.FileUtils

Enclosing class:

Utils

public abstract static class Utils.FileUtils
extends java.lang.Object

Contains various file function, including file access, reading or writing to files, or getting the md5 checksum of a file.

Constructor Summary

Constructors

Constructor and Description
FileUtils()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	getMd5(java.io.File file) Gets the MD5 hash of a file.
static byte[]	readBytesFromFile(java.io.File file) Reads the bytes of a file.
static java.lang.String	readStringFromFile(java.io.File file) Reads a text / string from a file.
static boolean	writeBytesToFile(byte[] bytes, java.io.File file) Writes bytes to a file.
static boolean	writeStringToFile(java.lang.String text, java.io.File file) Writes a string to file.

Methods inherited from class java.lang.Object

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

Constructor Detail

FileUtils

public FileUtils()

Method Detail

writeStringToFile

public static boolean writeStringToFile(java.lang.String text,
                                        java.io.File file)

Writes a string to file. This overrides the current file content.

Parameters:

text - the text you want to write to a file.

file - the target file.

Returns:

true if the text was written to the file successfully, false if not.

Example: Write String to txt file in the plugin directory

1	File targetFile = new File(getPath() + "data.txt");
2	Utils.FileUtils.writeStringToFile("Hello World!", targetFile);

readStringFromFile

public static java.lang.String readStringFromFile(java.io.File file)

Reads a text / string from a file.

Parameters:

file - the target file.

Returns:

the string that was read from the file, or null if no such file was found.

writeBytesToFile

public static boolean writeBytesToFile(byte[] bytes,
                                       java.io.File file)

Writes bytes to a file. This overrides the current file content.

Parameters:

bytes - the bytes you want to write to a file.

file - the target file.

Returns:

true if the bytes were written to the file successfully, false if not.

readBytesFromFile

public static byte[] readBytesFromFile(java.io.File file)

Reads the bytes of a file.

Parameters:

file - the target file.

Returns:

the file as a byte array.

getMd5

public static java.lang.String getMd5(java.io.File file)

Gets the MD5 hash of a file.

Parameters:

file - the target file.

Returns:

the MD5 hash as a string, or null if no such file was found.