Record Class HelperMethod

java.lang.Object
java.lang.Record
dev.langchain4j.agentic.internal.HelperMethod
Record Components:
method - the annotated method
target - the helper object declaring the method, or null for a static method
public record HelperMethod(Method method, Object target) extends Record
A helper method of a declarative agent, with the object it is invoked on: a static method of the agent type, whose target is null, or an instance method of a helper object.

  • Constructor Details

    • HelperMethod

      public HelperMethod(Method method, Object target)
      Creates an instance of a HelperMethod record class.
      Parameters:
      method - the value for the method record component
      target - the value for the target record component

  • Method Details

    • ofStatic

      public static HelperMethod ofStatic(Method method)

    • isStatic

      public boolean isStatic()

    • invoke

      public <T> T invoke(Object... args)
      Invokes the method on its target with the given arguments. Reflective failures, including the exception thrown by the method itself, are reported wrapped in a RuntimeException.

    • describe

      public String describe()
      Returns:
      a description of the method for error messages, with the class of its helper object when it has one

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

    • method

      public Method method()
      Returns the value of the method record component.
      Returns:
      the value of the method record component

    • target

      public Object target()
      Returns the value of the target record component.
      Returns:
      the value of the target record component