INativeDevice

public interface INativeDevice

com.android.tradefed.device.INativeDevice


ddmlib IDevice に信頼性の高い、やや高レベルの API を提供します。

デバイス コマンドを構成可能な回数再試行し、応答しないデバイスに対してデバイス復元インターフェースを提供します。

概要

定数

int UNKNOWN_API_LEVEL

API レベルを検出できない場合のデフォルト値

パブリック メソッド

abstract boolean checkApiLevelAgainstNextRelease(int strictMinLevel)

最小限サポートされているレベルで、機能が現在サポートされているかどうかを確認します。

abstract void clearLogcat()

蓄積された logcat データを削除します。

abstract void deleteFile(String deviceFilePath)

デバイス上のファイルまたはディレクトリを削除するヘルパー メソッド。

abstract void deleteFile(String deviceFilePath, int userId)

デバイス上のファイルまたはディレクトリを削除するヘルパー メソッド。

abstract boolean deviceSoftRestarted(ProcessInfo prevSystemServerProcess)

現在の system_server と以前の system_server ProcessInfo を比較して、デバイスがソフトリブートされたかどうかを確認するヘルパー メソッド。

abstract boolean deviceSoftRestartedSince(long utcEpochTime, TimeUnit timeUnit)

デバイスの UTC エポックからの時刻とその TimeUnit から、デバイスがソフト再起動されたかどうかを確認するヘルパー メソッド。

abstract boolean disableAdbRoot()

adb root をオフにします。

abstract boolean doesFileExist(String deviceFilePath)

デバイス上のファイルが存在するかどうかを判断するヘルパー メソッド。

abstract boolean enableAdbRoot()

adb root をオンにします。

abstract String executeAdbCommand(long timeout, String... commandArgs)

指定されたタイムアウトで adb コマンドをシステム コマンドとして実行するヘルパー メソッド。

abstract String executeAdbCommand(String... commandArgs)

adb コマンドをシステム コマンドとして実行するヘルパー メソッド。

abstract String executeAdbCommand(long timeout, Map<String, String> envMap, String... commandArgs)

指定されたタイムアウトで adb コマンドをシステム コマンドとして実行するヘルパー メソッド。

abstract CommandResult executeAdbV2Command(String... commandArgs)

adb コマンドをシステム コマンドとして実行するヘルパー メソッド。

abstract CommandResult executeAdbV2Command(long timeout, String... commandArgs)

指定されたタイムアウトで adb コマンドをシステム コマンドとして実行するヘルパー メソッド。

abstract CommandResult executeAdbV2Command(long timeout, Map<String, String> envMap, int retryAttempts, String... commandArgs)

指定されたタイムアウトで adb コマンドをシステム コマンドとして実行するヘルパー メソッド。

abstract CommandResult executeAdbV2Command(long timeout, Map<String, String> envMap, String... commandArgs)

指定されたタイムアウトで adb コマンドをシステム コマンドとして実行するヘルパー メソッド。

abstract CommandResult executeFastbootCommand(long timeout, String... commandArgs)

システム コマンドとして fastboot コマンドを実行するヘルパー メソッド。

abstract CommandResult executeFastbootCommand(String... commandArgs)

デフォルトのタイムアウトが 2 分のシステム コマンドとして fastboot コマンドを実行するヘルパー メソッド。

abstract CommandResult executeLongFastbootCommand(String... commandArgs)

システム コマンドとして実行時間の長い fastboot コマンドを実行するヘルパー メソッド。

abstract CommandResult executeLongFastbootCommand(Map<String, String> envVarMap, String... commandArgs)

システム環境変数を使用して、長時間実行される fastboot コマンドをシステム コマンドとして実行するヘルパー メソッド。

abstract String executeShellCommand(String command)

adb shell コマンドを実行し、出力を String として返すヘルパー メソッド。

abstract void executeShellCommand(String command, IShellOutputReceiver receiver, long maxTimeToOutputShellResponse, TimeUnit timeUnit, int retryAttempts)

コマンドの動作を制御する追加のパラメータを指定して、adb シェルコマンドを実行します。

abstract void executeShellCommand(String command, IShellOutputReceiver receiver)

指定された adb シェルコマンドを実行します。コマンドが失敗した場合は、複数回再試行します。

abstract void executeShellCommand(String command, IShellOutputReceiver receiver, long maxTimeoutForCommand, long maxTimeToOutputShellResponse, TimeUnit timeUnit, int retryAttempts)

コマンドの動作を制御する追加のパラメータを指定して、adb シェルコマンドを実行します。

abstract CommandResult executeShellV2Command(String command)

adb シェルコマンドを実行し、コマンド ステータス出力、stdout、stderr が適切に設定された CommandResult として結果を返すヘルパー メソッド。

abstract CommandResult executeShellV2Command(String command, File pipeAsInput, OutputStream pipeToOutput, long maxTimeoutForCommand, TimeUnit timeUnit, int retryAttempts)

コマンドの動作を制御する追加のパラメータを指定して、adb シェルコマンドを実行します。

abstract CommandResult executeShellV2Command(String command, long maxTimeoutForCommand, TimeUnit timeUnit)

コマンドの動作を制御する追加のパラメータを指定して、adb シェルコマンドを実行します。

abstract CommandResult executeShellV2Command(String command, File pipeAsInput)

adb シェルコマンドを実行し、コマンド ステータス出力、stdout、stderr が適切に設定された CommandResult として結果を返すヘルパー メソッド。

abstract CommandResult executeShellV2Command(String command, OutputStream pipeToOutput)

adb シェルコマンドを実行し、コマンド ステータス出力と stderr が適切に設定された CommandResult として結果を返すヘルパー メソッド。

abstract CommandResult executeShellV2Command(String command, File pipeAsInput, OutputStream pipeToOutput, OutputStream pipeToError, long maxTimeoutForCommand, TimeUnit timeUnit, int retryAttempts)

コマンドの動作を制御する追加のパラメータを指定して、adb シェルコマンドを実行します。

abstract CommandResult executeShellV2Command(String command, File pipeAsInput, OutputStream pipeToOutput, OutputStream pipeToError, long maxTimeoutForCommand, long maxTimeToOutputShellResponse, TimeUnit timeUnit, int retryAttempts)

コマンドの動作を制御する追加のパラメータを指定して、adb シェルコマンドを実行します。

abstract CommandResult executeShellV2Command(String command, long maxTimeoutForCommand, TimeUnit timeUnit, int retryAttempts)

コマンドの動作を制御する追加のパラメータを指定して、adb シェルコマンドを実行します。

abstract CommandResult executeShellV2Command(String command, IShellOutputReceiver receiver)

adb シェルコマンドを実行し、コマンド ステータス出力、stdout、stderr が適切に設定された CommandResult として結果を返すヘルパー メソッド。

abstract CommandResult fastbootOemRamdumpNow()

fastboot モードから ramdump をトリガーするヘルパー メソッド。

abstract CommandResult fastbootWipePartition(String partition)

デバイスのパーティションをワイプするヘルパー メソッド。

abstract int getApiLevel()

デバイスの API レベルを取得します。

abstract int getApiLevelFull()

getApiLevel() と同様ですが、完全なバージョンを返します。

abstract String getBasebandVersion()

このデバイスのベースバンド(無線通信)バージョンを取得する便利なメソッド。

abstract Integer getBattery()

デバイスの現在のバッテリー残量を返します。バッテリー残量が利用できない場合は Null を返します。

abstract boolean getBooleanProperty(String name, boolean defaultValue)

指定されたプロパティのブール値を返します。

abstract Map<Long, String> getBootHistory()

ヘルパー メソッドは、起動時間と起動理由を含む起動履歴マップを収集します。

abstract Map<Long, String> getBootHistorySince(long utcEpochTime, TimeUnit timeUnit)

ヘルパー メソッドは、デバイスから指定されたエポック以降の時間と指定された時間単位で、起動時間と起動理由を含む起動履歴マップを収集します。

abstract String getBootloaderVersion()

このデバイスのブートローダー バージョンを取得する便利なメソッド。

abstract String getBuildAlias()

デバイスで現在実行中のビルドのエイリアスを取得します。

abstract String getBuildFlavor()

デバイスのビルド フレーバーを取得します。

abstract String getBuildId()

デバイスで現在実行中のビルドを取得します。

abstract String getBuildSigningKeys()

デバイス イメージの署名に使用された鍵の種類を返します

通常、Android デバイスはテストキー(AOSP の場合など)またはリリースキー(個々のデバイス メーカーが管理)で署名されます。

abstract DeviceDescriptor getCachedDeviceDescriptor()

デバイスが割り当てられている場合はキャッシュに保存された DeviceDescriptor を返し、割り当てられていない場合は現在の DeviceDescriptor を返します。

abstract DeviceDescriptor getCachedDeviceDescriptor(boolean shortDescriptor)

デバイスが割り当てられている場合はキャッシュに保存された DeviceDescriptor を返し、割り当てられていない場合は現在の DeviceDescriptor を返します。

abstract String[] getChildren(String deviceFilePath)

権限が原因で機能しないことがある IFileEntry を使用する代わりに、

abstract AbstractConnection getConnection()

デバイスに関連付けられている接続を返します。

abstract String getDeviceClass()

デバイスクラスを取得します。

abstract long getDeviceDate()

デバイスの日付をエポックからのミリ秒単位で返します。

abstract DeviceDescriptor getDeviceDescriptor()

デバイス情報から DeviceDescriptor を返して、実際のデバイス オブジェクトを渡さずにその情報を取得します。

abstract DeviceDescriptor getDeviceDescriptor(boolean shortDescriptor)

デバイス情報から DeviceDescriptor を返して、実際のデバイス オブジェクトを渡さずにその情報を取得します。

abstract TestDeviceState getDeviceState()

デバイスの状態を取得します。

abstract long getDeviceTimeOffset(Date date)

デバイスと指定された Date の間の時間差を取得するヘルパー。

abstract InputStreamSource getEmulatorOutput()

エミュレータの stdout と stderr のストリームを取得します。

abstract long getExternalStoreFreeSpace()

デバイスの外部ストレージの空き容量を判断するヘルパー メソッド。

abstract String getFastbootProductType()

デバイスが Fastboot モード(Fastboot mode)のときに、そのデバイスの商品タイプを取得する便利なメソッド。

abstract String getFastbootProductVariant()

デバイスが Fastboot モード(Fastboot mode)のときに、そのデバイスの商品タイプを取得する便利なメソッド。

abstract String getFastbootSerialNumber()

fastboot モードのシリアル番号を返します。

abstract String getFastbootVariable(String variableName)

指定された fastboot 変数の値をデバイスから取得します。

abstract IFileEntry getFileEntry(String path)

デバイス上のリモート ファイルへの参照を取得します。

abstract IDevice getIDevice()

関連付けられた ddmlib IDevice への参照を返します。

abstract long getIntProperty(String name, long defaultValue)

デバイスから指定されたプロパティの整数値を返します。

abstract long getLastExpectedRebootTimeMillis()

Tradefed API が最後に再起動をトリガーした時刻(エポックからのミリ秒単位)を System.currentTimeMillis() が返す値として返します。

abstract int getLaunchApiLevel()

デバイスの初回リリース時の API レベルを取得します。

abstract InputStreamSource getLogcat()

logcat データのスナップショット ストリームを取得します。

abstract InputStreamSource getLogcat(int maxBytes)

キャプチャされた logcat データの最後の maxBytes のスナップショット ストリームを取得します。

abstract InputStreamSource getLogcatDump()

デバイスの現在の logcat のダンプを取得します。

abstract InputStreamSource getLogcatSince(long date)

指定された日付からキャプチャされた logcat データのスナップショット ストリームを取得します。

abstract String getMountPoint(String mountName)

マウント ポイントを返します。

abstract ITestDevice.MountPointInfo getMountPointInfo(String mountpoint)

指定されたマウントポイント パスに対応する MountPointInfo を返します。そのパスに何もマウントされていない場合、または /proc/mounts にマウントポイントとして表示されない場合は、null を返します。

abstract List<ITestDevice.MountPointInfo> getMountPointInfo()

デバイスの /proc/mounts の情報を解析したバージョンを返します。

abstract long getPartitionFreeSpace(String partition)

デバイス パーティションの空き容量を判断するヘルパー メソッド。

abstract ProcessInfo getProcessByName(String processName)

ヘルパー メソッドは「pidof」コマンドと「stat」コマンドを実行し、指定されたプロセスの PID とプロセス開始時刻を含む ProcessInfo オブジェクトを返します。

abstract String getProcessPid(String process)

サービスの pid を返します。問題が発生した場合は null を返します。

abstract String getProductType()

このデバイスのプロダクト タイプを取得するコンビニエンス メソッド。

abstract String getProductVariant()

このデバイスのバリエーション商品を取得する便利なメソッド。

abstract String getProperty(String name)

デバイスから指定されたプロパティ値を取得します。

abstract ITestDevice.RecoveryMode getRecoveryMode()

デバイスで使用されている現在の復元モードを取得します。

abstract String getSerialNumber()

このデバイスのシリアル番号を取得する便利なメソッド。

abstract List<File> getTombstones()

デバイスから tombstone のリストを取得して返します。

abstract long getTotalMemory()

物理メモリの合計サイズをバイト単位で返します。内部エラーの場合は -1 を返します。

default String getTrackingSerial()

デバイス管理の目的で、デバイスの追跡に使用されるシリアルを取得します。

abstract boolean getUseFastbootErase()

fastboot erase または fastboot format を使用してデバイスのパーティションをワイプするかどうかを取得します。

abstract boolean isAdbRoot()
abstract boolean isAdbTcp()
abstract boolean isAppEnumerationSupported()

デバイスのプラットフォームがアプリの列挙をサポートしているかどうかを確認します。

abstract boolean isBypassLowTargetSdkBlockSupported()

デバイスのプラットフォームがアプリのインストール時の低いターゲット SDK ブロックのバイパスをサポートしているかどうかを確認します。

abstract boolean isDebugfsMounted()

debugfs がマウントされているかどうかを確認します。

abstract boolean isDeviceEncrypted()

デバイスが暗号化されているかどうかを返します。

abstract boolean isDirectory(String deviceFilePath)

デバイス上のパスがディレクトリの場合は True、それ以外の場合は False を返します。

abstract boolean isEncryptionSupported()

デバイスで暗号化がサポートされているかどうかを返します。

abstract boolean isExecutable(String fullPath)

デバイス上のファイルパスが実行可能ファイルの場合は True を返し、それ以外の場合は False を返します。

abstract boolean isHeadless()

デバイスがヘッドレス(画面がない)の場合は true、それ以外の場合は false を返します。

abstract boolean isRuntimePermissionSupported()

デバイスのプラットフォームが実行時の権限付与をサポートしているかどうかを確認する

abstract boolean isStateBootloaderOrFastbootd()

デバイスが TestDeviceState.FASTBOOT または TestDeviceState.FASTBOOTD の場合、true を返します。

abstract boolean logAnrs(ITestLogger logger)

デバイスから ANR を収集してログに記録します。

abstract void logOnDevice(String tag, Log.LogLevel level, String format, Object... args)

デバイスの logcat にメッセージを記録します。

abstract void mountDebugfs()

debugfs をマウントします。

abstract void nonBlockingReboot()

デバイスを再起動するコマンドを発行し、コマンドが完了したとき、およびデバイスが adb に表示されなくなったときに返します。

abstract void postBootSetup()

ブートごとにテスト用にデバイスを設定する手順を実行します。

default void postInvocationTearDown()

このメソッドは非推奨です。代わりに postInvocationTearDown(Throwable) を使用してください。

abstract void postInvocationTearDown(Throwable invocationException)

呼び出しの完了後に実行される、デバイス固有の必須クリーンアップの追加ステップ。

default void preInvocationSetup(IBuildInfo info, MultiMap<String, String> attributes)

呼び出しフローの前にデバイスで実行される、デバイス固有の必須設定の追加手順。

abstract boolean pullDir(String deviceFilePath, File localDir)

デバイスからディレクトリの内容を再帰的に取得します。

abstract boolean pullDir(String deviceFilePath, File localDir, int userId, long timeout)

デバイスからディレクトリの内容を再帰的に取得します。

abstract boolean pullDir(String deviceFilePath, File localDir, int userId)

デバイスからディレクトリの内容を再帰的に取得します。

abstract File pullFile(String remoteFilePath, int userId)

デバイスからファイルを取得し、ローカルの一時 File に保存して、その File を返します。

abstract boolean pullFile(String remoteFilePath, File localFile, int userId, long timeout)

デバイスからファイルを取得します。

abstract File pullFile(String remoteFilePath)

デバイスからファイルを取得し、ローカルの一時 File に保存して、その File を返します。

abstract boolean pullFile(String remoteFilePath, File localFile, int userId)

デバイスからファイルを取得します。

abstract boolean pullFile(String remoteFilePath, File localFile)

デバイスからファイルを取得します。

abstract String pullFileContents(String remoteFilePath)

デバイスからファイルを取得し、その内容を返します。

abstract File pullFileFromExternal(String remoteFilePath)

デバイスの外部ストレージからファイルを取得し、ローカルの一時的な File に保存して、その File への参照を返す便利なメソッド。

abstract boolean pushDir(File localDir, String deviceFilePath, int userId)

ディレクトリの内容をデバイスに再帰的に push します。

abstract boolean pushDir(File localDir, String deviceFilePath, Set<String> excludedDirectories)

フィルタリングされた一部のディレクトリを除外しながら、ディレクトリの内容をデバイスに再帰的にプッシュします。

abstract boolean pushDir(File localDir, String deviceFilePath)

ディレクトリの内容をデバイスに再帰的に push します。

abstract boolean pushFile(File localFile, String deviceFilePath, int userId)

ファイルをデバイスにプッシュします。

abstract boolean pushFile(File localFile, String deviceFilePath, boolean evaluateContentProviderNeeded)

コンテンツ プロバイダの必要性を評価するかどうかを任意で検討できる pushFile(File,String) のバリエーション。

abstract boolean pushFile(File localFile, String deviceFilePath)

ファイルをデバイスにプッシュします。

abstract boolean pushString(String contents, String deviceFilePath)

文字列から作成されたファイルをデバイスに push する

abstract void reboot()

デバイスを adb モードで再起動します。

abstract void reboot(String reason)

指定された reason を再起動後も保持したまま、デバイスを adb モードで再起動します。

default String reboot(String command, String reason)

指定された command を使用してデバイスを再起動します。

abstract void rebootIntoBootloader()

デバイスを再起動してブートローダー モードにします。

abstract void rebootIntoFastbootd()

デバイスを fastbootd モードで再起動します。

abstract void rebootIntoRecovery()

デバイスを adb リカバリモードで再起動します。

abstract void rebootIntoSideload(boolean autoReboot)

デバイスを adb サイドロード モードで再起動します(これはリカバリの特別なモードです)。

デバイスがサイドロード モードに入るまでブロックします。

abstract void rebootIntoSideload()

デバイスを adb サイドロード モードで再起動します(これはリカバリの特別なモードです)。

デバイスがサイドロード モードに入るまでブロックします。

abstract void rebootUntilOnline()

reboot() の代替。デバイスがオンラインになるまで(adb に表示されるまで)のみブロックします。

abstract void rebootUntilOnline(String reason)

reboot() の代替。デバイスがオンラインになるまで(adb に表示されるまで)のみブロックします。

abstract void rebootUserspace()

デバイスのユーザー空間部分のみを再起動します。

abstract void rebootUserspaceUntilOnline()

rebootUserspace() ()} の代替。デバイスがオンラインになるまで(adb に表示されるまで)のみブロックします。

abstract void remountSystemReadOnly()

デバイスのシステム パーティションを読み取り専用にします。

abstract void remountSystemWritable()

デバイスのシステム パーティションを書き込み可能にします。

abstract void remountVendorReadOnly()

デバイスのベンダー パーティションを読み取り専用にします。

abstract void remountVendorWritable()

デバイスのベンダー パーティションを書き込み可能にします。

abstract boolean runInstrumentationTests(IRemoteAndroidTestRunner runner, Collection<ITestLifeCycleReceiver> listeners)

インストルメンテーション テストを実行し、デバイスの復元を提供します。

abstract boolean runInstrumentationTests(IRemoteAndroidTestRunner runner, ITestLifeCycleReceiver... listeners)

1 つ以上のリスナーをパラメータとして渡して runInstrumentationTests(IRemoteAndroidTestRunner,Collection) を実行するための便利なメソッド。

abstract boolean runInstrumentationTestsAsUser(IRemoteAndroidTestRunner runner, int userId, Collection<ITestLifeCycleReceiver> listeners)

ITestDevice.runInstrumentationTests(IRemoteAndroidTestRunner,Collection) と同じですが、指定されたユーザーに対してテストを実行します。

abstract boolean runInstrumentationTestsAsUser(IRemoteAndroidTestRunner runner, int userId, ITestLifeCycleReceiver... listeners)

ITestDevice.runInstrumentationTests(IRemoteAndroidTestRunner,ITestLifeCycleReceiver...) と同じですが、指定されたユーザーに対してテストを実行します。

abstract void setDate(Date date)

デバイスの日付を設定します。

注: デバイスで日付を設定するには root が必要です。

abstract void setOptions(TestDeviceOptions options)

デバイスの TestDeviceOptions を設定します。

abstract boolean setProperty(String propKey, String propValue)

デバイスに指定されたプロパティ値を設定します。

abstract void setRecovery(IDeviceRecovery recovery)

このデバイスで使用する IDeviceRecovery を設定します。

abstract void setRecoveryMode(ITestDevice.RecoveryMode mode)

デバイスで使用する現在のリカバリモードを設定します。

abstract void setTrackingSerial(String trackingSerial)

デバイス管理の目的で、デバイスの参照に使用するシリアルを追跡します。

abstract void setUseFastbootErase(boolean useFastbootErase)

デバイスのパーティションを消去するために fastboot erase を使用するか、fastboot format を使用するかを設定します。

abstract void startLogcat()

バックグラウンドでデバイスから logcat 出力のキャプチャを開始します。

abstract boolean startTradeInModeTesting(int timeoutMs)

下取りモードのテストを有効にします。

abstract void stopEmulatorOutput()

エミュレータの出力を閉じて削除します。

abstract void stopLogcat()

デバイスからの logcat 出力のキャプチャを停止し、現在保存されている logcat データを破棄します。

abstract void stopTradeInModeTesting()

下取りモードのテストを停止します。

abstract String switchToAdbTcp()

デバイスを adb-over-tcp モードに切り替えます。

abstract boolean switchToAdbUsb()

デバイスを USB 経由の adb モードに切り替えます。

abstract boolean syncFiles(File localFileDir, String deviceFilePath)

ローカル ファイル ディレクトリの内容をデバイスに増分同期します。

abstract boolean unlockDevice()

デバイスが暗号化された状態の場合、デバイスのロックを解除します。

abstract void unmountDebugfs()

debugfs をアンマウントします。

abstract boolean waitForBootComplete(long timeOut)

デバイスの起動完了フラグが設定されるまでブロックします。

abstract boolean waitForDeviceAvailable()

デバイスが応答可能になり、テストに使用できるようになるまで待機します。

abstract boolean waitForDeviceAvailable(long waitTime)

デバイスが応答可能になり、テストに使用できるようになるまで待機します。

abstract boolean waitForDeviceAvailableInRecoverPath(long waitTime)

復元パスを考慮せずに、デバイスが応答可能で利用可能になるまで待機します。

abstract void waitForDeviceBootloader()

fastboot でデバイスが認識されるまでブロックします。

abstract boolean waitForDeviceInRecovery(long waitTime)

デバイスが「adb recovery」状態になるのをブロックします(これは IDeviceRecovery とは異なります)。

abstract boolean waitForDeviceInSideload(long waitTime)

デバイスが「adb sideload」状態になるためのブロック

abstract boolean waitForDeviceNotAvailable(long waitTime)

デバイスが利用できない(adb に表示されない)ようにブロックします。

abstract void waitForDeviceOnline()

デバイスが adb 経由で認識されるまでブロックします。

abstract void waitForDeviceOnline(long waitTime)

デバイスが adb 経由で認識されるまでブロックします。

abstract boolean waitForDeviceShell(long waitTime)

デバイスが基本的な adb shell コマンドに応答するまで待機します。

定数

UNKNOWN_API_LEVEL

public static final int UNKNOWN_API_LEVEL

API レベルを検出できない場合のデフォルト値

定数値: -1 (0xffffffff)

パブリック メソッド

checkApiLevelAgainstNextRelease

public abstract boolean checkApiLevelAgainstNextRelease (int strictMinLevel)

最小限サポートされているレベルで、機能が現在サポートされているかどうかを確認します。このメソッドは、API レベルが引き上げられる前に、まだリリースされていない機能も考慮します。

パラメータ
strictMinLevel int: 機能をサポートする厳密な最小レベル。

戻り値
boolean レベルがサポートされている場合は true。それ以外は False が返されます。

例外
com.android.tradefed.device.DeviceNotAvailableException
DeviceNotAvailableException

clearLogcat

public abstract void clearLogcat ()

蓄積された logcat データを削除します。

これは、ITestDevice.getLogcat() が特定の時点以降(新しいデバイスビルドのフラッシュ後など)に生成されたログデータのみを返すようにする場合に便利です。

deleteFile

public abstract void deleteFile (String deviceFilePath)

デバイス上のファイルまたはディレクトリを削除するヘルパー メソッド。

パラメータ
deviceFilePath String: デバイス上のファイルの絶対パス。

例外
com.android.tradefed.device.DeviceNotAvailableException
DeviceNotAvailableException

deleteFile

public abstract void deleteFile (String deviceFilePath, 
                int userId)

デバイス上のファイルまたはディレクトリを削除するヘルパー メソッド。

パラメータ
deviceFilePath String: デバイス上のファイルの絶対パス。

userId int: 削除するユーザー ID

例外
com.android.tradefed.device.DeviceNotAvailableException
DeviceNotAvailableException

deviceSoftRestarted

public abstract boolean deviceSoftRestarted (ProcessInfo prevSystemServerProcess)

現在の system_server と以前の system_server ProcessInfo を比較して、デバイスがソフトリブートされたかどうかを確認するヘルパー メソッド。getProcessByName(String) を使用して ProcessInfo を取得します。

パラメータ
prevSystemServerProcess ProcessInfo: 以前の system_server プロセス ProcessInfo

戻り値
boolean デバイスがソフトリブートされた場合は true

例外
com.android.tradefed.device.DeviceNotAvailableException
RuntimeException デバイスの起動理由が異常な場合
DeviceNotAvailableException

deviceSoftRestartedSince

public abstract boolean deviceSoftRestartedSince (long utcEpochTime, 
                TimeUnit timeUnit)

デバイスの UTC 時刻(エポックからの経過時間)とその TimeUnit から、デバイスがソフト再起動されたかどうかを確認するヘルパー メソッド。ソフト再起動とは、デバイスのハード再起動以外で system_server が再起動されることを指します(リクエストされた再起動など)。現在のデバイスの utcEpochTime(ミリ秒単位)は、メソッド getDeviceDate() で取得できます。

パラメータ
utcEpochTime long: エポックからの経過秒数で表したデバイス時間。

timeUnit TimeUnit: 指定された utcEpochTime の時間単位 TimeUnit

戻り値
boolean デバイスがソフトリブートされた場合は true

例外
com.android.tradefed.device.DeviceNotAvailableException
RuntimeException デバイスの起動理由が異常な場合
DeviceNotAvailableException

disableAdbRoot

public abstract boolean disableAdbRoot ()

adb root をオフにします。

adb root を無効にすると、デバイスが adb から切断されることがあります。このメソッドは、デバイスが使用可能になるまでブロックします。

戻り値
boolean 成功した場合は true

例外
DeviceNotAvailableException デバイスとの接続が失われ、復元できない場合。

doesFileExist

public abstract boolean doesFileExist (String deviceFilePath)

デバイス上のファイルが存在するかどうかを判断するヘルパー メソッド。

パラメータ
deviceFilePath String: チェックするデバイス上のファイルの絶対パス

戻り値
boolean ファイルが存在する場合は true、それ以外の場合は false

例外
DeviceNotAvailableException デバイスとの接続が失われ、復元できない場合。

enableAdbRoot

public abstract boolean enableAdbRoot ()

adb root をオンにします。「enable-root」設定が「false」の場合、メッセージをログに記録し、root を有効にせずに戻ります。

adb root を有効にすると、デバイスが adb から切断されることがあります。このメソッドは、デバイスが使用可能になるまでブロックします。

戻り値
boolean 成功した場合は true

例外
DeviceNotAvailableException デバイスとの接続が失われ、復元できない場合。

executeAdbCommand

public abstract String executeAdbCommand (long timeout, 
                String... commandArgs)

指定されたタイムアウトで adb コマンドをシステム コマンドとして実行するヘルパー メソッド。

可能な限り executeShellCommand(String) を使用してください。このメソッドは、障害検出とパフォーマンスが優れています。

パラメータ
timeout long: デバイスが応答なしと見なされるまでの時間(ミリ秒単位)。タイムアウトなしの場合は 0L

commandArgs String: 実行する adb コマンドと引数

戻り値
String コマンドの stdout。コマンドの実行に失敗した場合は null

例外
DeviceNotAvailableException デバイスとの接続が失われ、復元できない場合。

executeAdbCommand

public abstract String executeAdbCommand (String... commandArgs)

adb コマンドをシステム コマンドとして実行するヘルパー メソッド。

可能な限り executeShellCommand(String) を使用してください。このメソッドは、障害検出とパフォーマンスが優れています。

パラメータ
commandArgs String: 実行する adb コマンドと引数

戻り値
String コマンドの stdout。コマンドの実行に失敗した場合は null

例外
DeviceNotAvailableException デバイスとの接続が失われ、復元できない場合。

executeAdbCommand

public abstract String executeAdbCommand (long timeout, 
                Map<String, String> envMap, 
                String... commandArgs)

指定されたタイムアウトで adb コマンドをシステム コマンドとして実行するヘルパー メソッド。

可能な限り executeShellCommand(String) を使用してください。このメソッドは、障害検出とパフォーマンスが優れています。

パラメータ
timeout long: デバイスが応答なしと見なされるまでの時間(ミリ秒単位)。タイムアウトなしの場合は 0L

envMap Map: コマンドに設定する環境

commandArgs String: 実行する adb コマンドと引数

戻り値
String コマンドの stdout。コマンドの実行に失敗した場合は null

例外
DeviceNotAvailableException デバイスとの接続が失われ、復元できない場合。

executeAdbV2Command

public abstract CommandResult executeAdbV2Command (String... commandArgs)

adb コマンドをシステム コマンドとして実行するヘルパー メソッド。

可能な限り executeShellCommand(String) を使用してください。このメソッドは、障害検出とパフォーマンスが優れています。

パラメータ
commandArgs String: 実行する adb コマンドと引数

戻り値
CommandResult コマンドの出力を含む CommandResult。

例外
DeviceNotAvailableException デバイスとの接続が失われ、復元できない場合。

executeAdbV2Command

public abstract CommandResult executeAdbV2Command (long timeout, 
                String... commandArgs)

指定されたタイムアウトで adb コマンドをシステム コマンドとして実行するヘルパー メソッド。

可能な限り executeShellCommand(String) を使用してください。このメソッドは、障害検出とパフォーマンスが優れています。

パラメータ
timeout long: デバイスが応答なしと見なされるまでの時間(ミリ秒単位)。タイムアウトなしの場合は 0L

commandArgs String: 実行する adb コマンドと引数

戻り値
CommandResult コマンドの出力を含む CommandResult。

例外
DeviceNotAvailableException デバイスとの接続が失われ、復元できない場合。

executeAdbV2Command

public abstract CommandResult executeAdbV2Command (long timeout, 
                Map<String, String> envMap, 
                int retryAttempts, 
                String... commandArgs)

指定されたタイムアウトで adb コマンドをシステム コマンドとして実行するヘルパー メソッド。

可能な限り executeShellCommand(String) を使用してください。このメソッドは、障害検出とパフォーマンスが優れています。

パラメータ
timeout long: デバイスが応答なしと見なされるまでの時間(ミリ秒単位)。タイムアウトなしの場合は 0L

envMap Map: コマンドに設定する環境

retryAttempts int: 例外が原因でコマンドが失敗した場合に、コマンドを再試行する最大回数。retryAttempts が正常に実行されなかった場合は、DeviceNotResponsiveException がスローされます。

commandArgs String: 実行する adb コマンドと引数

戻り値
CommandResult コマンドの出力を含む CommandResult。

例外
DeviceNotAvailableException デバイスとの接続が失われ、復元できない場合。

executeAdbV2Command

public abstract CommandResult executeAdbV2Command (long timeout, 
                Map<String, String> envMap, 
                String... commandArgs)

指定されたタイムアウトで adb コマンドをシステム コマンドとして実行するヘルパー メソッド。

可能な限り executeShellCommand(String) を使用してください。このメソッドは、障害検出とパフォーマンスが優れています。

パラメータ
timeout long: デバイスが応答なしと見なされるまでの時間(ミリ秒単位)。タイムアウトなしの場合は 0L

envMap Map: コマンドに設定する環境

commandArgs String: 実行する adb コマンドと引数

戻り値
CommandResult コマンドの出力を含む CommandResult。

例外
DeviceNotAvailableException デバイスとの接続が失われ、復元できない場合。

executeFastbootCommand

public abstract CommandResult executeFastbootCommand (long timeout, 
                String... commandArgs)

システム コマンドとして fastboot コマンドを実行するヘルパー メソッド。

デバイスがすでに fastboot モードになっている場合に使用されることが想定されています。

パラメータ
timeout long: コマンドの有効期限が切れるまでの時間(ミリ秒単位)

commandArgs String: 実行する fastboot コマンドと引数

戻り値
CommandResult コマンドの出力を含む CommandResult

例外
DeviceNotAvailableException デバイスとの接続が失われ、復元できない場合。

executeFastbootCommand

public abstract CommandResult executeFastbootCommand (String... commandArgs)

デフォルトのタイムアウトが 2 分のシステム コマンドとして fastboot コマンドを実行するヘルパー メソッド。

デバイスがすでに fastboot モードになっている場合に使用されることが想定されています。

パラメータ
commandArgs String: 実行する fastboot コマンドと引数

戻り値
CommandResult コマンドの出力を含む CommandResult

例外
DeviceNotAvailableException デバイスとの接続が失われ、復元できない場合。

executeLongFastbootCommand

public abstract CommandResult executeLongFastbootCommand (String... commandArgs)

長時間実行される fastboot コマンドをシステム コマンドとして実行するヘルパー メソッド。

タイムアウトが長い点を除き、executeFastbootCommand(String...) と同じです。

パラメータ
commandArgs String: 実行する fastboot コマンドと引数

戻り値
CommandResult コマンドの出力を含む CommandResult

例外
DeviceNotAvailableException デバイスとの接続が失われ、復元できない場合。

executeLongFastbootCommand

public abstract CommandResult executeLongFastbootCommand (Map<String, String> envVarMap, 
                String... commandArgs)

システム環境変数を使用して、長時間実行される fastboot コマンドをシステム コマンドとして実行するヘルパー メソッド。

タイムアウトが長い点を除き、executeFastbootCommand(String...) と同じです。

パラメータ
envVarMap Map: fastboot コマンドの実行に使用されるシステム環境変数

commandArgs String: 実行する fastboot コマンドと引数

戻り値
CommandResult コマンドの出力を含む CommandResult

例外
DeviceNotAvailableException デバイスとの接続が失われ、復元できない場合。

executeShellCommand

public abstract String executeShellCommand (String command)

adb shell コマンドを実行し、出力を String として返すヘルパー メソッド。

パラメータ
command String: 実行する adb シェルコマンド

戻り値
String シェル出力

例外
DeviceNotAvailableException デバイスとの接続が失われ、復元できない場合。

executeShellCommand

public abstract void executeShellCommand (String command, 
                IShellOutputReceiver receiver, 
                long maxTimeToOutputShellResponse, 
                TimeUnit timeUnit, 
                int retryAttempts)

adb シェルコマンドを実行します。コマンドの動作を制御するためのパラメータが追加されています。

パラメータ
command String: 実行する adb シェルコマンド

receiver IShellOutputReceiver: シェル出力を転送する IShellOutputReceiver

maxTimeToOutputShellResponse long: コマンドがレスポンスを出力しないことが許容される最大時間。単位は timeUnit で指定

timeUnit TimeUnit: maxTimeToOutputShellResponse の単位

retryAttempts int: 例外が原因でコマンドが失敗した場合に、コマンドを再試行する最大回数。retryAttempts が正常に実行されなかった場合、DeviceNotResponsiveException がスローされます。

例外
DeviceNotAvailableException デバイスとの接続が失われ、復元できない場合。

executeShellCommand

public abstract void executeShellCommand (String command, 
                IShellOutputReceiver receiver)

指定された adb シェルコマンドを実行します。コマンドが失敗した場合は、複数回再試行します。

デフォルト値を持つ executeShellCommand(String,IShellOutputReceiver,long,TimeUnit,int) のシンプルな形式。

パラメータ
command String: 実行する adb シェルコマンド

receiver IShellOutputReceiver: シェル出力を転送する IShellOutputReceiver

例外
DeviceNotAvailableException デバイスとの接続が失われ、復元できない場合。

executeShellCommand

public abstract void executeShellCommand (String command, 
                IShellOutputReceiver receiver, 
                long maxTimeoutForCommand, 
                long maxTimeToOutputShellResponse, 
                TimeUnit timeUnit, 
                int retryAttempts)

adb シェルコマンドを実行します。コマンドの動作を制御するためのパラメータが追加されています。

パラメータ
command String: 実行する adb シェルコマンド

receiver IShellOutputReceiver: シェル出力を転送する IShellOutputReceiver

maxTimeoutForCommand long: コマンドが完了するまでの最大タイムアウト。単位は timeUnit で指定

maxTimeToOutputShellResponse long: コマンドがレスポンスを出力しないことが許容される最大時間。単位は timeUnit で指定

timeUnit TimeUnit: maxTimeToOutputShellResponse の単位

retryAttempts int: 例外が原因でコマンドが失敗した場合に、コマンドを再試行する最大回数。retryAttempts が正常に実行されなかった場合は、DeviceNotResponsiveException がスローされます。

例外
DeviceNotAvailableException デバイスとの接続が失われ、復元できない場合。

executeShellV2Command

public abstract CommandResult executeShellV2Command (String command)

adb シェルコマンドを実行し、コマンド ステータス出力、stdout、stderr が適切に設定された CommandResult として結果を返すヘルパー メソッド。

パラメータ
command String: 実行するコマンド。

戻り値
CommandResult 結果は CommandResult になります。

例外
DeviceNotAvailableException デバイスとの接続が失われ、復元できない場合。

executeShellV2Command

public abstract CommandResult executeShellV2Command (String command, 
                File pipeAsInput, 
                OutputStream pipeToOutput, 
                long maxTimeoutForCommand, 
                TimeUnit timeUnit, 
                int retryAttempts)

adb シェルコマンドを実行します。コマンドの動作を制御するためのパラメータが追加されています。

パラメータ
command String: 実行する adb シェルコマンド

pipeAsInput File: コマンドへの入力としてパイプされる File。または null。

pipeToOutput OutputStream: 標準出力がリダイレクトされる OutputStream。null の場合もあります。

maxTimeoutForCommand long: コマンドが完了するまでの最大タイムアウト。単位は timeUnit で指定

timeUnit TimeUnit: maxTimeToOutputShellResponse の単位

retryAttempts int: 例外が原因でコマンドが失敗した場合に、コマンドを再試行する最大回数。retryAttempts が正常に実行されなかった場合は、DeviceNotResponsiveException がスローされます。

戻り値
CommandResult

例外
DeviceNotAvailableException デバイスとの接続が失われ、復元できない場合。

executeShellV2Command

public abstract CommandResult executeShellV2Command (String command, 
                long maxTimeoutForCommand, 
                TimeUnit timeUnit)

adb シェルコマンドを実行します。コマンドの動作を制御するためのパラメータが追加されています。

パラメータ
command String: 実行する adb シェルコマンド

maxTimeoutForCommand long: コマンドが完了するまでの最大タイムアウト。単位は timeUnit で指定

timeUnit TimeUnit: maxTimeToOutputShellResponse の単位

戻り値
CommandResult

例外
DeviceNotAvailableException デバイスとの接続が失われ、復元できない場合。

executeShellV2Command

public abstract CommandResult executeShellV2Command (String command, 
                File pipeAsInput)

adb シェルコマンドを実行し、コマンド ステータス出力、stdout、stderr が適切に設定された CommandResult として結果を返すヘルパー メソッド。

パラメータ
command String: 実行するコマンド。

pipeAsInput File: コマンドへの入力としてパイプされる File。または null。

戻り値
CommandResult 結果は CommandResult になります。

例外
DeviceNotAvailableException デバイスとの接続が失われ、復元できない場合。

executeShellV2Command

public abstract CommandResult executeShellV2Command (String command, 
                OutputStream pipeToOutput)

adb シェルコマンドを実行し、コマンド ステータス出力と stderr が適切に設定された CommandResult として結果を返すヘルパー メソッド。stdout は指定されたストリームに転送されます。

パラメータ
command String: 実行するコマンド。

pipeToOutput OutputStream: 標準出力がリダイレクトされる OutputStream。null の場合もあります。

戻り値
CommandResult 結果は CommandResult になります。

例外
DeviceNotAvailableException デバイスとの接続が失われ、復元できない場合。

executeShellV2Command

public abstract CommandResult executeShellV2Command (String command, 
                File pipeAsInput, 
                OutputStream pipeToOutput, 
                OutputStream pipeToError, 
                long maxTimeoutForCommand, 
                TimeUnit timeUnit, 
                int retryAttempts)

adb シェルコマンドを実行します。コマンドの動作を制御するためのパラメータが追加されています。

パラメータ
command String: 実行する adb シェルコマンド

pipeAsInput File: コマンドへの入力としてパイプされる File。または null。

pipeToOutput OutputStream: 標準出力がリダイレクトされる OutputStream。null の場合もあります。

pipeToError OutputStream: 標準エラーのリダイレクト先となる OutputStream。null の場合もあります。

maxTimeoutForCommand long: コマンドが完了するまでの最大タイムアウト。単位は timeUnit で指定

timeUnit TimeUnit: maxTimeToOutputShellResponse の単位

retryAttempts int: 例外が原因でコマンドが失敗した場合に、コマンドを再試行する最大回数。retryAttempts が正常に実行されなかった場合は、DeviceNotResponsiveException がスローされます。

戻り値
CommandResult

例外
DeviceNotAvailableException デバイスとの接続が失われ、復元できない場合。

executeShellV2Command

public abstract CommandResult executeShellV2Command (String command, 
                File pipeAsInput, 
                OutputStream pipeToOutput, 
                OutputStream pipeToError, 
                long maxTimeoutForCommand, 
                long maxTimeToOutputShellResponse, 
                TimeUnit timeUnit, 
                int retryAttempts)

adb シェルコマンドを実行します。コマンドの動作を制御するためのパラメータが追加されています。

パラメータ
command String: 実行する adb シェルコマンド

pipeAsInput File: コマンドへの入力としてパイプされる File。または null。

pipeToOutput OutputStream: 標準出力がリダイレクトされる OutputStream。null の場合もあります。

pipeToError OutputStream: 標準エラーのリダイレクト先となる OutputStream。null の場合もあります。

maxTimeoutForCommand long: コマンドが完了するまでの最大タイムアウト。単位は timeUnit で指定

maxTimeToOutputShellResponse long: コマンドがレスポンスを出力しないことが許容される最大時間。単位は timeUnit で指定

timeUnit TimeUnit: maxTimeToOutputShellResponse の単位

retryAttempts int: 例外が原因でコマンドが失敗した場合に、コマンドを再試行する最大回数。retryAttempts が正常に実行されなかった場合は、DeviceNotResponsiveException がスローされます。

戻り値
CommandResult

例外
DeviceNotAvailableException デバイスとの接続が失われ、復元できない場合。

executeShellV2Command

public abstract CommandResult executeShellV2Command (String command, 
                long maxTimeoutForCommand, 
                TimeUnit timeUnit, 
                int retryAttempts)

adb シェルコマンドを実行します。コマンドの動作を制御するためのパラメータが追加されています。

パラメータ
command String: 実行する adb シェルコマンド

maxTimeoutForCommand long: コマンドが完了するまでの最大タイムアウト。単位は timeUnit で指定

timeUnit TimeUnit: maxTimeToOutputShellResponse の単位

retryAttempts int: 例外が原因でコマンドが失敗した場合に、コマンドを再試行する最大回数。retryAttempts が正常に実行されなかった場合は、DeviceNotResponsiveException がスローされます。

戻り値
CommandResult

例外
DeviceNotAvailableException デバイスとの接続が失われ、復元できない場合。

executeShellV2Command

public abstract CommandResult executeShellV2Command (String command, 
                IShellOutputReceiver receiver)

adb シェルコマンドを実行し、コマンド ステータス出力、stdout、stderr が適切に設定された CommandResult として結果を返すヘルパー メソッド。

パラメータ
command String: 実行するコマンド。

receiver IShellOutputReceiver: シェル出力を転送する IShellOutputReceiver

戻り値
CommandResult 結果は CommandResult になります。

例外
DeviceNotAvailableException デバイスとの接続が失われ、復元できない場合。

fastbootOemRamdumpNow

public abstract CommandResult fastbootOemRamdumpNow ()

fastboot モードから ramdump をトリガーするヘルパー メソッド。

このメソッドは「oem ramdump now」コマンドを実行します。ERROR(/#executeFastbootCommand()) とは異なり、コマンドが失敗した場合やステータスが無効な場合でも、再試行やデバイスの復元は試みません。デバイスのクラッシュが意図された結果であるためです。デバイスがすでに fastboot モードになっている場合に使用されることが想定されています。

戻り値
CommandResult コマンドの出力を含む CommandResult

例外
DeviceNotAvailableException デバイスとの接続が失われ、復元できない場合。

fastbootWipePartition

public abstract CommandResult fastbootWipePartition (String partition)

デバイスのパーティションをワイプするヘルパー メソッド。

getUseFastbootErase()true の場合、fastboot erase を使用してパーティションをワイプします。デバイスは、次回起動時にファイル システムを作成する必要があります。それ以外の場合は、fastboot format が使用され、デバイスに新しいファイル システムが作成されます。

デバイスがすでに fastboot モードになっている場合に使用されることが想定されています。

パラメータ
partition String: ワイプするパーティション

戻り値
CommandResult コマンドの出力を含む CommandResult

例外
DeviceNotAvailableException デバイスとの接続が失われ、復元できない場合。

getApiLevel

public abstract int getApiLevel ()

デバイスの API レベルを取得します。デフォルトは UNKNOWN_API_LEVEL です。

戻り値
int デバイスの API レベルを示す整数

例外
com.android.tradefed.device.DeviceNotAvailableException
DeviceNotAvailableException

getApiLevelFull

public abstract int getApiLevelFull ()

getApiLevel() と同様ですが、完全なバージョンを返します。

戻り値
int デバイスの完全な API レベルを示す整数

例外
com.android.tradefed.device.DeviceNotAvailableException
DeviceNotAvailableException

getBasebandVersion

public abstract String getBasebandVersion ()

このデバイスのベースバンド(無線通信)バージョンを取得する便利なメソッド。無線通信バージョンの取得はデバイス固有であるため、すべてのデバイスで正しい情報が返されるとは限りません。このメソッドは、gsm.version.baseband プロパティに依存して正しいバージョン情報を返します。一部の CDMA デバイスでは正確ではなく、ここで返されるバージョンは fastboot から報告されるバージョンと一致しない場合があり、CDMA 無線通信のバージョンを返さない場合があります。要するに、このメソッドは gsm.version.baseband プロパティが fastboot getvar version-baseband が返すバージョンと同じ場合にのみ正確なバージョンをレポートします。

戻り値
String String ベースバンド バージョン。特定できない場合は null(デバイスにラジオがない、またはバージョン文字列を読み取れない場合)

例外
DeviceNotAvailableException デバイスとの接続が失われ、復元できない場合。

getBattery

public abstract Integer getBattery ()

デバイスの現在のバッテリー残量を返します。バッテリー残量が取得できない場合は Null を返します。

戻り値
Integer

getBooleanProperty

public abstract boolean getBooleanProperty (String name, 
                boolean defaultValue)

指定されたプロパティのブール値を返します。

パラメータ
name String: プロパティ名

defaultValue boolean: プロパティが空の場合、または存在しない場合に返されるデフォルト値。

戻り値
boolean プロパティの値が "1""y""yes""on""true" の場合は true、プロパティの値が "0""n""no""off""false"defaultValue の場合は false、それ以外の場合は "0"

例外
DeviceNotAvailableException

getBootHistory

public abstract Map<Long, String> getBootHistory ()

ヘルパー メソッドは、起動時間と起動理由を含む起動履歴マップを収集します。

戻り値
Map<Long, String> 起動時間(エポックからの経過秒数での UTC 時間)と起動理由のマップ

例外
DeviceNotAvailableException

getBootHistorySince

public abstract Map<Long, String> getBootHistorySince (long utcEpochTime, 
                TimeUnit timeUnit)

ヘルパー メソッドは、デバイスから指定されたエポック以降の時間と指定された時間単位で、起動時間と起動理由を含む起動履歴マップを収集します。現在のデバイスの utcEpochTime(ミリ秒単位)は、メソッド getDeviceDate() で取得できます。

パラメータ
utcEpochTime long: エポックからのデバイス時間。

timeUnit TimeUnit: 時間単位 TimeUnit

戻り値
Map<Long, String> 起動時間(エポックからの経過秒数での UTC 時間)と起動理由のマップ

例外
DeviceNotAvailableException

getBootloaderVersion

public abstract String getBootloaderVersion ()

このデバイスのブートローダー バージョンを取得する便利なメソッド。

デバイスの現在の状態からブートローダー バージョンの取得を試みます。(デバイスが Fastboot モードの場合、Fastboot からバージョンを取得しようとします)。

戻り値
String String ブートローダーのバージョン。見つからない場合は null

例外
DeviceNotAvailableException デバイスとの接続が失われ、復元できない場合。

getBuildAlias

public abstract String getBuildAlias ()

デバイスで現在実行中のビルドのエイリアスを取得します。

ビルド エイリアスは通常、ビルド ID よりも読みやすい文字列です(通常、Nexus ビルドの番号)。たとえば、Android 4.2 の最終リリースにはビルド エイリアス JDQ39 とビルド ID 573038 があります。

戻り値
String ビルド エイリアス。取得できなかった場合はビルド ID にフォールバックします。

例外
com.android.tradefed.device.DeviceNotAvailableException
DeviceNotAvailableException

getBuildFlavor

public abstract String getBuildFlavor ()

デバイスのビルド フレーバーを取得します。

戻り値
String ビルド フレーバー。取得できなかった場合は null

例外
com.android.tradefed.device.DeviceNotAvailableException
DeviceNotAvailableException

getBuildId

public abstract String getBuildId ()

デバイスで現在実行中のビルドを取得します。

戻り値
String ビルド ID。取得できなかった場合は IBuildInfo.UNKNOWN_BUILD_ID

例外
com.android.tradefed.device.DeviceNotAvailableException
DeviceNotAvailableException

getBuildSigningKeys

public abstract String getBuildSigningKeys ()

デバイス イメージの署名に使用された鍵の種類を返します

通常、Android デバイスはテストキー(AOSP の場合など)またはリリースキー(個々のデバイス メーカーが管理)で署名されます。

戻り値
String 署名鍵(見つかった場合)。見つからなかった場合は null。

例外
com.android.tradefed.device.DeviceNotAvailableException
DeviceNotAvailableException

getCachedDeviceDescriptor

public abstract DeviceDescriptor getCachedDeviceDescriptor ()

デバイスが割り当てられている場合はキャッシュに保存された DeviceDescriptor を返し、それ以外の場合は現在の DeviceDescriptor を返します。

戻り値
DeviceDescriptor

getCachedDeviceDescriptor

public abstract DeviceDescriptor getCachedDeviceDescriptor (boolean shortDescriptor)

デバイスが割り当てられている場合はキャッシュに保存された DeviceDescriptor を返し、それ以外の場合は現在の DeviceDescriptor を返します。

パラメータ
shortDescriptor boolean: 記述子を最小限の情報に制限するかどうか

戻り値
DeviceDescriptor

getChildren

public abstract String[] getChildren (String deviceFilePath)

権限が原因で機能しないことがある IFileEntry を使用する代わりに、

パラメータ
deviceFilePath String: 検索を行うデバイス上のパス

戻り値
String[] デバイス上のパスにあるすべてのファイルを含む文字列の配列。

例外
com.android.tradefed.device.DeviceNotAvailableException
DeviceNotAvailableException

getConnection

public abstract AbstractConnection getConnection ()

デバイスに関連付けられた接続を返します。

戻り値
AbstractConnection

getDeviceClass

public abstract String getDeviceClass ()

デバイスクラスを取得します。

戻り値
String String デバイス クラス。

getDeviceDate

public abstract long getDeviceDate ()

デバイスの日付をエポックからのミリ秒単位で返します。

戻り値
long デバイスの日付(エポック形式)。

例外
com.android.tradefed.device.DeviceNotAvailableException
DeviceNotAvailableException

getDeviceDescriptor

public abstract DeviceDescriptor getDeviceDescriptor ()

デバイス情報から DeviceDescriptor を返して、実際のデバイス オブジェクトを渡さずに情報を取得します。

戻り値
DeviceDescriptor

getDeviceDescriptor

public abstract DeviceDescriptor getDeviceDescriptor (boolean shortDescriptor)

デバイス情報から DeviceDescriptor を返して、実際のデバイス オブジェクトを渡さずに情報を取得します。

パラメータ
shortDescriptor boolean: 記述子を最小限の情報に制限するかどうか

戻り値
DeviceDescriptor

getDeviceState

public abstract TestDeviceState getDeviceState ()

デバイスの状態を取得します。

戻り値
TestDeviceState

getDeviceTimeOffset

public abstract long getDeviceTimeOffset (Date date)

デバイスと指定された Date の間の時間差を取得するヘルパー。内部でエポック時間を使用します。

パラメータ
date Date

戻り値
long ミリ秒単位の差

例外
DeviceNotAvailableException

getEmulatorOutput

public abstract InputStreamSource getEmulatorOutput ()

エミュレータの stdout と stderr のストリームを取得する

戻り値
InputStreamSource エミュレータの出力

getExternalStoreFreeSpace

public abstract long getExternalStoreFreeSpace ()

デバイスの外部ストレージの空き容量を判断するヘルパー メソッド。

戻り値
long 空き容量(KB)

例外
DeviceNotAvailableException デバイスとの接続が失われ、復元できない場合。

getFastbootProductType

public abstract String getFastbootProductType ()

デバイスが Fastboot モード(Fastboot mode)のときに、そのデバイスの商品タイプを取得する便利なメソッド。

このメソッドは、デバイスが fastboot にある必要がある場合にのみ使用してください。この場合、ITestDevice はデバイスが正しくない状態にあるか、応答しない場合にデバイスを fastboot に復元することがわかるため、汎用的な getProductType() メソッドよりも少し安全なバリアントです。

戻り値
String String(商品タイプ名)または null(特定できない場合)

例外
DeviceNotAvailableException デバイスとの接続が失われ、復元できない場合。

getFastbootProductVariant

public abstract String getFastbootProductVariant ()

デバイスが Fastboot モード(Fastboot mode)のときに、そのデバイスの商品タイプを取得する便利なメソッド。

このメソッドは、デバイスが fastboot にある必要がある場合にのみ使用してください。この場合、ITestDevice はデバイスが正しくない状態にあるか、応答しない場合にデバイスを fastboot に復元することがわかるため、汎用的な getProductType() メソッドよりも少し安全なバリアントです。

戻り値
String String(商品タイプ名)または null(特定できない場合)

例外
DeviceNotAvailableException デバイスとの接続が失われ、復元できない場合。

getFastbootSerialNumber

public abstract String getFastbootSerialNumber ()

Fastboot モードのシリアル番号を返します。

戻り値
String

getFastbootVariable

public abstract String getFastbootVariable (String variableName)

指定された fastboot 変数の値をデバイスから取得します。

パラメータ
variableName String: 変数名

戻り値
String プロパティ値。存在しない場合は null

例外
UnsupportedOperationException
DeviceNotAvailableException
UnsupportedOperationException

getFileEntry

public abstract IFileEntry getFileEntry (String path)

デバイス上のリモート ファイルへの参照を取得します。

パラメータ
path String: 取得するファイルパス。絶対パスまたは「/」からの相対パスを指定できます(「/system」と「system」の両方の構文がサポートされています)。

戻り値
IFileEntry 指定された path のファイルが見つからない場合は IFileEntry または null

例外
com.android.tradefed.device.DeviceNotAvailableException
DeviceNotAvailableException

getIDevice

public abstract IDevice getIDevice ()

関連付けられた ddmlib IDevice への参照を返します。

デバイスが adb から切断されて再接続されるたびに、DDMS によって新しい IDevice が割り当てられることがあります。そのため、呼び出し元は IDevice への参照を保持すべきではありません。参照が古くなる可能性があるためです。

戻り値
IDevice IDevice

getIntProperty

public abstract long getIntProperty (String name, 
                long defaultValue)

デバイスから指定されたプロパティの整数値を返します。

パラメータ
name String: プロパティ名

defaultValue long: プロパティが空の場合、または存在しない場合に返されるデフォルト値。

戻り値
long プロパティの値。プロパティが空、存在しない、または整数値を持たない場合は defaultValue

例外
DeviceNotAvailableException

getLastExpectedRebootTimeMillis

public abstract long getLastExpectedRebootTimeMillis ()

Tradefed API が最後に再起動をトリガーした時刻(エポックからのミリ秒単位)を返します。System.currentTimeMillis() によって返されます。

戻り値
long

getLaunchApiLevel

public abstract int getLaunchApiLevel ()

デバイスの初回リリース時の API レベルを取得します。デフォルトは UNKNOWN_API_LEVEL です。

戻り値
int デバイスの最初のリリース時の API レベルを示す整数

例外
com.android.tradefed.device.DeviceNotAvailableException
DeviceNotAvailableException

getLogcat

public abstract InputStreamSource getLogcat ()

logcat データのスナップショット ストリームを取得します。

次の 2 つのモードで動作します。

  • logcat がバックグラウンドでキャプチャされている場合、バックグラウンド logcat キャプチャの現在の内容を最大 TestDeviceOptions.getMaxLogcatDataSize() バイト返します。
  • それ以外の場合は、デバイスが現在応答している場合は logcat データの静的ダンプを返します。

    戻り値
    InputStreamSource

  • getLogcat

    public abstract InputStreamSource getLogcat (int maxBytes)

    キャプチャされた logcat データの最後の maxBytes のスナップショット ストリームを取得します。

    getLogcat() スナップショット全体を取得する際に発生する可能性のある大きなディスク容量のペナルティを回避しながら、キャプチャした logcat データのスナップショットを頻繁に取得したい場合に便利です。

    パラメータ
    maxBytes int: 返されるデータの最大量。メモリに収まる程度の量にする必要があります

    戻り値
    InputStreamSource

    getLogcatDump

    public abstract InputStreamSource getLogcatDump ()

    デバイスの現在の logcat のダンプを取得します。getLogcat() とは異なり、このメソッドは常に logcat の静的ダンプを返します。

    デバイスにアクセスできない場合は何も返されないというデメリットがあります。

    戻り値
    InputStreamSource ログキャットデータの InputStreamSource。logcat データのキャプチャに失敗した場合は、空のストリームが返されます。

    getLogcatSince

    public abstract InputStreamSource getLogcatSince (long date)

    指定された日付からキャプチャされた logcat データのスナップショット ストリームを取得します。デバイスの時刻は getDeviceDate() を使用する必要があります。

    パラメータ
    date long: スナップショットを開始する日時から現在までのエポックからのミリ秒数形式。(「date +%s」で取得できます)

    戻り値
    InputStreamSource

    getMountPoint

    public abstract String getMountPoint (String mountName)

    マウント ポイントを返します。

    IDevice のキャッシュ情報が利用できない場合、デバイスに直接クエリします。

    TODO: この動作を IDevice.getMountPoint(String) に移動

    パラメータ
    mountName String: マウント ポイントの名前

    戻り値
    String マウント ポイントまたは null

    getMountPointInfo

    public abstract ITestDevice.MountPointInfo getMountPointInfo (String mountpoint)

    指定されたマウントポイント パスに対応する MountPointInfo を返します。そのパスに何もマウントされていない場合や、/proc/mounts にマウントポイントとして表示されない場合は、null を返します。

    パラメータ
    mountpoint String

    戻り値
    ITestDevice.MountPointInfo 「/proc/mounts」の情報を含む MountPointInfoList

    例外
    DeviceNotAvailableException

    関連項目:

    getMountPointInfo

    public abstract List<ITestDevice.MountPointInfo> getMountPointInfo ()

    デバイスの /proc/mounts の情報を解析したバージョンを返します。

    戻り値
    List<ITestDevice.MountPointInfo> 「/proc/mounts」の情報を含む MountPointInfoList

    例外
    DeviceNotAvailableException

    getPartitionFreeSpace

    public abstract long getPartitionFreeSpace (String partition)

    デバイス パーティションの空き容量を判断するヘルパー メソッド。

    パラメータ
    partition String

    戻り値
    long 空き容量(KB)

    例外
    DeviceNotAvailableException デバイスとの接続が失われ、復元できない場合。

    getProcessByName

    public abstract ProcessInfo getProcessByName (String processName)

    ヘルパー メソッドは「pidof」コマンドと「stat」コマンドを実行し、指定されたプロセスの PID とプロセス開始時刻を含む ProcessInfo オブジェクトを返します。

    パラメータ
    processName String: プロセス名の文字列。

    戻り値
    ProcessInfo 指定された processName の ProcessInfo

    例外
    DeviceNotAvailableException

    getProcessPid

    public abstract String getProcessPid (String process)

    サービスが正常に動作した場合はサービスの pid を返し、問題が発生した場合は null を返します。

    パラメータ
    process String: プロセス名の文字列。

    戻り値
    String

    例外
    DeviceNotAvailableException

    getProductType

    public abstract String getProductType ()

    このデバイスの商品タイプを取得するコンビニエンス メソッド。

    この方法は、デバイスが adb モードまたは fastboot モードのいずれかの場合に機能します。

    戻り値
    String String 商品タイプの名前。null にはなりません

    例外
    DeviceNotAvailableException デバイスとの接続が失われ、復元できない場合、または商品タイプを特定できない場合

    getProductVariant

    public abstract String getProductVariant ()

    このデバイスのバリエーション商品を取得する便利なメソッド。

    この方法は、デバイスが adb モードまたは fastboot モードのいずれかの場合に機能します。

    戻り値
    String String(バリエーション商品名)または null(特定できない場合)

    例外
    DeviceNotAvailableException デバイスとの接続が失われ、復元できない場合。

    getProperty

    public abstract String getProperty (String name)

    デバイスから指定されたプロパティ値を取得します。

    パラメータ
    name String: プロパティ名

    戻り値
    String プロパティ値。存在しない場合は null

    例外
    com.android.tradefed.device.DeviceNotAvailableException
    DeviceNotAvailableException

    getRecoveryMode

    public abstract ITestDevice.RecoveryMode getRecoveryMode ()

    デバイスで使用されている現在の復元モードを取得します。

    戻り値
    ITestDevice.RecoveryMode デバイスで使用されている現在の復元モード。

    getSerialNumber

    public abstract String getSerialNumber ()

    このデバイスのシリアル番号を取得する便利なメソッド。

    戻り値
    String String シリアル番号

    getTombstones

    public abstract List<File> getTombstones ()

    デバイスから墓石のリストを取得して返します。ルート権限が必要です。

    メソッドはベスト エフォート型であるため、何らかの理由で 1 つの墓石の取得に失敗すると、その墓石はリストから欠落します。DeviceNotAvailableException のみがメソッドを早期に終了させます。

    戻り値
    List<File> 墓石ファイルのリスト。墓石がない場合は空。

    例外
    DeviceNotAvailableException

    getTotalMemory

    public abstract long getTotalMemory ()

    物理メモリの合計サイズ(バイト単位)を返します。内部エラーの場合は -1 を返します。

    戻り値
    long

    getTrackingSerial

    public String getTrackingSerial ()

    デバイス管理の目的で、デバイスの追跡に使用されるシリアルを取得します。

    戻り値
    String

    getUseFastbootErase

    public abstract boolean getUseFastbootErase ()

    fastboot erase または fastboot format を使用してデバイスのパーティションをワイプするかどうかを取得します。

    戻り値
    boolean fastboot erase を使用する場合は true、fastboot format を使用する場合は false

    isAdbRoot

    public abstract boolean isAdbRoot ()

    戻り値
    boolean デバイスが現在 adb root を持っている場合は true、それ以外の場合は false

    例外
    DeviceNotAvailableException デバイスとの接続が失われ、復元できない場合。

    isAdbTcp

    public abstract boolean isAdbTcp ()

    戻り値
    boolean デバイスが adb-over-tcp に接続されている場合は true、それ以外の場合は false

    isAppEnumerationSupported

    public abstract boolean isAppEnumerationSupported ()

    デバイスのプラットフォームがアプリの列挙をサポートしているかどうかを確認する

    戻り値
    boolean アプリの列挙がサポートされている場合は true、そうでない場合は false

    例外
    com.android.tradefed.device.DeviceNotAvailableException
    DeviceNotAvailableException

    isBypassLowTargetSdkBlockSupported

    public abstract boolean isBypassLowTargetSdkBlockSupported ()

    デバイスのプラットフォームがアプリのインストール時の低ターゲット SDK ブロックのバイパスをサポートしているかどうかを確認する

    戻り値
    boolean 低いターゲット SDK ブロックのバイパスがサポートされている場合は true、それ以外の場合は false

    例外
    com.android.tradefed.device.DeviceNotAvailableException
    DeviceNotAvailableException

    isDebugfsMounted

    public abstract boolean isDebugfsMounted ()

    debugfs がマウントされているかどうかを確認します。

    戻り値
    boolean debugfs がマウントされている場合: true

    例外
    com.android.tradefed.device.DeviceNotAvailableException
    DeviceNotAvailableException

    isDeviceEncrypted

    public abstract boolean isDeviceEncrypted ()

    デバイスが暗号化されているかどうかを返します。

    戻り値
    boolean デバイスが暗号化されている場合は true

    例外
    DeviceNotAvailableException デバイスとの接続が失われ、復元できない場合。

    isDirectory

    public abstract boolean isDirectory (String deviceFilePath)

    デバイス上のパスがディレクトリの場合は True を返し、それ以外の場合は False を返します。

    パラメータ
    deviceFilePath String

    戻り値
    boolean

    例外
    com.android.tradefed.device.DeviceNotAvailableException
    DeviceNotAvailableException

    isEncryptionSupported

    public abstract boolean isEncryptionSupported ()

    デバイスで暗号化がサポートされているかどうかを返します。

    戻り値
    boolean true: デバイスが暗号化をサポートしている場合。

    例外
    com.android.tradefed.device.DeviceNotAvailableException
    DeviceNotAvailableException

    isExecutable

    public abstract boolean isExecutable (String fullPath)

    デバイス上のファイルパスが実行可能ファイルの場合は True を返し、それ以外の場合は False を返します。

    パラメータ
    fullPath String

    戻り値
    boolean

    例外
    com.android.tradefed.device.DeviceNotAvailableException
    DeviceNotAvailableException

    isHeadless

    public abstract boolean isHeadless ()

    デバイスがヘッドレス(画面がない)の場合は true を返し、それ以外の場合は false を返します。

    戻り値
    boolean

    例外
    DeviceNotAvailableException

    isRuntimePermissionSupported

    public abstract boolean isRuntimePermissionSupported ()

    デバイスのプラットフォームが実行時の権限付与に対応しているかどうかを確認する

    戻り値
    boolean 実行時の権限がサポートされている場合は true、そうでない場合は false。

    例外
    com.android.tradefed.device.DeviceNotAvailableException
    DeviceNotAvailableException

    isStateBootloaderOrFastbootd

    public abstract boolean isStateBootloaderOrFastbootd ()

    デバイスが TestDeviceState.FASTBOOT または TestDeviceState.FASTBOOTD の場合、true を返します。

    戻り値
    boolean

    logAnrs

    public abstract boolean logAnrs (ITestLogger logger)

    デバイスから ANR を収集してログに記録します。

    パラメータ
    logger ITestLogger: ANR をログに記録する ITestLogger

    戻り値
    boolean ロギングが成功した場合は true、それ以外の場合は false。

    例外
    DeviceNotAvailableException

    logOnDevice

    public abstract void logOnDevice (String tag, 
                    Log.LogLevel level, 
                    String format, 
                    Object... args)

    デバイスの logcat にメッセージを記録します。これは安全な呼び出しであり、ロギングが失敗しても例外はスローされません。

    パラメータ
    tag String: logcat にメッセージを記録する際のタグ。

    level Log.LogLevel: logcat のメッセージのデバッグレベル。

    format String: メッセージ形式。

    args Object: String.format() で置き換える引数。

    mountDebugfs

    public abstract void mountDebugfs ()

    debugfs をマウントします。

    例外
    com.android.tradefed.device.DeviceNotAvailableException
    DeviceNotAvailableException

    nonBlockingReboot

    public abstract void nonBlockingReboot ()

    デバイスを再起動するコマンドを発行し、コマンドが完了したとき、およびデバイスが adb に表示されなくなったときに返します。

    例外
    com.android.tradefed.device.DeviceNotAvailableException
    DeviceNotAvailableException

    postBootSetup

    public abstract void postBootSetup ()

    ブートごとにテスト用にデバイスを構成する手順を実行します。

    デバイスが完全に起動して使用可能になった後に呼び出す必要があります。

    通常、このメソッドを明示的に呼び出す必要はありません。実装では、再起動時にこれらの手順が自動的に実行されるためです。

    この呼び出しが必要になるのは、他のイベント(fastboot 更新コマンドの完了など)によってデバイスが再起動される場合です。

    例外
    DeviceNotAvailableException デバイスとの接続が失われ、復元できない場合。

    postInvocationTearDown

    public void postInvocationTearDown ()

    このメソッドは非推奨です。
    代わりに postInvocationTearDown(Throwable) を使用してください。

    呼び出しの完了後に実行される、デバイス固有の必須クリーンアップの追加ステップ。

    postInvocationTearDown

    public abstract void postInvocationTearDown (Throwable invocationException)

    呼び出しの完了後に実行される、デバイス固有の必須クリーンアップの追加ステップ。

    パラメータ
    invocationException Throwable: 呼び出しの失敗によって発生した最終的な例外(ある場合)。

    preInvocationSetup

    public void preInvocationSetup (IBuildInfo info, 
                    MultiMap<String, String> attributes)

    呼び出しフローの前にデバイスで実行される、デバイス固有の必須設定の追加手順。

    パラメータ
    info IBuildInfo: デバイスの IBuildInfo

    attributes MultiMap: 呼び出しコンテキストに保存されている属性

    例外
    com.android.tradefed.device.DeviceNotAvailableException
    com.android.tradefed.targetprep.TargetSetupError
    DeviceNotAvailableException
    TargetSetupError

    pullDir

    public abstract boolean pullDir (String deviceFilePath, 
                    File localDir)

    デバイスからディレクトリの内容を再帰的に取得します。

    パラメータ
    deviceFilePath String: リモート ソースの絶対ファイルパス

    localDir File: ファイルをプルするローカル ディレクトリ

    戻り値
    boolean ファイルが正常に取得された場合は true。それ以外の場合は false

    例外
    DeviceNotAvailableException デバイスとの接続が失われ、復元できない場合。

    pullDir

    public abstract boolean pullDir (String deviceFilePath, 
                    File localDir, 
                    int userId, 
                    long timeout)

    デバイスからディレクトリの内容を再帰的に取得します。

    パラメータ
    deviceFilePath String: リモート ソースの絶対ファイルパス

    localDir File: ファイルをプルするローカル ディレクトリ

    userId int: プルするユーザー ID

    timeout long: コマンドの取得のタイムアウト

    戻り値
    boolean ファイルが正常に取得された場合は true。それ以外の場合は false

    例外
    DeviceNotAvailableException デバイスとの接続が失われ、復元できない場合。

    pullDir

    public abstract boolean pullDir (String deviceFilePath, 
                    File localDir, 
                    int userId)

    デバイスからディレクトリの内容を再帰的に取得します。

    パラメータ
    deviceFilePath String: リモート ソースの絶対ファイルパス

    localDir File: ファイルをプルするローカル ディレクトリ

    userId int: プルするユーザー ID

    戻り値
    boolean ファイルが正常に取得された場合は true。それ以外の場合は false

    例外
    DeviceNotAvailableException デバイスとの接続が失われ、復元できない場合。

    pullFile

    public abstract File pullFile (String remoteFilePath, 
                    int userId)

    デバイスからファイルを取得し、ローカルの一時 File に保存して、その File を返します。

    パラメータ
    remoteFilePath String: デバイス上のファイルへの絶対パス。

    userId int: 取得元のユーザー ID

    戻り値
    File デバイス ファイルの内容を含む File。コピーが何らかの理由で失敗した場合は null(ホスト ファイル システムの問題を含む)

    例外
    DeviceNotAvailableException デバイスとの接続が失われ、復元できない場合。

    pullFile

    public abstract boolean pullFile (String remoteFilePath, 
                    File localFile, 
                    int userId, 
                    long timeout)

    デバイスからファイルを取得します。

    パラメータ
    remoteFilePath String: デバイス上のファイルへの絶対パス。

    localFile File: コンテンツを保存するローカル ファイル。空でない場合、内容は置き換えられます。

    userId int: 取得元のユーザー ID

    timeout long: ファイルの取得コマンドのタイムアウト

    戻り値
    boolean ファイルが正常に取得された場合は true。それ以外の場合は false

    例外
    DeviceNotAvailableException デバイスとの接続が失われ、復元できない場合。

    pullFile

    public abstract File pullFile (String remoteFilePath)

    デバイスからファイルを取得し、ローカルの一時 File に保存して、その File を返します。

    パラメータ
    remoteFilePath String: デバイス上のファイルへの絶対パス。

    戻り値
    File デバイス ファイルの内容を含む File。コピーが何らかの理由で失敗した場合(ホスト ファイル システムの問題を含む)は null

    例外
    DeviceNotAvailableException デバイスとの接続が失われ、復元できない場合。

    pullFile

    public abstract boolean pullFile (String remoteFilePath, 
                    File localFile, 
                    int userId)

    デバイスからファイルを取得します。

    パラメータ
    remoteFilePath String: デバイス上のファイルへの絶対パス。

    localFile File: コンテンツを保存するローカル ファイル。空でない場合、内容は置き換えられます。

    userId int: 取得元のユーザー ID

    戻り値
    boolean ファイルが正常に取得された場合は true。それ以外の場合は false

    例外
    DeviceNotAvailableException デバイスとの接続が失われ、復元できない場合。

    pullFile

    public abstract boolean pullFile (String remoteFilePath, 
                    File localFile)

    デバイスからファイルを取得します。

    パラメータ
    remoteFilePath String: デバイス上のファイルへの絶対パス。

    localFile File: コンテンツを保存するローカル ファイル。空でない場合、内容は置き換えられます。

    戻り値
    boolean ファイルが正常に取得された場合は true。それ以外の場合は false

    例外
    DeviceNotAvailableException デバイスとの接続が失われ、復元できない場合。

    pullFileContents

    public abstract String pullFileContents (String remoteFilePath)

    デバイスからファイルを取得し、その内容を返します。

    パラメータ
    remoteFilePath String: デバイス上のファイルへの絶対パス。

    戻り値
    String デバイス ファイルの内容を含む String。コピーが何らかの理由で失敗した場合(ホスト ファイル システムの問題を含む)は null

    例外
    DeviceNotAvailableException

    pullFileFromExternal

    public abstract File pullFileFromExternal (String remoteFilePath)

    デバイスの外部ストレージからファイルを取得し、ローカルの一時的な File に保存して、その File への参照を返す便利なメソッド。

    パラメータ
    remoteFilePath String: デバイスの外部ストレージのマウントポイントを基準とした、デバイス上のファイルのパス

    戻り値
    File デバイス ファイルの内容を含む File。コピーが何らかの理由で失敗した場合(ホスト ファイル システムの問題を含む)は null

    例外
    DeviceNotAvailableException デバイスとの接続が失われ、復元できない場合。

    pushDir

    public abstract boolean pushDir (File localDir, 
                    String deviceFilePath, 
                    int userId)

    ディレクトリの内容をデバイスに再帰的に push します。

    パラメータ
    localDir File: プッシュするローカル ディレクトリ

    deviceFilePath String: リモート宛先の絶対ファイルパス

    userId int: プッシュするユーザー ID

    戻り値
    boolean ファイルが正常にプッシュされた場合は true。それ以外の場合は false

    例外
    DeviceNotAvailableException デバイスとの接続が失われ、復元できない場合。

    pushDir

    public abstract boolean pushDir (File localDir, 
                    String deviceFilePath, 
                    Set<String> excludedDirectories)

    フィルタリングされた一部のディレクトリを除外しながら、ディレクトリの内容をデバイスに再帰的にプッシュします。

    パラメータ
    localDir File: プッシュするローカル ディレクトリ

    deviceFilePath String: リモート宛先の絶対ファイルパス

    excludedDirectories Set: プッシュしない除外ディレクトリ名のセット。

    戻り値
    boolean ファイルが正常にプッシュされた場合は true。それ以外の場合は false

    例外
    DeviceNotAvailableException デバイスとの接続が失われ、復元できない場合。

    pushDir

    public abstract boolean pushDir (File localDir, 
                    String deviceFilePath)

    ディレクトリの内容をデバイスに再帰的に push します。

    パラメータ
    localDir File: プッシュするローカル ディレクトリ

    deviceFilePath String: リモート宛先の絶対ファイルパス

    戻り値
    boolean ファイルが正常にプッシュされた場合は true。それ以外の場合は false

    例外
    DeviceNotAvailableException デバイスとの接続が失われ、復元できない場合。

    pushFile

    public abstract boolean pushFile (File localFile, 
                    String deviceFilePath, 
                    int userId)

    デバイスにファイルをプッシュします。デフォルトでは、コンテンツ プロバイダを使用します。

    パラメータ
    localFile File: プッシュするローカル ファイル

    deviceFilePath String: リモートの宛先の絶対ファイルパス

    userId int: プッシュする userId

    戻り値
    boolean ファイルが正常にプッシュされた場合は true。それ以外の場合は false

    例外
    DeviceNotAvailableException デバイスとの接続が失われ、復元できない場合。

    pushFile

    public abstract boolean pushFile (File localFile, 
                    String deviceFilePath, 
                    boolean evaluateContentProviderNeeded)

    コンテンツ プロバイダの必要性を評価するかどうかをオプションで考慮できる pushFile(File,String) のバリエーション。

    パラメータ
    localFile File: プッシュするローカル ファイル

    deviceFilePath String: リモートの宛先の絶対ファイルパス

    evaluateContentProviderNeeded boolean: コンテンツ プロバイダが必要かどうかを確認するかどうか

    戻り値
    boolean ファイルが正常にプッシュされた場合は true。それ以外の場合は false

    例外
    DeviceNotAvailableException デバイスとの接続が失われ、復元できない場合。

    pushFile

    public abstract boolean pushFile (File localFile, 
                    String deviceFilePath)

    デバイスにファイルをプッシュします。デフォルトでは、コンテンツ プロバイダを使用します。

    パラメータ
    localFile File: プッシュするローカル ファイル

    deviceFilePath String: リモートの宛先の絶対ファイルパス

    戻り値
    boolean ファイルが正常にプッシュされた場合は true。それ以外の場合は false

    例外
    DeviceNotAvailableException デバイスとの接続が失われ、復元できない場合。

    pushString

    public abstract boolean pushString (String contents, 
                    String deviceFilePath)

    文字列から作成されたファイルをデバイスに push する

    パラメータ
    contents String: プッシュするファイルの内容

    deviceFilePath String: リモートの宛先の絶対ファイルパス

    戻り値
    boolean 文字列が正常に push された場合は true。それ以外の場合は false

    例外
    DeviceNotAvailableException デバイスとの接続が失われ、復元できない場合。

    再起動

    public abstract void reboot ()

    デバイスを再起動して adb モードにします。

    デバイスが利用可能になるまでブロックします。

    例外
    DeviceNotAvailableException 再起動後にデバイスが使用できない場合

    再起動

    public abstract void reboot (String reason)

    指定された reason を使用して、再起動後も保持される adb モードでデバイスを再起動します。

    デバイスが利用可能になるまでブロックします。

    前回の再起動の理由は、sys.boot.reason プロパティをクエリすることで取得できます。

    パラメータ
    reason String: この再起動の理由。理由が指定されていない場合は null

    例外
    DeviceNotAvailableException 再起動後にデバイスが使用できない場合

    再起動

    public String reboot (String command, 
                    String reason)

    指定された command を使用してデバイスを再起動します。

    デバイスが利用可能になるまでブロックします。

    前回の再起動の理由は、sys.boot.reason プロパティをクエリすることで取得できます。

    パラメータ
    command String: `adb` に渡されるコマンド。このコマンドは「そのまま」渡されるため、必要に応じて適切な引用符を付けるのは呼び出し側の責任です(特に、スペースで区切られた複数の部分が含まれている場合)。

    reason String: この再起動の理由。理由が指定されていない場合は null

    戻り値
    String

    例外
    DeviceNotAvailableException 再起動後にデバイスが使用できない場合

    rebootIntoBootloader

    public abstract void rebootIntoBootloader ()

    デバイスを再起動してブートローダー モードにします。

    デバイスがブートローダー モードになるまでブロックします。

    例外
    DeviceNotAvailableException デバイスとの接続が失われ、復元できない場合。

    rebootIntoFastbootd

    public abstract void rebootIntoFastbootd ()

    デバイスを再起動して fastbootd モードにします。

    デバイスが fastbootd モードになるまでブロックします。

    例外
    DeviceNotAvailableException デバイスとの接続が失われ、復元できない場合。

    rebootIntoRecovery

    public abstract void rebootIntoRecovery ()

    デバイスを再起動して adb リカバリモードにします。

    デバイスがリカバリに入るまでブロック

    例外
    DeviceNotAvailableException 再起動後にデバイスが使用できない場合

    rebootIntoSideload

    public abstract void rebootIntoSideload (boolean autoReboot)

    デバイスを adb サイドロード モードで再起動します(これはリカバリの特別なモードです)。

    デバイスがサイドロード モードになるまでブロック

    パラメータ
    autoReboot boolean: サイドロード後にデバイスを自動的に再起動するかどうか

    例外
    DeviceNotAvailableException 再起動後にデバイスがサイドローディング モードになっていない場合

    rebootIntoSideload

    public abstract void rebootIntoSideload ()

    デバイスを adb サイドロード モードで再起動します(これはリカバリの特別なモードです)。

    デバイスがサイドロード モードになるまでブロック

    例外
    DeviceNotAvailableException 再起動後にデバイスがサイドローディング モードになっていない場合

    rebootUntilOnline

    public abstract void rebootUntilOnline ()

    reboot() の代替。デバイスがオンラインになるまで(adb に表示されるまで)のみブロックします。

    例外
    DeviceNotAvailableException 再起動後にデバイスが使用できない場合

    rebootUntilOnline

    public abstract void rebootUntilOnline (String reason)

    reboot() の代替。デバイスがオンラインになるまで(adb に表示されるまで)のみブロックします。

    パラメータ
    reason String: この再起動の理由。理由が指定されていない場合は null

    例外
    DeviceNotAvailableException 再起動後にデバイスが使用できない場合

    関連項目:

    rebootUserspace

    public abstract void rebootUserspace ()

    デバイスのユーザー空間部分のみを再起動します。

    デバイスが利用可能になるまでブロックします。

    警告。ユーザースペースの再起動は現在開発中であり、自己責任で使用してください。

    例外
    DeviceNotAvailableException 再起動後にデバイスが使用できない場合

    rebootUserspaceUntilOnline

    public abstract void rebootUserspaceUntilOnline ()

    rebootUserspace() ()} の代替。デバイスがオンラインになるまで(adb に表示されるまで)のみブロックします。

    例外
    DeviceNotAvailableException 再起動後にデバイスが使用できない場合

    remountSystemReadOnly

    public abstract void remountSystemReadOnly ()

    デバイスのシステム パーティションを読み取り専用にします。デバイスを再起動する場合があります。

    例外
    com.android.tradefed.device.DeviceNotAvailableException
    DeviceNotAvailableException

    remountSystemWritable

    public abstract void remountSystemWritable ()

    デバイスのシステム パーティションを書き込み可能にします。デバイスを再起動する場合があります。

    例外
    com.android.tradefed.device.DeviceNotAvailableException
    DeviceNotAvailableException

    remountVendorReadOnly

    public abstract void remountVendorReadOnly ()

    デバイスのベンダー パーティションを読み取り専用にします。デバイスを再起動する場合があります。

    例外
    com.android.tradefed.device.DeviceNotAvailableException
    DeviceNotAvailableException

    remountVendorWritable

    public abstract void remountVendorWritable ()

    デバイスのベンダー パーティションを書き込み可能にします。デバイスを再起動する場合があります。

    例外
    com.android.tradefed.device.DeviceNotAvailableException
    DeviceNotAvailableException

    runInstrumentationTests

    public abstract boolean runInstrumentationTests (IRemoteAndroidTestRunner runner, 
                    Collection<ITestLifeCycleReceiver> listeners)

    インストルメンテーション テストを実行し、デバイスの復元を提供します。

    テスト実行が完了する前にデバイスとの接続が失われ、復元が成功した場合、すべてのリスナーに testRunFailed が通知され、「false」が返されます。テストコマンドは再実行されません。必要に応じて再試行するのは呼び出し側の責任です。

    テスト実行が完了する前にデバイスとの接続が失われ、復元に失敗すると、すべてのリスナーに testRunFailed が通知され、DeviceNotAvailableException がスローされます。

    パラメータ
    runner IRemoteAndroidTestRunner: テストを実行する IRemoteAndroidTestRunner

    listeners Collection: テスト結果リスナー

    戻り値
    boolean テストコマンドが完了した場合 trueデバイス通信例外が原因で完了できなかったが、復元に成功した場合は false

    例外
    DeviceNotAvailableException デバイスとの接続が失われ、復元できない場合(テストコマンドが完了せず、復元も失敗した場合など)。

    runInstrumentationTests

    public abstract boolean runInstrumentationTests (IRemoteAndroidTestRunner runner, 
                    ITestLifeCycleReceiver... listeners)

    1 つ以上のリスナーをパラメータとして渡して runInstrumentationTests(IRemoteAndroidTestRunner,Collection) を実行するための便利なメソッド。

    パラメータ
    runner IRemoteAndroidTestRunner: テストを実行する IRemoteAndroidTestRunner

    listeners ITestLifeCycleReceiver: テスト結果リスナー

    戻り値
    boolean テストコマンドが完了した場合 true完了に失敗したがリカバリーに成功した場合は false

    例外
    DeviceNotAvailableException デバイスとの接続が失われ、復元できない場合(テストコマンドが完了せず、復元も失敗した場合など)。

    runInstrumentationTestsAsUser

    public abstract boolean runInstrumentationTestsAsUser (IRemoteAndroidTestRunner runner, 
                    int userId, 
                    Collection<ITestLifeCycleReceiver> listeners)

    ITestDevice.runInstrumentationTests(IRemoteAndroidTestRunner,Collection) と同じですが、指定されたユーザーに対してテストを実行します。

    パラメータ
    runner IRemoteAndroidTestRunner

    userId int

    listeners Collection

    戻り値
    boolean

    例外
    DeviceNotAvailableException

    runInstrumentationTestsAsUser

    public abstract boolean runInstrumentationTestsAsUser (IRemoteAndroidTestRunner runner, 
                    int userId, 
                    ITestLifeCycleReceiver... listeners)

    ITestDevice.runInstrumentationTests(IRemoteAndroidTestRunner,ITestLifeCycleReceiver...) と同じですが、指定されたユーザーに対してテストを実行します。

    パラメータ
    runner IRemoteAndroidTestRunner

    userId int

    listeners ITestLifeCycleReceiver

    戻り値
    boolean

    例外
    DeviceNotAvailableException

    setDate

    public abstract void setDate (Date date)

    デバイスの日付を設定します。

    注: デバイスの日付を設定するにはルート権限が必要です

    パラメータ
    date Date: 特定の日付を指定します。null の場合はホストの日付を使用します。

    例外
    com.android.tradefed.device.DeviceNotAvailableException
    DeviceNotAvailableException

    setOptions

    public abstract void setOptions (TestDeviceOptions options)

    デバイスの TestDeviceOptions を設定する

    パラメータ
    options TestDeviceOptions

    setProperty

    public abstract boolean setProperty (String propKey, 
                    String propValue)

    デバイスに指定されたプロパティ値を設定します。adb root が true である必要があります。

    パラメータ
    propKey String: 設定対象のキー。

    propValue String: 設定するプロパティ値。

    戻り値
    boolean setprop コマンドが成功した場合は True を返し、それ以外の場合は False を返します。

    例外
    com.android.tradefed.device.DeviceNotAvailableException
    DeviceNotAvailableException

    setRecovery

    public abstract void setRecovery (IDeviceRecovery recovery)

    このデバイスで使用する IDeviceRecovery を設定します。デバイスが最初に割り当てられたときに設定する必要があります。

    パラメータ
    recovery IDeviceRecovery: IDeviceRecovery

    setRecoveryMode

    public abstract void setRecoveryMode (ITestDevice.RecoveryMode mode)

    デバイスで使用する現在のリカバリモードを設定します。

    デバイスの通信で問題が発生した場合に使用する復元方法を制御するために使用されます。このメソッドは、必要な場合(フレームワークがダウンしている場合など)にのみ使用することをおすすめします。

    パラメータ
    mode ITestDevice.RecoveryMode: 「オンラインになるまでのみ復元」モードをオンにするかどうか。

    setTrackingSerial

    public abstract void setTrackingSerial (String trackingSerial)

    デバイス管理の目的で、デバイスの参照に使用するシリアルを追跡します。

    パラメータ
    trackingSerial String

    setUseFastbootErase

    public abstract void setUseFastbootErase (boolean useFastbootErase)

    fastboot erase または fastboot format を使用してデバイスのパーティションをワイプするかどうかを設定します。

    パラメータ
    useFastbootErase boolean: fastboot erase を使用する場合は true、fastboot format を使用する場合は false

    startLogcat

    public abstract void startLogcat ()

    デバイスからの logcat 出力のキャプチャをバックグラウンドで開始します。

    logcat 出力がすでにキャプチャされている場合、効果はありません。データは後で getLogcat を介して取得できます。

    デバイスが使用されなくなったら、stopLogcat() を呼び出す必要があります。

    通常、TF 呼び出しコンテキスト内では、TF フレームワークが logcat を開始および停止するため、startLogcat()stopLogcat() を呼び出す必要はありません。

    startTradeInModeTesting

    public abstract boolean startTradeInModeTesting (int timeoutMs)

    下取りモードのテストを有効にします。デバイスがワイプされ、再起動します。

    パラメータ
    timeoutMs int

    戻り値
    boolean 成功した場合は true、それ以外の場合は false

    例外
    com.android.tradefed.device.DeviceNotAvailableException
    DeviceNotAvailableException

    stopEmulatorOutput

    public abstract void stopEmulatorOutput ()

    エミュレータ出力を閉じて削除します。

    stopLogcat

    public abstract void stopLogcat ()

    デバイスからの logcat 出力のキャプチャを停止し、現在保存されている logcat データを破棄します。

    logcat 出力がキャプチャされていない場合、効果はありません。

    stopTradeInModeTesting

    public abstract void stopTradeInModeTesting ()

    下取りモードのテストを停止します。デバイスが再起動します。

    例外
    com.android.tradefed.device.DeviceNotAvailableException
    DeviceNotAvailableException

    switchToAdbTcp

    public abstract String switchToAdbTcp ()

    デバイスを adb-over-tcp モードに切り替えます。

    戻り値
    String デバイスを切り替えられなかった場合は tcp シリアル番号または null

    例外
    com.android.tradefed.device.DeviceNotAvailableException
    DeviceNotAvailableException

    switchToAdbUsb

    public abstract boolean switchToAdbUsb ()

    デバイスを USB 経由の adb モードに切り替えます。

    戻り値
    boolean 切り替えが成功した場合は true、それ以外の場合は false

    例外
    com.android.tradefed.device.DeviceNotAvailableException
    DeviceNotAvailableException

    syncFiles

    public abstract boolean syncFiles (File localFileDir, 
                    String deviceFilePath)

    ローカル ファイル ディレクトリの内容をデバイスに増分同期します。

    ローカル ファイルのタイムスタンプとリモート ファイルのタイムスタンプを比較して、プッシュするファイルを決定します。「新しい」ファイルまたは存在しないファイルのみがデバイスにプッシュされます。したがって、デバイス上のファイルセットがすでに最新の状態であれば、オーバーヘッドは比較的小さくなります。

    隠しファイル(名前が「.」で始まるファイル)は無視されます。

    使用例: syncFiles("/tmp/files", "/sdcard") は、/sdcard/files ディレクトリが存在しない場合は作成し、/tmp/files のコンテンツを /sdcard/files に再帰的にプッシュします。

    パラメータ
    localFileDir File: 再帰的にプッシュするファイルを含むローカル ファイル ディレクトリ。

    deviceFilePath String: リモートの宛先絶対ファイルパスのルート。このファイルパス内のすべてのディレクトリが読み取り可能である必要があります。つまり、adb が root ではないときに /data/local/tmp にプッシュすると失敗します。

    戻り値
    boolean ファイルが正常に同期された場合は true。それ以外の場合は false

    例外
    DeviceNotAvailableException デバイスとの接続が失われ、復元できない場合。

    unlockDevice

    public abstract boolean unlockDevice ()

    デバイスが暗号化された状態の場合、デバイスのロックを解除します。

    このメソッドはフレームワークを再起動する可能性がありますが、postBootSetup() は呼び出しません。そのため、このメソッドが戻るときにデバイスのテスト準備が完全に整っていない可能性があります。

    戻り値
    boolean 成功した場合、またはデバイスが暗号化されていない場合は true

    例外
    DeviceNotAvailableException デバイスとの接続が失われ、復元できない場合。
    UnsupportedOperationException デバイスで暗号化がサポートされていない場合。

    unmountDebugfs

    public abstract void unmountDebugfs ()

    debugfs のマウントを解除します。

    例外
    com.android.tradefed.device.DeviceNotAvailableException
    DeviceNotAvailableException

    waitForBootComplete

    public abstract boolean waitForBootComplete (long timeOut)

    デバイスの起動完了フラグが設定されるまでブロックします。

    パラメータ
    timeOut long: フラグが設定されるのを待つ時間(ミリ秒単位)

    戻り値
    boolean タイムアウト内にデバイスのブート完了フラグが設定されている場合は true

    例外
    com.android.tradefed.device.DeviceNotAvailableException
    DeviceNotAvailableException

    waitForDeviceAvailable

    public abstract boolean waitForDeviceAvailable ()

    デバイスが応答し、テストに使用できるようになるまで待機します。デフォルトのタイムアウトを使用します。

    戻り値
    boolean デバイスが利用可能な場合は True、復元が無効で利用できない場合は False。

    例外
    DeviceNotAvailableException デバイスとの接続が失われ、復元できない場合。

    waitForDeviceAvailable

    public abstract boolean waitForDeviceAvailable (long waitTime)

    デバイスが応答し、テストに使用できるようになるまで待機します。

    パラメータ
    waitTime long: 待機する時間(ミリ秒単位)

    戻り値
    boolean デバイスが利用可能な場合は True、復元が無効で利用できない場合は False。

    例外
    DeviceNotAvailableException waitTime の期限が切れてもデバイスが応答しない場合。

    waitForDeviceAvailableInRecoverPath

    public abstract boolean waitForDeviceAvailableInRecoverPath (long waitTime)

    復元パスを考慮せずに、デバイスが応答可能で利用可能になるまで待機します。

    パラメータ
    waitTime long

    戻り値
    boolean デバイスが利用可能な場合は True、利用できない場合は False。

    例外
    DeviceNotAvailableException デバイスとの接続が失われ、復元できない場合。

    waitForDeviceBootloader

    public abstract void waitForDeviceBootloader ()

    デバイスが fastboot で認識されるまでブロックします。デフォルトのタイムアウトを使用します。

    例外
    DeviceNotAvailableException デバイスとの接続が失われ、復元できない場合。

    waitForDeviceInRecovery

    public abstract boolean waitForDeviceInRecovery (long waitTime)

    デバイスが「adb recovery」状態になるのをブロックします(これは IDeviceRecovery とは異なります)。

    パラメータ
    waitTime long: 待機する時間(ミリ秒単位)

    戻り値
    boolean true(デバイスがタイムアウト前にリカバリ モードで起動した場合)。それ以外の場合は false

    waitForDeviceInSideload

    public abstract boolean waitForDeviceInSideload (long waitTime)

    デバイスが「adb sideload」状態になるためのブロック

    パラメータ
    waitTime long: 待機する時間(ミリ秒単位)

    戻り値
    boolean true(デバイスが期限切れ前にサイドローディングで起動した場合)。それ以外の場合は false

    waitForDeviceNotAvailable

    public abstract boolean waitForDeviceNotAvailable (long waitTime)

    デバイスが利用できない(adb に表示されない)ようにブロックします

    パラメータ
    waitTime long: 待機する時間(ミリ秒単位)

    戻り値
    boolean デバイスが利用できなくなった場合は、タイムアウト前に true を返します。それ以外の場合は false

    waitForDeviceOnline

    public abstract void waitForDeviceOnline ()

    adb 経由でデバイスが認識されるまでブロックします。デフォルトのタイムアウトを使用します。

    完了時にデバイスがコマンドに応答しない場合があります。代わりに waitForDeviceAvailable() を使用してください。

    例外
    DeviceNotAvailableException デバイスとの接続が失われ、復元できない場合。

    waitForDeviceOnline

    public abstract void waitForDeviceOnline (long waitTime)

    デバイスが adb 経由で認識されるまでブロックします。

    完了時にデバイスがコマンドに応答しない場合があります。代わりに waitForDeviceAvailable() を使用してください。

    パラメータ
    waitTime long: 待機する時間(ミリ秒単位)

    例外
    DeviceNotAvailableException デバイスとの接続が失われ、復元できない場合。

    waitForDeviceShell

    public abstract boolean waitForDeviceShell (long waitTime)

    デバイスが基本的な adb shell コマンドに応答するまで待機します。

    パラメータ
    waitTime long: 待機する時間(ミリ秒単位)

    戻り値
    boolean waitTime が経過する前にデバイスが反応するようになった場合。true