Class ImageArchive

java.lang.Object

org.springframework.boot.buildpack.platform.docker.type.ImageArchive

All Implemented Interfaces:

TarArchive

public class ImageArchive
extends Object
implements TarArchive

An image archive that can be loaded into Docker.

Since:

2.3.0

Author:

Phillip Webb, Scott Frederick

See Also:

• from(Image, IOConsumer)
• Docker Image Specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ImageArchive.Update	Update class used to change data when creating an image archive.

Nested classes/interfaces inherited from interface TarArchive

TarArchive.Compression

Field Summary

Fields inherited from interface TarArchive

NORMALIZED_TIME

Method Summary

Modifier and Type	Method	Description
static ImageArchive	from(Image image)	Create a new ImageArchive based on an existing Image.
static ImageArchive	from(Image image, IOConsumer<ImageArchive.Update> update)	Create a new ImageArchive based on an existing Image.
Instant	getCreateDate()	Return the create date of the archive.
ImageConfig	getImageConfig()	Return the image config for the archive.
@Nullable ImageReference	getTag()	Return the tag of the archive.
void	writeTo(OutputStream outputStream)	Write the TAR archive to the given output stream.

Methods inherited from class Object

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

Methods inherited from interface TarArchive

getCompression

Method Details

getImageConfig

public ImageConfig getImageConfig()

Return the image config for the archive.

Returns:

the image config

getCreateDate

public Instant getCreateDate()

Return the create date of the archive.

Returns:

the create date

getTag

public @Nullable ImageReference getTag()

Return the tag of the archive.

Returns:

the tag

writeTo

public void writeTo(OutputStream outputStream)
             throws IOException

Description copied from interface: TarArchive

Write the TAR archive to the given output stream.

Specified by:

writeTo in interface TarArchive

Parameters:

outputStream - the output stream to write to

Throws:

IOException - on IO error

from

public static ImageArchive from(Image image)
                         throws IOException

Create a new ImageArchive based on an existing Image.

Parameters:

image - the image that this archive is based on

Returns:

the new image archive.

Throws:

IOException - on IO error

from

public static ImageArchive from(Image image,
 IOConsumer<ImageArchive.Update> update)
                         throws IOException

Create a new ImageArchive based on an existing Image.

Parameters:

image - the image that this archive is based on

update - consumer to apply updates

Returns:

the new image archive.

Throws:

IOException - on IO error