1 /*
   2  * Copyright (c) 2016, 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.plugin;
  26 
  27 import java.lang.module.ModuleDescriptor;
  28 import java.util.Optional;
  29 import java.util.Set;
  30 import java.util.stream.Stream;
  31 import jdk.internal.module.ModuleTarget;
  32 
  33 /**
  34   * Link-time representation of a module.
  35   */
  36 public interface ResourcePoolModule {
  37     /**
  38      * The module name.
  39      *
  40      * @return The module name.
  41      */
  42     public String name();
  43 
  44     /**
  45      * Retrieves a ResourcePoolEntry from the given path (e.g:
  46      * /mymodule/com.foo.bar/MyClass.class)
  47      *
  48      * @param path The piece of data path.
  49      * @return A ResourcePoolEntry of the given path, if found.
  50      */
  51     public Optional<ResourcePoolEntry> findEntry(String path);
  52 
  53     /**
  54      * The module descriptor of this module.
  55      *
  56      * @return The module descriptor.
  57      */
  58     public ModuleDescriptor descriptor();
  59 
  60     /**
  61      * The module target OS name for this module.
  62      *
  63      * @return The module target OS name
  64      */
  65     public String osName();
  66 
  67     /**
  68      * The module target OS arch for this module.
  69      *
  70      * @return The module target OS arch
  71      */
  72     public String osArch();
  73 
  74     /**
  75      * Retrieves all the packages located in this module.
  76      *
  77      * @return The set of packages.
  78      */
  79     public Set<String> packages();
  80 
  81     /**
  82      * Retrieves the stream of ResourcePoolEntry.
  83      *
  84      * @return The ResourcePoolEntry stream.
  85      */
  86     public Stream<ResourcePoolEntry> entries();
  87 
  88     /**
  89      * Return the number of ResourcePoolEntry count in this ResourcePoolModule.
  90      *
  91      * @return the entry count.
  92      */
  93     public int entryCount();
  94 }