ConfigurationFactory

public class ConfigurationFactory
extends Object implements IConfigurationFactory

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

الفئات الفرعية المباشرة المعروفة ‫GCSConfigurationFactory وRetryConfigurationFactory وSandboxConfigurationFactory GCSConfigurationFactory تحمّل ConfigurationFactory الإعدادات من Google Cloud Storage.  RetryConfigurationFactory مصنع يتعامل مع إعادة محاولة تنفيذ أمر.  SandboxConfigurationFactory مصنع الإعدادات الخاص للتعامل مع إنشاء الإعدادات لأغراض وضع الحماية

---

مصنع لإنشاء 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() احصل على مثيل IConfigurationFactory في نمط "سينغلتون".
void	loadAllConfigs(boolean discardExceptions) تحميل جميع الإعدادات التي تم العثور عليها في مسار الفئة وأدلة حالات الاختبار
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 للإعدادات في مسار الفئة يتم عرضها حتى تتمكّن اختبارات الوحدة من محاكاتها.
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)

طُرق وضع التصميم المحمية

ConfigurationFactory

protected ConfigurationFactory ()

الإجراءات العامة

clearMapConfig

public void clearMapConfig ()

في بعض الحالات المحدّدة، نحتاج إلى محو الخريطة.

createConfigurationFromArgs

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	IConfiguration التي تم تحميلها تمت تعبئة حقول عنصر التفويض Option بالقيم الواردة في args.

عمليات الطرح
ConfigurationException

createConfigurationFromArgs

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

إنشاء IConfiguration من وسيطات سطر الأوامر

التنسيق المتوقّع هو "CONFIG [options]"، حيث CONFIG هو اسم الإعدادات المضمّنة أو مسار ملف XML للإعدادات.

المعلَمات
arrayArgs	‫String: وسيطات سطر الأوامر
unconsumedArgs	‫List: قائمة سيتم ملؤها بالوسيطات التي لم يتم استهلاكها من خلال العناصر المرتبطة بالإعدادات المحدّدة. إذا كانت القيمة null، سيؤدي التنفيذ إلى طرح الخطأ ConfigurationException إذا بقيت أي وسيطات لم تتم معالجتها.

المرتجعات
IConfiguration	IConfiguration التي تم تحميلها تمت تعبئة حقول عنصر التفويض Option بالقيم الواردة في args.

عمليات الطرح
ConfigurationException

createConfigurationFromArgs

public IConfiguration createConfigurationFromArgs (String[] arrayArgs)

طريقة ملائمة تستدعي createConfigurationFromArgs(String[],List) مع وسيطة null ثانية. وبالتالي، سيتم طرح ConfigurationException إذا بقيت أي وسيطات غير مستهلكة.

المعلَمات
arrayArgs	String

القيم المُعادة
IConfiguration

عمليات الطرح
ConfigurationException

createGlobalConfigurationFromArgs

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

إنشاء IGlobalConfiguration من وسيطات سطر الأوامر

التنسيق المتوقّع هو "CONFIG [options]"، حيث CONFIG هو اسم الإعدادات المضمّنة أو مسار ملف XML للإعدادات.

المعلَمات
arrayArgs	‫String: وسيطات سطر الأوامر
remainingArgs	List: قائمة سيتم ملؤها بالوسيطات التي لم تتم معالجتها كوسيطات عامة

المرتجعات
IGlobalConfiguration	IGlobalConfiguration التي تم تحميلها تمت تعبئة حقول عنصر التفويض Option بالقيم الواردة في args.

عمليات الطرح
ConfigurationException

createPartialConfigurationFromArgs

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 الذي سيتم إرسال الناتج إليه

getConfigList

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

صيغة getConfigList() حيث يمكنك تحديد ما إذا كنت تريد أيضًا تحميل الإعدادات من البيئة أم لا.

المعلَمات
subPath	String: اسم الدلائل الفرعية التي سيتم البحث فيها عن الإعدادات. إذا كانت القيمة فارغة، سيكون السلوك مماثلاً للسلوك في getConfigList().
loadFromEnv	boolean: تكون القيمة True إذا كان يجب تحميل الإعداد في متغيّر البيئة.

المرتجعات
List<String>

getConfigList

public List<String> getConfigList ()

تعرض هذه الطريقة قائمة بأسماء جميع الإعدادات التي تم العثور عليها في ملفات JAR في مسار الفئة. لا تحاول تحميل أي من الإعدادات، لذا من المحتمل أن تتضمّن هذه القائمة إعدادات لا تعمل.

المرتجعات
List<String>

getInstance

public static IConfigurationFactory getInstance ()

احصل على مثيل IConfigurationFactory في نمط "سينغلتون".

المرتجعات
IConfigurationFactory

loadAllConfigs

public void loadAllConfigs (boolean discardExceptions)

تحميل جميع الإعدادات التي تم العثور عليها في مسار الفئة وأدلة حالات الاختبار

المعلَمات
discardExceptions	‫boolean: تكون القيمة true إذا كان يجب تجاهل أي ConfigurationException.

عمليات الطرح
	com.android.tradefed.config.ConfigurationException
ConfigurationException

loadAndPrintAllConfigs

public void loadAndPrintAllConfigs ()

طريقة مساعدة تتحقّق من إمكانية تحميل جميع الإعدادات وتحليلها وضبط جميع قيم الخيارات. يتم عرضها فقط لكي يتمكّن المشروع التابع من التحقّق من صحة إعداداته. يجب ألا يتم عرضه في وحدة التحكّم.

عمليات الطرح
ConfigurationException	في حال تعذّر تحميل إعداد واحد أو أكثر

printHelp

public void printHelp (PrintStream out)

تساعد عمليات الطباعة في إخراج البيانات لهذه السمة.

يطبع معلومات مساعدة عامة، ويسرد جميع الإعدادات المتاحة.

المعلَمات
out	‫PrintStream: PrintStream الذي سيتم إرسال الناتج إليه

printHelpForConfig

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

طباعة ناتج المساعدة الخاص بـ IConfiguration المحدّد في وسيطات سطر الأوامر

إذا كانت "args" تشير إلى إعداد معروف، سيتم إنشاء عنصر IConfiguration من XML، وسيتم عرض المساعدة الخاصة بهذا العنصر IConfiguration. يُرجى العِلم أنّه سيتم تجاهل جميع قيم "args" الأخرى (أي أنّ نص المساعدة سيصف القيم الحالية لـ Options كما تم تحميلها من XML، ولن يعكس قيم الخيار التي تم ضبطها بواسطة وسيطات سطر الأوامر.

إذا لم يشِر "args" إلى IConfiguration معروف، سيتم عرض المساعدة العامة printHelp(PrintStream).

المعلَمات
args	‫String: وسيطات سطر الأوامر
importantOnly	‫boolean: إذا كانت القيمة true، اطبع قائمة مختصرة للمساعدة تتضمّن التفاصيل المهمة فقط
out	‫PrintStream: PrintStream الذي سيتم إرسال الناتج إليه

طُرق محمية

getBundledConfigStream

protected InputStream getBundledConfigStream (String name)

المعلَمات
name	String

المرتجعات
InputStream

getConfigPrefix

protected String getConfigPrefix ()

إرجاع بادئة المسار لملفات XML للإعدادات في مسار الفئة

يتم عرضها حتى تتمكّن اختبارات الوحدة من محاكاتها.

المرتجعات
String	String مسار يتضمّن شرطة مائلة لاحقة

getConfigStream

protected BufferedInputStream getConfigStream (String name)

تحميل InputStream لاسم الإعدادات المحدّد

المعلَمات
name	‫String: اسم الإعداد المطلوب تحميله

المرتجعات
BufferedInputStream	BufferedInputStream لقراءة محتوى الإعدادات

عمليات الطرح
ConfigurationException	في حال تعذّر العثور على الإعدادات

getConfigurationDef

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

استرداد ConfigurationDef للاسم المحدّد

المعلَمات
name	‫String: اسم إعداد مسبق مضمّن ليتم تحميله أو مسار ملف إلى ملف الإعدادات ليتم تحميله
isGlobal	boolean
templateMap	Map

المرتجعات
ConfigurationDef	ConfigurationDef

عمليات الطرح
ConfigurationException	في حال حدوث خطأ أثناء تحميل الإعدادات

getMapConfig

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

يتم عرضها للاختبار. إرجاع نسخة من الخريطة

المرتجعات
Map<ConfigurationFactory.ConfigId, ConfigurationDef>

isDirectConfiguration

protected boolean isDirectConfiguration (String configName)

المعلَمات
configName	String

المرتجعات
boolean

reorderArgs

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