ภารกิจ Ant สำหรับการไม่ยอมรับ API

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

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

Usage

Description

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

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

พารามิเตอร์

แอ็ตทริบิวต์ คำอธิบาย ต้องการ
baseline แอ็ตทริบิวต์นี้ระบุตำแหน่งของการอ้างอิงพื้นฐาน

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

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

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

ตำแหน่งที่ระบุโดยใช้พาธสัมบูรณ์
Yes
report ตั้งค่าตำแหน่งเอาต์พุตที่รายงานถูกสร้างขึ้น

เมื่อภารกิจเสร็จสิ้นแล้ว รายงานจะพร้อมใช้งานอยู่ในไดเร็กทอรีโดยใช้โครงสร้างเดียวกับ root ของตัวกรอง โฟลเดอร์ย่อยถูกสร้างขึ้น สำหรับคอมโพเนนต์แต่ละตัวที่มีปัญหาที่ต้องรายงาน แต่ละโฟลเดอร์ย่อยมีไฟล์ที่เรียกว่า "report.xml"

โฟลเดอร์พิเศษเรียกว่า "allNonApiBundles" ยังถูกสร้างขึ้นในโฟลเดอร์ที่มีไฟล์ที่เรียกว่า "report.xml" ไฟล์นี้จะแสดงรายการบันเดิลทั้งหมดที่ไม่ใช้ลักษณะของเครื่องมือ API

ตำแหน่งที่ระบุโดยใช้พาธสัมบูรณ์
Yes
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;
 # DOC BUNDLES
 org.eclipse.jdt.doc.isv
 org.eclipse.jdt.doc.user
 org.eclipse.pde.doc.user
 org.eclipse.platform.doc.isv
 org.eclipse.platform.doc.user
 # NON-ECLIPSE BUNDLES
 com.ibm.icu
 com.jcraft.jsch
 javax.servlet
 javax.servlet.jsp
 ...
รายการที่แยกออกสามารถมีนิพจน์ทั่วไป ถ้าบรรทัดเริ่มต้นด้วย "R:".
No
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;
 # DOC BUNDLES
 org.eclipse.jdt.doc.isv
 org.eclipse.jdt.doc.user
 org.eclipse.pde.doc.user
 org.eclipse.platform.doc.isv
 org.eclipse.platform.doc.user
 # NON-ECLIPSE BUNDLES
 com.ibm.icu
 com.jcraft.jsch
 javax.servlet
 javax.servlet.jsp
 ...
No
ดีบัก ตั้งค่าดีบัก

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

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

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

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

ตัวอย่าง

 <apitooling.apideprecation
  baseline="D:\eclipse\3.4.1\eclipse"
  profile="D:\eclipse-SDK-I20081118-0800-linux-gtk.tar.gz"

  report="D:\reports\xml"
  excludelist="D:\exclude_list_external.txt"
  debug="true"
 />

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

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

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

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