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.util.Objects;
28 import java.util.Optional;
29 import java.util.stream.Stream;
30 
31 /**
32  * The module view of a ResourcePool.
33  */
34 public interface ResourcePoolModuleView {
35     /**
36      * Find the module, if any, of the given name.
37      *
38      * @param name name of the module
39      * @return Optional containing the module of the given name.
40      */
findModule(String name)41     public Optional<ResourcePoolModule> findModule(String name);
42 
43     /**
44      * Find the module, if any, of the given ResourcePoolEntry
45      *
46      * @param entry The ResourcePoolEntry whose module is looked up.
47      * @return Optional containing the module of the given ResourcePoolEntry
48      */
findModule(ResourcePoolEntry entry)49     public default Optional<ResourcePoolModule> findModule(ResourcePoolEntry entry) {
50         String name = Objects.requireNonNull(entry).moduleName();
51         return name != null? findModule(name) : Optional.empty();
52     }
53 
54     /**
55      * The stream of modules contained in this ResourcePool.
56      *
57      * @return The stream of modules.
58      */
modules()59     public Stream<ResourcePoolModule> modules();
60 
61     /**
62      * Return the number of ResourcePoolModule count in this ResourcePool.
63      *
64      * @return the module count.
65      */
moduleCount()66     public int moduleCount();
67 }
68