Complete javadocs for all DataManipulators. Add getters for guaranteed

DataManipulators with entities.

Signed-off-by: Gabriel Harris-Rouquette <[email protected]>

Author: gabizou

src/main/java/org/spongepowered/api/CatalogTypes.java

@@ -38,7 +38,7 @@
 import org.spongepowered.api.data.types.Comparison;
 import org.spongepowered.api.data.types.CookedFish;
 import org.spongepowered.api.data.types.DirtType;
-import org.spongepowered.api.data.types.DisgusedBlockType;
+import org.spongepowered.api.data.types.DisguisedBlockType;
 import org.spongepowered.api.data.types.DoubleSizePlantType;
 import org.spongepowered.api.data.types.DyeColor;
 import org.spongepowered.api.data.types.Fish;
@@ -88,7 +88,6 @@
 import org.spongepowered.api.text.chat.ChatType;
 import org.spongepowered.api.text.format.TextColor;
 import org.spongepowered.api.text.selector.SelectorType;
-import org.spongepowered.api.text.translation.Translation;
 import org.spongepowered.api.util.rotation.Rotation;
 import org.spongepowered.api.world.DimensionType;
 import org.spongepowered.api.world.GeneratorType;
@@ -122,7 +121,7 @@ public final class CatalogTypes {
     public static final Class<Difficulty> DIFFICULTY = Difficulty.class;
     public static final Class<DimensionType> DIMENSION_TYPE = DimensionType.class;
     public static final Class<DirtType> DIRT_TYPE = DirtType.class;
-    public static final Class<DisgusedBlockType> DISGUSED_BLOCK_TYPE = DisgusedBlockType.class;
+    public static final Class<DisguisedBlockType> DISGUSED_BLOCK_TYPE = DisguisedBlockType.class;
     public static final Class<DoubleSizePlantType> DOUBLE_SIZE_PLANT_TYPE = DoubleSizePlantType.class;
     public static final Class<DyeColor> DYE_COLOR = DyeColor.class;
     public static final Class<Enchantment> ENCHANTMENT = Enchantment.class;

src/main/java/org/spongepowered/api/block/tile/Jukebox.java

@@ -24,7 +24,7 @@
  */
 package org.spongepowered.api.block.tile;
 
-import org.spongepowered.api.data.manipulators.entities.RepresentedItemData;
+import org.spongepowered.api.data.manipulators.RepresentedItemData;
 import org.spongepowered.api.item.inventory.ItemStack;
 
 /**

src/main/java/org/spongepowered/api/block/tile/MobSpawner.java

@@ -24,6 +24,8 @@
  */
 package org.spongepowered.api.block.tile;
 
+import org.spongepowered.api.data.manipulators.MobSpawnerData;
+
 /**
  * Represents a Monster Spawner.
  */
@@ -39,4 +41,11 @@ public interface MobSpawner extends TileEntity {
      */
     void spawnEntityBatchImmediately(boolean force);
 
+    /**
+     * Gets a copy of the currently used {@link MobSpawnerData} for this mob spawner.
+     *
+     * @return A copy of the mob spawner data
+     */
+    MobSpawnerData getSpawnerData();
+
 }

src/main/java/org/spongepowered/api/block/tile/Note.java

@@ -40,4 +40,11 @@ public interface Note extends TileEntity {
      */
     void playNote();
 
+    /**
+     * Gets a copy of the currently used {@link NoteData}.
+     *
+     * @return The currently used note data
+     */
+    NoteData getNoteData();
+
 }

src/main/java/org/spongepowered/api/block/tile/Sign.java

@@ -24,9 +24,18 @@
  */
 package org.spongepowered.api.block.tile;
 
+import org.spongepowered.api.data.manipulators.tileentities.SignData;
+
 /**
  * Represents a sign.
  */
 public interface Sign extends TileEntity {
 
+    /**
+     * Gets a copy of the currently used {@link SignData}.
+     *
+     * @return A copy of the currently used sign data
+     */
+    SignData getSignData();
+
 }

src/main/java/org/spongepowered/api/data/manipulators/DisplayNameData.java

@@ -54,4 +54,18 @@ public interface DisplayNameData extends SingleValueData<Text, DisplayNameData>
      */
     void setDisplayName(Text displayName);
 
+    /**
+     * Returns whether the custom name is visible to players.
+     *
+     * @return Whether the custom name is visible or not
+     */
+    boolean isCustomNameVisible();
+
+    /**
+     * Sets whether the custom name is visible to players.
+     *
+     * @param visible Whether the custom name is visible
+     */
+    void setCustomNameVisible(boolean visible);
+
 }

src/main/java/org/spongepowered/api/data/manipulators/DyeableData.java

@@ -24,8 +24,18 @@
  */
 package org.spongepowered.api.data.manipulators;
 
+import org.spongepowered.api.block.BlockTypes;
+import org.spongepowered.api.data.DataHolder;
 import org.spongepowered.api.data.types.DyeColor;
+import org.spongepowered.api.entity.living.animal.Sheep;
+import org.spongepowered.api.entity.living.animal.Wolf;
+import org.spongepowered.api.item.ItemTypes;
 
+/**
+ * Signifies that a {@link DataHolder} can be "dyed" a specific
+ * {@link DyeColor}. Usually applicable to {@link BlockTypes#WOOL},
+ * {@link Sheep}, {@link Wolf} collars, and {@link ItemTypes#DYE}, etc.
+ */
 public interface DyeableData extends SingleValueData<DyeColor, DyeableData> {
 
 }

src/main/java/org/spongepowered/api/data/manipulators/IntData.java

@@ -24,6 +24,11 @@
  */
 package org.spongepowered.api.data.manipulators;
 
+/**
+ * Represents an abstract {@link SingleValueData} that has an int value.
+ *
+ * @param <T> The type of implementing data
+ */
 public interface IntData<T extends IntData<T>> extends SingleValueData<Integer, T> {
 
     /**

src/main/java/org/spongepowered/api/data/manipulators/PotionEffectData.java

@@ -24,12 +24,21 @@
  */
 package org.spongepowered.api.data.manipulators;
 
+import org.spongepowered.api.data.DataHolder;
+import org.spongepowered.api.entity.Entity;
+import org.spongepowered.api.item.ItemTypes;
+import org.spongepowered.api.item.inventory.ItemStack;
 import org.spongepowered.api.potion.PotionEffect;
 import org.spongepowered.api.potion.PotionEffectType;
 
 import java.util.Collection;
 import java.util.List;
 
+/**
+ * Represents a {@link List} of {@link PotionEffect}s that can be applicable to
+ * various {@link DataHolder}s such as {@link Entity}s, {@link ItemStack}s as
+ * {@link ItemTypes#POTION}, etc.
+ */
 public interface PotionEffectData extends ListData<PotionEffect, PotionEffectData> {
 
     /**

…lators/entities/RepresentedItemData.java …ta/manipulators/RepresentedItemData.javasrc/main/java/org/spongepowered/api/data/manipulators/entities/RepresentedItemData.java renamed to src/main/java/org/spongepowered/api/data/manipulators/RepresentedItemData.java src/main/java/org/spongepowered/api/data/manipulators/entities/RepresentedItemData.java renamed to src/main/java/org/spongepowered/api/data/manipulators/RepresentedItemData.java

@@ -22,17 +22,17 @@
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  * THE SOFTWARE.
  */
-package org.spongepowered.api.data.manipulators.entities;
+package org.spongepowered.api.data.manipulators;
 
-import org.spongepowered.api.block.tile.FlowerPot;
-import org.spongepowered.api.block.tile.Jukebox;
-import org.spongepowered.api.block.tile.TileEntity;
-import org.spongepowered.api.data.manipulators.SingleValueData;
+import org.spongepowered.api.entity.Entity;
+import org.spongepowered.api.entity.Item;
+import org.spongepowered.api.entity.hanging.ItemFrame;
 import org.spongepowered.api.item.inventory.ItemStack;
 
 /**
- * Represents a {@link TileEntity} that acts on an {@link ItemStack}.
- * Usually applicable to {@link Jukebox}es and {@link FlowerPot}s.
+ * Represents an {@link ItemStack} being "represented" graphically by an
+ * {@link Entity}. Usually applicable to {@link Item}s, {@link ItemFrame}s,
+ * etc.
  */
 public interface RepresentedItemData extends SingleValueData<ItemStack, RepresentedItemData> {