001: /*
002: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003: *
004: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005: *
006: * The contents of this file are subject to the terms of either the GNU
007: * General Public License Version 2 only ("GPL") or the Common Development
008: * and Distribution License("CDDL") (collectively, the "License"). You
009: * may not use this file except in compliance with the License. You can obtain
010: * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
011: * or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
012: * language governing permissions and limitations under the License.
013: *
014: * When distributing the software, include this License Header Notice in each
015: * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
016: * Sun designates this particular file as subject to the "Classpath" exception
017: * as provided by Sun in the GPL Version 2 section of the License file that
018: * accompanied this code. If applicable, add the following below the License
019: * Header, with the fields enclosed by brackets [] replaced by your own
020: * identifying information: "Portions Copyrighted [year]
021: * [name of copyright owner]"
022: *
023: * Contributor(s):
024: *
025: * If you wish your version of this file to be governed by only the CDDL or
026: * only the GPL Version 2, indicate your decision by adding "[Contributor]
027: * elects to include this software in this distribution under the [CDDL or GPL
028: * Version 2] license." If you don't indicate a single choice of license, a
029: * recipient has the option to distribute your version of this file under
030: * either the CDDL, the GPL Version 2 or to extend the choice of license to
031: * its licensees as provided above. However, if you add GPL Version 2 code
032: * and therefore, elected the GPL Version 2 license, then the option applies
033: * only if the new code is made subject to such option by the copyright
034: * holder.
035: */
036:
037: package com.sun.tools.xjc.addon.at_generated;
038:
039: import java.text.SimpleDateFormat;
040: import java.util.Date;
041:
042: import com.sun.codemodel.JAnnotatable;
043: import com.sun.codemodel.JClass;
044: import com.sun.codemodel.JFieldVar;
045: import com.sun.codemodel.JMethod;
046: import com.sun.tools.xjc.Driver;
047: import com.sun.tools.xjc.Options;
048: import com.sun.tools.xjc.Plugin;
049: import com.sun.tools.xjc.outline.ClassOutline;
050: import com.sun.tools.xjc.outline.EnumOutline;
051: import com.sun.tools.xjc.outline.Outline;
052:
053: import org.xml.sax.ErrorHandler;
054:
055: /**
056: * {@link Plugin} that marks the generated code by using JSR-250's '@Generated'.
057: *
058: * @author Kohsuke Kawaguchi
059: */
060: public class PluginImpl extends Plugin {
061:
062: public String getOptionName() {
063: return "mark-generated";
064: }
065:
066: public String getUsage() {
067: return " -mark-generated : mark the generated code as @javax.annotation.Generated";
068: }
069:
070: private JClass annotation;
071:
072: public boolean run(Outline model, Options opt,
073: ErrorHandler errorHandler) {
074: // we want this to work without requiring JSR-250 jar.
075: annotation = model.getCodeModel().ref(
076: "javax.annotation.Generated");
077:
078: for (ClassOutline co : model.getClasses())
079: augument(co);
080: for (EnumOutline eo : model.getEnums())
081: augument(eo);
082:
083: //TODO: process generated ObjectFactory classes?
084:
085: return true;
086: }
087:
088: private void augument(EnumOutline eo) {
089: annotate(eo.clazz);
090: }
091:
092: /**
093: * Adds "@Generated" to the classes, methods, and fields.
094: */
095: private void augument(ClassOutline co) {
096: annotate(co.implClass);
097: for (JMethod m : co.implClass.methods())
098: annotate(m);
099: for (JFieldVar f : co.implClass.fields().values())
100: annotate(f);
101: }
102:
103: private void annotate(JAnnotatable m) {
104: m.annotate(annotation).param("value", Driver.class.getName())
105: .param("date", getISO8601Date()).param("comments",
106: "JAXB RI v" + Options.getBuildID());
107: }
108:
109: // cache the timestamp so that all the @Generated annotations match
110: private String date = null;
111:
112: /**
113: * calculate the date value in ISO8601 format for the @Generated annotation
114: * @return the date value
115: */
116: private String getISO8601Date() {
117: if (date == null) {
118: StringBuffer tstamp = new StringBuffer();
119: tstamp.append((new SimpleDateFormat(
120: "yyyy-MM-dd'T'hh:mm:ssZ")).format(new Date()));
121: // hack to get ISO 8601 style timezone - is there a better way that doesn't require
122: // a bunch of timezone offset calculations?
123: tstamp.insert(tstamp.length() - 2, ':');
124: date = tstamp.toString();
125: }
126: return date;
127: }
128: }
|