Record Class Link

java.lang.Object
java.lang.Record
io.github.protasm.jvmud.engine.world.Link
public record Link(String action, Place origin, Place destination, boolean visible) extends Record
A navigable relationship from one place to another place. Entities are not link endpoints.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Link(String action, Place origin, Place destination, boolean visible)
    Creates an instance of a Link record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    action()
    Returns the value of the action record component.
    Place
    destination()
    Returns the value of the destination record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    Place
    origin()
    Returns the value of the origin record component.
    final String
    toString()
    Returns a string representation of this record class.
    boolean
    visible()
    Returns the value of the visible record component.

    Methods inherited from class Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • Link

      public Link(String action, Place origin, Place destination, boolean visible)
      Creates an instance of a Link record class.
      Parameters:
      action - the value for the action record component
      origin - the value for the origin record component
      destination - the value for the destination record component
      visible - the value for the visible record component

  • Method Details

    • 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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.
      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.

    • action

      public String action()
      Returns the value of the action record component.
      Returns:
      the value of the action record component

    • origin

      public Place origin()
      Returns the value of the origin record component.
      Returns:
      the value of the origin record component

    • destination

      public Place destination()
      Returns the value of the destination record component.
      Returns:
      the value of the destination record component

    • visible

      public boolean visible()
      Returns the value of the visible record component.
      Returns:
      the value of the visible record component