EpicKnarvik97/PlotSquared
EpicKnarvik97/PlotSquared
1
0
Fork 0
mirror of https://github.com/IntellectualSites/PlotSquared.git synced 2024-11-26 07:06:44 +01:00
Code Issues Projects Releases Wiki Activity

Cleanup some docs.

Browse Source
This commit is contained in:
MattBDev 2016-06-24 10:56:38 -04:00
parent 2c82d1106a
commit 6e25aab51f
10 changed files with 171 additions and 145 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

114
Core/src/main/java/com/intellectualcrafters/configuration/ConfigurationSection.java
View File

@ -27,12 +27,12 @@ public interface ConfigurationSection {
/** /**
* Gets a Map containing all keys and their values for this section. * Gets a Map containing all keys and their values for this section.
* <p> *
* If deep is set to true, then this will contain all the keys and values * <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, * within any child {@link ConfigurationSection}s (and their children,
* etc). These keys will be in a valid path notation for you to use. * etc). These keys will be in a valid path notation for you to use.
* <p> *
* If deep is set to false, then this will contain only the keys and * <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. * values of any direct children, and not their own children.
* *
* @param deep Whether or not to get a deep list, as opposed to a shallow * @param deep Whether or not to get a deep list, as opposed to a shallow
@ -49,8 +49,8 @@ public interface ConfigurationSection {
* *
* @param path Path to check for existence. * @param path Path to check for existence.
* @return True if this section contains the requested path, either via * @return True if this section contains the requested path, either via
* default or being set. * default or being set.
* @throws IllegalArgumentException Thrown when path is <code>null</code>. * @throws IllegalArgumentException Thrown when path is {@code null}.
*/ */
boolean contains(String path); boolean contains(String path);
@ -64,7 +64,7 @@ public interface ConfigurationSection {
* @param path Path to check for existence. * @param path Path to check for existence.
* @return True if this section contains the requested path, regardless of * @return True if this section contains the requested path, regardless of
* having a default. * having a default.
* @throws IllegalArgumentException Thrown when path is <code>null</code>. * @throws IllegalArgumentException Thrown when path is {@code null}.
*/ */
boolean isSet(String path); boolean isSet(String path);
@ -77,7 +77,7 @@ public interface ConfigurationSection {
* *
* <p>If the section is no longer contained within its root for any reason, * <p>If the section is no longer contained within its root for any reason,
* such as being replaced with a different value, * such as being replaced with a different value,
* this may return <code>null</code>. * this may return {@code null}.
* *
* <p>To retrieve the single name of this section, that is, the final part * <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()}. * of the path returned by this method, you may use {@link #getName()}.
@ -106,7 +106,7 @@ public interface ConfigurationSection {
* *
* <p>If the section is no longer contained within its root for any reason, * <p>If the section is no longer contained within its root for any reason,
* such as being replaced with a different value, * such as being replaced with a different value,
* this may return <code>null</code>. * this may return {@code null}.
* *
* @return Root configuration containing this section. * @return Root configuration containing this section.
*/ */
@ -117,11 +117,11 @@ public interface ConfigurationSection {
* this {@link ConfigurationSection}. * this {@link ConfigurationSection}.
* *
* <p>For any {@link Configuration} themselves, this will return * <p>For any {@link Configuration} themselves, this will return
* <code>null</code>. * {@code null}.
* *
* <p>If the section is no longer contained within its parent for any reason, * <p>If the section is no longer contained within its parent for any
* such as being replaced with a different value, this may * reason, such as being replaced with a different value, this may
* return <code>null</code>. * return {@code null}.
* *
* @return Parent section containing this section. * @return Parent section containing this section.
*/ */
@ -132,7 +132,7 @@ public interface ConfigurationSection {
* *
* <p>If the Object does not exist but a default value has been specified, * <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 * this will return the default value. If the Object does not exist and no
* default value was specified, this will return <code>null</code>. * default value was specified, this will return {@code null}.
* *
* @param path Path of the Object to get. * @param path Path of the Object to get.
* @return Requested Object. * @return Requested Object.
@ -156,7 +156,7 @@ public interface ConfigurationSection {
/** /**
* Sets the specified path to the given value. * Sets the specified path to the given value.
* *
* <p>If value is <code>null</code>, the entry will be removed. Any * <p>If value is {@code null}, the entry will be removed. Any
* existing entry will be replaced, regardless of what the new value is. * existing entry will be replaced, regardless of what the new value is.
* *
* <p>Some implementations may have limitations on what you may store. See * <p>Some implementations may have limitations on what you may store. See
@ -202,7 +202,7 @@ public interface ConfigurationSection {
* *
* <p>If the String does not exist but a default value has been specified, * <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 * this will return the default value. If the String does not exist and no
* default value was specified, this will return <code>null</code>. * default value was specified, this will return {@code null}.
* *
* @param path Path of the String to get. * @param path Path of the String to get.
* @return Requested String. * @return Requested String.
@ -470,13 +470,13 @@ public interface ConfigurationSection {
/** /**
* Gets the requested List of Boolean by path. * Gets the requested List of Boolean by path.
* <p> *
* If the List does not exist but a default value has been specified, this * <p>If the List does not exist but a default value has been specified,
* will return the default value. If the List does not exist and no * this will return the default value. If the List does not exist and no
* default value was specified, this will return an empty List. * default value was specified, this will return an empty List.
* <p> *
* This method will attempt to cast any values into a Boolean if possible, * <p>This method will attempt to cast any values into a Boolean if
* but may miss any values out if they are not compatible. * possible, but may miss any values out if they are not compatible.
* *
* @param path Path of the List to get. * @param path Path of the List to get.
* @return Requested List of Boolean. * @return Requested List of Boolean.
@ -485,12 +485,12 @@ public interface ConfigurationSection {
/** /**
* Gets the requested List of Double by path. * Gets the requested List of Double by path.
* <p> *
* If the List does not exist but a default value has been specified, this * <p>If the List does not exist but a default value has been specified,
* will return the default value. If the List does not exist and no * this will return the default value. If the List does not exist and no
* default value was specified, this will return an empty List. * default value was specified, this will return an empty List.
* <p> *
* This method will attempt to cast any values into a Double if possible, * <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. * but may miss any values out if they are not compatible.
* *
* @param path Path of the List to get. * @param path Path of the List to get.
@ -500,12 +500,12 @@ public interface ConfigurationSection {
/** /**
* Gets the requested List of Float by path. * Gets the requested List of Float by path.
* <p> *
* If the List does not exist but a default value has been specified, this * <p>If the List does not exist but a default value has been specified,
* will return the default value. If the List does not exist and no * this will return the default value. If the List does not exist and no
* default value was specified, this will return an empty List. * default value was specified, this will return an empty List.
* <p> *
* This method will attempt to cast any values into a Float if possible, * <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. * but may miss any values out if they are not compatible.
* *
* @param path Path of the List to get. * @param path Path of the List to get.
@ -515,12 +515,12 @@ public interface ConfigurationSection {
/** /**
* Gets the requested List of Long by path. * Gets the requested List of Long by path.
* <p> *
* If the List does not exist but a default value has been specified, this * <p>If the List does not exist but a default value has been specified,
* will return the default value. If the List does not exist and no * this will return the default value. If the List does not exist and no
* default value was specified, this will return an empty List. * default value was specified, this will return an empty List.
* <p> *
* This method will attempt to cast any values into a Long if possible, * <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. * but may miss any values out if they are not compatible.
* *
* @param path Path of the List to get. * @param path Path of the List to get.
@ -530,12 +530,12 @@ public interface ConfigurationSection {
/** /**
* Gets the requested List of Byte by path. * Gets the requested List of Byte by path.
* <p> *
* If the List does not exist but a default value has been specified, this * <p>If the List does not exist but a default value has been specified,
* will return the default value. If the List does not exist and no * this will return the default value. If the List does not exist and no
* default value was specified, this will return an empty List. * default value was specified, this will return an empty List.
* <p> *
* This method will attempt to cast any values into a Byte if possible, * <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. * but may miss any values out if they are not compatible.
* *
* @param path Path of the List to get. * @param path Path of the List to get.
@ -545,12 +545,12 @@ public interface ConfigurationSection {
/** /**
* Gets the requested List of Character by path. * Gets the requested List of Character by path.
* <p> *
* If the List does not exist but a default value has been specified, this * <p>If the List does not exist but a default value has been specified,
* will return the default value. If the List does not exist and no * this will return the default value. If the List does not exist and no
* default value was specified, this will return an empty List. * default value was specified, this will return an empty List.
* <p> *
* This method will attempt to cast any values into a Character if * <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. * possible, but may miss any values out if they are not compatible.
* *
* @param path Path of the List to get. * @param path Path of the List to get.
@ -560,11 +560,13 @@ public interface ConfigurationSection {
/** /**
* Gets the requested List of Short by path. * Gets the requested List of Short by path.
* <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 * <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 an empty List. * default value was specified, this will return an empty List.
* <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. * <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.
* *
* @param path Path of the List to get. * @param path Path of the List to get.
* @return Requested List of Short. * @return Requested List of Short.
@ -591,7 +593,7 @@ public interface ConfigurationSection {
* <p>If the ConfigurationSection does not exist but a default value has * <p>If the ConfigurationSection does not exist but a default value has
* been specified, this will return the default value. If the * been specified, this will return the default value. If the
* ConfigurationSection does not exist and no default value was specified, * ConfigurationSection does not exist and no default value was specified,
* this will return <code>null</code>. * this will return {@code null}.
* *
* @param path Path of the ConfigurationSection to get. * @param path Path of the ConfigurationSection to get.
* @return Requested ConfigurationSection. * @return Requested ConfigurationSection.
@ -618,7 +620,7 @@ public interface ConfigurationSection {
* *
* <p>If the root contains no defaults, or the defaults doesn't contain a * <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 * value for this path, or the value at this path is not a {@link
* ConfigurationSection} then this will return <code>null</code>. * ConfigurationSection} then this will return {@code null}.
* *
* @return Equivalent section in root configuration * @return Equivalent section in root configuration
*/ */
@ -631,16 +633,16 @@ public interface ConfigurationSection {
* collection, then a new {@link MemoryConfiguration} will be created to * collection, then a new {@link MemoryConfiguration} will be created to
* hold the new default value. * hold the new default value.
* *
* <p>If value is <code>null</code>, the value will be removed from the * <p>If value is {@code null}, the value will be removed from the
* default Configuration source. * default Configuration source.
* *
* <p>If the value as returned by {@link #getDefaultSection()} is * <p>If the value as returned by {@link #getDefaultSection()} is
* <code>null</code>, then this will create a new section at the path, * {@code null}, then this will create a new section at the path,
* replacing anything that may have existed there previously. * replacing anything that may have existed there previously.
* *
* @param path Path of the value to set * @param path Path of the value to set
* @param value Value to set the default to * @param value Value to set the default to
* @throws IllegalArgumentException Thrown if path is <code>null</code> * @throws IllegalArgumentException Thrown if path is {@code null}
*/ */
void addDefault(String path, Object value); void addDefault(String path, Object value);
} }

34
Core/src/main/java/com/intellectualcrafters/configuration/MemorySection.java
View File

@ -74,7 +74,8 @@ public class MemorySection implements ConfigurationSection {
if (obj instanceof String) { if (obj instanceof String) {
try { try {
return Double.parseDouble((String) obj); return Double.parseDouble((String) obj);
} catch (NumberFormatException ignored) {} } catch (NumberFormatException ignored) {
}
} else if (obj instanceof List) { } else if (obj instanceof List) {
List<?> val = (List<?>) obj; List<?> val = (List<?>) obj;
if (!val.isEmpty()) { if (!val.isEmpty()) {
@ -91,7 +92,8 @@ public class MemorySection implements ConfigurationSection {
if (obj instanceof String) { if (obj instanceof String) {
try { try {
return Integer.parseInt((String) obj); return Integer.parseInt((String) obj);
} catch (NumberFormatException ignored) {} } catch (NumberFormatException ignored) {
}
} else if (obj instanceof List) { } else if (obj instanceof List) {
List<?> val = (List<?>) obj; List<?> val = (List<?>) obj;
if (!val.isEmpty()) { if (!val.isEmpty()) {
@ -108,7 +110,8 @@ public class MemorySection implements ConfigurationSection {
if (obj instanceof String) { if (obj instanceof String) {
try { try {
return Long.parseLong((String) obj); return Long.parseLong((String) obj);
} catch (NumberFormatException ignored) {} } catch (NumberFormatException ignored) {
}
} else if (obj instanceof List) { } else if (obj instanceof List) {
List<?> val = (List<?>) obj; List<?> val = (List<?>) obj;
if (!val.isEmpty()) { if (!val.isEmpty()) {
@ -565,7 +568,8 @@ public class MemorySection implements ConfigurationSection {
} else if (object instanceof String) { } else if (object instanceof String) {
try { try {
result.add(Integer.valueOf((String) object)); result.add(Integer.valueOf((String) object));
} catch (NumberFormatException ignored) {} } catch (NumberFormatException ignored) {
}
} else if (object instanceof Character) { } else if (object instanceof Character) {
result.add((int) (Character) object); result.add((int) (Character) object);
} else if (object instanceof Number) { } else if (object instanceof Number) {
@ -609,7 +613,8 @@ public class MemorySection implements ConfigurationSection {
} else if (object instanceof String) { } else if (object instanceof String) {
try { try {
result.add(Double.valueOf((String) object)); result.add(Double.valueOf((String) object));
} catch (NumberFormatException ignored) {} } catch (NumberFormatException ignored) {
}
} else if (object instanceof Character) { } else if (object instanceof Character) {
result.add((double) (Character) object); result.add((double) (Character) object);
} else if (object instanceof Number) { } else if (object instanceof Number) {
@ -632,7 +637,8 @@ public class MemorySection implements ConfigurationSection {
} else if (object instanceof String) { } else if (object instanceof String) {
try { try {
result.add(Float.valueOf((String) object)); result.add(Float.valueOf((String) object));
} catch (NumberFormatException ignored) {} } catch (NumberFormatException ignored) {
}
} else if (object instanceof Character) { } else if (object instanceof Character) {
result.add((float) (Character) object); result.add((float) (Character) object);
} else if (object instanceof Number) { } else if (object instanceof Number) {
@ -655,7 +661,8 @@ public class MemorySection implements ConfigurationSection {
} else if (object instanceof String) { } else if (object instanceof String) {
try { try {
result.add(Long.valueOf((String) object)); result.add(Long.valueOf((String) object));
} catch (NumberFormatException ignored) {} } catch (NumberFormatException ignored) {
}
} else if (object instanceof Character) { } else if (object instanceof Character) {
result.add((long) (Character) object); result.add((long) (Character) object);
} else if (object instanceof Number) { } else if (object instanceof Number) {
@ -678,7 +685,8 @@ public class MemorySection implements ConfigurationSection {
} else if (object instanceof String) { } else if (object instanceof String) {
try { try {
result.add(Byte.valueOf((String) object)); result.add(Byte.valueOf((String) object));
} catch (NumberFormatException ignored) {} } catch (NumberFormatException ignored) {
}
} else if (object instanceof Character) { } else if (object instanceof Character) {
result.add((byte) ((Character) object).charValue()); result.add((byte) ((Character) object).charValue());
} else if (object instanceof Number) { } else if (object instanceof Number) {
@ -724,7 +732,8 @@ public class MemorySection implements ConfigurationSection {
} else if (object instanceof String) { } else if (object instanceof String) {
try { try {
result.add(Short.valueOf((String) object)); result.add(Short.valueOf((String) object));
} catch (NumberFormatException ignored) {} } catch (NumberFormatException ignored) {
}
} else if (object instanceof Character) { } else if (object instanceof Character) {
result.add((short) ((Character) object).charValue()); result.add((short) ((Character) object).charValue());
} else if (object instanceof Number) { } else if (object instanceof Number) {
@ -833,7 +842,10 @@ public class MemorySection implements ConfigurationSection {
@Override @Override
public String toString() { public String toString() {
Configuration root = getRoot(); Configuration root = getRoot();
return getClass().getSimpleName() + "[path='" + getCurrentPath() + "', root='" + (root == null ? null : root.getClass().getSimpleName()) + if (root == null) {
"']"; return getClass().getSimpleName() + "[path='" + getCurrentPath() + "', root='" + null + "']";
} else {
return getClass().getSimpleName() + "[path='" + getCurrentPath() + "', root='" + root.getClass().getSimpleName() + "']";
}
} }
} }

6
Core/src/main/java/com/intellectualcrafters/configuration/file/FileConfigurationOptions.java
View File

@ -42,8 +42,8 @@ public class FileConfigurationOptions extends MemoryConfigurationOptions {
* automatically be applied, but you may include one if you wish for extra * automatically be applied, but you may include one if you wish for extra
* spacing. * spacing.
* *
* <p><code>null</code> is a valid value which will indicate that no header] * <p>{@code null} is a valid value which will indicate that no header]
* is to be applied. The default value is <code>null</code>. * is to be applied. The default value is {@code null}.
* *
* @return Header * @return Header
*/ */
@ -60,7 +60,7 @@ public class FileConfigurationOptions extends MemoryConfigurationOptions {
* automatically be applied, but you may include one if you wish for extra * automatically be applied, but you may include one if you wish for extra
* spacing. * spacing.
* *
* <p><code>null</code> is a valid value which will indicate that no header * <p>{@code null} is a valid value which will indicate that no header
* is to be applied. * is to be applied.
* *
* @param value New header * @param value New header

22
Core/src/main/java/com/intellectualcrafters/configuration/file/YamlConfigurationOptions.java
View File

@ -2,12 +2,12 @@ package com.intellectualcrafters.configuration.file;
/** /**
* Various settings for controlling the input and output of a {@link * Various settings for controlling the input and output of a {@link
* YamlConfiguration} * YamlConfiguration}.
*/ */
public class YamlConfigurationOptions extends FileConfigurationOptions { public class YamlConfigurationOptions extends FileConfigurationOptions {
private int indent = 2; private int indent = 2;
YamlConfigurationOptions(final YamlConfiguration configuration) { YamlConfigurationOptions(YamlConfiguration configuration) {
super(configuration); super(configuration);
} }
@ -17,33 +17,33 @@ public class YamlConfigurationOptions extends FileConfigurationOptions {
} }
@Override @Override
public YamlConfigurationOptions copyDefaults(final boolean value) { public YamlConfigurationOptions copyDefaults(boolean value) {
super.copyDefaults(value); super.copyDefaults(value);
return this; return this;
} }
@Override @Override
public YamlConfigurationOptions pathSeparator(final char value) { public YamlConfigurationOptions pathSeparator(char value) {
super.pathSeparator(value); super.pathSeparator(value);
return this; return this;
} }
@Override @Override
public YamlConfigurationOptions header(final String value) { public YamlConfigurationOptions header(String value) {
super.header(value); super.header(value);
return this; return this;
} }
@Override @Override
public YamlConfigurationOptions copyHeader(final boolean value) { public YamlConfigurationOptions copyHeader(boolean value) {
super.copyHeader(value); super.copyHeader(value);
return this; return this;
} }
/** /**
* Gets how much spaces should be used to indent each line. * Gets how much spaces should be used to indent each line.
* <p> *
* The minimum value this may be is 2, and the maximum is 9. * <p>The minimum value this may be is 2, and the maximum is 9.
* *
* @return How much to indent by * @return How much to indent by
*/ */
@ -53,13 +53,13 @@ public class YamlConfigurationOptions extends FileConfigurationOptions {
/** /**
* Sets how much spaces should be used to indent each line. * Sets how much spaces should be used to indent each line.
* <p> *
* The minimum value this may be is 2, and the maximum is 9. * <p>The minimum value this may be is 2, and the maximum is 9.
* *
* @param value New indent * @param value New indent
* @return This object, for chaining * @return This object, for chaining
*/ */
public YamlConfigurationOptions indent(final int value) { public YamlConfigurationOptions indent(int value) {
if (value < 2) { if (value < 2) {
throw new IllegalArgumentException("Indent must be at least 2 characters"); throw new IllegalArgumentException("Indent must be at least 2 characters");
} }

2
Core/src/main/java/com/intellectualcrafters/configuration/file/YamlRepresenter.java
View File

@ -11,7 +11,7 @@ import java.util.Map;
class YamlRepresenter extends Representer { class YamlRepresenter extends Representer {
public YamlRepresenter() { YamlRepresenter() {
this.multiRepresenters.put(ConfigurationSection.class, new RepresentConfigurationSection()); this.multiRepresenters.put(ConfigurationSection.class, new RepresentConfigurationSection());
this.multiRepresenters.put(ConfigurationSerializable.class, new RepresentConfigurationSerializable()); this.multiRepresenters.put(ConfigurationSerializable.class, new RepresentConfigurationSerializable());
} }

9
Core/src/main/java/com/intellectualcrafters/configuration/serialization/ConfigurationSerializable.java
View File

@ -4,9 +4,8 @@ import java.util.Map;
/** /**
* Represents an object that may be serialized. * Represents an object that may be serialized.
* <p> * <p>These objects MUST implement one of the following, in addition to
* These objects MUST implement one of the following, in addition to the * the methods as defined by this interface:
* methods as defined by this interface:
* <ul> * <ul>
* <li>A static method "deserialize" that accepts a single {@link Map}&lt; * <li>A static method "deserialize" that accepts a single {@link Map}&lt;
* {@link String}, {@link Object}> and returns the class.</li> * {@link String}, {@link Object}> and returns the class.</li>
@ -25,8 +24,8 @@ public interface ConfigurationSerializable {
/** /**
* Creates a Map representation of this class. * Creates a Map representation of this class.
* <p> *
* This class must provide a method to restore this class, as defined in * <p>This class must provide a method to restore this class, as defined in
* the {@link ConfigurationSerializable} interface javadoc. * the {@link ConfigurationSerializable} interface javadoc.
* *
* @return Map containing the current state of this class * @return Map containing the current state of this class

36
Core/src/main/java/com/intellectualcrafters/jnbt/NBTOutputStream.java
View File

@ -7,10 +7,11 @@ import java.io.OutputStream;
import java.util.List; import java.util.List;
/** /**
* <p> This class writes <strong>NBT</strong>, or <strong>Named Binary Tag</strong> <code>Tag</code> objects to an * This class writes <strong>NBT</strong>, or <strong>Named Binary Tag</strong>
* underlying <code>OutputStream</code>. </p> <p> The NBT format was created by Markus Persson, and the * {@code Tag} objects to an underlying {@code OutputStream}.
* specification may be found at *
* @linktourl http://www.minecraft.net/docs/NBT.txt * <p> The NBT format was created by Markus Persson, and the specification may
* be found at @linktourl http://www.minecraft.net/docs/NBT.txt
* </p> * </p>
* *
* @author Graham Edgecombe * @author Graham Edgecombe
@ -23,7 +24,8 @@ public final class NBTOutputStream implements Closeable {
private final DataOutputStream os; private final DataOutputStream os;
/** /**
* Creates a new <code>NBTOutputStream</code>, which will write data to the specified underlying output stream. * Creates a new {@code NBTOutputStream}, which will write data to the
* specified underlying output stream.
* *
* @param os The output stream. * @param os The output stream.
* *
@ -105,7 +107,7 @@ public final class NBTOutputStream implements Closeable {
} }
/** /**
* Writes a <code>TAG_Byte</code> tag. * Writes a {@code TAG_Byte} tag.
* *
* @param tag The tag. * @param tag The tag.
* *
@ -116,7 +118,7 @@ public final class NBTOutputStream implements Closeable {
} }
/** /**
* Writes a <code>TAG_Byte_Array</code> tag. * Writes a {@code TAG_Byte_Array} tag.
* *
* @param tag The tag. * @param tag The tag.
* *
@ -129,7 +131,7 @@ public final class NBTOutputStream implements Closeable {
} }
/** /**
* Writes a <code>TAG_Compound</code> tag. * Writes a {@code TAG_Compound} tag.
* *
* @param tag The tag. * @param tag The tag.
* *
@ -143,7 +145,7 @@ public final class NBTOutputStream implements Closeable {
} }
/** /**
* Writes a <code>TAG_List</code> tag. * Writes a {@code TAG_List} tag.
* *
* @param tag The tag. * @param tag The tag.
* *
@ -161,7 +163,7 @@ public final class NBTOutputStream implements Closeable {
} }
/** /**
* Writes a <code>TAG_String</code> tag. * Writes a {@code TAG_String} tag.
* *
* @param tag The tag. * @param tag The tag.
* *
@ -174,7 +176,7 @@ public final class NBTOutputStream implements Closeable {
} }
/** /**
* Writes a <code>TAG_Double</code> tag. * Writes a {@code TAG_Double} tag.
* *
* @param tag The tag. * @param tag The tag.
* *
@ -185,7 +187,7 @@ public final class NBTOutputStream implements Closeable {
} }
/** /**
* Writes a <code>TAG_Float</code> tag. * Writes a {@code TAG_Float} tag.
* *
* @param tag The tag. * @param tag The tag.
* *
@ -196,7 +198,7 @@ public final class NBTOutputStream implements Closeable {
} }
/** /**
* Writes a <code>TAG_Long</code> tag. * Writes a {@code TAG_Long} tag.
* *
* @param tag The tag. * @param tag The tag.
* *
@ -207,7 +209,7 @@ public final class NBTOutputStream implements Closeable {
} }
/** /**
* Writes a <code>TAG_Int</code> tag. * Writes a {@code TAG_Int} tag.
* *
* @param tag The tag. * @param tag The tag.
* *
@ -218,7 +220,7 @@ public final class NBTOutputStream implements Closeable {
} }
/** /**
* Writes a <code>TAG_Short</code> tag. * Writes a {@code TAG_Short} tag.
* *
* @param tag The tag. * @param tag The tag.
* *
@ -229,7 +231,7 @@ public final class NBTOutputStream implements Closeable {
} }
/** /**
* Writes a <code>TAG_Empty</code> tag. * Writes a {@code TAG_Empty} tag.
* *
* @param tag The tag. * @param tag The tag.
*/ */
@ -251,7 +253,7 @@ public final class NBTOutputStream implements Closeable {
} }
/** /**
* Flush output * Flush output.
* @throws IOException * @throws IOException
*/ */
public void flush() throws IOException { public void flush() throws IOException {

4
Core/src/main/java/com/intellectualcrafters/json/Cookie.java
View File

@ -107,9 +107,9 @@ public class Cookie {
} }
/** /**
* Convert <code>%</code><i>hh</i> sequences to single characters, and convert plus to space. * Convert {@code %}<i>hh</i> sequences to single characters, and convert plus to space.
* *
* @param string A string that may contain <code>+</code> &nbsp;<small>(plus)</small> and <code>%</code><i>hh</i> * @param string A string that may contain {@code +} &nbsp;<small>(plus)</small> and <code>%</code><i>hh</i>
* sequences. * sequences.
* *
* @return The unescaped string. * @return The unescaped string.

85
Core/src/main/java/com/intellectualcrafters/json/JSONArray.java
View File

@ -10,28 +10,28 @@ import java.util.Map;
/** /**
* A JSONArray is an ordered sequence of values. Its external text form is a string wrapped in square brackets with * A JSONArray is an ordered sequence of values. Its external text form is a string wrapped in square brackets with
* commas separating the values. The internal form is an object having <code>get</code> and <code>opt</code> methods for * commas separating the values. The internal form is an object having {@code get} and {@code opt} methods for
* accessing the values by index, and <code>put</code> methods for adding or replacing values. The values can be any of * accessing the values by index, and {@code put} methods for adding or replacing values. The values can be any of
* these types: <code>Boolean</code>, <code>JSONArray</code>, <code>JSONObject</code>, <code>Number</code>, * these types: {@code Boolean}, {@code JSONArray}, {@code JSONObject}, {@code Number},
* <code>String</code>, or the <code>JSONObject.NULL object</code>. * {@code String}, or the {@code JSONObject.NULL object}.
* *
* The constructor can convert a JSON text into a Java object. The <code>toString</code> method converts to JSON text. * <p>The constructor can convert a JSON text into a Java object. The {@code toString} method converts to JSON text.
* *
* A <code>get</code> method returns a value if one can be found, and throws an exception if one cannot be found. An * <p>A {@code get} method returns a value if one can be found, and throws an exception if one cannot be found. An
* <code>opt</code> method returns a default value instead of throwing an exception, and so is useful for obtaining * {@code opt} method returns a default value instead of throwing an exception, and so is useful for obtaining
* optional values. * optional values.
* *
* The generic <code>get()</code> and <code>opt()</code> methods return an object which you can cast or query for type. * <p>The generic {@code get()} and {@code opt()} methods return an object which you can cast or query for type.
* There are also typed <code>get</code> and <code>opt</code> methods that do type checking and type coercion for you. * There are also typed {@code get} and {@code opt} methods that do type checking and type coercion for you.
* *
* The texts produced by the <code>toString</code> methods strictly conform to JSON syntax rules. The constructors are * <p>The texts produced by the {@code toString} methods strictly conform to JSON syntax rules. The constructors are
* more forgiving in the texts they will accept: <ul> <li>An extra <code>,</code>&nbsp;<small>(comma)</small> may appear * more forgiving in the texts they will accept: <ul> <li>An extra {@code ,}&nbsp;<small>(comma)</small> may appear
* just before the closing bracket.</li> <li>The <code>null</code> value will be inserted when there is <code>,</code> * just before the closing bracket.</li> <li>The {@code null} value will be inserted when there is {@code ,}
* &nbsp;<small>(comma)</small> elision.</li> <li>Strings may be quoted with <code>'</code>&nbsp;<small>(single * &nbsp;<small>(comma)</small> elision.</li> <li>Strings may be quoted with {@code '}&nbsp;<small>(single
* quote)</small>.</li> <li>Strings do not need to be quoted at all if they do not begin with a quote or single quote, * quote)</small>.</li> <li>Strings do not need to be quoted at all if they do not begin with a quote or single quote,
* and if they do not contain leading or trailing spaces, and if they do not contain any of these characters: <code>{ } * and if they do not contain leading or trailing spaces, and if they do not contain any of these characters: {@code { }
* [ ] / \ : , #</code> and if they do not look like numbers and if they are not the reserved words <code>true</code>, * [ ] / \ : , #} and if they do not look like numbers and if they are not the reserved words {@code true},
* <code>false</code>, or <code>null</code>.</li> </ul> * {@code false}, or {@code null}.</li> </ul>
* *
* @author JSON.org * @author JSON.org
* @version 2014-05-03 * @version 2014-05-03
@ -90,8 +90,8 @@ public class JSONArray {
/** /**
* Construct a JSONArray from a source JSON text. * Construct a JSONArray from a source JSON text.
* *
* @param source A string that begins with <code>[</code>&nbsp;<small>(left bracket)</small> and ends with * @param source A string that begins with {@code [}&nbsp;<small>(left bracket)</small> and ends with
* <code>]</code> &nbsp;<small>(right bracket)</small>. * {@code ]} &nbsp;<small>(right bracket)</small>.
* *
* @throws JSONException If there is a syntax error. * @throws JSONException If there is a syntax error.
*/ */
@ -283,7 +283,7 @@ public class JSONArray {
} }
/** /**
* Make a string from the contents of this JSONArray. The <code>separator</code> string is inserted between each * Make a string from the contents of this JSONArray. The {@code separator} string is inserted between each
* element. Warning: This method assumes that the data structure is acyclical. * element. Warning: This method assumes that the data structure is acyclical.
* *
* @param separator A string that will be inserted between the elements. * @param separator A string that will be inserted between the elements.
@ -449,10 +449,11 @@ public class JSONArray {
} }
/** /**
* Get the optional long value associated with an index. The defaultValue is returned if there is no value for the * Get the optional long value associated with an index. The defaultValue
* index, or if the value is not a number and cannot be converted to a number. * is returned if there is no value for the index, or if the value is not a
* number and cannot be converted to a number.
* *
* @param index The index must be between 0 and length() - 1. * @param index The index must be between 0 and length() - 1.
* @param defaultValue The default value. * @param defaultValue The default value.
* *
* @return The value. * @return The value.
@ -466,8 +467,9 @@ public class JSONArray {
} }
/** /**
* Get the optional string value associated with an index. It returns an empty string if there is no value at that * Get the optional string value associated with an index. It returns an
* index. If the value is not a string and is not null, then it is converted to a string. * empty string if there is no value at that index. If the value is not a
* string and is not null, then it is converted to a string.
* *
* @param index The index must be between 0 and length() - 1. * @param index The index must be between 0 and length() - 1.
* *
@ -478,7 +480,8 @@ public class JSONArray {
} }
/** /**
* Get the optional string associated with an index. The defaultValue is returned if the key is not found. * Get the optional string associated with an index. The defaultValue is
* returned if the key is not found.
* *
* @param index The index must be between 0 and length() - 1. * @param index The index must be between 0 and length() - 1.
* @param defaultValue The default value. * @param defaultValue The default value.
@ -503,7 +506,8 @@ public class JSONArray {
} }
/** /**
* Put a value in the JSONArray, where the value will be a JSONArray which is produced from a Collection. * Put a value in the JSONArray, where the value will be a JSONArray which
* is produced from a Collection.
* *
* @param value A Collection value. * @param value A Collection value.
* *
@ -555,7 +559,8 @@ public class JSONArray {
} }
/** /**
* Put a value in the JSONArray, where the value will be a JSONObject which is produced from a Map. * Put a value in the JSONArray, where the value will be a JSONObject which
* is produced from a Map.
* *
* @param value A Map value. * @param value A Map value.
* *
@ -569,8 +574,8 @@ public class JSONArray {
/** /**
* Append an object value. This increases the array's length by one. * Append an object value. This increases the array's length by one.
* *
* @param value An object value. The value should be a Boolean, Double, Integer, JSONArray, JSONObject, Long, or * @param value An object value. The value should be a Boolean, Double,
* String, or the JSONObject.NULL object. * Integer, JSONArray, JSONObject, Long, or String, or the JSONObject.NULL object.
* *
* @return this. * @return this.
*/ */
@ -596,14 +601,16 @@ public class JSONArray {
} }
/** /**
* Put a value in the JSONArray, where the value will be a JSONArray which is produced from a Collection. * Put a value in the JSONArray, where the value will be a JSONArray which
* is produced from a Collection.
* *
* @param index The subscript. * @param index The subscript.
* @param value A Collection value. * @param value A Collection value.
* *
* @return this. * @return this.
* *
* @throws JSONException If the index is negative or if the value is not finite. * @throws JSONException If the index is negative or if the value is not
* finite.
*/ */
public JSONArray put(int index, Collection<Object> value) throws JSONException { public JSONArray put(int index, Collection<Object> value) throws JSONException {
this.put(index, new JSONArray(value)); this.put(index, new JSONArray(value));
@ -611,15 +618,17 @@ public class JSONArray {
} }
/** /**
* Put or replace a double value. If the index is greater than the length of the JSONArray, then null elements will * Put or replace a double value. If the index is greater than the length
* be added as necessary to pad it out. * of the JSONArray, then null elements will be added as necessary to pad
* it out.
* *
* @param index The subscript. * @param index The subscript.
* @param value A double value. * @param value A double value.
* *
* @return this. * @return this.
* *
* @throws JSONException If the index is negative or if the value is not finite. * @throws JSONException If the index is negative or if the value is not
* finite.
*/ */
public JSONArray put(int index, double value) throws JSONException { public JSONArray put(int index, double value) throws JSONException {
this.put(index, new Double(value)); this.put(index, new Double(value));
@ -659,14 +668,16 @@ public class JSONArray {
} }
/** /**
* Put a value in the JSONArray, where the value will be a JSONObject that is produced from a Map. * Put a value in the JSONArray, where the value will be a JSONObject that
* is produced from a Map.
* *
* @param index The subscript. * @param index The subscript.
* @param value The Map value. * @param value The Map value.
* *
* @return this. * @return this.
* *
* @throws JSONException If the index is negative or if the the value is an invalid number. * @throws JSONException If the index is negative or if the the value is an
* invalid number.
*/ */
public JSONArray put(int index, Map<String, Object> value) throws JSONException { public JSONArray put(int index, Map<String, Object> value) throws JSONException {
this.put(index, new JSONObject(value)); this.put(index, new JSONObject(value));
@ -790,7 +801,7 @@ public class JSONArray {
* @param indentFactor The number of spaces to add to each level of indentation. * @param indentFactor The number of spaces to add to each level of indentation.
* *
* @return a printable, displayable, transmittable representation of the object, beginning with * @return a printable, displayable, transmittable representation of the object, beginning with
* <code>[</code>&nbsp;<small>(left bracket)</small> and ending with <code>]</code> &nbsp;<small>(right * {@code [}&nbsp;<small>(left bracket)</small> and ending with {@code ]} &nbsp;<small>(right
* bracket)</small>. * bracket)</small>.
* *
* @throws JSONException * @throws JSONException

4
Core/src/main/java/com/intellectualcrafters/plot/object/Plot.java
View File

@ -25,6 +25,7 @@ import com.intellectualcrafters.plot.util.block.GlobalBlockQueue;
import com.intellectualcrafters.plot.util.block.LocalBlockQueue; import com.intellectualcrafters.plot.util.block.LocalBlockQueue;
import com.intellectualcrafters.plot.util.expiry.PlotAnalysis; import com.intellectualcrafters.plot.util.expiry.PlotAnalysis;
import com.plotsquared.listener.PlotListener; import com.plotsquared.listener.PlotListener;
import java.awt.Rectangle; import java.awt.Rectangle;
import java.awt.geom.Area; import java.awt.geom.Area;
import java.awt.geom.PathIterator; import java.awt.geom.PathIterator;
@ -738,8 +739,7 @@ public class Plot {
} }
/** /**
* Clear a plot * Clear a plot.
* @see this#clear(Runnable)
* @see this#clear(boolean, boolean, Runnable) * @see this#clear(boolean, boolean, Runnable)
* @see #deletePlot(Runnable) to clear and delete a plot * @see #deletePlot(Runnable) to clear and delete a plot
* @param whenDone A runnable to execute when clearing finishes, or null * @param whenDone A runnable to execute when clearing finishes, or null