public abstract class AnnoyingFile
extends org.bukkit.configuration.file.YamlConfiguration
| Modifier and Type | Class and Description |
|---|---|
static class |
AnnoyingFile.Options<T extends AnnoyingFile.Options<T>>
A class to hold the options for a file
|
| Modifier and Type | Field and Description |
|---|---|
@NotNull java.io.File |
file
The file constructed using the
path |
protected AnnoyingFile.Options<?> |
fileOptions
The
AnnoyingFile.Options for the file |
@NotNull java.lang.String |
path
The path to the file
|
@NotNull AnnoyingPlugin |
plugin
The
AnnoyingPlugin instance |
BLANK_CONFIG, COMMENT_PREFIX| Modifier | Constructor and Description |
|---|---|
protected |
AnnoyingFile(@NotNull AnnoyingPlugin plugin,
@NotNull java.lang.String path)
Constructs a new
AnnoyingFile |
protected |
AnnoyingFile(@NotNull AnnoyingPlugin plugin,
@NotNull java.lang.String path,
AnnoyingFile.Options<?> fileOptions)
Constructs a new
AnnoyingFile |
| Modifier and Type | Method and Description |
|---|---|
abstract void |
create()
Creates the
file |
void |
delete()
Deletes the
file |
<T> T |
getAttributeModifier(@NotNull java.lang.String path)
1.9+ Gets an AttributeModifier from the path. |
<T> T |
getAttributeModifier(@NotNull java.lang.String path,
T def)
1.9+ Gets an AttributeModifier from the path. |
@Nullable org.bukkit.inventory.ItemStack |
getItemStack(@NotNull java.lang.String path)
Gets an
ItemStack from the path. |
@Nullable org.bukkit.inventory.ItemStack |
getItemStack(@NotNull java.lang.String path,
@Nullable org.bukkit.inventory.ItemStack def)
Gets an
ItemStack from the path. |
@Nullable PlayableSound |
getPlayableSound(@NotNull java.lang.String path)
Gets a
PlayableSound from the path. |
@Nullable PlayableSound |
getPlayableSound(@NotNull java.lang.String path,
@Nullable PlayableSound def)
Gets a
PlayableSound from the path. |
@Nullable org.bukkit.inventory.Recipe |
getRecipe(@NotNull java.lang.String path)
Gets a
Recipe from the YAML. |
@Nullable org.bukkit.inventory.Recipe |
getRecipe(@NotNull java.lang.String path,
@Nullable java.util.function.UnaryOperator<org.bukkit.inventory.ItemStack> itemFunction)
Gets a
Recipe from the YAML. |
@Nullable org.bukkit.inventory.Recipe |
getRecipe(@NotNull java.lang.String path,
@Nullable java.util.function.UnaryOperator<org.bukkit.inventory.ItemStack> itemFunction,
@Nullable org.bukkit.inventory.Recipe def)
Gets a
Recipe from the YAML. |
@Nullable org.bukkit.inventory.Recipe |
getRecipe(@NotNull java.lang.String path,
@Nullable java.util.function.UnaryOperator<org.bukkit.inventory.ItemStack> itemFunction,
@Nullable org.bukkit.inventory.Recipe def,
@Nullable java.lang.String name)
Gets a
Recipe from the YAML. |
@Nullable org.bukkit.Sound |
getSound(@NotNull java.lang.String path)
Gets a
Sound from the path |
@Nullable org.bukkit.Sound |
getSound(@NotNull java.lang.String path,
@Nullable org.bukkit.Sound def)
Gets a
Sound from the path |
void |
load()
Loads the YAML from the path
|
void |
log(@NotNull java.util.logging.Level level,
@Nullable java.lang.String key,
@NotNull java.lang.String message)
Sends a formatted log message to the console
Sends a formatted warning message to the console
|
void |
save()
Saves the YAML to the
file |
void |
setSave(@Nullable java.lang.String path,
@Nullable java.lang.Object value)
Sets a value in the YAML and then
saves the file |
@NotNull java.lang.String |
toString() |
buildHeader, convertMapsToSections, loadConfiguration, loadConfiguration, loadConfiguration, loadFromString, options, parseHeader, saveToStringload, load, load, load, save, saveaddDefault, addDefaults, addDefaults, getDefaults, getParent, setDefaultscontains, createPath, createPath, createSection, createSection, get, get, getBoolean, getBoolean, getBooleanList, getByteList, getCharacterList, getColor, getColor, getConfigurationSection, getCurrentPath, getDefault, getDefaultSection, getDouble, getDouble, getDoubleList, getFloatList, getInt, getInt, getIntegerList, getKeys, getList, getList, getLong, getLong, getLongList, getMapList, getName, getOfflinePlayer, getOfflinePlayer, getRoot, getShortList, getString, getString, getStringList, getValues, getVector, getVector, isBoolean, isColor, isConfigurationSection, isDouble, isInt, isItemStack, isList, isLong, isOfflinePlayer, isPrimitiveWrapper, isSet, isString, isVector, mapChildrenKeys, mapChildrenValues, setclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitcontains, createSection, createSection, get, get, getBoolean, getBoolean, getBooleanList, getByteList, getCharacterList, getColor, getColor, getConfigurationSection, getCurrentPath, getDefaultSection, getDouble, getDouble, getDoubleList, getFloatList, getInt, getInt, getIntegerList, getKeys, getList, getList, getLong, getLong, getLongList, getMapList, getName, getOfflinePlayer, getOfflinePlayer, getRoot, getShortList, getString, getString, getStringList, getValues, getVector, getVector, isBoolean, isColor, isConfigurationSection, isDouble, isInt, isItemStack, isList, isLong, isOfflinePlayer, isSet, isString, isVector, set@NotNull public final @NotNull AnnoyingPlugin plugin
AnnoyingPlugin instance@NotNull public final @NotNull java.lang.String path
@NotNull public final @NotNull java.io.File file
path@NotNull protected final AnnoyingFile.Options<?> fileOptions
AnnoyingFile.Options for the fileprotected AnnoyingFile(@NotNull
@NotNull AnnoyingPlugin plugin,
@NotNull
@NotNull java.lang.String path,
@Nullable
AnnoyingFile.Options<?> fileOptions)
AnnoyingFileplugin - pluginpath - pathfileOptions - fileOptionsprotected AnnoyingFile(@NotNull
@NotNull AnnoyingPlugin plugin,
@NotNull
@NotNull java.lang.String path)
AnnoyingFile@NotNull public @NotNull java.lang.String toString()
toString in class org.bukkit.configuration.MemorySectionpublic abstract void create()
filepublic void load()
public void delete()
filepublic void setSave(@Nullable
@Nullable java.lang.String path,
@Nullable
@Nullable java.lang.Object value)
saves the filepath - the path to the nodevalue - the value to set the node topublic void save()
filepublic void log(@NotNull
@NotNull java.util.logging.Level level,
@Nullable
@Nullable java.lang.String key,
@NotNull
@NotNull java.lang.String message)
level - the Level of the messagekey - the key of the node that the message is about (null if it's not about a node)message - the message to send@Nullable
public @Nullable org.bukkit.Sound getSound(@NotNull
@NotNull java.lang.String path)
Sound from the pathpath - the path to the nodeSound or null if it doesn't exist@Nullable
public @Nullable org.bukkit.Sound getSound(@NotNull
@NotNull java.lang.String path,
@Nullable
@Nullable org.bukkit.Sound def)
Sound from the pathpath - the path to the nodedef - the default valueSound or def if it doesn't exist@Nullable public @Nullable PlayableSound getPlayableSound(@NotNull @NotNull java.lang.String path)
PlayableSound from the path. See the wiki for more informationpath - the path to the nodePlayableSound or null if it's invalid@Nullable public @Nullable PlayableSound getPlayableSound(@NotNull @NotNull java.lang.String path, @Nullable @Nullable PlayableSound def)
PlayableSound from the path. See the wiki for more informationpath - the path to the nodedef - the default valuePlayableSound or def if it's invalid@Nullable
public <T> T getAttributeModifier(@NotNull
@NotNull java.lang.String path)
T - the AttributeModifier classpath - the path to the nodeAttributeModifier or null if it's invalid@Nullable
public <T> T getAttributeModifier(@NotNull
@NotNull java.lang.String path,
@Nullable
T def)
T - the AttributeModifier classpath - the path to the nodedef - the default valueAttributeModifier or def if it's invalid@Nullable
public @Nullable org.bukkit.inventory.ItemStack getItemStack(@NotNull
@NotNull java.lang.String path)
ItemStack from the path. See the wiki for more informationgetItemStack in interface org.bukkit.configuration.ConfigurationSectiongetItemStack in class org.bukkit.configuration.MemorySectionpath - the path to the nodeItemStack or null if it's invalid@Nullable
public @Nullable org.bukkit.inventory.ItemStack getItemStack(@NotNull
@NotNull java.lang.String path,
@Nullable
@Nullable org.bukkit.inventory.ItemStack def)
ItemStack from the path. See the wiki for more informationgetItemStack in interface org.bukkit.configuration.ConfigurationSectiongetItemStack in class org.bukkit.configuration.MemorySectionpath - the path to the nodedef - the default valueItemStack or def if it's invalid@Nullable
public @Nullable org.bukkit.inventory.Recipe getRecipe(@NotNull
@NotNull java.lang.String path)
Recipe from the YAML. See the wiki for more informationpath - the path to get the recipe fromRecipe or null if it doesn't exist / is invalid / something went wrong@Nullable
public @Nullable org.bukkit.inventory.Recipe getRecipe(@NotNull
@NotNull java.lang.String path,
@Nullable
@Nullable java.util.function.UnaryOperator<org.bukkit.inventory.ItemStack> itemFunction)
Recipe from the YAML. See the wiki for more informationpath - the path to get the recipe fromitemFunction - the function to apply to the ItemStack before returning itRecipe or null if it doesn't exist / is invalid / something went wrong@Nullable
public @Nullable org.bukkit.inventory.Recipe getRecipe(@NotNull
@NotNull java.lang.String path,
@Nullable
@Nullable java.util.function.UnaryOperator<org.bukkit.inventory.ItemStack> itemFunction,
@Nullable
@Nullable org.bukkit.inventory.Recipe def)
Recipe from the YAML. See the wiki for more informationpath - the path to get the recipe fromitemFunction - the function to apply to the ItemStack before returning itdef - the default Recipe to return if the recipe doesn't exist / is invalid / something went wrongRecipe or null if it doesn't exist / is invalid / something went wrong@Nullable
public @Nullable org.bukkit.inventory.Recipe getRecipe(@NotNull
@NotNull java.lang.String path,
@Nullable
@Nullable java.util.function.UnaryOperator<org.bukkit.inventory.ItemStack> itemFunction,
@Nullable
@Nullable org.bukkit.inventory.Recipe def,
@Nullable
@Nullable java.lang.String name)
Recipe from the YAML. See the wiki for more informationpath - the path to get the recipe fromitemFunction - the function to apply to the ItemStack before returning itdef - the default Recipe to return if the recipe doesn't exist / is invalid / something went wrongname - the name of the recipe (only used in 1.12+ for the NamespacedKey), or null to use the node nameRecipe or the def if it doesn't exist / is invalid / something went wrong