Package za.co.wethinkcode.robots.shared.arguments

Record Class Args.name

java.lang.Object
java.lang.Record
za.co.wethinkcode.robots.shared.arguments.Args.name
Record Components:
name - the name of the robot
All Implemented Interfaces:
Argument<String>
Enclosing class:
Args
public static record Args.name(String name) extends Record implements Argument<String>
Record class to store the name of the robot being launched

  • Constructor Summary

    Constructors
    Constructor
    Description
    name(String name)
    Creates an instance of a name record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    String
    getValue()
    Get the value of @param
    final int
    hashCode()
    Returns a hash code value for this object.
    String
    name()
    Returns the value of the name record component.
    final String
    toString()
    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

    • name

      public name(String name)
      Creates an instance of a name record class.
      Parameters:
      name - the value for the name record component

  • Method Details

    • getValue

      public String getValue()
      Description copied from interface: Argument
      Get the value of @param
      Specified by:
      getValue in interface Argument<String>
      Returns:
      name of the robot

    • 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.

    • name

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