Package org.sgrewritten.stargate.network.portal

Record Class GlobalPortalId

java.lang.Object
java.lang.Record
org.sgrewritten.stargate.network.portal.GlobalPortalId
Record Components:
portalId -

The locally unique id of a portal

networkId -

The id of the network the portal belongs to

public record GlobalPortalId(String portalId, String networkId) extends Record
A class representing a portal's global identifier

  • Constructor Details

    • GlobalPortalId

      public GlobalPortalId(String portalId, String networkId)
      Creates an instance of a GlobalPortalId record class.
      Parameters:
      portalId - the value for the portalId record component
      networkId - the value for the networkId record component

  • Method Details

    • getFromPortal

      public static GlobalPortalId getFromPortal(Portal portal)
      Gets a global portal id from the given portal
      Parameters:
      portal -

      The portal to get the id for

      Returns:

      The portal's id

    • toString

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

    • portalId

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

    • networkId

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