Clean up the javadoc to pass java 8's doclint

By: Thinkofdeath <thinkofdeath@spigotmc.org>
This commit is contained in:
Bukkit/Spigot 2014-11-30 21:09:01 +00:00
parent 8344aacc6e
commit b2d54f59bb
156 changed files with 1155 additions and 501 deletions

View File

@ -8,6 +8,7 @@ import java.util.Date;
* <p> * <p>
* Ban entries include the following properties: * Ban entries include the following properties:
* <table border=1> * <table border=1>
* <caption>Property information</caption>
* <tr> * <tr>
* <th>Property</th> * <th>Property</th>
* <th>Description</th> * <th>Description</th>

File diff suppressed because it is too large Load Diff

View File

@ -141,6 +141,8 @@ public enum ChatColor {
/** /**
* Checks if this code is a format code as opposed to a color code. * Checks if this code is a format code as opposed to a color code.
*
* @return whether this ChatColor is a format code
*/ */
public boolean isFormat() { public boolean isFormat() {
return isFormat; return isFormat;
@ -148,6 +150,8 @@ public enum ChatColor {
/** /**
* Checks if this code is a color code as opposed to a format code. * Checks if this code is a color code as opposed to a format code.
*
* @return whether this ChatColor is a color code
*/ */
public boolean isColor() { public boolean isColor() {
return !isFormat && this != RESET; return !isFormat && this != RESET;
@ -198,7 +202,7 @@ public enum ChatColor {
* character. The alternate color code character will only be replaced if * character. The alternate color code character will only be replaced if
* it is immediately followed by 0-9, A-F, a-f, K-O, k-o, R or r. * it is immediately followed by 0-9, A-F, a-f, K-O, k-o, R or r.
* *
* @param altColorChar The alternate color code character to replace. Ex: & * @param altColorChar The alternate color code character to replace. Ex: {@literal &}
* @param textToTranslate Text containing the alternate color code character. * @param textToTranslate Text containing the alternate color code character.
* @return Text containing the ChatColor.COLOR_CODE color code character. * @return Text containing the ChatColor.COLOR_CODE color code character.
*/ */

View File

@ -113,7 +113,7 @@ public final class Color implements ConfigurationSerializable {
* @param green integer from 0-255 * @param green integer from 0-255
* @param blue integer from 0-255 * @param blue integer from 0-255
* @return a new Color object for the red, green, blue * @return a new Color object for the red, green, blue
* @throws IllegalArgumentException if any value is strictly >255 or <0 * @throws IllegalArgumentException if any value is strictly {@literal >255 or <0}
*/ */
public static Color fromRGB(int red, int green, int blue) throws IllegalArgumentException { public static Color fromRGB(int red, int green, int blue) throws IllegalArgumentException {
return new Color(red, green, blue); return new Color(red, green, blue);
@ -126,7 +126,7 @@ public final class Color implements ConfigurationSerializable {
* @param green integer from 0-255 * @param green integer from 0-255
* @param red integer from 0-255 * @param red integer from 0-255
* @return a new Color object for the red, green, blue * @return a new Color object for the red, green, blue
* @throws IllegalArgumentException if any value is strictly >255 or <0 * @throws IllegalArgumentException if any value is strictly {@literal >255 or <0}
*/ */
public static Color fromBGR(int blue, int green, int red) throws IllegalArgumentException { public static Color fromBGR(int blue, int green, int red) throws IllegalArgumentException {
return new Color(red, green, blue); return new Color(red, green, blue);

View File

@ -17,7 +17,7 @@ public enum EntityEffect {
/** /**
* When a mob dies. * When a mob dies.
* <p> * <p>
* <b>This will cause client-glitches! * <b>This will cause client-glitches!</b>
*/ */
DEATH(3), DEATH(3),

View File

@ -351,6 +351,8 @@ public final class FireworkEffect implements ConfigurationSerializable {
/** /**
* @see ConfigurationSerializable * @see ConfigurationSerializable
* @param map the map to deserialize
* @return the resulting serializable
*/ */
public static ConfigurationSerializable deserialize(Map<String, Object> map) { public static ConfigurationSerializable deserialize(Map<String, Object> map) {
Type type = Type.valueOf((String) map.get(TYPE)); Type type = Type.valueOf((String) map.get(TYPE));
@ -367,6 +369,7 @@ public final class FireworkEffect implements ConfigurationSerializable {
.build(); .build();
} }
@Override
public Map<String, Object> serialize() { public Map<String, Object> serialize() {
return ImmutableMap.<String, Object>of( return ImmutableMap.<String, Object>of(
FLICKER, flicker, FLICKER, flicker,

View File

@ -209,7 +209,7 @@ public class Location implements Cloneable {
* <li>A pitch of 90 represents downward facing, or negative y * <li>A pitch of 90 represents downward facing, or negative y
* direction. * direction.
* <li>A pitch of -90 represents upward facing, or positive y direction. * <li>A pitch of -90 represents upward facing, or positive y direction.
* <ul> * </ul>
* Increasing pitch values the equivalent of looking down. * Increasing pitch values the equivalent of looking down.
* *
* @param pitch new incline's pitch * @param pitch new incline's pitch
@ -225,7 +225,7 @@ public class Location implements Cloneable {
* <li>A pitch of 90 represents downward facing, or negative y * <li>A pitch of 90 represents downward facing, or negative y
* direction. * direction.
* <li>A pitch of -90 represents upward facing, or positive y direction. * <li>A pitch of -90 represents upward facing, or positive y direction.
* <ul> * </ul>
* Increasing pitch values the equivalent of looking down. * Increasing pitch values the equivalent of looking down.
* *
* @return the incline's pitch * @return the incline's pitch
@ -260,6 +260,9 @@ public class Location implements Cloneable {
/** /**
* Sets the {@link #getYaw() yaw} and {@link #getPitch() pitch} to point * Sets the {@link #getYaw() yaw} and {@link #getPitch() pitch} to point
* in the direction of the vector. * in the direction of the vector.
*
* @param vector the direction vector
* @return the same location
*/ */
public Location setDirection(Vector vector) { public Location setDirection(Vector vector) {
/* /*

View File

@ -91,7 +91,7 @@ public interface Server extends PluginMessageRecipient {
* compatibility. It will not exist at runtime and should not be used * compatibility. It will not exist at runtime and should not be used
* under any circumstances. * under any circumstances.
* *
* @Deprecated superseded by {@link #getOnlinePlayers()} * @deprecated superseded by {@link #getOnlinePlayers()}
* @return an array of Players that are currently online * @return an array of Players that are currently online
*/ */
@Deprecated @Deprecated
@ -735,7 +735,7 @@ public interface Server extends PluginMessageRecipient {
/** /**
* Creates an empty inventory with the specified type and title. If the type * Creates an empty inventory with the specified type and title. If the type
* is {@link InventoryType#CHEST}, the new inventory has a size of 27; * is {@link InventoryType#CHEST}, the new inventory has a size of 27;
* otherwise the new inventory has the normal size for its type.<br /> * otherwise the new inventory has the normal size for its type.<br>
* It should be noted that some inventory types do not support titles and * It should be noted that some inventory types do not support titles and
* may not render with said titles on the Minecraft client. * may not render with said titles on the Minecraft client.
* *
@ -913,6 +913,7 @@ public interface Server extends PluginMessageRecipient {
/** /**
* @see UnsafeValues * @see UnsafeValues
* @return the unsafe values instance
*/ */
@Deprecated @Deprecated
UnsafeValues getUnsafe(); UnsafeValues getUnsafe();

View File

@ -14,7 +14,7 @@ import org.bukkit.inventory.ItemStack;
* <p> * <p>
* This interface is unsupported and only for internal use. * This interface is unsupported and only for internal use.
* *
* @deprecated Unsupported & internal use only * @deprecated Unsupported {@literal &} internal use only
*/ */
@Deprecated @Deprecated
public interface UnsafeValues { public interface UnsafeValues {

View File

@ -402,6 +402,7 @@ public interface World extends PluginMessageRecipient, Metadatable {
* Get a collection of all entities in this World matching the given * Get a collection of all entities in this World matching the given
* class/interface * class/interface
* *
* @param <T> an entity subclass
* @param classes The classes representing the types of entity to match * @param classes The classes representing the types of entity to match
* @return A List of all Entities currently residing in this world that * @return A List of all Entities currently residing in this world that
* match the given class/interface * match the given class/interface
@ -412,7 +413,8 @@ public interface World extends PluginMessageRecipient, Metadatable {
/** /**
* Get a collection of all entities in this World matching the given * Get a collection of all entities in this World matching the given
* class/interface * class/interface
* *
* @param <T> an entity subclass
* @param cls The class representing the type of entity to match * @param cls The class representing the type of entity to match
* @return A List of all Entities currently residing in this world that * @return A List of all Entities currently residing in this world that
* match the given class/interface * match the given class/interface
@ -746,6 +748,7 @@ public interface World extends PluginMessageRecipient, Metadatable {
* Plays an effect to all players within a default radius around a given * Plays an effect to all players within a default radius around a given
* location. * location.
* *
* @param <T> data dependant on the type of effect
* @param location the {@link Location} around which players must be to * @param location the {@link Location} around which players must be to
* hear the sound * hear the sound
* @param effect the {@link Effect} * @param effect the {@link Effect}
@ -756,6 +759,7 @@ public interface World extends PluginMessageRecipient, Metadatable {
/** /**
* Plays an effect to all players within a given radius around a location. * Plays an effect to all players within a given radius around a location.
* *
* @param <T> data dependant on the type of effect
* @param location the {@link Location} around which players must be to * @param location the {@link Location} around which players must be to
* hear the effect * hear the effect
* @param effect the {@link Effect} * @param effect the {@link Effect}
@ -1050,6 +1054,8 @@ public interface World extends PluginMessageRecipient, Metadatable {
* <p> * <p>
* <b>Note:</b> If set to a negative number the world will use the * <b>Note:</b> If set to a negative number the world will use the
* server-wide spawn limit instead. * server-wide spawn limit instead.
*
* @param limit the new mob limit
*/ */
void setMonsterSpawnLimit(int limit); void setMonsterSpawnLimit(int limit);
@ -1067,6 +1073,8 @@ public interface World extends PluginMessageRecipient, Metadatable {
* <p> * <p>
* <b>Note:</b> If set to a negative number the world will use the * <b>Note:</b> If set to a negative number the world will use the
* server-wide spawn limit instead. * server-wide spawn limit instead.
*
* @param limit the new mob limit
*/ */
void setAnimalSpawnLimit(int limit); void setAnimalSpawnLimit(int limit);
@ -1084,6 +1092,8 @@ public interface World extends PluginMessageRecipient, Metadatable {
* <p> * <p>
* <b>Note:</b> If set to a negative number the world will use the * <b>Note:</b> If set to a negative number the world will use the
* server-wide spawn limit instead. * server-wide spawn limit instead.
*
* @param limit the new mob limit
*/ */
void setWaterAnimalSpawnLimit(int limit); void setWaterAnimalSpawnLimit(int limit);
@ -1101,6 +1111,8 @@ public interface World extends PluginMessageRecipient, Metadatable {
* <p> * <p>
* <b>Note:</b> If set to a negative number the world will use the * <b>Note:</b> If set to a negative number the world will use the
* server-wide spawn limit instead. * server-wide spawn limit instead.
*
* @param limit the new mob limit
*/ */
void setAmbientSpawnLimit(int limit); void setAmbientSpawnLimit(int limit);

View File

@ -148,6 +148,7 @@ public interface Block extends Metadatable {
* If the provided Location is null this method does nothing and returns * If the provided Location is null this method does nothing and returns
* null. * null.
* *
* @param loc the location to copy into
* @return The Location object provided or null * @return The Location object provided or null
*/ */
Location getLocation(Location loc); Location getLocation(Location loc);
@ -219,16 +220,16 @@ public interface Block extends Metadatable {
boolean setTypeIdAndData(int type, byte data, boolean applyPhysics); boolean setTypeIdAndData(int type, byte data, boolean applyPhysics);
/** /**
* Gets the face relation of this block compared to the given block * Gets the face relation of this block compared to the given block.
* <p> * <p>
* For example: * For example:
* <pre> * <pre>{@code
* Block current = world.getBlockAt(100, 100, 100); * Block current = world.getBlockAt(100, 100, 100);
* Block target = world.getBlockAt(100, 101, 100); * Block target = world.getBlockAt(100, 101, 100);
* *
* current.getFace(target) == BlockFace.Up; * current.getFace(target) == BlockFace.Up;
* </pre> * }</pre>
* <br /> * <br>
* If the given block is not connected to this block, null may be returned * If the given block is not connected to this block, null may be returned
* *
* @param block Block to compare against this block * @param block Block to compare against this block

View File

@ -96,6 +96,7 @@ public interface BlockState extends Metadatable {
* If the provided Location is null this method does nothing and returns * If the provided Location is null this method does nothing and returns
* null. * null.
* *
* @param loc the location to copy into
* @return The Location object provided or null * @return The Location object provided or null
*/ */
Location getLocation(Location loc); Location getLocation(Location loc);

View File

@ -57,7 +57,14 @@ public abstract class Command {
public abstract boolean execute(CommandSender sender, String commandLabel, String[] args); public abstract boolean execute(CommandSender sender, String commandLabel, String[] args);
/** /**
* Executed on tab completion for this command, returning a list of
* options the player can tab through.
*
* @deprecated This method is not supported and returns null * @deprecated This method is not supported and returns null
* @param sender Source object which is executing this command
* @param args All arguments passed to the command, split via ' '
* @return a list of tab-completions for the specified arguments. This
* will never be null. List may be immutable.
*/ */
@Deprecated @Deprecated
public List<String> tabComplete(CommandSender sender, String[] args) { public List<String> tabComplete(CommandSender sender, String[] args) {

View File

@ -165,7 +165,7 @@ public class HelpCommand extends VanillaCommand {
/** /**
* Computes the Dameraur-Levenshtein Distance between two strings. Adapted * Computes the Dameraur-Levenshtein Distance between two strings. Adapted
* from the algorithm at <a href="http://en.wikipedia.org/wiki/DamerauLevenshtein_distance">Wikipedia: DamerauLevenshtein distance</a> * from the algorithm at <a href="http://en.wikipedia.org/wiki/Damerau%E2%80%93Levenshtein_distance">Wikipedia: DamerauLevenshtein distance</a>
* *
* @param s1 The first string being compared. * @param s1 The first string being compared.
* @param s2 The second string being compared. * @param s2 The second string being compared.

View File

@ -29,7 +29,7 @@ public interface Configuration extends 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 values. * hold the new default values.
* *
* @param defaults A map of Path->Values to add to defaults. * @param defaults A map of Path{@literal ->}Values to add to defaults.
* @throws IllegalArgumentException Thrown if defaults is null. * @throws IllegalArgumentException Thrown if defaults is null.
*/ */
public void addDefaults(Map<String, Object> defaults); public void addDefaults(Map<String, Object> defaults);

View File

@ -271,7 +271,7 @@ public abstract class FileConfiguration extends MemoryConfiguration {
* Compiles the header for this {@link FileConfiguration} and returns the * Compiles the header for this {@link FileConfiguration} and returns the
* result. * result.
* <p> * <p>
* This will use the header from {@link #options()} -> {@link * This will use the header from {@link #options()} -&gt; {@link
* FileConfigurationOptions#header()}, respecting the rules of {@link * FileConfigurationOptions#header()}, respecting the rules of {@link
* FileConfigurationOptions#copyHeader()} if set. * FileConfigurationOptions#copyHeader()} if set.
* *

View File

@ -9,11 +9,11 @@ import java.util.Map;
* 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}&gt; and returns the class.</li>
* <li>A static method "valueOf" that accepts a single {@link Map}&lt;{@link * <li>A static method "valueOf" that accepts a single {@link Map}&lt;{@link
* String}, {@link Object}> and returns the class.</li> * String}, {@link Object}&gt; and returns the class.</li>
* <li>A constructor that accepts a single {@link Map}&lt;{@link String}, * <li>A constructor that accepts a single {@link Map}&lt;{@link String},
* {@link Object}>.</li> * {@link Object}&gt;.</li>
* </ul> * </ul>
* In addition to implementing this interface, you must register the class * In addition to implementing this interface, you must register the class
* with {@link ConfigurationSerialization#registerClass(Class)}. * with {@link ConfigurationSerialization#registerClass(Class)}.

View File

@ -71,6 +71,7 @@ public enum CreatureType {
/** /**
* *
* @return the raw type id
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated
@ -84,6 +85,8 @@ public enum CreatureType {
/** /**
* *
* @param id the raw type id
* @return the matching CreatureType or null
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated

View File

@ -15,6 +15,8 @@ public interface Damageable extends Entity {
* This method exists for legacy reasons to provide backwards * This method exists for legacy reasons to provide backwards
* compatibility. It will not exist at runtime and should not be used * compatibility. It will not exist at runtime and should not be used
* under any circumstances. * under any circumstances.
*
* @param amount Amount of damage to deal
*/ */
@Deprecated @Deprecated
void _INVALID_damage(int amount); void _INVALID_damage(int amount);
@ -32,6 +34,9 @@ public interface Damageable extends Entity {
* This method exists for legacy reasons to provide backwards * This method exists for legacy reasons to provide backwards
* compatibility. It will not exist at runtime and should not be used * compatibility. It will not exist at runtime and should not be used
* under any circumstances. * under any circumstances.
*
* @param amount Amount of damage to deal
* @param source Entity which to attribute this damage from
*/ */
@Deprecated @Deprecated
void _INVALID_damage(int amount, Entity source); void _INVALID_damage(int amount, Entity source);
@ -47,6 +52,8 @@ public interface Damageable extends Entity {
* This method exists for legacy reasons to provide backwards * This method exists for legacy reasons to provide backwards
* compatibility. It will not exist at runtime and should not be used * compatibility. It will not exist at runtime and should not be used
* under any circumstances. * under any circumstances.
*
* @return Health represented from 0 to max
*/ */
@Deprecated @Deprecated
int _INVALID_getHealth(); int _INVALID_getHealth();
@ -56,7 +63,7 @@ public interface Damageable extends Entity {
* dead. * dead.
* *
* @param health New health represented from 0 to max * @param health New health represented from 0 to max
* @throws IllegalArgumentException Thrown if the health is < 0 or > * @throws IllegalArgumentException Thrown if the health is {@literal < 0 or >}
* {@link #getMaxHealth()} * {@link #getMaxHealth()}
*/ */
void setHealth(double health); void setHealth(double health);
@ -65,6 +72,10 @@ public interface Damageable extends Entity {
* This method exists for legacy reasons to provide backwards * This method exists for legacy reasons to provide backwards
* compatibility. It will not exist at runtime and should not be used * compatibility. It will not exist at runtime and should not be used
* under any circumstances. * under any circumstances.
*
* @param health New health represented from 0 to max
* @throws IllegalArgumentException Thrown if the health is {@literal < 0 or >}
* {@link #getMaxHealth()}
*/ */
@Deprecated @Deprecated
void _INVALID_setHealth(int health); void _INVALID_setHealth(int health);
@ -80,6 +91,8 @@ public interface Damageable extends Entity {
* This method exists for legacy reasons to provide backwards * This method exists for legacy reasons to provide backwards
* compatibility. It will not exist at runtime and should not be used * compatibility. It will not exist at runtime and should not be used
* under any circumstances. * under any circumstances.
*
* @return Maximum health
*/ */
@Deprecated @Deprecated
int _INVALID_getMaxHealth(); int _INVALID_getMaxHealth();
@ -101,6 +114,8 @@ public interface Damageable extends Entity {
* This method exists for legacy reasons to provide backwards * This method exists for legacy reasons to provide backwards
* compatibility. It will not exist at runtime and should not be used * compatibility. It will not exist at runtime and should not be used
* under any circumstances. * under any circumstances.
*
* @param health amount of health to set the maximum to
*/ */
@Deprecated @Deprecated
void _INVALID_setMaxHealth(int health); void _INVALID_setMaxHealth(int health);

View File

@ -30,6 +30,7 @@ public interface Entity extends Metadatable {
* If the provided Location is null this method does nothing and returns * If the provided Location is null this method does nothing and returns
* null. * null.
* *
* @param loc the location to copy into
* @return The Location object provided or null * @return The Location object provided or null
*/ */
public Location getLocation(Location loc); public Location getLocation(Location loc);
@ -109,7 +110,7 @@ public interface Entity extends Metadatable {
* @param x 1/2 the size of the box along x axis * @param x 1/2 the size of the box along x axis
* @param y 1/2 the size of the box along y axis * @param y 1/2 the size of the box along y axis
* @param z 1/2 the size of the box along z axis * @param z 1/2 the size of the box along z axis
* @return List<Entity> List of entities nearby * @return {@code List<Entity>} List of entities nearby
*/ */
public List<org.bukkit.entity.Entity> getNearbyEntities(double x, double y, double z); public List<org.bukkit.entity.Entity> getNearbyEntities(double x, double y, double z);

View File

@ -209,6 +209,7 @@ public enum EntityType {
/** /**
* *
* @return the entity type's name
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated
@ -222,6 +223,7 @@ public enum EntityType {
/** /**
* *
* @return the raw type id
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated
@ -231,6 +233,8 @@ public enum EntityType {
/** /**
* *
* @param name the entity type's name
* @return the matching entity type or null
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated
@ -243,6 +247,8 @@ public enum EntityType {
/** /**
* *
* @param id the raw type id
* @return the matching entity type or null
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated

View File

@ -173,6 +173,8 @@ public interface LivingEntity extends Entity, Damageable, ProjectileSource {
* This method exists for legacy reasons to provide backwards * This method exists for legacy reasons to provide backwards
* compatibility. It will not exist at runtime and should not be used * compatibility. It will not exist at runtime and should not be used
* under any circumstances. * under any circumstances.
*
* @return damage taken since the last no damage ticks time period
*/ */
@Deprecated @Deprecated
public int _INVALID_getLastDamage(); public int _INVALID_getLastDamage();
@ -188,6 +190,8 @@ public interface LivingEntity extends Entity, Damageable, ProjectileSource {
* This method exists for legacy reasons to provide backwards * This method exists for legacy reasons to provide backwards
* compatibility. It will not exist at runtime and should not be used * compatibility. It will not exist at runtime and should not be used
* under any circumstances. * under any circumstances.
*
* @param damage amount of damage
*/ */
@Deprecated @Deprecated
public void _INVALID_setLastDamage(int damage); public void _INVALID_setLastDamage(int damage);

View File

@ -11,6 +11,8 @@ public interface Minecart extends Vehicle {
* This method exists for legacy reasons to provide backwards * This method exists for legacy reasons to provide backwards
* compatibility. It will not exist at runtime and should not be used * compatibility. It will not exist at runtime and should not be used
* under any circumstances. * under any circumstances.
*
* @param damage over 40 to "kill" a minecart
*/ */
@Deprecated @Deprecated
public void _INVALID_setDamage(int damage); public void _INVALID_setDamage(int damage);
@ -26,6 +28,8 @@ public interface Minecart extends Vehicle {
* This method exists for legacy reasons to provide backwards * This method exists for legacy reasons to provide backwards
* compatibility. It will not exist at runtime and should not be used * compatibility. It will not exist at runtime and should not be used
* under any circumstances. * under any circumstances.
*
* @return The damage
*/ */
@Deprecated @Deprecated
public int _INVALID_getDamage(); public int _INVALID_getDamage();

View File

@ -255,6 +255,7 @@ public interface Player extends HumanEntity, Conversable, CommandSender, Offline
/** /**
* Plays an effect to just this player. * Plays an effect to just this player.
* *
* @param <T> the data based based on the type of the effect
* @param loc the location to play the effect at * @param loc the location to play the effect at
* @param effect the {@link Effect} * @param effect the {@link Effect}
* @param data a data bit needed for some effects * @param data a data bit needed for some effects
@ -360,6 +361,7 @@ public interface Player extends HumanEntity, Conversable, CommandSender, Offline
/** /**
* Gets whether this player has the given achievement. * Gets whether this player has the given achievement.
* *
* @param achievement the achievement to check
* @return whether the player has the achievement * @return whether the player has the achievement
* @throws IllegalArgumentException if achievement is null * @throws IllegalArgumentException if achievement is null
*/ */
@ -763,7 +765,7 @@ public interface Player extends HumanEntity, Conversable, CommandSender, Offline
* Gets the players current saturation level. * Gets the players current saturation level.
* <p> * <p>
* Saturation is a buffer for food level. Your food level will not drop if * Saturation is a buffer for food level. Your food level will not drop if
* you are saturated > 0. * you are saturated {@literal >} 0.
* *
* @return Saturation level * @return Saturation level
*/ */

View File

@ -11,6 +11,8 @@ public interface Projectile extends Entity {
* This method exists for legacy reasons to provide backwards * This method exists for legacy reasons to provide backwards
* compatibility. It will not exist at runtime and should not be used * compatibility. It will not exist at runtime and should not be used
* under any circumstances. * under any circumstances.
*
* @return the {@link LivingEntity} that shot this projectile
*/ */
@Deprecated @Deprecated
public LivingEntity _INVALID_getShooter(); public LivingEntity _INVALID_getShooter();
@ -26,6 +28,8 @@ public interface Projectile extends Entity {
* This method exists for legacy reasons to provide backwards * This method exists for legacy reasons to provide backwards
* compatibility. It will not exist at runtime and should not be used * compatibility. It will not exist at runtime and should not be used
* under any circumstances. * under any circumstances.
*
* @param shooter the {@link LivingEntity} that shot this projectile
*/ */
@Deprecated @Deprecated
public void _INVALID_setShooter(LivingEntity shooter); public void _INVALID_setShooter(LivingEntity shooter);

View File

@ -24,6 +24,8 @@ public @interface EventHandler {
* <li>HIGHEST * <li>HIGHEST
* <li>MONITOR * <li>MONITOR
* </ol> * </ol>
*
* @return the priority
*/ */
EventPriority priority() default EventPriority.NORMAL; EventPriority priority() default EventPriority.NORMAL;
@ -32,6 +34,8 @@ public @interface EventHandler {
* <p> * <p>
* If ignoreCancelled is true and the event is cancelled, the method is * If ignoreCancelled is true and the event is cancelled, the method is
* not called. Otherwise, the method is always called. * not called. Otherwise, the method is always called.
*
* @return whether cancelled events should be ignored
*/ */
boolean ignoreCancelled() default false; boolean ignoreCancelled() default false;
} }

View File

@ -29,6 +29,9 @@ public class BlockCanBuildEvent extends BlockEvent {
/** /**
* *
* @deprecated Magic value * @deprecated Magic value
* @param block the block involved in this event
* @param id the id of the block to place
* @param canBuild whether we can build
*/ */
@Deprecated @Deprecated
public BlockCanBuildEvent(final Block block, final int id, final boolean canBuild) { public BlockCanBuildEvent(final Block block, final int id, final boolean canBuild) {

View File

@ -19,10 +19,6 @@ public class BlockIgniteEvent extends BlockEvent implements Cancellable {
private final Block ignitingBlock; private final Block ignitingBlock;
private boolean cancel; private boolean cancel;
/**
* @deprecated use {@link BlockIgniteEvent#BlockIgniteEvent(Block,
* IgniteCause, Entity)} instead.
*/
@Deprecated @Deprecated
public BlockIgniteEvent(final Block theBlock, final IgniteCause cause, final Player thePlayer) { public BlockIgniteEvent(final Block theBlock, final IgniteCause cause, final Player thePlayer) {
this(theBlock, cause, (Entity) thePlayer); this(theBlock, cause, (Entity) thePlayer);

View File

@ -16,6 +16,8 @@ public class BlockPhysicsEvent extends BlockEvent implements Cancellable {
/** /**
* *
* @deprecated Magic value * @deprecated Magic value
* @param block the block involved in this event
* @param changed the changed block's type id
*/ */
@Deprecated @Deprecated
public BlockPhysicsEvent(final Block block, final int changed) { public BlockPhysicsEvent(final Block block, final int changed) {

View File

@ -46,8 +46,8 @@ public class SignChangeEvent extends BlockEvent implements Cancellable {
* @param index index of the line to get * @param index index of the line to get
* @return the String containing the line of text associated with the * @return the String containing the line of text associated with the
* provided index * provided index
* @throws IndexOutOfBoundsException thrown when the provided index is > 3 * @throws IndexOutOfBoundsException thrown when the provided index is {@literal > 3
* or < 0 * or < 0}
*/ */
public String getLine(int index) throws IndexOutOfBoundsException { public String getLine(int index) throws IndexOutOfBoundsException {
return lines[index]; return lines[index];
@ -58,8 +58,8 @@ public class SignChangeEvent extends BlockEvent implements Cancellable {
* *
* @param index index of the line to set * @param index index of the line to set
* @param line text to set * @param line text to set
* @throws IndexOutOfBoundsException thrown when the provided index is > 3 * @throws IndexOutOfBoundsException thrown when the provided index is {@literal > 3
* or < 0 * or < 0}
*/ */
public void setLine(int index, String line) throws IndexOutOfBoundsException { public void setLine(int index, String line) throws IndexOutOfBoundsException {
lines[index] = line; lines[index] = line;

View File

@ -63,6 +63,7 @@ public class EntityDamageEvent extends EntityEvent implements Cancellable {
* event's construction. * event's construction.
* *
* @param type the modifier * @param type the modifier
* @return the original damage
* @throws IllegalArgumentException if type is null * @throws IllegalArgumentException if type is null
*/ */
public double getOriginalDamage(DamageModifier type) throws IllegalArgumentException { public double getOriginalDamage(DamageModifier type) throws IllegalArgumentException {
@ -79,6 +80,7 @@ public class EntityDamageEvent extends EntityEvent implements Cancellable {
/** /**
* Sets the damage for the specified modifier. * Sets the damage for the specified modifier.
* *
* @param type the damage modifier
* @param damage the scalar value of the damage's modifier * @param damage the scalar value of the damage's modifier
* @see #getFinalDamage() * @see #getFinalDamage()
* @throws IllegalArgumentException if type is null * @throws IllegalArgumentException if type is null
@ -96,6 +98,7 @@ public class EntityDamageEvent extends EntityEvent implements Cancellable {
/** /**
* Gets the damage change for some modifier * Gets the damage change for some modifier
* *
* @param type the damage modifier
* @return The raw amount of damage caused by the event * @return The raw amount of damage caused by the event
* @throws IllegalArgumentException if type is null * @throws IllegalArgumentException if type is null
* @see DamageModifier#BASE * @see DamageModifier#BASE
@ -150,6 +153,8 @@ public class EntityDamageEvent extends EntityEvent implements Cancellable {
* This method exists for legacy reasons to provide backwards * This method exists for legacy reasons to provide backwards
* compatibility. It will not exist at runtime and should not be used * compatibility. It will not exist at runtime and should not be used
* under any circumstances. * under any circumstances.
*
* @return the (rounded) damage
*/ */
@Deprecated @Deprecated
public int _INVALID_getDamage() { public int _INVALID_getDamage() {
@ -197,6 +202,8 @@ public class EntityDamageEvent extends EntityEvent implements Cancellable {
* This method exists for legacy reasons to provide backwards * This method exists for legacy reasons to provide backwards
* compatibility. It will not exist at runtime and should not be used * compatibility. It will not exist at runtime and should not be used
* under any circumstances. * under any circumstances.
*
* @param damage the new damage value
*/ */
@Deprecated @Deprecated
public void _INVALID_setDamage(int damage) { public void _INVALID_setDamage(int damage) {

View File

@ -26,7 +26,7 @@ public class EntityPortalExitEvent extends EntityTeleportEvent {
* Gets a copy of the velocity that the entity has before entering the * Gets a copy of the velocity that the entity has before entering the
* portal. * portal.
* *
* @return velocity of entity before entering portal * @return velocity of entity before entering the portal
*/ */
public Vector getBefore() { public Vector getBefore() {
return this.before.clone(); return this.before.clone();
@ -36,7 +36,7 @@ public class EntityPortalExitEvent extends EntityTeleportEvent {
* Gets a copy of the velocity that the entity will have after exiting the * Gets a copy of the velocity that the entity will have after exiting the
* portal. * portal.
* *
* @return velocity of entity after exiting portal * @return velocity of entity after exiting the portal
*/ */
public Vector getAfter() { public Vector getAfter() {
return this.after.clone(); return this.after.clone();
@ -44,6 +44,8 @@ public class EntityPortalExitEvent extends EntityTeleportEvent {
/** /**
* Sets the velocity that the entity will have after exiting the portal. * Sets the velocity that the entity will have after exiting the portal.
*
* @param after the velocity after exiting the portal
*/ */
public void setAfter(Vector after) { public void setAfter(Vector after) {
this.after = after.clone(); this.after = after.clone();

View File

@ -38,6 +38,8 @@ public class EntityRegainHealthEvent extends EntityEvent implements Cancellable
* This method exists for legacy reasons to provide backwards * This method exists for legacy reasons to provide backwards
* compatibility. It will not exist at runtime and should not be used * compatibility. It will not exist at runtime and should not be used
* under any circumstances. * under any circumstances.
*
* @return the (rounded) amount regained
*/ */
@Deprecated @Deprecated
public int _INVALID_getAmount() { public int _INVALID_getAmount() {
@ -57,16 +59,20 @@ public class EntityRegainHealthEvent extends EntityEvent implements Cancellable
* This method exists for legacy reasons to provide backwards * This method exists for legacy reasons to provide backwards
* compatibility. It will not exist at runtime and should not be used * compatibility. It will not exist at runtime and should not be used
* under any circumstances. * under any circumstances.
*
* @param amount the amount that will be regained
*/ */
@Deprecated @Deprecated
public void _INVALID_setAmount(int amount) { public void _INVALID_setAmount(int amount) {
setAmount(amount); setAmount(amount);
} }
@Override
public boolean isCancelled() { public boolean isCancelled() {
return cancelled; return cancelled;
} }
@Override
public void setCancelled(boolean cancel) { public void setCancelled(boolean cancel) {
cancelled = cancel; cancelled = cancel;
} }

View File

@ -20,9 +20,9 @@ public class PlayerFishEvent extends PlayerEvent implements Cancellable {
/** /**
* @deprecated replaced by {@link #PlayerFishEvent(Player, Entity, Fish, * @deprecated replaced by {@link #PlayerFishEvent(Player, Entity, Fish,
* State)} to include the {@link Fish} hook entity. * State)} to include the {@link Fish} hook entity.
* @param player * @param player the player fishing
* @param entity * @param entity the caught entity
* @param state * @param state the state of fishing
*/ */
@Deprecated @Deprecated
public PlayerFishEvent(final Player player, final Entity entity, final State state) { public PlayerFishEvent(final Player player, final Entity entity, final State state) {
@ -40,7 +40,7 @@ public class PlayerFishEvent extends PlayerEvent implements Cancellable {
* Gets the entity caught by the player. * Gets the entity caught by the player.
* <p> * <p>
* If player has fished successfully, the result may be cast to {@link * If player has fished successfully, the result may be cast to {@link
* Item}. * org.bukkit.entity.Item}.
* *
* @return Entity caught by the player, Entity if fishing, and null if * @return Entity caught by the player, Entity if fishing, and null if
* bobber has gotten stuck in the ground or nothing has been caught * bobber has gotten stuck in the ground or nothing has been caught

View File

@ -17,6 +17,7 @@ public class PlayerLoginEvent extends PlayerEvent {
/** /**
* @deprecated Address should be provided in other constructor * @deprecated Address should be provided in other constructor
* @param player The {@link Player} for this event
*/ */
@Deprecated @Deprecated
public PlayerLoginEvent(final Player player) { public PlayerLoginEvent(final Player player) {
@ -25,6 +26,8 @@ public class PlayerLoginEvent extends PlayerEvent {
/** /**
* @deprecated Address should be provided in other constructor * @deprecated Address should be provided in other constructor
* @param player The {@link Player} for this event
* @param hostname The hostname that was used to connect to the server
*/ */
@Deprecated @Deprecated
public PlayerLoginEvent(final Player player, final String hostname) { public PlayerLoginEvent(final Player player, final String hostname) {
@ -49,6 +52,9 @@ public class PlayerLoginEvent extends PlayerEvent {
/** /**
* @deprecated Address and hostname should be provided in other * @deprecated Address and hostname should be provided in other
* constructor * constructor
* @param player The {@link Player} for this event
* @param result The result status for this event
* @param message The message to be displayed if result denies login
*/ */
@Deprecated @Deprecated
public PlayerLoginEvent(final Player player, final Result result, final String message) { public PlayerLoginEvent(final Player player, final Result result, final String message) {

View File

@ -32,6 +32,10 @@ public class ServerListPingEvent extends ServerEvent implements Iterable<Player>
* This constructor is intended for implementations that provide the * This constructor is intended for implementations that provide the
* {@link #iterator()} method, thus provided the {@link #getNumPlayers()} * {@link #iterator()} method, thus provided the {@link #getNumPlayers()}
* count. * count.
*
* @param address the address of the pinger
* @param motd the message of the day
* @param maxPlayers the max number of players
*/ */
protected ServerListPingEvent(final InetAddress address, final String motd, final int maxPlayers) { protected ServerListPingEvent(final InetAddress address, final String motd, final int maxPlayers) {
this.numPlayers = MAGIC_PLAYER_COUNT; this.numPlayers = MAGIC_PLAYER_COUNT;

View File

@ -48,6 +48,8 @@ public class VehicleDamageEvent extends VehicleEvent implements Cancellable {
* This method exists for legacy reasons to provide backwards * This method exists for legacy reasons to provide backwards
* compatibility. It will not exist at runtime and should not be used * compatibility. It will not exist at runtime and should not be used
* under any circumstances. * under any circumstances.
*
* @return the damage
*/ */
@Deprecated @Deprecated
public int _INVALID_getDamage() { public int _INVALID_getDamage() {
@ -67,6 +69,8 @@ public class VehicleDamageEvent extends VehicleEvent implements Cancellable {
* This method exists for legacy reasons to provide backwards * This method exists for legacy reasons to provide backwards
* compatibility. It will not exist at runtime and should not be used * compatibility. It will not exist at runtime and should not be used
* under any circumstances. * under any circumstances.
*
* @param damage the damage
*/ */
@Deprecated @Deprecated
public void _INVALID_setDamage(int damage) { public void _INVALID_setDamage(int damage) {

View File

@ -9,8 +9,8 @@ import org.bukkit.event.Cancellable;
import org.bukkit.event.HandlerList; import org.bukkit.event.HandlerList;
/** /**
* Event that is called when an organic structure attempts to grow (Sapling -> * Event that is called when an organic structure attempts to grow (Sapling {@literal ->}
* Tree), (Mushroom -> Huge Mushroom), naturally or using bonemeal. * Tree), (Mushroom {@literal ->} Huge Mushroom), naturally or using bonemeal.
*/ */
public class StructureGrowEvent extends WorldEvent implements Cancellable { public class StructureGrowEvent extends WorldEvent implements Cancellable {
private static final HandlerList handlers = new HandlerList(); private static final HandlerList handlers = new HandlerList();

View File

@ -89,7 +89,7 @@ public abstract class ChunkGenerator {
* <pre> * <pre>
* short[][] result = new short[world-height / 16][]; * short[][] result = new short[world-height / 16][];
* </pre> * </pre>
* Each section (sectionID = (Y>>4)) that has blocks needs to be allocated * Each section {@code (sectionID = (Y>>4))} that has blocks needs to be allocated
* space for the 4096 blocks in that section: * space for the 4096 blocks in that section:
* <pre> * <pre>
* result[sectionID] = new short[4096]; * result[sectionID] = new short[4096];
@ -100,20 +100,20 @@ public abstract class ChunkGenerator {
* following mapping function: * following mapping function:
* <pre> * <pre>
* void setBlock(short[][] result, int x, int y, int z, short blkid) { * void setBlock(short[][] result, int x, int y, int z, short blkid) {
* if (result[y >> 4] == null) { * {@code if (result[y >> 4] == null) {}
* result[y >> 4] = new short[4096]; * {@code result[y >> 4] = new short[4096];}
* } * }
* result[y >> 4][((y & 0xF) << 8) | (z << 4) | x] = blkid; * {@code result[y >> 4][((y & 0xF) << 8) | (z << 4) | x] = blkid;}
* } * }
* </pre> * </pre>
* while reading a block ID can be done with the following mapping * while reading a block ID can be done with the following mapping
* function: * function:
* <pre> * <pre>
* short getBlock(short[][] result, int x, int y, int z) { * short getBlock(short[][] result, int x, int y, int z) {
* if (result[y >> 4] == null) { * {@code if (result[y >> 4] == null) {}
* return (short)0; * return (short)0;
* } * }
* return result[y >> 4][((y & 0xF) << 8) | (z << 4) | x]; * {@code return result[y >> 4][((y & 0xF) << 8) | (z << 4) | x];}
* } * }
* </pre> * </pre>
* while sections that are not populated can be left null. * while sections that are not populated can be left null.
@ -122,20 +122,20 @@ public abstract class ChunkGenerator {
* following mapping function: * following mapping function:
* <pre> * <pre>
* void setBlock(short[][] result, int x, int y, int z, short blkid) { * void setBlock(short[][] result, int x, int y, int z, short blkid) {
* if (result[y >> 4) == null) { * {@code if (result[y >> 4) == null) {}
* result[y >> 4] = new short[4096]; * {@code result[y >> 4] = new short[4096];}
* } * }
* result[y >> 4][((y & 0xF) << 8) | (z << 4) | x] = blkid; * {@code result[y >> 4][((y & 0xF) << 8) | (z << 4) | x] = blkid;}
* } * }
* </pre> * </pre>
* while reading a block ID can be done with the following mapping * while reading a block ID can be done with the following mapping
* function: * function:
* <pre> * <pre>
* short getBlock(short[][] result, int x, int y, int z) { * short getBlock(short[][] result, int x, int y, int z) {
* if (result[y >> 4) == null) { * {@code if (result[y >> 4) == null) {}
* return (short)0; * return (short)0;
* } * }
* return result[y >> 4][((y & 0xF) << 8) | (z << 4) | x]; * {@code return result[y >> 4][((y & 0xF) << 8) | (z << 4) | x];}
* } * }
* </pre> * </pre>
* <p> * <p>
@ -173,7 +173,7 @@ public abstract class ChunkGenerator {
* <pre> * <pre>
* byte[][] result = new byte[world-height / 16][]; * byte[][] result = new byte[world-height / 16][];
* </pre> * </pre>
* Each section (sectionID = (Y>>4)) that has blocks needs to be allocated * Each section {@code (sectionID = (Y>>4))} that has blocks needs to be allocated
* space for the 4096 blocks in that section: * space for the 4096 blocks in that section:
* <pre> * <pre>
* result[sectionID] = new byte[4096]; * result[sectionID] = new byte[4096];
@ -184,20 +184,20 @@ public abstract class ChunkGenerator {
* following mapping function: * following mapping function:
* <pre> * <pre>
* void setBlock(byte[][] result, int x, int y, int z, byte blkid) { * void setBlock(byte[][] result, int x, int y, int z, byte blkid) {
* if (result[y >> 4) == null) { * {@code if (result[y >> 4) == null) {}
* result[y >> 4] = new byte[4096]; * {@code result[y >> 4] = new byte[4096];}
* } * }
* result[y >> 4][((y & 0xF) << 8) | (z << 4) | x] = blkid; * {@code result[y >> 4][((y & 0xF) << 8) | (z << 4) | x] = blkid;}
* } * }
* </pre> * </pre>
* while reading a block ID can be done with the following mapping * while reading a block ID can be done with the following mapping
* function: * function:
* <pre> * <pre>
* byte getBlock(byte[][] result, int x, int y, int z) { * byte getBlock(byte[][] result, int x, int y, int z) {
* if (result[y >> 4) == null) { * {@code if (result[y >> 4) == null) {}
* return (byte)0; * return (byte)0;
* } * }
* return result[y >> 4][((y & 0xF) << 8) | (z << 4) | x]; * {@code return result[y >> 4][((y & 0xF) << 8) | (z << 4) | x];}
* } * }
* </pre> * </pre>
* *

View File

@ -7,7 +7,7 @@ import java.util.List;
* The HelpMap tracks all help topics registered in a Bukkit server. When the * The HelpMap tracks all help topics registered in a Bukkit server. When the
* server starts up or is reloaded, help is processed and topics are added in * server starts up or is reloaded, help is processed and topics are added in
* the following order: * the following order:
* <p> *
* <ol> * <ol>
* <li>General topics are loaded from the help.yml * <li>General topics are loaded from the help.yml
* <li>Plugins load and optionally call {@code addTopic()} * <li>Plugins load and optionally call {@code addTopic()}

View File

@ -98,8 +98,8 @@ public interface EntityEquipment {
/** /**
* Gets the chance of the currently held item being dropped upon this * Gets the chance of the currently held item being dropped upon this
* creature's death * creature's death.
* <p> *
* <ul> * <ul>
* <li>A drop chance of 0F will never drop * <li>A drop chance of 0F will never drop
* <li>A drop chance of 1F will always drop * <li>A drop chance of 1F will always drop
@ -111,8 +111,8 @@ public interface EntityEquipment {
/** /**
* Sets the chance of the item this creature is currently holding being * Sets the chance of the item this creature is currently holding being
* dropped upon this creature's death * dropped upon this creature's death.
* <p> *
* <ul> * <ul>
* <li>A drop chance of 0F will never drop * <li>A drop chance of 0F will never drop
* <li>A drop chance of 1F will always drop * <li>A drop chance of 1F will always drop
@ -124,8 +124,8 @@ public interface EntityEquipment {
void setItemInHandDropChance(float chance); void setItemInHandDropChance(float chance);
/** /**
* Gets the chance of the helmet being dropped upon this creature's death * Gets the chance of the helmet being dropped upon this creature's death.
* <p> *
* <ul> * <ul>
* <li>A drop chance of 0F will never drop * <li>A drop chance of 0F will never drop
* <li>A drop chance of 1F will always drop * <li>A drop chance of 1F will always drop
@ -136,8 +136,8 @@ public interface EntityEquipment {
float getHelmetDropChance(); float getHelmetDropChance();
/** /**
* Sets the chance of the helmet being dropped upon this creature's death * Sets the chance of the helmet being dropped upon this creature's death.
* <p> *
* <ul> * <ul>
* <li>A drop chance of 0F will never drop * <li>A drop chance of 0F will never drop
* <li>A drop chance of 1F will always drop * <li>A drop chance of 1F will always drop
@ -150,8 +150,8 @@ public interface EntityEquipment {
/** /**
* Gets the chance of the chest plate being dropped upon this creature's * Gets the chance of the chest plate being dropped upon this creature's
* death * death.
* <p> *
* <ul> * <ul>
* <li>A drop chance of 0F will never drop * <li>A drop chance of 0F will never drop
* <li>A drop chance of 1F will always drop * <li>A drop chance of 1F will always drop
@ -163,8 +163,8 @@ public interface EntityEquipment {
/** /**
* Sets the chance of the chest plate being dropped upon this creature's * Sets the chance of the chest plate being dropped upon this creature's
* death * death.
* <p> *
* <ul> * <ul>
* <li>A drop chance of 0F will never drop * <li>A drop chance of 0F will never drop
* <li>A drop chance of 1F will always drop * <li>A drop chance of 1F will always drop
@ -177,8 +177,8 @@ public interface EntityEquipment {
/** /**
* Gets the chance of the leggings being dropped upon this creature's * Gets the chance of the leggings being dropped upon this creature's
* death * death.
* <p> *
* <ul> * <ul>
* <li>A drop chance of 0F will never drop * <li>A drop chance of 0F will never drop
* <li>A drop chance of 1F will always drop * <li>A drop chance of 1F will always drop
@ -190,8 +190,8 @@ public interface EntityEquipment {
/** /**
* Sets the chance of the leggings being dropped upon this creature's * Sets the chance of the leggings being dropped upon this creature's
* death * death.
* <p> *
* <ul> * <ul>
* <li>A drop chance of 0F will never drop * <li>A drop chance of 0F will never drop
* <li>A drop chance of 1F will always drop * <li>A drop chance of 1F will always drop
@ -203,8 +203,8 @@ public interface EntityEquipment {
void setLeggingsDropChance(float chance); void setLeggingsDropChance(float chance);
/** /**
* Gets the chance of the boots being dropped upon this creature's death * Gets the chance of the boots being dropped upon this creature's death.
* <p> *
* <ul> * <ul>
* <li>A drop chance of 0F will never drop * <li>A drop chance of 0F will never drop
* <li>A drop chance of 1F will always drop * <li>A drop chance of 1F will always drop
@ -215,8 +215,8 @@ public interface EntityEquipment {
float getBootsDropChance(); float getBootsDropChance();
/** /**
* Sets the chance of the boots being dropped upon this creature's death * Sets the chance of the boots being dropped upon this creature's death.
* <p> *
* <ul> * <ul>
* <li>A drop chance of 0F will never drop * <li>A drop chance of 0F will never drop
* <li>A drop chance of 1F will always drop * <li>A drop chance of 1F will always drop

View File

@ -62,6 +62,7 @@ public abstract class InventoryView {
/** /**
* *
* @return the id of this view
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated

View File

@ -95,6 +95,10 @@ public class ItemStack implements Cloneable, ConfigurationSerializable {
} }
/** /**
* @param type the raw type id
* @param amount the amount in the stack
* @param damage the damage value of the item
* @param data the data value or null
* @deprecated this method uses an ambiguous data byte object * @deprecated this method uses an ambiguous data byte object
*/ */
@Deprecated @Deprecated
@ -109,6 +113,10 @@ public class ItemStack implements Cloneable, ConfigurationSerializable {
} }
/** /**
* @param type the type
* @param amount the amount in the stack
* @param damage the damage value of the item
* @param data the data value or null
* @deprecated this method uses an ambiguous data byte object * @deprecated this method uses an ambiguous data byte object
*/ */
@Deprecated @Deprecated

View File

@ -57,7 +57,7 @@ public interface FireworkMeta extends ItemMeta {
* Remove an effect from this firework. * Remove an effect from this firework.
* *
* @param index The index of the effect to remove * @param index The index of the effect to remove
* @throws IndexOutOfBoundsException If index < 0 or index > {@link * @throws IndexOutOfBoundsException If index {@literal < 0 or index >} {@link
* #getEffectsSize()} * #getEffectsSize()}
*/ */
void removeEffect(int index) throws IndexOutOfBoundsException; void removeEffect(int index) throws IndexOutOfBoundsException;
@ -86,7 +86,7 @@ public interface FireworkMeta extends ItemMeta {
* a second of flight time. * a second of flight time.
* *
* @param power the power of the firework, from 0-128 * @param power the power of the firework, from 0-128
* @throws IllegalArgumentException if height<0 or height>128 * @throws IllegalArgumentException if {@literal height<0 or height>128}
*/ */
void setPower(int power) throws IllegalArgumentException; void setPower(int power) throws IllegalArgumentException;

View File

@ -87,7 +87,7 @@ public interface ItemMeta extends Cloneable, ConfigurationSerializable {
int getEnchantLevel(Enchantment ench); int getEnchantLevel(Enchantment ench);
/** /**
* Returns a copy the enchantments in this ItemMeta.<br /> * Returns a copy the enchantments in this ItemMeta. <br>
* Returns an empty map if none. * Returns an empty map if none.
* *
* @return An immutable copy of the enchantments * @return An immutable copy of the enchantments

View File

@ -166,6 +166,7 @@ public final class MapCursor {
/** /**
* *
* @return the value
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated
@ -175,6 +176,8 @@ public final class MapCursor {
/** /**
* *
* @param value the value
* @return the matching type
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated

View File

@ -135,7 +135,7 @@ public interface MapView {
/** /**
* Get a list of MapRenderers currently in effect. * Get a list of MapRenderers currently in effect.
* *
* @return A List<MapRenderer> containing each map renderer. * @return A {@code List<MapRenderer>} containing each map renderer.
*/ */
public List<MapRenderer> getRenderers(); public List<MapRenderer> getRenderers();

View File

@ -14,7 +14,7 @@ public class Banner extends MaterialData implements Attachable {
} }
/** /**
* * @param type the raw type id
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated
@ -24,6 +24,8 @@ public class Banner extends MaterialData implements Attachable {
/** /**
* *
* @param type the type
* @param data the raw data value
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated
@ -31,8 +33,9 @@ public class Banner extends MaterialData implements Attachable {
super(type, data); super(type, data);
} }
/** /** *
* * @param type the raw type id
* @param data the raw data value
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated

View File

@ -27,6 +27,7 @@ public class Bed extends MaterialData implements Directional {
/** /**
* *
* @param type the raw type id
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated
@ -39,7 +40,8 @@ public class Bed extends MaterialData implements Directional {
} }
/** /**
* * @param type the raw type id
* @param data the raw data value
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated
@ -48,7 +50,8 @@ public class Bed extends MaterialData implements Directional {
} }
/** /**
* * @param type the type
* @param data the raw data value
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated

View File

@ -12,7 +12,7 @@ public class Button extends SimpleAttachableMaterialData implements Redstone {
} }
/** /**
* * @param type the type
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated
@ -25,7 +25,8 @@ public class Button extends SimpleAttachableMaterialData implements Redstone {
} }
/** /**
* * @param type the raw type id
* @param data the raw data value
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated
@ -34,7 +35,8 @@ public class Button extends SimpleAttachableMaterialData implements Redstone {
} }
/** /**
* * @param type the type
* @param data the raw data value
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated

View File

@ -8,7 +8,7 @@ public class Cake extends MaterialData {
} }
/** /**
* * @param type the raw type id
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated
@ -21,7 +21,8 @@ public class Cake extends MaterialData {
} }
/** /**
* * @param type the raw type id
* @param data the raw data value
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated
@ -30,7 +31,8 @@ public class Cake extends MaterialData {
} }
/** /**
* * @param type the type
* @param data the raw data value
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated

View File

@ -15,6 +15,8 @@ public class Cauldron extends MaterialData {
/** /**
* *
* @param type the raw type id
* @param data the raw data value
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated
@ -24,6 +26,7 @@ public class Cauldron extends MaterialData {
/** /**
* *
* @param data the raw data value
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated

View File

@ -23,7 +23,7 @@ public class Chest extends DirectionalContainer {
} }
/** /**
* * @param type the raw type id
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated
@ -36,7 +36,8 @@ public class Chest extends DirectionalContainer {
} }
/** /**
* * @param type the raw type id
* @param data the raw data value
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated
@ -45,7 +46,8 @@ public class Chest extends DirectionalContainer {
} }
/** /**
* * @param type the type
* @param data the raw data value
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated

View File

@ -17,7 +17,7 @@ public class Coal extends MaterialData {
} }
/** /**
* * @param type the raw type id
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated
@ -30,7 +30,8 @@ public class Coal extends MaterialData {
} }
/** /**
* * @param type the raw type id
* @param data the raw data value
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated
@ -39,7 +40,8 @@ public class Coal extends MaterialData {
} }
/** /**
* * @param type the type
* @param data the raw data value
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated

View File

@ -19,7 +19,7 @@ public class CocoaPlant extends MaterialData implements Directional, Attachable
} }
/** /**
* * @param type the raw type id
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated
@ -28,7 +28,8 @@ public class CocoaPlant extends MaterialData implements Directional, Attachable
} }
/** /**
* * @param type the raw type id
* @param data the raw data value
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated

View File

@ -11,7 +11,7 @@ public class Command extends MaterialData implements Redstone {
} }
/** /**
* * @param type the raw type id
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated
@ -24,7 +24,8 @@ public class Command extends MaterialData implements Redstone {
} }
/** /**
* * @param type the raw type id
* @param data the raw data value
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated
@ -33,7 +34,8 @@ public class Command extends MaterialData implements Redstone {
} }
/** /**
* * @param type the type
* @param data the raw data value
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated

View File

@ -17,7 +17,7 @@ public class Crops extends MaterialData {
} }
/** /**
* * @param type the raw type id
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated
@ -30,7 +30,8 @@ public class Crops extends MaterialData {
} }
/** /**
* * @param type the raw type id
* @param data the raw data value
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated
@ -39,7 +40,8 @@ public class Crops extends MaterialData {
} }
/** /**
* * @param type the type
* @param data the raw data value
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated

View File

@ -11,7 +11,7 @@ public class DetectorRail extends ExtendedRails implements PressureSensor {
} }
/** /**
* * @param type the raw type id
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated
@ -24,7 +24,8 @@ public class DetectorRail extends ExtendedRails implements PressureSensor {
} }
/** /**
* * @param type the raw type id
* @param data the raw data value
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated
@ -33,7 +34,8 @@ public class DetectorRail extends ExtendedRails implements PressureSensor {
} }
/** /**
* * @param type the type
* @param data the raw data value
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated

View File

@ -9,7 +9,7 @@ public class Diode extends MaterialData implements Directional {
} }
/** /**
* * @param type the raw type id
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated
@ -22,7 +22,8 @@ public class Diode extends MaterialData implements Directional {
} }
/** /**
* * @param type the raw type id
* @param data the raw data value
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated
@ -31,7 +32,8 @@ public class Diode extends MaterialData implements Directional {
} }
/** /**
* * @param type the type
* @param data the raw data value
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated

View File

@ -8,7 +8,7 @@ import org.bukkit.block.BlockFace;
*/ */
public class DirectionalContainer extends MaterialData implements Directional { public class DirectionalContainer extends MaterialData implements Directional {
/** /**
* * @param type the raw type id
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated
@ -21,7 +21,8 @@ public class DirectionalContainer extends MaterialData implements Directional {
} }
/** /**
* * @param type the raw type id
* @param data the raw data value
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated
@ -30,7 +31,8 @@ public class DirectionalContainer extends MaterialData implements Directional {
} }
/** /**
* * @param type the type
* @param data the raw data value
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated

View File

@ -18,7 +18,7 @@ public class Dispenser extends FurnaceAndDispenser {
} }
/** /**
* * @param type the raw type id
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated
@ -31,7 +31,8 @@ public class Dispenser extends FurnaceAndDispenser {
} }
/** /**
* * @param type the raw type id
* @param data the raw data value
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated
@ -40,7 +41,8 @@ public class Dispenser extends FurnaceAndDispenser {
} }
/** /**
* * @param type the type
* @param data the raw data value
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated

View File

@ -15,7 +15,7 @@ public class Door extends MaterialData implements Directional, Openable {
} }
/** /**
* * @param type the raw type id
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated
@ -28,7 +28,8 @@ public class Door extends MaterialData implements Directional, Openable {
} }
/** /**
* * @param type the raw type id
* @param data the raw data value
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated
@ -37,7 +38,8 @@ public class Door extends MaterialData implements Directional, Openable {
} }
/** /**
* * @param type the type
* @param data the raw data value
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated

View File

@ -12,7 +12,7 @@ public class Dye extends MaterialData implements Colorable {
} }
/** /**
* * @param type the raw type id
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated
@ -25,7 +25,8 @@ public class Dye extends MaterialData implements Colorable {
} }
/** /**
* * @param type the raw type id
* @param data the raw data value
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated
@ -34,7 +35,8 @@ public class Dye extends MaterialData implements Colorable {
} }
/** /**
* * @param type the type
* @param data the raw data value
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated

View File

@ -23,7 +23,7 @@ public class EnderChest extends DirectionalContainer {
} }
/** /**
* * @param type the raw type id
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated
@ -36,7 +36,8 @@ public class EnderChest extends DirectionalContainer {
} }
/** /**
* * @param type the raw type id
* @param data the raw data value
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated
@ -45,7 +46,8 @@ public class EnderChest extends DirectionalContainer {
} }
/** /**
* * @param type the type
* @param data the raw data value
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated

View File

@ -9,7 +9,7 @@ import org.bukkit.block.BlockFace;
*/ */
public class ExtendedRails extends Rails { public class ExtendedRails extends Rails {
/** /**
* * @param type the raw type id
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated
@ -22,7 +22,8 @@ public class ExtendedRails extends Rails {
} }
/** /**
* * @param type the raw type id
* @param data the raw data value
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated
@ -31,7 +32,8 @@ public class ExtendedRails extends Rails {
} }
/** /**
* * @param type the type
* @param data the raw data value
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated

View File

@ -17,7 +17,7 @@ public class FlowerPot extends MaterialData {
} }
/** /**
* * @param type the raw type id
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated
@ -30,7 +30,8 @@ public class FlowerPot extends MaterialData {
} }
/** /**
* * @param type the raw type id
* @param data the raw data value
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated
@ -39,7 +40,8 @@ public class FlowerPot extends MaterialData {
} }
/** /**
* * @param type the type
* @param data the raw data value
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated

View File

@ -23,7 +23,7 @@ public class Furnace extends FurnaceAndDispenser {
} }
/** /**
* * @param type the raw type id
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated
@ -36,7 +36,8 @@ public class Furnace extends FurnaceAndDispenser {
} }
/** /**
* * @param type the raw type id
* @param data the raw data value
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated
@ -45,7 +46,8 @@ public class Furnace extends FurnaceAndDispenser {
} }
/** /**
* * @param type the type
* @param data the raw data value
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated

View File

@ -8,7 +8,7 @@ import org.bukkit.Material;
public class FurnaceAndDispenser extends DirectionalContainer { public class FurnaceAndDispenser extends DirectionalContainer {
/** /**
* * @param type the raw type id
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated
@ -21,7 +21,8 @@ public class FurnaceAndDispenser extends DirectionalContainer {
} }
/** /**
* * @param type the raw type id
* @param data the raw data value
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated
@ -30,7 +31,8 @@ public class FurnaceAndDispenser extends DirectionalContainer {
} }
/** /**
* * @param type the type
* @param data the raw data value
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated

View File

@ -12,7 +12,7 @@ public class Ladder extends SimpleAttachableMaterialData {
} }
/** /**
* * @param type the raw type id
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated
@ -25,7 +25,8 @@ public class Ladder extends SimpleAttachableMaterialData {
} }
/** /**
* * @param type the raw type id
* @param data the raw data value
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated
@ -34,7 +35,8 @@ public class Ladder extends SimpleAttachableMaterialData {
} }
/** /**
* * @param type the type
* @param data the raw data value
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated

View File

@ -17,7 +17,7 @@ public class Leaves extends MaterialData {
} }
/** /**
* * @param type the raw type id
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated
@ -30,7 +30,8 @@ public class Leaves extends MaterialData {
} }
/** /**
* * @param type the raw type id
* @param data the raw data value
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated
@ -39,7 +40,8 @@ public class Leaves extends MaterialData {
} }
/** /**
* * @param type the type
* @param data the raw data value
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated

View File

@ -12,7 +12,7 @@ public class Lever extends SimpleAttachableMaterialData implements Redstone {
} }
/** /**
* * @param type the raw type id
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated
@ -25,7 +25,8 @@ public class Lever extends SimpleAttachableMaterialData implements Redstone {
} }
/** /**
* * @param type the raw type id
* @param data the raw data value
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated
@ -34,7 +35,8 @@ public class Lever extends SimpleAttachableMaterialData implements Redstone {
} }
/** /**
* * @param type the type
* @param data the raw data value
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated

View File

@ -17,7 +17,7 @@ public class LongGrass extends MaterialData {
} }
/** /**
* * @param type the raw type id
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated
@ -30,7 +30,8 @@ public class LongGrass extends MaterialData {
} }
/** /**
* * @param type the raw type id
* @param data the raw data value
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated
@ -39,7 +40,8 @@ public class LongGrass extends MaterialData {
} }
/** /**
* * @param type the type
* @param data the raw data value
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated

View File

@ -11,7 +11,7 @@ public class MaterialData implements Cloneable {
private byte data = 0; private byte data = 0;
/** /**
* * @param type the raw type id
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated
@ -24,7 +24,8 @@ public class MaterialData implements Cloneable {
} }
/** /**
* * @param type the raw type id
* @param data the raw data value
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated
@ -34,7 +35,8 @@ public class MaterialData implements Cloneable {
} }
/** /**
* * @param type the type
* @param data the raw data value
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated

View File

@ -22,7 +22,7 @@ public class MonsterEggs extends TexturedMaterial {
} }
/** /**
* * @param type the raw type id
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated
@ -38,7 +38,8 @@ public class MonsterEggs extends TexturedMaterial {
} }
/** /**
* * @param type the raw type id
* @param data the raw data value
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated
@ -47,7 +48,8 @@ public class MonsterEggs extends TexturedMaterial {
} }
/** /**
* * @param type the type
* @param data the raw data value
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated

View File

@ -27,7 +27,8 @@ public class Mushroom extends MaterialData {
} }
/** /**
* * @param shroom the type
* @param data the raw data value
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated
@ -37,7 +38,8 @@ public class Mushroom extends MaterialData {
} }
/** /**
* * @param type the raw type id
* @param data the raw data value
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated

View File

@ -17,7 +17,7 @@ public class NetherWarts extends MaterialData {
} }
/** /**
* * @param type the raw type id
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated
@ -30,7 +30,8 @@ public class NetherWarts extends MaterialData {
} }
/** /**
* * @param type the raw type id
* @param data the raw data value
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated
@ -39,7 +40,8 @@ public class NetherWarts extends MaterialData {
} }
/** /**
* * @param type the type
* @param data the raw data value
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated

View File

@ -7,8 +7,11 @@ import org.bukkit.block.BlockFace;
* Material data for the piston base block * Material data for the piston base block
*/ */
public class PistonBaseMaterial extends MaterialData implements Directional, Redstone { public class PistonBaseMaterial extends MaterialData implements Directional, Redstone {
/** /**
* * Constructs a PistonBaseMaterial
*
* @param type the raw type id
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated
@ -21,7 +24,10 @@ public class PistonBaseMaterial extends MaterialData implements Directional, Red
} }
/** /**
* * Constructs a PistonBaseMaterial.
*
* @param type the raw type id
* @param data the raw data value
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated
@ -30,7 +36,10 @@ public class PistonBaseMaterial extends MaterialData implements Directional, Red
} }
/** /**
* * Constructs a PistonBaseMaterial.
*
* @param type the material type to use
* @param data the raw data value
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated
@ -38,6 +47,7 @@ public class PistonBaseMaterial extends MaterialData implements Directional, Red
super(type, data); super(type, data);
} }
@Override
public void setFacingDirection(BlockFace face) { public void setFacingDirection(BlockFace face) {
byte data = (byte) (getData() & 0x8); byte data = (byte) (getData() & 0x8);
@ -61,6 +71,7 @@ public class PistonBaseMaterial extends MaterialData implements Directional, Red
setData(data); setData(data);
} }
@Override
public BlockFace getFacing() { public BlockFace getFacing() {
byte dir = (byte) (getData() & 7); byte dir = (byte) (getData() & 7);
@ -82,6 +93,7 @@ public class PistonBaseMaterial extends MaterialData implements Directional, Red
} }
} }
@Override
public boolean isPowered() { public boolean isPowered() {
return (getData() & 0x8) == 0x8; return (getData() & 0x8) == 0x8;
} }
@ -89,7 +101,7 @@ public class PistonBaseMaterial extends MaterialData implements Directional, Red
/** /**
* Sets the current state of this piston * Sets the current state of this piston
* *
* @param powered true if the piston is extended & powered, or false * @param powered true if the piston is extended {@literal &} powered, or false
*/ */
public void setPowered(boolean powered) { public void setPowered(boolean powered) {
setData((byte) (powered ? (getData() | 0x8) : (getData() & ~0x8))); setData((byte) (powered ? (getData() | 0x8) : (getData() & ~0x8)));

View File

@ -8,7 +8,7 @@ import org.bukkit.block.BlockFace;
*/ */
public class PistonExtensionMaterial extends MaterialData implements Attachable { public class PistonExtensionMaterial extends MaterialData implements Attachable {
/** /**
* * @param type the raw type id
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated
@ -21,7 +21,8 @@ public class PistonExtensionMaterial extends MaterialData implements Attachable
} }
/** /**
* * @param type the raw type id
* @param data the raw data value
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated
@ -30,7 +31,8 @@ public class PistonExtensionMaterial extends MaterialData implements Attachable
} }
/** /**
* * @param type the type
* @param data the raw data value
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated

View File

@ -11,7 +11,7 @@ public class PoweredRail extends ExtendedRails implements Redstone {
} }
/** /**
* * @param type the raw type id
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated
@ -24,7 +24,8 @@ public class PoweredRail extends ExtendedRails implements Redstone {
} }
/** /**
* * @param type the raw type id
* @param data the raw data value
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated
@ -33,7 +34,8 @@ public class PoweredRail extends ExtendedRails implements Redstone {
} }
/** /**
* * @param type the type
* @param data the raw data value
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated

View File

@ -11,7 +11,7 @@ public class PressurePlate extends MaterialData implements PressureSensor {
} }
/** /**
* * @param type the raw type id
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated
@ -24,7 +24,8 @@ public class PressurePlate extends MaterialData implements PressureSensor {
} }
/** /**
* * @param type the raw type id
* @param data the raw data value
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated
@ -33,7 +34,8 @@ public class PressurePlate extends MaterialData implements PressureSensor {
} }
/** /**
* * @param type the type
* @param data the raw data value
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated

View File

@ -23,7 +23,7 @@ public class Pumpkin extends MaterialData implements Directional {
} }
/** /**
* * @param type the raw type id
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated
@ -36,7 +36,8 @@ public class Pumpkin extends MaterialData implements Directional {
} }
/** /**
* * @param type the raw type id
* @param data the raw data value
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated
@ -45,7 +46,8 @@ public class Pumpkin extends MaterialData implements Directional {
} }
/** /**
* * @param type the type
* @param data the raw data value
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated

View File

@ -13,7 +13,7 @@ public class Rails extends MaterialData {
} }
/** /**
* * @param type the raw type id
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated
@ -26,7 +26,8 @@ public class Rails extends MaterialData {
} }
/** /**
* * @param type the raw type id
* @param data the raw data value
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated
@ -35,7 +36,8 @@ public class Rails extends MaterialData {
} }
/** /**
* * @param type the type
* @param data the raw data value
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated

View File

@ -11,7 +11,7 @@ public class RedstoneTorch extends Torch implements Redstone {
} }
/** /**
* * @param type the raw type id
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated
@ -24,7 +24,8 @@ public class RedstoneTorch extends Torch implements Redstone {
} }
/** /**
* * @param type the raw type id
* @param data the raw data value
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated
@ -33,7 +34,8 @@ public class RedstoneTorch extends Torch implements Redstone {
} }
/** /**
* * @param type the type
* @param data the raw data value
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated

View File

@ -11,7 +11,7 @@ public class RedstoneWire extends MaterialData implements Redstone {
} }
/** /**
* * @param type the raw type id
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated
@ -24,7 +24,8 @@ public class RedstoneWire extends MaterialData implements Redstone {
} }
/** /**
* * @param type the raw type id
* @param data the raw data value
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated
@ -33,7 +34,8 @@ public class RedstoneWire extends MaterialData implements Redstone {
} }
/** /**
* * @param type the type
* @param data the raw data value
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated

View File

@ -17,7 +17,7 @@ public class Sandstone extends MaterialData {
} }
/** /**
* * @param type the raw type id
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated
@ -30,7 +30,8 @@ public class Sandstone extends MaterialData {
} }
/** /**
* * @param type the raw type id
* @param data the raw data value
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated
@ -39,7 +40,8 @@ public class Sandstone extends MaterialData {
} }
/** /**
* * @param type the type
* @param data the raw data value
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated

View File

@ -12,7 +12,7 @@ public class Sign extends MaterialData implements Attachable {
} }
/** /**
* * @param type the raw type id
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated
@ -25,7 +25,8 @@ public class Sign extends MaterialData implements Attachable {
} }
/** /**
* * @param type the raw type id
* @param data the raw data value
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated
@ -34,7 +35,8 @@ public class Sign extends MaterialData implements Attachable {
} }
/** /**
* * @param type the raw type id
* @param data the raw data value
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated

View File

@ -9,7 +9,7 @@ import org.bukkit.block.BlockFace;
public abstract class SimpleAttachableMaterialData extends MaterialData implements Attachable { public abstract class SimpleAttachableMaterialData extends MaterialData implements Attachable {
/** /**
* * @param type the raw type id
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated
@ -32,7 +32,8 @@ public abstract class SimpleAttachableMaterialData extends MaterialData implemen
} }
/** /**
* * @param type the raw type id
* @param data the raw data value
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated
@ -41,7 +42,8 @@ public abstract class SimpleAttachableMaterialData extends MaterialData implemen
} }
/** /**
* * @param type the type
* @param data the raw data value
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated

View File

@ -22,7 +22,7 @@ public class Skull extends MaterialData implements Directional {
} }
/** /**
* * @param type the raw type id
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated
@ -35,7 +35,8 @@ public class Skull extends MaterialData implements Directional {
} }
/** /**
* * @param type the raw type id
* @param data the raw data value
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated
@ -44,7 +45,8 @@ public class Skull extends MaterialData implements Directional {
} }
/** /**
* * @param type the type
* @param data the raw data value
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated

View File

@ -23,7 +23,7 @@ public class SmoothBrick extends TexturedMaterial {
} }
/** /**
* * @param type the raw type id
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated
@ -39,7 +39,8 @@ public class SmoothBrick extends TexturedMaterial {
} }
/** /**
* * @param type the raw type id
* @param data the raw data value
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated
@ -48,7 +49,8 @@ public class SmoothBrick extends TexturedMaterial {
} }
/** /**
* * @param type the type
* @param data the raw data value
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated

View File

@ -13,7 +13,8 @@ public class SpawnEgg extends MaterialData {
} }
/** /**
* * @param type the raw type id
* @param data the raw data value
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated
@ -22,7 +23,7 @@ public class SpawnEgg extends MaterialData {
} }
/** /**
* * @param data the raw data value
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated

View File

@ -9,7 +9,7 @@ import org.bukkit.block.BlockFace;
public class Stairs extends MaterialData implements Directional { public class Stairs extends MaterialData implements Directional {
/** /**
* * @param type the raw type id
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated
@ -22,7 +22,8 @@ public class Stairs extends MaterialData implements Directional {
} }
/** /**
* * @param type the raw type id
* @param data the raw data value
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated
@ -31,7 +32,8 @@ public class Stairs extends MaterialData implements Directional {
} }
/** /**
* * @param type the type
* @param data the raw data value
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated

View File

@ -26,7 +26,7 @@ public class Step extends TexturedMaterial {
} }
/** /**
* * @param type the raw type id
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated
@ -42,7 +42,8 @@ public class Step extends TexturedMaterial {
} }
/** /**
* * @param type the raw type id
* @param data the raw data value
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated
@ -51,7 +52,8 @@ public class Step extends TexturedMaterial {
} }
/** /**
* * @param type the type
* @param data the raw data value
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated

View File

@ -14,7 +14,7 @@ public abstract class TexturedMaterial extends MaterialData {
} }
/** /**
* * @param type the raw type id
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated
@ -23,7 +23,8 @@ public abstract class TexturedMaterial extends MaterialData {
} }
/** /**
* * @param type the raw type id
* @param data the raw data value
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated
@ -32,7 +33,8 @@ public abstract class TexturedMaterial extends MaterialData {
} }
/** /**
* * @param type the type
* @param data the raw data value
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated

View File

@ -12,7 +12,7 @@ public class Torch extends SimpleAttachableMaterialData {
} }
/** /**
* * @param type the raw type id
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated
@ -25,7 +25,8 @@ public class Torch extends SimpleAttachableMaterialData {
} }
/** /**
* * @param type the raw type id
* @param data the raw data value
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated
@ -34,7 +35,8 @@ public class Torch extends SimpleAttachableMaterialData {
} }
/** /**
* * @param type the type
* @param data the raw data value
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated

View File

@ -12,7 +12,7 @@ public class TrapDoor extends SimpleAttachableMaterialData implements Openable {
} }
/** /**
* * @param type the raw type id
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated
@ -25,7 +25,8 @@ public class TrapDoor extends SimpleAttachableMaterialData implements Openable {
} }
/** /**
* * @param type the raw type id
* @param data the raw data value
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated
@ -34,7 +35,8 @@ public class TrapDoor extends SimpleAttachableMaterialData implements Openable {
} }
/** /**
* * @param type the type
* @param data the raw data value
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated

View File

@ -24,7 +24,7 @@ public class Tree extends MaterialData {
} }
/** /**
* * @param type the raw type id
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated
@ -37,7 +37,8 @@ public class Tree extends MaterialData {
} }
/** /**
* * @param type the raw type id
* @param data the raw data value
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated
@ -46,7 +47,8 @@ public class Tree extends MaterialData {
} }
/** /**
* * @param type the type
* @param data the raw data value
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated

View File

@ -12,7 +12,7 @@ public class Tripwire extends MaterialData {
} }
/** /**
* * @param type the raw type id
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated
@ -21,7 +21,8 @@ public class Tripwire extends MaterialData {
} }
/** /**
* * @param type the raw type id
* @param data the raw data value
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated

View File

@ -13,7 +13,7 @@ public class TripwireHook extends SimpleAttachableMaterialData implements Redsto
} }
/** /**
* * @param type the raw type id
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated
@ -22,7 +22,8 @@ public class TripwireHook extends SimpleAttachableMaterialData implements Redsto
} }
/** /**
* * @param type the raw type id
* @param data the raw data value
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated

View File

@ -21,7 +21,8 @@ public class Vine extends MaterialData {
} }
/** /**
* * @param type the raw type id
* @param data the raw data value
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated
@ -30,7 +31,7 @@ public class Vine extends MaterialData {
} }
/** /**
* * @param data the raw data value
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated

View File

@ -13,7 +13,7 @@ public class WoodenStep extends MaterialData {
} }
/** /**
* * @param type the raw type id
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated
@ -33,7 +33,8 @@ public class WoodenStep extends MaterialData {
} }
/** /**
* * @param type the raw type id
* @param data the raw data value
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated
@ -42,7 +43,8 @@ public class WoodenStep extends MaterialData {
} }
/** /**
* * @param type the type
* @param data the raw data value
* @deprecated Magic value * @deprecated Magic value
*/ */
@Deprecated @Deprecated

Some files were not shown because too many files have changed in this diff Show More