विकल्प

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" या "4ms" भी मान्य समय वैल्यू हैं. एम्बेड किए गए सभी खाली सफ़ेद स्पेस हटा दिए जाते हैं.

रिटर्न
boolean

ज़रूरी है

public boolean mandatory ()

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

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

  • यह फ़ील्ड null है.
  • यह फ़ील्ड, खाली Collection है.

रिटर्न
boolean

नाम

public String name ()

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

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

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

रिटर्न
String

requiredForRerun

public boolean requiredForRerun ()

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

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

रिटर्न
boolean

shortName

public char shortName ()

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

रिटर्न
char

updateRule

public OptionUpdateRule updateRule ()

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

रिटर्न
OptionUpdateRule