aoqi@0: /*
aoqi@0:  * Copyright (c) 1997, 2011, Oracle and/or its affiliates. All rights reserved.
aoqi@0:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0:  *
aoqi@0:  * This code is free software; you can redistribute it and/or modify it
aoqi@0:  * under the terms of the GNU General Public License version 2 only, as
aoqi@0:  * published by the Free Software Foundation.  Oracle designates this
aoqi@0:  * particular file as subject to the "Classpath" exception as provided
aoqi@0:  * by Oracle in the LICENSE file that accompanied this code.
aoqi@0:  *
aoqi@0:  * This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
aoqi@0:  * version 2 for more details (a copy is included in the LICENSE file that
aoqi@0:  * accompanied this code).
aoqi@0:  *
aoqi@0:  * You should have received a copy of the GNU General Public License version
aoqi@0:  * 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0:  *
aoqi@0:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0:  * or visit www.oracle.com if you need additional information or have any
aoqi@0:  * questions.
aoqi@0:  */
aoqi@0: 
aoqi@0: package com.sun.tools.internal.xjc.addon.at_generated;
aoqi@0: 
aoqi@0: import java.text.SimpleDateFormat;
aoqi@0: import java.util.Date;
aoqi@0: 
aoqi@0: import com.sun.codemodel.internal.JAnnotatable;
aoqi@0: import com.sun.codemodel.internal.JClass;
aoqi@0: import com.sun.codemodel.internal.JFieldVar;
aoqi@0: import com.sun.codemodel.internal.JMethod;
aoqi@0: import com.sun.tools.internal.xjc.Driver;
aoqi@0: import com.sun.tools.internal.xjc.Options;
aoqi@0: import com.sun.tools.internal.xjc.Plugin;
aoqi@0: import com.sun.tools.internal.xjc.outline.ClassOutline;
aoqi@0: import com.sun.tools.internal.xjc.outline.EnumOutline;
aoqi@0: import com.sun.tools.internal.xjc.outline.Outline;
aoqi@0: 
aoqi@0: import org.xml.sax.ErrorHandler;
aoqi@0: 
aoqi@0: /**
aoqi@0:  * {@link Plugin} that marks the generated code by using JSR-250's '@Generated'.
aoqi@0:  *
aoqi@0:  * @author Kohsuke Kawaguchi
aoqi@0:  */
aoqi@0: public class PluginImpl extends Plugin {
aoqi@0: 
aoqi@0:     public String getOptionName() {
aoqi@0:         return "mark-generated";
aoqi@0:     }
aoqi@0: 
aoqi@0:     public String getUsage() {
aoqi@0:         return "  -mark-generated    :  mark the generated code as @javax.annotation.Generated";
aoqi@0:     }
aoqi@0: 
aoqi@0:     private JClass annotation;
aoqi@0: 
aoqi@0:     public boolean run( Outline model, Options opt, ErrorHandler errorHandler ) {
aoqi@0:         // we want this to work without requiring JSR-250 jar.
aoqi@0:         annotation = model.getCodeModel().ref("javax.annotation.Generated");
aoqi@0: 
aoqi@0:         for( ClassOutline co : model.getClasses() )
aoqi@0:             augument(co);
aoqi@0:         for( EnumOutline eo : model.getEnums() )
aoqi@0:             augument(eo);
aoqi@0: 
aoqi@0:         //TODO: process generated ObjectFactory classes?
aoqi@0: 
aoqi@0:         return true;
aoqi@0:     }
aoqi@0: 
aoqi@0:     private void augument(EnumOutline eo) {
aoqi@0:         annotate(eo.clazz);
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Adds "@Generated" to the classes, methods, and fields.
aoqi@0:      */
aoqi@0:     private void augument(ClassOutline co) {
aoqi@0:         annotate(co.implClass);
aoqi@0:         for (JMethod m : co.implClass.methods())
aoqi@0:             annotate(m);
aoqi@0:         for (JFieldVar f : co.implClass.fields().values())
aoqi@0:             annotate(f);
aoqi@0:     }
aoqi@0: 
aoqi@0:     private void annotate(JAnnotatable m) {
aoqi@0:         m.annotate(annotation)
aoqi@0:                 .param("value",Driver.class.getName())
aoqi@0:                 .param("date", getISO8601Date())
aoqi@0:                 .param("comments", "JAXB RI v" + Options.getBuildID());
aoqi@0:     }
aoqi@0: 
aoqi@0:     // cache the timestamp so that all the @Generated annotations match
aoqi@0:     private String date = null;
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * calculate the date value in ISO8601 format for the @Generated annotation
aoqi@0:      * @return the date value
aoqi@0:      */
aoqi@0:     private String getISO8601Date() {
aoqi@0:         if(date==null) {
aoqi@0:             StringBuffer tstamp = new StringBuffer();
aoqi@0:             tstamp.append((new SimpleDateFormat("yyyy-MM-dd'T'hh:mm:ssZ")).format(new Date()));
aoqi@0:             // hack to get ISO 8601 style timezone - is there a better way that doesn't require
aoqi@0:             // a bunch of timezone offset calculations?
aoqi@0:             tstamp.insert(tstamp.length()-2, ':');
aoqi@0:             date = tstamp.toString();
aoqi@0:         }
aoqi@0:         return date;
aoqi@0:     }
aoqi@0: }