Package io.github.jspinak.brobot.runner.dsl.model

Class Parameter

java.lang.Object
io.github.jspinak.brobot.runner.dsl.model.Parameter
public class Parameter extends Object
Represents a parameter definition for automation functions in the Brobot DSL.

Parameters allow functions to accept input values, making them reusable and configurable. Each parameter has a name and type, which are used for validation and type checking when the function is called.

When a function is invoked, arguments are matched to parameters by position, and type compatibility is verified to ensure correct execution.

Example in JSON (as part of a function definition): 

 "parameters": [
   {"name": "elementId", "type": "string"},
   {"name": "timeout", "type": "integer"},
   {"name": "retry", "type": "boolean"}
 ]
See Also:

  • Constructor Details

    • Parameter

      public Parameter()

  • Method Details

    • getName

      public String getName()
      The name of the parameter. Used to reference the parameter value within the function body and for documentation purposes.

    • getType

      public String getType()
      The data type of the parameter. Common types include: "boolean", "string", "integer", "double", "object", "array" Used for type checking when arguments are passed to the function.

    • setName

      public void setName(String name)
      The name of the parameter. Used to reference the parameter value within the function body and for documentation purposes.

    • setType

      public void setType(String type)
      The data type of the parameter. Common types include: "boolean", "string", "integer", "double", "object", "array" Used for type checking when arguments are passed to the function.

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • canEqual

      protected boolean canEqual(Object other)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object