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 32 /** 33 * Link-time representation of a module. 34 */ 35 public interface ResourcePoolModule { 36 /** 37 * The module name. 38 * 39 * @return The module name. 40 */ 41 public String name(); 42 43 /** 44 * Retrieves a ResourcePoolEntry from the given path (e.g: 45 * /mymodule/com.foo.bar/MyClass.class) 46 * 47 * @param path The piece of data path. 48 * @return A ResourcePoolEntry of the given path, if found. 49 */ 50 public Optional<ResourcePoolEntry> findEntry(String path); 51 52 /** 53 * The module descriptor of this module. 54 * 55 * @return The module descriptor. 56 */ 57 public ModuleDescriptor descriptor(); 58 59 /** 60 * Retrieves all the packages located in this module. 61 * 62 * @return The set of packages. 63 */ 64 public Set<String> packages(); 65 66 /** 67 * Retrieves the stream of ResourcePoolEntry. 68 * 69 * @return The ResourcePoolEntry stream. 70 */ 71 public Stream<ResourcePoolEntry> entries(); 72 73 /** 74 * Return the number of ResourcePoolEntry count in this ResourcePoolModule. 75 * 76 * @return the entry count. 77 */ 78 public int entryCount(); 79 }