विकल्प

public abstract @interface Option
implements Annotation

com.android.tradefed.config.Option

---

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

सारांश

नेस्टेड कक्षाएं
enum	Option.Importance

स्थिरांक
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 (1000 मिली), मिनट के लिए 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' के साथ 'help' नाम वाला एक Option निर्दिष्ट किया जाएगा।

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

रिटर्न
String

आवश्यकफिर से चलाएँ

public boolean requiredForRerun ()

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

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

रिटर्न
boolean

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

public char shortName ()

विकल्प के लिए वैकल्पिक संक्षिप्त नाम। यह एक '-' के साथ प्रीफ़िक्स्ड कमांड लाइन तर्क के लिए मैप करेगा। उदाहरण के लिए "-एच" जहां एच = शॉर्टनाम। '0' का मतलब यह है कि विकल्प का कोई छोटा नाम नहीं है।

रिटर्न
char

अद्यतन नियम

public OptionUpdateRule updateRule ()

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

रिटर्न
OptionUpdateRule