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.builder;
  26 
  27 import java.io.DataOutputStream;
  28 import java.util.Properties;
  29 import java.util.Set;
  30 
  31 import jdk.tools.jlink.internal.ExecutableImage;
  32 import jdk.tools.jlink.plugin.PluginException;
  33 import jdk.tools.jlink.plugin.ResourcePool;
  34 
  35 /**
  36  * Implement this interface to develop your own image layout. First the jimage
  37  * is written onto the output stream returned by getOutputStream then storeFiles
  38  * is called.
  39  */
  40 public interface ImageBuilder {
  41 
  42     /**
  43      * Store the external files.
  44      *
  45      * @param rootModules root modules for the image generated
  46      * @param content Pool of module content.
  47      * @throws PluginException
  48      */
  49     public void storeFiles(Set<String> rootModules, ResourcePool content);
  50 
  51     /**
  52      * The OutputStream to store the jimage file.
  53      *
  54      * @return The output stream
  55      * @throws PluginException
  56      */
  57     public DataOutputStream getJImageOutputStream();
  58 
  59     /**
  60      * Gets the executable image that is generated.
  61      *
  62      * @return The executable image.
  63      * @throws PluginException
  64      */
  65     public ExecutableImage getExecutableImage();
  66 }