com.google.cloud.tools.jib.api.buildplan

Class FileEntry

java.lang.Object

com.google.cloud.tools.jib.api.buildplan.FileEntry

@Immutable
public class FileEntry
extends java.lang.Object

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

This class is immutable and thread-safe.

Constructor Summary

Constructors

Constructor and Description
FileEntry(java.nio.file.Path sourceFile, AbsoluteUnixPath extractionPath, FilePermissions permissions, java.time.Instant modificationTime) Instantiates with a source file and the path to place the source file in the container file system.
FileEntry(java.nio.file.Path sourceFile, AbsoluteUnixPath extractionPath, FilePermissions permissions, java.time.Instant modificationTime, java.lang.String ownership) 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(java.lang.Object other)
AbsoluteUnixPath	getExtractionPath() Gets the extraction path.
java.time.Instant	getModificationTime() Returns the modification time of the file in the entry.
java.lang.String	getOwnership() Gets the file ownership on the container.
FilePermissions	getPermissions() Gets the file permissions on the container.
java.nio.file.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

FileEntry

public FileEntry(java.nio.file.Path sourceFile,
                 AbsoluteUnixPath extractionPath,
                 FilePermissions permissions,
                 java.time.Instant modificationTime)

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

For example, new FileEntry(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 FileEntry(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/.

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

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

modificationTime - the file modification time

FileEntry

public FileEntry(java.nio.file.Path sourceFile,
                 AbsoluteUnixPath extractionPath,
                 FilePermissions permissions,
                 java.time.Instant modificationTime,
                 java.lang.String ownership)

Instantiates with a source file and the path to place the source file in the container file system. See FileEntry(Path, AbsoluteUnixPath, FilePermissions, Instant) for more information.

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

modificationTime - the file modification time

ownership - file ownership. For example, "1234", "user", ":5678", ":group", "1234:5678", and "user:group". Note that "" (empty string), ":" (single colon), "0:", ":0" are allowed and representative of "0:0" or "root:root", but prefer an empty string for "0:0".

Method Detail

getModificationTime

public java.time.Instant getModificationTime()

Returns the modification time of the file in the entry.

Returns:

the modification time

getSourceFile

public java.nio.file.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

getOwnership

public java.lang.String getOwnership()

Gets the file ownership on the container.

Returns:

the file ownership on the container

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object