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

public interface IConfigurationFactory

com.android.tradefed.config.IConfigurationFactory


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

خلاصه

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

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

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

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

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

abstract IConfiguration createConfigurationFromArgs (String[] args)

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

abstract IGlobalConfiguration createGlobalConfigurationFromArgs (String[] args, List<String> nonGlobalArgs)

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

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

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

abstract void dumpConfig (String configName, PrintStream out)

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

abstract List<String> getConfigList ()

لیست نام تمام پیکربندی‌های موجود در JARهای مسیر کلاس را برمی‌گرداند.

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

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

abstract void printHelp (PrintStream out)

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

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

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

اگر 'args' به یک پیکربندی شناخته شده اشاره داشته باشد، یک شیء IConfiguration از XML ایجاد می‌شود و راهنمای آن IConfiguration در خروجی نمایش داده می‌شود.

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

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

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

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

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

پارامترها
args String : آرگومان‌های خط فرمان

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

keyStoreClient IKeyStoreClient : یک IKeyStoreClient که برای دریافت اطلاعات حساس در آرگومان‌ها استفاده می‌شود.

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

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

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

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

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

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

پارامترها
args String : آرگومان‌های خط فرمان

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

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

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

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

public abstract IConfiguration createConfigurationFromArgs (String[] args)

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

پارامترها
args String

بازگشت‌ها
IConfiguration

پرتاب‌ها
ConfigurationException

همچنین ببینید:

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

public abstract IGlobalConfiguration createGlobalConfigurationFromArgs (String[] args, 
                List<String> nonGlobalArgs)

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

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

پارامترها
args String : آرگومان‌های خط فرمان

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

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

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

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

public abstract 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 abstract void dumpConfig (String configName, 
                PrintStream out)

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

پارامترها
configName String : نام پیکربندی

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

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

public abstract List<String> getConfigList ()

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

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

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

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

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

پارامترها
subPath String : نام زیرشاخه‌هایی که باید پیکربندی در آنها جستجو شود. اگر null باشد، رفتاری مشابه getConfigList() خواهد داشت.

loadFromEnv boolean : اگر قرار باشد پیکربندی را در متغیر محیطی بارگذاری کنیم، مقدار True برمی‌گرداند.

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

چاپراهنما

public abstract void printHelp (PrintStream out)

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

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

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

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

public abstract 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 برای تخلیه خروجی