विकल्प

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 को फेंक दिया जाएगा.

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

इकाइयों को मिलाया जा सकता है और उनका मिलान किया जा सकता है, बशर्ते प्रत्येक इकाई अधिकतम एक बार दिखाई दे, और दिखाई देने वाली सभी इकाइयां स्केल के घटते क्रम में दिखाई गई हैं. इसलिए, उदाहरण के लिए, h सिर्फ़ m से पहले दिख सकता है और d के बाद ही दिख सकता है. खास तौर पर उदाहरण, "1d2h3m4s5ms" मान्य समय मान होगा, जैसा कि "4" होगा या "4 मि॰से॰" हो. सभी एम्बेड किए गए खाली सफ़ेद जगह छोड़ दी जाती है.

रिटर्न
boolean

ज़रूरी है

public boolean mandatory ()

यह विकल्प ज़रूरी है या ज़रूरी नहीं है.

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

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

रिटर्न
boolean

नाम

public String name ()

इस विकल्प के लिए ज़रूरी यूनीक नाम.

यह दो '-' वाले किसी कमांड लाइन तर्क से शुरू होगा वर्ण उदाहरण के लिए, 'help' नाम वाला Option को '--help' के साथ तय किया जाएगा पूरी तरह कैसे कमांड लाइन लिखें.

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

रिटर्न
String

ज़रूरी के लिए

public boolean requiredForRerun ()

क्या जांच को फिर से चलाने के लिए, निर्देश इकट्ठा करने की ज़रूरत है.

नतीजा रिपोर्टर, टेस्ट को फिर से चलाने के बारे में निर्देश इकट्ठा करने की कोशिश कर सकता है. इसमें दिखाई देता है. इस निर्देश में टेस्ट पर लागू होने वाले सभी विकल्प शामिल होंगे फिर से चलाना. इस एट्रिब्यूट का इस्तेमाल यह बताने के लिए किया जाता है कि क्या यह विकल्प निर्देश दिए गए हों.

रिटर्न
boolean

छोटा नाम

public char shortName ()

विकल्प के लिए छोटा नाम डालना ज़रूरी नहीं है. यह एक कमांड लाइन आर्ग्युमेंट पर मैप करेगा, जिसके पहले एक '-' लगा होगा. उदाहरण के लिए, "-घ°" जहां h = छोटा नाम है. '0' का मतलब यह है कि विकल्प में कोई छोटा नाम नहीं है.

रिटर्न
char

अपडेट के नियम

public OptionUpdateRule updateRule ()

किसी विकल्प को कई बार तय करने पर, यह नीति लागू होती है. ध्यान दें कि यह नियम ERROR(/Collection) या ERROR(/Map) वाले विकल्पों को पूरी तरह अनदेखा कर दिया जाता है.

रिटर्न
OptionUpdateRule