com.android.builder.testing.api

Class DeviceProvider

java.lang.Object

com.android.builder.testing.api.DeviceProvider

@Beta
public abstract class DeviceProvider
extends java.lang.Object

Provides a list of remote or local devices.

Constructor Summary

Constructors

Constructor and Description
DeviceProvider()

Method Summary

Modifier and Type	Method and Description
abstract java.util.List<? extends DeviceConnector>	getDevices() Returns a list of DeviceConnector.
abstract java.lang.String	getName() Returns the name of the provider.
abstract int	getTimeoutInMs() Returns the timeout to use.
abstract void	init() Initializes the provider.
abstract boolean	isConfigured() Returns true if the provider is configured and able to run.
abstract void	terminate() Terminates the provider and cleans up resources.

Methods inherited from class java.lang.Object

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

Constructor Detail

DeviceProvider

public DeviceProvider()

Method Detail

getName

@NonNull
public abstract java.lang.String getName()

Returns the name of the provider. Must be unique, not contain spaces, and start with a lower case.

Returns:

the name of the provider.

init

public abstract void init()
                   throws DeviceException

Initializes the provider. This must be called before any other method (except getName()). Each successful call to init() MUST be followed by a call to terminate().

Throws:

DeviceException - if initialization fails.

terminate

public abstract void terminate()
                        throws DeviceException

Terminates the provider and cleans up resources. Each successful call to init() MUST be followed by a call to terminate().

Throws:

DeviceException - if termination fails. Resources will still be cleaned up.

getDevices

@NonNull
public abstract java.util.List<? extends DeviceConnector> getDevices()

Returns a list of DeviceConnector.

Returns:

a non-null list (but could be empty.)

getTimeoutInMs

public abstract int getTimeoutInMs()

Returns the timeout to use.

Returns:

the time out in milliseconds.

isConfigured

public abstract boolean isConfigured()

Returns true if the provider is configured and able to run.

Returns:

if the provider is configured.