com.bergerkiller.bukkit.common.config

Class FileConfiguration

java.lang.Object

com.bergerkiller.bukkit.common.config.yaml.YamlNodeAbstract<ConfigurationNode>

com.bergerkiller.bukkit.common.config.ConfigurationNode

com.bergerkiller.bukkit.common.config.BasicConfiguration

com.bergerkiller.bukkit.common.config.FileConfiguration

All Implemented Interfaces:

Cloneable

public class FileConfiguration
extends BasicConfiguration

Field Summary

Fields inherited from class com.bergerkiller.bukkit.common.config.yaml.YamlNodeAbstract

_children, _entry, _root

Constructor Summary

Constructors

Constructor and Description
FileConfiguration(File file)
FileConfiguration(org.bukkit.plugin.java.JavaPlugin plugin)
FileConfiguration(org.bukkit.plugin.java.JavaPlugin plugin, String filepath)
FileConfiguration(String filepath)

Method Summary

Modifier and Type	Method and Description
boolean	exists()
static Iterable<File>	findSaveOperationsInDirectory(File directory) Gets all the files for which FileConfiguration save operations are still ongoing inside a directory.
static void	flushAllSaveOperations() Finishes all FileConfiguration save operations that are still ongoing
static void	flushAllSaveOperationsForPlugin(org.bukkit.plugin.Plugin plugin) Finishes all FileConfiguration save operations that are still ongoing inside the configuration directory of a plugin.
static void	flushAllSaveOperationsInDirectory(File directory) Finishes all FileConfiguration save operations that are still ongoing inside a directory.
static void	flushSaveOperation(File file) Finishes any save operation that is going on for a particular file
static boolean	flushSaveOperation(File file, long timeout) Finishes any save operation that is going on for a particular file with a timeout in milliseconds.
void	load() Loads this File Configuration from file
void	save() Saves this File Configuration to file asynchronously in the background.
void	saveSync() Saves this File Configuration to file and waits for writing to complete

Methods inherited from class com.bergerkiller.bukkit.common.config.BasicConfiguration

getIndent, getPath, loadDeserializerOutput, setIndent

Methods inherited from class com.bergerkiller.bukkit.common.config.ConfigurationNode

clone, createNode, getNode, getParent, isRead, isRead, set, setNodeList, setRead, setRead, trim

Methods inherited from class com.bergerkiller.bukkit.common.config.yaml.YamlNodeAbstract

addHeader, addHeader, clear, clearHeaders, cloneChildEntry, contains, createChildEntry, createEntryIfAbsent, get, get, get, get, getEntry, getEntryIfExists, getHeader, getHeader, getKeys, getList, getList, getList, getName, getNodeList, getNodes, getPath, getValues, getValues, getYamlParent, getYamlPath, hasParent, indexOfKey, indexOfValue, isEmpty, isNode, lastIndexOfValue, loadFromReader, loadFromStream, loadFromString, remove, remove, removeChildEntry, removeChildEntryAt, removeHeader, removeHeader, saveToFileAsync, saveToStream, saveToWriter, setHeader, setHeader, setIfAbsent, setValues, shareWith, shareWithMap, toCharBuffer, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

FileConfiguration

public FileConfiguration(org.bukkit.plugin.java.JavaPlugin plugin)

FileConfiguration

public FileConfiguration(org.bukkit.plugin.java.JavaPlugin plugin,
                         String filepath)

FileConfiguration

public FileConfiguration(String filepath)

FileConfiguration

public FileConfiguration(File file)

Method Detail

exists

public boolean exists()

load

public void load()

Loads this File Configuration from file

saveSync

public void saveSync()

Saves this File Configuration to file and waits for writing to complete

save

public void save()

Saves this File Configuration to file asynchronously in the background. A guarantee is made that future calls to load() for this FileConfiguration or a different instance for the same file will wait for this save to complete.

All pending saves are flushed when BKCommonLib terminates.

flushSaveOperation

public static void flushSaveOperation(File file)

Finishes any save operation that is going on for a particular file

Parameters:

file -

flushSaveOperation

public static boolean flushSaveOperation(File file,
                                         long timeout)

Finishes any save operation that is going on for a particular file with a timeout in milliseconds. If the timeout is reached, then false is returned.

Parameters:

file -

timeout -

Returns:

Whether flushing was sucessful, False if and only if the timeout was reached

flushAllSaveOperations

public static void flushAllSaveOperations()

Finishes all FileConfiguration save operations that are still ongoing

flushAllSaveOperationsInDirectory

public static void flushAllSaveOperationsInDirectory(File directory)

Finishes all FileConfiguration save operations that are still ongoing inside a directory. Files inside sub-directories of the directory are waited for as well. If the directory is null, then all ongoing save operations are waited for.

Parameters:

directory -

flushAllSaveOperationsForPlugin

public static void flushAllSaveOperationsForPlugin(org.bukkit.plugin.Plugin plugin)

Finishes all FileConfiguration save operations that are still ongoing inside the configuration directory of a plugin.

Parameters:

plugin -

findSaveOperationsInDirectory

public static Iterable<File> findSaveOperationsInDirectory(File directory)

Gets all the files for which FileConfiguration save operations are still ongoing inside a directory. If the directory specified is null, then all ongoing save operations are returned. Due to the asynchronous nature of saving, the saving may have already be completed by the time the file is iterated.

The iterable returned is generated live, which means it can be used more than once and new save operations will show up.

Parameters:

directory -

Returns:

ongoing save operations