| /* | |
| * Copyright (c) 2015, 2023, Oracle and/or its affiliates. All rights reserved. | |
| * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. | |
| * | |
| * This code is free software; you can redistribute it and/or modify it | |
| * under the terms of the GNU General Public License version 2 only, as | |
| * published by the Free Software Foundation. Oracle designates this | |
| * particular file as subject to the "Classpath" exception as provided | |
| * by Oracle in the LICENSE file that accompanied this code. | |
| * | |
| * This code is distributed in the hope that it will be useful, but WITHOUT | |
| * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or | |
| * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License | |
| * version 2 for more details (a copy is included in the LICENSE file that | |
| * accompanied this code). | |
| * | |
| * You should have received a copy of the GNU General Public License version | |
| * 2 along with this work; if not, write to the Free Software Foundation, | |
| * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. | |
| * | |
| * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA | |
| * or visit www.oracle.com if you need additional information or have any | |
| * questions. | |
| */ | |
| package jdk.tools.jlink.builder; | |
| import java.io.DataOutputStream; | |
| import java.util.Properties; | |
| import jdk.tools.jlink.internal.ExecutableImage; | |
| import jdk.tools.jlink.internal.Platform; | |
| import jdk.tools.jlink.plugin.PluginException; | |
| import jdk.tools.jlink.plugin.ResourcePool; | |
| /** | |
| * Implement this interface to develop your own image layout. First the jimage | |
| * is written onto the output stream returned by getOutputStream then storeFiles | |
| * is called. | |
| */ | |
| public interface ImageBuilder { | |
| /** | |
| * Store the external files. | |
| * | |
| * @param content Pool of module content. | |
| * @param release the release properties | |
| * @throws PluginException | |
| */ | |
| public default void storeFiles(ResourcePool content, Properties release) { | |
| storeFiles(content); | |
| } | |
| /** | |
| * Store the external files. | |
| * | |
| * @param content Pool of module content. | |
| * @throws PluginException | |
| */ | |
| public default void storeFiles(ResourcePool content) { | |
| throw new UnsupportedOperationException("storeFiles"); | |
| } | |
| /** | |
| * The OutputStream to store the jimage file. | |
| * | |
| * @return The output stream | |
| * @throws PluginException | |
| */ | |
| public DataOutputStream getJImageOutputStream(); | |
| /** | |
| * Gets the executable image that is generated. | |
| * | |
| * @return The executable image. | |
| * @throws PluginException | |
| */ | |
| public ExecutableImage getExecutableImage(); | |
| /** | |
| * Gets the platform of the image. | |
| * | |
| * @return {@code Platform} object representing the platform of the image | |
| * @throws UnsupportedOperationException if this method is not implemented by the ImageBuilder | |
| */ | |
| public default Platform getTargetPlatform() { | |
| throw new UnsupportedOperationException("Builder does not define getTargetPlatform"); | |
| } | |
| } |