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.

Field Summary

Fields

Modifier and Type	Field and Description
static BiFunction<Path,AbsoluteUnixPath,FilePermissions>	DEFAULT_FILE_PERMISSIONS_PROVIDER Provider that returns default file permissions (644 for files, 755 for directories).
static Instant	DEFAULT_MODIFIED_TIME
static BiFunction<Path,AbsoluteUnixPath,Instant>	DEFAULT_MODIFIED_TIME_PROVIDER Provider that returns default file modification time (EPOCH + 1 second).

Constructor Summary

Constructors

Constructor and Description
LayerEntry(Path sourceFile, AbsoluteUnixPath extractionPath) Instantiates with a source file and the path to place the source file in the container file system.
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.
LayerEntry(Path sourceFile, AbsoluteUnixPath extractionPath, FilePermissions permissions, Instant lastModifiedTime) 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.
Instant	getLastModifiedTime() Returns the modification time of the file in the entry.
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

Field Detail

DEFAULT_FILE_PERMISSIONS_PROVIDER

public static final BiFunction<Path,AbsoluteUnixPath,FilePermissions> DEFAULT_FILE_PERMISSIONS_PROVIDER

Provider that returns default file permissions (644 for files, 755 for directories).

DEFAULT_MODIFIED_TIME

public static final Instant DEFAULT_MODIFIED_TIME

DEFAULT_MODIFIED_TIME_PROVIDER

public static final BiFunction<Path,AbsoluteUnixPath,Instant> DEFAULT_MODIFIED_TIME_PROVIDER

Provider that returns default file modification time (EPOCH + 1 second).

Constructor Detail

LayerEntry

public LayerEntry(Path sourceFile,
                  AbsoluteUnixPath extractionPath)

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

LayerEntry

public 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.

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)

LayerEntry

public LayerEntry(Path sourceFile,
                  AbsoluteUnixPath extractionPath,
                  FilePermissions permissions,
                  Instant lastModifiedTime)

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

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

lastModifiedTime - the file modification time, default to 1 second since the epoch (https://github.com/GoogleContainerTools/jib/issues/1079)

Method Detail

getLastModifiedTime

public Instant getLastModifiedTime()

Returns the modification time of the file in the entry.

Returns:

the modification time

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