Package com.tnsai.coordination.resources

Record Class BudgetAllocation.Budget

java.lang.Object
java.lang.Record
com.tnsai.coordination.resources.BudgetAllocation.Budget
Record Components:
name - the budget name
allocated - total amount allocated
consumed - amount consumed so far
unit - the unit of measurement (e.g., "tokens", "calls", "seconds")
Enclosing class:
BudgetAllocation
public static record BudgetAllocation.Budget(String name, double allocated, double consumed, String unit) extends Record
A named resource budget.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Budget(String name, double allocated, double consumed, String unit)
    Creates a Budget with validation.

  • Method Summary

    Modifier and Type
    Method
    Description
    double
    allocated()
    Returns the value of the allocated record component.
    double
    consumed()
    Returns the value of the consumed record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    boolean
    isExhausted()
    Checks if this budget is fully consumed.
    String
    name()
    Returns the value of the name record component.
    double
    remaining()
    Returns the remaining amount in this budget.
    final String
    toString()
    Returns a string representation of this record class.
    String
    unit()
    Returns the value of the unit record component.
    double
    utilizationPercent()
    Returns the utilization percentage (0-100).

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • Budget

      public Budget(String name, double allocated, double consumed, String unit)
      Creates a Budget with validation.

  • Method Details

    • remaining

      public double remaining()
      Returns the remaining amount in this budget.
      Returns:
      remaining = allocated - consumed

    • utilizationPercent

      public double utilizationPercent()
      Returns the utilization percentage (0-100).
      Returns:
      utilization as a percentage

    • isExhausted

      public boolean isExhausted()
      Checks if this budget is fully consumed.
      Returns:
      true if consumed >= allocated

    • 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. Reference components are compared with Objects::equals(Object,Object); primitive components 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.

    • name

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

    • allocated

      public double allocated()
      Returns the value of the allocated record component.
      Returns:
      the value of the allocated record component

    • consumed

      public double consumed()
      Returns the value of the consumed record component.
      Returns:
      the value of the consumed record component

    • unit

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