001/*
002 * Copyright 2012-2016 the original author or authors.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *      http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016
017package org.springframework.boot.loader.tools;
018
019import java.io.IOException;
020import java.io.InputStream;
021
022/**
023 * Writer used by {@link CustomLoaderLayout CustomLoaderLayouts} to write classes into a
024 * repackaged JAR.
025 *
026 * @author Phillip Webb
027 * @since 1.5.0
028 */
029public interface LoaderClassesWriter {
030
031        /**
032         * Write the default required spring-boot-loader classes to the JAR.
033         * @throws IOException if the classes cannot be written
034         */
035        void writeLoaderClasses() throws IOException;
036
037        /**
038         * Write custom required spring-boot-loader classes to the JAR.
039         * @param loaderJarResourceName the name of the resource containing the loader classes
040         * to be written
041         * @throws IOException if the classes cannot be written
042         */
043        void writeLoaderClasses(String loaderJarResourceName) throws IOException;
044
045        /**
046         * Write a single entry to the JAR.
047         * @param name the name of the entry
048         * @param inputStream the input stream content
049         * @throws IOException if the entry cannot be written
050         */
051        void writeEntry(String name, InputStream inputStream) throws IOException;
052
053}