Record Class LocatedBlock

java.lang.Object
java.lang.Record
com.sk89q.worldedit.util.LocatedBlock

public record LocatedBlock(BlockVector3 location, BaseBlock block) extends Record
Represents a block located at some position.
  • Constructor Summary

    Constructors
    Constructor
    Description
    Creates an instance of a LocatedBlock record class.
  • Method Summary

    Modifier and Type
    Method
    Description
    Returns the value of the block record component.
    final boolean
    Indicates whether some other object is "equal to" this one.
    Deprecated, for removal: This API element is subject to removal in a future version.
    This class is now a record.
    Deprecated, for removal: This API element is subject to removal in a future version.
    This class is now a record.
    final int
    Returns a hash code value for this object.
    Returns the value of the location record component.
    final String
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait
  • Constructor Details

    • LocatedBlock

      public LocatedBlock(BlockVector3 location, BaseBlock block)
      Creates an instance of a LocatedBlock record class.
      Parameters:
      location - the value for the location record component
      block - the value for the block record component
  • Method Details

    • getLocation

      @Deprecated(forRemoval=true, since="2.11.0") public BlockVector3 getLocation()
      Deprecated, for removal: This API element is subject to removal in a future version.
      This class is now a record. Use location() instead.
      Gets the location.
      Returns:
      The location
    • getBlock

      @Deprecated(forRemoval=true, since="2.11.0") public BaseBlock getBlock()
      Deprecated, for removal: This API element is subject to removal in a future version.
      This class is now a record. Use block() instead.
      Gets the block.
      Returns:
      The block
    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object
    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object
    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.
    • location

      public BlockVector3 location()
      Returns the value of the location record component.
      Returns:
      the value of the location record component
    • block

      public BaseBlock block()
      Returns the value of the block record component.
      Returns:
      the value of the block record component