IConfigurationFactory

public interface IConfigurationFactory

com.android.tradefed.config.IConfigurationFactory


Factory untuk membuat IConfiguration

Ringkasan

Metode publik

abstract IConfiguration createConfigurationFromArgs(String[] args, List<String> unconsumedArgs, IKeyStoreClient keyStoreClient)

Buat IConfiguration dari argumen command line dengan key store.

abstract IConfiguration createConfigurationFromArgs(String[] args, List<String> unconsumedArgs)

Buat IConfiguration dari argumen command line.

abstract IConfiguration createConfigurationFromArgs(String[] args)

Metode praktis yang memanggil createConfigurationFromArgs(String[],List) dengan argumen kedua null.

abstract IGlobalConfiguration createGlobalConfigurationFromArgs(String[] args, List<String> nonGlobalArgs)

Buat IGlobalConfiguration dari argumen command line.

abstract IConfiguration createPartialConfigurationFromArgs(String[] arrayArgs, IKeyStoreClient keyStoreClient, Set<String> allowedObjects, TradefedDelegator delegator)

Buat konfigurasi yang hanya berisi sekumpulan objek yang dipilih.

abstract void dumpConfig(String configName, PrintStream out)

Mengekspor konten konfigurasi ke PrintStream yang ditentukan

abstract List<String> getConfigList()

Menampilkan daftar nama semua konfigurasi yang ditemukan di JAR pada classpath.

abstract List<String> getConfigList(String subPath, boolean loadFromEnv)

Variasi getConfigList() yang dapat menentukan apakah kita juga ingin memuat konfigurasi dari lingkungan atau tidak.

abstract void printHelp(PrintStream out)

Mencetak output bantuan untuk factory ini.

abstract void printHelpForConfig(String[] args, boolean importantOnly, PrintStream out)

Mencetak output bantuan untuk IConfiguration yang ditentukan dalam argumen command line,

Jika 'args' merujuk ke konfigurasi yang diketahui, objek IConfiguration akan dibuat dari XML, dan bantuan untuk IConfiguration tersebut akan ditampilkan.

Metode publik

createConfigurationFromArgs

public abstract IConfiguration createConfigurationFromArgs (String[] args, 
                List<String> unconsumedArgs, 
                IKeyStoreClient keyStoreClient)

Buat IConfiguration dari argumen command line dengan key store.

Format yang diharapkan adalah "CONFIG [options]", dengan CONFIG adalah nama konfigurasi bawaan atau jalur file ke file xml konfigurasi.

Parameter
args String: argumen command line

unconsumedArgs List: Daftar yang akan diisi dengan argumen yang tidak digunakan oleh Objek yang terkait dengan konfigurasi yang ditentukan. Jika adalah null, implementasi akan memunculkan ConfigurationException jika ada argumen yang belum diproses.

keyStoreClient IKeyStoreClient: IKeyStoreClient yang digunakan untuk mendapatkan info sensitif di args.

Hasil
IConfiguration IConfiguration yang dimuat. Kolom objek delegasi Option telah diisi dengan nilai dalam args.

Menampilkan
ConfigurationException jika konfigurasi tidak dapat dimuat

createConfigurationFromArgs

public abstract IConfiguration createConfigurationFromArgs (String[] args, 
                List<String> unconsumedArgs)

Buat IConfiguration dari argumen command line.

Format yang diharapkan adalah "CONFIG [options]", dengan CONFIG adalah nama konfigurasi bawaan atau jalur file ke file xml konfigurasi.

Parameter
args String: argumen command line

unconsumedArgs List: Daftar yang akan diisi dengan argumen yang tidak digunakan oleh Objek yang terkait dengan konfigurasi yang ditentukan. Jika adalah null, implementasi akan memunculkan ConfigurationException jika ada argumen yang belum diproses.

Hasil
IConfiguration IConfiguration yang dimuat. Kolom objek delegasi Option telah diisi dengan nilai dalam args.

Menampilkan
ConfigurationException jika konfigurasi tidak dapat dimuat

createConfigurationFromArgs

public abstract IConfiguration createConfigurationFromArgs (String[] args)

Metode praktis yang memanggil createConfigurationFromArgs(String[],List) dengan argumen kedua null. Oleh karena itu, fungsi ini akan menampilkan ConfigurationException jika ada argumen yang belum digunakan.

Parameter
args String

Hasil
IConfiguration

Menampilkan
ConfigurationException

createGlobalConfigurationFromArgs

public abstract IGlobalConfiguration createGlobalConfigurationFromArgs (String[] args, 
                List<String> nonGlobalArgs)

Buat IGlobalConfiguration dari argumen command line.

Format yang diharapkan adalah "CONFIG [options]", dengan CONFIG adalah nama konfigurasi bawaan atau jalur file ke file xml konfigurasi.

Parameter
args String: argumen command line

nonGlobalArgs List: daftar yang akan diisi dengan argumen yang tidak diproses sebagai argumen global

Hasil
IGlobalConfiguration IGlobalConfiguration yang dimuat. Kolom objek delegasi Option telah diisi dengan nilai dalam args.

Menampilkan
ConfigurationException jika konfigurasi tidak dapat dimuat

createPartialConfigurationFromArgs

public abstract IConfiguration createPartialConfigurationFromArgs (String[] arrayArgs, 
                IKeyStoreClient keyStoreClient, 
                Set<String> allowedObjects, 
                TradefedDelegator delegator)

Buat konfigurasi yang hanya berisi sekumpulan objek yang dipilih.

Parameter
arrayArgs String: Argumen command line

keyStoreClient IKeyStoreClient: IKeyStoreClient yang digunakan untuk mendapatkan info sensitif di args.

allowedObjects Set: Kumpulan objek yang diizinkan untuk dibuat

delegator TradefedDelegator

Hasil
IConfiguration IConfiguration yang dimuat.

Menampilkan
ConfigurationException jika konfigurasi tidak dapat dimuat

dumpConfig

public abstract void dumpConfig (String configName, 
                PrintStream out)

Mengekspor konten konfigurasi ke PrintStream yang ditentukan

Parameter
configName String: nama konfigurasi

out PrintStream: PrintStream untuk mengeluarkan output

getConfigList

public abstract List<String> getConfigList ()

Menampilkan daftar nama semua konfigurasi yang ditemukan di JAR pada classpath. Tidak mencoba memuat konfigurasi apa pun, sehingga konfigurasi yang tidak berfungsi dapat berada dalam daftar ini.

Hasil
List<String>

getConfigList

public abstract List<String> getConfigList (String subPath, 
                boolean loadFromEnv)

Variasi getConfigList() yang dapat menentukan apakah kita juga ingin memuat konfigurasi dari lingkungan atau tidak.

Parameter
subPath String: nama subdirektori yang akan dicari konfigurasinya. Jika null, akan memiliki perilaku yang sama dengan getConfigList().

loadFromEnv boolean: Benar (True) jika kita harus memuat konfigurasi dalam variabel lingkungan.

Hasil
List<String>

printHelp

public abstract void printHelp (PrintStream out)

Mencetak output bantuan untuk factory ini.

Mencetak info bantuan umum, dan mencantumkan semua konfigurasi yang tersedia.

Parameter
out PrintStream: PrintStream untuk mengeluarkan output

printHelpForConfig

public abstract void printHelpForConfig (String[] args, 
                boolean importantOnly, 
                PrintStream out)

Mencetak output bantuan untuk IConfiguration yang ditentukan dalam argumen command line,

Jika 'args' merujuk ke konfigurasi yang diketahui, objek IConfiguration akan dibuat dari XML, dan bantuan untuk IConfiguration tersebut akan ditampilkan. Perhatikan bahwa semua nilai 'args' lainnya akan diabaikan (yaitu teks bantuan akan menjelaskan nilai Options saat ini yang dimuat dari XML, dan tidak akan mencerminkan nilai opsi yang ditetapkan oleh argumen command line.

Jika 'args' tidak mereferensikan IConfiguration yang diketahui, bantuan printHelp(PrintStream) generik akan ditampilkan.

Parameter
args String: argumen command line

importantOnly boolean: jika true, cetak daftar bantuan singkat yang hanya berisi detail penting

out PrintStream: PrintStream untuk mengeluarkan output