ConfigurationFactory

public class ConfigurationFactory
extends Object implements IConfigurationFactory

java.lang.Object
   ↳ com.android.tradefed.config.ConfigurationFactory

Factory สำหรับสร้าง IConfiguration

สรุป

คลาสที่ซ้อนกัน

class ConfigurationFactory.ConfigLoader

การใช้งาน IConfigDefLoader ที่ติดตามการกำหนดค่าที่รวมไว้จากไฟล์กำหนดค่ารูทไฟล์หนึ่ง และจะแสดงข้อยกเว้นเมื่อมีการรวมแบบวงกลม 

class ConfigurationFactory.ExceptionLoader

 

เครื่องมือสร้างที่ป้องกัน

ConfigurationFactory()

เมธอดสาธารณะ

void clearMapConfig()

ในบางกรณี เราจำเป็นต้องล้างแผนที่

IConfiguration createConfigurationFromArgs(String[] arrayArgs, List<String> unconsumedArgs, IKeyStoreClient keyStoreClient)

สร้าง IConfiguration จากอาร์กิวเมนต์บรรทัดคำสั่งที่มีที่เก็บคีย์

IConfiguration createConfigurationFromArgs(String[] arrayArgs, List<String> unconsumedArgs)

สร้าง IConfiguration จากอาร์กิวเมนต์บรรทัดคำสั่ง

IConfiguration createConfigurationFromArgs(String[] arrayArgs)

เมธอดอำนวยความสะดวกที่เรียกใช้ createConfigurationFromArgs(String[],List) โดยมีอาร์กิวเมนต์ที่ 2 เป็น null

IGlobalConfiguration createGlobalConfigurationFromArgs(String[] arrayArgs, List<String> remainingArgs)

สร้าง IGlobalConfiguration จากอาร์กิวเมนต์บรรทัดคำสั่ง

IConfiguration createPartialConfigurationFromArgs(String[] arrayArgs, IKeyStoreClient keyStoreClient, Set<String> allowedObjects, TradefedDelegator delegator)

สร้างการกำหนดค่าที่มีเฉพาะชุดออบเจ็กต์ที่เลือก

void dumpConfig(String configName, PrintStream out)

ส่งออกเนื้อหาของการกำหนดค่าไปยัง PrintStream ที่ระบุ

List<String> getConfigList(String subPath, boolean loadFromEnv)

รูปแบบของ getConfigList() ซึ่งคุณระบุได้ว่าต้องการโหลดการกำหนดค่าจากสภาพแวดล้อมด้วยหรือไม่

List<String> getConfigList()

แสดงรายการชื่อของไฟล์กำหนดค่าทั้งหมดที่พบในไฟล์ JAR ในเส้นทางของคลาส

static IConfigurationFactory getInstance()

รับอินสแตนซ์ IConfigurationFactory Singleton

void loadAllConfigs(boolean discardExceptions)

โหลดการกำหนดค่าทั้งหมดที่พบในไดเรกทอรี Classpath และไดเรกทอรีกรณีทดสอบ

void loadAndPrintAllConfigs()

เมธอดยูทิลิตีที่ตรวจสอบว่าโหลด แยกวิเคราะห์ และ ตั้งค่าตัวเลือกทั้งหมดได้

void printHelp(PrintStream out)

พิมพ์เอาต์พุตวิธีใช้สำหรับ Factory นี้

void printHelpForConfig(String[] args, boolean importantOnly, PrintStream out)

พิมพ์เอาต์พุตความช่วยเหลือสำหรับ IConfiguration ที่ระบุในอาร์กิวเมนต์บรรทัดคำสั่ง

หาก "args" อ้างอิงถึงการกำหนดค่าที่รู้จัก ระบบจะสร้างออบเจ็กต์ IConfiguration จาก XML และแสดงความช่วยเหลือสำหรับ IConfiguration นั้น

วิธีการที่ได้รับการป้องกัน

InputStream getBundledConfigStream(String name)
String getConfigPrefix()

ส่งคืนคำนำหน้าเส้นทางของไฟล์ XML การกำหนดค่าใน Classpath

แสดงเพื่อให้การทดสอบหน่วยสามารถจำลองได้

BufferedInputStream getConfigStream(String name)

โหลด InputStream สำหรับชื่อการกำหนดค่าที่ระบุ

ConfigurationDef getConfigurationDef(String name, boolean isGlobal, Map<String, String> templateMap)

ดึงข้อมูล ConfigurationDef สำหรับชื่อที่ระบุ

Map<ConfigurationFactory.ConfigId, ConfigurationDef> getMapConfig()

แสดงสำหรับการทดสอบ

boolean isDirectConfiguration(String configName)
String[] reorderArgs(String[] args)

จัดเรียงอาร์กิวเมนต์ใหม่เพื่อให้ย้ายอาร์กิวเมนต์ template:map ทั้งหมดไปไว้ด้านหน้า

IRemoteFileResolver.ResolvedFile resolveRemoteFile(URI configURI, URI destDir)

เครื่องมือสร้างที่ป้องกัน

ConfigurationFactory

protected ConfigurationFactory ()

เมธอดสาธารณะ

clearMapConfig

public void clearMapConfig ()

ในบางกรณี เราจำเป็นต้องล้างแผนที่

createConfigurationFromArgs

public IConfiguration createConfigurationFromArgs (String[] arrayArgs, 
                List<String> unconsumedArgs, 
                IKeyStoreClient keyStoreClient)

สร้าง IConfiguration จากอาร์กิวเมนต์บรรทัดคำสั่งที่มีที่เก็บคีย์

รูปแบบที่คาดไว้คือ "CONFIG [options]" โดยที่ CONFIG คือชื่อการกำหนดค่าในตัวหรือ เส้นทางไฟล์ไปยังไฟล์ XML การกำหนดค่า

พารามิเตอร์
arrayArgs String: อาร์กิวเมนต์บรรทัดคำสั่ง
unconsumedArgs List: รายการที่จะได้รับการป้อนข้อมูลด้วยอาร์กิวเมนต์ที่ไม่ได้ ใช้โดยออบเจ็กต์ที่เชื่อมโยงกับการกำหนดค่าที่ระบุ หากเป็น null การติดตั้งใช้งานจะแสดง ConfigurationException หากยังมีอาร์กิวเมนต์ที่ยังไม่ได้ประมวลผล
keyStoreClient IKeyStoreClient: IKeyStoreClient ที่ใช้เพื่อรับข้อมูลที่ละเอียดอ่อนใน อาร์กิวเมนต์
การคืนสินค้า
IConfiguration IConfiguration ที่โหลดแล้ว ระบบได้ป้อนค่าในอาร์กิวเมนต์ลงในฟิลด์ของออบเจ็กต์ผู้มอบสิทธิ์ Option แล้ว

ส่ง
ConfigurationException

createConfigurationFromArgs

public IConfiguration createConfigurationFromArgs (String[] arrayArgs, 
                List<String> unconsumedArgs)

สร้าง IConfiguration จากอาร์กิวเมนต์บรรทัดคำสั่ง

รูปแบบที่คาดไว้คือ "CONFIG [options]" โดยที่ CONFIG คือชื่อการกำหนดค่าในตัวหรือ เส้นทางไฟล์ไปยังไฟล์ XML การกำหนดค่า

พารามิเตอร์
arrayArgs String: อาร์กิวเมนต์บรรทัดคำสั่ง
unconsumedArgs List: รายการที่จะได้รับการป้อนข้อมูลด้วยอาร์กิวเมนต์ที่ไม่ได้ ใช้โดยออบเจ็กต์ที่เชื่อมโยงกับการกำหนดค่าที่ระบุ หากเป็น null การติดตั้งใช้งานจะแสดง ConfigurationException หากยังมีอาร์กิวเมนต์ที่ยังไม่ได้ประมวลผล
การคืนสินค้า
IConfiguration IConfiguration ที่โหลดแล้ว ระบบได้ป้อนค่าในอาร์กิวเมนต์ลงในฟิลด์ของออบเจ็กต์ผู้มอบสิทธิ์ Option แล้ว

ส่ง
ConfigurationException

createConfigurationFromArgs

public IConfiguration createConfigurationFromArgs (String[] arrayArgs)

เมธอดอำนวยความสะดวกที่เรียกใช้ createConfigurationFromArgs(String[],List) โดยมีอาร์กิวเมนต์ที่ 2 เป็น null ดังนั้น ฟังก์ชันนี้จะแสดง ConfigurationException หาก ยังมีอาร์กิวเมนต์ที่ไม่ได้ใช้

พารามิเตอร์
arrayArgs String

การคืนสินค้า
IConfiguration

ส่ง
ConfigurationException

createGlobalConfigurationFromArgs

public IGlobalConfiguration createGlobalConfigurationFromArgs (String[] arrayArgs, 
                List<String> remainingArgs)

สร้าง IGlobalConfiguration จากอาร์กิวเมนต์บรรทัดคำสั่ง

รูปแบบที่คาดไว้คือ "CONFIG [options]" โดยที่ CONFIG คือชื่อการกำหนดค่าในตัวหรือ เส้นทางไฟล์ไปยังไฟล์ XML การกำหนดค่า

พารามิเตอร์
arrayArgs String: อาร์กิวเมนต์บรรทัดคำสั่ง
remainingArgs List: รายการที่จะมีอาร์กิวเมนต์ที่ไม่ได้ ประมวลผลเป็นอาร์กิวเมนต์ส่วนกลาง
การคืนสินค้า
IGlobalConfiguration IGlobalConfiguration ที่โหลดแล้ว ระบบได้ป้อนค่าใน args ลงในฟิลด์ของออบเจ็กต์ที่มอบสิทธิ์ Option แล้ว

ส่ง
ConfigurationException

createPartialConfigurationFromArgs

public IConfiguration createPartialConfigurationFromArgs (String[] arrayArgs, 
                IKeyStoreClient keyStoreClient, 
                Set<String> allowedObjects, 
                TradefedDelegator delegator)

สร้างการกำหนดค่าที่มีเฉพาะชุดออบเจ็กต์ที่เลือก

พารามิเตอร์
arrayArgs String: อาร์กิวเมนต์บรรทัดคำสั่ง
keyStoreClient IKeyStoreClient: IKeyStoreClient ที่ใช้เพื่อรับข้อมูลที่ละเอียดอ่อนใน อาร์กิวเมนต์
allowedObjects Set: ชุดออบเจ็กต์ที่อนุญาตให้สร้าง
delegator TradefedDelegator

การคืนสินค้า
IConfiguration IConfiguration ที่โหลดแล้ว
ส่ง
ConfigurationException

dumpConfig

public void dumpConfig (String configName, 
                PrintStream out)

ส่งออกเนื้อหาของการกำหนดค่าไปยัง PrintStream ที่ระบุ

พารามิเตอร์
configName String: ชื่อการกำหนดค่า
out PrintStream: PrintStream ที่จะดัมพ์เอาต์พุตไป

getConfigList

public List<String> getConfigList (String subPath, 
                boolean loadFromEnv)

รูปแบบของ getConfigList() ซึ่งคุณระบุได้ว่าต้องการโหลดการกำหนดค่าจากสภาพแวดล้อมด้วยหรือไม่

พารามิเตอร์
subPath String: ชื่อของไดเรกทอรีย่อยที่จะค้นหาการกำหนดค่า หากเป็นค่าว่าง จะมีลักษณะการทำงานเหมือนกับ getConfigList()
loadFromEnv boolean: จริง หากเราควรโหลดการกำหนดค่าในตัวแปรสภาพแวดล้อม
การคืนสินค้า
List<String>

getConfigList

public List<String> getConfigList ()

แสดงรายการชื่อของไฟล์กำหนดค่าทั้งหมดที่พบในไฟล์ JAR ในเส้นทางของคลาส ไม่พยายามโหลดการกำหนดค่าใดๆ จึงอาจมีการกำหนดค่าที่ใช้งานไม่ได้ ในรายการนี้

การคืนสินค้า
List<String>

getInstance

public static IConfigurationFactory getInstance ()

รับอินสแตนซ์ IConfigurationFactory Singleton

การคืนสินค้า
IConfigurationFactory

loadAllConfigs

public void loadAllConfigs (boolean discardExceptions)

โหลดการกำหนดค่าทั้งหมดที่พบในไดเรกทอรี Classpath และไดเรกทอรีกรณีทดสอบ

พารามิเตอร์
discardExceptions boolean: จริง หากควรละเว้น ConfigurationException
ส่ง
com.android.tradefed.config.ConfigurationException
ConfigurationException

loadAndPrintAllConfigs

public void loadAndPrintAllConfigs ()

เมธอดยูทิลิตีที่ตรวจสอบว่าโหลด แยกวิเคราะห์ และ ตั้งค่าตัวเลือกทั้งหมดได้ เปิดเผยเฉพาะเพื่อให้โปรเจ็กต์ที่ขึ้นอยู่กับโปรเจ็กต์นี้ตรวจสอบการกำหนดค่าได้ ไม่ควรแสดงในคอนโซล

ส่ง
ConfigurationException หากโหลดการกำหนดค่าอย่างน้อย 1 รายการไม่สำเร็จ

printHelp

public void printHelp (PrintStream out)

พิมพ์เอาต์พุตวิธีใช้สำหรับ Factory นี้

พิมพ์ข้อมูลความช่วยเหลือทั่วไปและแสดงรายการการกำหนดค่าที่มีทั้งหมด

พารามิเตอร์
out PrintStream: PrintStream ที่จะดัมพ์เอาต์พุตไป

printHelpForConfig

public void printHelpForConfig (String[] args, 
                boolean importantOnly, 
                PrintStream out)

พิมพ์เอาต์พุตความช่วยเหลือสำหรับ IConfiguration ที่ระบุในอาร์กิวเมนต์บรรทัดคำสั่ง

หาก "args" อ้างอิงถึงการกำหนดค่าที่รู้จัก ระบบจะสร้างออบเจ็กต์ IConfiguration จาก XML และแสดงความช่วยเหลือสำหรับ IConfiguration นั้น โปรดทราบว่าระบบจะไม่สนใจค่า "args" อื่นๆ ทั้งหมด (เช่น ข้อความช่วยเหลือจะอธิบายค่าปัจจุบันของ Options ที่โหลดจาก XML และจะไม่แสดงค่าของตัวเลือกที่ตั้งค่าโดยอาร์กิวเมนต์บรรทัดคำสั่ง

หาก "args" ไม่ได้อ้างอิงถึง IConfiguration ที่รู้จัก ระบบจะแสดงความช่วยเหลือทั่วไปของ printHelp(PrintStream)

พารามิเตอร์
args String: อาร์กิวเมนต์บรรทัดคำสั่ง
importantOnly boolean: หากเป็น true ให้พิมพ์รายการความช่วยเหลือแบบย่อซึ่งมีเฉพาะรายละเอียดที่สำคัญ
out PrintStream: PrintStream ที่จะดัมพ์เอาต์พุตไป

วิธีการที่ได้รับการป้องกัน

getBundledConfigStream

protected InputStream getBundledConfigStream (String name)

พารามิเตอร์
name String

การคืนสินค้า
InputStream

getConfigPrefix

protected String getConfigPrefix ()

ส่งคืนคำนำหน้าเส้นทางของไฟล์ XML การกำหนดค่าใน Classpath

แสดงเพื่อให้การทดสอบหน่วยสามารถจำลองได้

การคืนสินค้า
String String เส้นทางที่มี / ต่อท้าย

getConfigStream

protected BufferedInputStream getConfigStream (String name)

โหลด InputStream สำหรับชื่อการกำหนดค่าที่ระบุ

พารามิเตอร์
name String: ชื่อการกำหนดค่าที่จะโหลด
การคืนสินค้า
BufferedInputStream BufferedInputStream สำหรับอ่านเนื้อหาการกำหนดค่า
ส่ง
ConfigurationException หากไม่พบการกำหนดค่า

getConfigurationDef

protected ConfigurationDef getConfigurationDef (String name, 
                boolean isGlobal, 
                Map<String, String> templateMap)

ดึงข้อมูล ConfigurationDef สำหรับชื่อที่ระบุ

พารามิเตอร์
name String: ชื่อของการกำหนดค่าในตัวที่จะโหลดหรือเส้นทางไฟล์ไปยังไฟล์กำหนดค่า ที่จะโหลด
isGlobal boolean

templateMap Map

การคืนสินค้า
ConfigurationDef ConfigurationDef
ส่ง
ConfigurationException หากเกิดข้อผิดพลาดขณะโหลดการกำหนดค่า

getMapConfig

protected Map<ConfigurationFactory.ConfigId, ConfigurationDef> getMapConfig ()

แสดงสำหรับการทดสอบ ส่งคืนสำเนาของแผนที่

การคืนสินค้า
Map<ConfigurationFactory.ConfigId, ConfigurationDef>

isDirectConfiguration

protected boolean isDirectConfiguration (String configName)

พารามิเตอร์
configName String

การคืนสินค้า
boolean

reorderArgs

protected String[] reorderArgs (String[] args)

จัดเรียงอาร์กิวเมนต์ใหม่เพื่อให้ย้ายอาร์กิวเมนต์ template:map ทั้งหมดไปไว้ด้านหน้า

พารามิเตอร์
args String

การคืนสินค้า
String[]

resolveRemoteFile

protected IRemoteFileResolver.ResolvedFile resolveRemoteFile (URI configURI, 
                URI destDir)

พารามิเตอร์
configURI URI

destDir URI

การคืนสินค้า
IRemoteFileResolver.ResolvedFile

ส่ง
BuildRetrievalError