Package com.nsdev.lettergenerator.letter

Record Class Party

java.lang.Object
java.lang.Record
com.nsdev.lettergenerator.letter.Party
Record Components:
name - display name, nullable when organization supplies the display identity
organization - optional organization
address - optional postal address
public record Party(String name, String organization, Address address) extends Record
A sender or recipient with optional organization and address.

  • Constructor Details

    • Party

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

  • Method Details

    • of

      public static Party of(String name, Address address)
      Creates an individual party.
      Parameters:
      name - display name
      address - optional address
      Returns:
      immutable party

    • company

      public static Party company(String name, Address address)
      Creates an organization party.
      Parameters:
      name - organization name
      address - optional address
      Returns:
      immutable party

    • 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

    • organization

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

    • address

      public Address address()
      Returns the value of the address record component.
      Returns:
      the value of the address record component