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 
  30 import jdk.tools.jlink.plugin.ExecutableImage;
  31 import jdk.tools.jlink.plugin.PluginException;
  32 import jdk.tools.jlink.plugin.Pool;
  33 
  34 /**
  35  * Implement this interface to develop your own image layout. First the jimage
  36  * is written onto the output stream returned by getOutputStream then storeFiles
  37  * is called.
  38  */
  39 public interface ImageBuilder {
  40 
  41     /**
  42      * Store the external files.
  43      *
  44      * @param content Pool of module content.
  45      * @param bom The options used to build the image file.
  46      * @param release the release properties
  47      * @throws PluginException
  48      */
  49     public default void storeFiles(Pool content, String bom, Properties release) {
  50         storeFiles(content, bom);
  51     }
  52 
  53     /**
  54      * Store the external files.
  55      *
  56      * @param content Pool of module content.
  57      * @param bom The options used to build the image file.
  58      * @throws PluginException
  59      */
  60     public default void storeFiles(Pool content, String bom) {
  61         throw new UnsupportedOperationException("storeFiles");
  62     }
  63 
  64     /**
  65      * The OutputStream to store the jimage file.
  66      *
  67      * @return The output stream
  68      * @throws PluginException
  69      */
  70     public DataOutputStream getJImageOutputStream();
  71 
  72     /**
  73      * Gets the executable image that is generated.
  74      *
  75      * @return The executable image.
  76      * @throws PluginException
  77      */
  78     public ExecutableImage getExecutableImage();
  79 }
--- EOF ---