Interface Flip

All Superinterfaces:
Shiftable<Flip>, ValueProvider<Flip>
public interface Flip extends Shiftable<Flip>
Represents a flip of a schematic.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final Flip
    EAST_WEST
    A Flip from east to west.
    static final Flip
    NONE
    No flip.
    static final Flip
    NORTH_SOUTH
    A flip from north to south.
    static final Flip
    UP_DOWN
    A flip from up to down.

  • Method Summary

    Modifier and Type
    Method
    Description
    String[]
    alias()
    Alias which is used for parsing only
    static Flip
    asFlip(String input)
    Parse a string to a valid flip value
    com.sk89q.worldedit.math.Vector3
    direction()
    The direction as vector
    String
    name()
    Simple name of the flip.
    default @NotNull Flip
    value()
    Get the current value
    default void
    value(@NotNull Flip value)
    Change the current value.
    static Flip
    valueOf(String input)
    Get the flip value by name of the flip.
    default Flip
    valueProvider()
    Returns a new value
    static Flip[]
    values()
    A enum like representation of all flip values.

    Methods inherited from interface Shiftable

    shift, shiftable

    Methods inherited from interface ValueProvider

    refresh

  • Field Details

    • NONE

      static final Flip NONE
      No flip.

    • EAST_WEST

      static final Flip EAST_WEST
      A Flip from east to west.

    • NORTH_SOUTH

      static final Flip NORTH_SOUTH
      A flip from north to south.

    • UP_DOWN

      static final Flip UP_DOWN
      A flip from up to down.

  • Method Details

    • values

      static Flip[] values()
      A enum like representation of all flip values.
      Returns:
      flip values

    • asFlip

      static Flip asFlip(String input) throws CommandException
      Parse a string to a valid flip value
      Parameters:
      input - string to parse
      Returns:
      flip enum value
      Throws:
      IllegalArgumentException - when the value can't be parsed.
      CommandException - when the flip type is invalid

    • valueOf

      static Flip valueOf(String input)
      Get the flip value by name of the flip.
      Parameters:
      input - input
      Returns:
      value of flip or NONE if no match was found.

    • name

      String name()
      Simple name of the flip. Can not contain spaces
      Returns:
      name

    • alias

      String[] alias()
      Alias which is used for parsing only
      Returns:
      array of aliases

    • direction

      com.sk89q.worldedit.math.Vector3 direction()
      The direction as vector
      Returns:
      direction

    • value

      default void value(@NotNull @NotNull Flip value)
      Description copied from interface: ValueProvider
      Change the current value.
      Specified by:
      value in interface ValueProvider<Flip>
      Parameters:
      value - value to set

    • value

      @NotNull default @NotNull Flip value()
      Description copied from interface: ValueProvider
      Get the current value
      Specified by:
      value in interface ValueProvider<Flip>
      Returns:
      the value

    • valueProvider

      default Flip valueProvider()
      Description copied from interface: ValueProvider
      Returns a new value
      Specified by:
      valueProvider in interface ValueProvider<Flip>
      Returns:
      new value