Package io.appium.java_client.remote.options

Class BaseOptions<T extends BaseOptions<T>>

java.lang.Object
org.openqa.selenium.MutableCapabilities
io.appium.java_client.remote.options.BaseOptions<T>
Type Parameters:
T - The child class for a proper chaining.
All Implemented Interfaces:
CanSetCapability<T>, SupportsAutomationNameOption<T>, SupportsBrowserNameOption<T>, SupportsEventTimingsOption<T>, SupportsFullResetOption<T>, SupportsNewCommandTimeoutOption<T>, SupportsNoResetOption<T>, SupportsPlatformVersionOption<T>, SupportsPrintPageSourceOnFindFailureOption<T>, SupportsWebSocketUrlOption<T>, Serializable, org.openqa.selenium.Capabilities
Direct Known Subclasses:
ChromiumOptions, EspressoOptions, FlutterDriverOptions, GeckoOptions, Mac2Options, SafariOptions, UiAutomator2Options, WindowsOptions, XCUITestOptions
public class BaseOptions<T extends BaseOptions<T>> extends org.openqa.selenium.MutableCapabilities implements CanSetCapability<T>, SupportsAutomationNameOption<T>, SupportsEventTimingsOption<T>, SupportsPrintPageSourceOnFindFailureOption<T>, SupportsNoResetOption<T>, SupportsFullResetOption<T>, SupportsNewCommandTimeoutOption<T>, SupportsBrowserNameOption<T>, SupportsPlatformVersionOption<T>, SupportsWebSocketUrlOption<T>
This class represents capabilities that are available in the base driver, e.g. are acceptable by any Appium driver
See Also:

  • Constructor Details

    • BaseOptions

      public BaseOptions()
      Creates new instance with no preset capabilities.

    • BaseOptions

      public BaseOptions(Map<String,?> source)
      Creates new instance with provided capabilities.
      Parameters:
      source - Capabilities map to merge into new instance

    • BaseOptions

      public BaseOptions(org.openqa.selenium.Capabilities source)
      Creates new instance with provided capabilities.
      Parameters:
      source - is Capabilities instance to merge into new instance

  • Method Details

    • setPlatformName

      public T setPlatformName(String platform)
      Set the kind of mobile device or emulator to use.
      Parameters:
      platform - the kind of mobile device or emulator to use.
      Returns:
      self instance for chaining.
      See Also:
      • CapabilityType.PLATFORM_NAME

    • getPlatformName

      public @Nullable org.openqa.selenium.Platform getPlatformName()
      Specified by:
      getPlatformName in interface org.openqa.selenium.Capabilities

    • asMap

      public Map<String,Object> asMap()
      Specified by:
      asMap in interface org.openqa.selenium.Capabilities
      Overrides:
      asMap in class org.openqa.selenium.MutableCapabilities

    • merge

      public T merge(org.openqa.selenium.Capabilities extraCapabilities)
      Specified by:
      merge in interface org.openqa.selenium.Capabilities
      Overrides:
      merge in class org.openqa.selenium.MutableCapabilities

    • clone

      public T clone()
      Makes a deep clone of the current Options instance.
      Overrides:
      clone in class Object
      Returns:
      A deep instance clone.

    • setCapability

      public void setCapability(String key, @Nullable Object value)
      Specified by:
      setCapability in interface CanSetCapability<T extends BaseOptions<T>>
      Overrides:
      setCapability in class org.openqa.selenium.MutableCapabilities

    • getCapability

      public @Nullable Object getCapability(String capabilityName)
      Specified by:
      getCapability in interface org.openqa.selenium.Capabilities
      Overrides:
      getCapability in class org.openqa.selenium.MutableCapabilities

    • toW3cName

      public static String toW3cName(String capName)
      Adds the 'appium:' prefix to the given capability name if necessary.
      Parameters:
      capName - the original capability name.
      Returns:
      The preformatted W3C-compatible capability name.