ConfigurationFactory

public class ConfigurationFactory
extends Object implements IConfigurationFactory

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

المصنع لإنشاء IConfiguration

ملخّص

الفئات المُدمجة

class ConfigurationFactory.ConfigLoader

تنفيذ IConfigDefLoader الذي يتتبّع الإعدادات المضمّنة من أحد الإعدادات الأساسية ويُلقي استثناءً عند عمليات التضمين الدائرية 

class ConfigurationFactory.ExceptionLoader

 

وظائف الإنشاء المحمية

ConfigurationFactory()

الطرق العامة

void clearMapConfig()

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

IConfiguration createConfigurationFromArgs(String[] arrayArgs, unconsumedArgs)

أنشئ IConfiguration من وسيطات سطر الأوامر.

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

أنشئ IConfiguration من مَعلمات سطر الأوامر باستخدام متجر مفاتيح.

IConfiguration createConfigurationFromArgs(String[] arrayArgs)

طريقة مساعدة تستدعي ERROR(/#createConfigurationFromArgs(String[],List)) باستخدام وسيطة ثانية null.

IGlobalConfiguration createGlobalConfigurationFromArgs(String[] arrayArgs, remainingArgs)

أنشئ IGlobalConfiguration من وسيطات سطر الأوامر.

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

أنشئ إعدادات تحتوي فقط على مجموعة من العناصر المحدّدة.

void dumpConfig(String configName, PrintStream out)

تفريغ محتوى الإعدادات في ERROR(/PrintStream) المحدَّد

getConfigList(String subPath, boolean loadFromEnv)

يشير هذا الاختلاف إلى getConfigList() حيث يمكننا تحديد ما إذا كنا نريد أيضًا تحميل الإعدادات من البيئة أم لا.

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()

عرض بادئة مسار ملفات config xml في classpath

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

BufferedInputStream getConfigStream(String name)

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

ConfigurationDef getConfigurationDef(String name, boolean isGlobal, templateMap)

استرداد 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, 
                 unconsumedArgs)

أنشئ IConfiguration من وسيطات سطر الأوامر.

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

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

createConfigurationFromArgs

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

أنشئ IConfiguration من مَعلمات سطر الأوامر باستخدام متجر مفاتيح.

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

المعلمات
arrayArgs String: وسيطات سطر الأوامر
unconsumedArgs : قائمة ستتم تعبئتها بالوسيطات التي لم يتم استخدامها من قِبل الكائنات المرتبطة بالإعداد المحدّد. إذا كان هذا القيمة null، سيُلقي التنفيذ سوى ConfigurationException إذا بقيت أيّ وسيطات لم تتم معالجتها.
keyStoreClient ‫IKeyStoreClient: IKeyStoreClient يُستخدَم للحصول على معلومات حسّاسة في الوسيطات
المرتجعات
IConfiguration IConfiguration المحمَّلة. تمت تعبئة حقول العنصر المفوَّض Option بالقيم في args.
عمليات الرمي
ConfigurationException

createConfigurationFromArgs

public IConfiguration createConfigurationFromArgs (String[] arrayArgs)

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

المعلمات
arrayArgs String

المرتجعات
IConfiguration

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

createGlobalConfigurationFromArgs

public IGlobalConfiguration createGlobalConfigurationFromArgs (String[] arrayArgs, 
                 remainingArgs)

أنشئ IGlobalConfiguration من وسيطات سطر الأوامر.

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

المعلمات
arrayArgs String: وسيطات سطر الأوامر
remainingArgs : قائمة ستتم تعبئتها بالوسيطات التي لم تتم معالجتها كوسيطات عامة
المرتجعات
IGlobalConfiguration IGlobalConfiguration المحمَّلة. تمّت تعبئة حقول العنصر المفوَّض Option بالقيم الواردة في args.
عمليات الرمي
ConfigurationException

createPartialConfigurationFromArgs

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

أنشئ إعدادات تحتوي فقط على مجموعة من العناصر المحدّدة.

المعلمات
arrayArgs String: وسيطات سطر الأوامر
keyStoreClient IKeyStoreClient: IKeyStoreClient يُستخدَم للحصول على معلومات حسّاسة في args.
allowedObjects : مجموعة العناصر المسموح بإنشاءها
delegator TradefedDelegator

المرتجعات
IConfiguration تم تحميل IConfiguration.
عمليات الرمي
ConfigurationException

dumpConfig

public void dumpConfig (String configName, 
                PrintStream out)

تفريغ محتوى الإعدادات في ERROR(/PrintStream) المحدَّد

المعلمات
configName String: اسم الإعداد
out ‫PrintStream: ERROR(/PrintStream) لتفريغ الإخراج

getConfigList

public  getConfigList (String subPath, 
                boolean loadFromEnv)

يشير هذا الاختلاف إلى getConfigList() حيث يمكننا تحديد ما إذا كنا نريد أيضًا تحميل الإعدادات من البيئة أم لا.

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

getConfigList

public  getConfigList ()

عرض قائمة بأسماء جميع الإعدادات المتوفّرة في حِزم JAR على مسار تحميل الحِزم لا تحاول تحميل أي من الإعدادات، لذا من الممكن أن تتضمّن هذه القائمة إعدادات غير صالحة.

المرتجعات

getInstance

public static IConfigurationFactory getInstance ()

احصل على مثيل IConfigurationFactory في نمط "العنصر الفردي".

المرتجعات
IConfigurationFactory

loadAllConfigs

public void loadAllConfigs (boolean discardExceptions)

تحمِّل هذه الطريقة جميع الإعدادات المتوفّرة في مسار الطباعة ودلائل اختبارات التطبيق.

المعلمات
discardExceptions ‫boolean: صحيح إذا كان يجب تجاهل أيّ ConfigurationException.
عمليات الرمي
com.android.tradefed.config.ConfigurationException
ConfigurationException

loadAndPrintAllConfigs

public void loadAndPrintAllConfigs ()

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

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

printHelp

public void printHelp (PrintStream out)

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

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

المعلمات
out ‫PrintStream: ERROR(/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: ERROR(/PrintStream) لتفريغ الإخراج

الطرق المحمية

getBundledConfigStream

protected InputStream getBundledConfigStream (String name)

المعلمات
name String

المرتجعات
InputStream

getConfigPrefix

protected String getConfigPrefix ()

عرض بادئة مسار ملفات config xml في classpath

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

المرتجعات
String مسار String مع شرطة مائلة لاحقة

getConfigStream

protected BufferedInputStream getConfigStream (String name)

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

المعلمات
name String: اسم الإعدادات المطلوب تحميلها
المرتجعات
BufferedInputStream ERROR(/BufferedInputStream) لقراءة محتوى الإعدادات
عمليات الرمي
ConfigurationException إذا تعذّر العثور على الإعدادات

getConfigurationDef

protected ConfigurationDef getConfigurationDef (String name, 
                boolean isGlobal, 
                 templateMap)

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

المعلمات
name String: اسم إعدادات مضمّنة المطلوب تحميلها أو مسار ملف إلى ملف الإعدادات المطلوب تحميله
isGlobal boolean

templateMap

المرتجعات
ConfigurationDef ConfigurationDef
عمليات الرمي
ConfigurationException إذا حدث خطأ أثناء تحميل الإعدادات

getMapConfig

protected  getMapConfig ()

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

المرتجعات

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