Record Class CardAction.Contract

java.lang.Object
java.lang.Record
ai.badmonkey.agentspaces.api.ad.CardAction.Contract
Enclosing class:
CardAction

public static record CardAction.Contract(List<String> pre, List<String> post, String cost, List<String> methods) extends Record
The planner's view of an action (SPEC ยง6.1b, v0.1.25): pre, the situation names or conditions that must hold before the action runs (beside its consumed schemas); post, the schemas it produces and the situations it establishes (beside its produced schemas); cost, a free hint a planner orders by ("1", "low", "PT2M"); methods, the HTN method names the action belongs to (reserved for strategy B4). Each list holds at most CardAction.MAX_CONTRACT_TERMS terms.
  • Constructor Details

    • Contract

      public Contract(List<String> pre, List<String> post, String cost, List<String> methods)
      Creates an instance of a Contract record class.
      Parameters:
      pre - the value for the pre record component
      post - the value for the post record component
      cost - the value for the cost record component
      methods - the value for the methods record component
  • Method Details

    • of

      public static CardAction.Contract of(List<String> pre, List<String> post, String cost)
      Null when every term is empty, so an empty contract never reaches the wire.
    • 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.
    • pre

      public List<String> pre()
      Returns the value of the pre record component.
      Returns:
      the value of the pre record component
    • post

      public List<String> post()
      Returns the value of the post record component.
      Returns:
      the value of the post record component
    • cost

      public String cost()
      Returns the value of the cost record component.
      Returns:
      the value of the cost record component
    • methods

      public List<String> methods()
      Returns the value of the methods record component.
      Returns:
      the value of the methods record component