Package s2.types

Record Class BasinInfo

java.lang.Object
java.lang.Record
s2.types.BasinInfo
public record BasinInfo(String name, String scope, String cell, BasinState state) extends Record

  • Constructor Summary

    Constructors
    Constructor
    Description
    BasinInfo(String name, String scope, String cell, BasinState state)
    Creates an instance of a BasinInfo record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    cell()
    Returns the value of the cell record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    static BasinInfo
    fromProto(s2.v1alpha.BasinInfo basinInfo)
     
    final int
    hashCode()
    Returns a hash code value for this object.
    String
    name()
    Returns the value of the name record component.
    String
    scope()
    Returns the value of the scope record component.
    BasinState
    state()
    Returns the value of the state 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

    • BasinInfo

      public BasinInfo(String name, String scope, String cell, BasinState state)
      Creates an instance of a BasinInfo record class.
      Parameters:
      name - the value for the name record component
      scope - the value for the scope record component
      cell - the value for the cell record component
      state - the value for the state record component

  • Method Details

    • fromProto

      public static BasinInfo fromProto(s2.v1alpha.BasinInfo basinInfo)

    • 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

    • scope

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

    • cell

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

    • state

      public BasinState state()
      Returns the value of the state record component.
      Returns:
      the value of the state record component