ภารกิจ Ant สำหรับ API Freeze

วัตถุประสงค์

ภารกิจนี้ระบุ APIs ที่เพิ่ม ปรับเปลี่ยน หรือถอนความสัมพันธ์กับ API พื้นฐาน ภารกิจนี้มีเจตนาที่จะตรวจสอบความถูกต้องของการเปลี่ยนแปลง API ที่ไม่ได้เกิดขึ้นหลังจาก API freeze

การใช้งาน

คำอธิบาย

ชื่อภารกิจ Ant คือ: apitooling.apifreeze. เมื่อต้องการใช้ ไฟล์ jar apitooling-ant.jar ต้องอยู่บน Ant classpath

<apitooling.apifreeze
	baseline="..."
	profile="..."
	report="..."
	excludelist="..."
	includelist="..."
	debug="..."
	eefile="..."
/>

พารามิเตอร์

แอ็ตทริบิวต์ รายละเอียด จำเป็นต้องมี
baseline แอ็ตทริบิวต์นี้ระบุตำแหน่งของการอ้างอิงพื้นฐาน

ซึ่งสามารถเป็นไฟล์ .zip, .jar, .tgz, .tar.gz หรือไดเร็กทอรีที่สอดคล้องกับโฟลเดอร์การติดตั้ง Eclipse นี่คือไดเร็กทอรี ที่คุณสามารถค้นหาโปรแกรมเรียกทำงาน Eclipse

ตำแหน่งที่ระบุโดยใช้พาธสัมบูรณ์
ใช่
โปรไฟล์ แอ็ตทริบิวต์นี้ระบุตำแหน่งของผลิตภัณฑ์หรือโปรไฟล์ปัจจุบันที่คุณต้องการเปรียบเทียบกับการอ้างอิงพื้นฐาน

ซึ่งสามารถเป็นไฟล์ .zip, .jar, .tgz, .tar.gz หรือไดเร็กทอรีที่สอดคล้องกับโฟลเดอร์การติดตั้ง Eclipse นี่คือไดเร็กทอรี ที่คุณสามารถค้นหาโปรแกรมเรียกทำงาน Eclipse

ตำแหน่งที่ระบุโดยใช้พาธสัมบูรณ์
ใช่
รายงาน ตั้งค่าชื่อของไฟล์รายงานที่ต้องการสร้าง

ควรระบุไว้โดยใช้พาธสัมบูรณ์
ซึ่งต้องเป็นตำแหน่งของไฟล์ ไม่ใช่ไดเร็กทอรี
ใช่
excludelist ตั้งค่าการแยกตำแหน่งรายการ

การแยกตำแหน่งรายการจะระบุไฟล์ข้อความที่แสดงรายการบันเดิลที่จะถูกแยกออกจากการวิเคราะห์ โดยดีฟอลต์บันเดิลทั้งหมดในโปรไฟล์จะถูกวิเคราะห์ แอ็ตทริบิวต์รายการที่ถูกรวมและถูกแยกสามารถถูกใช้เพื่อเลือกบันเดิลที่จะรวมหรือแยก นอกจากนี้ งานนี้จะสนับสนุนการแสดงรายการสมาชิกในรายการรวมและแยก รายการที่รวมจะ seed ชุดของบันเดิลและสมาชิกที่จะถูกวิเคราะห์ (เมื่อปล่อยไว้บันเดิลและสมาชิกทั้งหมดจะถูกรวม) และรายการที่แยกออกจะถูกนำมาใช้ แต่ละบรรทัดของไฟล์จะระบุสิ่งต่อไปนี้:
  • ชื่อบันเดิลที่ระบุ
  • ชื่อสมาชิกที่ระบุ
  • นิพจน์ทั่วไปเพื่อจับคู่กับชื่อบันเดิลและสมาชิก (บรรทัดที่มี "R:")
  • หมายเหตุ (บรรทัดที่มี '#')

ตำแหน่งที่ระบุโดยใช้พาธสัมบูรณ์
ต่อไปนี้เป็นตัวอย่างของรายการที่ถูกแยกออก:
# ECLIPSE MEMBERS
org.eclipse.jface.databinding_1.2.0:org.eclipse.jface.databinding.viewers.ObservableListContentProvider#getElements(Ljava/lang/Object;)[Ljava/lang/Object;
# ECLIPSE BUNDLES
org.eclipse.ui.workbench_3.4.0:org.eclipse.ui.ISharedImages#IMG_DEC_FIELD_ERROR
org.eclipse.ui.workbench_3.4.0:org.eclipse.ui.ISharedImages#IMG_DEC_FIELD_WARNING
org.eclipse.ui.workbench_3.4.0:org.eclipse.ui.ISharedImages#IMG_ELCL_COLLAPSEALL
# NON-ECLIPSE BUNDLES
com.ibm.icu
R:javax\..*
...
ไม่ใช่
includelist ตั้งตำแหน่งรานการที่รวม

ตำแหน่งของรายการที่รวมจะระบุไฟล์ข้อความที่แสดงรายการบันเดิลที่จะถูกรวมในการวิเคราะห์ โดยดีฟอลต์บันเดิลทั้งหมดในโปรไฟล์จะถูกวิเคราะห์ แอ็ตทริบิวต์รายการที่ถูกรวมและถูกแยกสามารถถูกใช้เพื่อเลือกบันเดิลที่จะรวมหรือแยก นอกจากนี้ งานนี้จะสนับสนุนการแสดงรายการสมาชิกในรายการรวมและแยก รายการที่รวมจะ seed ชุดของบันเดิลและสมาชิกที่จะถูกวิเคราะห์ (เมื่อปล่อยไว้บันเดิลและสมาชิกทั้งหมดจะถูกรวม) และรายการที่แยกออกจะถูกนำมาใช้ แต่ละบรรทัดของไฟล์จะระบุสิ่งต่อไปนี้:
  • ชื่อบันเดิลที่ระบุ
  • ชื่อสมาชิกที่ระบุ
  • นิพจน์ทั่วไปเพื่อจับคู่กับชื่อบันเดิลและสมาชิก (บรรทัดที่มี "R:")
  • หมายเหตุ (บรรทัดที่มี '#')

ตำแหน่งที่ระบุโดยใช้พาธสัมบูรณ์
ต่อไปนี้เป็นตัวอย่างของรายการที่ถูกรวม:
# ECLIPSE MEMBERS
org.eclipse.jface.databinding_1.2.0:org.eclipse.jface.databinding.viewers.ObservableListContentProvider#getElements(Ljava/lang/Object;)[Ljava/lang/Object;
# ECLIPSE BUNDLES
org.eclipse.ui.workbench_3.4.0:org.eclipse.ui.ISharedImages#IMG_DEC_FIELD_ERROR
org.eclipse.ui.workbench_3.4.0:org.eclipse.ui.ISharedImages#IMG_DEC_FIELD_WARNING
org.eclipse.ui.workbench_3.4.0:org.eclipse.ui.ISharedImages#IMG_ELCL_COLLAPSEALL
# NON-ECLIPSE BUNDLES
com.ibm.icu
R:javax\..*
...
ไม่ใช่
ดีบัก ตั้งค่าดีบัก

ค่าที่เป็นไปได้คือ: true, false
ค่าดีฟอลต์คือ false
ไม่ใช่
eefile ตั้งค่าไฟล์สภาวะแวดล้อมการเรียกใช้งานเพื่อใช้

ตามค่าดีฟอลต์ ไฟล์สภาวะแวดล้อมการเรียกใช้งานสอดคล้องกับสภาวะแวดล้อมแบบ JavaSE-1.6 ถูกนำมาใช้

รูปแบบของไฟล์ที่กล่าวถึงใน หน้าวิกินี้

ไฟล์ถูกระบุไว้โดยใช้พาธสัมบูรณ์
ไม่ใช่

ตัวอย่าง

	<apitooling.apifreeze
		baseline="D:\eclipse\3.4.1\eclipse"
		profile="D:\eclipse-SDK-I20081118-0800-linux-gtk.tar.gz"
		report="D:\report\report.xml"
		excludelist="D:\exclude_list.txt"
		debug="true"
	/>

รันภารกิจการสร้าง report.xml ภายในโฟลเดอร์ D:\report ซึ่งจะใช้รายการที่แยกออกและ D:\exclude_list_external.txt เพื่อลดจำนวนของปัญหาที่รายงาน

เนื่องจากเปิดใช้งานดีบัก การติดตามการดีบักบางตัวจะแสดงอยู่ในคอนโซล Ant

การอ้างถึงที่เกี่ยวข้อง

ภารกิจ Ant สำหรับการวิเคราะห์
ภารกิจ Ant สำหรับการสร้างไฟล์
ภารกิจ Ant สำหรับการใช้ API
ภารกิจ Ant สำหรับการแปลงรายงานการวิเคราะห์
ภารกิจ Ant สำหรับการแปลงรายงาน API Freeze
ภารกิจ Ant สำหรับการไม่ยอมรับ API
ภารกิจ Ant สำหรับการแปลงรายงานการไม่ยอมรับ API
ภารกิจ Ant สำหรับการแปลงรายงานการใช้ API