ConfigurationFactory

public class ConfigurationFactory
extends Object implements IConfigurationFactory

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

Các lớp con trực tiếp đã biết GCSConfigurationFactory , RetryConfigurationFactory , SandboxConfigurationFactory GCSConfigurationFactory ConfigurationFactory tải các cấu hình từ Google Cloud Storage. RetryConfigurationFactory Nhà máy xử lý việc thử lại một lệnh. SandboxConfigurationFactory Nhà máy cấu hình đặc biệt để xử lý việc tạo cấu hình cho mục đích Hộp cát.

---

Nhà máy để tạo IConfiguration .

Bản tóm tắt

Các lớp lồng nhau
class	ConfigurationFactory.ConfigLoader Triển khai IConfigDefLoader để theo dõi các cấu hình được bao gồm từ một cấu hình gốc và ném một ngoại lệ trên vòng bao gồm.
class	ConfigurationFactory.ExceptionLoader

Các trình xây dựng được bảo vệ
ConfigurationFactory ()

Phương pháp công khai
void	clearMapConfig () Trong một số trường hợp cụ thể, chúng ta cần xóa bản đồ.
IConfiguration	createConfigurationFromArgs (String[] arrayArgs, unconsumedArgs) createConfigurationFromArgs (String[] arrayArgs, unconsumedArgs) Tạo cấu hình IConfiguration từ các đối số dòng lệnh.
IConfiguration	createConfigurationFromArgs (String[] arrayArgs, unconsumedArgs, IKeyStoreClient keyStoreClient) createConfigurationFromArgs (String[] arrayArgs, unconsumedArgs, IKeyStoreClient keyStoreClient) Tạo cấu hình IConfiguration từ các đối số dòng lệnh bằng kho khóa.
IConfiguration	createConfigurationFromArgs (String[] arrayArgs) Một phương thức tiện lợi gọi ERROR(/#createConfigurationFromArgs(String[],List)) với đối số thứ hai null .
IGlobalConfiguration	createGlobalConfigurationFromArgs (String[] arrayArgs, remainingArgs) createGlobalConfigurationFromArgs (String[] arrayArgs, remainingArgs) Tạo một IGlobalConfiguration từ các đối số dòng lệnh.
IConfiguration	createPartialConfigurationFromArgs (String[] arrayArgs, IKeyStoreClient keyStoreClient, allowedObjects, TradefedDelegator delegator) createPartialConfigurationFromArgs (String[] arrayArgs, IKeyStoreClient keyStoreClient, allowedObjects, TradefedDelegator delegator) Tạo 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 ERROR(/PrintStream)
	getConfigList (String subPath, boolean loadFromEnv) Biến thể của getConfigList() trong đó 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.
	getConfigList () Trả lại danh sách tên của tất cả các cấu hình được tìm thấy trong JAR trên đường dẫn classpath.
static IConfigurationFactory	getInstance () Nhận cá thể singleton IConfigurationFactory .
void	loadAllConfigs (boolean discardExceptions) Tải tất cả các cấu hình được tìm thấy trong thư mục classpath và test case.
void	loadAndPrintAllConfigs () Phương thức tiện ích kiểm tra xem tất cả các cấu hình có thể được tải, phân tích cú pháp và tất cả các giá trị tùy chọn được đặt hay không.
void	printHelp (PrintStream out) Bản in giúp đầu ra cho nhà máy này.
void	printHelpForConfig (String[] args, boolean importantOnly, PrintStream out) In đầu ra trợ giúp cho cấu hình IConfiguration được chỉ định trong các đối số dòng lệnh, Nếu 'args' đề cập đến một cấu hình đã biết, một đối tượng IConfiguration sẽ được tạo từ XML và trợ giúp cho IConfiguration sẽ được xuất ra.

Các phương pháp được bảo vệ
InputStream	getBundledConfigStream (String name)
String	getConfigPrefix () Trả lại tiền tố đường dẫn của các tệp cấu hình xml trên classpath Tiếp xúc để các bài kiểm tra đơn vị có thể giả lập.
BufferedInputStream	getConfigStream (String name) Tải một InputStream cho tên cấu hình đã cho
ConfigurationDef	getConfigurationDef (String name, boolean isGlobal, templateMap) getConfigurationDef (String name, boolean isGlobal, templateMap) Truy xuất ConfigurationDef cho tên đã cho
	getMapConfig () Phơi để thử nghiệm.
boolean	isDirectConfiguration (String configName)
String[]	reorderArgs (String[] args) Sắp xếp lại các args để template: map args đều được chuyển lên phía trước.
IRemoteFileResolver.ResolvedFile	resolveRemoteFile (URI configURI, URI destDir)

Các trình xây dựng được bảo vệ

ConfigurationFactory

protected ConfigurationFactory ()

Phương pháp công khai

clearMapConfig

public void clearMapConfig ()

Trong một số trường hợp cụ thể, chúng ta cần xóa bản đồ.

createConfigurationFromArgs

public IConfiguration createConfigurationFromArgs (String[] arrayArgs, 
                 unconsumedArgs)

Tạo cấu hình IConfiguration từ các đối số dòng lệnh.

Định dạng mong đợi là "CONFIG [tùy chọn]", trong đó CONFIG là tên cấu hình cài sẵn hoặc đường dẫn tệp đến tệp xml cấu hình.

Thông số
arrayArgs	String : đối số dòng lệnh
unconsumedArgs	: một Danh sách sẽ được điền với các đối số không được sử dụng bởi các Đối tượng được liên kết với cấu hình được chỉ định. Nếu giá trị này là null , thì việc triển khai sẽ ném ra ConfigurationException nếu vẫn còn bất kỳ args chưa được xử lý nào.

Lợi nhuận
IConfiguration	cấu hình IConfiguration đã tải. Đối tượng ủy quyền Các trường Option đã được điền các giá trị trong args.

Ném
ConfigurationException

createConfigurationFromArgs

public IConfiguration createConfigurationFromArgs (String[] arrayArgs, 
                 unconsumedArgs, 
                IKeyStoreClient keyStoreClient)

Tạo cấu hình IConfiguration từ các đối số dòng lệnh bằng kho khóa.

Định dạng mong đợi là "CONFIG [tùy chọn]", trong đó CONFIG là tên cấu hình cài sẵn hoặc đường dẫn tệp đến tệp xml cấu hình.

Thông số
arrayArgs	String : đối số dòng lệnh
unconsumedArgs	: một Danh sách sẽ được điền với các đối số không được sử dụng bởi các Đối tượng được liên kết với cấu hình được chỉ định. Nếu giá trị này là null , thì việc triển khai sẽ ném ra ConfigurationException nếu vẫn còn bất kỳ args chưa được xử lý nào.
keyStoreClient	IKeyStoreClient : một IKeyStoreClient được sử dụng để lấy thông tin nhạy cảm trong args.

Lợi nhuận
IConfiguration	cấu hình IConfiguration đã tải. Đối tượng ủy quyền Các trường Option đã được điền các giá trị trong args.

Ném
ConfigurationException

createConfigurationFromArgs

public IConfiguration createConfigurationFromArgs (String[] arrayArgs)

Một phương thức tiện lợi gọi ERROR(/#createConfigurationFromArgs(String[],List)) với đối số thứ hai null . Do đó, nó sẽ ném ra ConfigurationException nếu vẫn còn bất kỳ đối số nào chưa được tích lũy.

Thông số
arrayArgs	String

Lợi nhuận
IConfiguration

Ném
ConfigurationException

createGlobalConfigurationFromArgs

public IGlobalConfiguration createGlobalConfigurationFromArgs (String[] arrayArgs, 
                 remainingArgs)

Tạo một IGlobalConfiguration từ các đối số dòng lệnh.

Định dạng mong đợi là "CONFIG [tùy chọn]", trong đó CONFIG là tên cấu hình cài sẵn hoặc đường dẫn tệp đến tệp xml cấu hình.

Thông số
arrayArgs	String : đối số dòng lệnh
remainingArgs	: một danh sách sẽ được điền với các đối số không được xử lý như các đối số toàn cục

Lợi nhuận
IGlobalConfiguration	IGlobalConfiguration đã tải. Đối tượng ủy quyền Các trường Option đã được điền các giá trị trong args.

Ném
ConfigurationException

createPartialConfigurationFromArgs

public IConfiguration createPartialConfigurationFromArgs (String[] arrayArgs, 
                IKeyStoreClient keyStoreClient, 
                 allowedObjects, 
                TradefedDelegator delegator)

Tạo cấu hình chỉ chứa một tập hợp các đối tượng đã chọn.

Thông số
arrayArgs	String : Các đối số dòng lệnh
keyStoreClient	IKeyStoreClient : Một IKeyStoreClient được sử dụng để lấy thông tin nhạy cảm trong args.
allowedObjects	: Tập hợp các đối tượng được phép tạo
delegator	TradefedDelegator

Lợi nhuận
IConfiguration	Cấu IConfiguration đã tải.

Ném
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)

Thông số
configName	String : tên cấu hình
out	PrintStream : ERROR(/PrintStream) để kết xuất đầu ra cho

getConfigList

public  getConfigList (String subPath, 
                boolean loadFromEnv)

Biến thể của getConfigList() trong đó 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.

Thông số
subPath	String : tên của các thư mục con cần tìm để cấu hình. Nếu null, sẽ có hành vi giống như getConfigList() .
loadFromEnv	boolean : Đúng nếu chúng ta tải cấu hình trong biến môi trường.

Lợi nhuận

getConfigList

public  getConfigList ()

Trả lại danh sách tên của tất cả các cấu hình được tìm thấy trong JAR trên đường dẫn classpath. 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.

Lợi nhuận

getInstance

public static IConfigurationFactory getInstance ()

Nhận cá thể singleton IConfigurationFactory .

Lợi nhuận
IConfigurationFactory

loadAllConfigs

public void loadAllConfigs (boolean discardExceptions)

Tải tất cả các cấu hình được tìm thấy trong thư mục classpath và test case.

Thông số
discardExceptions	boolean : true nếu bỏ qua bất kỳ ConfigurationException nào.

Ném
ConfigurationException

loadAndPrintAllConfigs

public void loadAndPrintAllConfigs ()

Phương thức tiện ích kiểm tra xem tất cả các cấu hình có thể được tải, phân tích cú pháp và tất cả các giá trị tùy chọn được đặt hay không. Chỉ được hiển thị để tùy thuộc vào dự án có thể xác nhận cấu hình của họ. Không nên để lộ trong bàn điều khiển.

Ném
ConfigurationException	nếu một hoặc nhiều cấu hình không tải được

printHelp

public void printHelp (PrintStream out)

Bản in giúp đầu ra cho nhà máy này.

In thông tin trợ giúp chung và liệt kê tất cả các cấu hình có sẵn.

Thông số
out	PrintStream : ERROR(/PrintStream) để kết xuất đầu ra cho

printHelpForConfig

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

In đầu ra trợ giúp cho cấu hình IConfiguration được chỉ định trong các đối số dòng lệnh,

Nếu 'args' đề cập đến một cấu hình đã biết, một đối tượng IConfiguration sẽ được tạo từ XML và trợ giúp cho IConfiguration sẽ được xuất ra. 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 s khi được tải từ XML và sẽ không phản ánh các giá trị của tùy chọn được đặt bởi args dòng lệnh.

Nếu 'args' không tham chiếu đến IConfiguration biết, trợ giúp printHelp(PrintStream) chung sẽ được hiển thị.

Thông số
args	String : đối số dòng lệnh
importantOnly	boolean : nếu true , hãy in một trợ giúp viết tắt chỉ liệt kê những chi tiết quan trọng
out	PrintStream : ERROR(/PrintStream) để kết xuất đầu ra cho

Các phương pháp được bảo vệ

getBundledConfigStream

protected InputStream getBundledConfigStream (String name)

Thông số
name	String

Lợi nhuận
InputStream

getConfigPrefix

protected String getConfigPrefix ()

Trả lại tiền tố đường dẫn của các tệp cấu hình xml trên classpath

Tiếp xúc để các bài kiểm tra đơn vị có thể giả lập.

Lợi nhuận
String	Đường dẫn String có dấu /

getConfigStream

protected BufferedInputStream getConfigStream (String name)

Tải InputStream cho tên cấu hình đã cho

Thông số
name	String : tên cấu hình để tải

Lợi nhuận
BufferedInputStream	một ERROR(/BufferedInputStream) để đọc nội dung cấu hình

Ném
ConfigurationException	nếu không thể 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

Thông số
name	String : tên của cấu hình cài sẵn để tải hoặc đường dẫn tệp đến tệp cấu hình để tải
isGlobal	boolean
templateMap

Lợi nhuận
ConfigurationDef	ConfigurationDef

Ném
ConfigurationException	nếu xảy ra lỗi khi tải cấu hình

getMapConfig

protected  getMapConfig ()

Phơi để thử nghiệm. Trả lại bản sao của Bản đồ.

Lợi nhuận

isDirectConfiguration

protected boolean isDirectConfiguration (String configName)

Thông số
configName	String

Lợi nhuận
boolean

reorderArgs

protected String[] reorderArgs (String[] args)

Sắp xếp lại các args để template: map args đều được chuyển lên phía trước.

Thông số
args	String

Lợi nhuận
String[]

giải quyếtRemoteFile

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

Thông số
configURI	URI
destDir	URI

Lợi nhuận
IRemoteFileResolver.ResolvedFile

Ném
BuildRetrievalError