org.springframework.boot.loader.tools

Class AbstractJarWriter

java.lang.Object

org.springframework.boot.loader.tools.AbstractJarWriter

All Implemented Interfaces:

LoaderClassesWriter

Direct Known Subclasses:

JarWriter

public abstract class AbstractJarWriter
extends Object
implements LoaderClassesWriter

Abstract base class for JAR writers.

Since:

2.3.0

Author:

Phillip Webb, Andy Wilkinson, Madhura Bhave

Constructor Summary

Constructors

Constructor and Description
AbstractJarWriter()

Method Summary

Modifier and Type	Method and Description
void	writeEntries(JarFile jarFile) Deprecated. since 2.4.8 for removal in 2.6.0 in favor of writeEntries(JarFile, EntryTransformer, UnpackHandler, Predicate)
void	writeEntries(JarFile jarFile, org.springframework.boot.loader.tools.AbstractJarWriter.EntryTransformer entryTransformer, org.springframework.boot.loader.tools.AbstractJarWriter.UnpackHandler unpackHandler, Predicate<JarEntry> entryFilter) Write required entries from the specified jar file.
void	writeEntry(String entryName, EntryWriter entryWriter) Writes an entry.
void	writeEntry(String entryName, InputStream inputStream) Writes an entry.
void	writeIndexFile(String location, Collection<String> lines) Write a simple index file containing the specified UTF-8 lines.
void	writeLoaderClasses() Write the required spring-boot-loader classes to the JAR.
void	writeLoaderClasses(String loaderJarResourceName) Write the required spring-boot-loader classes to the JAR.
void	writeManifest(Manifest manifest) Write the specified manifest.
void	writeNestedLibrary(String location, Library library) Write a nested library.
protected abstract void	writeToArchive(ZipEntry entry, EntryWriter entryWriter)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractJarWriter

public AbstractJarWriter()

Method Detail

writeManifest

public void writeManifest(Manifest manifest)
                   throws IOException

Write the specified manifest.

Parameters:

manifest - the manifest to write

Throws:

IOException - of the manifest cannot be written

writeEntries

@Deprecated
public void writeEntries(JarFile jarFile)
                              throws IOException

Deprecated. since 2.4.8 for removal in 2.6.0 in favor of writeEntries(JarFile, EntryTransformer, UnpackHandler, Predicate)

Write all entries from the specified jar file.

Parameters:

jarFile - the source jar file

Throws:

IOException - if the entries cannot be written

writeEntries

public void writeEntries(JarFile jarFile,
                         org.springframework.boot.loader.tools.AbstractJarWriter.EntryTransformer entryTransformer,
                         org.springframework.boot.loader.tools.AbstractJarWriter.UnpackHandler unpackHandler,
                         Predicate<JarEntry> entryFilter)
                  throws IOException

Write required entries from the specified jar file.

Parameters:

jarFile - the source jar file

entryTransformer - the entity transformer used to change the entry

unpackHandler - the unpack handler

entryFilter - a predicate used to filter the written entries

Throws:

IOException - if the entries cannot be written

Since:

2.4.8

writeEntry

public void writeEntry(String entryName,
                       InputStream inputStream)
                throws IOException

Writes an entry. The inputStream is closed once the entry has been written

Specified by:

writeEntry in interface LoaderClassesWriter

Parameters:

entryName - the name of the entry

inputStream - the stream from which the entry's data can be read

Throws:

IOException - if the write fails

writeEntry

public void writeEntry(String entryName,
                       EntryWriter entryWriter)
                throws IOException

Writes an entry. The inputStream is closed once the entry has been written

Parameters:

entryName - the name of the entry

entryWriter - the entry writer

Throws:

IOException - if the write fails

writeNestedLibrary

public void writeNestedLibrary(String location,
                               Library library)
                        throws IOException

Write a nested library.

Parameters:

location - the destination of the library

library - the library

Throws:

IOException - if the write fails

writeIndexFile

public void writeIndexFile(String location,
                           Collection<String> lines)
                    throws IOException

Write a simple index file containing the specified UTF-8 lines.

Parameters:

location - the location of the index file

lines - the lines to write

Throws:

IOException - if the write fails

Since:

2.3.0

writeLoaderClasses

public void writeLoaderClasses()
                        throws IOException

Write the required spring-boot-loader classes to the JAR.

Specified by:

writeLoaderClasses in interface LoaderClassesWriter

Throws:

IOException - if the classes cannot be written

writeLoaderClasses

public void writeLoaderClasses(String loaderJarResourceName)
                        throws IOException

Write the required spring-boot-loader classes to the JAR.

Specified by:

writeLoaderClasses in interface LoaderClassesWriter

Parameters:

loaderJarResourceName - the name of the resource containing the loader classes to be written

Throws:

IOException - if the classes cannot be written

writeToArchive

protected abstract void writeToArchive(ZipEntry entry,
                                       EntryWriter entryWriter)
                                throws IOException

Throws:

IOException