Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
$
- $ - Class in com.shaft.driver.internal
-
A shorthand alias for the
SHAFTclass, providing the same unified entry point to all SHAFT framework capabilities (GUI, API, CLI, DB, Validations, TestData, and Report) under a concise$identifier. - $() - Constructor for class com.shaft.driver.internal.$
-
Default constructor for the
$shorthand alias.
A
- acceptAlert() - Method in class com.shaft.gui.element.AlertActions
-
Accepts (clicks "OK" on) the currently displayed alert, confirm, or prompt dialog.
- acceptInsecureCerts() - Method in interface com.shaft.properties.internal.BrowserStack
-
Whether to accept insecure SSL certificates during test execution on BrowserStack.
- acceptInsecureCerts() - Method in interface com.shaft.properties.internal.LambdaTest
- acceptInsecureCerts(boolean) - Method in class com.shaft.properties.internal.BrowserStack.SetProperty
-
Overrides the
browserStack.acceptInsecureCertsproperty at runtime. - acceptInsecureCerts(boolean) - Method in class com.shaft.properties.internal.LambdaTest.SetProperty
- accessibility() - Method in class com.shaft.gui.browser.BrowserActions
-
Provides access to accessibility testing actions for the current browser session.
- AccessibilityActions - Class in com.shaft.validation.accessibility
-
Provides a fluent API for running automated accessibility audits against web pages using the axe-core engine via
AccessibilityHelper. - AccessibilityActions(WebDriver, BrowserActions) - Constructor for class com.shaft.validation.accessibility.AccessibilityActions
-
Constructs an
AccessibilityActionsinstance backed by the supplied rawWebDriverand the caller'sBrowserActionscontext. - AccessibilityConfig() - Constructor for class com.shaft.validation.accessibility.AccessibilityHelper.AccessibilityConfig
-
Creates a new
AccessibilityConfigwith default settings. - AccessibilityHelper - Class in com.shaft.validation.accessibility
-
Internal helper that drives WCAG-based accessibility analysis using the axe-core engine via
AxeBuilder. - AccessibilityHelper.AccessibilityConfig - Class in com.shaft.validation.accessibility
-
Mutable configuration bean for an accessibility scan with fluent-builder setters.
- AccessibilityHelper.AccessibilityResult - Class in com.shaft.validation.accessibility
-
Value object returned by
AccessibilityHelper.analyzePageAccessibilityAndSave(WebDriver, String, boolean)and its overloads, carrying the aggregated outcome of a single axe accessibility scan. - AccessibilityResult() - Constructor for class com.shaft.validation.accessibility.AccessibilityHelper.AccessibilityResult
-
Creates a new empty
AccessibilityResult. - accessKey() - Method in interface com.shaft.properties.internal.BrowserStack
-
BrowserStack access key used for authentication alongside
BrowserStack.userName(). - accessKey() - Method in interface com.shaft.properties.internal.LambdaTest
- accessKey(String) - Method in class com.shaft.properties.internal.BrowserStack.SetProperty
-
Overrides the
browserStack.accessKeyproperty at runtime. - accessKey(String) - Method in class com.shaft.properties.internal.LambdaTest.SetProperty
- accumulateHistory() - Method in interface com.shaft.properties.internal.Allure
-
Whether Allure history data should be accumulated across test runs, enabling trend graphs and historical comparison in the report.
- accumulateHistory(boolean) - Method in class com.shaft.properties.internal.Allure.SetProperty
-
Overrides the
allure.accumulateHistoryproperty at runtime. - accumulateReports() - Method in interface com.shaft.properties.internal.Allure
-
Whether generated Allure HTML report files should accumulate in the report directory rather than being replaced on each run.
- accumulateReports(boolean) - Method in class com.shaft.properties.internal.Allure.SetProperty
-
Overrides the
allure.accumulateReportsproperty at runtime. - Actions - Class in com.shaft.gui.element.internal
-
Provides a fluent API for performing low-level UI interactions on web and mobile elements.
- Actions() - Constructor for class com.shaft.gui.element.internal.Actions
-
Creates a new
Actionsinstance using the driver managed by the current thread's activeDriverFactoryHelper. - Actions(DriverFactoryHelper) - Constructor for class com.shaft.gui.element.internal.Actions
-
Creates a new
Actionsinstance backed by the givenDriverFactoryHelper, which provides access to driver configuration, synchronization settings, and screenshot utilities. - Actions(WebDriver) - Constructor for class com.shaft.gui.element.internal.Actions
-
Creates a new
Actionsinstance wrapping the givenWebDriver. - Actions(WebDriver, boolean) - Constructor for class com.shaft.gui.element.internal.Actions
-
Creates a new
Actionsinstance wrapping the givenWebDriver, with optional suppression of standard reporting output. - Actions.ClipboardAction - Class in com.shaft.gui.element.internal
-
Provides keyboard-shortcut-based clipboard operations for a target element.
- Actions.GetElementInformation - Class in com.shaft.gui.element.internal
-
Provides read-only accessors for querying properties, attributes, and state of a located web element.
- activateAppFromBackground(String) - Method in class com.shaft.gui.element.TouchActions
-
Activates an app that has been previously deactivated or sent to the background.
- ACTIVE_NETWORK_REQUESTS_COUNT - Enum constant in enum class com.shaft.tools.internal.support.JavaScriptHelper
- addCookie(String, Object) - Method in class com.shaft.api.RequestBuilder
-
Append a cookie to the current session to be used in the current and all the following requests.
- addCookie(String, String) - Method in class com.shaft.driver.SHAFT.API
- addCookie(String, String) - Method in class com.shaft.gui.browser.BrowserActions
-
Adds a cookie to the current browsing context.
- addCookies(Map) - Method in class com.shaft.api.RequestBuilder
-
Append cookies to the current session to be used in the current and all the following requests.
- addCookieVariable(String, String) - Method in class com.shaft.api.RestActions
- addHeader(String, String) - Method in class com.shaft.api.RequestBuilder
-
Append a header to the current session to be used in the current and all the following requests.
- addHeader(String, String) - Method in class com.shaft.driver.SHAFT.API
- addHeaders(Map) - Method in class com.shaft.api.RequestBuilder
-
Append headers to the current session to be used in the current and all the following requests.
- addHeaderVariable(String, String) - Method in class com.shaft.api.RestActions
-
Append a header to the current session to be used in all the following requests.
- afterAnyCall(Object, Method, Object[], Object) - Method in class com.shaft.listeners.internal.WebDriverListener
- afterBack(WebDriver.Navigation) - Method in class com.shaft.listeners.internal.WebDriverListener
- afterClose(WebDriver) - Method in class com.shaft.listeners.internal.WebDriverListener
- afterContainerStart(TestResultContainer) - Method in class com.shaft.listeners.AllureListener
- afterContainerStop(TestResultContainer) - Method in class com.shaft.listeners.AllureListener
- afterContainerUpdate(TestResultContainer) - Method in class com.shaft.listeners.AllureListener
- afterContainerWrite(TestResultContainer) - Method in class com.shaft.listeners.AllureListener
- afterFixtureStart(FixtureResult) - Method in class com.shaft.listeners.AllureListener
- afterFixtureStop(FixtureResult) - Method in class com.shaft.listeners.AllureListener
- afterFixtureUpdate(FixtureResult) - Method in class com.shaft.listeners.AllureListener
- afterForward(WebDriver.Navigation) - Method in class com.shaft.listeners.internal.WebDriverListener
- afterGet(WebDriver, String) - Method in class com.shaft.listeners.internal.WebDriverListener
- afterGetAttribute(WebElement, String, String) - Method in class com.shaft.listeners.internal.WebDriverListener
- afterGetCurrentUrl(String, WebDriver) - Method in class com.shaft.listeners.internal.WebDriverListener
- afterGetText(WebElement, String) - Method in class com.shaft.listeners.internal.WebDriverListener
- afterGetTitle(WebDriver, String) - Method in class com.shaft.listeners.internal.WebDriverListener
- afterInvocation(IInvokedMethod, ITestResult, ITestContext) - Method in class com.shaft.listeners.TestNGListener
-
A listener that gets invoked after a method is invoked by TestNG.
- afterMaximize(WebDriver.Window) - Method in class com.shaft.listeners.internal.WebDriverListener
- afterQuit(WebDriver) - Method in class com.shaft.listeners.internal.WebDriverListener
- afterRefresh(WebDriver.Navigation) - Method in class com.shaft.listeners.internal.WebDriverListener
- afterStepStart(StepResult) - Method in class com.shaft.listeners.AllureListener
- afterStepStop(StepResult) - Method in class com.shaft.listeners.AllureListener
-
Invoked after each Allure step stops.
- afterStepUpdate(StepResult) - Method in class com.shaft.listeners.AllureListener
- afterTestSchedule(TestResult) - Method in class com.shaft.listeners.AllureListener
- afterTestStart(TestResult) - Method in class com.shaft.listeners.AllureListener
- afterTestStop(TestResult) - Method in class com.shaft.listeners.AllureListener
- afterTestUpdate(TestResult) - Method in class com.shaft.listeners.AllureListener
- afterTestWrite(TestResult) - Method in class com.shaft.listeners.AllureListener
- afterTo(WebDriver.Navigation, String) - Method in class com.shaft.listeners.internal.WebDriverListener
- afterTo(WebDriver.Navigation, URL) - Method in class com.shaft.listeners.internal.WebDriverListener
- AI_AGENT - Enum constant in enum class com.shaft.tools.io.internal.ProjectStructureManager.RunType
- alert() - Method in class com.shaft.driver.internal.FluentWebDriverAction
- alert() - Method in class com.shaft.driver.SHAFT.GUI.WebDriver
- AlertActions - Class in com.shaft.gui.element
-
Provides actions for interacting with browser alert, confirm, and prompt dialogs.
- AlertActions() - Constructor for class com.shaft.gui.element.AlertActions
-
Creates a new
AlertActionsinstance using the currently active SHAFT-managed driver. - AlertActions(DriverFactoryHelper) - Constructor for class com.shaft.gui.element.AlertActions
-
Creates a new
AlertActionsinstance using an existingDriverFactoryHelper. - AlertActions(WebDriver) - Constructor for class com.shaft.gui.element.AlertActions
-
Creates a new
AlertActionsinstance wrapping the providedWebDriver. - allure - Static variable in class com.shaft.properties.internal.Properties
- Allure - Interface in com.shaft.properties.internal
-
Configuration properties interface for Allure report generation in the SHAFT framework.
- Allure.SetProperty - Class in com.shaft.properties.internal
-
Fluent builder that allows programmatic override of individual Allure configuration properties.
- allureLinkCustomPattern() - Method in interface com.shaft.properties.internal.Jira
- allureLinkCustomPattern(String) - Method in class com.shaft.properties.internal.Jira.SetProperty
- allureLinkIssuePattern() - Method in interface com.shaft.properties.internal.Pattern
- allureLinkIssuePattern(String) - Method in class com.shaft.properties.internal.Pattern.SetProperty
- allureLinkTmsPattern() - Method in interface com.shaft.properties.internal.Jira
- allureLinkTmsPattern(String) - Method in class com.shaft.properties.internal.Jira.SetProperty
- AllureListener - Class in com.shaft.listeners
-
Allure lifecycle listener that integrates SHAFT's TestNG support with the Allure reporting engine.
- AllureListener() - Constructor for class com.shaft.listeners.AllureListener
- AllureManager - Class in com.shaft.tools.io.internal
-
Internal utility class that manages the Allure reporting lifecycle for SHAFT test runs.
- AllureManager() - Constructor for class com.shaft.tools.io.internal.AllureManager
- allureResults() - Method in interface com.shaft.properties.internal.Paths
- allureResults(String) - Method in class com.shaft.properties.internal.Paths.SetProperty
- allureVersion() - Method in interface com.shaft.properties.internal.Internal
- alter(List) - Method in class com.shaft.listeners.TestNGListener
-
Implementations of this interface will gain access to the
XmlSuiteobject and thus let users be able to alter a suite or a test based on their own needs. - alwaysLogDiscreetly() - Method in interface com.shaft.properties.internal.Reporting
- alwaysLogDiscreetly(boolean) - Method in class com.shaft.properties.internal.Reporting.SetProperty
- analyzeAndReturn(String) - Method in class com.shaft.validation.accessibility.AccessibilityActions
-
Analyzes the current page and returns the
AccessibilityHelper.AccessibilityResultfor programmatic inspection. - analyzeAndReturn(String, boolean) - Method in class com.shaft.validation.accessibility.AccessibilityActions
-
Analyzes the current page, optionally saving the HTML report to disk, and returns the
AccessibilityHelper.AccessibilityResultfor programmatic inspection. - analyzeAndReturn(String, AccessibilityHelper.AccessibilityConfig) - Method in class com.shaft.validation.accessibility.AccessibilityActions
-
Analyzes the current page using a custom
AccessibilityHelper.AccessibilityConfig, saves the report, and returns the result. - analyzeAndReturn(String, AccessibilityHelper.AccessibilityConfig, boolean) - Method in class com.shaft.validation.accessibility.AccessibilityActions
-
Analyzes the current page using the given configuration and
saveReportflag, then returns theAccessibilityHelper.AccessibilityResult. - analyzePage(String) - Method in class com.shaft.validation.accessibility.AccessibilityActions
-
Runs an accessibility audit on the current page, saves the HTML report to disk, and attaches it to the Allure report under the given
pageName. - analyzePage(String, AccessibilityHelper.AccessibilityConfig) - Method in class com.shaft.validation.accessibility.AccessibilityActions
-
Runs an accessibility audit on the current page using a custom
AccessibilityHelper.AccessibilityConfig, saves the HTML report to disk, and attaches it to the Allure report. - analyzePageAccessibility(WebDriver, String) - Static method in class com.shaft.validation.accessibility.AccessibilityHelper
-
Runs a WCAG accessibility scan against the currently loaded page using the default
AccessibilityHelper.AccessibilityConfigand writes both a JSON data file and an interactive HTML report to disk. - analyzePageAccessibility(WebDriver, String, AccessibilityHelper.AccessibilityConfig) - Static method in class com.shaft.validation.accessibility.AccessibilityHelper
-
Runs a WCAG accessibility scan using the supplied
AccessibilityHelper.AccessibilityConfigand writes both a JSON data file and an interactive HTML report to disk. - analyzePageAccessibility(WebDriver, String, String) - Static method in class com.shaft.validation.accessibility.AccessibilityHelper
-
Convenience overload that runs an accessibility scan scoped to a specific CSS context selector using default settings for all other configuration values.
- analyzePageAccessibilityAndSave(WebDriver, String, boolean) - Static method in class com.shaft.validation.accessibility.AccessibilityHelper
-
Runs an accessibility scan with default configuration, optionally persisting reports to disk, and returns a structured
AccessibilityHelper.AccessibilityResult. - analyzePageAccessibilityAndSave(WebDriver, String, AccessibilityHelper.AccessibilityConfig, boolean) - Static method in class com.shaft.validation.accessibility.AccessibilityHelper
-
Full-control overload: runs an accessibility scan with the supplied
AccessibilityHelper.AccessibilityConfig, optionally saves reports, and returns a structuredAccessibilityHelper.AccessibilityResultsuitable for programmatic assertions. - analyzeWithIgnoredRules(String, List) - Method in class com.shaft.validation.accessibility.AccessibilityActions
-
Analyzes the current page and attaches a filtered Allure report that excludes the specified rule IDs, without permanently modifying the cached result.
- ancestor(String) - Method in class com.shaft.gui.internal.locator.XpathAxis
- and() - Method in class com.shaft.driver.internal.FluentWebDriverAction
-
Returns this instance to allow fluent (method-chaining) syntax between successive actions.
- and() - Method in class com.shaft.gui.browser.BrowserActions
- and() - Method in class com.shaft.gui.element.ElementActions
- and() - Method in class com.shaft.gui.element.internal.Actions
- and() - Method in class com.shaft.gui.element.TouchActions
- and() - Method in class com.shaft.gui.internal.locator.LocatorBuilder
-
Syntactic Sugar
- ANGULAR_READY_STATE - Enum constant in enum class com.shaft.tools.internal.support.JavaScriptHelper
- ANGULAR2_READY_STATE - Enum constant in enum class com.shaft.tools.internal.support.JavaScriptHelper
- animatedGifFrameDelay() - Method in interface com.shaft.properties.internal.Visuals
- animatedGifFrameDelay(int) - Method in class com.shaft.properties.internal.Visuals.SetProperty
- AnimatedGifManager - Class in com.shaft.gui.internal.image
-
Manages the creation, frame-appending, and finalisation of animated GIF files that visualise test execution steps in the SHAFT framework.
- api - Static variable in class com.shaft.properties.internal.Properties
- API - Enum constant in enum class com.shaft.driver.DriverFactory.DriverType
- API - Interface in com.shaft.properties.internal
-
Configuration properties interface for API (REST) testing in the SHAFT framework.
- API(RestActions) - Constructor for class com.shaft.driver.SHAFT.API
- API(String) - Constructor for class com.shaft.driver.SHAFT.API
- API.SetProperty - Class in com.shaft.properties.internal
-
Fluent builder that allows programmatic override of individual API configuration properties.
- apiConnectionManagerTimeout() - Method in interface com.shaft.properties.internal.Timeouts
- apiConnectionManagerTimeout(int) - Method in class com.shaft.properties.internal.Timeouts.SetProperty
- apiConnectionTimeout() - Method in interface com.shaft.properties.internal.Timeouts
- apiConnectionTimeout(int) - Method in class com.shaft.properties.internal.Timeouts.SetProperty
- ApiPerformanceExecutionReport - Class in com.shaft.tools.io.internal
-
Utility class for generating HTML-based API performance execution reports.
- ApiPerformanceExecutionReport() - Constructor for class com.shaft.tools.io.internal.ApiPerformanceExecutionReport
- apiSocketTimeout() - Method in interface com.shaft.properties.internal.Timeouts
- apiSocketTimeout(int) - Method in class com.shaft.properties.internal.Timeouts.SetProperty
- app() - Method in interface com.shaft.properties.internal.Mobile
- app(String) - Method in class com.shaft.properties.internal.Mobile.SetProperty
- appActivity() - Method in interface com.shaft.properties.internal.Mobile
- appActivity(String) - Method in class com.shaft.properties.internal.Mobile.SetProperty
- appendDefaultContentCharsetToContentTypeIfUndefined(boolean) - Method in class com.shaft.api.RequestBuilder
-
Tells whether REST Assured should automatically append the content charset to the content-type header if not defined explicitly.
- appenderConsoleFilterThresholdLevel() - Method in interface com.shaft.properties.internal.Log4j
- appenderConsoleFilterThresholdType() - Method in interface com.shaft.properties.internal.Log4j
- appenderConsoleLayoutDisableAnsi() - Method in interface com.shaft.properties.internal.Log4j
- appenderConsoleLayoutPattern() - Method in interface com.shaft.properties.internal.Log4j
- appenderConsoleLayoutType() - Method in interface com.shaft.properties.internal.Log4j
- appenderConsoleName() - Method in interface com.shaft.properties.internal.Log4j
- appenderConsoleType() - Method in interface com.shaft.properties.internal.Log4j
- appenderFile_FileName() - Method in interface com.shaft.properties.internal.Log4j
- appenderFileFilterThresholdLevel() - Method in interface com.shaft.properties.internal.Log4j
- appenderFileFilterThresholdType() - Method in interface com.shaft.properties.internal.Log4j
- appenderFileLayoutPattern() - Method in interface com.shaft.properties.internal.Log4j
- appenderFileLayoutType() - Method in interface com.shaft.properties.internal.Log4j
- appenderFileName() - Method in interface com.shaft.properties.internal.Log4j
- appenderFileType() - Method in interface com.shaft.properties.internal.Log4j
- appendTestDataToRelativePath(String) - Static method in class com.shaft.tools.internal.support.JavaHelper
- APPIUM_BROWSER - Enum constant in enum class com.shaft.driver.DriverFactory.DriverType
- APPIUM_CHROME - Enum constant in enum class com.shaft.driver.DriverFactory.DriverType
- APPIUM_CHROMIUM - Enum constant in enum class com.shaft.driver.DriverFactory.DriverType
- APPIUM_FLUTTER - Enum constant in enum class com.shaft.driver.DriverFactory.DriverType
- APPIUM_MOBILE_NATIVE - Enum constant in enum class com.shaft.driver.DriverFactory.DriverType
- APPIUM_SAMSUNG_BROWSER - Enum constant in enum class com.shaft.driver.DriverFactory.DriverType
- appiumVersion() - Method in interface com.shaft.properties.internal.BrowserStack
-
Appium version to use on BrowserStack App Automate for mobile native testing.
- appiumVersion() - Method in interface com.shaft.properties.internal.LambdaTest
- appiumVersion(String) - Method in class com.shaft.properties.internal.BrowserStack.SetProperty
-
Overrides the
browserStack.appiumVersionproperty at runtime. - appiumVersion(String) - Method in class com.shaft.properties.internal.LambdaTest.SetProperty
- applitoolsApiKey() - Method in interface com.shaft.properties.internal.Paths
- applitoolsApiKey(String) - Method in class com.shaft.properties.internal.Paths.SetProperty
- appName() - Method in interface com.shaft.properties.internal.BrowserStack
-
Name assigned to a new app file being uploaded to BrowserStack App Automate.
- appName() - Method in interface com.shaft.properties.internal.LambdaTest
- appName(String) - Method in class com.shaft.properties.internal.BrowserStack.SetProperty
-
Overrides the
browserStack.appNameproperty at runtime. - appName(String) - Method in class com.shaft.properties.internal.LambdaTest.SetProperty
- appPackage() - Method in interface com.shaft.properties.internal.Mobile
- appPackage(String) - Method in class com.shaft.properties.internal.Mobile.SetProperty
- appProfiling() - Method in interface com.shaft.properties.internal.LambdaTest
- appProfiling(Boolean) - Method in class com.shaft.properties.internal.LambdaTest.SetProperty
- appRelativeFilePath() - Method in interface com.shaft.properties.internal.BrowserStack
-
Relative file path of the app to be uploaded to BrowserStack App Automate.
- appRelativeFilePath() - Method in interface com.shaft.properties.internal.LambdaTest
- appRelativeFilePath(String) - Method in class com.shaft.properties.internal.BrowserStack.SetProperty
-
Overrides the
browserStack.appRelativeFilePathproperty at runtime. - appRelativeFilePath(String) - Method in class com.shaft.properties.internal.LambdaTest.SetProperty
- appUrl() - Method in interface com.shaft.properties.internal.BrowserStack
-
URL of a previously uploaded app on BrowserStack App Automate.
- appUrl() - Method in interface com.shaft.properties.internal.LambdaTest
- appUrl(String) - Method in class com.shaft.properties.internal.BrowserStack.SetProperty
-
Overrides the
browserStack.appUrlproperty at runtime. - appUrl(String) - Method in class com.shaft.properties.internal.LambdaTest.SetProperty
- assertAccessibilityScoreAtLeast(String, double) - Method in class com.shaft.validation.accessibility.AccessibilityActions
-
Asserts that the accessibility score for the given page is at least
minimumPercentage. - assertAccessibilityScoreAtLeast(String, double, boolean) - Method in class com.shaft.validation.accessibility.AccessibilityActions
-
Asserts that the accessibility score for the given page is at least
minimumPercentage, with control over whether the HTML report is saved to disk. - assertAccessibilityScoreAtLeast(String, double, AccessibilityHelper.AccessibilityConfig) - Method in class com.shaft.validation.accessibility.AccessibilityActions
-
Asserts that the accessibility score for the given page is at least
minimumPercentage, using a customAccessibilityHelper.AccessibilityConfig. - assertAccessibilityScoreAtLeast(String, double, AccessibilityHelper.AccessibilityConfig, boolean) - Method in class com.shaft.validation.accessibility.AccessibilityActions
-
Asserts that the accessibility score for the given page is at least
minimumPercentage, using a customAccessibilityHelper.AccessibilityConfigand explicit control over report persistence. - assertAll() - Method in class com.shaft.validation.internal.CustomSoftAssert
- assertBrowserAttributeContains(String, String) - Method in class com.shaft.cucumber.AssertionSteps
-
Asserts browser attribute contains expectedValue.
- assertBrowserAttributeDoesNotContain(String, String) - Method in class com.shaft.cucumber.AssertionSteps
-
Asserts browser attribute does not contain expectedValue.
- assertBrowserAttributeDoesNotEqual(String, String) - Method in class com.shaft.cucumber.AssertionSteps
-
Asserts browser attribute does not equal expectedValue.
- assertBrowserAttributeDoesNotMatch(String, String) - Method in class com.shaft.cucumber.AssertionSteps
-
Asserts browser attribute does not match expectedValue.
- assertBrowserAttributeEquals(String, String) - Method in class com.shaft.cucumber.AssertionSteps
-
Asserts browser attribute equals expectedValue.
- assertBrowserAttributeMatches(String, String) - Method in class com.shaft.cucumber.AssertionSteps
-
Asserts browser attribute matches expectedValue.
- assertElementAttributeContains(String, String, String, String) - Method in class com.shaft.cucumber.AssertionSteps
-
Asserts webElement attribute contains expectedValue.
- assertElementAttributeDoesNotContain(String, String, String, String) - Method in class com.shaft.cucumber.AssertionSteps
-
Asserts webElement attribute does not contain expectedValue.
- assertElementAttributeDoesNotEqual(String, String, String, String) - Method in class com.shaft.cucumber.AssertionSteps
-
Asserts webElement attribute does not equal expectedValue.
- assertElementAttributeDoesNotMatch(String, String, String, String) - Method in class com.shaft.cucumber.AssertionSteps
-
Asserts webElement attribute does not match expectedValue.
- assertElementAttributeMatches(String, String, String, String) - Method in class com.shaft.cucumber.AssertionSteps
-
Asserts webElement attribute matches expectedValue.
- assertElementCSSPropertyContains(String, String, String, String) - Method in class com.shaft.cucumber.AssertionSteps
-
Asserts webElement CSSProperty contains expectedValue.
- assertElementCSSPropertyDoesNotContain(String, String, String, String) - Method in class com.shaft.cucumber.AssertionSteps
-
Asserts webElement CSSProperty does not contain expectedValue.
- assertElementCSSPropertyDoesNotEqual(String, String, String, String) - Method in class com.shaft.cucumber.AssertionSteps
-
Asserts webElement CSSProperty does not equal expectedValue.
- assertElementCSSPropertyDoesNotMatch(String, String, String, String) - Method in class com.shaft.cucumber.AssertionSteps
-
Asserts webElement CSSProperty does not match expectedValue.
- assertElementCSSPropertyEquals(String, String, String, String) - Method in class com.shaft.cucumber.AssertionSteps
-
Asserts webElement CSSProperty equals expectedValue.
- assertElementCSSPropertyMatches(String, String, String, String) - Method in class com.shaft.cucumber.AssertionSteps
-
Asserts webElement CSSProperty matches expectedValue.
- assertElementDoesNotExist(String, String) - Method in class com.shaft.cucumber.AssertionSteps
-
Asserts that the webElement found using the provided driver and locator does not exist.
- assertElementDoesNotMatchContentEyes(String, String) - Method in class com.shaft.cucumber.AssertionSteps
-
Asserts that the current image of the target element matches the expected reference image using the desired VisualValidationEngine if AssertionType is POSITIVE, or doesn't match it if AssertionType is NEGATIVE.
- assertElementDoesNotMatchExactEyes(String, String) - Method in class com.shaft.cucumber.AssertionSteps
-
Asserts that the current image of the target element matches the expected reference image using the desired VisualValidationEngine if AssertionType is POSITIVE, or doesn't match it if AssertionType is NEGATIVE.
- assertElementDoesNotMatchLayoutEyes(String, String) - Method in class com.shaft.cucumber.AssertionSteps
-
Asserts that the current image of the target element matches the expected reference image using the desired VisualValidationEngine if AssertionType is POSITIVE, or doesn't match it if AssertionType is NEGATIVE.
- assertElementDoesNotMatchOpenCV(String, String) - Method in class com.shaft.cucumber.AssertionSteps
-
Asserts that the current image of the target element matches the expected reference image using the desired VisualValidationEngine if AssertionType is POSITIVE, or doesn't match it if AssertionType is NEGATIVE.
- assertElementDoesNotMatchStrictEyes(String, String) - Method in class com.shaft.cucumber.AssertionSteps
-
Asserts that the current image of the target element matches the expected reference image using the desired VisualValidationEngine if AssertionType is POSITIVE, or doesn't match it if AssertionType is NEGATIVE.
- assertelementDomAttributeEquals(String, String, String, String) - Method in class com.shaft.cucumber.AssertionSteps
-
Asserts webElement attribute equals expectedValue.
- assertElementExists(String, String) - Method in class com.shaft.cucumber.AssertionSteps
-
Asserts that the webElement found using the provided driver and locator exists.
- assertElementMatchesContentEyes(String, String) - Method in class com.shaft.cucumber.AssertionSteps
-
Asserts that the current image of the target element matches the expected reference image using the desired VisualValidationEngine if AssertionType is POSITIVE, or doesn't match it if AssertionType is NEGATIVE.
- assertElementMatchesExactEyes(String, String) - Method in class com.shaft.cucumber.AssertionSteps
-
Asserts that the current image of the target element matches the expected reference image using the desired VisualValidationEngine if AssertionType is POSITIVE, or doesn't match it if AssertionType is NEGATIVE.
- assertElementMatchesLayoutEyes(String, String) - Method in class com.shaft.cucumber.AssertionSteps
-
Asserts that the current image of the target element matches the expected reference image using the desired VisualValidationEngine if AssertionType is POSITIVE, or doesn't match it if AssertionType is NEGATIVE.
- assertElementMatchesOpenCV(String, String) - Method in class com.shaft.cucumber.AssertionSteps
-
Asserts that the current image of the target element matches the expected reference image using the desired VisualValidationEngine if AssertionType is POSITIVE, or doesn't match it if AssertionType is NEGATIVE.
- assertElementMatchesStrictEyes(String, String) - Method in class com.shaft.cucumber.AssertionSteps
-
Asserts that the current image of the target element matches the expected reference image using the desired VisualValidationEngine if AssertionType is POSITIVE, or doesn't match it if AssertionType is NEGATIVE.
- ASSERTION - Enum constant in enum class com.shaft.tools.io.internal.CheckpointType
-
A hard assertion that fails the test immediately on failure.
- AssertionSteps - Class in com.shaft.cucumber
-
Provides Cucumber step definitions for browser-level assertions in SHAFT-powered test suites.
- AssertionSteps(ThreadLocal) - Constructor for class com.shaft.cucumber.AssertionSteps
-
Creates a new
AssertionStepsinstance with the supplied thread-local driver. - assertIsAccessible() - Method in class com.shaft.validation.accessibility.AccessibilityActions
-
Asserts (hard assertion) that the current page is fully accessible according to
AccessibilityHelper.isAccessible(WebDriver)'s default criteria (zero violations). - assertNoCriticalViolations(String) - Method in class com.shaft.validation.accessibility.AccessibilityActions
-
Asserts (hard assertion) that the current page has no accessibility violations with an impact level of
"critical". - assertNoViolationsByImpact(String, String...) - Method in class com.shaft.validation.accessibility.AccessibilityActions
-
Asserts (hard assertion) that the current page has no accessibility violations matching any of the supplied impact levels.
- assertThat() - Method in class com.shaft.driver.SHAFT.GUI.WebDriver
- assertThat() - Static method in class com.shaft.driver.SHAFT.Validations
- assertThat() - Method in class com.shaft.gui.browser.BrowserActions
-
Opens a hard-assertion builder scoped to the current browser state.
- assertThat() - Static method in class com.shaft.validation.Validations
-
Start building your assertion (Note: if an assertion fails the test method execution will stop and fail)
- assertThat(By) - Method in class com.shaft.gui.element.ElementActions
- assertThat(By) - Method in class com.shaft.gui.element.TouchActions
- assertThatResponse() - Method in class com.shaft.driver.SHAFT.API
- assignee() - Method in interface com.shaft.properties.internal.Jira
- assignee(String) - Method in class com.shaft.properties.internal.Jira.SetProperty
- async() - Method in class com.shaft.driver.SHAFT.GUI.WebDriver
- Async() - Constructor for class com.shaft.driver.SHAFT.GUI.WebDriver.Async
- AsyncElementActions - Class in com.shaft.gui.element
-
Provides asynchronous (non-blocking) variants of common
ElementActionsoperations. - AsyncElementActions(DriverFactoryHelper) - Constructor for class com.shaft.gui.element.AsyncElementActions
-
Constructs a new
AsyncElementActionsbound to the given driver helper. - attach() - Static method in class com.shaft.tools.io.internal.CheckpointCounter
- attach(String, String, InputStream) - Static method in class com.shaft.driver.SHAFT.Report
- attach(String, String, InputStream) - Static method in class com.shaft.tools.io.internal.ReportManagerHelper
-
Adds a new attachment using the input parameters provided.
- attach(String, String, String) - Static method in class com.shaft.driver.SHAFT.Report
- attach(String, String, String) - Static method in class com.shaft.tools.io.internal.ReportManagerHelper
-
Adds a new attachment using the input parameters provided.
- attach(List) - Static method in class com.shaft.tools.io.internal.ReportManagerHelper
- attachAnimatedGif() - Static method in class com.shaft.gui.internal.image.AnimatedGifManager
-
Finalises and attaches the current thread's animated GIF to the Allure report, then resets the thread-local GIF state so a new GIF can be started for the next test.
- attachAsStep(String, String, InputStream) - Static method in class com.shaft.tools.io.internal.ReportManagerHelper
-
Adds a new attachment using the input parameters provided.
- attachBasedOnFileType(String, String, ByteArrayOutputStream, String) - Static method in class com.shaft.tools.io.internal.AttachmentReporter
-
Attaches the given content to the Allure report (and ReportPortal if enabled), automatically selecting the correct MIME type and file extension based on the attachment type and name strings.
- attachConfigurationHelperClass(List) - Static method in class com.shaft.listeners.internal.TestNGListenerHelper
- attachConfigurationMethods() - Static method in class com.shaft.listeners.internal.TestNGListenerHelper
- attachCucumberReport() - Static method in class com.shaft.tools.io.internal.ReportHelper
- attachEngineLog() - Static method in class com.shaft.tools.io.internal.ReportHelper
- attachEngineLog(String) - Static method in class com.shaft.tools.io.internal.ReportManagerHelper
- attachFilesToIssue(String, List) - Static method in class com.shaft.tools.internal.tms.XrayIntegrationHelper
-
Update the created issue with the attachments.
- attachFilteredReportToAllure(String, AccessibilityHelper.AccessibilityResult, WebDriver) - Static method in class com.shaft.validation.accessibility.AccessibilityHelper
-
Generates a filtered HTML report containing only the violations present in the supplied
AccessibilityHelper.AccessibilityResultand attaches it to the current Allure test step. - attachFullLog() - Method in interface com.shaft.properties.internal.Reporting
- attachFullLog(boolean) - Method in class com.shaft.properties.internal.Reporting.SetProperty
- attachIssuesLog() - Static method in class com.shaft.tools.io.internal.ReportHelper
- attachIssuesLog(String) - Static method in class com.shaft.tools.io.internal.ReportManagerHelper
- AttachmentReporter - Class in com.shaft.tools.io.internal
-
Internal utility class responsible for attaching test artifacts (screenshots, recordings, GIFs, data files, page snapshots, etc.) to the Allure report and optionally to ReportPortal.
- attachPropertyFiles() - Static method in class com.shaft.tools.io.internal.ReportHelper
- attachReportToAllure(String) - Static method in class com.shaft.validation.accessibility.AccessibilityHelper
-
Attaches the most recently generated HTML accessibility report for the given page to the current Allure test step.
- attachTestArtifacts(ITestResult) - Static method in class com.shaft.listeners.internal.TestNGListenerHelper
- attachTestLog(String, String) - Static method in class com.shaft.tools.io.internal.ReportManagerHelper
-
Returns the log of the current test, and attaches it in the end of the test execution report.
- attachVideoRecording() - Static method in class com.shaft.gui.internal.video.RecordManager
- attachVideoRecording(Path) - Static method in class com.shaft.gui.internal.video.RecordManager
- attemptClearBeforeTyping() - Method in interface com.shaft.properties.internal.Flags
- attemptClearBeforeTyping(boolean) - Method in class com.shaft.properties.internal.Flags.SetProperty
-
Deprecated, for removal: This API element is subject to removal in a future version.
- attemptClearBeforeTypingUsingBackspace() - Method in interface com.shaft.properties.internal.Flags
- attemptClearBeforeTypingUsingBackspace(boolean) - Method in class com.shaft.properties.internal.Flags.SetProperty
-
Deprecated, for removal: This API element is subject to removal in a future version.
- attemptMaximizeUsingSeleniumWebDriver(WebDriver, String, String, String) - Method in class com.shaft.gui.browser.internal.BrowserActionsHelper
-
Attempts to maximize the browser window using the Selenium WebDriver
WebDriver.Window.maximize()method. - attemptMaximizeUsingSeleniumWebDriverManageWindow(WebDriver, int, int) - Method in class com.shaft.gui.browser.internal.BrowserActionsHelper
-
Maximizes the browser window by explicitly setting its position to
(0, 0)and its size to the provided dimensions using theWebDriver.WindowAPI. - attemptMaximizeUsingToolkitAndJavascript(WebDriver, int, int) - Method in class com.shaft.gui.browser.internal.BrowserActionsHelper
-
Attempts to maximize the browser window by reading the physical screen dimensions from
Toolkitand resizing the window accordingly. - attemptToClickBeforeTyping() - Method in interface com.shaft.properties.internal.Flags
- attemptToClickBeforeTyping(boolean) - Method in class com.shaft.properties.internal.Flags.SetProperty
- attribute(String) - Method in class com.shaft.validation.internal.WebDriverBrowserValidationsBuilder
-
Use this to check against a certain browser attribute
- attribute(String) - Method in class com.shaft.validation.internal.WebDriverElementValidationsBuilder
-
Use this to check against a certain element attribute
- attribute(By, String) - Method in class com.shaft.gui.element.internal.Actions.GetElementInformation
-
Returns the value of the named HTML attribute from the located element.
- authorization() - Method in interface com.shaft.properties.internal.Jira
- authorization(String) - Method in class com.shaft.properties.internal.Jira.SetProperty
- authType() - Method in interface com.shaft.properties.internal.Jira
- authType(String) - Method in class com.shaft.properties.internal.Jira.SetProperty
- autoAcceptAlerts() - Method in interface com.shaft.properties.internal.LambdaTest
- autoAcceptAlerts(boolean) - Method in class com.shaft.properties.internal.LambdaTest.SetProperty
- autoCloseDriverInstance() - Method in interface com.shaft.properties.internal.Flags
- autoCloseDriverInstance(boolean) - Method in class com.shaft.properties.internal.Flags.SetProperty
- autoGrantPermissions() - Method in interface com.shaft.properties.internal.LambdaTest
- autoGrantPermissions(boolean) - Method in class com.shaft.properties.internal.LambdaTest.SetProperty
- automaticallyAddRecommendedChromeOptions() - Method in interface com.shaft.properties.internal.Flags
- automaticallyAddRecommendedChromeOptions(boolean) - Method in class com.shaft.properties.internal.Flags.SetProperty
- automaticallyAssertResponseStatusCode() - Method in interface com.shaft.properties.internal.Flags
- automaticallyAssertResponseStatusCode(boolean) - Method in class com.shaft.properties.internal.Flags.SetProperty
- automaticallyOpen() - Method in interface com.shaft.properties.internal.Allure
-
Whether the Allure report HTML file should be opened automatically in the default browser after the test run completes.
- automaticallyOpen(boolean) - Method in class com.shaft.properties.internal.Allure.SetProperty
-
Overrides the
allure.automaticallyOpenproperty at runtime. - automationName() - Method in interface com.shaft.properties.internal.Mobile
- automationName(String) - Method in class com.shaft.properties.internal.Mobile.SetProperty
- autoMaximizeBrowserWindow() - Method in interface com.shaft.properties.internal.Flags
- autoMaximizeBrowserWindow(boolean) - Method in class com.shaft.properties.internal.Flags.SetProperty
B
- BACK - Enum constant in enum class com.shaft.enums.internal.NavigationAction
- backToBrowser() - Method in class com.shaft.validation.accessibility.AccessibilityActions
-
Returns the
BrowserActionsinstance that was used to create thisAccessibilityActions, enabling fluent chaining back into browser-level operations. - baseURL() - Method in interface com.shaft.properties.internal.Web
- baseURL(String) - Method in class com.shaft.properties.internal.Web.SetProperty
- BASIC - Enum constant in enum class com.shaft.api.RequestBuilder.AuthenticationType
- beforeClear(WebElement) - Method in class com.shaft.listeners.internal.WebDriverListener
- beforeClick(WebElement) - Method in class com.shaft.listeners.internal.WebDriverListener
- beforeConfiguration(ITestResult) - Method in class com.shaft.listeners.TestNGListener
- beforeContainerStart(TestResultContainer) - Method in class com.shaft.listeners.AllureListener
- beforeContainerStop(TestResultContainer) - Method in class com.shaft.listeners.AllureListener
- beforeContainerUpdate(TestResultContainer) - Method in class com.shaft.listeners.AllureListener
- beforeContainerWrite(TestResultContainer) - Method in class com.shaft.listeners.AllureListener
- beforeFindElement(WebDriver, By) - Method in class com.shaft.listeners.internal.WebDriverListener
- beforeFixtureStart(FixtureResult) - Method in class com.shaft.listeners.AllureListener
- beforeFixtureStop(FixtureResult) - Method in class com.shaft.listeners.AllureListener
-
Invoked before each Allure fixture (TestNG
@BeforeXxx/@AfterXxxmethod) stops. - beforeFixtureUpdate(FixtureResult) - Method in class com.shaft.listeners.AllureListener
- beforeInvocation(IInvokedMethod, ITestResult, ITestContext) - Method in class com.shaft.listeners.TestNGListener
-
A listener that gets invoked before a method is invoked by TestNG.
- beforeSendKeys(Alert, String) - Method in class com.shaft.listeners.internal.WebDriverListener
- beforeSendKeys(WebElement, CharSequence...) - Method in class com.shaft.listeners.internal.WebDriverListener
- beforeStepStart(StepResult) - Method in class com.shaft.listeners.AllureListener
- beforeStepStop(StepResult) - Method in class com.shaft.listeners.AllureListener
- beforeStepUpdate(StepResult) - Method in class com.shaft.listeners.AllureListener
- beforeSubmit(WebElement) - Method in class com.shaft.listeners.internal.WebDriverListener
- beforeTestSchedule(TestResult) - Method in class com.shaft.listeners.AllureListener
- beforeTestStart(TestResult) - Method in class com.shaft.listeners.AllureListener
- beforeTestStop(TestResult) - Method in class com.shaft.listeners.AllureListener
- beforeTestUpdate(TestResult) - Method in class com.shaft.listeners.AllureListener
- beforeTestWrite(TestResult) - Method in class com.shaft.listeners.AllureListener
- body() - Method in class com.shaft.validation.internal.RestValidationsBuilder
- browser() - Method in class com.shaft.driver.internal.FluentWebDriverAction
- browser() - Method in class com.shaft.driver.internal.WizardHelpers.WebDriverAssertions
- browser() - Method in class com.shaft.driver.internal.WizardHelpers.WebDriverVerifications
- browser() - Method in class com.shaft.driver.SHAFT.GUI.WebDriver
- browser(WebDriver) - Method in class com.shaft.validation.internal.ValidationsBuilder
-
Build a WebDriver browser validation to check against the target browser
- BrowserActions - Class in com.shaft.gui.browser
-
Provides a fluent API for performing browser-level actions such as navigation, window management, cookie handling, network interception, and accessibility validation.
- BrowserActions() - Constructor for class com.shaft.gui.browser.BrowserActions
-
Creates a new
BrowserActionsinstance and initializes the underlying driver using the framework's default driver factory configuration. - BrowserActions(DriverFactoryHelper) - Constructor for class com.shaft.gui.browser.BrowserActions
-
Creates a new
BrowserActionsinstance backed by an existingDriverFactoryHelper. - BrowserActions(WebDriver) - Constructor for class com.shaft.gui.browser.BrowserActions
-
Creates a new
BrowserActionsinstance wrapping the providedWebDriver. - BrowserActions(WebDriver, boolean) - Constructor for class com.shaft.gui.browser.BrowserActions
-
Creates a new
BrowserActionsinstance wrapping the providedWebDriver, with control over whether reporting output is suppressed. - BrowserActionsHelper - Class in com.shaft.gui.browser.internal
-
Internal helper class for browser actions within the SHAFT framework.
- BrowserActionsHelper(boolean) - Constructor for class com.shaft.gui.browser.internal.BrowserActionsHelper
-
Creates a new
BrowserActionsHelper. - browserName() - Method in interface com.shaft.properties.internal.Mobile
- browserName(String) - Method in class com.shaft.properties.internal.Mobile.SetProperty
- browserNavigationTimeout() - Method in interface com.shaft.properties.internal.Timeouts
- browserNavigationTimeout(int) - Method in class com.shaft.properties.internal.Timeouts.SetProperty
- browserStack - Static variable in class com.shaft.properties.internal.Properties
- BrowserStack - Interface in com.shaft.properties.internal
-
Configuration properties interface for BrowserStack cloud execution in the SHAFT framework.
- BROWSERSTACK - Enum constant in enum class com.shaft.driver.DriverFactory.DriverType
- BrowserStack.SetProperty - Class in com.shaft.properties.internal
-
Fluent builder that allows programmatic override of individual BrowserStack configuration properties at runtime.
- browserstackAutomation() - Method in interface com.shaft.properties.internal.BrowserStack
-
Whether BrowserStack Automation is enabled in the SDK configuration.
- browserstackAutomation(boolean) - Method in class com.shaft.properties.internal.BrowserStack.SetProperty
-
Overrides the
browserStack.browserstackAutomationproperty at runtime. - BrowserStackHelper - Class in com.shaft.driver.internal.DriverFactory
- BrowserStackHelper() - Constructor for class com.shaft.driver.internal.DriverFactory.BrowserStackHelper
- BrowserStackSdkHelper - Class in com.shaft.driver.internal.DriverFactory
-
Utility class for generating a
browserstack.ymlconfiguration file from SHAFT's BrowserStack property system. - BrowserSteps - Class in com.shaft.cucumber
-
Cucumber step definitions for browser-level actions such as navigation, window management, and browser lifecycle operations.
- BrowserSteps(ThreadLocal) - Constructor for class com.shaft.cucumber.BrowserSteps
-
Constructs a new
BrowserStepsinstance, injecting a sharedThreadLocalWebDriver container from the Cucumber IoC context. - browserVersion() - Method in interface com.shaft.properties.internal.BrowserStack
-
Target browser version for desktop web testing on BrowserStack Automate.
- browserVersion() - Method in interface com.shaft.properties.internal.LambdaTest
- browserVersion() - Method in interface com.shaft.properties.internal.Mobile
- browserVersion(String) - Method in class com.shaft.properties.internal.BrowserStack.SetProperty
-
Overrides the
browserStack.browserVersionproperty at runtime. - browserVersion(String) - Method in class com.shaft.properties.internal.LambdaTest.SetProperty
- browserVersion(String) - Method in class com.shaft.properties.internal.Mobile.SetProperty
- browserWindowHeight() - Method in interface com.shaft.properties.internal.Web
- browserWindowHeight(int) - Method in class com.shaft.properties.internal.Web.SetProperty
- browserWindowWidth() - Method in interface com.shaft.properties.internal.Web
- browserWindowWidth(int) - Method in class com.shaft.properties.internal.Web.SetProperty
- build() - Method in class com.shaft.gui.internal.locator.LocatorBuilder
- build() - Method in class com.shaft.gui.internal.locator.ShadowLocatorBuilder
- build() - Method in interface com.shaft.properties.internal.LambdaTest
- build(String) - Method in class com.shaft.properties.internal.LambdaTest.SetProperty
- buildHtml(String, String, String, String) - Static method in class com.shaft.tools.internal.support.PerformanceReportHTMLHelper
- buildName() - Method in interface com.shaft.properties.internal.BrowserStack
-
Custom build name for BrowserStack dashboard reporting.
- buildName() - Method in interface com.shaft.properties.internal.LambdaTest
- buildName(String) - Method in class com.shaft.properties.internal.BrowserStack.SetProperty
-
Overrides the
browserStack.buildNameproperty at runtime. - buildName(String) - Method in class com.shaft.properties.internal.LambdaTest.SetProperty
- buildNewRequest(String, RestActions.RequestType) - Method in class com.shaft.api.RestActions
- buildNewRequest(String, String, RestActions.RequestType) - Static method in class com.shaft.api.RestActions
- BUTTON - Enum constant in enum class com.shaft.gui.internal.locator.Role
- byAxis() - Method in class com.shaft.gui.internal.locator.LocatorBuilder
- byRelation() - Method in class com.shaft.gui.internal.locator.LocatorBuilder
- byRole(Role) - Static method in class com.shaft.gui.internal.locator.LocatorBuilder
C
- captureElementName() - Method in interface com.shaft.properties.internal.Reporting
- captureElementName(boolean) - Method in class com.shaft.properties.internal.Reporting.SetProperty
- capturePageSnapshot() - Method in class com.shaft.gui.browser.BrowserActions
-
Attempts to capture a page snapshot archive in the format of a .mht file Works only for Chromium based driver instances For other driver types attempts to attach the current page source (for web) or accessibility tree (for mobile)
- capturePageSnapshot(WebDriver) - Method in class com.shaft.gui.browser.internal.BrowserActionsHelper
-
Captures a snapshot of the current page.
- captureScreenshot() - Method in class com.shaft.gui.browser.BrowserActions
-
Use this action to return a full page screenshot.
- captureScreenshot(Screenshots) - Method in class com.shaft.gui.browser.BrowserActions
-
Use this action to return a page screenshot.
- captureScreenshot(By) - Method in class com.shaft.gui.element.AsyncElementActions
-
Asynchronously captures a screenshot of the element identified by
elementLocatorand attaches it to the Allure report. - captureScreenshot(By) - Method in class com.shaft.gui.element.ElementActions
- captureSnapshot() - Method in class com.shaft.gui.browser.BrowserActions
-
Use this action to return a page snapshot.
- captureWebDriverLogs() - Method in interface com.shaft.properties.internal.Reporting
- captureWebDriverLogs(boolean) - Method in class com.shaft.properties.internal.Reporting.SetProperty
- CASE_INSENSITIVE - Enum constant in enum class com.shaft.validation.ValidationEnums.ValidationComparisonType
- casesDetailsIncrement(String, String, String, String, String, String, String) - Static method in class com.shaft.tools.io.internal.ExecutionSummaryReport
- changeWebElementVisibilityUsingJavascript(WebDriver, By, boolean) - Method in class com.shaft.gui.element.internal.ElementActionsHelper
- check() - Static method in class com.shaft.listeners.internal.UpdateChecker
- CHECKBOX - Enum constant in enum class com.shaft.gui.internal.locator.Role
- checkNavigationWasSuccessful(WebDriver, String, String, String) - Method in class com.shaft.gui.browser.internal.BrowserActionsHelper
-
Waits until the browser URL reflects a successful navigation away from the initial URL, and optionally waits until it contains the expected target URL.
- CHECKPOINT_COUNTER - Enum constant in enum class com.shaft.tools.internal.support.HTMLHelper
- CHECKPOINT_DETAILS_FORMAT - Enum constant in enum class com.shaft.tools.internal.support.HTMLHelper
- CheckpointCounter - Class in com.shaft.tools.io.internal
- CheckpointCounter() - Constructor for class com.shaft.tools.io.internal.CheckpointCounter
- CheckpointStatus - Enum Class in com.shaft.tools.io.internal
- CheckpointType - Enum Class in com.shaft.tools.io.internal
- checksum() - Method in class com.shaft.validation.internal.FileValidationsBuilder
-
Use this to calculate and check a certain file checksum to confirm if it has the exact same content or not
- child(String) - Method in class com.shaft.gui.internal.locator.XpathAxis
- CHROME - Enum constant in enum class com.shaft.driver.DriverFactory.DriverType
- CHROMIUM - Enum constant in enum class com.shaft.driver.DriverFactory.DriverType
- cleanExecutionSummaryReportDirectory() - Static method in class com.shaft.tools.io.internal.ReportManagerHelper
- cleanResultsDirectory() - Method in interface com.shaft.properties.internal.Allure
-
Whether the Allure results directory should be cleaned before a new test run starts.
- cleanResultsDirectory(boolean) - Method in class com.shaft.properties.internal.Allure.SetProperty
-
Overrides the
allure.cleanResultsDirectoryproperty at runtime. - cleanSummaryReportsDirectoryBeforeExecution() - Method in interface com.shaft.properties.internal.Reporting
- clear() - Static method in class com.shaft.properties.internal.ThreadLocalPropertiesManager
-
Clears all thread-local property overrides for the current thread.
- clear(By) - Method in class com.shaft.gui.element.internal.Actions
- clear(By) - Method in class com.shaft.gui.element.AsyncElementActions
-
Asynchronously clears the content of the element identified by
elementLocator. - clear(By) - Method in class com.shaft.gui.element.ElementActions
-
Clears the value of the target element.
- clearBeforeTypingMode() - Method in interface com.shaft.properties.internal.Flags
- clearBeforeTypingMode(String) - Method in class com.shaft.properties.internal.Flags.SetProperty
- clearFailures() - Method in class com.shaft.validation.internal.CustomSoftAssert
- clearForCurrentThread() - Static method in class com.shaft.properties.internal.Properties
-
Clears all thread-local property overrides for the current thread and resets the per-thread override map maintained by
ThreadLocalPropertiesManager. - click(String) - Method in class com.shaft.gui.element.internal.Actions
-
Clicks a clickable element resolved by its visible label or accessible name.
- click(String, String) - Method in class com.shaft.cucumber.ElementSteps
-
Clicks on a certain element using Selenium WebDriver, or JavaScript.
- click(By) - Method in class com.shaft.gui.element.internal.Actions
- click(By) - Method in class com.shaft.gui.element.AsyncElementActions
-
Asynchronously clicks the element identified by
elementLocator. - click(By) - Method in class com.shaft.gui.element.ElementActions
-
Clicks on a certain element using Selenium WebDriver, or JavaScript
- clickableField(String) - Static method in class com.shaft.gui.internal.locator.Locator
- clickableField(String) - Static method in class com.shaft.gui.internal.locator.SmartLocators
- clickAndHold(String, String) - Method in class com.shaft.cucumber.ElementSteps
-
Waits for the element to be clickable, and then clicks and holds it.
- clickAndHold(By) - Method in class com.shaft.gui.element.internal.Actions
- clickAndHold(By) - Method in class com.shaft.gui.element.AsyncElementActions
-
Asynchronously clicks and holds the mouse button down on the element identified by
elementLocatorwithout releasing it, which is useful for drag operations or long-press interactions. - clickAndHold(By) - Method in class com.shaft.gui.element.ElementActions
-
Waits for the element to be clickable, and then clicks and holds it.
- clickUsingJavascript(By) - Method in class com.shaft.gui.element.internal.Actions
- clickUsingJavascript(By) - Method in class com.shaft.gui.element.AsyncElementActions
-
Asynchronously clicks the element identified by
elementLocatorusing JavaScript. - clickUsingJavascript(By) - Method in class com.shaft.gui.element.ElementActions
-
Clicks on certain element using javaScript only
- clickUsingJavascriptWhenWebDriverClickFails() - Method in interface com.shaft.properties.internal.Flags
- clickUsingJavascriptWhenWebDriverClickFails(boolean) - Method in class com.shaft.properties.internal.Flags.SetProperty
- clipboard() - Method in class com.shaft.gui.element.internal.Actions
-
Returns a
Actions.ClipboardActionbuilder that exposes clipboard operations (copy, cut, paste, delete) for a target element. - ClipboardAction - Enum Class in com.shaft.enums.internal
- clipboardActions(String, String, String) - Method in class com.shaft.cucumber.ElementSteps
-
Attempts to perform a native clipboard action on the text from a certain web element, like copy/cut/paste
- clipboardActions(By, ClipboardAction) - Method in class com.shaft.gui.element.AsyncElementActions
-
Asynchronously performs the specified clipboard action (e.g., copy, paste, cut) on the element identified by
elementLocator. - clipboardActions(By, ClipboardAction) - Method in class com.shaft.gui.element.ElementActions
-
Deprecated, for removal: This API element is subject to removal in a future version.
- close() - Method in class com.shaft.tools.io.internal.ProgressBarLogger
- closeCurrentWindow() - Method in class com.shaft.cucumber.BrowserSteps
-
Closes the current browser window
- closeCurrentWindow() - Method in class com.shaft.gui.browser.BrowserActions
-
Closes the current browser window
- closeDriver() - Method in class com.shaft.driver.internal.DriverFactory.DriverFactoryHelper
- closeDriver(WebDriver) - Method in class com.shaft.driver.internal.DriverFactory.DriverFactoryHelper
-
Closes the given WebDriver session and performs all associated teardown tasks: attaches video recording (if scope is DriverSession), collects WebDriver logs, handles dockerized driver cleanup, and removes the WebDriverManager reference.
- com.shaft.api - package com.shaft.api
- com.shaft.cli - package com.shaft.cli
- com.shaft.cucumber - package com.shaft.cucumber
- com.shaft.db - package com.shaft.db
- com.shaft.driver - package com.shaft.driver
- com.shaft.driver.internal - package com.shaft.driver.internal
- com.shaft.driver.internal.DriverFactory - package com.shaft.driver.internal.DriverFactory
- com.shaft.enums.internal - package com.shaft.enums.internal
- com.shaft.gui.browser - package com.shaft.gui.browser
- com.shaft.gui.browser.internal - package com.shaft.gui.browser.internal
- com.shaft.gui.element - package com.shaft.gui.element
- com.shaft.gui.element.internal - package com.shaft.gui.element.internal
- com.shaft.gui.internal.exceptions - package com.shaft.gui.internal.exceptions
- com.shaft.gui.internal.image - package com.shaft.gui.internal.image
- com.shaft.gui.internal.locator - package com.shaft.gui.internal.locator
- com.shaft.gui.internal.video - package com.shaft.gui.internal.video
- com.shaft.listeners - package com.shaft.listeners
- com.shaft.listeners.internal - package com.shaft.listeners.internal
- com.shaft.performance.internal - package com.shaft.performance.internal
- com.shaft.properties.internal - package com.shaft.properties.internal
- com.shaft.tools.internal - package com.shaft.tools.internal
- com.shaft.tools.internal.security - package com.shaft.tools.internal.security
- com.shaft.tools.internal.support - package com.shaft.tools.internal.support
- com.shaft.tools.internal.tms - package com.shaft.tools.internal.tms
- com.shaft.tools.io - package com.shaft.tools.io
- com.shaft.tools.io.internal - package com.shaft.tools.io.internal
- com.shaft.validation - package com.shaft.validation
- com.shaft.validation.accessibility - package com.shaft.validation.accessibility
- com.shaft.validation.internal - package com.shaft.validation.internal
- COMBOBOX - Enum constant in enum class com.shaft.gui.internal.locator.Role
- compareAgainstBaseline(WebDriver, By, byte[], ImageProcessingActions.VisualValidationEngine) - Static method in class com.shaft.gui.internal.image.ImageProcessingActions
- compareImageFolders(String, String, double) - Static method in class com.shaft.gui.internal.image.ImageProcessingActions
- compareJSON(Response, String, RestActions.ComparisonType) - Static method in class com.shaft.api.RestActions
-
Compares the Response object against the content of the referenceJsonFilePath
- compareJSON(Response, String, RestActions.ComparisonType, String) - Static method in class com.shaft.api.RestActions
-
Compares the Response object against the content of the referenceJsonFilePath
- compareTwoObjects(Object, Object, Object, Boolean) - Static method in class com.shaft.tools.internal.support.JavaHelper
-
Compares two objects (that can be cast to a string value) based on the selected comparisonType and ValidationType, then returns the result in an integer value
- ConfigurationHelper - Class in com.shaft.listeners.internal
-
TestNG listener helper that provides
@BeforeTest/@AfterTestlifecycle hooks for attaching SHAFT property files and generating end-of-suite reports. - ConfigurationHelper() - Constructor for class com.shaft.listeners.internal.ConfigurationHelper
-
Constructs a new
ConfigurationHelperinstance. - configureCrossBrowserExecution(List) - Static method in class com.shaft.listeners.internal.TestNGListenerHelper
- configureCucumberProperties(List) - Static method in class com.shaft.listeners.internal.CucumberHelper
-
Applies SHAFT Cucumber property values as parameters on each TestNG suite so that the Cucumber runner can pick them up at execution time.
- configureJVMProxy() - Static method in class com.shaft.listeners.internal.TestNGListenerHelper
- configureTestNGProperties(List) - Static method in class com.shaft.listeners.internal.TestNGListenerHelper
- confirmThatWebsiteIsNotDown(WebDriver, String) - Method in class com.shaft.gui.browser.internal.BrowserActionsHelper
-
Verifies that the page currently loaded in the browser is not a network-error page.
- console() - Method in interface com.shaft.properties.internal.LambdaTest
- console(boolean) - Method in class com.shaft.properties.internal.LambdaTest.SetProperty
- contains(Object) - Method in class com.shaft.validation.internal.NativeValidationsBuilder
-
Use this to check that the actual object contains the expected value
- CONTAINS - Enum constant in enum class com.shaft.api.RestActions.ComparisonType
- CONTAINS - Enum constant in enum class com.shaft.validation.ValidationEnums.ValidationComparisonType
- containsAttribute(String, String) - Method in class com.shaft.gui.internal.locator.LocatorBuilder
- containsClass(String) - Method in class com.shaft.gui.internal.locator.LocatorBuilder
- containsFileContent(String) - Method in class com.shaft.validation.internal.RestValidationsBuilder
-
Use this to check if the content of the provided actual response object contains the expected file content
- containsId(String) - Method in class com.shaft.gui.internal.locator.LocatorBuilder
- containsText(String) - Method in class com.shaft.gui.internal.locator.LocatorBuilder
- content() - Method in class com.shaft.validation.internal.FileValidationsBuilder
-
Use this to attempt to read and validate a certain file content (works for PDF and TEXT files)
- CONTENT - Enum constant in enum class com.shaft.gui.element.internal.ElementActionsHelper.TextDetectionStrategy
- CONTENT_EYES - Enum constant in enum class com.shaft.gui.internal.image.ImageProcessingActions.VisualValidationEngine
- CONTENT_EYES - Enum constant in enum class com.shaft.validation.ValidationEnums.VisualValidationEngine
- convertToSentenceCase(String) - Static method in class com.shaft.tools.internal.support.JavaHelper
- COPY - Enum constant in enum class com.shaft.enums.internal.ClipboardAction
-
Copies the selected content to the clipboard.
- copyAll(By) - Method in class com.shaft.gui.element.internal.Actions.ClipboardAction
-
Selects all text inside the located element and copies it to the system clipboard (Ctrl+A, Ctrl+C).
- copyFile(TerminalActions, String, String, String) - Method in class com.shaft.cli.FileActions
-
Copies files from sourceDirectory to destinationDirectory using the provided terminalSession.
- copyFile(String, String) - Method in class com.shaft.cli.FileActions
-
Copies a file from sourceFilePath to destinationFilePath on the local storage
- copyFileFromJar(String, String, String) - Method in class com.shaft.cli.FileActions
- copyFileToLocalMachine(TerminalActions, String, String, String...) - Method in class com.shaft.cli.FileActions
-
This method is used to copy a certain file from a remote machine (dockerized or not) to the current execution machine.
- copyFolder(String, String) - Method in class com.shaft.cli.FileActions
- copyFolderFromJar(String, String) - Method in class com.shaft.cli.FileActions
- createAnimatedGif() - Method in interface com.shaft.properties.internal.Visuals
- createAnimatedGif(boolean) - Method in class com.shaft.properties.internal.Visuals.SetProperty
- createCounterDocument(String, String) - Static method in class com.shaft.tools.internal.FirestoreRestClient
-
Creates a new document with a counter field initialized to 0.
- createFile(String, String) - Method in class com.shaft.cli.FileActions
- createFolder(String) - Method in class com.shaft.cli.FileActions
- createIssue(List, String, String) - Static method in class com.shaft.tools.internal.tms.XrayIntegrationHelper
-
Create JIRA Bug to report execution failure.
- createLighthouseReportFolderInProjectDirectory() - Method in class com.shaft.performance.internal.LightHouseGenerateReport
- createLogEntry(String, Level) - Static method in class com.shaft.tools.io.internal.ReportManagerHelper
- createReportMessage(String, String, String, Boolean) - Method in class com.shaft.gui.element.internal.ElementActionsHelper
- createTestLog(List) - Static method in class com.shaft.listeners.internal.TestNGListenerHelper
- crossBrowserMode() - Method in interface com.shaft.properties.internal.Platform
- crossBrowserMode(String) - Method in class com.shaft.properties.internal.Platform.SetProperty
- CSS - Enum constant in enum class com.shaft.gui.internal.locator.Locators
- cssProperty(String) - Method in class com.shaft.validation.internal.WebDriverElementValidationsBuilder
-
Use this to check against a certain element attribute
- cssSelector - Static variable in class com.shaft.gui.internal.locator.ShadowLocatorBuilder
- cssValue(By, String) - Method in class com.shaft.gui.element.internal.Actions.GetElementInformation
-
Returns the computed CSS value of the named property for the located element.
- CSV(String) - Constructor for class com.shaft.driver.SHAFT.TestData.CSV
-
Creates a new instance of the test data CSV reader using the target CSV file path
- CSVFileManager - Class in com.shaft.tools.io
- CSVFileManager(String) - Constructor for class com.shaft.tools.io.CSVFileManager
-
Creates a new instance of the test data CSV reader using the target CSV file path
- cucumber - Static variable in class com.shaft.properties.internal.Properties
- Cucumber - Interface in com.shaft.properties.internal
-
Configuration properties interface for Cucumber test execution in the SHAFT framework.
- CUCUMBER - Enum constant in enum class com.shaft.tools.io.internal.ProjectStructureManager.RunType
- cucumberAnsiColorsDisabled() - Method in interface com.shaft.properties.internal.Cucumber
-
Whether ANSI color output is disabled in Cucumber's console output.
- cucumberExecutionDryRun() - Method in interface com.shaft.properties.internal.Cucumber
-
Whether Cucumber runs in dry-run mode, parsing but not executing step definitions.
- cucumberExecutionLimit() - Method in interface com.shaft.properties.internal.Cucumber
-
Maximum number of scenarios to execute.
- cucumberExecutionOrder() - Method in interface com.shaft.properties.internal.Cucumber
-
Order in which Cucumber scenarios are executed (e.g.,
"lexical"or"random"). - cucumberExecutionStrict() - Method in interface com.shaft.properties.internal.Cucumber
-
Whether Cucumber runs in strict mode, treating undefined and pending steps as failures.
- cucumberExecutionWip() - Method in interface com.shaft.properties.internal.Cucumber
-
Whether Cucumber runs in WIP (work-in-progress) mode, failing if any scenario passes.
- CucumberFeatureListener - Class in com.shaft.listeners
-
Allure plugin for Cucumber JVM 7.0.
- CucumberFeatureListener() - Constructor for class com.shaft.listeners.CucumberFeatureListener
- CucumberFeatureListener(AllureLifecycle) - Constructor for class com.shaft.listeners.CucumberFeatureListener
- cucumberFeatures() - Method in interface com.shaft.properties.internal.Cucumber
-
Path(s) to the feature files or directories containing Cucumber feature files.
- cucumberFilterName() - Method in interface com.shaft.properties.internal.Cucumber
-
Regular expression filter to select scenarios by name.
- cucumberFilterTags() - Method in interface com.shaft.properties.internal.Cucumber
-
Tag expression used to filter which scenarios are executed (e.g.,
"@smoke and not @slow"). - cucumberGlue() - Method in interface com.shaft.properties.internal.Cucumber
-
Comma-separated list of packages to scan for Cucumber step definitions and hooks.
- CucumberHelper - Class in com.shaft.listeners.internal
-
Internal helper class providing shared setup and teardown logic for Cucumber-based test runs managed by the SHAFT framework.
- cucumberObjectFactory() - Method in interface com.shaft.properties.internal.Cucumber
-
Fully qualified class name of a custom Cucumber object factory for dependency injection.
- cucumberPlugin() - Method in interface com.shaft.properties.internal.Cucumber
-
Comma-separated list of Cucumber plugins used for reporting and listeners.
- cucumberPublishQuiet() - Method in interface com.shaft.properties.internal.Cucumber
-
Whether the Cucumber publish report banner is suppressed from console output.
- cucumberSnippetType() - Method in interface com.shaft.properties.internal.Cucumber
-
Snippet style used when generating missing step definition stubs (e.g.,
"underscore"or"camelcase"). - CucumberTestRunnerListener - Class in com.shaft.listeners
- CucumberTestRunnerListener() - Constructor for class com.shaft.listeners.CucumberTestRunnerListener
- customBrowserStackYmlPath() - Method in interface com.shaft.properties.internal.BrowserStack
-
Path to a custom
browserstack.ymlfile to use instead of auto-generating one from SHAFT properties. - customBrowserStackYmlPath(String) - Method in class com.shaft.properties.internal.BrowserStack.SetProperty
-
Overrides the
browserStack.customBrowserStackYmlPathproperty at runtime. - customID() - Method in interface com.shaft.properties.internal.BrowserStack
-
Custom ID assigned to an app uploaded to BrowserStack App Automate.
- customID() - Method in interface com.shaft.properties.internal.LambdaTest
- customID(String) - Method in class com.shaft.properties.internal.BrowserStack.SetProperty
-
Overrides the
browserStack.customIDproperty at runtime. - customID(String) - Method in class com.shaft.properties.internal.LambdaTest.SetProperty
- customLogo() - Method in interface com.shaft.properties.internal.Allure
-
URL pointing to a custom logo image that replaces the default SHAFT logo in the Allure report.
- customLogo(String) - Method in class com.shaft.properties.internal.Allure.SetProperty
-
Overrides the
allure.customLogoproperty at runtime. - CustomSoftAssert - Class in com.shaft.validation.internal
-
Enhanced SoftAssert implementation that provides clickable stack traces for failed assertions.
- CustomSoftAssert() - Constructor for class com.shaft.validation.internal.CustomSoftAssert
- customTitle() - Method in interface com.shaft.properties.internal.Allure
-
Custom title displayed in the header of the generated Allure report.
- customTitle(String) - Method in class com.shaft.properties.internal.Allure.SetProperty
-
Overrides the
allure.customTitleproperty at runtime. - CUT - Enum constant in enum class com.shaft.enums.internal.ClipboardAction
-
Cuts the selected content and places it on the clipboard.
- cutAll(By) - Method in class com.shaft.gui.element.internal.Actions.ClipboardAction
-
Selects all text inside the located element, cuts it to the system clipboard (Ctrl+A, Ctrl+X), and leaves the field empty.
D
- DATABASE - Enum constant in enum class com.shaft.driver.DriverFactory.DriverType
- DatabaseActions - Class in com.shaft.db
- DatabaseActions(DatabaseActions.DatabaseType, String, String, String, String, String) - Constructor for class com.shaft.db.DatabaseActions
-
This constructor is used for initializing the database variables that are needed to create new connections and perform queries
- DatabaseActions(String) - Constructor for class com.shaft.db.DatabaseActions
-
This constructor is used for initializing the database variables that are needed to create new connections and perform queries
- DatabaseActions.DatabaseType - Enum Class in com.shaft.db
- databaseLoginTimeout() - Method in interface com.shaft.properties.internal.Timeouts
- databaseLoginTimeout(int) - Method in class com.shaft.properties.internal.Timeouts.SetProperty
- databaseNetworkTimeout() - Method in interface com.shaft.properties.internal.Timeouts
- databaseNetworkTimeout(int) - Method in class com.shaft.properties.internal.Timeouts.SetProperty
- databaseQueryTimeout() - Method in interface com.shaft.properties.internal.Timeouts
- databaseQueryTimeout(int) - Method in class com.shaft.properties.internal.Timeouts.SetProperty
- dataProviderThreadCount() - Method in interface com.shaft.properties.internal.TestNG
- DB(DatabaseActions.DatabaseType, String, String, String, String, String) - Constructor for class com.shaft.driver.SHAFT.DB
- DB(String) - Constructor for class com.shaft.driver.SHAFT.DB
- debug() - Method in interface com.shaft.properties.internal.BrowserStack
-
Whether BrowserStack debug mode is enabled, capturing additional screenshots to aid in diagnosing test failures.
- debug() - Method in interface com.shaft.properties.internal.LambdaTest
- debug(boolean) - Method in class com.shaft.properties.internal.BrowserStack.SetProperty
-
Overrides the
browserStack.debugproperty at runtime. - debug(boolean) - Method in class com.shaft.properties.internal.LambdaTest.SetProperty
- debugMode() - Method in interface com.shaft.properties.internal.Reporting
- debugMode(boolean) - Method in class com.shaft.properties.internal.Reporting.SetProperty
- decrypt() - Static method in class com.shaft.tools.internal.security.GoogleTink
- decrypt(String, String) - Static method in class com.shaft.tools.internal.security.GoogleTink
- defaultElementIdentificationTimeout() - Method in interface com.shaft.properties.internal.Timeouts
- defaultElementIdentificationTimeout(double) - Method in class com.shaft.properties.internal.Timeouts.SetProperty
- defaultProperties() - Method in interface com.shaft.properties.internal.Paths
- delete(String) - Method in class com.shaft.driver.SHAFT.API
- DELETE - Enum constant in enum class com.shaft.api.RestActions.RequestType
- deleteAll(By) - Method in class com.shaft.gui.element.internal.Actions.ClipboardAction
-
Selects all text inside the located element and deletes it (Ctrl+A, Backspace).
- deleteAllCookies() - Method in class com.shaft.gui.browser.BrowserActions
-
Deletes all the cookies of the current browsing context.
- deleteCookie(String) - Method in class com.shaft.gui.browser.BrowserActions
-
Deletes the cookie data matching with the provided cookie name for the current browsing context.
- deleteFile(String) - Method in class com.shaft.cli.FileActions
-
Deletes a file from the local storage
- deleteFolder(String) - Method in class com.shaft.cli.FileActions
- descendant(String) - Method in class com.shaft.gui.internal.locator.XpathAxis
- deviceName() - Method in interface com.shaft.properties.internal.BrowserStack
-
Target device name for mobile app testing on BrowserStack App Automate (e.g.,
"Samsung Galaxy S21"). - deviceName() - Method in interface com.shaft.properties.internal.LambdaTest
- deviceName() - Method in interface com.shaft.properties.internal.Mobile
- deviceName(String) - Method in class com.shaft.properties.internal.BrowserStack.SetProperty
-
Overrides the
browserStack.deviceNameproperty at runtime. - deviceName(String) - Method in class com.shaft.properties.internal.LambdaTest.SetProperty
- deviceName(String) - Method in class com.shaft.properties.internal.Mobile.SetProperty
- disableCache() - Method in interface com.shaft.properties.internal.Flags
- disableCache(boolean) - Method in class com.shaft.properties.internal.Flags.SetProperty
- disableLogging() - Method in interface com.shaft.properties.internal.Reporting
- disableLogging() - Static method in class com.shaft.tools.io.internal.ReportHelper
- disableLogging(boolean) - Method in class com.shaft.properties.internal.Reporting.SetProperty
- disableSslCertificateCheck() - Method in interface com.shaft.properties.internal.Flags
- disableSslCertificateCheck(boolean) - Method in class com.shaft.properties.internal.Flags.SetProperty
- dismissAlert() - Method in class com.shaft.gui.element.AlertActions
-
Dismisses (clicks "Cancel" on) the currently displayed alert or confirm dialog.
- dockerCommandTimeout() - Method in interface com.shaft.properties.internal.Timeouts
- dockerCommandTimeout(int) - Method in class com.shaft.properties.internal.Timeouts.SetProperty
- DOCUMENT_READY_STATE - Enum constant in enum class com.shaft.tools.internal.support.JavaScriptHelper
- doesFileExist(String) - Method in class com.shaft.cli.FileActions
- doesFileExist(String, String, int) - Method in class com.shaft.cli.FileActions
-
Tests whether the file or directory denoted by this abstract pathname exists.
- doesNotContain(Object) - Method in class com.shaft.validation.internal.NativeValidationsBuilder
-
Use this to check that the actual object does not contain the expected value
- doesNotContainFileContent(String) - Method in class com.shaft.validation.internal.RestValidationsBuilder
-
Use this to check if the content of the provided actual response object does not contain the expected file content
- doesNotEqual(Number) - Method in class com.shaft.validation.internal.NumberValidationsBuilder
-
Use this to check that the actual number does not equal the expected value
- doesNotEqual(Object) - Method in class com.shaft.validation.internal.NativeValidationsBuilder
-
Use this to check that the actual object is not equal to the expected value
- doesNotEqualFileContent(String) - Method in class com.shaft.validation.internal.RestValidationsBuilder
-
Use this to check if the content of the provided actual response object is not equal to the expected file content
- doesNotEqualFileContentIgnoringOrder(String) - Method in class com.shaft.validation.internal.RestValidationsBuilder
-
Use this to check if the content of the provided actual response object is not equal to the expected file content (Ignoring Order)
- doesNotEqualIgnoringCaseSensitivity(Object) - Method in class com.shaft.validation.internal.NativeValidationsBuilder
-
Use this to check that the actual object is not equal to the expected value (ignoring case sensitivity)
- doesNotEqualIgnoringOrder(Object) - Method in class com.shaft.validation.internal.JSONValidationsBuilder
-
Use this to check that the actual json response is not equal to the expected json value (ignoring ordering)
- doesNotExist() - Method in class com.shaft.validation.internal.FileValidationsBuilder
-
Use this to check if a certain file does not exist
- doesNotExist() - Method in class com.shaft.validation.internal.WebDriverElementValidationsBuilder
-
Use this to check that the target element does not exist
- doesNotMatchReferenceImage() - Method in class com.shaft.validation.internal.WebDriverElementValidationsBuilder
-
Use this to check that the target element does not match a reference image (using the Artificial Intelligence library OpenCV).
- doesNotMatchReferenceImage(ValidationEnums.VisualValidationEngine) - Method in class com.shaft.validation.internal.WebDriverElementValidationsBuilder
-
Use this to check that the target element does not match a reference image.
- doesNotMatchRegex(Object) - Method in class com.shaft.validation.internal.NativeValidationsBuilder
-
Use this to check that the actual object does not match the expected regular expression
- doesNotMatchSchema(String) - Method in class com.shaft.validation.internal.RestValidationsBuilder
-
Use this to check if the content of the provided actual response object matches the schema for the expected file content
- domAttribute(String) - Method in class com.shaft.validation.internal.WebDriverElementValidationsBuilder
- domAttribute(By, String) - Method in class com.shaft.gui.element.internal.Actions.GetElementInformation
-
Returns the value of the named DOM attribute from the located element.
- domProperty(String) - Method in class com.shaft.validation.internal.WebDriverElementValidationsBuilder
- domProperty(By, String) - Method in class com.shaft.gui.element.internal.Actions.GetElementInformation
-
Returns the value of the named DOM property from the located element.
- DONE - Enum constant in enum class com.shaft.gui.element.TouchActions.KeyboardKeys
- doubleClick(String, String) - Method in class com.shaft.cucumber.ElementSteps
-
Double-clicks on an element using Selenium WebDriver's Actions Library
- doubleClick(By) - Method in class com.shaft.gui.element.internal.Actions
- doubleClick(By) - Method in class com.shaft.gui.element.AsyncElementActions
-
Asynchronously double-clicks the element identified by
elementLocator. - doubleClick(By) - Method in class com.shaft.gui.element.ElementActions
-
Double-clicks on an element using Selenium WebDriver's Actions Library
- doubleTap(By) - Method in class com.shaft.gui.element.TouchActions
-
Double-Taps an element on a touch-enabled screen
- DOWN - Enum constant in enum class com.shaft.gui.element.TouchActions.SwipeDirection
- downloadFile(String, String) - Method in class com.shaft.cli.FileActions
- downloadFile(String, String, int, int) - Method in class com.shaft.cli.FileActions
- downloads() - Method in interface com.shaft.properties.internal.Paths
- downloads(String) - Method in class com.shaft.properties.internal.Paths.SetProperty
- dragAndDrop(String, String, String, String) - Method in class com.shaft.cucumber.ElementSteps
-
Drags the source element and drops it onto the destination element
- dragAndDrop(By, By) - Method in class com.shaft.gui.element.internal.Actions
- dragAndDrop(By, By) - Method in class com.shaft.gui.element.AsyncElementActions
-
Asynchronously drags the element identified by
sourceElementLocatorand drops it onto the element identified bydestinationElementLocator. - dragAndDrop(By, By) - Method in class com.shaft.gui.element.ElementActions
-
Drags the source element and drops it onto the destination element
- dragAndDropByOffset(String, String, int, int) - Method in class com.shaft.cucumber.ElementSteps
-
Drags the source element and drops it onto the determined offset
- dragAndDropByOffset(By, int, int) - Method in class com.shaft.gui.element.internal.Actions
- dragAndDropByOffset(By, int, int) - Method in class com.shaft.gui.element.ElementActions
-
Drags the source element and drops it onto the determined offset
- driver_version() - Method in interface com.shaft.properties.internal.LambdaTest
- driver_version(String) - Method in class com.shaft.properties.internal.LambdaTest.SetProperty
- DriverFactory - Class in com.shaft.driver
- DriverFactory() - Constructor for class com.shaft.driver.DriverFactory
- DriverFactory.DriverType - Enum Class in com.shaft.driver
-
List of the supported driver types for execution
- DriverFactoryHelper - Class in com.shaft.driver.internal.DriverFactory
- DriverFactoryHelper() - Constructor for class com.shaft.driver.internal.DriverFactory.DriverFactoryHelper
- DriverFactoryHelper(WebDriver) - Constructor for class com.shaft.driver.internal.DriverFactory.DriverFactoryHelper
- driverProxySettings() - Method in interface com.shaft.properties.internal.Platform
- driverProxySettings(boolean) - Method in class com.shaft.properties.internal.Platform.SetProperty
- dropFileToUpload(By, String) - Method in class com.shaft.gui.element.internal.Actions
-
Uploads a file by simulating a drag-and-drop gesture onto the target drop zone.
- dynamicObjectRepository() - Method in interface com.shaft.properties.internal.Paths
- dynamicObjectRepository(String) - Method in class com.shaft.properties.internal.Paths.SetProperty
E
- EDGE - Enum constant in enum class com.shaft.driver.DriverFactory.DriverType
- element() - Method in class com.shaft.driver.internal.FluentWebDriverAction
- element() - Method in class com.shaft.driver.SHAFT.GUI.WebDriver.Async
- element() - Method in class com.shaft.driver.SHAFT.GUI.WebDriver
- element(By) - Method in class com.shaft.driver.internal.WizardHelpers.WebDriverAssertions
- element(By) - Method in class com.shaft.driver.internal.WizardHelpers.WebDriverVerifications
- element(WebDriver, By) - Method in class com.shaft.validation.internal.ValidationsBuilder
- ELEMENT - Enum constant in enum class com.shaft.enums.internal.Screenshots
- ELEMENT_DRAG_AND_DROP - Enum constant in enum class com.shaft.tools.internal.support.JavaScriptHelper
- ELEMENT_GET_XPATH - Enum constant in enum class com.shaft.tools.internal.support.JavaScriptHelper
- ELEMENT_SCROLL_TO_VIEWPORT - Enum constant in enum class com.shaft.tools.internal.support.JavaScriptHelper
- ElementActions - Class in com.shaft.gui.element
- ElementActions() - Constructor for class com.shaft.gui.element.ElementActions
- ElementActions(DriverFactoryHelper) - Constructor for class com.shaft.gui.element.ElementActions
- ElementActions(WebDriver) - Constructor for class com.shaft.gui.element.ElementActions
- ElementActions(WebDriver, boolean) - Constructor for class com.shaft.gui.element.ElementActions
- ElementActionsHelper - Class in com.shaft.gui.element.internal
- ElementActionsHelper(boolean) - Constructor for class com.shaft.gui.element.internal.ElementActionsHelper
- ElementActionsHelper.TextDetectionStrategy - Enum Class in com.shaft.gui.element.internal
- ElementInformation - Class in com.shaft.gui.element.internal
- ElementInformation() - Constructor for class com.shaft.gui.element.internal.ElementInformation
- ElementSteps - Class in com.shaft.cucumber
- ElementSteps(ThreadLocal) - Constructor for class com.shaft.cucumber.ElementSteps
- enableBiDi() - Method in interface com.shaft.properties.internal.Platform
- enableBiDi(boolean) - Method in class com.shaft.properties.internal.Platform.SetProperty
- enableBiometric(boolean) - Method in class com.shaft.properties.internal.BrowserStack.SetProperty
-
Overrides the
browserStack.enableBiometricproperty at runtime. - enableLogging() - Static method in class com.shaft.tools.io.internal.ReportHelper
- enableTrueNativeMode() - Method in interface com.shaft.properties.internal.Flags
- enableTrueNativeMode(boolean) - Method in class com.shaft.properties.internal.Flags.SetProperty
- enableUrlEncoding(boolean) - Method in class com.shaft.api.RequestBuilder
-
Tells whether REST Assured should automatically encode the URI if not defined explicitly.
- encodeToBase64String(String) - Static method in class com.shaft.tools.internal.support.JavaHelper
- encrypt() - Static method in class com.shaft.tools.internal.security.GoogleTink
- encrypt(String, String) - Static method in class com.shaft.tools.internal.security.GoogleTink
- EngineProperties<T> - Interface in com.shaft.properties.internal
-
Base interface for all SHAFT engine configuration properties.
- EngineProperties.SetProperty - Interface in com.shaft.properties.internal
-
Marker interface implemented by every concrete fluent property-override builder.
- engineSetup() - Static method in class com.shaft.listeners.internal.CucumberHelper
-
Initialises the SHAFT engine for a Cucumber run: records the execution start time, triggers engine setup, and configures legacy
cucumber.optionssystem property. - engineSetup(ProjectStructureManager.RunType) - Static method in class com.shaft.listeners.TestNGListener
- engineTearDown() - Method in class com.shaft.listeners.internal.ConfigurationHelper
-
TestNG after-test hook that attaches the engine log, Cucumber report, checkpoint summary, and issues log to the Allure report.
- equals(Object) - Method in class com.shaft.validation.internal.NativeValidationsBuilder
-
Overrides the default object method equals and is the same as calling isEqualTo(expectedValue).perform();
- equals(Object) - Method in class com.shaft.validation.internal.NumberValidationsBuilder
-
Overrides the default object method equals and is the same as calling isEqualTo((Number) expectedValue).perform();
- EQUALS - Enum constant in enum class com.shaft.api.RestActions.ComparisonType
- EQUALS - Enum constant in enum class com.shaft.validation.ValidationEnums.NumbersComparativeRelation
- EQUALS - Enum constant in enum class com.shaft.validation.ValidationEnums.ValidationComparisonType
- EQUALS_IGNORING_ORDER - Enum constant in enum class com.shaft.api.RestActions.ComparisonType
- equalsIgnoringCaseSensitivity(Object) - Method in class com.shaft.validation.internal.NativeValidationsBuilder
-
Use this to check that the actual object is equal to the expected value (ignoring case sensitivity)
- equalsIgnoringOrder(Object) - Method in class com.shaft.validation.internal.JSONValidationsBuilder
-
Use this to check that the actual json response is equal to the expected json value (ignoring ordering)
- EXACT_EYES - Enum constant in enum class com.shaft.gui.internal.image.ImageProcessingActions.VisualValidationEngine
- EXACT_EYES - Enum constant in enum class com.shaft.validation.ValidationEnums.VisualValidationEngine
- EXACT_OPENCV - Enum constant in enum class com.shaft.gui.internal.image.ImageProcessingActions.VisualValidationEngine
- EXACT_OPENCV - Enum constant in enum class com.shaft.validation.ValidationEnums.VisualValidationEngine
- EXACT_SHUTTERBUG - Enum constant in enum class com.shaft.gui.internal.image.ImageProcessingActions.VisualValidationEngine
- EXACT_SHUTTERBUG - Enum constant in enum class com.shaft.validation.ValidationEnums.VisualValidationEngine
- EXCEL(String) - Constructor for class com.shaft.driver.SHAFT.TestData.EXCEL
-
Creates a new instance of the test data Excel reader using the target Excel file path
- ExcelFileManager - Class in com.shaft.tools.io
- ExcelFileManager(String) - Constructor for class com.shaft.tools.io.ExcelFileManager
-
Creates a new instance of the test data Excel reader using the target Excel file path
- executeDDLStatement(String) - Method in class com.shaft.db.DatabaseActions
- executeDeleteQuery(String) - Method in class com.shaft.db.DatabaseActions
-
Executes any DML or DDL statement and returns the result as a ResultSet object
- executeInsertQuery(String) - Method in class com.shaft.db.DatabaseActions
-
Executes any DML or DDL statement and returns the result as a ResultSet object
- executeNativeMobileCommand(String, Map) - Method in class com.shaft.gui.element.ElementActions
-
This is a generic method to enable the execution of the native mobile commands found herein: appium.io
- executeNativeMobileCommandUsingJavascript(WebDriver, String, Map) - Method in class com.shaft.gui.element.internal.ElementActionsHelper
- executeSelectQuery(String) - Method in class com.shaft.db.DatabaseActions
-
Executes a SELECT statement and returns the result as a ResultSet object
- executeUpdateQuery(String) - Method in class com.shaft.db.DatabaseActions
-
Executes any DML or DDL statement and returns the result as a ResultSet object
- EXECUTION_SUMMARY - Enum constant in enum class com.shaft.tools.internal.support.HTMLHelper
- EXECUTION_SUMMARY_DETAILS_FORMAT - Enum constant in enum class com.shaft.tools.internal.support.HTMLHelper
- executionAddress() - Method in interface com.shaft.properties.internal.Platform
- executionAddress(String) - Method in class com.shaft.properties.internal.Platform.SetProperty
- executionDescription() - Method in interface com.shaft.properties.internal.Jira
- executionDescription(String) - Method in class com.shaft.properties.internal.Jira.SetProperty
- executionName() - Method in interface com.shaft.properties.internal.Jira
- executionName(String) - Method in class com.shaft.properties.internal.Jira.SetProperty
- executionSummaryReport() - Method in interface com.shaft.properties.internal.Paths
- executionSummaryReport(String) - Method in class com.shaft.properties.internal.Paths.SetProperty
- ExecutionSummaryReport - Class in com.shaft.tools.io.internal
- ExecutionSummaryReport() - Constructor for class com.shaft.tools.io.internal.ExecutionSummaryReport
- ExecutionSummaryReport.Status - Enum Class in com.shaft.tools.io.internal
- ExecutionSummaryReport.StatusIcon - Enum Class in com.shaft.tools.io.internal
- exists() - Method in class com.shaft.validation.internal.FileValidationsBuilder
-
Use this to check if a certain file exists
- exists() - Method in class com.shaft.validation.internal.WebDriverElementValidationsBuilder
-
Use this to check that the target element exists
- extentReports() - Method in interface com.shaft.properties.internal.Paths
- extentReports(String) - Method in class com.shaft.properties.internal.Paths.SetProperty
- extractedJsonValue(String) - Method in class com.shaft.validation.internal.RestValidationsBuilder
-
Use this to extract a certain value from the provided actual response object and check against it
- extractedJsonValueAsList(String) - Method in class com.shaft.validation.internal.RestValidationsBuilder
-
Use this to extract a certain value from the provided actual response object as list and check every item against it
F
- fail(Class, String, Throwable) - Static method in class com.shaft.tools.io.internal.FailureReporter
- fail(String) - Static method in class com.shaft.tools.io.internal.FailureReporter
- FAIL - Enum constant in enum class com.shaft.tools.io.internal.CheckpointStatus
-
The checkpoint failed.
- failAction(Exception...) - Method in class com.shaft.gui.browser.internal.BrowserActionsHelper
-
Reports a failed browser action without a WebDriver instance or test data.
- failAction(WebDriver, String, Exception...) - Method in class com.shaft.gui.browser.internal.BrowserActionsHelper
-
Reports a failed browser action, capturing a screenshot when a driver is provided.
- failAction(WebDriver, String, String, Exception...) - Method in class com.shaft.gui.browser.internal.BrowserActionsHelper
-
Reports a failed browser action with an explicit action name, then throws a test failure.
- failAction(WebDriver, String, String, By, List, Throwable...) - Method in class com.shaft.gui.element.internal.ElementActionsHelper
- failAction(WebDriver, String, By, Throwable...) - Method in class com.shaft.gui.element.internal.ElementActionsHelper
- failAction(WebDriver, String, By, List, Throwable...) - Method in class com.shaft.gui.element.internal.ElementActionsHelper
- failAction(WebDriver, By, Throwable...) - Method in class com.shaft.gui.element.internal.ElementActionsHelper
- FAILED - Enum constant in enum class com.shaft.tools.io.internal.ExecutionSummaryReport.Status
- FAILED - Enum constant in enum class com.shaft.tools.io.internal.ExecutionSummaryReport.StatusIcon
- FAILED - Enum constant in enum class com.shaft.validation.ValidationEnums.ValidationState
- failFast(ITestResult) - Static method in class com.shaft.listeners.internal.TestNGListenerHelper
- failIfViolationsExist(String) - Method in class com.shaft.validation.accessibility.AccessibilityActions
-
Attaches a filtered Allure report for the given page and throws an
AssertionErrorif any accessibility violations exist. - FailureReporter - Class in com.shaft.tools.io.internal
- FailureReporter() - Constructor for class com.shaft.tools.io.internal.FailureReporter
- FALSE - Enum constant in enum class com.shaft.tools.io.PdfFileManager.DeleteFileAfterValidationStatus
- file() - Static method in class com.shaft.driver.SHAFT.CLI
- file(String, String) - Method in class com.shaft.driver.internal.WizardHelpers.StandaloneAssertions
- file(String, String) - Method in class com.shaft.driver.internal.WizardHelpers.StandaloneVerifications
- file(String, String) - Method in class com.shaft.validation.internal.ValidationsBuilder
-
Build a file validation to check against the target file
- FileActions - Class in com.shaft.cli
- FileActions() - Constructor for class com.shaft.cli.FileActions
- FileValidationsBuilder - Class in com.shaft.validation.internal
- FileValidationsBuilder(ValidationEnums.ValidationCategory, String, String, StringBuilder) - Constructor for class com.shaft.validation.internal.FileValidationsBuilder
- findImageWithinCurrentPage(String, byte[]) - Static method in class com.shaft.gui.internal.image.ImageProcessingActions
- FIREFOX - Enum constant in enum class com.shaft.driver.DriverFactory.DriverType
- FirestoreRestClient - Class in com.shaft.tools.internal
-
FirestoreRestClient handles anonymous usage telemetry for SHAFT Engine.
- FirestoreRestClient() - Constructor for class com.shaft.tools.internal.FirestoreRestClient
- flags - Static variable in class com.shaft.properties.internal.Properties
- Flags - Interface in com.shaft.properties.internal
- Flags.SetProperty - Class in com.shaft.properties.internal
- fluentWait() - Method in class com.shaft.driver.internal.DriverFactory.SynchronizationManager
- fluentWait(boolean) - Method in class com.shaft.driver.internal.DriverFactory.SynchronizationManager
- FluentWebDriverAction - Class in com.shaft.driver.internal
- FluentWebDriverAction() - Constructor for class com.shaft.driver.internal.FluentWebDriverAction
- following(String) - Method in class com.shaft.gui.internal.locator.XpathAxis
- followingSibling(String) - Method in class com.shaft.gui.internal.locator.XpathAxis
- forceBrowserDownload() - Method in interface com.shaft.properties.internal.Web
- forceBrowserDownload(boolean) - Method in class com.shaft.properties.internal.Web.SetProperty
- forceCaptureSupportingEvidenceOnRetry() - Method in interface com.shaft.properties.internal.Flags
- forceCaptureSupportingEvidenceOnRetry(boolean) - Method in class com.shaft.properties.internal.Flags.SetProperty
- forceCheckElementLocatorIsUnique() - Method in interface com.shaft.properties.internal.Flags
- forceCheckElementLocatorIsUnique(boolean) - Method in class com.shaft.properties.internal.Flags.SetProperty
- forceCheckForElementVisibility() - Method in interface com.shaft.properties.internal.Flags
- forceCheckForElementVisibility(boolean) - Method in class com.shaft.properties.internal.Flags.SetProperty
- forceCheckForElementVisibility(boolean) - Method in class com.shaft.properties.internal.Reporting.SetProperty
- forceCheckNavigationWasSuccessful() - Method in interface com.shaft.properties.internal.Flags
- forceCheckNavigationWasSuccessful(boolean) - Method in class com.shaft.properties.internal.Flags.SetProperty
- forceCheckStatusOfRemoteServer() - Method in interface com.shaft.properties.internal.Flags
- forceCheckStatusOfRemoteServer(boolean) - Method in class com.shaft.properties.internal.Flags.SetProperty
- forceCheckTextWasTypedCorrectly() - Method in interface com.shaft.properties.internal.Flags
- forceCheckTextWasTypedCorrectly(boolean) - Method in class com.shaft.properties.internal.Flags.SetProperty
- forceFail() - Method in class com.shaft.driver.internal.WizardHelpers.StandaloneAssertions
- forceFail() - Method in class com.shaft.driver.internal.WizardHelpers.StandaloneVerifications
- forceFail() - Method in class com.shaft.validation.internal.ValidationsBuilder
-
Force fails the current validation
- forceFail(String) - Method in class com.shaft.driver.internal.WizardHelpers.StandaloneAssertions
- forceFail(String) - Method in class com.shaft.validation.internal.ValidationsBuilder
- FORM - Enum constant in enum class com.shaft.api.RequestBuilder.AuthenticationType
- FORM - Enum constant in enum class com.shaft.api.RestActions.ParametersType
- formatElementLocatorToImagePath(By) - Static method in class com.shaft.gui.internal.image.ImageProcessingActions
- formatFailureWithStackTrace(AssertionError, String) - Static method in class com.shaft.validation.internal.CustomSoftAssert
-
Gets the formatted failure message with clickable stack trace for a given AssertionError.
- formatLocatorToString(By) - Static method in class com.shaft.tools.internal.support.JavaHelper
- formatStackTraceToLogEntry(Throwable) - Static method in class com.shaft.tools.io.internal.ReportManagerHelper
- formatUrlForBasicAuthentication(String, String, String) - Method in class com.shaft.gui.browser.internal.BrowserActionsHelper
-
Embeds Basic-Authentication credentials into a URL so that the browser submits them automatically on navigation without requiring an interactive prompt.
- formatXML(String) - Static method in class com.shaft.api.RestActions
- FORWARD - Enum constant in enum class com.shaft.enums.internal.NavigationAction
- fromList(List) - Static method in class com.shaft.gui.element.internal.ElementInformation
- FULL - Enum constant in enum class com.shaft.enums.internal.Screenshots
- fullScreenWindow() - Method in class com.shaft.cucumber.BrowserSteps
-
Switches the current browser window to full-screen mode.
- fullScreenWindow() - Method in class com.shaft.gui.browser.BrowserActions
-
Resize the window to fill the current screen
G
- generateAllureReportArchive() - Static method in class com.shaft.tools.io.internal.AllureManager
-
Generates a self-contained ZIP archive of the Allure report when
SHAFT.Properties.allure.generateArchive()istrue. - generateArchive() - Method in interface com.shaft.properties.internal.Allure
-
Whether a self-contained ZIP archive of the generated Allure report should be created after the test run.
- generateArchive(boolean) - Method in class com.shaft.properties.internal.Allure.SetProperty
-
Overrides the
allure.generateArchiveproperty at runtime. - generateAttachmentFileName(String) - Method in class com.shaft.gui.internal.image.ScreenshotManager
- generateBrowserStackYml() - Static method in class com.shaft.driver.internal.DriverFactory.BrowserStackSdkHelper
-
Generates a
browserstack.ymlconfiguration file in the project root directory by mapping SHAFT's BrowserStack properties to the SDK's expected YAML format. - generateExecutionSummaryReport(int, int, int, long, long) - Static method in class com.shaft.tools.io.internal.ExecutionSummaryReport
- generateFilteredHTMLReport(AccessibilityHelper.AccessibilityResult, String, String, WebDriver) - Static method in class com.shaft.validation.accessibility.AccessibilityHelper
-
Generates a minimal HTML accessibility report that lists only the violations contained in the supplied
AccessibilityHelper.AccessibilityResultand writes it to the given file path. - generateLightHouseReport() - Method in class com.shaft.gui.browser.BrowserActions
-
Generates a Google Lighthouse performance report for the currently open page.
- generateLightHouseReport() - Method in class com.shaft.performance.internal.LightHouseGenerateReport
- generatePerformanceReport(Map, long, long) - Static method in class com.shaft.tools.io.internal.ApiPerformanceExecutionReport
-
Calculates per-endpoint performance statistics from the supplied data and writes a timestamped HTML report to the configured performance report directory.
- geoLocation() - Method in interface com.shaft.properties.internal.BrowserStack
-
Geographic location code for IP geolocation testing on BrowserStack (enterprise accounts only).
- geoLocation() - Method in interface com.shaft.properties.internal.LambdaTest
- geoLocation(String) - Method in class com.shaft.properties.internal.BrowserStack.SetProperty
-
Overrides the
browserStack.geoLocationproperty at runtime. - geoLocation(String) - Method in class com.shaft.properties.internal.LambdaTest.SetProperty
- get() - Method in class com.shaft.gui.element.internal.Actions
-
Returns a
Actions.GetElementInformationbuilder that exposes read-only element property accessors such as text, attributes, CSS values, and visibility state. - get() - Method in class com.shaft.tools.io.YAMLFileManager
-
Fetch all the date from the YAML file
- get(String) - Method in class com.shaft.driver.SHAFT.API
- get(String) - Method in class com.shaft.tools.io.JSONFileManager
-
Alias to getTestData
- get(String) - Method in class com.shaft.tools.io.YAMLFileManager
-
Fetch a single piece of data from the YAML file using a single key or a series of keys
- GET - Enum constant in enum class com.shaft.api.RestActions.RequestType
- getAbsolutePath(String) - Method in class com.shaft.cli.FileActions
-
Returns the full (absolute) file/folder path using the project-relative relativePath
- getAbsolutePath(String, String) - Method in class com.shaft.cli.FileActions
-
Returns the full (absolute) file/folder path using the project-relative fileFolderName and the fileName
- getAccessibilityScore() - Method in class com.shaft.validation.accessibility.AccessibilityHelper.AccessibilityResult
-
Returns the overall accessibility score as a percentage in the range
[0.0, 100.0]. - getAiAidedElementIdentificationFolderPath() - Static method in class com.shaft.gui.internal.image.ScreenshotHelper
- getAlertText() - Method in class com.shaft.gui.element.AlertActions
-
Retrieves the text message displayed in the currently active browser alert dialog.
- getAllCookies() - Method in class com.shaft.gui.browser.BrowserActions
-
Gets all cookies for the current browsing context.
- getAPIDriver(String) - Static method in class com.shaft.driver.DriverFactory
-
Creates a new API instance to facilitate using the Rest Actions Library
- getAppiumDesiredCapabilities() - Static method in class com.shaft.properties.internal.PropertyFileManager
- getAs(String, Class) - Method in class com.shaft.tools.io.YAMLFileManager
-
Fetch a single piece of data from the YAML file using a single key or a series of keys
- getAttribute(By, String) - Method in class com.shaft.gui.element.ElementActions
-
Deprecated, for removal: This API element is subject to removal in a future version.
- getBoolean(String) - Method in class com.shaft.tools.io.YAMLFileManager
-
Fetch a single piece of data from the YAML file using a single key or a series of keys
- getBrowser() - Method in class com.shaft.cucumber.BrowserSteps
-
Read the target browser value from the execution.properties file
- getBrowserStackDriver(MutableCapabilities) - Static method in class com.shaft.driver.internal.DriverFactory.BrowserStackHelper
-
Creates a new Selenium WebDriver instance using BrowserStack, use this to test Native Mobile apps over BrowserStack.
- getCallingClassFullName() - Static method in class com.shaft.tools.io.internal.ReportManagerHelper
- getCallingMethodFullName() - Static method in class com.shaft.tools.io.internal.ReportManagerHelper
- getCellCount(int) - Method in class com.shaft.tools.io.CSVFileManager
-
Retrieves the total count of cells in a specific column.
- getCellCount(String) - Method in class com.shaft.tools.io.CSVFileManager
-
Retrieves the total count of cells in a specific column.
- getCellData(int, int) - Method in class com.shaft.tools.io.CSVFileManager
-
Retrieves a specific cell's data based on row number and column name.
- getCellData(int, String) - Method in class com.shaft.tools.io.CSVFileManager
-
Retrieves a specific cell's data based on row number and column name.
- getCellData(String) - Method in class com.shaft.tools.io.ExcelFileManager
-
Reads cell data from the first sheet in the desired Excel workbook Reads cell data using row name (1st column) only Reads cell data from the 2nd column (1st Value in the test data file)
- getCellData(String, String) - Method in class com.shaft.tools.io.ExcelFileManager
-
Reads cell data from the first sheet in the desired Excel workbook Reads cell data using row name (1st column) and column name
- getCellData(String, String, String) - Method in class com.shaft.tools.io.ExcelFileManager
-
Reads cell data from a specific sheet name inside the Excel file Reads cell data using row name (1st column) and column name
- getColumn(String) - Method in class com.shaft.db.DatabaseActions
- getColumn(ResultSet, String) - Static method in class com.shaft.db.DatabaseActions
-
Returns a string value which represents the data of the target column
- getColumn(ResultSet, String) - Static method in class com.shaft.driver.SHAFT.DB
- getColumnNameUsingRowNameAndCellData(String, String) - Method in class com.shaft.tools.io.ExcelFileManager
-
Looks for the column name that holds the cellData in the specified rowName and the default sheet name
- getColumnNameUsingRowNameAndCellData(String, String, String) - Method in class com.shaft.tools.io.ExcelFileManager
-
Looks for the column name that holds the cellData in the specified rowName and sheetName
- getColumns() - Method in class com.shaft.tools.io.CSVFileManager
-
Retrieves the column names from the CSV file.
- getColumnsWithData() - Method in class com.shaft.tools.io.CSVFileManager
-
Maps each column name to its corresponding list of row data.
- getContext() - Method in class com.shaft.gui.browser.BrowserActions
-
Returns the handle for currently active context.
- getContext() - Method in class com.shaft.validation.accessibility.AccessibilityHelper.AccessibilityConfig
-
Returns the CSS selector string used to scope the axe scan to specific page regions.
- getContextHandles() - Method in class com.shaft.gui.browser.BrowserActions
-
Returns a list of unique handles for all the currently open contexts.
- getCookie(String) - Method in class com.shaft.gui.browser.BrowserActions
-
Gets a cookie with a given name.
- getCookieDomain(String) - Method in class com.shaft.gui.browser.BrowserActions
-
Gets the cookie domain.
- getCookiePath(String) - Method in class com.shaft.gui.browser.BrowserActions
-
Gets the cookie path.
- getCookieValue(String) - Method in class com.shaft.gui.browser.BrowserActions
-
Gets the cookie value.
- getCSSProperty(By, String) - Method in class com.shaft.gui.element.ElementActions
-
Deprecated, for removal: This API element is subject to removal in a future version.
- getCurrentFrame() - Method in class com.shaft.gui.element.ElementActions
-
gets the current frame
- getCurrentURL() - Method in class com.shaft.gui.browser.BrowserActions
-
Gets the current page URL and returns it as a string
- getCurrentWindowTitle() - Method in class com.shaft.gui.browser.BrowserActions
-
Gets the current window title and returns it as a string
- getCustomBrowserstackCapabilities() - Static method in class com.shaft.properties.internal.PropertyFileManager
- getCustomWebDriverDesiredCapabilities() - Static method in class com.shaft.properties.internal.PropertyFileManager
- getDatabaseDriver(DatabaseActions.DatabaseType, String, String, String, String, String) - Static method in class com.shaft.driver.DriverFactory
-
Creates a new Database driver instance to facilitate using the Database Actions Library
- getDate(String) - Method in class com.shaft.tools.io.YAMLFileManager
-
Fetch a single piece of data from the YAML file using a single key or a series of keys
- getDiscreteLogging() - Static method in class com.shaft.tools.io.internal.ReportManagerHelper
- getDomainNameFromUrl(String) - Method in class com.shaft.gui.browser.internal.BrowserActionsHelper
-
Extracts the registrable (top-private) domain name from a full URL.
- getDouble(String) - Method in class com.shaft.tools.io.YAMLFileManager
-
Fetch a single piece of data from the YAML file using a single key or a series of keys
- getDriver() - Method in class com.shaft.driver.DriverFactory
- getDriver() - Method in class com.shaft.driver.SHAFT.GUI.WebDriver
-
Returns the current Selenium WebDriver instance for custom manipulation
- getEffectiveProperties() - Static method in class com.shaft.properties.internal.ThreadLocalPropertiesManager
-
Returns a merged view of system properties and thread-local overrides for the current thread.
- getElementName(WebDriver, By) - Method in class com.shaft.gui.element.internal.ElementActionsHelper
- getElementsCount(By) - Method in class com.shaft.gui.element.ElementActions
- getElementsCount(WebDriver, By) - Method in class com.shaft.gui.element.internal.ElementActionsHelper
-
Returns the number of elements that match a certain elementLocator
- getElementTag() - Method in class com.shaft.gui.element.internal.ElementInformation
- getElementText() - Method in class com.shaft.gui.element.internal.ElementInformation
- getExecutionDuration(long, long) - Static method in class com.shaft.tools.io.internal.ReportManagerHelper
- getFailedTestsWithoutOpenIssuesCounter() - Static method in class com.shaft.tools.io.internal.ReportManagerHelper
- getFileChecksum(TerminalActions, String, String, String...) - Method in class com.shaft.cli.FileActions
-
This method is used to compute the SHA256 checksum for any file.
- getFileList(String) - Method in class com.shaft.cli.FileActions
- getFirstColumn() - Method in class com.shaft.tools.io.CSVFileManager
-
Retrieves the name of the first column in the CSV file.
- getHelper() - Method in class com.shaft.driver.DriverFactory
-
Read the target Selenium WebDriver value from the execution.properties file
- getHelper(DriverFactory.DriverType) - Method in class com.shaft.driver.DriverFactory
-
Creates a new Selenium WebDriver instance with custom driver type
- getHelper(DriverFactory.DriverType, MutableCapabilities) - Method in class com.shaft.driver.DriverFactory
-
Creates a new Selenium WebDriver instance with custom driver type and options
- getHelper(WebDriver) - Method in class com.shaft.driver.DriverFactory
-
Attaches the Engine to an already up and running selenium webdriver instance
- getInstance() - Static method in class com.shaft.cli.FileActions
- getInstance() - Static method in class com.shaft.cli.TerminalActions
- getInstance(boolean) - Static method in class com.shaft.cli.FileActions
- getInstance(boolean) - Static method in class com.shaft.cli.TerminalActions
- getInstance(boolean, boolean) - Static method in class com.shaft.cli.TerminalActions
- getInstance(boolean, boolean, boolean) - Static method in class com.shaft.cli.TerminalActions
- getInstance(DatabaseActions.DatabaseType, String, String, String, String, String) - Static method in class com.shaft.db.DatabaseActions
- getInstance(DatabaseActions.DatabaseType, String, String, String, String, String) - Static method in class com.shaft.driver.SHAFT.DB
- getInstance(String) - Static method in class com.shaft.db.DatabaseActions
- getInstance(String) - Static method in class com.shaft.driver.SHAFT.API
- getInstance(String) - Static method in class com.shaft.driver.SHAFT.DB
- getInstance(String) - Static method in class com.shaft.driver.SHAFT.TestData.CSV
- getInstance(String) - Static method in class com.shaft.driver.SHAFT.TestData.EXCEL
- getInstance(String) - Static method in class com.shaft.driver.SHAFT.TestData.JSON
- getInstance(String) - Static method in class com.shaft.driver.SHAFT.TestData.YAML
- getInteger(String) - Method in class com.shaft.tools.io.YAMLFileManager
-
Fetch a single piece of data from the YAML file using a single key or a series of keys
- getIssueAnnotationValue(ITestResult) - Static method in class com.shaft.listeners.internal.TestNGListenerHelper
- getIssueCounter() - Static method in class com.shaft.tools.io.internal.ReportManagerHelper
- getLambdaTestDriver(MutableCapabilities) - Static method in class com.shaft.driver.internal.DriverFactory.LambdaTestHelper
-
Creates a new Selenium WebDriver instance using lambdaTest, use this to test Native Mobile apps over lambdaTest
- getLastColumn() - Method in class com.shaft.tools.io.CSVFileManager
-
Retrieves the name of the last column in the CSV file.
- getLastColumnNumber() - Method in class com.shaft.tools.io.ExcelFileManager
-
Returns the last column number that contains a header value (zero based) assuming that you are working within the default sheet.
- getLastColumnNumber(String) - Method in class com.shaft.tools.io.ExcelFileManager
-
Returns the last column number that contains a header value (zero based).
- getLatestReportPath(String) - Static method in class com.shaft.validation.accessibility.AccessibilityHelper
-
Finds the most recently modified HTML report file for the given page inside the
"accessibility-reports/"directory. - getListAs(String, Class) - Method in class com.shaft.tools.io.YAMLFileManager
-
Fetch a single piece of data from the YAML file using a single key or a series of keys
- getLong(String) - Method in class com.shaft.tools.io.YAMLFileManager
-
Fetch a single piece of data from the YAML file using a single key or a series of keys
- getMapAs(String, Class) - Method in class com.shaft.tools.io.YAMLFileManager
-
Fetch a single piece of data from the YAML file using a single key or a series of keys
- getMatchingElementsInformation(WebDriver, By, boolean) - Method in class com.shaft.gui.element.internal.ElementActionsHelper
- getMaxCellValue(int) - Method in class com.shaft.tools.io.CSVFileManager
-
Retrieves the maximum value from a specific column.
- getMaxCellValue(String) - Method in class com.shaft.tools.io.CSVFileManager
-
Retrieves the maximum value from a specific column.
- getMinCellValue(int) - Method in class com.shaft.tools.io.CSVFileManager
-
Retrieves the minimum value from a specific column.
- getMinCellValue(String) - Method in class com.shaft.tools.io.CSVFileManager
-
Retrieves the minimum value from a specific column.
- getOpenIssuesForFailedTestsCounters() - Static method in class com.shaft.tools.io.internal.ReportManagerHelper
- getOpenIssuesForPassedTestsCounter() - Static method in class com.shaft.tools.io.internal.ReportManagerHelper
- getOverrides() - Static method in class com.shaft.properties.internal.ThreadLocalPropertiesManager
-
Returns the live thread-local overrides map for the current thread.
- getPageName() - Method in class com.shaft.performance.internal.LightHouseGenerateReport
- getPageName() - Method in class com.shaft.validation.accessibility.AccessibilityHelper.AccessibilityResult
-
Returns the page name supplied when the scan was initiated.
- getPageSource() - Method in class com.shaft.gui.browser.BrowserActions
-
Gets the current page source and returns it as a string
- getPassCount() - Method in class com.shaft.validation.accessibility.AccessibilityHelper.AccessibilityResult
-
Returns the number of axe rules the page passed.
- getPasses() - Method in class com.shaft.validation.accessibility.AccessibilityHelper.AccessibilityResult
-
Returns the list of axe
Ruleobjects that the page passed. - getProperty(String) - Static method in class com.shaft.properties.internal.ThreadLocalPropertiesManager
-
Returns the effective value for the given property key by checking the current thread's overrides first and falling back to the corresponding system property.
- getReferenceImage(By) - Static method in class com.shaft.gui.internal.image.ImageProcessingActions
- getReportsDir() - Method in class com.shaft.validation.accessibility.AccessibilityHelper.AccessibilityConfig
-
Returns the file-system directory where JSON and HTML reports will be written.
- getResponse() - Method in class com.shaft.api.RestActions
- getResponse() - Method in class com.shaft.driver.SHAFT.API
- getResponseBody() - Method in class com.shaft.driver.SHAFT.API
- getResponseBody(Response) - Static method in class com.shaft.api.RestActions
-
Extracts the response body and returns it as a plain string
- getResponseJSONValue(Response, String) - Static method in class com.shaft.api.RestActions
-
Extracts a string value from the response body by parsing the target jsonpath
- getResponseJSONValue(Object, String) - Static method in class com.shaft.api.RestActions
- getResponseJSONValue(String) - Method in class com.shaft.driver.SHAFT.API
- getResponseJSONValueAsList(Response, String) - Static method in class com.shaft.api.RestActions
- getResponseJSONValueAsList(String) - Method in class com.shaft.driver.SHAFT.API
- getResponseJSONValueFromList(Response, String, String, String, String) - Static method in class com.shaft.api.RestActions
-
Extracts a string value from an object of a list by reference of another attribute inside the same object
- getResponseStatusCode() - Method in class com.shaft.driver.SHAFT.API
- getResponseStatusCode(Response) - Static method in class com.shaft.api.RestActions
- getResponseTime() - Method in class com.shaft.driver.SHAFT.API
- getResponseTime(Response) - Static method in class com.shaft.api.RestActions
- getResponseXMLValue(Response, String) - Static method in class com.shaft.api.RestActions
- getResponseXMLValue(Object, String) - Static method in class com.shaft.api.RestActions
- getResponseXMLValue(String) - Method in class com.shaft.driver.SHAFT.API
- getResponseXMLValueAsList(Response, String) - Static method in class com.shaft.api.RestActions
- getResponseXMLValueAsList(String) - Method in class com.shaft.driver.SHAFT.API
- getResult() - Method in class com.shaft.db.DatabaseActions
- getResult(ResultSet) - Static method in class com.shaft.db.DatabaseActions
-
Returns a string representation of the provided resultSet object
- getResult(ResultSet) - Static method in class com.shaft.driver.SHAFT.DB
- getRootCause(Throwable) - Static method in class com.shaft.tools.io.internal.FailureReporter
- getRow(String, String) - Method in class com.shaft.db.DatabaseActions
- getRow(ResultSet, String, String) - Static method in class com.shaft.db.DatabaseActions
-
Returns a string value which represents the data of the target row
- getRow(ResultSet, String, String) - Static method in class com.shaft.driver.SHAFT.DB
- getRowCount() - Method in class com.shaft.db.DatabaseActions
- getRowCount(ResultSet) - Static method in class com.shaft.db.DatabaseActions
-
Returns the number of rows contained inside the provided resultSet
- getRowCount(ResultSet) - Static method in class com.shaft.driver.SHAFT.DB
- getRows() - Method in class com.shaft.tools.io.CSVFileManager
-
Retrieves all rows from the CSV file as a list of string arrays.
- getSelectedText(By) - Method in class com.shaft.gui.element.ElementActions
-
Deprecated, for removal: This API element is subject to removal in a future version.
- getShutterbugDifferencesImage(By) - Static method in class com.shaft.gui.internal.image.ImageProcessingActions
- getSpecificColumnData(int) - Method in class com.shaft.tools.io.CSVFileManager
-
Retrieves all data for a specific column.
- getSpecificColumnData(String) - Method in class com.shaft.tools.io.CSVFileManager
-
Retrieves all data for a specific column.
- getSpecificColumnName(int) - Method in class com.shaft.tools.io.CSVFileManager
-
Retrieves the name of a specific column based on its index.
- getString(String) - Method in class com.shaft.tools.io.YAMLFileManager
-
Fetch a single piece of data from the YAML file using a single key or a series of keys
- getTableRowsData(By) - Method in class com.shaft.gui.element.ElementActions
-
Get any simple table rows' data that has thead which include all the column labels and tbody which includes all table data
- getTags() - Method in class com.shaft.validation.accessibility.AccessibilityHelper.AccessibilityConfig
-
Returns the axe-core WCAG tag filters applied during the scan.
- getTerminalDriver() - Static method in class com.shaft.driver.DriverFactory
-
Creates a new local Terminal instance to facilitate using the Terminal Actions Library
- getTestClassName() - Static method in class com.shaft.tools.io.internal.ReportManagerHelper
- getTestData(String) - Method in class com.shaft.tools.io.JSONFileManager
-
Reads the string value at the desired jsonpath within the target test data file
- getTestData(String) - Method in class com.shaft.tools.io.YAMLFileManager
-
Fetch a single piece of data from the YAML file using a single key or a series of keys
- getTestDataAsJson(String) - Method in class com.shaft.tools.io.JSONFileManager
-
Reads the json object value at the desired jsonpath within the target test data file to map it to java object
- getTestDataAsList(String) - Method in class com.shaft.tools.io.JSONFileManager
-
Reads the list value at the desired jsonpath within the target test data file
- getTestDataAsMap(String) - Method in class com.shaft.tools.io.JSONFileManager
-
Reads the map value at the desired jsonpath within the target test data file
- getTestMethodName() - Static method in class com.shaft.tools.io.internal.ReportManagerHelper
- getTestName() - Static method in class com.shaft.listeners.internal.TestNGListenerHelper
- getText(By) - Method in class com.shaft.gui.element.ElementActions
-
Deprecated, for removal: This API element is subject to removal in a future version.
- getTimestamp() - Method in class com.shaft.validation.accessibility.AccessibilityHelper.AccessibilityResult
-
Returns the ISO-8601 timestamp captured when the scan completed.
- getTmsLinkAnnotationValue(ITestResult) - Static method in class com.shaft.listeners.internal.TestNGListenerHelper
- getType() - Static method in enum class com.shaft.enums.internal.Screenshots
- getValue() - Method in enum class com.shaft.validation.ValidationEnums.ValidationState
- getValue() - Method in enum class com.shaft.validation.ValidationEnums.ValidationType
- getVerificationErrorToForceFail() - Static method in class com.shaft.validation.internal.ValidationsHelper
- getVideoRecording() - Static method in class com.shaft.gui.internal.video.RecordManager
- getVideoRecordingFilePath() - Static method in class com.shaft.gui.internal.video.RecordManager
- getViolations() - Method in class com.shaft.validation.accessibility.AccessibilityHelper.AccessibilityResult
-
Returns the list of axe
Ruleobjects representing detected violations. - getViolationsByType(WebDriver) - Static method in class com.shaft.validation.accessibility.AccessibilityHelper
-
Returns a breakdown of axe violations grouped by their WCAG conformance level (e.g.
- getViolationsCount() - Method in class com.shaft.validation.accessibility.AccessibilityHelper.AccessibilityResult
-
Returns the total number of axe violations found during the scan.
- getWindowHandle() - Method in class com.shaft.gui.browser.BrowserActions
-
Gets the current window handle and returns it as a string
- getWindowHandles() - Method in class com.shaft.gui.browser.BrowserActions
-
Returns a list of unique handles for all the currently open windows.
- getWindowHeight() - Method in class com.shaft.gui.browser.BrowserActions
-
Gets the current window size and returns it as a string
- getWindowPosition() - Method in class com.shaft.gui.browser.BrowserActions
-
Gets the current window position and returns it as a string
- getWindowSize() - Method in class com.shaft.gui.browser.BrowserActions
-
Gets the current window size and returns it as a string
- getWindowWidth() - Method in class com.shaft.gui.browser.BrowserActions
-
Gets the current window size and returns it as a string
- GO - Enum constant in enum class com.shaft.gui.element.TouchActions.KeyboardKeys
- GoogleTink - Class in com.shaft.tools.internal.security
- GoogleTink() - Constructor for class com.shaft.tools.internal.security.GoogleTink
- GREATER_THAN - Enum constant in enum class com.shaft.validation.ValidationEnums.NumbersComparativeRelation
- GREATER_THAN_OR_EQUALS - Enum constant in enum class com.shaft.validation.ValidationEnums.NumbersComparativeRelation
- groupByInstances() - Method in interface com.shaft.properties.internal.TestNG
- GUI() - Constructor for class com.shaft.driver.SHAFT.GUI
H
- handleNonSelectDropDown() - Method in interface com.shaft.properties.internal.Flags
- handleNonSelectDropDown(boolean) - Method in class com.shaft.properties.internal.Flags.SetProperty
- HARD_ASSERT - Enum constant in enum class com.shaft.validation.ValidationEnums.ValidationCategory
- hasAnyTagName() - Static method in class com.shaft.gui.internal.locator.Locator
- hasAttribute(String) - Method in class com.shaft.gui.internal.locator.LocatorBuilder
- hasAttribute(String, String) - Method in class com.shaft.gui.internal.locator.LocatorBuilder
- hasClass(String) - Method in class com.shaft.gui.internal.locator.LocatorBuilder
- hasCriticalViolations(WebDriver, String) - Static method in class com.shaft.validation.accessibility.AccessibilityHelper
-
Determines whether the currently loaded page has any axe-detected WCAG violations using the default rule set.
- hasId(String) - Method in class com.shaft.gui.internal.locator.LocatorBuilder
- hasIndex(int) - Method in class com.shaft.gui.internal.locator.LocatorBuilder
- hasRole(Role) - Static method in class com.shaft.gui.internal.locator.Locator
- hasTagName(String) - Static method in class com.shaft.gui.internal.locator.Locator
- hasTagName(String) - Static method in class com.shaft.gui.internal.locator.LocatorBuilder
- hasText(String) - Method in class com.shaft.gui.internal.locator.LocatorBuilder
- hasViolations() - Method in class com.shaft.validation.accessibility.AccessibilityHelper.AccessibilityResult
-
Returns
truewhen at least one WCAG violation was detected. - HEADING - Enum constant in enum class com.shaft.gui.internal.locator.Role
- headless() - Method in interface com.shaft.properties.internal.LambdaTest
- headless(boolean) - Method in class com.shaft.properties.internal.LambdaTest.SetProperty
- headlessExecution() - Method in interface com.shaft.properties.internal.Web
- headlessExecution(boolean) - Method in class com.shaft.properties.internal.Web.SetProperty
- healEnabled() - Method in interface com.shaft.properties.internal.Healenium
- healEnabled(boolean) - Method in class com.shaft.properties.internal.Healenium.SetProperty
- healenium - Static variable in class com.shaft.properties.internal.Properties
- Healenium - Interface in com.shaft.properties.internal
- Healenium.SetProperty - Class in com.shaft.properties.internal
- hideNativeKeyboard() - Method in class com.shaft.gui.element.TouchActions
-
Hides the device native soft keyboard.
- highlightElementInScreenshot(byte[], Rectangle, Color) - Static method in class com.shaft.gui.internal.image.ImageProcessingActions
- HORIZONTAL - Enum constant in enum class com.shaft.gui.element.TouchActions.SwipeMovement
- hover(String, String) - Method in class com.shaft.cucumber.ElementSteps
-
Hovers over target element.
- hover(By) - Method in class com.shaft.gui.element.internal.Actions
- hover(By) - Method in class com.shaft.gui.element.AsyncElementActions
-
Asynchronously moves the mouse cursor over the element identified by
elementLocator, triggering any hover-based UI state (e.g., tooltips, drop-down menus). - hover(By) - Method in class com.shaft.gui.element.ElementActions
-
Hovers over target element.
- hoverAndClick(List, By) - Method in class com.shaft.gui.element.ElementActions
-
Hovers over the hoverElements in sequence then clicks the clickableElement
- HTMLHelper - Enum Class in com.shaft.tools.internal.support
I
- IBM_DB2 - Enum constant in enum class com.shaft.db.DatabaseActions.DatabaseType
- identifyRunType() - Static method in class com.shaft.listeners.TestNGListener
- identifyUniqueElement(WebDriver, By) - Method in class com.shaft.gui.element.internal.ElementActionsHelper
- identifyUniqueElementIgnoringVisibility(WebDriver, By) - Method in class com.shaft.gui.element.internal.ElementActionsHelper
- IE - Enum constant in enum class com.shaft.driver.DriverFactory.DriverType
- IMAGE - Enum constant in enum class com.shaft.gui.internal.locator.Role
- ImageProcessingActions - Class in com.shaft.gui.internal.image
- ImageProcessingActions.VisualValidationEngine - Enum Class in com.shaft.gui.internal.image
- imitatePort() - Method in interface com.shaft.properties.internal.Healenium
- imitatePort(int) - Method in class com.shaft.properties.internal.Healenium.SetProperty
- importCucumberResults(String) - Static method in class com.shaft.tools.internal.tms.XrayIntegrationHelper
-
Import cucumber results recorded in cucumber.jsom file through /import/execution/cucumber endpoint
- importTestNGResults(String) - Static method in class com.shaft.tools.internal.tms.XrayIntegrationHelper
-
Import TestNG results recorded in testng-results.jsom file through /import/execution/testng?
- IN - Enum constant in enum class com.shaft.gui.element.TouchActions.ZoomDirection
- incognitoMode() - Method in interface com.shaft.properties.internal.Web
- incognitoMode(boolean) - Method in class com.shaft.properties.internal.Web.SetProperty
- increment(CheckpointType, String, CheckpointStatus) - Static method in class com.shaft.tools.io.internal.CheckpointCounter
- incrementCounter(String, String) - Static method in class com.shaft.tools.internal.FirestoreRestClient
-
Atomically increments an integer field in a Firestore document.
- initialize() - Method in class com.shaft.driver.internal.FluentWebDriverAction
- initialize() - Static method in class com.shaft.properties.internal.PropertiesHelper
- initialize() - Static method in class com.shaft.tools.internal.security.GoogleTink
- initialize(DriverFactoryHelper) - Method in class com.shaft.driver.internal.FluentWebDriverAction
- initialize(ProjectStructureManager.RunType) - Static method in class com.shaft.tools.io.internal.ProjectStructureManager
- initialize(WebDriver) - Method in class com.shaft.driver.internal.FluentWebDriverAction
- initialize(WebDriver, boolean) - Method in class com.shaft.driver.internal.FluentWebDriverAction
- initializeAiAgent() - Static method in class com.shaft.properties.internal.PropertiesHelper
- initializeAllureReportingEnvironment() - Static method in class com.shaft.tools.io.internal.AllureManager
-
Initialises the Allure reporting environment before a test suite begins.
- initializeDriver() - Method in class com.shaft.driver.internal.DriverFactory.DriverFactoryHelper
- initializeDriver(DriverFactory.DriverType) - Method in class com.shaft.driver.internal.DriverFactory.DriverFactoryHelper
- initializeDriver(DriverFactory.DriverType, MutableCapabilities) - Method in class com.shaft.driver.internal.DriverFactory.DriverFactoryHelper
- initializeDriver(WebDriver) - Method in class com.shaft.driver.internal.DriverFactory.DriverFactoryHelper
- initializeDriver(MutableCapabilities) - Method in class com.shaft.driver.internal.DriverFactory.DriverFactoryHelper
- initializeSystemProperties() - Static method in class com.shaft.driver.internal.DriverFactory.DriverFactoryHelper
- INJECT_INPUT_TO_UPLOAD_FILE_VIA_DROP_ACTION - Enum constant in enum class com.shaft.tools.internal.support.JavaScriptHelper
- inputField(String) - Static method in class com.shaft.gui.internal.locator.Locator
- inputField(String) - Static method in class com.shaft.gui.internal.locator.SmartLocators
- insideShadowDom(By) - Method in class com.shaft.gui.internal.locator.LocatorBuilder
- intercept(Predicate, HttpResponse) - Method in class com.shaft.gui.browser.BrowserActions
-
Intercepts outgoing HTTP requests matching the given predicate and substitutes the real network response with the provided
HttpResponse. - intercept(List, ITestContext) - Method in class com.shaft.listeners.TestNGListener
- internal - Static variable in class com.shaft.properties.internal.Properties
- Internal - Interface in com.shaft.properties.internal
- internalCaptureScreenshot(WebDriver, By, boolean) - Method in class com.shaft.gui.internal.image.ScreenshotManager
- isAccessible(WebDriver) - Static method in class com.shaft.validation.accessibility.AccessibilityHelper
-
Performs a quick axe accessibility check and returns whether the page has zero violations.
- isAlertPresent() - Method in class com.shaft.gui.element.AlertActions
-
Checks whether a browser alert dialog is currently present.
- isChecked() - Method in class com.shaft.validation.internal.WebDriverElementValidationsBuilder
-
Use this to check against the provided elements checked attribute
- isCurrentTestPassed() - Static method in class com.shaft.tools.io.internal.ReportManagerHelper
- isDisabled() - Method in class com.shaft.validation.internal.WebDriverElementValidationsBuilder
-
Use this to check against the provided elements disabled attribute
- isDisplayed(By) - Method in class com.shaft.gui.element.internal.Actions.GetElementInformation
-
Returns
trueif the located element is currently displayed on the page. - isDockerizedTerminal() - Method in class com.shaft.cli.TerminalActions
- isElementClickable(By) - Method in class com.shaft.gui.element.ElementActions
-
Deprecated, for removal: This API element is subject to removal in a future version.
- isElementDisplayed(By) - Method in class com.shaft.gui.element.ElementActions
-
Deprecated, for removal: This API element is subject to removal in a future version.
- isEnabled() - Method in interface com.shaft.properties.internal.Jira
- isEnabled() - Method in interface com.shaft.properties.internal.Performance
- isEnabled() - Method in class com.shaft.validation.internal.WebDriverElementValidationsBuilder
-
Use this to check against the provided elements disabled attribute
- isEnabled(boolean) - Method in class com.shaft.properties.internal.Performance.SetProperty
- isEnabled(By) - Method in class com.shaft.gui.element.internal.Actions.GetElementInformation
-
Returns
trueif the located element is currently enabled (i.e., interactive). - isEnablePerformanceReport() - Method in interface com.shaft.properties.internal.Performance
- isEqualTo(Number) - Method in class com.shaft.validation.internal.NumberValidationsBuilder
-
Use this to check that the actual number is equal to the expected value
- isEqualTo(Object) - Method in class com.shaft.validation.internal.NativeValidationsBuilder
-
Use this to check that the actual object is equal to the expected value
- isEqualToFileContent(String) - Method in class com.shaft.validation.internal.RestValidationsBuilder
-
Use this to check if the content of the provided actual response object is equal to the expected file content
- isEqualToFileContentIgnoringOrder(String) - Method in class com.shaft.validation.internal.RestValidationsBuilder
-
Use this to check if the content of the provided actual response object is equal to the expected file content (Ignoring Order)
- isFalse() - Method in class com.shaft.validation.internal.NativeValidationsBuilder
-
Use this to check that the actual object is false
- isFirst() - Method in class com.shaft.gui.internal.locator.LocatorBuilder
- isFoundInStacktrace(Class, Throwable) - Method in class com.shaft.gui.element.internal.ElementActionsHelper
- isGreaterThan(Number) - Method in class com.shaft.validation.internal.NumberValidationsBuilder
-
Use this to check that the actual number is greater than the expected value
- isGreaterThanOrEquals(Number) - Method in class com.shaft.validation.internal.NumberValidationsBuilder
-
Use this to check that the actual number is greater than or equal to the expected value
- isHidden() - Method in class com.shaft.validation.internal.WebDriverElementValidationsBuilder
-
Use this to check against the provided elements hidden attribute
- isIncludePasses() - Method in class com.shaft.validation.accessibility.AccessibilityHelper.AccessibilityConfig
-
Returns whether passing rules are included in the generated report.
- isInitialized() - Static method in class com.shaft.properties.internal.Properties
-
Returns
trueif the framework property system has been fully initialized (i.e. - isInternalStep() - Static method in class com.shaft.tools.io.internal.ReportManagerHelper
- isLast() - Method in class com.shaft.gui.internal.locator.LocatorBuilder
- isLessThan(Number) - Method in class com.shaft.validation.internal.NumberValidationsBuilder
-
Use this to check that the actual number is less than the expected value
- isLessThanOrEquals(Number) - Method in class com.shaft.validation.internal.NumberValidationsBuilder
-
Use this to check that the actual number is less than or equal to the expected value
- isMobileEmulation() - Method in interface com.shaft.properties.internal.Web
- isMobileEmulation(boolean) - Method in class com.shaft.properties.internal.Web.SetProperty
- isMobileNativeExecution() - Static method in class com.shaft.driver.internal.DriverFactory.DriverFactoryHelper
-
Checks to see if the execution is a mobile-native execution
- isMobileWebExecution() - Static method in class com.shaft.driver.internal.DriverFactory.DriverFactoryHelper
-
Checks to see if the execution is a mobile-web execution
- isNotChecked() - Method in class com.shaft.validation.internal.WebDriverElementValidationsBuilder
-
Use this to check against the provided elements checked attribute
- isNotMobileExecution() - Static method in class com.shaft.driver.internal.DriverFactory.DriverFactoryHelper
-
Checks to see if the execution is a web-based execution
- isNotNull() - Method in class com.shaft.validation.internal.NativeValidationsBuilder
-
Use this to check that the actual object is not null
- isNotSelected() - Method in class com.shaft.validation.internal.WebDriverElementValidationsBuilder
-
Use this to check against the provided elements selected attribute
- isNull() - Method in class com.shaft.validation.internal.NativeValidationsBuilder
-
Use this to check that the actual object is null
- isRealMobile() - Method in interface com.shaft.properties.internal.LambdaTest
- isRealMobile(boolean) - Method in class com.shaft.properties.internal.LambdaTest.SetProperty
- isRemoteTerminal() - Method in class com.shaft.cli.TerminalActions
- isSelected() - Method in class com.shaft.validation.internal.WebDriverElementValidationsBuilder
-
Use this to check against the provided elements selected attribute
- isSelected(By) - Method in class com.shaft.gui.element.internal.Actions.GetElementInformation
-
Returns
trueif the located element (e.g., a checkbox or radio button) is currently selected. - IssueReporter - Class in com.shaft.tools.io.internal
- IssueReporter() - Constructor for class com.shaft.tools.io.internal.IssueReporter
- isTrue() - Method in class com.shaft.validation.internal.NativeValidationsBuilder
-
Use this to check that the actual object is true
- isVisible() - Method in class com.shaft.validation.internal.WebDriverElementValidationsBuilder
-
Use this to check against the provided elements hidden attribute
J
- JavaHelper - Class in com.shaft.tools.internal.support
- JavaScriptHelper - Enum Class in com.shaft.tools.internal.support
- JavaScriptWaitManager - Class in com.shaft.gui.browser.internal
- jira - Static variable in class com.shaft.properties.internal.Properties
- Jira - Interface in com.shaft.properties.internal
- Jira.SetProperty - Class in com.shaft.properties.internal
- JiraHelper - Class in com.shaft.listeners.internal
- JiraHelper() - Constructor for class com.shaft.listeners.internal.JiraHelper
- jiraInteraction(boolean) - Method in class com.shaft.properties.internal.Jira.SetProperty
- jiraUrl(String) - Method in class com.shaft.properties.internal.Jira.SetProperty
- join() - Method in class com.shaft.gui.element.AsyncElementActions
-
Alias for
AsyncElementActions.synchronize(). - JQUERY_ACTIVE_STATE - Enum constant in enum class com.shaft.tools.internal.support.JavaScriptHelper
- JSON - Enum constant in enum class com.shaft.tools.io.JSONFileManager.DataType
- JSON(String) - Constructor for class com.shaft.driver.SHAFT.TestData.JSON
-
Creates a new instance of the test data json reader using the target json file path
- JSONFileManager - Class in com.shaft.tools.io
- JSONFileManager(String) - Constructor for class com.shaft.tools.io.JSONFileManager
-
Creates a new instance of the test data json reader using the target json file path
- JSONFileManager.DataType - Enum Class in com.shaft.tools.io
- JSONValidationsBuilder - Class in com.shaft.validation.internal
- JSONValidationsBuilder(RestValidationsBuilder) - Constructor for class com.shaft.validation.internal.JSONValidationsBuilder
- JUNIT - Enum constant in enum class com.shaft.tools.io.internal.ProjectStructureManager.RunType
- JunitListener - Class in com.shaft.listeners
- JunitListener() - Constructor for class com.shaft.listeners.JunitListener
- JunitListenerHelper - Class in com.shaft.listeners.internal
- JunitListenerHelper() - Constructor for class com.shaft.listeners.internal.JunitListenerHelper
- jvmProxySettings() - Method in interface com.shaft.properties.internal.Platform
- jvmProxySettings(boolean) - Method in class com.shaft.properties.internal.Platform.SetProperty
K
- KEY_CONTAINS_LIST_REGEX - Static variable in class com.shaft.tools.io.YAMLFileManager
- KEY_SEPARATOR_REGEX - Static variable in class com.shaft.tools.io.YAMLFileManager
- keyPress(String, String, String) - Method in class com.shaft.cucumber.ElementSteps
-
Presses a specific keyboard key into the target element.
- keysetFilename() - Method in interface com.shaft.properties.internal.Tinkey
- keysetFilename(String) - Method in class com.shaft.properties.internal.Tinkey.SetProperty
- kmsCredentialPath() - Method in interface com.shaft.properties.internal.Tinkey
- kmsCredentialPath(String) - Method in class com.shaft.properties.internal.Tinkey.SetProperty
- kmsMasterKeyUri() - Method in interface com.shaft.properties.internal.Tinkey
- kmsMasterKeyUri(String) - Method in class com.shaft.properties.internal.Tinkey.SetProperty
- kmsServerType() - Method in interface com.shaft.properties.internal.Tinkey
- kmsServerType(String) - Method in class com.shaft.properties.internal.Tinkey.SetProperty
L
- lambdaTest - Static variable in class com.shaft.properties.internal.Properties
- LambdaTest - Interface in com.shaft.properties.internal
- LAMBDATEST - Enum constant in enum class com.shaft.driver.DriverFactory.DriverType
- LambdaTest.SetProperty - Class in com.shaft.properties.internal
- LambdaTestHelper - Class in com.shaft.driver.internal.DriverFactory
- LambdaTestHelper() - Constructor for class com.shaft.driver.internal.DriverFactory.LambdaTestHelper
- latestVersion - Static variable in class com.shaft.listeners.internal.UpdateChecker
- launcherSessionOpened(LauncherSession) - Method in class com.shaft.listeners.JunitListener
- LAYOUT_EYES - Enum constant in enum class com.shaft.gui.internal.image.ImageProcessingActions.VisualValidationEngine
- LAYOUT_EYES - Enum constant in enum class com.shaft.validation.ValidationEnums.VisualValidationEngine
- lazyLoadingTimeout(int) - Method in class com.shaft.properties.internal.Timeouts.SetProperty
- LEFT - Enum constant in enum class com.shaft.gui.element.TouchActions.SwipeDirection
- LESS_THAN - Enum constant in enum class com.shaft.validation.ValidationEnums.NumbersComparativeRelation
- LESS_THAN_OR_EQUALS - Enum constant in enum class com.shaft.validation.ValidationEnums.NumbersComparativeRelation
- LightHouseGenerateReport - Class in com.shaft.performance.internal
- LightHouseGenerateReport(WebDriver) - Constructor for class com.shaft.performance.internal.LightHouseGenerateReport
- LINK - Enum constant in enum class com.shaft.gui.internal.locator.Role
- link2Tickets(String, String) - Static method in class com.shaft.tools.internal.tms.XrayIntegrationHelper
-
Link any jira 2 tickets using the tickets IDs through PUT API request. the covered relation is relates.
- LIST - Enum constant in enum class com.shaft.gui.internal.locator.Role
- LIST - Enum constant in enum class com.shaft.tools.io.JSONFileManager.DataType
- listFilesInDirectory(TerminalActions, String) - Method in class com.shaft.cli.FileActions
-
Lists all files inside the targetDirectory
- listFilesInDirectory(String) - Method in class com.shaft.cli.FileActions
- listFilesInDirectory(String, TrueFileFilter) - Method in class com.shaft.cli.FileActions
- LISTITEM - Enum constant in enum class com.shaft.gui.internal.locator.Role
- LOAD_JQUERY - Enum constant in enum class com.shaft.tools.internal.support.JavaScriptHelper
- loadOpenCV() - Static method in class com.shaft.gui.internal.image.ImageProcessingActions
- local() - Method in interface com.shaft.properties.internal.BrowserStack
-
Whether BrowserStack Local testing is enabled for accessing localhost or internal servers.
- local(boolean) - Method in class com.shaft.properties.internal.BrowserStack.SetProperty
-
Overrides the
browserStack.localproperty at runtime. - Locator - Class in com.shaft.gui.internal.locator
- Locator() - Constructor for class com.shaft.driver.SHAFT.GUI.Locator
- Locator() - Constructor for class com.shaft.gui.internal.locator.Locator
- LocatorBuilder - Class in com.shaft.gui.internal.locator
- Locators - Enum Class in com.shaft.gui.internal.locator
- log(String) - Static method in class com.shaft.driver.SHAFT.Report
- log(String) - Static method in class com.shaft.tools.io.ReportManager
-
Creates a custom log entry that will also be added as a step in the execution report
- log(String, List) - Static method in class com.shaft.tools.io.internal.ReportManagerHelper
- log(String, Level) - Static method in class com.shaft.tools.io.ReportManager
-
Creates a custom log entry at the specified log level that will also be added as a step in the execution report
- log(Throwable) - Static method in class com.shaft.tools.io.internal.ReportManagerHelper
-
Format an exception message and stack trace, and calls attach to add it as a log entry.
- log4j - Static variable in class com.shaft.properties.internal.Properties
- Log4j - Interface in com.shaft.properties.internal
- logConfigurationMethodInformation(String, String, String) - Static method in class com.shaft.tools.io.internal.ReportManagerHelper
- logDiscrete(String) - Static method in class com.shaft.tools.io.ReportManager
-
Creates a custom log entry that will not be added as a step in the execution report, but you can see it in the attached execution log txt file
- logDiscrete(String, Level) - Static method in class com.shaft.tools.io.internal.ReportManagerHelper
-
Creates a custom log entry that will not be added as a step in the execution report, but you can see it in the attached execution log txt file
- logDiscrete(String, Level) - Static method in class com.shaft.tools.io.ReportManager
- logDiscrete(Throwable) - Static method in class com.shaft.tools.io.internal.ReportManagerHelper
- logDiscrete(Throwable, Level) - Static method in class com.shaft.tools.io.internal.ReportManagerHelper
- logEngineClosure() - Static method in class com.shaft.tools.io.internal.ReportManagerHelper
- logEngineVersion() - Static method in class com.shaft.tools.io.internal.ReportManagerHelper
- logEventToAnalytics(String, long) - Static method in class com.shaft.tools.internal.FirestoreRestClient
-
Logs a custom event to Firebase Analytics via the Measurement Protocol.
- logExecutionSummary(String, String, String, String) - Static method in class com.shaft.tools.io.internal.ReportManagerHelper
- logFinishedTestInformation(String, String, String, String) - Static method in class com.shaft.tools.io.internal.ReportManagerHelper
- logFinishedTestInformation(ITestResult) - Static method in class com.shaft.listeners.internal.TestNGListenerHelper
- loggerAppLevel() - Method in interface com.shaft.properties.internal.Log4j
- loggerAppName() - Method in interface com.shaft.properties.internal.Log4j
- logImportantEntry(String, Level) - Static method in class com.shaft.tools.io.internal.ReportManagerHelper
- logIssue(String) - Static method in class com.shaft.tools.io.internal.ReportManagerHelper
- logNestedSteps(String, List, List) - Static method in class com.shaft.tools.io.internal.ReportManagerHelper
- logNestedSteps(String, List) - Static method in class com.shaft.tools.io.internal.ReportManagerHelper
- LogRedirector - Class in com.shaft.tools.io.internal
- LogRedirector(Logger, Level) - Constructor for class com.shaft.tools.io.internal.LogRedirector
- logScenarioInformation(String, String, String) - Static method in class com.shaft.tools.io.internal.ReportManagerHelper
- logTestInformation(String, String, String) - Static method in class com.shaft.tools.io.internal.ReportManagerHelper
- logTestInformation(TestIdentifier) - Static method in class com.shaft.listeners.internal.JunitListenerHelper
- logTestInformation(ITestResult) - Static method in class com.shaft.listeners.internal.TestNGListenerHelper
- longTap(By) - Method in class com.shaft.gui.element.TouchActions
-
Performs a long-tap on an element to trigger the context menu on a touch-enabled screen
M
- makeFullScreenshot(WebDriver, WebElement...) - Static method in class com.shaft.gui.internal.image.ScreenshotHelper
- MAP - Enum constant in enum class com.shaft.tools.io.JSONFileManager.DataType
- MATCHES - Enum constant in enum class com.shaft.validation.ValidationEnums.ValidationComparisonType
- matchesReferenceImage() - Method in class com.shaft.validation.internal.WebDriverElementValidationsBuilder
-
Use this to check that the target element matches a reference image (using the Artificial Intelligence library SHUTTERBUG).
- matchesReferenceImage(ValidationEnums.VisualValidationEngine) - Method in class com.shaft.validation.internal.WebDriverElementValidationsBuilder
-
Use this to check that the target element matches a reference image.
- matchesRegex(Object) - Method in class com.shaft.validation.internal.NativeValidationsBuilder
-
Use this to check that the actual object matches the expected regular expression
- matchesSchema(String) - Method in class com.shaft.validation.internal.RestValidationsBuilder
-
Use this to check if the content of the provided actual response object matches the schema for the expected file content
- maximizeWindow() - Method in class com.shaft.cucumber.BrowserSteps
-
Maximizes the current browser window to fill the screen.
- maximizeWindow() - Method in class com.shaft.gui.browser.BrowserActions
-
Maximizes current window size based on screen size minus 5%
- maximumPerformanceMode() - Method in interface com.shaft.properties.internal.Flags
- maximumPerformanceMode(int) - Method in class com.shaft.properties.internal.Flags.SetProperty
- mobile - Static variable in class com.shaft.properties.internal.Properties
- Mobile - Interface in com.shaft.properties.internal
- Mobile.SetProperty - Class in com.shaft.properties.internal
- mobileEmulationDeviceName() - Method in interface com.shaft.properties.internal.Web
- mobileEmulationDeviceName(String) - Method in class com.shaft.properties.internal.Web.SetProperty
- mobileEmulationHeight() - Method in interface com.shaft.properties.internal.Web
- mobileEmulationHeight(int) - Method in class com.shaft.properties.internal.Web.SetProperty
- mobileEmulationIsCustomDevice() - Method in interface com.shaft.properties.internal.Web
- mobileEmulationIsCustomDevice(boolean) - Method in class com.shaft.properties.internal.Web.SetProperty
- mobileEmulationPixelRatio() - Method in interface com.shaft.properties.internal.Web
- mobileEmulationPixelRatio(double) - Method in class com.shaft.properties.internal.Web.SetProperty
- mobileEmulationUserAgent() - Method in interface com.shaft.properties.internal.Web
- mobileEmulationUserAgent(String) - Method in class com.shaft.properties.internal.Web.SetProperty
- mobileEmulationWidth() - Method in interface com.shaft.properties.internal.Web
- mobileEmulationWidth(int) - Method in class com.shaft.properties.internal.Web.SetProperty
- mock(Predicate, HttpResponse) - Method in class com.shaft.gui.browser.BrowserActions
-
Intercepts outgoing HTTP requests matching the given predicate and replaces the actual network response with the provided
HttpResponse. - MULTIPART - Enum constant in enum class com.shaft.api.RestActions.ParametersType
- MultipleElementsFoundException - Exception Class in com.shaft.gui.internal.exceptions
- MultipleElementsFoundException() - Constructor for exception class com.shaft.gui.internal.exceptions.MultipleElementsFoundException
- MultipleElementsFoundException(String) - Constructor for exception class com.shaft.gui.internal.exceptions.MultipleElementsFoundException
- MultipleElementsFoundException(String, Throwable) - Constructor for exception class com.shaft.gui.internal.exceptions.MultipleElementsFoundException
- MultipleElementsFoundException(Throwable) - Constructor for exception class com.shaft.gui.internal.exceptions.MultipleElementsFoundException
- MY_SQL - Enum constant in enum class com.shaft.db.DatabaseActions.DatabaseType
N
- name() - Method in interface com.shaft.properties.internal.Log4j
- name(By) - Method in class com.shaft.gui.element.internal.Actions.GetElementInformation
-
Returns the accessible name of the located element as computed by the browser's accessibility tree.
- nativeKeyboardKeyPress(TouchActions.KeyboardKeys) - Method in class com.shaft.gui.element.TouchActions
-
Sends a key-press via the device soft keyboard.
- NativeValidationsBuilder - Class in com.shaft.validation.internal
- NativeValidationsBuilder(FileValidationsBuilder) - Constructor for class com.shaft.validation.internal.NativeValidationsBuilder
- NativeValidationsBuilder(RestValidationsBuilder) - Constructor for class com.shaft.validation.internal.NativeValidationsBuilder
- NativeValidationsBuilder(ValidationsBuilder) - Constructor for class com.shaft.validation.internal.NativeValidationsBuilder
- NativeValidationsBuilder(WebDriverBrowserValidationsBuilder) - Constructor for class com.shaft.validation.internal.NativeValidationsBuilder
- NativeValidationsBuilder(WebDriverElementValidationsBuilder) - Constructor for class com.shaft.validation.internal.NativeValidationsBuilder
- navigateBack() - Method in class com.shaft.cucumber.BrowserSteps
-
Navigates one step back from the browsers history
- navigateBack() - Method in class com.shaft.gui.browser.BrowserActions
-
Navigates one step back from the browsers history
- navigateForward() - Method in class com.shaft.cucumber.BrowserSteps
-
Navigates one step forward from the browsers history
- navigateForward() - Method in class com.shaft.gui.browser.BrowserActions
-
Navigates one step forward from the browsers history
- navigateToNewUrl(WebDriver, String, String, String) - Method in class com.shaft.gui.browser.internal.BrowserActionsHelper
-
Navigates the browser to a new URL.
- navigateToURL(String) - Method in class com.shaft.cucumber.BrowserSteps
-
Navigates to targetUrl in case the current URL is different, else refreshes the current page
- navigateToURL(String) - Method in class com.shaft.gui.browser.BrowserActions
-
Navigates to targetUrl in case the current URL is different, else refreshes the current page
- navigateToURL(String, String) - Method in class com.shaft.cucumber.BrowserSteps
-
Navigates to targetUrl in case the current URL is different, else refreshes the current page.
- navigateToURL(String, String) - Method in class com.shaft.gui.browser.BrowserActions
-
Navigates to targetUrl in case the current URL is different, else refreshes the current page.
- navigateToURL(String, WindowType) - Method in class com.shaft.gui.browser.BrowserActions
-
Navigates to the specified URL by opening it in a new browser tab or a new browser window, depending on the provided
WindowType. - navigateToURLWithBasicAuthentication(String, String, String, String) - Method in class com.shaft.gui.browser.BrowserActions
-
Navigates to targetUrl using basic authentication in case the current URL is different, else refreshes the current page.
- NAVIGATION_TIMEOUT_INTEGER - Static variable in class com.shaft.gui.browser.internal.BrowserActionsHelper
-
The navigation timeout in seconds, sourced from
SHAFT.Properties.timeouts.browserNavigationTimeout(). - NavigationAction - Enum Class in com.shaft.enums.internal
- NEGATIVE - Enum constant in enum class com.shaft.validation.ValidationEnums.ValidationType
- networkLogs() - Method in interface com.shaft.properties.internal.BrowserStack
-
Whether network log capture is enabled during test execution on BrowserStack.
- networkLogs() - Method in interface com.shaft.properties.internal.LambdaTest
- networkLogs(boolean) - Method in class com.shaft.properties.internal.BrowserStack.SetProperty
-
Overrides the
browserStack.networkLogsproperty at runtime. - networkLogs(boolean) - Method in class com.shaft.properties.internal.LambdaTest.SetProperty
- NEXT - Enum constant in enum class com.shaft.gui.element.TouchActions.KeyboardKeys
- NONE - Enum constant in enum class com.shaft.api.RequestBuilder.AuthenticationType
- NONE - Enum constant in enum class com.shaft.gui.element.TouchActions.KeyboardKeys
- NORMAL - Enum constant in enum class com.shaft.gui.element.TouchActions.KeyboardKeys
- number(Number) - Method in class com.shaft.driver.internal.WizardHelpers.StandaloneAssertions
- number(Number) - Method in class com.shaft.driver.internal.WizardHelpers.StandaloneVerifications
- number(Number) - Method in class com.shaft.validation.internal.ValidationsBuilder
-
Build a number validation to check against the target number
- NUMBER_IN_SQUARE_BRACKETS_REGEX - Static variable in class com.shaft.tools.io.YAMLFileManager
- NumberValidationsBuilder - Class in com.shaft.validation.internal
- NumberValidationsBuilder(RestValidationsBuilder) - Constructor for class com.shaft.validation.internal.NumberValidationsBuilder
- NumberValidationsBuilder(ValidationsBuilder) - Constructor for class com.shaft.validation.internal.NumberValidationsBuilder
O
- OBFUSCATED_STRING - Static variable in class com.shaft.gui.element.internal.ElementActionsHelper
- object(boolean) - Method in class com.shaft.driver.internal.WizardHelpers.WebDriverAssertions
- object(boolean) - Method in class com.shaft.driver.internal.WizardHelpers.WebDriverVerifications
- object(Object) - Method in class com.shaft.driver.internal.WizardHelpers.StandaloneAssertions
- object(Object) - Method in class com.shaft.driver.internal.WizardHelpers.StandaloneVerifications
- object(Object) - Method in class com.shaft.validation.internal.ValidationsBuilder
-
Build a native validation to check against the target object
- onAssertFailure(IAssert, AssertionError) - Method in class com.shaft.validation.internal.CustomSoftAssert
- onConfigurationFailure(ITestResult) - Method in class com.shaft.listeners.TestNGListener
- onConfigurationSkip(ITestResult) - Method in class com.shaft.listeners.TestNGListener
- onConfigurationSuccess(ITestResult) - Method in class com.shaft.listeners.TestNGListener
- onError(Object, Method, Object[], InvocationTargetException) - Method in class com.shaft.listeners.internal.WebDriverListener
- onExecutionFinish() - Method in class com.shaft.listeners.TestNGListener
-
gets invoked at the very last (after attachTestArtifacts generation phase), before TestNG exits the JVM.
- onExecutionStart() - Method in class com.shaft.listeners.TestNGListener
-
gets invoked before TestNG proceeds with invoking any other listener.
- onFinish(ISuite) - Method in class com.shaft.listeners.TestNGListener
- onFinish(ITestContext) - Method in class com.shaft.listeners.TestNGListener
- onStart(ISuite) - Method in class com.shaft.listeners.TestNGListener
-
This method is invoked before the SuiteRunner starts.
- onStart(ITestContext) - Method in class com.shaft.listeners.TestNGListener
- onTestFailedButWithinSuccessPercentage(ITestResult) - Method in class com.shaft.listeners.TestNGListener
- onTestFailure(ITestResult) - Method in class com.shaft.listeners.TestNGListener
- onTestSkipped(ITestResult) - Method in class com.shaft.listeners.TestNGListener
- onTestStart(ITestResult) - Method in class com.shaft.listeners.TestNGListener
- onTestSuccess(ITestResult) - Method in class com.shaft.listeners.TestNGListener
- openAllureReportAfterExecution() - Static method in class com.shaft.tools.io.internal.AllureManager
-
Generates the Allure HTML report and opens it in the default browser when
SHAFT.Properties.allure.automaticallyOpen()istrue. - openExecutionSummaryReportAfterExecution() - Method in interface com.shaft.properties.internal.Reporting
- openExecutionSummaryReportAfterExecution() - Static method in class com.shaft.tools.io.internal.ReportManagerHelper
- openExecutionSummaryReportAfterExecution(boolean) - Method in class com.shaft.properties.internal.Reporting.SetProperty
- openLighthouseReportWhileExecution() - Method in class com.shaft.performance.internal.LightHouseGenerateReport
- openLighthouseReportWhileExecution() - Method in interface com.shaft.properties.internal.Reporting
- openLighthouseReportWhileExecution(boolean) - Method in class com.shaft.properties.internal.Reporting.SetProperty
- OptionsManager - Class in com.shaft.driver.internal.DriverFactory
- OptionsManager() - Constructor for class com.shaft.driver.internal.DriverFactory.OptionsManager
- ORACLE - Enum constant in enum class com.shaft.db.DatabaseActions.DatabaseType
- ORACLE_SERVICE_NAME - Enum constant in enum class com.shaft.db.DatabaseActions.DatabaseType
- osVersion() - Method in interface com.shaft.properties.internal.BrowserStack
-
Target operating system version for desktop web testing on BrowserStack Automate (e.g.,
"10"for Windows 10). - osVersion() - Method in interface com.shaft.properties.internal.LambdaTest
- osVersion(String) - Method in class com.shaft.properties.internal.BrowserStack.SetProperty
-
Overrides the
browserStack.osVersionproperty at runtime. - osVersion(String) - Method in class com.shaft.properties.internal.LambdaTest.SetProperty
- OUT - Enum constant in enum class com.shaft.gui.element.TouchActions.ZoomDirection
- overlayShaftEngineLogo(BufferedImage) - Static method in class com.shaft.gui.internal.image.ScreenshotHelper
P
- pageLoadStrategy() - Method in interface com.shaft.properties.internal.Web
- pageLoadStrategy(String) - Method in class com.shaft.properties.internal.Web.SetProperty
- pageLoadTimeout() - Method in interface com.shaft.properties.internal.Timeouts
- pageLoadTimeout(int) - Method in class com.shaft.properties.internal.Timeouts.SetProperty
- parallel() - Method in interface com.shaft.properties.internal.TestNG
- parallelMode() - Method in interface com.shaft.properties.internal.TestNG
- parallelsPerPlatform() - Method in interface com.shaft.properties.internal.BrowserStack
-
Number of parallel test threads to run per platform on BrowserStack.
- parallelsPerPlatform(int) - Method in class com.shaft.properties.internal.BrowserStack.SetProperty
-
Overrides the
browserStack.parallelsPerPlatformproperty at runtime. - parent(String) - Method in class com.shaft.gui.internal.locator.XpathAxis
- parseBodyToJson(Response) - Static method in class com.shaft.api.RestActions
- parseBodyToJson(Object) - Static method in class com.shaft.api.RestActions
- PASS - Enum constant in enum class com.shaft.tools.io.internal.CheckpointStatus
-
The checkpoint passed successfully.
- passAction(String) - Method in class com.shaft.gui.browser.internal.BrowserActionsHelper
-
Reports a successful browser action without a WebDriver instance.
- passAction(WebDriver, String) - Method in class com.shaft.gui.browser.internal.BrowserActionsHelper
-
Reports a successful browser action, attaching a screenshot when a driver is provided.
- passAction(WebDriver, String, String) - Method in class com.shaft.gui.browser.internal.BrowserActionsHelper
-
Reports a successful browser action with an explicit action name.
- passAction(WebDriver, By, String, String, List, String) - Method in class com.shaft.gui.element.internal.ElementActionsHelper
- passAction(WebDriver, By, String, List, String) - Method in class com.shaft.gui.element.internal.ElementActionsHelper
- PASSED - Enum constant in enum class com.shaft.tools.io.internal.ExecutionSummaryReport.Status
- PASSED - Enum constant in enum class com.shaft.tools.io.internal.ExecutionSummaryReport.StatusIcon
- PASSED - Enum constant in enum class com.shaft.validation.ValidationEnums.ValidationState
- paste(By) - Method in class com.shaft.gui.element.internal.Actions.ClipboardAction
-
Pastes the current system clipboard contents into the located element (Ctrl+V).
- PASTE - Enum constant in enum class com.shaft.enums.internal.ClipboardAction
-
Pastes the clipboard content at the current cursor position.
- patch(String) - Method in class com.shaft.driver.SHAFT.API
- PATCH - Enum constant in enum class com.shaft.api.RestActions.RequestType
- paths - Static variable in class com.shaft.properties.internal.Properties
- Paths - Interface in com.shaft.properties.internal
- Paths.SetProperty - Class in com.shaft.properties.internal
- pattern - Static variable in class com.shaft.properties.internal.Properties
- Pattern - Interface in com.shaft.properties.internal
- Pattern.SetProperty - Class in com.shaft.properties.internal
- PdfFileManager - Class in com.shaft.tools.io
- PdfFileManager(String) - Constructor for class com.shaft.tools.io.PdfFileManager
- PdfFileManager(String, String, int) - Constructor for class com.shaft.tools.io.PdfFileManager
- PdfFileManager.DeleteFileAfterValidationStatus - Enum Class in com.shaft.tools.io
- perform() - Method in class com.shaft.api.RequestBuilder
-
After you finish building your request, use this method to trigger the request and get back the response object.
- perform() - Method in class com.shaft.validation.internal.ValidationsExecutor
-
Execute this validation
- performAlertAction() - Method in class com.shaft.driver.internal.FluentWebDriverAction
- performance - Static variable in class com.shaft.properties.internal.Properties
- Performance - Interface in com.shaft.properties.internal
- Performance.SetProperty - Class in com.shaft.properties.internal
- PerformanceReportHTMLHelper - Class in com.shaft.tools.internal.support
- PerformanceReportHTMLHelper() - Constructor for class com.shaft.tools.internal.support.PerformanceReportHTMLHelper
- performanceReportPath() - Method in interface com.shaft.properties.internal.Paths
- performBrowserAction() - Method in class com.shaft.driver.internal.FluentWebDriverAction
- performClipboardActions(WebDriver, ClipboardAction) - Method in class com.shaft.gui.element.internal.ElementActionsHelper
- performElementAction() - Method in class com.shaft.driver.internal.FluentWebDriverAction
- performRequest() - Method in class com.shaft.api.RequestBuilder
-
After you finish building your request, use this method to trigger the request and get back the response object.
- performTerminalCommand(String) - Method in class com.shaft.cli.TerminalActions
- performTerminalCommands(List) - Method in class com.shaft.cli.TerminalActions
- performTouchAction() - Method in class com.shaft.driver.internal.FluentWebDriverAction
- pinchToZoom(TouchActions.ZoomDirection) - Method in class com.shaft.gui.element.TouchActions
-
Attempts to zoom the current screen IN/ OUT in case of zoom enabled screen.
- platform - Static variable in class com.shaft.properties.internal.Properties
- Platform - Interface in com.shaft.properties.internal
- Platform.SetProperty - Class in com.shaft.properties.internal
- platformName() - Method in interface com.shaft.properties.internal.Mobile
- platformName(String) - Method in class com.shaft.properties.internal.Mobile.SetProperty
- platformsList() - Method in interface com.shaft.properties.internal.BrowserStack
-
JSON array defining multiple platform entries for parallel testing across different devices or browsers on BrowserStack.
- platformsList(String) - Method in class com.shaft.properties.internal.BrowserStack.SetProperty
-
Overrides the
browserStack.platformsListproperty at runtime. - platformVersion() - Method in interface com.shaft.properties.internal.BrowserStack
-
Target mobile platform version for native app testing on BrowserStack App Automate (e.g.,
"11"for Android 11). - platformVersion() - Method in interface com.shaft.properties.internal.LambdaTest
- platformVersion() - Method in interface com.shaft.properties.internal.Mobile
- platformVersion(String) - Method in class com.shaft.properties.internal.BrowserStack.SetProperty
-
Overrides the
browserStack.platformVersionproperty at runtime. - platformVersion(String) - Method in class com.shaft.properties.internal.LambdaTest.SetProperty
- platformVersion(String) - Method in class com.shaft.properties.internal.Mobile.SetProperty
- port() - Method in interface com.shaft.properties.internal.Performance
- port(int) - Method in class com.shaft.properties.internal.Performance.SetProperty
- POSITIVE - Enum constant in enum class com.shaft.validation.ValidationEnums.ValidationType
- post(String) - Method in class com.shaft.driver.SHAFT.API
- POST - Enum constant in enum class com.shaft.api.RestActions.RequestType
- POSTGRES_SQL - Enum constant in enum class com.shaft.db.DatabaseActions.DatabaseType
- postProcessing() - Static method in class com.shaft.properties.internal.PropertiesHelper
- preceding(String) - Method in class com.shaft.gui.internal.locator.XpathAxis
- precedingSibling(String) - Method in class com.shaft.gui.internal.locator.XpathAxis
- prepareImageForReport(byte[], String) - Method in class com.shaft.gui.internal.image.ScreenshotManager
- prepareIssuesLog() - Static method in class com.shaft.tools.io.internal.ReportManagerHelper
- prepareTestResultAttributes(IInvokedMethod, ITestResult) - Static method in class com.shaft.listeners.internal.JiraHelper
-
The method is to update testng-results.xml with the required data to integrate with xray plugin The Method uses Epic, Feature, Story and Test allure annotations' values.
- preserveOrder() - Method in interface com.shaft.properties.internal.TestNG
- PREVIOUS - Enum constant in enum class com.shaft.gui.element.TouchActions.KeyboardKeys
- ProgressBarLogger - Class in com.shaft.tools.io.internal
- ProgressBarLogger(String) - Constructor for class com.shaft.tools.io.internal.ProgressBarLogger
- ProgressBarLogger(String, int) - Constructor for class com.shaft.tools.io.internal.ProgressBarLogger
- project() - Method in interface com.shaft.properties.internal.LambdaTest
- project(String) - Method in class com.shaft.properties.internal.LambdaTest.SetProperty
- projectKey() - Method in interface com.shaft.properties.internal.Jira
- projectKey(String) - Method in class com.shaft.properties.internal.Jira.SetProperty
- projectName() - Method in interface com.shaft.properties.internal.BrowserStack
-
Custom project name for BrowserStack dashboard reporting.
- projectName(String) - Method in class com.shaft.properties.internal.BrowserStack.SetProperty
-
Overrides the
browserStack.projectNameproperty at runtime. - ProjectStructureManager - Class in com.shaft.tools.io.internal
- ProjectStructureManager() - Constructor for class com.shaft.tools.io.internal.ProjectStructureManager
- ProjectStructureManager.RunType - Enum Class in com.shaft.tools.io.internal
- properties() - Method in interface com.shaft.properties.internal.Paths
- properties(String) - Method in class com.shaft.properties.internal.Paths.SetProperty
- Properties - Class in com.shaft.properties.internal
-
Central holder for all SHAFT property configuration objects.
- Properties() - Constructor for class com.shaft.driver.SHAFT.Properties
- Properties() - Constructor for class com.shaft.properties.internal.Properties
- PropertiesHelper - Class in com.shaft.properties.internal
- PropertiesHelper() - Constructor for class com.shaft.properties.internal.PropertiesHelper
- property(String) - Method in class com.shaft.validation.internal.WebDriverElementValidationsBuilder
-
Use this to check against a certain element attribute
- PropertyFileManager - Class in com.shaft.properties.internal
- proxy() - Method in interface com.shaft.properties.internal.Platform
- proxySettings(String) - Method in class com.shaft.properties.internal.Platform.SetProperty
- pullFile(String, String) - Method in class com.shaft.gui.element.TouchActions
-
Downloads a file from the device or simulator/emulator to the local machine.
- pushFile(String, File) - Method in class com.shaft.gui.element.TouchActions
-
Uploads a file to the device or simulator/emulator using a File object.
- pushFile(String, String) - Method in class com.shaft.gui.element.TouchActions
-
Uploads a file to the device or simulator/emulator.
- put(String) - Method in class com.shaft.driver.SHAFT.API
- PUT - Enum constant in enum class com.shaft.api.RestActions.RequestType
Q
- QUERY - Enum constant in enum class com.shaft.api.RestActions.ParametersType
- quit() - Method in class com.shaft.driver.SHAFT.GUI.WebDriver
R
- RADIO - Enum constant in enum class com.shaft.gui.internal.locator.Role
- readCounter(String, String) - Static method in class com.shaft.tools.internal.FirestoreRestClient
-
Reads a document and prints its content.
- readCustomPropertyFiles() - Static method in class com.shaft.properties.internal.PropertyFileManager
- readFile(String) - Method in class com.shaft.cli.FileActions
- readFile(String, String) - Method in class com.shaft.cli.FileActions
- readFileAsByteArray(String) - Method in class com.shaft.cli.FileActions
- readFileContent() - Method in class com.shaft.tools.io.PdfFileManager
- readFileContent(String, boolean...) - Static method in class com.shaft.tools.io.PdfFileManager
-
Read PDF file content given relative path and optionally delete the file after reading it
- readinessState() - Method in interface com.shaft.properties.internal.Web
- readinessState(String) - Method in class com.shaft.properties.internal.Web.SetProperty
- readPDF(String) - Method in class com.shaft.cli.FileActions
- readPDF(String, String) - Method in class com.shaft.cli.FileActions
- readPDFContentFromDownloadedPDF(int, int, PdfFileManager.DeleteFileAfterValidationStatus) - Method in class com.shaft.tools.io.PdfFileManager
- readPDFContentFromDownloadedPDF(PdfFileManager.DeleteFileAfterValidationStatus) - Method in class com.shaft.tools.io.PdfFileManager
- RecordManager - Class in com.shaft.gui.internal.video
- recoveryTries() - Method in interface com.shaft.properties.internal.Healenium
- recoveryTries(int) - Method in class com.shaft.properties.internal.Healenium.SetProperty
- REFRESH - Enum constant in enum class com.shaft.enums.internal.NavigationAction
- refreshCurrentPage() - Method in class com.shaft.cucumber.BrowserSteps
-
Refreshes the currently loaded page in the browser.
- refreshCurrentPage() - Method in class com.shaft.gui.browser.BrowserActions
-
Attempts to refresh the current page
- reloadProperties() - Static method in class com.shaft.driver.DriverFactory
- remoteServerInstanceCreationTimeout() - Method in interface com.shaft.properties.internal.Timeouts
- remoteServerInstanceCreationTimeout(int) - Method in class com.shaft.properties.internal.Timeouts.SetProperty
- removeSpecialCharacters(String) - Static method in class com.shaft.tools.internal.support.JavaHelper
- renameFile(String, String) - Method in class com.shaft.cli.FileActions
- renameTestExecutionSuit(String, String) - Static method in class com.shaft.tools.internal.tms.XrayIntegrationHelper
-
Import TestNG results recorded in testng-results.jsom file through /import/execution/testng?
- replaceRegex(String) - Static method in class com.shaft.tools.internal.support.JavaHelper
-
Returns text after replaces its regular expressions which included in this set []^$.|?
- replaceRegex(String[], String) - Static method in class com.shaft.tools.internal.support.JavaHelper
-
Takes two parameters, one is the array of special characters that are needed to be replaced, and the text needed to be updated It converts text with %40%23%24%25%26 ..etc (special characters) to return it with %5C%5C%40%5C%5C%23%5C%5C%24%5C%5C%25%5C%5C%26
- report(String) - Static method in class com.shaft.driver.SHAFT.Report
- REPORT_PORTAL_SERVICE - Static variable in class com.shaft.listeners.TestNGListener
- reportActionResult(WebDriver, String, String, By, List, String, Boolean, Throwable...) - Method in class com.shaft.gui.element.internal.ElementActionsHelper
- reportBugs() - Method in interface com.shaft.properties.internal.Jira
- reportBugs(boolean) - Method in class com.shaft.properties.internal.Jira.SetProperty
- reportBugsToJIRA(List, String, ITestResult, ITestNGMethod) - Static method in class com.shaft.listeners.internal.JiraHelper
-
is called in afterInvocation() to report bugs in case of failure and if the integration is enabled
- reportExecutionStatusToJira() - Static method in class com.shaft.listeners.internal.JiraHelper
- ReportHelper - Class in com.shaft.tools.io.internal
- ReportHelper() - Constructor for class com.shaft.tools.io.internal.ReportHelper
- reporting - Static variable in class com.shaft.properties.internal.Properties
- Reporting - Interface in com.shaft.properties.internal
- Reporting.SetProperty - Class in com.shaft.properties.internal
- ReportManager - Class in com.shaft.tools.io
- ReportManagerHelper - Class in com.shaft.tools.io.internal
- reportPath() - Method in interface com.shaft.properties.internal.Jira
- reportPath(String) - Method in class com.shaft.properties.internal.Jira.SetProperty
- reportTestCasesExecution() - Method in interface com.shaft.properties.internal.Jira
- reportTestCasesExecution(boolean) - Method in class com.shaft.properties.internal.Jira.SetProperty
- RequestBuilder - Class in com.shaft.api
- RequestBuilder.AuthenticationType - Enum Class in com.shaft.api
-
The type of your authentication method {BASIC, FORM, NONE}
- resetVerificationStateAfterFailing() - Static method in class com.shaft.validation.internal.ValidationsHelper
- resolution() - Method in interface com.shaft.properties.internal.LambdaTest
- resolution(String) - Method in class com.shaft.properties.internal.LambdaTest.SetProperty
- respectBuiltInWaitsInNativeMode() - Method in interface com.shaft.properties.internal.Flags
- respectBuiltInWaitsInNativeMode(boolean) - Method in class com.shaft.properties.internal.Flags.SetProperty
- response(Object) - Method in class com.shaft.validation.internal.ValidationsBuilder
-
Build an API response validation to check against the target API response
- RestActions - Class in com.shaft.api
- RestActions(String) - Constructor for class com.shaft.api.RestActions
- RestActions(String, SHAFT.API) - Constructor for class com.shaft.api.RestActions
- RestActions.ComparisonType - Enum Class in com.shaft.api
- RestActions.ParametersType - Enum Class in com.shaft.api
- RestActions.RequestType - Enum Class in com.shaft.api
- RestValidationsBuilder - Class in com.shaft.validation.internal
- RestValidationsBuilder(ValidationEnums.ValidationCategory, Object, StringBuilder) - Constructor for class com.shaft.validation.internal.RestValidationsBuilder
- retry(ITestResult) - Method in class com.shaft.listeners.internal.RetryAnalyzer
- RetryAnalyzer - Class in com.shaft.listeners.internal
-
TestNG retry analyzer that re-runs failed tests up to a configurable maximum number of attempts.
- RetryAnalyzer() - Constructor for class com.shaft.listeners.internal.RetryAnalyzer
- retryMaximumNumberOfAttempts() - Method in interface com.shaft.properties.internal.Flags
- retryMaximumNumberOfAttempts(int) - Method in class com.shaft.properties.internal.Flags.SetProperty
- RIGHT - Enum constant in enum class com.shaft.gui.element.TouchActions.SwipeDirection
- Role - Enum Class in com.shaft.gui.internal.locator
- rootLogger() - Method in interface com.shaft.properties.internal.Log4j
- rotate(ScreenOrientation) - Method in class com.shaft.gui.element.TouchActions
-
Rotate between portrait and landscape modes
S
- SAFARI - Enum constant in enum class com.shaft.driver.DriverFactory.DriverType
- safeFindElement(WebDriver, By) - Static method in class com.shaft.gui.element.internal.ElementActionsHelper
-
Safely calls
driver.findElement(locator), handling the infinite recursion between Selenium 4.41.0'sElementLocationand Appium java-client 10.0.0'sAppiumBy.findElements(SearchContext). - safeFindElements(WebDriver, By) - Static method in class com.shaft.gui.element.internal.ElementActionsHelper
-
Safely calls
driver.findElements(locator), handling the infinite recursion between Selenium 4.41.0'sElementLocationand Appium java-client 10.0.0'sAppiumBy.findElements(SearchContext). - scoreCap() - Method in interface com.shaft.properties.internal.Healenium
- scoreCap(String) - Method in class com.shaft.properties.internal.Healenium.SetProperty
- ScreenshotHelper - Class in com.shaft.gui.internal.image
- ScreenshotManager - Class in com.shaft.gui.internal.image
- ScreenshotManager() - Constructor for class com.shaft.gui.internal.image.ScreenshotManager
- screenshotParamsHighlightElements() - Method in interface com.shaft.properties.internal.Visuals
- screenshotParamsHighlightElements(boolean) - Method in class com.shaft.properties.internal.Visuals.SetProperty
- screenshotParamsHighlightMethod() - Method in interface com.shaft.properties.internal.Visuals
- screenshotParamsHighlightMethod(String) - Method in class com.shaft.properties.internal.Visuals.SetProperty
- screenshotParamsScalingFactor() - Method in interface com.shaft.properties.internal.Visuals
- screenshotParamsScalingFactor(double) - Method in class com.shaft.properties.internal.Visuals.SetProperty
- screenshotParamsScreenshotType() - Method in interface com.shaft.properties.internal.Visuals
- screenshotParamsScreenshotType(String) - Method in class com.shaft.properties.internal.Visuals.SetProperty
- screenshotParamsSkippedElementsFromScreenshot() - Method in interface com.shaft.properties.internal.Visuals
- screenshotParamsSkippedElementsFromScreenshot(String) - Method in class com.shaft.properties.internal.Visuals.SetProperty
- screenshotParamsWatermark() - Method in interface com.shaft.properties.internal.Visuals
- screenshotParamsWatermark(boolean) - Method in class com.shaft.properties.internal.Visuals.SetProperty
- screenshotParamsWatermarkOpacity() - Method in interface com.shaft.properties.internal.Visuals
- screenshotParamsWatermarkOpacity(float) - Method in class com.shaft.properties.internal.Visuals.SetProperty
- screenshotParamsWhenToTakeAScreenshot() - Method in interface com.shaft.properties.internal.Visuals
- screenshotParamsWhenToTakeAScreenshot(String) - Method in class com.shaft.properties.internal.Visuals.SetProperty
- Screenshots - Enum Class in com.shaft.enums.internal
- scriptExecutionTimeout() - Method in interface com.shaft.properties.internal.Timeouts
- scriptExecutionTimeout(int) - Method in class com.shaft.properties.internal.Timeouts.SetProperty
- scrollingMode() - Method in interface com.shaft.properties.internal.Flags
- scrollingMode(String) - Method in class com.shaft.properties.internal.Flags.SetProperty
- scrollToElement(By) - Method in class com.shaft.gui.element.ElementActions
-
If the element is outside the viewport, scrolls the bottom of the element to the bottom of the viewport.
- scrollToFindElement(WebDriver, By) - Method in class com.shaft.gui.element.internal.ElementActionsHelper
- SEARCH - Enum constant in enum class com.shaft.gui.element.TouchActions.KeyboardKeys
- select(String, String, String) - Method in class com.shaft.cucumber.ElementSteps
-
Selects an element from a dropdown list using its displayed text
- select(By, String) - Method in class com.shaft.gui.element.AsyncElementActions
-
Asynchronously selects the option matching
textin the drop-down element identified byelementLocator. - select(By, String) - Method in class com.shaft.gui.element.ElementActions
-
Selects an element from a dropdown list using its displayed text or attribute Value
- SELECT_ALL - Enum constant in enum class com.shaft.enums.internal.ClipboardAction
-
Selects all content in the target element or context.
- selectedText(By) - Method in class com.shaft.gui.element.internal.Actions.GetElementInformation
-
Returns the combined text of all currently selected
<option>elements inside a<select>element. - selenium_version() - Method in interface com.shaft.properties.internal.LambdaTest
- selenium_version(String) - Method in class com.shaft.properties.internal.LambdaTest.SetProperty
- seleniumVersion() - Method in interface com.shaft.properties.internal.BrowserStack
-
Selenium version to use on BrowserStack Automate.
- seleniumVersion(String) - Method in class com.shaft.properties.internal.BrowserStack.SetProperty
-
Overrides the
browserStack.seleniumVersionproperty at runtime. - selfManaged(boolean) - Method in class com.shaft.properties.internal.Mobile.SetProperty
- selfManagedAndroidSDKVersion(int) - Method in class com.shaft.properties.internal.Mobile.SetProperty
- SEND - Enum constant in enum class com.shaft.gui.element.TouchActions.KeyboardKeys
- sendAppToBackground() - Method in class com.shaft.gui.element.TouchActions
-
Send the currently active app to the background and leave the app deactivated.
- sendAppToBackground(int) - Method in class com.shaft.gui.element.TouchActions
-
Send the currently active app to the background, and return after a certain number of seconds.
- sendGraphQlRequest(String, String) - Static method in class com.shaft.api.RestActions
-
Perform Graphql Request using Query - WITHOUT Header.
- sendGraphQlRequest(String, String, String) - Static method in class com.shaft.api.RestActions
-
Perform Graphql Request using Query and Variables - WITHOUT Header.
- sendGraphQlRequest(String, String, String, String) - Static method in class com.shaft.api.RestActions
-
Perform Graphql Request using Query, Variables, and Fragments - WITHOUT Header.
- sendGraphQlRequestWithHeader(String, String, String, String) - Static method in class com.shaft.api.RestActions
-
Perform Graphql Request using Query - WITH Header.
- sendGraphQlRequestWithHeader(String, String, String, String, String) - Static method in class com.shaft.api.RestActions
-
Perform Graphql Request using Query and Variables - WITH Header.
- sendGraphQlRequestWithHeader(String, String, String, String, String, String) - Static method in class com.shaft.api.RestActions
-
Perform Graphql Request using Query, Variables, and Fragments - WITH Header.
- sendTelemetry(long, long) - Static method in class com.shaft.tools.internal.FirestoreRestClient
-
Sends anonymous telemetry data if telemetry is enabled.
- serverHost() - Method in interface com.shaft.properties.internal.Healenium
- serverHost(String) - Method in class com.shaft.properties.internal.Healenium.SetProperty
- serverPort() - Method in interface com.shaft.properties.internal.Healenium
- serverPort(int) - Method in class com.shaft.properties.internal.Healenium.SetProperty
- services() - Method in interface com.shaft.properties.internal.Paths
- services(String) - Method in class com.shaft.properties.internal.Paths.SetProperty
- set() - Method in interface com.shaft.properties.internal.Allure
-
Returns a fluent
Allure.SetPropertybuilder for programmatically overriding Allure properties. - set() - Method in interface com.shaft.properties.internal.API
-
Returns a fluent
API.SetPropertybuilder for programmatically overriding API properties. - set() - Method in interface com.shaft.properties.internal.BrowserStack
- set() - Method in interface com.shaft.properties.internal.EngineProperties
-
Returns a fluent
EngineProperties.SetPropertybuilder that allows programmatic override of individual configuration properties at runtime. - set() - Method in interface com.shaft.properties.internal.Flags
- set() - Method in interface com.shaft.properties.internal.Healenium
- set() - Method in interface com.shaft.properties.internal.Jira
- set() - Method in interface com.shaft.properties.internal.LambdaTest
- set() - Method in interface com.shaft.properties.internal.Mobile
- set() - Method in interface com.shaft.properties.internal.Paths
- set() - Method in interface com.shaft.properties.internal.Pattern
- set() - Method in interface com.shaft.properties.internal.Performance
- set() - Method in interface com.shaft.properties.internal.Platform
- set() - Method in interface com.shaft.properties.internal.Reporting
- set() - Method in interface com.shaft.properties.internal.Timeouts
- set() - Method in interface com.shaft.properties.internal.Tinkey
- set() - Method in interface com.shaft.properties.internal.Visuals
- set() - Method in interface com.shaft.properties.internal.Web
- setAuthentication(String, String, RequestBuilder.AuthenticationType) - Method in class com.shaft.api.RequestBuilder
-
Set the authentication method that will be used by the API request that you're currently building.
- setClearBeforeTypingMode() - Static method in class com.shaft.properties.internal.PropertiesHelper
- setContentType(ContentType) - Method in class com.shaft.api.RequestBuilder
-
Sets the content type for the API request that you're currently building.
- setContentType(String) - Method in class com.shaft.api.RequestBuilder
-
Sets the content type for the API request that you're currently building.
- setContext(String) - Method in class com.shaft.gui.browser.BrowserActions
-
Switches focus to another context
- setContext(String) - Method in class com.shaft.validation.accessibility.AccessibilityHelper.AccessibilityConfig
-
Restricts the axe scan to the DOM subtrees matched by the given CSS selector.
- setDebugMode(Boolean) - Static method in class com.shaft.tools.io.internal.ReportManagerHelper
- setDiscreteLogging(boolean) - Static method in class com.shaft.tools.io.internal.ReportManagerHelper
- setEventPublisher(EventPublisher) - Method in class com.shaft.listeners.CucumberFeatureListener
- setEventPublisher(EventPublisher) - Method in class com.shaft.listeners.CucumberTestRunnerListener
- setFailedTestsWithoutOpenIssuesCounter(int) - Static method in class com.shaft.tools.io.internal.ReportManagerHelper
- setFeatureName(String) - Static method in class com.shaft.tools.io.internal.ReportManagerHelper
- setIncludePasses(boolean) - Method in class com.shaft.validation.accessibility.AccessibilityHelper.AccessibilityConfig
-
Controls whether passing axe rules are written into the report.
- setKeySystemProperties() - Static method in class com.shaft.properties.internal.PropertiesHelper
- setListOfNewIssuesForFailedTests(List) - Static method in class com.shaft.tools.io.internal.ReportManagerHelper
- setListOfOpenIssuesForFailedTests(List) - Static method in class com.shaft.tools.io.internal.ReportManagerHelper
- setListOfOpenIssuesForPassedTests(List) - Static method in class com.shaft.tools.io.internal.ReportManagerHelper
- setMobilePlatform() - Static method in class com.shaft.properties.internal.PropertiesHelper
- setOpenIssuesForFailedTestsCounter(int) - Static method in class com.shaft.tools.io.internal.ReportManagerHelper
- setOpenIssuesForPassedTestsCounter(int) - Static method in class com.shaft.tools.io.internal.ReportManagerHelper
- setPageName(String) - Method in class com.shaft.validation.accessibility.AccessibilityHelper.AccessibilityResult
-
Sets the page name for this result.
- setParameters(List, RestActions.ParametersType) - Method in class com.shaft.api.RequestBuilder
-
Deprecated.Use setParameters(Map<String, Object>, RestActions.ParametersType) instead. This method will be removed in a future release. Sets the parameters (if any) for the API request that you're currently building. A request usually has only one of the following: urlArguments, parameters+type, or body
- setParameters(Map, RestActions.ParametersType) - Method in class com.shaft.api.RequestBuilder
-
Sets API request parameters using a Map<String, Object>.
- setPasses(List) - Method in class com.shaft.validation.accessibility.AccessibilityHelper.AccessibilityResult
-
Sets the list of passing axe rules for this result.
- setPassesCount(int) - Method in class com.shaft.validation.accessibility.AccessibilityHelper.AccessibilityResult
-
Sets the number of rules that the scanned page passed.
- setPathParameters(String...) - Method in class com.shaft.api.RequestBuilder
-
Dynamically sets path parameters by replacing placeholders in the `serviceName` using ordered string values.
- setPathParameters(Map) - Method in class com.shaft.api.RequestBuilder
-
Dynamically sets path parameters by replacing placeholders in the `serviceName` using key-value pairs.
- setProperty(String, String) - Static method in class com.shaft.properties.internal.ThreadLocalPropertiesManager
-
Sets a property override for the current thread only.
- SetProperty() - Constructor for class com.shaft.properties.internal.Allure.SetProperty
-
Creates a new
SetPropertyinstance. - SetProperty() - Constructor for class com.shaft.properties.internal.API.SetProperty
-
Creates a new
SetPropertyinstance. - SetProperty() - Constructor for class com.shaft.properties.internal.BrowserStack.SetProperty
-
Creates a new
SetPropertyinstance. - SetProperty() - Constructor for class com.shaft.properties.internal.Flags.SetProperty
- SetProperty() - Constructor for class com.shaft.properties.internal.Healenium.SetProperty
- SetProperty() - Constructor for class com.shaft.properties.internal.Jira.SetProperty
- SetProperty() - Constructor for class com.shaft.properties.internal.LambdaTest.SetProperty
- SetProperty() - Constructor for class com.shaft.properties.internal.Mobile.SetProperty
- SetProperty() - Constructor for class com.shaft.properties.internal.Paths.SetProperty
- SetProperty() - Constructor for class com.shaft.properties.internal.Pattern.SetProperty
- SetProperty() - Constructor for class com.shaft.properties.internal.Performance.SetProperty
- SetProperty() - Constructor for class com.shaft.properties.internal.Platform.SetProperty
- SetProperty() - Constructor for class com.shaft.properties.internal.Reporting.SetProperty
- SetProperty() - Constructor for class com.shaft.properties.internal.Timeouts.SetProperty
- SetProperty() - Constructor for class com.shaft.properties.internal.Tinkey.SetProperty
- SetProperty() - Constructor for class com.shaft.properties.internal.Visuals.SetProperty
- SetProperty() - Constructor for class com.shaft.properties.internal.Web.SetProperty
- setReportsDir(String) - Method in class com.shaft.validation.accessibility.AccessibilityHelper.AccessibilityConfig
-
Sets the output directory for generated accessibility reports.
- setRequestBody(Object) - Method in class com.shaft.api.RequestBuilder
-
Sets the body (if any) for the API request that you're currently building.
- setRequestBodyFromFile(String) - Method in class com.shaft.api.RequestBuilder
-
Sets the body (if any) for the API request that you're currently building.
- setRootPackage(String) - Method in class com.shaft.validation.internal.CustomSoftAssert
-
Allows configuring the root package used when filtering stack trace elements.
- setScore(double) - Method in class com.shaft.validation.accessibility.AccessibilityHelper.AccessibilityResult
-
Sets the pre-computed accessibility score for this result.
- setTags(List) - Method in class com.shaft.validation.accessibility.AccessibilityHelper.AccessibilityConfig
-
Replaces the axe-core tag filters for this scan.
- setTargetStatusCode(int) - Method in class com.shaft.api.RequestBuilder
-
Sets the expected target status code for the API request that you're currently building.
- setTestCaseDescription(String) - Static method in class com.shaft.tools.io.internal.ReportManagerHelper
- setTestCaseName(String) - Static method in class com.shaft.tools.io.internal.ReportManagerHelper
- setTestName(TestIdentifier) - Static method in class com.shaft.listeners.internal.JunitListenerHelper
- setTestName(ITestContext) - Static method in class com.shaft.listeners.internal.TestNGListenerHelper
- setTimestamp(String) - Method in class com.shaft.validation.accessibility.AccessibilityHelper.AccessibilityResult
-
Sets the scan timestamp.
- setTotalNumberOfTests(int) - Static method in class com.shaft.tools.io.internal.ReportManagerHelper
- setTotalNumberOfTests(ISuite) - Static method in class com.shaft.listeners.internal.TestNGListenerHelper
- setUrlArguments(String) - Method in class com.shaft.api.RequestBuilder
-
Sets the url arguments (if any) for the API request that you're currently building.
- setValueUsingJavaScript(String, String, String) - Method in class com.shaft.cucumber.ElementSteps
-
Used to SetProperty value for an element (hidden or visible) using javascript
- setValueUsingJavaScript(By, String) - Method in class com.shaft.gui.element.internal.Actions
- setValueUsingJavaScript(By, String) - Method in class com.shaft.gui.element.AsyncElementActions
-
Asynchronously sets the
valueattribute of the element identified byelementLocatordirectly via JavaScript, bypassing normal input events. - setValueUsingJavaScript(By, String) - Method in class com.shaft.gui.element.ElementActions
-
Used to SetProperty value for an element (hidden or visible) using javascript
- setViolations(List) - Method in class com.shaft.validation.accessibility.AccessibilityHelper.AccessibilityResult
-
Sets the violations list and synchronises
AccessibilityHelper.AccessibilityResult.violationsCountaccordingly. - setViolationsCount(int) - Method in class com.shaft.validation.accessibility.AccessibilityHelper.AccessibilityResult
-
Explicitly sets the violations count.
- setWindowSize(int, int) - Method in class com.shaft.cucumber.BrowserSteps
-
Resizes the current browser window to the specified dimensions.
- setWindowSize(int, int) - Method in class com.shaft.gui.browser.BrowserActions
-
Resizes the current window size based on the provided width and height
- shadowDomLocator - Static variable in class com.shaft.gui.internal.locator.ShadowLocatorBuilder
- ShadowLocatorBuilder - Class in com.shaft.gui.internal.locator
- ShadowLocatorBuilder(By, By) - Constructor for class com.shaft.gui.internal.locator.ShadowLocatorBuilder
- SHAFT - Class in com.shaft.driver
- SHAFT() - Constructor for class com.shaft.driver.SHAFT
- SHAFT.API - Class in com.shaft.driver
- SHAFT.CLI - Class in com.shaft.driver
- SHAFT.DB - Class in com.shaft.driver
- SHAFT.GUI - Class in com.shaft.driver
- SHAFT.GUI.Locator - Class in com.shaft.driver
- SHAFT.GUI.WebDriver - Class in com.shaft.driver
- SHAFT.GUI.WebDriver.Async - Class in com.shaft.driver
- SHAFT.Properties - Class in com.shaft.driver
- SHAFT.Report - Class in com.shaft.driver
- SHAFT.TestData - Class in com.shaft.driver
- SHAFT.TestData.CSV - Class in com.shaft.driver
- SHAFT.TestData.EXCEL - Class in com.shaft.driver
- SHAFT.TestData.JSON - Class in com.shaft.driver
- SHAFT.TestData.YAML - Class in com.shaft.driver
- SHAFT.Validations - Class in com.shaft.driver
- shaftEngineVersion() - Method in interface com.shaft.properties.internal.Internal
- shaftTearDown() - Static method in class com.shaft.listeners.internal.CucumberHelper
-
Performs SHAFT engine teardown at the end of a native Cucumber run (i.e. when there is no active TestNG
Reporterresult). - shellSessionTimeout() - Method in interface com.shaft.properties.internal.Timeouts
- shellSessionTimeout(long) - Method in class com.shaft.properties.internal.Timeouts.SetProperty
- SIKULI - Enum constant in enum class com.shaft.driver.DriverFactory.DriverType
- SKIPPED - Enum constant in enum class com.shaft.tools.io.internal.ExecutionSummaryReport.Status
- SKIPPED - Enum constant in enum class com.shaft.tools.io.internal.ExecutionSummaryReport.StatusIcon
- skipTestsWithLinkedIssues() - Method in interface com.shaft.properties.internal.Flags
- skipTestsWithLinkedIssues(boolean) - Method in class com.shaft.properties.internal.Flags.SetProperty
- skipTestsWithLinkedIssues(ITestResult) - Static method in class com.shaft.listeners.internal.TestNGListenerHelper
- SmartLocators - Class in com.shaft.gui.internal.locator
- SmartLocators() - Constructor for class com.shaft.gui.internal.locator.SmartLocators
- SOFT_ASSERT - Enum constant in enum class com.shaft.validation.ValidationEnums.ValidationCategory
- SQL_SERVER - Enum constant in enum class com.shaft.db.DatabaseActions.DatabaseType
- SQUARE_BRACKETS_REGEX - Static variable in class com.shaft.tools.io.YAMLFileManager
- StandaloneAssertions() - Constructor for class com.shaft.driver.internal.WizardHelpers.StandaloneAssertions
- StandaloneVerifications() - Constructor for class com.shaft.driver.internal.WizardHelpers.StandaloneVerifications
- startOrAppendToAnimatedGif(byte[]) - Static method in class com.shaft.gui.internal.image.AnimatedGifManager
-
Appends a screenshot frame to the current thread's animated GIF, or starts a new GIF if one has not yet been created for the current thread.
- startVideoRecording() - Static method in class com.shaft.gui.internal.video.RecordManager
- startVideoRecording(WebDriver) - Static method in class com.shaft.gui.internal.video.RecordManager
- STRICT_EYES - Enum constant in enum class com.shaft.gui.internal.image.ImageProcessingActions.VisualValidationEngine
- STRICT_EYES - Enum constant in enum class com.shaft.validation.ValidationEnums.VisualValidationEngine
- STRING - Enum constant in enum class com.shaft.tools.io.JSONFileManager.DataType
- submitFormUsingJavascript(WebDriver, By) - Method in class com.shaft.gui.element.internal.ElementActionsHelper
- submitFormUsingJavaScript(String, String) - Method in class com.shaft.cucumber.ElementSteps
-
Used to submit a form using javascript
- submitFormUsingJavaScript(By) - Method in class com.shaft.gui.element.AsyncElementActions
-
Asynchronously submits the form that contains the element identified by
elementLocatorusing JavaScript, bypassing standard form-submission validation. - submitFormUsingJavaScript(By) - Method in class com.shaft.gui.element.ElementActions
-
Used to submit a form using javascript
- suiteSetup(ITestContext) - Method in class com.shaft.listeners.internal.ConfigurationHelper
-
TestNG before-test hook that attaches SHAFT property files to the Allure report so they are available for inspection after the run.
- swaggerValidationEnabled() - Method in interface com.shaft.properties.internal.API
-
Whether automatic Swagger/OpenAPI response-schema validation is enabled for all API calls.
- swaggerValidationEnabled(boolean) - Method in class com.shaft.properties.internal.API.SetProperty
-
Overrides the
swagger.validation.enabledproperty at runtime. - swaggerValidationUrl() - Method in interface com.shaft.properties.internal.API
-
The URL of the Swagger/OpenAPI specification document used for response validation.
- swaggerValidationUrl(String) - Method in class com.shaft.properties.internal.API.SetProperty
-
Overrides the
swagger.validation.urlproperty at runtime. - swipeByOffset(By, int, int) - Method in class com.shaft.gui.element.TouchActions
-
Swipes an element with the desired x and y offset.
- swipeElementIntoView(String) - Method in class com.shaft.gui.element.TouchActions
-
Attempts to scroll element into view using androidUIAutomator
- swipeElementIntoView(String, TouchActions.SwipeDirection) - Method in class com.shaft.gui.element.TouchActions
-
Attempts to scroll element into view using the new W3C compliant actions for android and ios and AI for image identification
- swipeElementIntoView(String, TouchActions.SwipeMovement) - Method in class com.shaft.gui.element.TouchActions
-
Attempts to scroll element into view using androidUIAutomator
- swipeElementIntoView(By, TouchActions.SwipeDirection) - Method in class com.shaft.gui.element.TouchActions
-
Attempts to scroll the element into view in case of native mobile elements.
- swipeElementIntoView(By, String, TouchActions.SwipeDirection) - Method in class com.shaft.gui.element.TouchActions
-
Attempts to scroll element into view using the new W3C compliant actions for android and ios and AI for image identification
- swipeElementIntoView(By, By, TouchActions.SwipeDirection) - Method in class com.shaft.gui.element.TouchActions
-
Attempts to scroll element into view using the new W3C compliant actions for android and ios
- swipeToElement(By, By) - Method in class com.shaft.gui.element.TouchActions
-
Swipes the sourceElement onto the destinationElement on a touch-enabled screen
- switchToDefaultContent() - Method in class com.shaft.gui.element.ElementActions
-
Switches focus to default content, is mainly used in coordination with
ElementActions.switchToIframe(By)to exit any iFrame layer and go back to the main page - switchToIframe(By) - Method in class com.shaft.gui.element.ElementActions
-
Switches focus to a certain iFrame, is mainly used in coordination with
ElementActions.switchToDefaultContent()to navigate inside any iFrame layer and go back to the main page - switchToWindow(String) - Method in class com.shaft.gui.browser.BrowserActions
-
Switches focus to another window
- sync() - Method in class com.shaft.gui.element.AsyncElementActions
-
Alias for
AsyncElementActions.synchronize(). - SynchronizationManager - Class in com.shaft.driver.internal.DriverFactory
- SynchronizationManager(WebDriver) - Constructor for class com.shaft.driver.internal.DriverFactory.SynchronizationManager
- synchronize() - Method in class com.shaft.gui.element.AsyncElementActions
-
Blocks the calling thread until all previously queued asynchronous actions have finished executing on their respective virtual threads.
T
- TABLE - Enum constant in enum class com.shaft.gui.internal.locator.Role
- TABLE_CELL - Enum constant in enum class com.shaft.gui.internal.locator.Role
- TABLE_COLUMNHEADER - Enum constant in enum class com.shaft.gui.internal.locator.Role
- TABLE_ROW - Enum constant in enum class com.shaft.gui.internal.locator.Role
- takeElementScreenshot(WebDriver, By) - Method in class com.shaft.gui.internal.image.ScreenshotManager
- takeScreenshot(WebDriver, By) - Method in class com.shaft.gui.internal.image.ScreenshotManager
- takeScreenshot(WebDriver, By, String, boolean) - Method in class com.shaft.gui.internal.image.ScreenshotManager
- takeScreenshot(WebDriver, By, String, String, boolean) - Method in class com.shaft.gui.element.internal.ElementActionsHelper
- tap(String) - Method in class com.shaft.gui.element.TouchActions
-
Taps an element once on a touch-enabled screen
- tap(By) - Method in class com.shaft.gui.element.TouchActions
-
Taps an element once on a touch-enabled screen
- targetBrowserName() - Method in interface com.shaft.properties.internal.Web
- targetBrowserName(String) - Method in class com.shaft.properties.internal.Web.SetProperty
- targetPlatform() - Method in interface com.shaft.properties.internal.Platform
- targetPlatform(String) - Method in class com.shaft.properties.internal.Platform.SetProperty
- telemetryEnabled() - Method in interface com.shaft.properties.internal.Flags
- terminal() - Static method in class com.shaft.driver.SHAFT.CLI
- TERMINAL - Enum constant in enum class com.shaft.driver.DriverFactory.DriverType
- TerminalActions - Class in com.shaft.cli
- TerminalActions() - Constructor for class com.shaft.cli.TerminalActions
-
This constructor is used for local terminal actions.
- TerminalActions(boolean) - Constructor for class com.shaft.cli.TerminalActions
-
This constructor is used for local terminal actions.
- TerminalActions(String, int, String, String, String) - Constructor for class com.shaft.cli.TerminalActions
-
This constructor is used for remote terminal actions.
- TerminalActions(String, int, String, String, String, String, String) - Constructor for class com.shaft.cli.TerminalActions
-
This constructor is used for remote terminal actions inside a docker.
- TerminalActions(String, String) - Constructor for class com.shaft.cli.TerminalActions
-
This constructor is used for local terminal actions inside a docker.
- testData() - Method in interface com.shaft.properties.internal.Paths
- testData(String) - Method in class com.shaft.properties.internal.Paths.SetProperty
- TestData() - Constructor for class com.shaft.driver.SHAFT.TestData
- testDataColumnNamePrefix() - Method in interface com.shaft.properties.internal.Pattern
- testDataColumnNamePrefix(String) - Method in class com.shaft.properties.internal.Pattern.SetProperty
- testNG - Static variable in class com.shaft.properties.internal.Properties
- TestNG - Interface in com.shaft.properties.internal
- TESTNG - Enum constant in enum class com.shaft.tools.io.internal.ProjectStructureManager.RunType
- TestNGListener - Class in com.shaft.listeners
- TestNGListener() - Constructor for class com.shaft.listeners.TestNGListener
- TestNGListenerHelper - Class in com.shaft.listeners.internal
- TestNGListenerHelper() - Constructor for class com.shaft.listeners.internal.TestNGListenerHelper
- testSuiteTimeout() - Method in interface com.shaft.properties.internal.TestNG
-
Test Suite Timeout in Minutes Default is 1440 minutes == 24 hours
- text() - Method in class com.shaft.validation.internal.WebDriverElementValidationsBuilder
-
Use this to check against the provided elements text attribute
- text(By) - Method in class com.shaft.gui.element.internal.Actions.GetElementInformation
-
Returns the visible inner text of the located element.
- TEXT - Enum constant in enum class com.shaft.gui.element.internal.ElementActionsHelper.TextDetectionStrategy
- TEXTBOX - Enum constant in enum class com.shaft.gui.internal.locator.Role
- textTrimmed() - Method in class com.shaft.validation.internal.WebDriverElementValidationsBuilder
-
Use this to check against the provided elements text attribute after it's trimmed (all leading and trailing space removed)
- threadCount() - Method in interface com.shaft.properties.internal.TestNG
- ThreadLocalPropertiesManager - Class in com.shaft.properties.internal
-
Manages per-thread property overrides for SHAFT properties.
- time() - Method in class com.shaft.validation.internal.RestValidationsBuilder
- timeoutForRemoteServerToBeUp() - Method in interface com.shaft.properties.internal.Timeouts
- timeoutForRemoteServerToBeUp(int) - Method in class com.shaft.properties.internal.Timeouts.SetProperty
- timeouts - Static variable in class com.shaft.properties.internal.Properties
- Timeouts - Interface in com.shaft.properties.internal
- Timeouts.SetProperty - Class in com.shaft.properties.internal
- timezone() - Method in interface com.shaft.properties.internal.LambdaTest
- timezone(String) - Method in class com.shaft.properties.internal.LambdaTest.SetProperty
- tinkey - Static variable in class com.shaft.properties.internal.Properties
- Tinkey - Interface in com.shaft.properties.internal
- Tinkey.SetProperty - Class in com.shaft.properties.internal
- title() - Method in class com.shaft.validation.internal.WebDriverBrowserValidationsBuilder
-
Use this to check against the current page title
- toList() - Method in class com.shaft.gui.element.internal.ElementInformation
- toString() - Method in class com.shaft.validation.accessibility.AccessibilityHelper.AccessibilityResult
- touch() - Method in class com.shaft.driver.internal.FluentWebDriverAction
- touch() - Method in class com.shaft.driver.SHAFT.GUI.WebDriver
- TouchActions - Class in com.shaft.gui.element
- TouchActions() - Constructor for class com.shaft.gui.element.TouchActions
- TouchActions(DriverFactoryHelper) - Constructor for class com.shaft.gui.element.TouchActions
- TouchActions(WebDriver) - Constructor for class com.shaft.gui.element.TouchActions
- TouchActions.KeyboardKeys - Enum Class in com.shaft.gui.element
- TouchActions.SwipeDirection - Enum Class in com.shaft.gui.element
-
SwipeDirection; swiping UP means the screen will move downwards
- TouchActions.SwipeMovement - Enum Class in com.shaft.gui.element
- TouchActions.ZoomDirection - Enum Class in com.shaft.gui.element
- transform(ITestAnnotation, Class, Constructor, Method) - Method in class com.shaft.listeners.TestNGListener
-
This method will be invoked by TestNG to give you a chance to modify a TestNG annotation read from your test classes.
- TRUE - Enum constant in enum class com.shaft.tools.io.PdfFileManager.DeleteFileAfterValidationStatus
- tunnel() - Method in interface com.shaft.properties.internal.LambdaTest
- tunnel(boolean) - Method in class com.shaft.properties.internal.LambdaTest.SetProperty
- tunnelName() - Method in interface com.shaft.properties.internal.LambdaTest
- tunnelName(String) - Method in class com.shaft.properties.internal.LambdaTest.SetProperty
- type(String, CharSequence...) - Method in class com.shaft.gui.element.internal.Actions
-
Types the given text into an input field resolved by its visible label or placeholder.
- type(String, String, String) - Method in class com.shaft.cucumber.ElementSteps
-
Checks if there is any text in an element, clears it, then types the required string into the target element.
- type(By, CharSequence...) - Method in class com.shaft.gui.element.internal.Actions
- type(By, CharSequence...) - Method in class com.shaft.gui.element.ElementActions
-
Types the provided text into the target element, replacing any existing value.
- type(By, String) - Method in class com.shaft.gui.element.AsyncElementActions
-
Asynchronously types the given text into the element identified by
elementLocator. - typeAppend(String, String, String) - Method in class com.shaft.cucumber.ElementSteps
-
Appends the required string into the target element, regardless of the current text value.
- typeAppend(By, CharSequence...) - Method in class com.shaft.gui.element.internal.Actions
- typeAppend(By, CharSequence...) - Method in class com.shaft.gui.element.ElementActions
-
Appends the required string into the target element, regardless of the current text value.
- typeAppend(By, String) - Method in class com.shaft.gui.element.AsyncElementActions
-
Asynchronously appends the given text to the current value of the element identified by
elementLocatorwithout clearing its existing content first. - typeFileLocationForUpload(String, String, String) - Method in class com.shaft.cucumber.ElementSteps
-
ValidationEnums the required file path into an input[type='file'] button, to successfully upload the target file.
- typeFileLocationForUpload(By, String) - Method in class com.shaft.gui.element.AsyncElementActions
-
Asynchronously types the absolute path of a local file into the file-upload input element identified by
elementLocator, triggering the browser's file selection mechanism. - typeFileLocationForUpload(By, String) - Method in class com.shaft.gui.element.ElementActions
-
ValidationEnums the required file path into an input[type='file'] button, to successfully upload the target file.
- typeIntoPromptAlert(String) - Method in class com.shaft.gui.element.AlertActions
-
Types the specified text into a JavaScript prompt dialog's input field.
- typeSecure(String, String, String) - Method in class com.shaft.cucumber.ElementSteps
-
Checks if there is any text in an element, clears it, then types the required string into the target element.
- typeSecure(By, CharSequence...) - Method in class com.shaft.gui.element.internal.Actions
- typeSecure(By, CharSequence...) - Method in class com.shaft.gui.element.ElementActions
-
Checks if there is any text in an element, clears it, then types the required string into the target element.
- typeSecure(By, String) - Method in class com.shaft.gui.element.AsyncElementActions
-
Asynchronously types the given text into the element identified by
elementLocatorin a secure manner, masking the typed characters in logs and reports to protect sensitive data such as passwords.
U
- udid() - Method in interface com.shaft.properties.internal.Mobile
- udid(String) - Method in class com.shaft.properties.internal.Mobile.SetProperty
- UNDEFINED - Enum constant in enum class com.shaft.gui.element.internal.ElementActionsHelper.TextDetectionStrategy
- unpackArchive(URL, String) - Method in class com.shaft.cli.FileActions
- UNSELECT_ALL - Enum constant in enum class com.shaft.enums.internal.ClipboardAction
-
Clears any active selection in the target element or context.
- UNSPECIFIED - Enum constant in enum class com.shaft.gui.element.TouchActions.KeyboardKeys
- UP - Enum constant in enum class com.shaft.gui.element.TouchActions.SwipeDirection
- UpdateChecker - Class in com.shaft.listeners.internal
- UpdateChecker() - Constructor for class com.shaft.listeners.internal.UpdateChecker
- updateConfigurationMethods(ITestResult) - Static method in class com.shaft.listeners.internal.TestNGListenerHelper
- updateIssuesLog(ITestResult) - Static method in class com.shaft.tools.io.internal.IssueReporter
- updateTestMethods(ITestResult) - Static method in class com.shaft.listeners.internal.TestNGListenerHelper
- updateTestStatusInCaseOfVerificationFailure(ITestResult) - Static method in class com.shaft.tools.io.internal.IssueReporter
- url() - Method in interface com.shaft.properties.internal.Jira
- url() - Method in class com.shaft.validation.internal.WebDriverBrowserValidationsBuilder
-
Use this to check against the current page URL
- useRelaxedHTTPSValidation() - Method in class com.shaft.api.RequestBuilder
-
set useRelaxedHTTPSValidation configuration to trust all hosts regardless if the SSL certificate is invalid in the request builder 'SSL' is the protocol name by default
- useRelaxedHTTPSValidation(String) - Method in class com.shaft.api.RequestBuilder
-
set useRelaxedHTTPSValidation configuration to trust all hosts regardless if the SSL certificate is invalid in the request builder *
- username() - Method in interface com.shaft.properties.internal.LambdaTest
- username(String) - Method in class com.shaft.properties.internal.LambdaTest.SetProperty
- userName() - Method in interface com.shaft.properties.internal.BrowserStack
-
BrowserStack account username used for authentication.
- userName(String) - Method in class com.shaft.properties.internal.BrowserStack.SetProperty
-
Overrides the
browserStack.userNameproperty at runtime.
V
- validateSwipeToElement() - Method in interface com.shaft.properties.internal.Flags
- validateSwipeToElement(boolean) - Method in class com.shaft.properties.internal.Flags.SetProperty
- ValidationEnums - Class in com.shaft.validation
- ValidationEnums() - Constructor for class com.shaft.validation.ValidationEnums
- ValidationEnums.NumbersComparativeRelation - Enum Class in com.shaft.validation
- ValidationEnums.ValidationCategory - Enum Class in com.shaft.validation
- ValidationEnums.ValidationComparisonType - Enum Class in com.shaft.validation
- ValidationEnums.ValidationState - Enum Class in com.shaft.validation
- ValidationEnums.ValidationType - Enum Class in com.shaft.validation
- ValidationEnums.VisualValidationEngine - Enum Class in com.shaft.validation
- Validations - Class in com.shaft.validation
- ValidationsBuilder - Class in com.shaft.validation.internal
- ValidationsBuilder(ValidationEnums.ValidationCategory) - Constructor for class com.shaft.validation.internal.ValidationsBuilder
- ValidationsExecutor - Class in com.shaft.validation.internal
- ValidationsExecutor(FileValidationsBuilder) - Constructor for class com.shaft.validation.internal.ValidationsExecutor
- ValidationsExecutor(NativeValidationsBuilder) - Constructor for class com.shaft.validation.internal.ValidationsExecutor
- ValidationsExecutor(NumberValidationsBuilder) - Constructor for class com.shaft.validation.internal.ValidationsExecutor
- ValidationsExecutor(RestValidationsBuilder) - Constructor for class com.shaft.validation.internal.ValidationsExecutor
- ValidationsExecutor(ValidationsBuilder) - Constructor for class com.shaft.validation.internal.ValidationsExecutor
- ValidationsExecutor(WebDriverElementValidationsBuilder) - Constructor for class com.shaft.validation.internal.ValidationsExecutor
- ValidationsHelper - Class in com.shaft.validation.internal
- ValidationsHelper2 - Class in com.shaft.validation.internal
- validationsIncrement(CheckpointStatus) - Static method in class com.shaft.tools.io.internal.ExecutionSummaryReport
- VALUE - Enum constant in enum class com.shaft.gui.element.internal.ElementActionsHelper.TextDetectionStrategy
- valueOf(String) - Static method in enum class com.shaft.api.RequestBuilder.AuthenticationType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.shaft.api.RestActions.ComparisonType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.shaft.api.RestActions.ParametersType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.shaft.api.RestActions.RequestType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.shaft.db.DatabaseActions.DatabaseType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.shaft.driver.DriverFactory.DriverType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.shaft.enums.internal.ClipboardAction
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.shaft.enums.internal.NavigationAction
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.shaft.enums.internal.Screenshots
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.shaft.gui.element.internal.ElementActionsHelper.TextDetectionStrategy
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.shaft.gui.element.TouchActions.KeyboardKeys
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.shaft.gui.element.TouchActions.SwipeDirection
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.shaft.gui.element.TouchActions.SwipeMovement
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.shaft.gui.element.TouchActions.ZoomDirection
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.shaft.gui.internal.image.ImageProcessingActions.VisualValidationEngine
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.shaft.gui.internal.locator.Locators
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.shaft.gui.internal.locator.Role
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.shaft.tools.internal.support.HTMLHelper
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.shaft.tools.internal.support.JavaScriptHelper
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.shaft.tools.io.internal.CheckpointStatus
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.shaft.tools.io.internal.CheckpointType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.shaft.tools.io.internal.ExecutionSummaryReport.Status
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.shaft.tools.io.internal.ExecutionSummaryReport.StatusIcon
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.shaft.tools.io.internal.ProjectStructureManager.RunType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.shaft.tools.io.JSONFileManager.DataType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.shaft.tools.io.PdfFileManager.DeleteFileAfterValidationStatus
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.shaft.validation.ValidationEnums.NumbersComparativeRelation
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.shaft.validation.ValidationEnums.ValidationCategory
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.shaft.validation.ValidationEnums.ValidationComparisonType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.shaft.validation.ValidationEnums.ValidationState
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.shaft.validation.ValidationEnums.ValidationType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.shaft.validation.ValidationEnums.VisualValidationEngine
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class com.shaft.api.RequestBuilder.AuthenticationType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.shaft.api.RestActions.ComparisonType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.shaft.api.RestActions.ParametersType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.shaft.api.RestActions.RequestType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.shaft.db.DatabaseActions.DatabaseType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.shaft.driver.DriverFactory.DriverType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.shaft.enums.internal.ClipboardAction
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.shaft.enums.internal.NavigationAction
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.shaft.enums.internal.Screenshots
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.shaft.gui.element.internal.ElementActionsHelper.TextDetectionStrategy
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.shaft.gui.element.TouchActions.KeyboardKeys
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.shaft.gui.element.TouchActions.SwipeDirection
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.shaft.gui.element.TouchActions.SwipeMovement
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.shaft.gui.element.TouchActions.ZoomDirection
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.shaft.gui.internal.image.ImageProcessingActions.VisualValidationEngine
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.shaft.gui.internal.locator.Locators
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.shaft.gui.internal.locator.Role
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.shaft.tools.internal.support.HTMLHelper
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.shaft.tools.internal.support.JavaScriptHelper
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.shaft.tools.io.internal.CheckpointStatus
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.shaft.tools.io.internal.CheckpointType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.shaft.tools.io.internal.ExecutionSummaryReport.Status
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.shaft.tools.io.internal.ExecutionSummaryReport.StatusIcon
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.shaft.tools.io.internal.ProjectStructureManager.RunType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.shaft.tools.io.JSONFileManager.DataType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.shaft.tools.io.PdfFileManager.DeleteFileAfterValidationStatus
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.shaft.validation.ValidationEnums.NumbersComparativeRelation
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.shaft.validation.ValidationEnums.ValidationCategory
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.shaft.validation.ValidationEnums.ValidationComparisonType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.shaft.validation.ValidationEnums.ValidationState
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.shaft.validation.ValidationEnums.ValidationType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.shaft.validation.ValidationEnums.VisualValidationEngine
-
Returns an array containing the constants of this enum class, in the order they are declared.
- verbose() - Method in interface com.shaft.properties.internal.TestNG
- VERIFICATION - Enum constant in enum class com.shaft.tools.io.internal.CheckpointType
-
A soft verification that accumulates failures until the end of the test.
- verifyIsAccessible() - Method in class com.shaft.validation.accessibility.AccessibilityActions
-
Verifies (soft assertion) that the current page is fully accessible according to
AccessibilityHelper.isAccessible(WebDriver)'s default criteria (zero violations). - verifyNoCriticalViolations(String) - Method in class com.shaft.validation.accessibility.AccessibilityActions
-
Verifies (soft assertion) that the current page has no accessibility violations with an impact level of
"critical". - verifyThat() - Method in class com.shaft.driver.SHAFT.GUI.WebDriver
- verifyThat() - Static method in class com.shaft.driver.SHAFT.Validations
- verifyThat() - Method in class com.shaft.gui.browser.BrowserActions
-
Opens a soft-assertion (verification) builder scoped to the current browser state.
- verifyThat() - Static method in class com.shaft.validation.Validations
-
Start building your verification (Note: if a verification fails the test method execution will continue normally and all failures will be reported at the end)
- verifyThat(By) - Method in class com.shaft.gui.element.ElementActions
- verifyThat(By) - Method in class com.shaft.gui.element.TouchActions
- verifyThatResponse() - Method in class com.shaft.driver.SHAFT.API
- VERTICAL - Enum constant in enum class com.shaft.gui.element.TouchActions.SwipeMovement
- video() - Method in interface com.shaft.properties.internal.LambdaTest
- video() - Method in interface com.shaft.properties.internal.Paths
- video(boolean) - Method in class com.shaft.properties.internal.LambdaTest.SetProperty
- video(String) - Method in class com.shaft.properties.internal.Paths.SetProperty
- videoParamsRecordVideo() - Method in interface com.shaft.properties.internal.Visuals
- videoParamsRecordVideo(boolean) - Method in class com.shaft.properties.internal.Visuals.SetProperty
- videoParamsScope() - Method in interface com.shaft.properties.internal.Visuals
- videoParamsScope(String) - Method in class com.shaft.properties.internal.Visuals.SetProperty
- VIEWPORT - Enum constant in enum class com.shaft.enums.internal.Screenshots
- visual() - Method in interface com.shaft.properties.internal.LambdaTest
- visual(boolean) - Method in class com.shaft.properties.internal.LambdaTest.SetProperty
- visualMatchingThreshold() - Method in interface com.shaft.properties.internal.Visuals
- visualMatchingThreshold(double) - Method in class com.shaft.properties.internal.Visuals.SetProperty
- visuals - Static variable in class com.shaft.properties.internal.Properties
- Visuals - Interface in com.shaft.properties.internal
- Visuals.SetProperty - Class in com.shaft.properties.internal
W
- w3c() - Method in interface com.shaft.properties.internal.LambdaTest
- w3c(boolean) - Method in class com.shaft.properties.internal.LambdaTest.SetProperty
- waitForElementPresence(WebDriver, String) - Method in class com.shaft.gui.element.internal.ElementActionsHelper
- waitForElementPresence(WebDriver, By, boolean) - Method in class com.shaft.gui.element.internal.ElementActionsHelper
- waitForElementTextToBeNot(WebDriver, By, String) - Method in class com.shaft.gui.element.internal.ElementActionsHelper
- waitForElementToBeClickable(WebDriver, By, String) - Method in class com.shaft.gui.element.internal.ElementActionsHelper
- waitForLazyLoading() - Method in class com.shaft.gui.browser.BrowserActions
-
Waits for the page to finish lazy-loading by polling JavaScript readiness conditions.
- waitForLazyLoading() - Method in interface com.shaft.properties.internal.Timeouts
- waitForLazyLoading(boolean) - Method in class com.shaft.properties.internal.Timeouts.SetProperty
- waitForLazyLoading(WebDriver) - Static method in class com.shaft.gui.browser.internal.JavaScriptWaitManager
-
Waits for jQuery, Angular, and/or Javascript if present on the current page.
- waitForRemoteServerToBeUp() - Method in interface com.shaft.properties.internal.Timeouts
- waitForRemoteServerToBeUp(boolean) - Method in class com.shaft.properties.internal.Timeouts.SetProperty
- waitUntil(Function) - Method in class com.shaft.gui.element.internal.Actions
-
Waits until the given condition returns
true, using the framework's default element-identification timeout multiplied by ten seconds. - waitUntil(Function, Duration) - Method in class com.shaft.gui.element.internal.Actions
-
Waits until the given condition returns
truewithin the specified timeout. - waitUntilAttributeContains(By, String, String) - Method in class com.shaft.gui.element.ElementActions
-
Deprecated, for removal: This API element is subject to removal in a future version.
- waitUntilElementIsVisible(String) - Method in class com.shaft.gui.element.TouchActions
-
Waits until a specific element is now visible on the current screen
- waitUntilElementTextToBe(By, String) - Method in class com.shaft.gui.element.ElementActions
-
Deprecated, for removal: This API element is subject to removal in a future version.
- waitUntilElementToBeSelected(By) - Method in class com.shaft.gui.element.ElementActions
-
Deprecated, for removal: This API element is subject to removal in a future version.
- waitUntilNumberOfElementsToBe(By, int) - Method in class com.shaft.gui.element.ElementActions
-
Deprecated, for removal: This API element is subject to removal in a future version.
- waitUntilNumberOfElementsToBeLessThan(By, int) - Method in class com.shaft.gui.element.ElementActions
-
Deprecated, for removal: This API element is subject to removal in a future version.
- waitUntilNumberOfElementsToBeMoreThan(By, int) - Method in class com.shaft.gui.element.ElementActions
-
Deprecated, for removal: This API element is subject to removal in a future version.
- waitUntilNumberOfWindowsToBe(int) - Method in class com.shaft.gui.browser.BrowserActions
-
Deprecated, for removal: This API element is subject to removal in a future version.
- waitUntilPresenceOfAllElementsLocatedBy(By) - Method in class com.shaft.gui.element.ElementActions
-
Deprecated, for removal: This API element is subject to removal in a future version.
- waitUntilTimeout() - Method in interface com.shaft.properties.internal.Timeouts
- waitUntilTimeout(int) - Method in class com.shaft.properties.internal.Timeouts.SetProperty
- waitUntilTitleContains(String) - Method in class com.shaft.gui.browser.BrowserActions
-
Deprecated, for removal: This API element is subject to removal in a future version.
- waitUntilTitleIs(String) - Method in class com.shaft.gui.browser.BrowserActions
-
Deprecated, for removal: This API element is subject to removal in a future version.
- waitUntilTitleNotContains(String) - Method in class com.shaft.gui.browser.BrowserActions
-
Deprecated, for removal: This API element is subject to removal in a future version.
- waitUntilUrlContains(String) - Method in class com.shaft.gui.browser.BrowserActions
-
Deprecated, for removal: This API element is subject to removal in a future version.
- waitUntilUrlIsNot(WebDriver, String) - Method in class com.shaft.gui.browser.internal.BrowserActionsHelper
-
Waits until the browser URL is no longer equal to the given initial URL.
- waitUntilUrlMatches(String) - Method in class com.shaft.gui.browser.BrowserActions
-
Deprecated, for removal: This API element is subject to removal in a future version.
- waitUntilUrlNotContains(String) - Method in class com.shaft.gui.browser.BrowserActions
-
Deprecated, for removal: This API element is subject to removal in a future version.
- waitUntilUrlNotToBe(String) - Method in class com.shaft.gui.browser.BrowserActions
-
Deprecated, for removal: This API element is subject to removal in a future version.
- waitUntilUrlToBe(String) - Method in class com.shaft.gui.browser.BrowserActions
-
Deprecated, for removal: This API element is subject to removal in a future version.
- watermarkImagePath() - Method in interface com.shaft.properties.internal.Internal
- web - Static variable in class com.shaft.properties.internal.Properties
- Web - Interface in com.shaft.properties.internal
- Web.SetProperty - Class in com.shaft.properties.internal
- WebDriver() - Constructor for class com.shaft.driver.SHAFT.GUI.WebDriver
- WebDriver(DriverFactory.DriverType) - Constructor for class com.shaft.driver.SHAFT.GUI.WebDriver
- WebDriver(DriverFactory.DriverType, MutableCapabilities) - Constructor for class com.shaft.driver.SHAFT.GUI.WebDriver
- WebDriver(WebDriver) - Constructor for class com.shaft.driver.SHAFT.GUI.WebDriver
- WebDriverAssertions(DriverFactoryHelper) - Constructor for class com.shaft.driver.internal.WizardHelpers.WebDriverAssertions
- WebDriverBrowserValidationsBuilder - Class in com.shaft.validation.internal
- WebDriverBrowserValidationsBuilder(ValidationEnums.ValidationCategory, WebDriver, StringBuilder) - Constructor for class com.shaft.validation.internal.WebDriverBrowserValidationsBuilder
- WebDriverElementValidationsBuilder - Class in com.shaft.validation.internal
- WebDriverElementValidationsBuilder(ValidationEnums.ValidationCategory, WebDriver, By, StringBuilder) - Constructor for class com.shaft.validation.internal.WebDriverElementValidationsBuilder
- WebDriverListener - Class in com.shaft.listeners.internal
- WebDriverListener() - Constructor for class com.shaft.listeners.internal.WebDriverListener
- WebDriverVerifications(DriverFactoryHelper) - Constructor for class com.shaft.driver.internal.WizardHelpers.WebDriverVerifications
- WEBKIT - Enum constant in enum class com.shaft.driver.DriverFactory.DriverType
- whenToTakePageSourceSnapshot() - Method in interface com.shaft.properties.internal.Visuals
- whenToTakePageSourceSnapshot(String) - Method in class com.shaft.properties.internal.Visuals.SetProperty
- WINDOW_FOCUS - Enum constant in enum class com.shaft.tools.internal.support.JavaScriptHelper
- WINDOW_RESET_LOCATION - Enum constant in enum class com.shaft.tools.internal.support.JavaScriptHelper
- WINDOW_RESIZE - Enum constant in enum class com.shaft.tools.internal.support.JavaScriptHelper
- withCustomReportMessage(String) - Method in class com.shaft.validation.internal.ValidationsExecutor
-
Set a customized business-readable message that will appear in the execution report instead of the technical log message which will be nested under it
- WizardHelpers - Class in com.shaft.driver.internal
- WizardHelpers() - Constructor for class com.shaft.driver.internal.WizardHelpers
- WizardHelpers.StandaloneAssertions - Class in com.shaft.driver.internal
- WizardHelpers.StandaloneVerifications - Class in com.shaft.driver.internal
- WizardHelpers.WebDriverAssertions - Class in com.shaft.driver.internal
- WizardHelpers.WebDriverVerifications - Class in com.shaft.driver.internal
- write(byte[]) - Method in class com.shaft.tools.io.internal.LogRedirector
- write(byte[], int, int) - Method in class com.shaft.tools.io.internal.LogRedirector
- write(int) - Method in class com.shaft.tools.io.internal.LogRedirector
- writeNodeScriptFileInProjectDirectory() - Method in class com.shaft.performance.internal.LightHouseGenerateReport
- writeReportPathToFilesInProjectDirectory(String) - Method in class com.shaft.performance.internal.LightHouseGenerateReport
- writeStepToReport(String) - Static method in class com.shaft.tools.io.internal.ReportManagerHelper
-
Formats logText and adds timestamp, then logs it as a step in the execution report.
- writeStepToReport(String, Level) - Static method in class com.shaft.tools.io.internal.ReportManagerHelper
-
Formats logText and adds timestamp at the specified log level, then logs it as a step in the execution report.
- writeToFile(String, byte[]) - Method in class com.shaft.cli.FileActions
- writeToFile(String, String) - Method in class com.shaft.cli.FileActions
- writeToFile(String, String, byte[]) - Method in class com.shaft.cli.FileActions
- writeToFile(String, String, String) - Method in class com.shaft.cli.FileActions
- writeToFile(String, String, List) - Method in class com.shaft.cli.FileActions
X
- XPATH - Enum constant in enum class com.shaft.gui.internal.locator.Locators
- XpathAxis - Class in com.shaft.gui.internal.locator
- XrayIntegrationHelper - Class in com.shaft.tools.internal.tms
- XrayIntegrationHelper() - Constructor for class com.shaft.tools.internal.tms.XrayIntegrationHelper
Y
- YAML(String) - Constructor for class com.shaft.driver.SHAFT.TestData.YAML
-
Creates a new instance of the test data Excel reader using the target Excel file path
- YAMLFileManager - Class in com.shaft.tools.io
- YAMLFileManager(String) - Constructor for class com.shaft.tools.io.YAMLFileManager
-
Creating an instance of
YAMLFileManager
Z
- zipFiles(String, String) - Method in class com.shaft.cli.FileActions
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form