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 */
25package jdk.tools.jlink.builder;
26
27import java.io.DataOutputStream;
28import java.util.Properties;
29
30import jdk.tools.jlink.internal.ExecutableImage;
31import jdk.tools.jlink.plugin.PluginException;
32import jdk.tools.jlink.plugin.ResourcePool;
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 */
39public interface ImageBuilder {
40
41    /**
42     * Store the external files.
43     *
44     * @param content Pool of module content.
45     * @param release the release properties
46     * @throws PluginException
47     */
48    public default void storeFiles(ResourcePool content, Properties release) {
49        storeFiles(content);
50    }
51
52    /**
53     * Store the external files.
54     *
55     * @param content Pool of module content.
56     * @throws PluginException
57     */
58    public default void storeFiles(ResourcePool content) {
59        throw new UnsupportedOperationException("storeFiles");
60    }
61
62    /**
63     * The OutputStream to store the jimage file.
64     *
65     * @return The output stream
66     * @throws PluginException
67     */
68    public DataOutputStream getJImageOutputStream();
69
70    /**
71     * Gets the executable image that is generated.
72     *
73     * @return The executable image.
74     * @throws PluginException
75     */
76    public ExecutableImage getExecutableImage();
77}
78