1 /*
   2  * Copyright (c) 2015, 2017, 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 jdk.internal.misc;
  27 
  28 import java.io.PrintStream;
  29 import java.lang.module.Configuration;
  30 import java.lang.module.ModuleDescriptor;
  31 import java.lang.module.ModuleDescriptor.Exports;
  32 import java.lang.module.ModuleDescriptor.Opens;
  33 import java.lang.module.ModuleDescriptor.Requires;
  34 import java.lang.module.ModuleDescriptor.Provides;
  35 import java.lang.module.ModuleDescriptor.Version;
  36 import java.lang.module.ModuleFinder;
  37 import java.lang.module.ModuleReader;
  38 import java.lang.module.ModuleReference;
  39 import java.net.URI;
  40 import java.nio.file.Path;
  41 import java.util.Collection;
  42 import java.util.List;
  43 import java.util.Set;
  44 import java.util.function.Supplier;
  45 
  46 import jdk.internal.module.ModuleHashes;
  47 
  48 /**
  49  * Provides access to non-public methods in java.lang.module.
  50  */
  51 
  52 public interface JavaLangModuleAccess {
  53 
  54     /**
  55      * Creates a builder for building a module with the given module name.
  56      *
  57      * @param strict
  58      *        Indicates whether module names are checked or not
  59      */
  60     ModuleDescriptor.Builder newModuleBuilder(String mn,
  61                                               boolean strict,
  62                                               Set<ModuleDescriptor.Modifier> ms);
  63 
  64     /**
  65      * Returns a snapshot of the packages in the module.
  66      */
  67     Set<String> packages(ModuleDescriptor.Builder builder);
  68 
  69     /**
  70      * Adds a dependence on a module with the given (possibly un-parsable)
  71      * version string.
  72      */
  73     void requires(ModuleDescriptor.Builder builder,
  74                   Set<Requires.Modifier> ms,
  75                   String mn,
  76                   String rawCompiledVersion);
  77 
  78     /**
  79      * Returns a {@code ModuleDescriptor.Requires} of the given modifiers
  80      * and module name.
  81      */
  82     Requires newRequires(Set<Requires.Modifier> ms, String mn, Version v);
  83 
  84     /**
  85      * Returns an unqualified {@code ModuleDescriptor.Exports}
  86      * of the given modifiers and package name source.
  87      */
  88     Exports newExports(Set<Exports.Modifier> ms,
  89                        String source);
  90 
  91     /**
  92      * Returns a qualified {@code ModuleDescriptor.Exports}
  93      * of the given modifiers, package name source and targets.
  94      */
  95     Exports newExports(Set<Exports.Modifier> ms,
  96                        String source,
  97                        Set<String> targets);
  98 
  99     /**
 100      * Returns an unqualified {@code ModuleDescriptor.Opens}
 101      * of the given modifiers and package name source.
 102      */
 103     Opens newOpens(Set<Opens.Modifier> ms, String source);
 104 
 105     /**
 106      * Returns a qualified {@code ModuleDescriptor.Opens}
 107      * of the given modifiers, package name source and targets.
 108      */
 109     Opens newOpens(Set<Opens.Modifier> ms, String source, Set<String> targets);
 110 
 111     /**
 112      * Returns a {@code ModuleDescriptor.Provides}
 113      * of the given service name and providers.
 114      */
 115     Provides newProvides(String service, List<String> providers);
 116 
 117     /**
 118      * Returns a new {@code ModuleDescriptor} instance.
 119      */
 120     ModuleDescriptor newModuleDescriptor(String name,
 121                                          Version version,
 122                                          Set<ModuleDescriptor.Modifier> ms,
 123                                          Set<Requires> requires,
 124                                          Set<Exports> exports,
 125                                          Set<Opens> opens,
 126                                          Set<String> uses,
 127                                          Set<Provides> provides,
 128                                          Set<String> packages,
 129                                          String mainClass,
 130                                          int hashCode);
 131 
 132     /**
 133      * Resolves a collection of root modules, with service binding
 134      * and the empty configuration as the parent. The post resolution
 135      * checks are optionally run.
 136      */
 137     Configuration resolveAndBind(ModuleFinder finder,
 138                                  Collection<String> roots,
 139                                  boolean check,
 140                                  PrintStream traceOutput);
 141 
 142 }