com.google.cloud.tools.jib.image

Class LayerEntry

java.lang.Object

com.google.cloud.tools.jib.image.LayerEntry

public class LayerEntry
extends Object

Represents an entry in the layer. A layer consists of many entries that can be converted into tar archive entries.

Note that:

• Entry source files can be either files or directories.
• Adding a directory does not include the contents of the directory. Each file under a directory must be added as a separate LayerEntry.

Constructor Summary

Constructors

Constructor and Description
LayerEntry(Path sourceFile, AbsoluteUnixPath extractionPath, FilePermissions permissions) Instantiates with a source file and the path to place the source file in the container file system.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object other)
AbsoluteUnixPath	getExtractionPath() Gets the extraction path.
FilePermissions	getPermissions() Gets the file permissions on the container.
Path	getSourceFile() Gets the source file.
int	hashCode()

Methods inherited from class java.lang.Object

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

Constructor Detail

LayerEntry

public LayerEntry(Path sourceFile,
                  AbsoluteUnixPath extractionPath,
                  @Nullable
                  FilePermissions permissions)

Instantiates with a source file and the path to place the source file in the container file system.

For example, new LayerEntry(Paths.get("HelloWorld.class"), AbsoluteUnixPath.get("/app/classes/HelloWorld.class")) adds a file HelloWorld.class to the container file system at /app/classes/HelloWorld.class.

For example, new LayerEntry(Paths.get("com"), AbsoluteUnixPath.get("/app/classes/com")) adds a directory to the container file system at /app/classes/com. This does not add the contents of com/.

Parameters:

sourceFile - the source file to add to the layer

extractionPath - the path in the container file system corresponding to the sourceFile

permissions - the file permissions on the container. Use null to use defaults (644 for files, 755 for directories)

Method Detail

getSourceFile

public Path getSourceFile()

Gets the source file. The source file may be relative or absolute, so the caller should use getSourceFile().toAbsolutePath().toString() for the serialized form since the serialization could change independently of the path representation.

Returns:

the source file

getExtractionPath

public AbsoluteUnixPath getExtractionPath()

Gets the extraction path.

Returns:

the extraction path

getPermissions

public FilePermissions getPermissions()

Gets the file permissions on the container.

Returns:

the file permissions on the container

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object