Pabrik Konfigurasi
public class ConfigurationFactory
extends Object
implements IConfigurationFactory
java.lang.Objek | |
↳ | com.android.tradefed.config.ConfigurationFactory |
Pabrik untuk membuat IConfiguration
.
Ringkasan
Kelas bersarang | |
---|---|
class | ConfigurationFactory.ConfigLoader Implementasi IConfigDefLoader yang melacak konfigurasi yang disertakan dari satu konfigurasi root, dan melontarkan pengecualian pada penyertaan melingkar. |
class | ConfigurationFactory.ExceptionLoader
|
Konstruktor terlindungi | |
---|---|
ConfigurationFactory () |
Metode publik | |
---|---|
void | clearMapConfig () Dalam beberapa kasus tertentu, kita perlu membersihkan peta. |
IConfiguration | createConfigurationFromArgs (String[] arrayArgs, unconsumedArgs) createConfigurationFromArgs (String[] arrayArgs, unconsumedArgs) Buat |
IConfiguration | createConfigurationFromArgs (String[] arrayArgs, unconsumedArgs, IKeyStoreClient keyStoreClient) createConfigurationFromArgs (String[] arrayArgs, unconsumedArgs, IKeyStoreClient keyStoreClient) Buat |
IConfiguration | createConfigurationFromArgs (String[] arrayArgs) Metode praktis yang memanggil |
IGlobalConfiguration | createGlobalConfigurationFromArgs (String[] arrayArgs, remainingArgs) createGlobalConfigurationFromArgs (String[] arrayArgs, remainingArgs) Buat |
IConfiguration | createPartialConfigurationFromArgs (String[] arrayArgs, IKeyStoreClient keyStoreClient, allowedObjects, TradefedDelegator delegator) createPartialConfigurationFromArgs (String[] arrayArgs, IKeyStoreClient keyStoreClient, allowedObjects, TradefedDelegator delegator) Buat konfigurasi yang hanya berisi satu set objek yang dipilih. |
void | dumpConfig (String configName, PrintStream out) Membuang isi konfigurasi ke |
getConfigList (String subPath, boolean loadFromEnv) Variasi dari | |
getConfigList () Kembalikan daftar nama semua konfigurasi yang ditemukan di JAR di classpath. | |
static IConfigurationFactory | getInstance () Dapatkan instance |
void | loadAllConfigs (boolean discardExceptions) Memuat semua konfigurasi yang ditemukan di direktori classpath dan test case. |
void | loadAndPrintAllConfigs () Metode utilitas yang memeriksa apakah semua konfigurasi dapat dimuat, diuraikan, dan semua nilai opsi ditetapkan. |
void | printHelp (PrintStream out) Cetakan membantu output untuk pabrik ini. |
void | printHelpForConfig (String[] args, boolean importantOnly, PrintStream out) Mencetak output bantuan untuk IConfiguration akan dibuat dari XML, dan bantuan untuk IConfiguration tersebut akan dihasilkan. |
Metode yang dilindungi | |
---|---|
InputStream | getBundledConfigStream (String name) |
String | getConfigPrefix () Kembalikan awalan jalur file config xml di classpath Terkena sehingga pengujian unit dapat mengejek. |
BufferedInputStream | getConfigStream (String name) Memuat InputStream untuk nama konfigurasi yang diberikan |
ConfigurationDef | getConfigurationDef (String name, boolean isGlobal, templateMap) getConfigurationDef (String name, boolean isGlobal, templateMap) Ambil |
getMapConfig () Diekspos untuk pengujian. | |
boolean | isDirectConfiguration (String configName) |
String[] | reorderArgs (String[] args) Susun ulang args sehingga template:map args semuanya dipindahkan ke depan. |
IRemoteFileResolver.ResolvedFile | resolveRemoteFile (URI configURI, URI destDir) |
Konstruktor terlindungi
Pabrik Konfigurasi
protected ConfigurationFactory ()
Metode publik
clearMapConfig
public void clearMapConfig ()
Dalam beberapa kasus tertentu, kita perlu membersihkan peta.
createConfigurationFromArgs
public IConfiguration createConfigurationFromArgs (String[] arrayArgs,unconsumedArgs)
Buat IConfiguration
dari argumen baris perintah.
Parameter | |
---|---|
arrayArgs | String : argumen baris perintah |
unconsumedArgs | null , implementasi akan melontarkan ConfigurationException jika masih ada argumen yang belum diproses. |
Pengembalian | |
---|---|
IConfiguration | IConfiguration yang dimuat. Kolom Option objek delegasi telah diisi dengan nilai dalam args. |
Melempar | |
---|---|
ConfigurationException |
createConfigurationFromArgs
public IConfiguration createConfigurationFromArgs (String[] arrayArgs,unconsumedArgs, IKeyStoreClient keyStoreClient)
Buat IConfiguration
dari argumen baris perintah dengan key store.
Parameter | |
---|---|
arrayArgs | String : argumen baris perintah |
unconsumedArgs | null , implementasi akan melontarkan ConfigurationException jika masih ada argumen yang belum diproses. |
keyStoreClient | IKeyStoreClient : IKeyStoreClient yang digunakan untuk mendapatkan info sensitif di args. |
Pengembalian | |
---|---|
IConfiguration | IConfiguration yang dimuat. Kolom Option objek delegasi telah diisi dengan nilai dalam args. |
Melempar | |
---|---|
ConfigurationException |
createConfigurationFromArgs
public IConfiguration createConfigurationFromArgs (String[] arrayArgs)
Metode praktis yang memanggil ERROR(/#createConfigurationFromArgs(String[],List))
dengan argumen null
second. Dengan demikian, itu akan membuang ConfigurationException
jika masih ada argumen yang tidak dikonsumsi.
Parameter | |
---|---|
arrayArgs | String |
Pengembalian | |
---|---|
IConfiguration |
Melempar | |
---|---|
ConfigurationException |
buatGlobalConfigurationFromArgs
public IGlobalConfiguration createGlobalConfigurationFromArgs (String[] arrayArgs,remainingArgs)
Buat IGlobalConfiguration
dari argumen baris perintah.
Parameter | |
---|---|
arrayArgs | String : argumen baris perintah |
remainingArgs |
Pengembalian | |
---|---|
IGlobalConfiguration | IGlobalConfiguration yang dimuat. Kolom Option objek delegasi telah diisi dengan nilai dalam args. |
Melempar | |
---|---|
ConfigurationException |
createPartialConfigurationFromArgs
public IConfiguration createPartialConfigurationFromArgs (String[] arrayArgs, IKeyStoreClient keyStoreClient,allowedObjects, TradefedDelegator delegator)
Buat konfigurasi yang hanya berisi satu set objek yang dipilih.
Parameter | |
---|---|
arrayArgs | String : Argumen baris perintah |
keyStoreClient | IKeyStoreClient : IKeyStoreClient yang digunakan untuk mendapatkan info sensitif di args. |
allowedObjects | |
delegator | TradefedDelegator |
Pengembalian | |
---|---|
IConfiguration | IConfiguration yang dimuat. |
Melempar | |
---|---|
ConfigurationException |
dumpConfig
public void dumpConfig (String configName, PrintStream out)
Membuang isi konfigurasi ke ERROR(/PrintStream)
yang diberikan
Parameter | |
---|---|
configName | String : nama konfigurasi |
out | PrintStream : ERROR(/PrintStream) untuk membuang keluaran |
getConfigList
publicgetConfigList (String subPath, boolean loadFromEnv)
Variasi dari getConfigList()
yang dapat menentukan apakah kita juga ingin memuat konfigurasi dari lingkungan atau tidak.
Parameter | |
---|---|
subPath | String : nama sub-direktori untuk mencari konfigurasi. Jika null, akan memiliki perilaku yang sama dengan getConfigList() . |
loadFromEnv | boolean : Benar jika kita harus memuat konfigurasi dalam variabel lingkungan. |
Pengembalian | |
---|---|
getConfigList
publicgetConfigList ()
Kembalikan daftar nama semua konfigurasi yang ditemukan di JAR di classpath. Tidak mencoba memuat konfigurasi apa pun, jadi mungkin ada konfigurasi yang tidak berfungsi dalam daftar ini.
Pengembalian | |
---|---|
getInstance
public static IConfigurationFactory getInstance ()
Dapatkan instance IConfigurationFactory
tunggal.
Pengembalian | |
---|---|
IConfigurationFactory |
loadAllConfigs
public void loadAllConfigs (boolean discardExceptions)
Memuat semua konfigurasi yang ditemukan di direktori classpath dan test case.
Parameter | |
---|---|
discardExceptions | boolean : true jika ada ConfigurationException yang harus diabaikan. |
Melempar | |
---|---|
| 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 sehingga proyek yang bergantung dapat memvalidasi konfigurasinya. Seharusnya tidak diekspos di konsol.
Melempar | |
---|---|
ConfigurationException | jika satu atau lebih konfigurasi gagal dimuat |
printHelp
public void printHelp (PrintStream out)
Cetakan membantu output untuk pabrik ini.
Mencetak info bantuan umum, dan mencantumkan semua konfigurasi yang tersedia.Parameter | |
---|---|
out | PrintStream : ERROR(/PrintStream) untuk membuang keluaran |
printHelpForConfig
public void printHelpForConfig (String[] args, boolean importantOnly, PrintStream out)
Mencetak output bantuan untuk IConfiguration
yang ditentukan dalam argumen baris perintah,
IConfiguration
akan dibuat dari XML, dan bantuan untuk IConfiguration
tersebut akan dihasilkan. Perhatikan bahwa semua nilai 'args' lainnya akan diabaikan (yaitu teks bantuan akan menjelaskan nilai Option
s saat ini yang dimuat dari XML, dan tidak akan mencerminkan nilai opsi yang ditetapkan oleh baris perintah args. Jika 'args' tidak mereferensikan IConfiguration
yang dikenal, bantuan printHelp(PrintStream)
generik akan ditampilkan.Parameter | |
---|---|
args | String : argumen baris perintah |
importantOnly | boolean : jika true , cetak bantuan singkat yang hanya mencantumkan detail penting |
out | PrintStream : ERROR(/PrintStream) untuk membuang keluaran |
Metode yang dilindungi
getBundledConfigStream
protected InputStream getBundledConfigStream (String name)
Parameter | |
---|---|
name | String |
Pengembalian | |
---|---|
InputStream |
getConfigPrefix
protected String getConfigPrefix ()
Kembalikan awalan jalur file config xml di classpath
Terkena sehingga pengujian unit dapat mengejek.
Pengembalian | |
---|---|
String | Jalur String dengan trailing / |
getConfigStream
protected BufferedInputStream getConfigStream (String name)
Memuat InputStream untuk nama konfigurasi yang diberikan
Parameter | |
---|---|
name | String : nama konfigurasi yang akan dimuat |
Pengembalian | |
---|---|
BufferedInputStream | sebuah ERROR(/BufferedInputStream) untuk membaca konten konfigurasi |
Melempar | |
---|---|
ConfigurationException | jika konfigurasi tidak dapat ditemukan |
getConfigurationDef
protected ConfigurationDef getConfigurationDef (String name, boolean isGlobal,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 |
Pengembalian | |
---|---|
ConfigurationDef | ConfigurationDef |
Melempar | |
---|---|
ConfigurationException | jika terjadi kesalahan memuat konfigurasi |
getMapConfig
protectedgetMapConfig ()
Diekspos untuk pengujian. Kembalikan salinan Peta.
Pengembalian | |
---|---|
isDirectConfiguration
protected boolean isDirectConfiguration (String configName)
Parameter | |
---|---|
configName | String |
Pengembalian | |
---|---|
boolean |
menyusun ulangArgs
protected String[] reorderArgs (String[] args)
Susun ulang args sehingga template:map args semuanya dipindahkan ke depan.
Parameter | |
---|---|
args | String |
Pengembalian | |
---|---|
String[] |
resolRemoteFile
protected IRemoteFileResolver.ResolvedFile resolveRemoteFile (URI configURI, URI destDir)
Parameter | |
---|---|
configURI | URI |
destDir | URI |
Pengembalian | |
---|---|
IRemoteFileResolver.ResolvedFile |
Melempar | |
---|---|
BuildRetrievalError |
Konten dan contoh kode di halaman ini tunduk pada lisensi yang dijelaskan dalam Lisensi Konten. Java dan OpenJDK adalah merek dagang atau merek dagang terdaftar dari Oracle dan/atau afiliasinya.
Terakhir diperbarui pada 2023-07-19 UTC.