विकल्प
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है. - फ़ील्ड खाली
ERROR(/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 ()
एक से ज़्यादा बार विकल्प तय किए जाने पर, उसके काम करने का तरीका कंट्रोल करता है. ध्यान दें कि ERROR(/Collection) या ERROR(/Map) वाले विकल्पों के लिए, इस नियम को पूरी तरह से अनदेखा किया जाता है.
| रिटर्न | |
|---|---|
OptionUpdateRule |
|