com.android.builder.utils

Class FileCache.Inputs.Builder

java.lang.Object

com.android.builder.utils.FileCache.Inputs.Builder

Enclosing class:

FileCache.Inputs

public static final class FileCache.Inputs.Builder
extends java.lang.Object

Builder of FileCache.Inputs.

Constructor Summary

Constructors

Constructor and Description
Builder(FileCache.Command command) Creates a FileCache.Inputs.Builder instance to construct an FileCache.Inputs object.

Method Summary

Modifier and Type	Method and Description
FileCache.Inputs	build() Builds an Inputs instance.
FileCache.Inputs.Builder	putBoolean(java.lang.String name, boolean value) Adds an input parameter with a Boolean value.
FileCache.Inputs.Builder	putFileHash(java.lang.String name, java.io.File file) Adds the hash of a file's contents as an input parameter.
FileCache.Inputs.Builder	putFilePath(java.lang.String name, java.io.File file) Adds the path of a file/directory as an input parameter.
FileCache.Inputs.Builder	putFilePathLengthTimestamp(java.lang.String name, java.io.File file) Adds a file's path, length and timestamp as input parameters.
FileCache.Inputs.Builder	putLong(java.lang.String name, long value) Adds an input parameter with a Long value.
FileCache.Inputs.Builder	putString(java.lang.String name, java.lang.String value) Adds an input parameter with a String value.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder(@NonNull
               FileCache.Command command)

Creates a FileCache.Inputs.Builder instance to construct an FileCache.Inputs object.

Parameters:

command - the command that identifies a file creator callback function (which usually corresponds to a Gradle task)

Method Detail

putFilePath

public FileCache.Inputs.Builder putFilePath(@NonNull
                                            java.lang.String name,
                                            @NonNull
                                            java.io.File file)

Adds the path of a file/directory as an input parameter. If a parameter with the same name exists, the file/directory's path is overwritten.

Note that this method is used to indicate that the path of an input file/directory affects the output. Depending on your specific use case, consider adding other properties of the file/directory such as its hash, size, or timestamp as part of the inputs as well.

See Also:

putFilePathLengthTimestamp(String, File)

putFileHash

public FileCache.Inputs.Builder putFileHash(@NonNull
                                            java.lang.String name,
                                            @NonNull
                                            java.io.File file)
                                     throws java.io.IOException

Adds the hash of a file's contents as an input parameter. If a parameter with the same name exists, the file's hash is overwritten.

Note that this method is used to indicate that the contents of an input file affect the output. Also, by using this method, you are assuming that the hash of a file represents its contents, so beware of accidental hash collisions when two different files with different contents end up having the same hash (although it is unlikely to happen, it is possible). Depending on the specific use case, consider adding other properties of the file such as its path, name, size, or timestamp as part of the inputs as well.

Parameters:

file - the file to be hashed (must not be a directory)

Throws:

java.io.IOException

See Also:

putFilePathLengthTimestamp(String, File)

putFilePathLengthTimestamp

public FileCache.Inputs.Builder putFilePathLengthTimestamp(@NonNull
                                                           java.lang.String name,
                                                           @NonNull
                                                           java.io.File file)

Adds a file's path, length and timestamp as input parameters.

This is much faster than calculating the file hash and approximates it well enough for files that we know are not supposed to change often.

putString

public FileCache.Inputs.Builder putString(@NonNull
                                          java.lang.String name,
                                          @NonNull
                                          java.lang.String value)

Adds an input parameter with a String value. If a parameter with the same name exists, the parameter's value is overwritten.

putBoolean

public FileCache.Inputs.Builder putBoolean(@NonNull
                                           java.lang.String name,
                                           boolean value)

Adds an input parameter with a Boolean value. If a parameter with the same name exists, the parameter's value is overwritten.

putLong

public FileCache.Inputs.Builder putLong(@NonNull
                                        java.lang.String name,
                                        long value)

Adds an input parameter with a Long value. If a parameter with the same name exists, the parameter's value is overwritten.

build

public FileCache.Inputs build()

Builds an Inputs instance.

Throws:

java.lang.IllegalStateException - if the inputs are empty