پیکربندی کارخانه

public class ConfigurationFactory
extends Object implements IConfigurationFactory

شیء جاوا
↳	com.android.tradefed.config.ConfigurationFactory

زیرکلاس‌های مستقیم شناخته‌شده GCSConfigurationFactory ، RetryConfigurationFactory ، SandboxConfigurationFactory کارخانه پیکربندی GCS یک ConfigurationFactory پیکربندی‌ها را از Google Cloud Storage بارگذاری می‌کند. RetryConfigurationFactory کارخانه‌ای که تلاش مجدد یک دستور را مدیریت می‌کند. SandboxConfigurationFactory کارخانه پیکربندی ویژه برای مدیریت ایجاد پیکربندی‌ها به منظور Sandboxing.

---

کارخانه‌ای برای ایجاد IConfiguration .

خلاصه

کلاس‌های تو در تو
class	ConfigurationFactory.ConfigLoader پیاده‌سازی IConfigDefLoader که پیکربندی‌های گنجانده شده را از یک پیکربندی ریشه ردیابی می‌کند و در مورد شامل شدن‌های دایره‌ای، استثنا ایجاد می‌کند.
class	ConfigurationFactory.ExceptionLoader

سازنده‌های محافظت‌شده
ConfigurationFactory ()

روش‌های عمومی
void	clearMapConfig () در برخی موارد خاص، باید نقشه را پاک کنیم.
IConfiguration	createConfigurationFromArgs (String[] arrayArgs, List<String> unconsumedArgs, IKeyStoreClient keyStoreClient) آرگومان‌های خط فرمان IConfiguration را با یک فروشگاه کلید ایجاد کنید.
IConfiguration	createConfigurationFromArgs (String[] arrayArgs, List<String> unconsumedArgs) ایجاد IConfiguration از آرگومان‌های خط فرمان.
IConfiguration	createConfigurationFromArgs (String[] arrayArgs) یک متد کمکی که تابع createConfigurationFromArgs(String[],List) را با آرگومان دوم null فراخوانی می‌کند.
IGlobalConfiguration	createGlobalConfigurationFromArgs (String[] arrayArgs, List<String> remainingArgs) ایجاد یک IGlobalConfiguration از آرگومان‌های خط فرمان.
IConfiguration	createPartialConfigurationFromArgs (String[] arrayArgs, IKeyStoreClient keyStoreClient, Set<String> allowedObjects, TradefedDelegator delegator) یک پیکربندی ایجاد کنید که فقط شامل مجموعه‌ای از اشیاء انتخاب شده باشد.
void	dumpConfig (String configName, PrintStream out) محتویات پیکربندی را در PrintStream داده شده تخلیه می‌کند.
List<String>	getConfigList (String subPath, boolean loadFromEnv) نوع دیگری از getConfigList() که می‌تواند مشخص کند آیا می‌خواهیم پیکربندی را از محیط نیز بارگیری کنیم یا خیر.
List<String>	getConfigList () لیست نام تمام پیکربندی‌های موجود در JARهای مسیر کلاس را برمی‌گرداند.
static IConfigurationFactory	getInstance () نمونه‌ی singleton از IConfigurationFactory را دریافت کنید.
void	loadAllConfigs (boolean discardExceptions) تمام پیکربندی‌های موجود در دایرکتوری‌های classpath و test case را بارگذاری می‌کند.
void	loadAndPrintAllConfigs () متد کاربردی که بررسی می‌کند آیا همه پیکربندی‌ها قابل بارگذاری، تجزیه و تحلیل و تنظیم مقادیر همه گزینه‌ها هستند یا خیر.
void	printHelp (PrintStream out) چاپ به خروجی این کارخانه کمک می‌کند.
void	printHelpForConfig (String[] args, boolean importantOnly, PrintStream out) خروجی راهنما را برای IConfiguration مشخص شده در آرگومان‌های خط فرمان چاپ می‌کند، اگر 'args' به یک پیکربندی شناخته شده اشاره داشته باشد، یک شیء IConfiguration از XML ایجاد می‌شود و راهنمای آن IConfiguration در خروجی نمایش داده می‌شود.

روش‌های محافظت‌شده
InputStream	getBundledConfigStream (String name)
String	getConfigPrefix () پیشوند مسیر فایل‌های پیکربندی xml در classpath را برمی‌گرداند. در معرض نمایش قرار گرفته تا تست‌های واحد بتوانند شبیه‌سازی کنند.
BufferedInputStream	getConfigStream (String name) یک InputStream را برای نام پیکربندی داده شده بارگذاری می‌کند.
ConfigurationDef	getConfigurationDef (String name, boolean isGlobal, Map<String, String> templateMap) بازیابی ConfigurationDef برای نام داده شده
Map<ConfigurationFactory.ConfigId, ConfigurationDef >	getMapConfig () برای آزمایش در معرض دید قرار گرفت.
boolean	isDirectConfiguration (String configName)
String[]	reorderArgs (String[] args) آرگومان‌ها را طوری مرتب کنید که آرگومان‌های template:map همگی به جلو منتقل شوند.
IRemoteFileResolver.ResolvedFile	resolveRemoteFile (URI configURI, URI destDir)

سازنده‌های محافظت‌شده

پیکربندی کارخانه

protected ConfigurationFactory ()

روش‌های عمومی

clearMapConfig

public void clearMapConfig ()

در برخی موارد خاص، باید نقشه را پاک کنیم.

ایجاد پیکربندی از آرگومان‌ها

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

آرگومان‌های خط فرمان IConfiguration را با یک فروشگاه کلید ایجاد کنید.

قالب مورد انتظار "CONFIG [options]" است، که در آن CONFIG نام پیکربندی داخلی یا مسیر فایل به یک فایل xml پیکربندی است.

پارامترها
arrayArgs	String : آرگومان‌های خط فرمان
unconsumedArgs	List : لیستی که با آرگومان‌هایی که توسط اشیاء مرتبط با پیکربندی مشخص شده مصرف نشده‌اند، پر می‌شود. اگر این null باشد، در صورت باقی ماندن آرگومان‌های پردازش نشده، پیاده‌سازی، ConfigurationException صادر می‌کند.
keyStoreClient	IKeyStoreClient : یک IKeyStoreClient که برای دریافت اطلاعات حساس در آرگومان‌ها استفاده می‌شود.

بازگشت‌ها
IConfiguration	فیلدهای Option شیء نماینده با مقادیر موجود در args IConfiguration شده‌اند.

پرتاب‌ها
ConfigurationException

ایجاد پیکربندی از آرگومان‌ها

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

ایجاد IConfiguration از آرگومان‌های خط فرمان.

قالب مورد انتظار "CONFIG [options]" است، که در آن CONFIG نام پیکربندی داخلی یا مسیر فایل به یک فایل xml پیکربندی است.

پارامترها
arrayArgs	String : آرگومان‌های خط فرمان
unconsumedArgs	List : لیستی که با آرگومان‌هایی که توسط اشیاء مرتبط با پیکربندی مشخص شده مصرف نشده‌اند، پر می‌شود. اگر این null باشد، در صورت باقی ماندن آرگومان‌های پردازش نشده، پیاده‌سازی، ConfigurationException صادر می‌کند.

بازگشت‌ها
IConfiguration	فیلدهای Option شیء نماینده با مقادیر موجود در args IConfiguration شده‌اند.

پرتاب‌ها
ConfigurationException

ایجاد پیکربندی از آرگومان‌ها

public IConfiguration createConfigurationFromArgs (String[] arrayArgs)

یک متد کمکی که تابع createConfigurationFromArgs(String[],List) را با آرگومان دوم null فراخوانی می‌کند. بنابراین، اگر آرگومان‌های مصرف نشده‌ای باقی بمانند، خطای ConfigurationException رخ می‌دهد.

پارامترها
arrayArgs	String

بازگشت‌ها
IConfiguration

پرتاب‌ها
ConfigurationException

ایجاد پیکربندی سراسری از آرگومان‌ها

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

ایجاد یک IGlobalConfiguration از آرگومان‌های خط فرمان.

قالب مورد انتظار "CONFIG [options]" است، که در آن CONFIG نام پیکربندی داخلی یا مسیر فایل به یک فایل xml پیکربندی است.

پارامترها
arrayArgs	String : آرگومان‌های خط فرمان
remainingArgs	List : فهرستی که با آرگومان‌هایی که به عنوان آرگومان‌های سراسری پردازش نشده‌اند، پر خواهد شد.

بازگشت‌ها
IGlobalConfiguration	فیلدهای Option شیء IGlobalConfiguration با مقادیر موجود در args پر شده‌اند.

پرتاب‌ها
ConfigurationException

ایجاد پیکربندی جزئیاز آرگومان‌ها

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

یک پیکربندی ایجاد کنید که فقط شامل مجموعه‌ای از اشیاء انتخاب شده باشد.

پارامترها
arrayArgs	String : آرگومان‌های خط فرمان
keyStoreClient	IKeyStoreClient : یک IKeyStoreClient که برای دریافت اطلاعات حساس در آرگومان‌ها استفاده می‌شود.
allowedObjects	Set : مجموعه‌ای از اشیاء مجاز برای ایجاد
delegator	TradefedDelegator

بازگشت‌ها
IConfiguration	فایل IConfiguration بارگذاری شده.

پرتاب‌ها
ConfigurationException

dumpConfig

public void dumpConfig (String configName, 
                PrintStream out)

محتویات پیکربندی را در PrintStream داده شده تخلیه می‌کند.

پارامترها
configName	String : نام پیکربندی
out	PrintStream : PrintStream برای تخلیه خروجی

دریافت لیست پیکربندی

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

نوع دیگری از getConfigList() که می‌تواند مشخص کند آیا می‌خواهیم پیکربندی را از محیط نیز بارگیری کنیم یا خیر.

پارامترها
subPath	String : نام زیرشاخه‌هایی که باید پیکربندی در آنها جستجو شود. اگر null باشد، رفتاری مشابه getConfigList() خواهد داشت.
loadFromEnv	boolean : اگر قرار باشد پیکربندی را در متغیر محیطی بارگذاری کنیم، مقدار True برمی‌گرداند.

بازگشت‌ها
List<String>

دریافت لیست پیکربندی

public List<String> getConfigList ()

لیست نام تمام پیکربندی‌های موجود در JARهای مسیر کلاس را برمی‌گرداند. هیچ یک از پیکربندی‌ها را بارگذاری نمی‌کند، بنابراین ممکن است پیکربندی غیرفعال در این لیست وجود داشته باشد.

بازگشت‌ها
List<String>

دریافت نمونه

public static IConfigurationFactory getInstance ()

نمونه‌ی singleton از IConfigurationFactory را دریافت کنید.

بازگشت‌ها
IConfigurationFactory

بارگذاری همه پیکربندی‌ها

public void loadAllConfigs (boolean discardExceptions)

تمام پیکربندی‌های موجود در دایرکتوری‌های classpath و test case را بارگذاری می‌کند.

پارامترها
discardExceptions	boolean : اگر هر یک از ConfigurationExceptionها باید نادیده گرفته شوند، مقدار true را برمی‌گرداند.

پرتاب‌ها
	com.android.tradefed.config.ConfigurationException
ConfigurationException

بارگذاری و چاپ همه پیکربندی‌ها

public void loadAndPrintAllConfigs ()

متد کاربردی که بررسی می‌کند آیا همه پیکربندی‌ها می‌توانند بارگذاری، تجزیه و تحلیل شوند و همه مقادیر گزینه‌ها تنظیم شوند. فقط به گونه‌ای نمایش داده می‌شود که پروژه‌های وابسته بتوانند پیکربندی‌های خود را اعتبارسنجی کنند. نباید در کنسول نمایش داده شود.

پرتاب‌ها
ConfigurationException	اگر یک یا چند پیکربندی بارگیری نشد

چاپراهنما

public void printHelp (PrintStream out)

چاپ به خروجی این کارخانه کمک می‌کند.

یک اطلاعات راهنمای عمومی چاپ می‌کند و تمام پیکربندی‌های موجود را فهرست می‌کند.

پارامترها
out	PrintStream : PrintStream برای تخلیه خروجی

چاپکمک برای پیکربندی

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

خروجی راهنما را برای IConfiguration مشخص شده در آرگومان‌های خط فرمان چاپ می‌کند،

اگر 'args' به یک پیکربندی شناخته شده اشاره داشته باشد، یک شیء IConfiguration از XML ایجاد می‌شود و راهنمای آن IConfiguration در خروجی نمایش داده می‌شود. توجه داشته باشید که سایر مقادیر 'args' نادیده گرفته می‌شوند (یعنی متن راهنما، مقادیر فعلی Option s را که از XML بارگذاری شده‌اند، توصیف می‌کند و مقادیر گزینه تنظیم شده توسط args خط فرمان را منعکس نمی‌کند).

اگر 'args' به یک IConfiguration شناخته شده اشاره نکند، راهنمای عمومی printHelp(PrintStream) نمایش داده خواهد شد.

پارامترها
args	String : آرگومان‌های خط فرمان
importantOnly	boolean : اگر true ، یک راهنمای مختصر چاپ می‌کند که فقط جزئیات مهم را فهرست می‌کند.
out	PrintStream : PrintStream برای تخلیه خروجی

روش‌های محافظت‌شده

getBundledConfigStream

protected InputStream getBundledConfigStream (String name)

پارامترها
name	String

بازگشت‌ها
InputStream

پیشوند getConfig

protected String getConfigPrefix ()

پیشوند مسیر فایل‌های پیکربندی xml در classpath را برمی‌گرداند.

در معرض نمایش قرار گرفته تا تست‌های واحد بتوانند شبیه‌سازی کنند.

بازگشت‌ها
String	مسیر String با علامت / در انتهای آن

getConfigStream

protected BufferedInputStream getConfigStream (String name)

یک InputStream را برای نام پیکربندی داده شده بارگذاری می‌کند.

پارامترها
name	String : نام پیکربندی برای بارگذاری

بازگشت‌ها
BufferedInputStream	یک BufferedInputStream برای خواندن محتوای پیکربندی

پرتاب‌ها
ConfigurationException	اگر پیکربندی پیدا نشد

دریافت پیکربندیDef

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

بازیابی ConfigurationDef برای نام داده شده

پارامترها
name	String : نام پیکربندی داخلی برای بارگذاری یا مسیر فایل پیکربندی برای بارگذاری
isGlobal	boolean
templateMap	Map

بازگشت‌ها
ConfigurationDef	ConfigurationDef

پرتاب‌ها
ConfigurationException	اگر خطایی در بارگیری پیکربندی رخ داد

دریافت نقشه پیکربندی

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

برای آزمایش در معرض دید قرار گرفت. یک کپی از نقشه را برگردانید.

بازگشت‌ها
Map<ConfigurationFactory.ConfigId, ConfigurationDef >

پیکربندی isDirect

protected boolean isDirectConfiguration (String configName)

پارامترها
configName	String

بازگشت‌ها
boolean

آرگومان‌های reorder

protected String[] reorderArgs (String[] args)

آرگومان‌ها را طوری مرتب کنید که آرگومان‌های template:map همگی به جلو منتقل شوند.

پارامترها
args	String

بازگشت‌ها
String[]

resolveRemoteFile

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

پارامترها
configURI	URI
destDir	URI

بازگشت‌ها
IRemoteFileResolver.ResolvedFile

پرتاب‌ها
BuildRetrievalError