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.lang.module.ModuleDescriptor;
  28 import java.util.Set;
  29 import jdk.internal.org.objectweb.asm.ClassReader;
  30 
  31 /**
  32  * A pool for a given module
  33  */
  34 public interface AsmModulePool extends AsmPool {
  35 
  36     /**
  37      * Associate a package to this module, useful when adding new classes in new
  38      * packages. WARNING: In order to properly handle new package and/or new
  39      * module, module-info class must be added and/or updated.
  40      *
  41      * @param pkg The new package, following java binary syntax (/-separated
  42      * path name).
  43      * @throws jdk.tools.jlink.plugins.PluginException If a mapping already
  44      * exist for this package.
  45      */
  46     public void addPackage(String pkg);
  47 
  48     /**
  49      * The module name of this pool.
  50      * @return The module name;
  51      */
  52     public String getModuleName();
  53 
  54     /**
  55      * Lookup the class in this pool and the required pools. NB: static module
  56      * readability can be different at execution time.
  57      *
  58      * @param binaryName The class to lookup.
  59      * @return The reader or null if not found
  60      * @throws jdk.tools.jlink.plugins.PluginException
  61      */
  62     public ClassReader getClassReaderInDependencies(String binaryName);
  63 
  64     /**
  65      * Lookup the class in the exported packages of this module. "public
  66      * requires" modules are looked up. NB: static module readability can be
  67      * different at execution time.
  68      *
  69      * @param callerModule Name of calling module.
  70      * @param binaryName The class to lookup.
  71      * @return The reader or null if not found
  72      * @throws jdk.tools.jlink.plugins.PluginException
  73      */
  74     public ClassReader getExportedClassReader(String callerModule,
  75             String binaryName);
  76 
  77     /**
  78      * The module descriptor.
  79      *
  80      * @return The module descriptor;
  81      */
  82     public ModuleDescriptor getDescriptor();
  83 
  84     /**
  85      * Retrieve the internal and exported packages.
  86      *
  87      * @return
  88      */
  89     public Set<String> getAllPackages();
  90 }