การกำหนดค่าโรงงาน

public class ConfigurationFactory
extends Object implements IConfigurationFactory

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


โรงงานสำหรับสร้าง IConfiguration

สรุป

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

class ConfigurationFactory.ConfigLoader

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

class ConfigurationFactory.ExceptionLoader

ตัวสร้างที่ได้รับการคุ้มครอง

ConfigurationFactory ()

วิธีการสาธารณะ

void clearMapConfig ()

ในบางกรณี เราต้องเคลียร์แผนที่

IConfiguration createConfigurationFromArgs (String[] arrayArgs, unconsumedArgs) createConfigurationFromArgs (String[] arrayArgs, unconsumedArgs)

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

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

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

IConfiguration createConfigurationFromArgs (String[] arrayArgs)

วิธีการอำนวยความสะดวกที่เรียก ERROR(/#createConfigurationFromArgs(String[],List)) ด้วยอาร์กิวเมนต์วินาที null

IGlobalConfiguration createGlobalConfigurationFromArgs (String[] arrayArgs, remainingArgs) createGlobalConfigurationFromArgs (String[] arrayArgs, remainingArgs)

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

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

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

void dumpConfig (String configName, PrintStream out)

ดัมพ์เนื้อหาของการกำหนดค่าไปยัง ERROR(/PrintStream) ที่กำหนด

getConfigList (String subPath, boolean loadFromEnv)

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

getConfigList ()

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

static IConfigurationFactory getInstance ()

รับอินสแตนซ์ IConfigurationFactory ซิงเกิลตัน

void loadAllConfigs (boolean discardExceptions)

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

void loadAndPrintAllConfigs ()

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

void printHelp (PrintStream out)

พิมพ์ความช่วยเหลือเอาต์พุตสำหรับโรงงานนี้

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

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

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

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

InputStream getBundledConfigStream (String name)
String getConfigPrefix ()

ส่งคืนคำนำหน้าเส้นทางของไฟล์ config xml บน classpath

เปิดเผยเพื่อให้การทดสอบหน่วยสามารถเยาะเย้ยได้

BufferedInputStream getConfigStream (String name)

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

ConfigurationDef getConfigurationDef (String name, boolean isGlobal, templateMap) getConfigurationDef (String name, boolean isGlobal, templateMap)

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

getMapConfig ()

เปิดเผยสำหรับการทดสอบ

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

เรียงลำดับ args ใหม่เพื่อให้ template:map args ทั้งหมดย้ายไปอยู่ด้านหน้า

IRemoteFileResolver.ResolvedFile resolveRemoteFile (URI configURI, URI destDir)

ตัวสร้างที่ได้รับการคุ้มครอง

การกำหนดค่าโรงงาน

protected ConfigurationFactory ()

วิธีการสาธารณะ

clearMapConfig

public void clearMapConfig ()

ในบางกรณี เราต้องเคลียร์แผนที่

createConfigurationFromArgs

public IConfiguration createConfigurationFromArgs (String[] arrayArgs, 
                 unconsumedArgs)

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

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

พารามิเตอร์
arrayArgs String : อาร์กิวเมนต์บรรทัดคำสั่ง

unconsumedArgs : รายการซึ่งจะถูกเติมด้วยอาร์กิวเมนต์ที่ไม่ได้ใช้โดยออบเจ็กต์ที่เกี่ยวข้องกับการกำหนดค่าที่ระบุ หากเป็น null การใช้งานจะโยน ConfigurationException หากยังมี args ที่ยังไม่ได้ประมวลผลอยู่

การส่งคืน
IConfiguration IConfiguration ที่โหลด ฟิลด์ Option วัตถุผู้รับมอบสิทธิ์ได้รับการเติมด้วยค่าใน args

ขว้าง
ConfigurationException

createConfigurationFromArgs

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

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

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

พารามิเตอร์
arrayArgs String : อาร์กิวเมนต์บรรทัดคำสั่ง

unconsumedArgs : รายการซึ่งจะถูกเติมด้วยอาร์กิวเมนต์ที่ไม่ได้ใช้โดยออบเจ็กต์ที่เกี่ยวข้องกับการกำหนดค่าที่ระบุ หากเป็น null การใช้งานจะโยน ConfigurationException หากยังมี args ที่ยังไม่ได้ประมวลผลอยู่

keyStoreClient IKeyStoreClient : IKeyStoreClient ซึ่งใช้เพื่อรับข้อมูลที่ละเอียดอ่อนใน args

การส่งคืน
IConfiguration IConfiguration ที่โหลด ฟิลด์ Option วัตถุผู้รับมอบสิทธิ์ได้รับการเติมด้วยค่าใน args

ขว้าง
ConfigurationException

createConfigurationFromArgs

public IConfiguration createConfigurationFromArgs (String[] arrayArgs)

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

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

การส่งคืน
IConfiguration

ขว้าง
ConfigurationException

createGlobalConfigurationFromArgs

public IGlobalConfiguration createGlobalConfigurationFromArgs (String[] arrayArgs, 
                 remainingArgs)

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

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

พารามิเตอร์
arrayArgs String : อาร์กิวเมนต์บรรทัดคำสั่ง

remainingArgs : รายการซึ่งจะถูกเติมด้วยอาร์กิวเมนต์ที่ไม่ได้รับการประมวลผลเป็นอาร์กิวเมนต์ร่วม

การส่งคืน
IGlobalConfiguration IGlobalConfiguration ที่โหลดแล้ว ฟิลด์ Option วัตถุผู้รับมอบสิทธิ์ได้รับการเติมด้วยค่าใน args

ขว้าง
ConfigurationException

createPartialConfigurationFromArgs

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

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

พารามิเตอร์
arrayArgs String : อาร์กิวเมนต์บรรทัดคำสั่ง

keyStoreClient IKeyStoreClient : IKeyStoreClient ซึ่งใช้เพื่อรับข้อมูลที่ละเอียดอ่อนใน args

allowedObjects : ชุดของวัตถุที่อนุญาตให้สร้าง

delegator TradefedDelegator

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

ขว้าง
ConfigurationException

dumpConfig

public void dumpConfig (String configName, 
                PrintStream out)

ดัมพ์เนื้อหาของการกำหนดค่าไปยัง ERROR(/PrintStream) ที่กำหนด

พารามิเตอร์
configName String : ชื่อการกำหนดค่า

out PrintStream : ERROR(/PrintStream) ที่จะถ่ายโอนข้อมูลเอาต์พุตไปที่

getConfigList

public  getConfigList (String subPath, 
                boolean loadFromEnv)

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

พารามิเตอร์
subPath String : ชื่อของไดเร็กทอรีย่อยที่ต้องการค้นหาเพื่อกำหนดค่า หากเป็นค่าว่าง จะมีพฤติกรรมเหมือนกับ getConfigList()

loadFromEnv boolean : เป็นจริงหากเราควรโหลดการกำหนดค่าในตัวแปรสภาพแวดล้อม

การส่งคืน

getConfigList

public  getConfigList ()

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

การส่งคืน

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

public static IConfigurationFactory getInstance ()

รับอินสแตนซ์ IConfigurationFactory ซิงเกิลตัน

การส่งคืน
IConfigurationFactory

โหลด AllConfigs

public void loadAllConfigs (boolean discardExceptions)

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

พารามิเตอร์
discardExceptions boolean : จริงหากควรละเว้น ConfigurationException ใด ๆ

ขว้าง
com.android.tradefed.config.ConfigurationException
ConfigurationException

loadAndPrintAllConfigs

public void loadAndPrintAllConfigs ()

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

ขว้าง
ConfigurationException หากไม่สามารถโหลดการกำหนดค่าอย่างน้อยหนึ่งรายการ

พิมพ์ช่วยเหลือ

public void printHelp (PrintStream out)

พิมพ์ความช่วยเหลือเอาต์พุตสำหรับโรงงานนี้

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

พารามิเตอร์
out PrintStream : ERROR(/PrintStream) ที่จะถ่ายโอนข้อมูลเอาต์พุตไปที่

printHelpForConfig

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

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

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

หาก 'args' ไม่ได้อ้างอิงถึง IConfiguration ที่รู้จัก วิธีใช้ printHelp(PrintStream) ทั่วไปจะปรากฏขึ้น

พารามิเตอร์
args String : อาร์กิวเมนต์บรรทัดคำสั่ง

importantOnly boolean : หาก true ให้พิมพ์วิธีใช้แบบย่อโดยระบุเฉพาะรายละเอียดที่สำคัญ

out PrintStream : ERROR(/PrintStream) ที่จะถ่ายโอนข้อมูลเอาต์พุตไปที่

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

getBundledConfigStream.getBundledConfigStream

protected InputStream getBundledConfigStream (String name)

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

การส่งคืน
InputStream

getConfigPrefix

protected String getConfigPrefix ()

ส่งคืนคำนำหน้าเส้นทางของไฟล์ config xml บน classpath

เปิดเผยเพื่อให้การทดสอบหน่วยสามารถเยาะเย้ยได้

การส่งคืน
String เส้นทาง String พร้อมส่วนท้าย /

getConfigStream

protected BufferedInputStream getConfigStream (String name)

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

พารามิเตอร์
name String : ชื่อการกำหนดค่าที่จะโหลด

การส่งคืน
BufferedInputStream ERROR(/BufferedInputStream) สำหรับการอ่านเนื้อหาการกำหนดค่า

ขว้าง
ConfigurationException หากไม่พบการกำหนดค่า

รับการกำหนดค่าDef

protected ConfigurationDef getConfigurationDef (String name, 
                boolean isGlobal, 
                 templateMap)

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

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

isGlobal boolean

templateMap

การส่งคืน
ConfigurationDef ConfigurationDef

ขว้าง
ConfigurationException หากเกิดข้อผิดพลาดในการโหลดการกำหนดค่า

getMapConfig

protected  getMapConfig ()

เปิดเผยสำหรับการทดสอบ ส่งสำเนาแผนที่กลับมา

การส่งคืน

คือการกำหนดค่าโดยตรง

protected boolean isDirectConfiguration (String configName)

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

การส่งคืน
boolean

จัดลำดับ Args ใหม่

protected String[] reorderArgs (String[] args)

เรียงลำดับ args ใหม่เพื่อให้ template:map args ทั้งหมดย้ายไปอยู่ด้านหน้า

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

การส่งคืน
String[]

แก้ไข RemoteFile

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

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

destDir URI

การส่งคืน
IRemoteFileResolver.ResolvedFile

ขว้าง
BuildRetrievalError