More API cleanup. ICarvableVariation no longer extends Comparable.

This commit is contained in:
tterrag1098 committed 2015-01-15 06:20:22 -05:00
1 parent a110c4e8ef
commit 4bcaa62ca7
5 files changed
+19 -20

No files matched your search

@@ -2,6 +2,14 @@ package com.cricketcraft.chisel.api.carving;
import java.util.List;
/**
* Represents a group of chiselable blocks.
* <p>
* This is an object that contains a collection of {@link ICarvingVariation} objects, and keeps them sorted. You may sort them in any way (or not at all), and {@link ICarvingVariation#getOrder()} will
* likely be of use to do so.
* <p>
* It also defines what sound and oredict name the group as a whole has.
*/
public interface ICarvingGroup {
/**
@@ -5,11 +5,8 @@ import net.minecraft.item.Item;
/**
* Represents a variation of a chiselable block.
* <p>
* Do note that while this interface extends {@link Comparable}, a default implementation of {@link Comparable#compareTo(Object)} is provided in
* {@link CarvingUtils#compare(ICarvingVariation, ICarvingVariation)}
*/
public interface ICarvingVariation extends Comparable<ICarvingVariation> {
public interface ICarvingVariation {
/**
* The base block of this variation.
@@ -33,10 +30,9 @@ public interface ICarvingVariation extends Comparable<ICarvingVariation> {
int getItemMeta();
/**
* The "order" of this variation. Represents its position in the list of variations.
* The "order" of this variation. Represents its position in the list of variations held by a group.
*
* @return An integer to represent the position of this variation in the list of all variations in the group
*/
int getOrder();
}