com.android.build.api.transform

Class SecondaryFile

java.lang.Object

com.android.build.api.transform.SecondaryFile

public class SecondaryFile
extends java.lang.Object

A secondary input file(s) for a Transform. A secondary input is part of the transform inputs and can be decorated to indicate if a change to the input would trigger a non incremental Transform.transform(TransformInvocation). call. The collection should only contain one file.

Constructor Summary

Constructors

Constructor and Description
SecondaryFile(java.io.File secondaryInputFile, boolean supportsIncrementalBuild)

Method Summary

Modifier and Type	Method and Description
java.io.File	getFile() Deprecated. use getFileCollection(org.gradle.api.Project)
FileCollection	getFileCollection(Project project) Returns the FileCollection handle for this secondary input to a Transform If this SecondaryFile is constructed with File, the supplied Project will be used to create a FileCollection.
static SecondaryFile	incremental(java.io.File file) Deprecated. Use incremental(FileCollection)
static SecondaryFile	incremental(FileCollection file) Creates a SecondaryFile instance that, when modified, will not trigger a full, non-incremental build.
static SecondaryFile	incremental(java.util.function.Supplier<FileCollection> file) Creates a SecondaryFile instance that, when modified, will not trigger a full non-incremental build.
static SecondaryFile	nonIncremental(java.io.File file) Deprecated. Use nonIncremental(FileCollection)
static SecondaryFile	nonIncremental(FileCollection file) Creates a SecondaryFile instance that, when modified, will always trigger a full, non-incremental build.
static SecondaryFile	nonIncremental(java.util.function.Supplier<FileCollection> file) Creates a SecondaryFile instance that, when modified, will always trigger a full non-incremental build.
boolean	supportsIncrementalBuild() Returns true if this secondary input changes can be handled by the receiving Transform incrementally.

Methods inherited from class java.lang.Object

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

Constructor Detail

SecondaryFile

public SecondaryFile(@NonNull
                     java.io.File secondaryInputFile,
                     boolean supportsIncrementalBuild)

Parameters:

secondaryInputFile - the File this SecondaryFile will point to

supportsIncrementalBuild - if true, changes to the file can be handled incrementally by the transform

See Also:

incremental(File), nonIncremental(File)

Method Detail

incremental

@Deprecated
public static SecondaryFile incremental(@NonNull
                                                    java.io.File file)

Deprecated. Use incremental(FileCollection)

Creates a SecondaryFile instance that, when modified, will not trigger a full, non-incremental build.

incremental

public static SecondaryFile incremental(@NonNull
                                        FileCollection file)

Creates a SecondaryFile instance that, when modified, will not trigger a full, non-incremental build.

incremental

public static SecondaryFile incremental(@NonNull
                                        java.util.function.Supplier<FileCollection> file)

Creates a SecondaryFile instance that, when modified, will not trigger a full non-incremental build.

Parameters:

file - a supplier of file collection.

nonIncremental

@Deprecated
public static SecondaryFile nonIncremental(@NonNull
                                                       java.io.File file)

Deprecated. Use nonIncremental(FileCollection)

Creates a SecondaryFile instance that, when modified, will always trigger a full, non-incremental build.

nonIncremental

public static SecondaryFile nonIncremental(@NonNull
                                           FileCollection file)

Creates a SecondaryFile instance that, when modified, will always trigger a full, non-incremental build.

nonIncremental

public static SecondaryFile nonIncremental(@NonNull
                                           java.util.function.Supplier<FileCollection> file)

Creates a SecondaryFile instance that, when modified, will always trigger a full non-incremental build.

Parameters:

file - a supplier of file collection.

supportsIncrementalBuild

public boolean supportsIncrementalBuild()

Returns true if this secondary input changes can be handled by the receiving Transform incrementally. If false, a change to the file returned by getFileCollection(org.gradle.api.Project) will trigger a non incremental build.

Returns:

true when the input file changes can be handled incrementally, false otherwise.

getFileCollection

public FileCollection getFileCollection(@NonNull
                                        Project project)

Returns the FileCollection handle for this secondary input to a Transform If this SecondaryFile is constructed with File, the supplied Project will be used to create a FileCollection.

Parameters:

project - for creating a FileCollection when necessary.

Returns:

FileCollection of this SecondaryFile

getFile

@Deprecated
public java.io.File getFile()

Deprecated. use getFileCollection(org.gradle.api.Project)

Returns the file handle for this secondary input to a Transform.

Returns:

a file handle.