Find JSRs
Submit this Search


Ad Banner
 
 
 
 

Summary  |  Proposal  |  Detail (Summary & Proposal)
JSRs: Java Specification Requests
JSR 269: Pluggable Annotation Processing API

Stage Access Start Finish
Maintenance Release 2 Download page 04 Mar, 2014  
Maintenance Review Ballot View results 07 Jan, 2014 13 Jan, 2014
Maintenance Draft Review 2 Download page 20 Nov, 2013 20 Dec, 2013
Maintenance Release Download page 07 Nov, 2011  
Maintenance Draft Review Download page 11 Mar, 2011 25 Apr, 2011
Final Release Download page 11 Dec, 2006  
Final Approval Ballot View results 24 Oct, 2006 06 Nov, 2006
Proposed Final Draft Download page 18 Sep, 2006  
Public Review Ballot View results 13 Jun, 2006 19 Jun, 2006
Public Review Download page 17 May, 2006 19 Jun, 2006
Early Draft Review Download page 30 Jun, 2005 01 Aug, 2005
Expert Group Formation   15 Feb, 2005 02 Mar, 2005
JSR Review Ballot View results 01 Feb, 2005 14 Feb, 2005
Status: Active
JCP version in use: 2.9
Java Specification Participation Agreement version in use: 2.0


Description:
Provide an API to allow the processing of JSR 175 annotations (metadata); this will require modeling elements of the Java(TM) programming language as well as processing-specific functionality.

Expert Group Transparency:
  Public Communications
  Issue Tracking

Team

Specification Leads
  Joe Darcy Oracle
Expert Group
  BEA Systems
: Tim Wagner
Bruce Chapman Google Inc.
: Bob Lee
  Doug Lea Niemeyer, Patrick D. Oracle
: Joe Darcy
  Oracle
: Michel Trudeau
Sun Microsystems, Inc.
: Joe Darcy

Updates to the Original JSR

The following updates have been made to the original request.

2013.10.21:
The Maintenance of JSR 269 was moved to JCP 2.9.

2.19 Please describe the communications channel you have established for the public to observe Expert Group deliberations, provide feedback, and view archives of all Expert Group communications.

Interested parties can submit issues at bugs.sun.com, which will be filtered into JBS, the JDK Bug System hosted at https://bugs.openjdk.java.net.

2.20 What is the URL of the Issue Tracker that the public can read, and how does the public log issues in the Issue Tracker?

The JSR 269 related issues in JBS

2.21 Please provide the location of the publicly accessible document archive you have created for the Expert Group.

Since JSR 269 is in maintenance, there is no expert group.

2010.02.15
Oracle took over as Maintenance Lead from Sun Microsystems.

Maintenance Lead: Oracle America, Inc.

Contact: Joe Darcy

E-mail address: joe.darcy@oracle.com

Telephone: +1 408 276 7053

2006.10.24

2.18 Please provide a description of the business terms for the Specification, RI and TCK that will apply when this JSR is final.

Sun will license the RI binary for this JSR free of charge.

This JSR will be included in the Java SE 6 platform release. The JSR TCK will thus be licensed as part of the Java SE 6 TCK under the terms described in the JSR-270 business terms.

Sun will license the standalone TCK for this JSR for a flat fee of $50 K. In addition, Sun will make the standalone TCK available for no charge to Java SE TCK licensees, qualified individuals and not for profit organizations.

2006.10.12

2.16 Please describe how the RI and TCK will de delivered, i.e. as part of a profile or platform edition, or stand-alone, or both. Include version information for the profile or platform in your answer.

We plan to include the RI and TCK as part of Java SE 6 as well as making the TCK available standalone.

2.18 Please provide a description of the business terms for the Specification, RI and TCK that will apply when this JSR is final.

Sun will license the RI binary for this JSR free of charge.

This JSR will be included in the Java SE 6 platform release. The JSR TCK will thus be licensed as part of the Java SE 6 TCK under the terms described in the JSR-270 business terms.

Sun will license the standalone TCK for this JSR for a flat fee of $50 K. In addition, Sun will make the standalone TCK available for no charge to Java SE TCK licensees, qualified individuals and not for profit organizations.


Original Java Specification Request (JSR)

Identification | Request | Contributions | Additional Information

Section 1. Identification

Submitting Member: Sun Microsystems, Inc

Name of Contact Person: Joseph D. Darcy

E-Mail Address: joe.darcy@sun.com

Telephone Number: +1 408 276 7053

Fax Number: +1 408 276 7700


Specification Lead: Joseph D. Darcy

E-Mail Address: joe.darcy@sun.com

Telephone Number: +1 408 276 7053

Fax Number: +1 408 276 7700


Initial Expert Group Membership:

BEA
Google
Oracle
Doug Lea
Bruce Chapman

Supporting this JSR:

Google
Oracle
Doug Lea



Section 2: Request

2.1 Please describe the proposed Specification:

J2SE 1.5 added a new Java language mechanism "annotations" that allows annotation types to be used to annotate classes, fields, and methods. These annotations are typically processed either by build-time tools or by run-time libraries to achieve new semantic effects. In order to support annotation processing at build-time, this JSR will define APIs to allow annotation processors to be created using a standard pluggable API. This will simplify the task of creating annotation processors and will also allow automation of the discovery of appropriate annotation processors for a given source file.

The specification will include at least two sections, a section of API modeling the Java programming language and a distinct section for declaring annotation processors and controlling how they are run. Since annotations are placed on program elements, an annotation processing framework needs to reflect program structure. Annotation processors will be able to specify what annotations they process and multiple processors will be able to run cooperatively.

The processors and program structure api can be accessed at build-time; i.e. this functionality supplements core reflection support for reading annotations.

2.2 What is the target Java platform? (i.e., desktop, server, personal, embedded, card, etc.)

J2SE

2.3 The Executive Committees would like to ensure JSR submitters think about how their proposed technology relates to all of the Java platform editions. Please provide details here for which platform editions are being targeted by this JSR, and how this JSR has considered the relationship with the other platform editions.

Just as JSR 175 was delivered in J2SE with extensive expected use by J2EE, this JSR is being submitted to the J2SE EC although we expect the functionality in this JSR to be heavily used by J2EE.

2.4 Should this JSR be voted on by both Executive Committees?

No

2.5 What need of the Java community will be addressed by the proposed specification?

Standardized annotation processing mechanism for build-time annotation processing.

2.6 Why isn't this need met by existing specifications?

A standardized build-time annotation processing mechanism was not included in JDK5 coincident with shipping JSR175. The core reflection support for reading annotations does not allow annotations to be read from source code (or the reading of source-only annotations). The javadoc API does not directly support running multiple pluggable modules based on what annotations are present.

2.7 Please give a short description of the underlying technology or technologies:

In order to realize the full benefits of annotations, a standardized mechanism is necessary to process them in contexts other than a running jvm. Since annotations are added to declarations (classes, methods, fields, etc.), the API needs to include a model of program structure. Additionally, the processors for different annotations should be able to work cooperatively and the set of processors that are run should be able to depend on what annotations are present in the code being processed.

2.8 Is there a proposed package name for the API Specification? (i.e., javapi.something, org.something, etc.)

All the API elements are expected to reside in the javax namespace; the language modeling portions of the API might be called javax.mirror.declaration, javax.mirror.type, etc. while the processing related portions of the API might be called javax.annotation.processing.

2.9 Does the proposed specification have any dependencies on specific operating systems, CPUs, or I/O devices that you know of?

No

2.10 Are there any security issues that cannot be addressed by the current security model?

None known.

2.11 Are there any internationalization or localization issues?

No i18n or l10n issue beyond localizing messages in the implementation.

2.12 Are there any existing specifications that might be rendered obsolete, deprecated, or in need of revision as a result of this work?

The intent is to supersede the com.sun.mirror.* APIs and the apt tool shipped as part of Sun's JDK 5.

2.13 Please describe the anticipated schedule for the development of this specification.

The intention is to deliver this JSR as part of the Mustang umbrella JSR. Early review would occur in May 2005, Public Preview in October 2005, and Proposed Final Draft in February 2006.

2.14 Please describe the anticipated working model for the Expert Group working on developing this specification.

A mailing list is intended to be the primary communication mechanism among members of the expert group. Conference calls may be used on an as-needed basis.

2.15 It is important to the success of the community and each JSR that the work of the Expert Group be handled in a manner which provides the community and the public with insight into the work the Expert Group is doing, and the decisions that the Expert Group has made. The Executive Committees would like to ensure Spec Leads understand the value of this transparency and ask that each JSR have an operating plan in place for how their JSR will address the involvement of the community and the public. Please provide your plan here, and refer to the Spec Lead Guide for a more detailed description and a set of example questions you may wish to answer in your plan.

We anticipate providing draft specs every two to three months after the first draft is released until the Proposed Final Draft. A JSR interest mailing list will be established so interested parties can be informed of issues under discussion.

2.16 Please describe how the RI and TCK will de delivered, i.e. as part of a profile or platform edition, or stand-alone, or both. Include version information for the profile or platform in your answer.

This JSR and its RI and TCK are intended to be part of the Mustang RI and TCK, respectively.

NOTE that this section has been updated from this original request.

2.17 Please state the rationale if previous versions are available stand-alone and you are now proposing in 2.13 to only deliver RI and TCK as part of a profile or platform edition (See sections 1.1.5 and 1.1.6 of the JCP 2 document).

Not applicable.

2.18 Please provide a description of the business terms for the Specification, RI and TCK that will apply when this JSR is final.

The RI and TCK will be delivered and licensed as part of the RI and TCK for Mustang.

NOTE that this section has been updated from this original request.



Section 3: Contributions

3.1 Please list any existing documents, specifications, or implementations that describe the technology. Please include links to the documents if they are publicly available.

This JSR is targeting the same general functionality as the apt tool, http://java.sun.com/j2se/1.5.0/docs/guide/apt/index.html. It is expected the API included in this JSR will resemble but not necessarily be compatible with the existing apt API.

We expect some coordination with JSR199 to avoid designing overlapping functionality.

3.2 Explanation of how these items might be used as a starting point for the work.

Users of apt have identified several limitations to the API; this feedback should be considered by the expert group.



Section 4: Additional Information (Optional)

4.1 This section contains any additional information that the submitting Member wishes to include in the JSR.