Package io.karatelabs.driver

Class DriverApi

java.lang.Object

io.karatelabs.driver.DriverApi

public class DriverApi
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ABOVE
static final String	ACTIVATE
static final String	ATTRIBUTE
static final String	BACK
static final String	BELOW
static final List<String>	BOUND_METHODS
static final String	CLEAR
static final String	CLEAR_COOKIES
static final String	CLICK
static final String	CLOSE
static final String	COOKIE
static final String	COOKIES
static final String	COOKIES_SET
static final String	DELETE_COOKIE
static final String	DIALOG
static final String	DIALOG_TEXT
static final String	DIMENSIONS
static final String	ENABLED
static final String	EXISTS
static final String	FOCUS
static final String	FORWARD
static final String	FULLSCREEN
static final String	GET_PAGES
static final String	HIGHLIGHT
static final String	HIGHLIGHT_ALL
static final String	HTML
static final String	INPUT
static final String	INPUT_FILE
static final String	INTERCEPT
static final String	KEYS
static final String	LEFT_OF
static final String	LOCATE
static final String	LOCATE_ALL
static final String	MAXIMIZE
static final String	MINIMIZE
static final String	MOUSE
static final String	NEAR
static final String	ON_DIALOG
static final String	OPTIONAL
static final String	PDF
static final String	POSITION
static final String	PROPERTY
static final String	QUIT
static final String	REFRESH
static final String	RELOAD
static final String	RETRY
static final String	RIGHT_OF
static final String	SCREENSHOT
static final String	SCRIPT
static final String	SCRIPT_ALL
static final String	SCROLL
static final String	SELECT
static final String	SUBMIT
static final String	SWITCH_FRAME
static final String	SWITCH_PAGE
static final String	TEXT
static final String	TIMEOUT
static final String	TITLE
static final String	URL
static final String	VALUE
static final String	WAIT_FOR
static final String	WAIT_FOR_ANY
static final String	WAIT_FOR_ENABLED
static final String	WAIT_FOR_RESULT_COUNT
static final String	WAIT_FOR_TEXT
static final String	WAIT_FOR_URL
static final String	WAIT_UNTIL

Constructor Summary

Constructors

Constructor	Description
DriverApi()

Method Summary

Modifier and Type	Method	Description
static Supplier<Object>	asSupplier(Object arg, io.karatelabs.js.Context ctx)	Adapt a JS/Java callable argument to a Supplier<Object>.
static void	bindJsHelpers(io.karatelabs.js.Engine engine, Driver driver)	Bind driver action methods as global functions.
static List<String>	resolveFilePaths(String... refs)	Resolve file-path references for Driver.inputFile(String, String...) to absolute OS paths, using the SAME rule as read(): a bare path is relative to the calling feature's dir, a leading / anchors the project root, classpath: is classloader-first with a root fallback, and this: is the feature's dir.

Methods inherited from class java.lang.Object

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

Field Details

CLICK

public static final String CLICK

See Also:

• Constant Field Values

INPUT

public static final String INPUT

See Also:

• Constant Field Values

INPUT_FILE

public static final String INPUT_FILE

See Also:

• Constant Field Values

CLEAR

public static final String CLEAR

See Also:

• Constant Field Values

FOCUS

public static final String FOCUS

See Also:

• Constant Field Values

SCROLL

public static final String SCROLL

See Also:

• Constant Field Values

HIGHLIGHT

public static final String HIGHLIGHT

See Also:

• Constant Field Values

HIGHLIGHT_ALL

public static final String HIGHLIGHT_ALL

See Also:

• Constant Field Values

SELECT

public static final String SELECT

See Also:

• Constant Field Values

SUBMIT

public static final String SUBMIT

See Also:

• Constant Field Values

TEXT

public static final String TEXT

See Also:

• Constant Field Values

HTML

public static final String HTML

See Also:

• Constant Field Values

VALUE

public static final String VALUE

See Also:

• Constant Field Values

ATTRIBUTE

public static final String ATTRIBUTE

See Also:

• Constant Field Values

PROPERTY

public static final String PROPERTY

See Also:

• Constant Field Values

EXISTS

public static final String EXISTS

See Also:

• Constant Field Values

ENABLED

public static final String ENABLED

See Also:

• Constant Field Values

POSITION

public static final String POSITION

See Also:

• Constant Field Values

LOCATE

public static final String LOCATE

See Also:

• Constant Field Values

LOCATE_ALL

public static final String LOCATE_ALL

See Also:

• Constant Field Values

OPTIONAL

public static final String OPTIONAL

See Also:

• Constant Field Values

WAIT_FOR

public static final String WAIT_FOR

See Also:

• Constant Field Values

WAIT_FOR_ANY

public static final String WAIT_FOR_ANY

See Also:

• Constant Field Values

WAIT_FOR_TEXT

public static final String WAIT_FOR_TEXT

See Also:

• Constant Field Values

WAIT_FOR_ENABLED

public static final String WAIT_FOR_ENABLED

See Also:

• Constant Field Values

WAIT_FOR_URL

public static final String WAIT_FOR_URL

See Also:

• Constant Field Values

WAIT_UNTIL

public static final String WAIT_UNTIL

See Also:

• Constant Field Values

WAIT_FOR_RESULT_COUNT

public static final String WAIT_FOR_RESULT_COUNT

See Also:

• Constant Field Values

SWITCH_FRAME

public static final String SWITCH_FRAME

See Also:

• Constant Field Values

SWITCH_PAGE

public static final String SWITCH_PAGE

See Also:

• Constant Field Values

GET_PAGES

public static final String GET_PAGES

See Also:

• Constant Field Values

SCRIPT

public static final String SCRIPT

See Also:

• Constant Field Values

SCRIPT_ALL

public static final String SCRIPT_ALL

See Also:

• Constant Field Values

REFRESH

public static final String REFRESH

See Also:

• Constant Field Values

RELOAD

public static final String RELOAD

See Also:

• Constant Field Values

BACK

public static final String BACK

See Also:

• Constant Field Values

FORWARD

public static final String FORWARD

See Also:

• Constant Field Values

MAXIMIZE

public static final String MAXIMIZE

See Also:

• Constant Field Values

MINIMIZE

public static final String MINIMIZE

See Also:

• Constant Field Values

FULLSCREEN

public static final String FULLSCREEN

See Also:

• Constant Field Values

ACTIVATE

public static final String ACTIVATE

See Also:

• Constant Field Values

CLOSE

public static final String CLOSE

See Also:

• Constant Field Values

QUIT

public static final String QUIT

See Also:

• Constant Field Values

SCREENSHOT

public static final String SCREENSHOT

See Also:

• Constant Field Values

PDF

public static final String PDF

See Also:

• Constant Field Values

COOKIE

public static final String COOKIE

See Also:

• Constant Field Values

COOKIES_SET

public static final String COOKIES_SET

See Also:

• Constant Field Values

CLEAR_COOKIES

public static final String CLEAR_COOKIES

See Also:

• Constant Field Values

DELETE_COOKIE

public static final String DELETE_COOKIE

See Also:

• Constant Field Values

INTERCEPT

public static final String INTERCEPT

See Also:

• Constant Field Values

DIALOG

public static final String DIALOG

See Also:

• Constant Field Values

ON_DIALOG

public static final String ON_DIALOG

See Also:

• Constant Field Values

DIALOG_TEXT

public static final String DIALOG_TEXT

See Also:

• Constant Field Values

MOUSE

public static final String MOUSE

See Also:

• Constant Field Values

KEYS

public static final String KEYS

See Also:

• Constant Field Values

RIGHT_OF

public static final String RIGHT_OF

See Also:

• Constant Field Values

LEFT_OF

public static final String LEFT_OF

See Also:

• Constant Field Values

ABOVE

public static final String ABOVE

See Also:

• Constant Field Values

BELOW

public static final String BELOW

See Also:

• Constant Field Values

NEAR

public static final String NEAR

See Also:

• Constant Field Values

RETRY

public static final String RETRY

See Also:

• Constant Field Values

TIMEOUT

public static final String TIMEOUT

See Also:

• Constant Field Values

URL

public static final String URL

See Also:

• Constant Field Values

TITLE

public static final String TITLE

See Also:

• Constant Field Values

COOKIES

public static final String COOKIES

See Also:

• Constant Field Values

DIMENSIONS

public static final String DIMENSIONS

See Also:

• Constant Field Values

BOUND_METHODS

public static final List<String> BOUND_METHODS

Constructor Details

DriverApi

public DriverApi()

Method Details

resolveFilePaths

public static List<String> resolveFilePaths(String... refs)

Resolve file-path references for Driver.inputFile(String, String...) to absolute OS paths, using the SAME rule as read(): a bare path is relative to the calling feature's dir, a leading / anchors the project root, classpath: is classloader-first with a root fallback, and this: is the feature's dir. Outside a scenario (plain Java API use) a bare path falls back to classloader/CWD semantics.

Every resolved reference must exist as a real file on the local disk — a miss fails here, with the resolved path, rather than as an opaque browser-side error. The one exception is the file: escape hatch, which is pure path math with no existence check: with a remote browser (grid, container) the file may exist only on the machine the browser runs on, and only the user can know that.

asSupplier

public static Supplier<Object> asSupplier(Object arg,
 io.karatelabs.js.Context ctx)

Adapt a JS/Java callable argument to a Supplier<Object>.

Karate treats inline JS lambdas as first-class Java callables — the same pattern that powers karate.filter(list, x => ...). This helper lets driver bindings route a callable argument to the Supplier-taking overload of a method (polled locally in karate-js) rather than coercing it to a string and shipping it off to the browser, where its karate-js scope wouldn't exist.

Returns:

a Supplier wrapping the callable, or null when the argument is not a recognised callable (caller should fall through to the String overload).

bindJsHelpers

public static void bindJsHelpers(io.karatelabs.js.Engine engine,
 Driver driver)

Bind driver action methods as global functions. This allows writing `* click('#button')` instead of `* driver.click('#button')`. Reuses JavaCallables from Driver.jsGet() for consistency.