Package com.patelheet.capitalengine.api

Record Class PolicyStatus

java.lang.Object
java.lang.Record
com.patelheet.capitalengine.api.PolicyStatus
Record Components:
issueRemainingToday - coins it may still create today
treasuryRemainingToday - coins it may still take from the Treasury today
denied - the owner has denied this plugin from moving money without a counterparty
public record PolicyStatus(long issueRemainingToday, long treasuryRemainingToday, boolean denied) extends Record
A plugin's remaining owner-set limits today. Long.MAX_VALUE means unlimited.

  • Constructor Details

    • PolicyStatus

      public PolicyStatus(long issueRemainingToday, long treasuryRemainingToday, boolean denied)
      Creates an instance of a PolicyStatus record class.
      Parameters:
      issueRemainingToday - the value for the issueRemainingToday record component
      treasuryRemainingToday - the value for the treasuryRemainingToday record component
      denied - the value for the denied 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 '=='.
      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.

    • issueRemainingToday

      public long issueRemainingToday()
      Returns the value of the issueRemainingToday record component.
      Returns:
      the value of the issueRemainingToday record component

    • treasuryRemainingToday

      public long treasuryRemainingToday()
      Returns the value of the treasuryRemainingToday record component.
      Returns:
      the value of the treasuryRemainingToday record component

    • denied

      public boolean denied()
      Returns the value of the denied record component.
      Returns:
      the value of the denied record component