ConfigurationFactory
public
class
ConfigurationFactory
extends Object
implements
IConfigurationFactory
java.lang.Object | |
↳ | com.android.tradefed.config.ConfigurationFactory |
Nhà máy để tạo IConfiguration
.
Tóm tắt
Lớp lồng ghép | |
---|---|
class |
ConfigurationFactory.ConfigLoader
Triển khai IConfigDefLoader theo dõi các cấu hình được đưa vào từ một cấu hình gốc và gửi một ngoại lệ về các cấu hình bao gồm vòng tròn. |
class |
ConfigurationFactory.ExceptionLoader
|
Hàm khởi tạo được bảo vệ | |
---|---|
ConfigurationFactory()
|
Phương thức công khai | |
---|---|
void
|
clearMapConfig()
Trong một số trường hợp cụ thể, chúng ta cần xoá bản đồ. |
IConfiguration
|
createConfigurationFromArgs(String[] arrayArgs,
Tạo |
IConfiguration
|
createConfigurationFromArgs(String[] arrayArgs,
Tạo |
IConfiguration
|
createConfigurationFromArgs(String[] arrayArgs)
Một phương thức tiện lợi gọi |
IGlobalConfiguration
|
createGlobalConfigurationFromArgs(String[] arrayArgs,
Tạo |
IConfiguration
|
createPartialConfigurationFromArgs(String[] arrayArgs, IKeyStoreClient keyStoreClient,
Tạo một cấu hình chỉ chứa một tập hợp các đối tượng đã chọn. |
void
|
dumpConfig(String configName, PrintStream out)
Kết xuất nội dung của cấu hình vào |
|
getConfigList(String subPath, boolean loadFromEnv)
Biến thể của |
|
getConfigList()
Trả về danh sách tên của tất cả các cấu hình tìm thấy trong tệp JAR trên đường dẫn lớp. |
static
IConfigurationFactory
|
getInstance()
Lấy thực thể singleton |
void
|
loadAllConfigs(boolean discardExceptions)
Tải tất cả cấu hình có trong đường dẫn lớp và thư mục trường hợp kiểm thử. |
void
|
loadAndPrintAllConfigs()
Phương thức tiện ích kiểm tra để đảm bảo rằng tất cả cấu hình đều có thể được tải, phân tích cú pháp và đặt tất cả giá trị tuỳ chọn. |
void
|
printHelp(PrintStream out)
In kết quả trợ giúp cho nhà máy này. |
void
|
printHelpForConfig(String[] args, boolean importantOnly, PrintStream out)
In kết quả trợ giúp cho
Nếu "args" tham chiếu đến một cấu hình đã biết, thì đối tượng |
Phương thức được bảo vệ | |
---|---|
InputStream
|
getBundledConfigStream(String name)
|
String
|
getConfigPrefix()
Trả về tiền tố đường dẫn của các tệp xml cấu hình trên classpath Được hiển thị để các kiểm thử đơn vị có thể mô phỏng. |
BufferedInputStream
|
getConfigStream(String name)
Tải InputStream cho tên cấu hình đã cho |
ConfigurationDef
|
getConfigurationDef(String name, boolean isGlobal,
Truy xuất |
|
getMapConfig()
Được hiển thị để kiểm thử. |
boolean
|
isDirectConfiguration(String configName)
|
String[]
|
reorderArgs(String[] args)
Sắp xếp lại các đối số để tất cả đối số template:map đều được chuyển ra phía trước. |
IRemoteFileResolver.ResolvedFile
|
resolveRemoteFile(URI configURI, URI destDir)
|
Hàm khởi tạo được bảo vệ
ConfigurationFactory
protected ConfigurationFactory ()
Phương thức công khai
clearMapConfig
public void clearMapConfig ()
Trong một số trường hợp cụ thể, chúng ta cần xoá bản đồ.
createConfigurationFromArgs
public IConfiguration createConfigurationFromArgs (String[] arrayArgs,unconsumedArgs)
Tạo IConfiguration
từ các đối số dòng lệnh.
Định dạng dự kiến là "CONFIG [options]", trong đó CONFIG là tên cấu hình tích hợp sẵn hoặc đường dẫn tệp đến tệp cấu hình xml.
Tham số | |
---|---|
arrayArgs |
String : đối số dòng lệnh |
unconsumedArgs |
: Danh sách sẽ được điền sẵn các đối số mà Đối tượng liên kết với cấu hình đã chỉ định không sử dụng. Nếu giá trị này là null , thì quá trình triển khai sẽ gửi ConfigurationException nếu còn bất kỳ đối số nào chưa được xử lý. |
Giá trị trả về | |
---|---|
IConfiguration |
IConfiguration đã tải. Các trường Option của đối tượng uỷ quyền đã được điền sẵn các giá trị trong args. |
Gửi | |
---|---|
ConfigurationException |
createConfigurationFromArgs
public IConfiguration createConfigurationFromArgs (String[] arrayArgs,unconsumedArgs, IKeyStoreClient keyStoreClient)
Tạo IConfiguration
từ các đối số dòng lệnh bằng kho khoá.
Định dạng dự kiến là "CONFIG [options]", trong đó CONFIG là tên cấu hình tích hợp sẵn hoặc đường dẫn tệp đến tệp cấu hình xml.
Tham số | |
---|---|
arrayArgs |
String : đối số dòng lệnh |
unconsumedArgs |
: Danh sách sẽ được điền sẵn các đối số mà Đối tượng liên kết với cấu hình đã chỉ định không sử dụng. Nếu giá trị này là null , thì quá trình triển khai sẽ gửi ConfigurationException nếu còn bất kỳ đối số nào chưa được xử lý. |
keyStoreClient |
IKeyStoreClient : IKeyStoreClient dùng để lấy thông tin nhạy cảm trong args. |
Giá trị trả về | |
---|---|
IConfiguration |
IConfiguration đã tải. Các trường Option của đối tượng uỷ quyền đã được điền sẵn các giá trị trong args. |
Gửi | |
---|---|
ConfigurationException |
createConfigurationFromArgs
public IConfiguration createConfigurationFromArgs (String[] arrayArgs)
Một phương thức tiện lợi gọi ERROR(/#createConfigurationFromArgs(String[],List))
bằng đối số thứ hai null
. Do đó, phương thức này sẽ gửi ConfigurationException
nếu còn bất kỳ đối số nào chưa được sử dụng.
Tham số | |
---|---|
arrayArgs |
String |
Giá trị trả về | |
---|---|
IConfiguration |
Gửi | |
---|---|
ConfigurationException |
createGlobalConfigurationFromArgs
public IGlobalConfiguration createGlobalConfigurationFromArgs (String[] arrayArgs,remainingArgs)
Tạo IGlobalConfiguration
từ các đối số dòng lệnh.
Định dạng dự kiến là "CONFIG [options]", trong đó CONFIG là tên cấu hình tích hợp sẵn hoặc đường dẫn tệp đến tệp cấu hình xml.
Tham số | |
---|---|
arrayArgs |
String : đối số dòng lệnh |
remainingArgs |
: danh sách sẽ được điền sẵn các đối số không được xử lý dưới dạng đối số toàn cục |
Giá trị trả về | |
---|---|
IGlobalConfiguration |
IGlobalConfiguration đã tải. Các trường Option của đối tượng uỷ quyền đã được điền sẵn các giá trị trong args. |
Gửi | |
---|---|
ConfigurationException |
createPartialConfigurationFromArgs
public IConfiguration createPartialConfigurationFromArgs (String[] arrayArgs, IKeyStoreClient keyStoreClient,allowedObjects, TradefedDelegator delegator)
Tạo một cấu hình chỉ chứa một tập hợp các đối tượng đã chọn.
Tham số | |
---|---|
arrayArgs |
String : Đối số dòng lệnh |
keyStoreClient |
IKeyStoreClient : IKeyStoreClient dùng để lấy thông tin nhạy cảm trong các đối số. |
allowedObjects |
: Tập hợp các đối tượng được phép tạo |
delegator |
TradefedDelegator |
Giá trị trả về | |
---|---|
IConfiguration |
IConfiguration đã tải. |
Gửi | |
---|---|
ConfigurationException |
dumpConfig
public void dumpConfig (String configName, PrintStream out)
Kết xuất nội dung của cấu hình vào ERROR(/PrintStream)
đã cho
Tham số | |
---|---|
configName |
String : tên cấu hình |
out |
PrintStream : ERROR(/PrintStream) để kết xuất đầu ra |
getConfigList
publicgetConfigList (String subPath, boolean loadFromEnv)
Biến thể của getConfigList()
có thể chỉ định xem chúng ta có muốn tải cấu hình từ môi trường hay không.
Tham số | |
---|---|
subPath |
String : tên của các thư mục con cần tìm cấu hình. Nếu rỗng, sẽ có cùng hành vi như getConfigList() . |
loadFromEnv |
boolean : Đúng nếu chúng ta nên tải cấu hình trong biến môi trường. |
Giá trị trả về | |
---|---|
|
getConfigList
publicgetConfigList ()
Trả về danh sách tên của tất cả các cấu hình tìm thấy trong tệp JAR trên đường dẫn lớp. Không cố gắng tải bất kỳ cấu hình nào, vì vậy, có thể có cấu hình không hoạt động trong danh sách này.
Giá trị trả về | |
---|---|
|
getInstance
public static IConfigurationFactory getInstance ()
Lấy thực thể singleton IConfigurationFactory
.
Giá trị trả về | |
---|---|
IConfigurationFactory |
loadAllConfigs
public void loadAllConfigs (boolean discardExceptions)
Tải tất cả cấu hình có trong đường dẫn lớp và thư mục trường hợp kiểm thử.
Tham số | |
---|---|
discardExceptions |
boolean : true nếu bạn muốn bỏ qua mọi ConfigurationException. |
Gửi | |
---|---|
|
com.android.tradefed.config.ConfigurationException |
ConfigurationException |
loadAndPrintAllConfigs
public void loadAndPrintAllConfigs ()
Phương thức tiện ích kiểm tra để đảm bảo rằng tất cả cấu hình đều có thể được tải, phân tích cú pháp và đặt tất cả giá trị tuỳ chọn. Chỉ hiển thị để dự án phụ thuộc có thể xác thực cấu hình của chúng. Không được hiển thị trong bảng điều khiển.
Gửi | |
---|---|
ConfigurationException |
nếu một hoặc nhiều cấu hình không tải được |
printHelp
public void printHelp (PrintStream out)
In kết quả trợ giúp cho nhà máy này.
In thông tin trợ giúp chung và liệt kê tất cả cấu hình có sẵn.
Tham số | |
---|---|
out |
PrintStream : ERROR(/PrintStream) để kết xuất đầu ra |
printHelpForConfig
public void printHelpForConfig (String[] args, boolean importantOnly, PrintStream out)
In kết quả trợ giúp cho IConfiguration
được chỉ định trong đối số dòng lệnh,
Nếu "args" tham chiếu đến một cấu hình đã biết, thì đối tượng IConfiguration
sẽ được tạo từ XML và nội dung trợ giúp cho IConfiguration
đó sẽ được xuất ra. Xin lưu ý rằng tất cả các giá trị "args" khác sẽ bị bỏ qua (tức là văn bản trợ giúp sẽ mô tả các giá trị hiện tại của Option
được tải từ XML và sẽ không phản ánh các giá trị của tuỳ chọn do đối số dòng lệnh đặt).
Nếu "args" không tham chiếu đến một IConfiguration
đã biết, thì thông tin trợ giúp printHelp(PrintStream)
chung sẽ xuất hiện.
Tham số | |
---|---|
args |
String : đối số dòng lệnh |
importantOnly |
boolean : nếu true , hãy in một phần trợ giúp rút gọn chỉ liệt kê các chi tiết quan trọng |
out |
PrintStream : ERROR(/PrintStream) để kết xuất đầu ra |
Phương thức được bảo vệ
getBundledConfigStream
protected InputStream getBundledConfigStream (String name)
Tham số | |
---|---|
name |
String |
Giá trị trả về | |
---|---|
InputStream |
getConfigPrefix
protected String getConfigPrefix ()
Trả về tiền tố đường dẫn của các tệp xml cấu hình trên classpath
Được hiển thị để các kiểm thử đơn vị có thể mô phỏng.
Giá trị trả về | |
---|---|
String |
Đường dẫn String có dấu gạch chéo ở cuối |
getConfigStream
protected BufferedInputStream getConfigStream (String name)
Tải InputStream cho tên cấu hình đã cho
Tham số | |
---|---|
name |
String : tên cấu hình cần tải |
Giá trị trả về | |
---|---|
BufferedInputStream |
ERROR(/BufferedInputStream) để đọc nội dung cấu hình |
Gửi | |
---|---|
ConfigurationException |
nếu không tìm thấy cấu hình |
getConfigurationDef
protected ConfigurationDef getConfigurationDef (String name, boolean isGlobal,templateMap)
Truy xuất ConfigurationDef
cho tên đã cho
Tham số | |
---|---|
name |
String : tên của cấu hình tích hợp sẵn để tải hoặc đường dẫn tệp đến tệp cấu hình cần tải |
isGlobal |
boolean |
templateMap |
|
Giá trị trả về | |
---|---|
ConfigurationDef |
ConfigurationDef |
Gửi | |
---|---|
ConfigurationException |
nếu xảy ra lỗi khi tải cấu hình |
getMapConfig
protectedgetMapConfig ()
Được hiển thị để kiểm thử. Trả về bản sao của Bản đồ.
Giá trị trả về | |
---|---|
|
isDirectConfiguration
protected boolean isDirectConfiguration (String configName)
Tham số | |
---|---|
configName |
String |
Giá trị trả về | |
---|---|
boolean |
reorderArgs
protected String[] reorderArgs (String[] args)
Sắp xếp lại các đối số để tất cả đối số template:map đều được chuyển ra phía trước.
Tham số | |
---|---|
args |
String |
Giá trị trả về | |
---|---|
String[] |
resolveRemoteFile
protected IRemoteFileResolver.ResolvedFile resolveRemoteFile (URI configURI, URI destDir)
Tham số | |
---|---|
configURI |
URI |
destDir |
URI |
Giá trị trả về | |
---|---|
IRemoteFileResolver.ResolvedFile |
Gửi | |
---|---|
BuildRetrievalError |