1 /*
   2  * Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 
  26 package com.sun.tools.internal.xjc.addon.code_injector;
  27 
  28 import java.util.Collections;
  29 import java.util.List;
  30 
  31 import com.sun.tools.internal.xjc.Options;
  32 import com.sun.tools.internal.xjc.Plugin;
  33 import com.sun.tools.internal.xjc.model.CPluginCustomization;
  34 import com.sun.tools.internal.xjc.outline.ClassOutline;
  35 import com.sun.tools.internal.xjc.outline.Outline;
  36 import com.sun.tools.internal.xjc.util.DOMUtils;
  37 
  38 import org.xml.sax.ErrorHandler;
  39 
  40 /**
  41  * Entry point of a plugin.
  42  *
  43  * See the javadoc of {@link Plugin} for what those methods mean.
  44  *
  45  * @author Kohsuke Kawaguchi
  46  */
  47 public class PluginImpl extends Plugin {
  48     public String getOptionName() {
  49         return "Xinject-code";
  50     }
  51 
  52     public List<String> getCustomizationURIs() {
  53         return Collections.singletonList(Const.NS);
  54     }
  55 
  56     public boolean isCustomizationTagName(String nsUri, String localName) {
  57         return nsUri.equals(Const.NS) && localName.equals("code");
  58     }
  59 
  60     public String getUsage() {
  61         return "  -Xinject-code      :  inject specified Java code fragments into the generated code";
  62     }
  63 
  64     // meat of the processing
  65     public boolean run(Outline model, Options opt, ErrorHandler errorHandler) {
  66         for( ClassOutline co : model.getClasses() ) {
  67             CPluginCustomization c = co.target.getCustomizations().find(Const.NS,"code");
  68             if(c==null)
  69                 continue;   // no customization --- nothing to inject here
  70 
  71             c.markAsAcknowledged();
  72             // TODO: ideally you should validate this DOM element to make sure
  73             // that there's no typo/etc. JAXP 1.3 can do this very easily.
  74             String codeFragment = DOMUtils.getElementText(c.element);
  75 
  76             // inject the specified code fragment into the implementation class.
  77             co.implClass.direct(codeFragment);
  78         }
  79 
  80         return true;
  81     }
  82 }