Package org.spongepowered.api.util

Interface Cycleable<T extends Cycleable<T>>

  • Type Parameters:
    T - The type of cycleable for type reference
    All Known Subinterfaces:
    DoorHinge, NotePitch, RailDirection
    All Known Implementing Classes:
    Axis
    public interface Cycleable<T extends Cycleable<T>>
    Represents a type of Enum or pseudo enum, that can be "cycled" for the "next" value. The uses are varying, but usually related to cycling BlockStates. Note that Cycleable is NOT intended to cycle between "types" that have no particular ordering, such as DyeColor, etc. due to their non-ordered nature. Applying an ordering on such types is not recommended as there is no logic to a particular ordering, except that of which they are registered.

    • Method Detail

      • cycleNext

        T cycleNext()
        Gets the "next" Cycleable instance to be considered for cycling.
        Returns:
        The next value