org.robotframework

## Class RobotFramework

- java.lang.Object
- - org.robotframework.RobotFramework

-     public class RobotFramework
      extends java.lang.Object

  Entry point for using Robot Framework from Java programs.

- - ### Constructor Summary

    Constructors
    Constructor and Description
    `RobotFramework()`

  - ### Method Summary

    All Methods Static Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `static void` | `main(java.lang.String[] args)` Entry point when used as a main program.
    `static int` | `run(java.lang.String[] args)` Runs Robot Framework.

    - ### Methods inherited from class java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### Constructor Detail

    - #### RobotFramework

          public RobotFramework()

  - ### Method Detail

    - #### main

          public static void main(java.lang.String[] args)

      Entry point when used as a main program. Uses `run(java.lang.String[])` to run Robot Framework and calls `System.exit(int)` with the return code.
      Parameters:
        `args` - The command line options, passed to `run`.

    - #### run

          public static int run(java.lang.String[] args)

      Runs Robot Framework.

      The default action is to run tests, but it is also possible to use other RF functionality by giving a command as a first value in `args`. The available commands are

      - rebot
      - libdoc
      - tidy
      - testdoc

      Example usages:
      `run(new String[] {"--outputdir", "/tmp", "tests.robot"})`
      `run(new String[] {"libdoc", "MyLibrary", "mydoc.html"})`

      Parameters:
        `args` - The command line options to Robot Framework.
      Returns:
        Robot Framework return code. See Robot Framework User Guide for meaning of different return codes.