Package com.stardevllc.starhomes

Record Class StarHomes.RenameHomeInfo

java.lang.Object
java.lang.Record
com.stardevllc.starhomes.StarHomes.RenameHomeInfo
Record Components:
home - The home that was renamed (This is present if the event cancelled and success status are the ones)
oldName - The old name (This may not be the direct name provided, it is replaced with the actual name if a home is found)
newName - The new name
status - The status of the action
Enclosing class:
StarHomes
public static record StarHomes.RenameHomeInfo(Optional<Home> home, String oldName, String newName, StarHomes.RenameHomeStatus status) extends Record
Record for the information relatled to renaming a home

  • Constructor Details

    • RenameHomeInfo

      public RenameHomeInfo(Optional<Home> home, String oldName, String newName, StarHomes.RenameHomeStatus status)
      Creates an instance of a RenameHomeInfo record class.
      Parameters:
      home - the value for the home record component
      oldName - the value for the oldName record component
      newName - the value for the newName record component
      status - the value for the status 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. 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.

    • home

      public Optional<Home> home()
      Returns the value of the home record component.
      Returns:
      the value of the home record component

    • oldName

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

    • newName

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

    • status

      public StarHomes.RenameHomeStatus status()
      Returns the value of the status record component.
      Returns:
      the value of the status record component