विकल्प

public abstract @interface Option
implements Annotation

com.android.tradefed.config.Option


किसी फ़ील्ड को IConfiguration विकल्प का प्रतिनिधित्व करने के रूप में एनोटेट करता है।

सारांश

स्थिरांक

char NO_SHORT_NAME

सार्वजनिक तरीके

String description ()

विकल्प का उपयोगकर्ता के अनुकूल विवरण.

Option.Importance importance ()

विकल्प का महत्व.

boolean isTimeVal ()

क्या विकल्प समय मान का प्रतिनिधित्व करता है।

boolean mandatory ()

चाहे विकल्प अनिवार्य हो या वैकल्पिक.

String name ()

इस विकल्प के लिए अनिवार्य अद्वितीय नाम.

boolean requiredForRerun ()

क्या किसी परीक्षण को दोबारा चलाने के लिए निर्देश संकलित करने के लिए विकल्प की आवश्यकता है।

char shortName ()

विकल्प के लिए वैकल्पिक संक्षिप्त नाम.

OptionUpdateRule updateRule ()

जब कोई विकल्प कई बार निर्दिष्ट किया जाता है तो व्यवहार को नियंत्रित करता है।

स्थिरांक

NO_SHORT_NAME

public static final char NO_SHORT_NAME

स्थिर मान: 48 (0x00000030)

सार्वजनिक तरीके

विवरण

public String description ()

विकल्प का उपयोगकर्ता के अनुकूल विवरण.

रिटर्न
String

महत्त्व

public Option.Importance importance ()

विकल्प का महत्व.

संक्षिप्त सहायता आउटपुट में 'महत्वपूर्ण' समझा जाने वाला एक विकल्प प्रदर्शित किया जाएगा। किसी महत्वहीन विकल्प के लिए सहायता केवल पूर्ण सहायता पाठ में प्रदर्शित की जाएगी।

रिटर्न
Option.Importance

isTimeVal

public boolean isTimeVal ()

क्या विकल्प समय मान का प्रतिनिधित्व करता है।

यदि यह एक समय मान है, तो समय-विशिष्ट प्रत्ययों को पार्स किया जाएगा। फील्ड अवश्य इस ध्वज के वैध होने के लिए long या Long होना चाहिए। अन्यथा एक ConfigurationException फेंक दिया जाएगा।

डिफ़ॉल्ट इकाई मिलिस है. कॉन्फ़िगरेशन ढांचा सेकंड (1000 मिली) के लिए s , मिनट (60 सेकंड) के लिए m , घंटों (60 मिनट) के लिए h , या दिन (24 घंटे) के लिए d स्वीकार करेगा।

इकाइयों को मिश्रित और मिलान किया जा सकता है, जब तक कि प्रत्येक इकाई अधिकतम एक बार दिखाई देती है, और जब तक दिखाई देने वाली सभी इकाइयाँ पैमाने के घटते क्रम में सूचीबद्ध होती हैं। इसलिए, उदाहरण के लिए, h केवल m पहले प्रकट हो सकता है, और केवल d के बाद प्रकट हो सकता है। एक विशिष्ट उदाहरण के रूप में, "1d2h3m4s5ms" एक वैध समय मान होगा, जैसा कि "4" या "4ms" होगा। सभी एम्बेडेड रिक्त स्थान हटा दिए गए हैं।

रिटर्न
boolean

अनिवार्य

public boolean mandatory ()

चाहे विकल्प अनिवार्य हो या वैकल्पिक.

यदि सभी स्रोतों से विकल्पों को पार्स करने के बाद निम्नलिखित में से कोई भी अनिवार्य फ़ील्ड के लिए सत्य है, तो कॉन्फ़िगरेशन फ़्रेमवर्क ConfigurationException को फेंक देगा:

  • फ़ील्ड null है.
  • फ़ील्ड एक खाली ERROR(/Collection) है।

रिटर्न
boolean

नाम

public String name ()

इस विकल्प के लिए अनिवार्य अद्वितीय नाम.

यह दो '-' वर्णों के साथ उपसर्गित कमांड लाइन तर्क पर मैप करेगा। उदाहरण के लिए, 'help' नाम वाला एक Option कमांड लाइन पर '--help' के साथ निर्दिष्ट किया जाएगा।

नाम में कोलन नहीं होना चाहिए जैसे ':'।

रिटर्न
String

पुनः चलाने के लिए आवश्यक

public boolean requiredForRerun ()

क्या किसी परीक्षण को दोबारा चलाने के लिए निर्देश संकलित करने के लिए विकल्प की आवश्यकता है।

परिणाम रिपोर्टर किसी परीक्षण को दोबारा चलाने और परिणाम में संदेश शामिल करने के तरीके पर निर्देश संकलित करने का प्रयास कर सकता है। निर्देश में परीक्षण पुनः चलाने पर लागू होने वाले सभी विकल्प शामिल होंगे। इस विशेषता का उपयोग यह इंगित करने के लिए किया जाता है कि विकल्प को ऐसे निर्देश में शामिल किया जाएगा या नहीं।

रिटर्न
boolean

संक्षिप्त नाम

public char shortName ()

विकल्प के लिए वैकल्पिक संक्षिप्त नाम. यह एकल '-' के साथ उपसर्गित कमांड लाइन तर्क पर मैप करेगा। उदाहरण के लिए "-h" जहां h = संक्षिप्त नाम। '0' आरक्षित है जिसका मतलब है कि विकल्प का कोई संक्षिप्त नाम नहीं है।

रिटर्न
char

अद्यतन नियम

public OptionUpdateRule updateRule ()

जब कोई विकल्प कई बार निर्दिष्ट किया जाता है तो व्यवहार को नियंत्रित करता है। ध्यान दें कि इस नियम को उन विकल्पों के लिए पूरी तरह से नजरअंदाज कर दिया जाता है जो ERROR(/Collection) s या ERROR(/Map) s हैं।

रिटर्न
OptionUpdateRule