SteamWar/Paper
9
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Javadoc updates

Browse Source 
Fixes BUKKIT-1653, Fixes BUKKIT-1383 and Fixes BUKKIT-1644

By: feildmaster <admin@feildmaster.com>
This commit is contained in:
Bukkit/Spigot
2012-06-03 05:40:54 -05:00
parent 3b35e0472d
commit 03af91781c
39 changed files with 232 additions and 211 deletions
Download Patch File Download Diff File Expand all files Collapse all files

148
paper-api/src/main/java/org/bukkit/configuration/ConfigurationSection.java
View File

@ -13,11 +13,11 @@ import org.bukkit.inventory.ItemStack;
public interface ConfigurationSection {
/**
* Gets a set containing all keys in this section.
* <p>
* <p />
* If deep is set to true, then this will contain all the keys within any child
* {@link ConfigurationSection}s (and their children, etc). These will be in a
* valid path notation for you to use.
* <p>
* <p />
* If deep is set to false, then this will contain only the keys of any direct children,
* and not their own children.
*
@ -28,11 +28,11 @@ public interface ConfigurationSection {
/**
* Gets a Map containing all keys and their values for this section.
* <p>
* <p />
* If deep is set to true, then this will contain all the keys and values within
* any child {@link ConfigurationSection}s (and their children, etc). These
* keys will be in a valid path notation for you to use.
* <p>
* <p />
* If deep is set to false, then this will contain only the keys and values of any
* direct children, and not their own children.
*
@ -43,7 +43,7 @@ public interface ConfigurationSection {
/**
* Checks if this {@link ConfigurationSection} contains the given path.
* <p>
* <p />
* If the value for the requested path does not exist but a default value has
* been specified, this will return true.
*
@ -55,7 +55,7 @@ public interface ConfigurationSection {
/**
* Checks if this {@link ConfigurationSection} has a value set for the given path.
* <p>
* <p />
* If the value for the requested path does not exist but a default value has
* been specified, this will still return false.
*
@ -67,12 +67,12 @@ public interface ConfigurationSection {
/**
* Gets the path of this {@link ConfigurationSection} from its root {@link Configuration}
* <p>
* <p />
* For any {@link Configuration} themselves, this will return an empty string.
* <p>
* <p />
* If the section is no longer contained within its root for any reason, such as
* being replaced with a different value, this may return null.
* <p>
* <p />
* To retrieve the single name of this section, that is, the final part of the path
* returned by this method, you may use {@link #getName()}.
*
@ -82,7 +82,7 @@ public interface ConfigurationSection {
/**
* Gets the name of this individual {@link ConfigurationSection}, in the path.
* <p>
* <p />
* This will always be the final part of {@link #getCurrentPath()}, unless the
* section is orphaned.
*
@ -92,9 +92,9 @@ public interface ConfigurationSection {
/**
* Gets the root {@link Configuration} that contains this {@link ConfigurationSection}
* <p>
* <p />
* For any {@link Configuration} themselves, this will return its own object.
* <p>
* <p />
* If the section is no longer contained within its root for any reason, such as
* being replaced with a different value, this may return null.
*
@ -105,9 +105,9 @@ public interface ConfigurationSection {
/**
* Gets the parent {@link ConfigurationSection} that directly contains this
* {@link ConfigurationSection}.
* <p>
* <p />
* For any {@link Configuration} themselves, this will return null.
* <p>
* <p />
* If the section is no longer contained within its parent for any reason, such as
* being replaced with a different value, this may return null.
*
@ -117,7 +117,7 @@ public interface ConfigurationSection {
/**
* Gets the requested Object by path.
* <p>
* <p />
* If the Object does not exist but a default value has been specified, this
* will return the default value. If the Object does not exist and no default
* value was specified, this will return null.
@ -129,7 +129,7 @@ public interface ConfigurationSection {
/**
* Gets the requested Object by path, returning a default value if not found.
* <p>
* <p />
* If the Object does not exist then the specified default value will returned
* regardless of if a default has been identified in the root {@link Configuration}.
*
@ -141,10 +141,10 @@ public interface ConfigurationSection {
/**
* Sets the specified path to the given value.
* <p>
* <p />
* If value is null, the entry will be removed. Any existing entry will be
* replaced, regardless of what the new value is.
* <p>
* <p />
* Some implementations may have limitations on what you may store. See their
* individual javadocs for details. No implementations should allow you to store
* {@link Configuration}s or {@link ConfigurationSection}s, please use
@ -157,7 +157,7 @@ public interface ConfigurationSection {
/**
* Creates an empty {@link ConfigurationSection} at the specified path.
* <p>
* <p />
* Any value that was previously set at this path will be overwritten. If the
* previous value was itself a {@link ConfigurationSection}, it will be orphaned.
*
@ -168,7 +168,7 @@ public interface ConfigurationSection {
/**
* Creates a {@link ConfigurationSection} at the specified path, with specified values.
* <p>
* <p />
* Any value that was previously set at this path will be overwritten. If the
* previous value was itself a {@link ConfigurationSection}, it will be orphaned.
*
@ -181,7 +181,7 @@ public interface ConfigurationSection {
// Primitives
/**
* Gets the requested String by path.
* <p>
* <p />
* If the String does not exist but a default value has been specified, this
* will return the default value. If the String does not exist and no default
* value was specified, this will return null.
@ -193,7 +193,7 @@ public interface ConfigurationSection {
/**
* Gets the requested String by path, returning a default value if not found.
* <p>
* <p />
* If the String does not exist then the specified default value will returned
* regardless of if a default has been identified in the root {@link Configuration}.
*
@ -205,7 +205,7 @@ public interface ConfigurationSection {
/**
* Checks if the specified path is a String.
* <p>
* <p />
* If the path exists but is not a String, this will return false. If the path does not
* exist, this will return false. If the path does not exist but a default value
* has been specified, this will check if that default value is a String and return
@ -218,10 +218,10 @@ public interface ConfigurationSection {
/**
* Gets the requested int by path.
* <p>
* <p />
* If the int does not exist but a default value has been specified, this
* will return the default value. If the int does not exist and no default
* value was specified, this will return null.
* value was specified, this will return 0.
*
* @param path Path of the int to get.
* @return Requested int.
@ -230,7 +230,7 @@ public interface ConfigurationSection {
/**
* Gets the requested int by path, returning a default value if not found.
* <p>
* <p />
* If the int does not exist then the specified default value will returned
* regardless of if a default has been identified in the root {@link Configuration}.
*
@ -242,7 +242,7 @@ public interface ConfigurationSection {
/**
* Checks if the specified path is an int.
* <p>
* <p />
* If the path exists but is not a int, this will return false. If the path does not
* exist, this will return false. If the path does not exist but a default value
* has been specified, this will check if that default value is a int and return
@ -255,7 +255,7 @@ public interface ConfigurationSection {
/**
* Gets the requested boolean by path.
* <p>
* <p />
* If the boolean does not exist but a default value has been specified, this
* will return the default value. If the boolean does not exist and no default
* value was specified, this will return false.
@ -267,7 +267,7 @@ public interface ConfigurationSection {
/**
* Gets the requested boolean by path, returning a default value if not found.
* <p>
* <p />
* If the boolean does not exist then the specified default value will returned
* regardless of if a default has been identified in the root {@link Configuration}.
*
@ -279,7 +279,7 @@ public interface ConfigurationSection {
/**
* Checks if the specified path is a boolean.
* <p>
* <p />
* If the path exists but is not a boolean, this will return false. If the path does not
* exist, this will return false. If the path does not exist but a default value
* has been specified, this will check if that default value is a boolean and return
@ -292,7 +292,7 @@ public interface ConfigurationSection {
/**
* Gets the requested double by path.
* <p>
* <p />
* If the double does not exist but a default value has been specified, this
* will return the default value. If the double does not exist and no default
* value was specified, this will return null.
@ -304,7 +304,7 @@ public interface ConfigurationSection {
/**
* Gets the requested double by path, returning a default value if not found.
* <p>
* <p />
* If the double does not exist then the specified default value will returned
* regardless of if a default has been identified in the root {@link Configuration}.
*
@ -316,7 +316,7 @@ public interface ConfigurationSection {
/**
* Checks if the specified path is a double.
* <p>
* <p />
* If the path exists but is not a double, this will return false. If the path does not
* exist, this will return false. If the path does not exist but a default value
* has been specified, this will check if that default value is a double and return
@ -329,7 +329,7 @@ public interface ConfigurationSection {
/**
* Gets the requested long by path.
* <p>
* <p />
* If the long does not exist but a default value has been specified, this
* will return the default value. If the long does not exist and no default
* value was specified, this will return null.
@ -341,7 +341,7 @@ public interface ConfigurationSection {
/**
* Gets the requested long by path, returning a default value if not found.
* <p>
* <p />
* If the long does not exist then the specified default value will returned
* regardless of if a default has been identified in the root {@link Configuration}.
*
@ -353,7 +353,7 @@ public interface ConfigurationSection {
/**
* Checks if the specified path is a long.
* <p>
* <p />
* If the path exists but is not a long, this will return false. If the path does not
* exist, this will return false. If the path does not exist but a default value
* has been specified, this will check if that default value is a long and return
@ -367,7 +367,7 @@ public interface ConfigurationSection {
// Java
/**
* Gets the requested List by path.
* <p>
* <p />
* If the List does not exist but a default value has been specified, this
* will return the default value. If the List does not exist and no default
* value was specified, this will return null.
@ -379,7 +379,7 @@ public interface ConfigurationSection {
/**
* Gets the requested List by path, returning a default value if not found.
* <p>
* <p />
* If the List does not exist then the specified default value will returned
* regardless of if a default has been identified in the root {@link Configuration}.
*
@ -391,7 +391,7 @@ public interface ConfigurationSection {
/**
* Checks if the specified path is a List.
* <p>
* <p />
* If the path exists but is not a List, this will return false. If the path does not
* exist, this will return false. If the path does not exist but a default value
* has been specified, this will check if that default value is a List and return
@ -404,11 +404,11 @@ public interface ConfigurationSection {
/**
* Gets the requested List of String by path.
* <p>
* <p />
* If the List does not exist but a default value has been specified, this
* will return the default value. If the List does not exist and no default
* value was specified, this will return null.
* <p>
* <p />
* This method will attempt to cast any values into a String if possible, but may
* miss any values out if they are not compatible.
*
@ -419,11 +419,11 @@ public interface ConfigurationSection {
/**
* Gets the requested List of Integer by path.
* <p>
* <p />
* If the List does not exist but a default value has been specified, this
* will return the default value. If the List does not exist and no default
* value was specified, this will return null.
* <p>
* <p />
* This method will attempt to cast any values into a Integer if possible, but may
* miss any values out if they are not compatible.
*
@ -434,11 +434,11 @@ public interface ConfigurationSection {
/**
* Gets the requested List of Boolean by path.
* <p>
* <p />
* If the List does not exist but a default value has been specified, this
* will return the default value. If the List does not exist and no default
* value was specified, this will return null.
* <p>
* <p />
* This method will attempt to cast any values into a Boolean if possible, but may
* miss any values out if they are not compatible.
*
@ -449,11 +449,11 @@ public interface ConfigurationSection {
/**
* Gets the requested List of Double by path.
* <p>
* <p />
* If the List does not exist but a default value has been specified, this
* will return the default value. If the List does not exist and no default
* value was specified, this will return null.
* <p>
* <p />
* This method will attempt to cast any values into a Double if possible, but may
* miss any values out if they are not compatible.
*
@ -464,11 +464,11 @@ public interface ConfigurationSection {
/**
* Gets the requested List of Float by path.
* <p>
* <p />
* If the List does not exist but a default value has been specified, this
* will return the default value. If the List does not exist and no default
* value was specified, this will return null.
* <p>
* <p />
* This method will attempt to cast any values into a Float if possible, but may
* miss any values out if they are not compatible.
*
@ -479,11 +479,11 @@ public interface ConfigurationSection {
/**
* Gets the requested List of Long by path.
* <p>
* <p />
* If the List does not exist but a default value has been specified, this
* will return the default value. If the List does not exist and no default
* value was specified, this will return null.
* <p>
* <p />
* This method will attempt to cast any values into a Long if possible, but may
* miss any values out if they are not compatible.
*
@ -494,11 +494,11 @@ public interface ConfigurationSection {
/**
* Gets the requested List of Byte by path.
* <p>
* <p />
* If the List does not exist but a default value has been specified, this
* will return the default value. If the List does not exist and no default
* value was specified, this will return null.
* <p>
* <p />
* This method will attempt to cast any values into a Byte if possible, but may
* miss any values out if they are not compatible.
*
@ -509,11 +509,11 @@ public interface ConfigurationSection {
/**
* Gets the requested List of Character by path.
* <p>
* <p />
* If the List does not exist but a default value has been specified, this
* will return the default value. If the List does not exist and no default
* value was specified, this will return null.
* <p>
* <p />
* This method will attempt to cast any values into a Character if possible, but may
* miss any values out if they are not compatible.
*
@ -524,11 +524,11 @@ public interface ConfigurationSection {
/**
* Gets the requested List of Short by path.
* <p>
* <p />
* If the List does not exist but a default value has been specified, this
* will return the default value. If the List does not exist and no default
* value was specified, this will return null.
* <p>
* <p />
* This method will attempt to cast any values into a Short if possible, but may
* miss any values out if they are not compatible.
*
@ -539,11 +539,11 @@ public interface ConfigurationSection {
/**
* Gets the requested List of Maps by path.
* <p>
* <p />
* If the List does not exist but a default value has been specified, this
* will return the default value. If the List does not exist and no default
* value was specified, this will return null.
* <p>
* <p />
* This method will attempt to cast any values into a Map if possible, but may
* miss any values out if they are not compatible.
*
@ -555,7 +555,7 @@ public interface ConfigurationSection {
// Bukkit
/**
* Gets the requested Vector by path.
* <p>
* <p />
* If the Vector does not exist but a default value has been specified, this
* will return the default value. If the Vector does not exist and no default
* value was specified, this will return null.
@ -567,7 +567,7 @@ public interface ConfigurationSection {
/**
* Gets the requested {@link Vector} by path, returning a default value if not found.
* <p>
* <p />
* If the Vector does not exist then the specified default value will returned
* regardless of if a default has been identified in the root {@link Configuration}.
*
@ -579,7 +579,7 @@ public interface ConfigurationSection {
/**
* Checks if the specified path is a Vector.
* <p>
* <p />
* If the path exists but is not a Vector, this will return false. If the path does not
* exist, this will return false. If the path does not exist but a default value
* has been specified, this will check if that default value is a Vector and return
@ -592,7 +592,7 @@ public interface ConfigurationSection {
/**
* Gets the requested OfflinePlayer by path.
* <p>
* <p />
* If the OfflinePlayer does not exist but a default value has been specified, this
* will return the default value. If the OfflinePlayer does not exist and no default
* value was specified, this will return null.
@ -604,7 +604,7 @@ public interface ConfigurationSection {
/**
* Gets the requested {@link OfflinePlayer} by path, returning a default value if not found.
* <p>
* <p />
* If the OfflinePlayer does not exist then the specified default value will returned
* regardless of if a default has been identified in the root {@link Configuration}.
*
@ -616,7 +616,7 @@ public interface ConfigurationSection {
/**
* Checks if the specified path is an OfflinePlayer.
* <p>
* <p />
* If the path exists but is not a OfflinePlayer, this will return false. If the path does not
* exist, this will return false. If the path does not exist but a default value
* has been specified, this will check if that default value is a OfflinePlayer and return
@ -629,7 +629,7 @@ public interface ConfigurationSection {
/**
* Gets the requested ItemStack by path.
* <p>
* <p />
* If the ItemStack does not exist but a default value has been specified, this
* will return the default value. If the ItemStack does not exist and no default
* value was specified, this will return null.
@ -641,7 +641,7 @@ public interface ConfigurationSection {
/**
* Gets the requested {@link ItemStack} by path, returning a default value if not found.
* <p>
* <p />
* If the ItemStack does not exist then the specified default value will returned
* regardless of if a default has been identified in the root {@link Configuration}.
*
@ -653,7 +653,7 @@ public interface ConfigurationSection {
/**
* Checks if the specified path is an ItemStack.
* <p>
* <p />
* If the path exists but is not a ItemStack, this will return false. If the path does not
* exist, this will return false. If the path does not exist but a default value
* has been specified, this will check if that default value is a ItemStack and return
@ -666,7 +666,7 @@ public interface ConfigurationSection {
/**
* Gets the requested ConfigurationSection by path.
* <p>
* <p />
* If the ConfigurationSection does not exist but a default value has been specified, this
* will return the default value. If the ConfigurationSection does not exist and no default
* value was specified, this will return null.
@ -678,7 +678,7 @@ public interface ConfigurationSection {
/**
* Checks if the specified path is a ConfigurationSection.
* <p>
* <p />
* If the path exists but is not a ConfigurationSection, this will return false. If the path does not
* exist, this will return false. If the path does not exist but a default value
* has been specified, this will check if that default value is a ConfigurationSection and return
@ -691,7 +691,7 @@ public interface ConfigurationSection {
/**
* Gets the equivalent {@link ConfigurationSection} from the default {@link Configuration} defined in {@link #getRoot()}.
* <p>
* <p />
* If the root contains no defaults, or the defaults doesn't contain a value
* for this path, or the value at this path is not a {@link ConfigurationSection} then
* this will return null.
@ -702,13 +702,13 @@ public interface ConfigurationSection {
/**
* Sets the default value in the root at the given path as provided.
* <p>
* <p />
* If no source {@link Configuration} was provided as a default collection,
* then a new {@link MemoryConfiguration} will be created to hold the new default
* value.
* <p>
* <p />
* If value is null, the value will be removed from the default Configuration source.
* <p>
* <p />
* If the value as returned by {@link #getDefaultSection()} is null,
* then this will create a new section at the path, replacing anything that
* may have existed there previously.