ConfigurationFactory

public class ConfigurationFactory
extends Object implements IConfigurationFactory

java.lang.Object
   ↳ com.android.tradefed.config.ConfigurationFactory

Factory untuk membuat IConfiguration.

Ringkasan

Class bertingkat

class ConfigurationFactory.ConfigLoader

Implementasi IConfigDefLoader yang melacak konfigurasi yang disertakan dari satu konfigurasi root, dan menampilkan pengecualian pada penyertaan melingkar. 

class ConfigurationFactory.ExceptionLoader

 

Konstruktor yang dilindungi

ConfigurationFactory()

Metode publik

void clearMapConfig()

Dalam kasus tertentu, kita perlu menghapus peta.

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

Buat IConfiguration dari argumen command line dengan key store.

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

Buat IConfiguration dari argumen command line.

IConfiguration createConfigurationFromArgs(String[] arrayArgs)

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

IGlobalConfiguration createGlobalConfigurationFromArgs(String[] arrayArgs, List<String> remainingArgs)

Buat IGlobalConfiguration dari argumen command line.

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

Buat konfigurasi yang hanya berisi sekumpulan objek yang dipilih.

void dumpConfig(String configName, PrintStream out)

Mengekspor konten konfigurasi ke PrintStream yang ditentukan

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

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

List<String> getConfigList()

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

static IConfigurationFactory getInstance()

Dapatkan instance IConfigurationFactory singleton.

void loadAllConfigs(boolean discardExceptions)

Memuat semua konfigurasi yang ditemukan di direktori classpath dan kasus pengujian.

void loadAndPrintAllConfigs()

Metode utilitas yang memeriksa apakah semua konfigurasi dapat dimuat, diuraikan, dan semua nilai opsi ditetapkan.

void printHelp(PrintStream out)

Mencetak output bantuan untuk factory ini.

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 yang dilindungi

InputStream getBundledConfigStream(String name)
String getConfigPrefix()

Mengembalikan awalan jalur file xml config di classpath

Diekspos sehingga pengujian unit dapat melakukan mocking.

BufferedInputStream getConfigStream(String name)

Memuat InputStream untuk nama konfigurasi tertentu

ConfigurationDef getConfigurationDef(String name, boolean isGlobal, Map<String, String> templateMap)

Ambil ConfigurationDef untuk nama yang diberikan

Map<ConfigurationFactory.ConfigId, ConfigurationDef> getMapConfig()

Diekspos untuk pengujian.

boolean isDirectConfiguration(String configName)
String[] reorderArgs(String[] args)

Susun ulang argumen sehingga argumen template:map dipindahkan ke depan.

IRemoteFileResolver.ResolvedFile resolveRemoteFile(URI configURI, URI destDir)

Konstruktor yang dilindungi

ConfigurationFactory

protected ConfigurationFactory ()

Metode publik

clearMapConfig

public void clearMapConfig ()

Dalam kasus tertentu, kita perlu menghapus peta.

createConfigurationFromArgs

public IConfiguration createConfigurationFromArgs (String[] arrayArgs, 
                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
arrayArgs 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

createConfigurationFromArgs

public IConfiguration createConfigurationFromArgs (String[] arrayArgs, 
                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
arrayArgs 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

createConfigurationFromArgs

public IConfiguration createConfigurationFromArgs (String[] arrayArgs)

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
arrayArgs String

Hasil
IConfiguration

Menampilkan
ConfigurationException

createGlobalConfigurationFromArgs

public IGlobalConfiguration createGlobalConfigurationFromArgs (String[] arrayArgs, 
                List<String> remainingArgs)

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
arrayArgs String: argumen command line
remainingArgs 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

createPartialConfigurationFromArgs

public 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

dumpConfig

public 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 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>

getConfigList

public 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>

getInstance

public static IConfigurationFactory getInstance ()

Dapatkan instance IConfigurationFactory singleton.

Hasil
IConfigurationFactory

loadAllConfigs

public void loadAllConfigs (boolean discardExceptions)

Memuat semua konfigurasi yang ditemukan di direktori classpath dan kasus pengujian.

Parameter
discardExceptions boolean: benar (true) jika ada ConfigurationException yang harus diabaikan.
Menampilkan
com.android.tradefed.config.ConfigurationException
ConfigurationException

loadAndPrintAllConfigs

public void loadAndPrintAllConfigs ()

Metode utilitas yang memeriksa apakah semua konfigurasi dapat dimuat, diuraikan, dan semua nilai opsi ditetapkan. Hanya diekspos agar project yang bergantung dapat memvalidasi konfigurasinya. Tidak boleh diekspos di konsol.

Menampilkan
ConfigurationException jika satu atau beberapa konfigurasi gagal dimuat

printHelp

public 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 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

Metode yang dilindungi

getBundledConfigStream

protected InputStream getBundledConfigStream (String name)

Parameter
name String

Hasil
InputStream

getConfigPrefix

protected String getConfigPrefix ()

Mengembalikan awalan jalur file xml config di classpath

Diekspos sehingga pengujian unit dapat melakukan mocking.

Hasil
String Jalur String dengan / di akhir

getConfigStream

protected BufferedInputStream getConfigStream (String name)

Memuat InputStream untuk nama konfigurasi tertentu

Parameter
name String: nama konfigurasi yang akan dimuat
Hasil
BufferedInputStream BufferedInputStream untuk membaca konten konfigurasi
Menampilkan
ConfigurationException jika konfigurasi tidak dapat ditemukan

getConfigurationDef

protected ConfigurationDef getConfigurationDef (String name, 
                boolean isGlobal, 
                Map<String, String> templateMap)

Ambil ConfigurationDef untuk nama yang diberikan

Parameter
name String: nama konfigurasi bawaan yang akan dimuat atau jalur file ke file konfigurasi yang akan dimuat
isGlobal boolean

templateMap Map

Hasil
ConfigurationDef ConfigurationDef
Menampilkan
ConfigurationException jika terjadi error saat memuat konfigurasi

getMapConfig

protected Map<ConfigurationFactory.ConfigId, ConfigurationDef> getMapConfig ()

Diekspos untuk pengujian. Menampilkan salinan Peta.

Hasil
Map<ConfigurationFactory.ConfigId, ConfigurationDef>

isDirectConfiguration

protected boolean isDirectConfiguration (String configName)

Parameter
configName String

Hasil
boolean

reorderArgs

protected String[] reorderArgs (String[] args)

Susun ulang argumen sehingga argumen template:map dipindahkan ke depan.

Parameter
args String

Hasil
String[]

resolveRemoteFile

protected IRemoteFileResolver.ResolvedFile resolveRemoteFile (URI configURI, 
                URI destDir)

Parameter
configURI URI

destDir URI

Hasil
IRemoteFileResolver.ResolvedFile

Menampilkan
BuildRetrievalError