1 /*
   2  * Copyright (c) 2015, 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 package jdk.tools.jlink.internal.plugins.asm;
  26 
  27 import java.util.Objects;
  28 import jdk.tools.jlink.plugin.Plugin;
  29 import jdk.tools.jlink.plugin.ModuleEntry;
  30 import jdk.tools.jlink.plugin.ModulePool;
  31 import jdk.tools.jlink.internal.ModulePoolImpl;
  32 
  33 /**
  34  * Extend this class to develop your own plugin in order to transform jimage
  35  * resources.
  36  *
  37  */
  38 public abstract class AsmPlugin implements Plugin {
  39 
  40     public AsmPlugin() {
  41     }
  42 
  43     @Override
  44     public void visit(ModulePool allContent, ModulePool outResources) {
  45         Objects.requireNonNull(allContent);
  46         Objects.requireNonNull(outResources);
  47         ModulePoolImpl resources = new ModulePoolImpl(allContent.getByteOrder());
  48         allContent.entries().forEach(md -> {
  49             if(md.getType().equals(ModuleEntry.Type.CLASS_OR_RESOURCE)) {
  50                 resources.add(md);
  51             } else {
  52                 outResources.add(md);
  53             }
  54         });
  55         AsmPools pools = new AsmPools(resources);
  56         visit(pools);
  57         pools.fillOutputResources(outResources);
  58     }
  59 
  60     /**
  61      * This is the method to implement in order to
  62      * apply Asm transformation to jimage contained classes.
  63      * @param pools The pool of Asm classes and other resource files.
  64      * @param strings To add a string to the jimage strings table.
  65      * @throws jdk.tools.jlink.plugin.PluginException
  66      */
  67     public abstract void visit(AsmPools pools);
  68 }