SecondaryFile
class SecondaryFile
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
. call. The collection should only contain one file.
Summary
Public constructors |
|
---|---|
SecondaryFile( |
Public functions |
|
---|---|
File! |
This function is deprecated. use getFileCollection |
FileCollection! |
getFileCollection(project: Project!) Returns the |
FileCollection! |
Returns the |
java-static SecondaryFile! |
This function is deprecated. Use |
java-static SecondaryFile! |
incremental(file: FileCollection!) Creates a |
java-static SecondaryFile! |
incremental(file: Supplier<FileCollection!>!) Creates a |
java-static SecondaryFile! |
This function is deprecated. Use |
java-static SecondaryFile! |
nonIncremental(file: FileCollection!) Creates a |
java-static SecondaryFile! |
nonIncremental(file: Supplier<FileCollection!>!) Creates a |
Boolean |
Returns true if this secondary input changes can be handled by the receiving |
Public constructors
SecondaryFile
SecondaryFile(
secondaryInputFile: File!,
supportsIncrementalBuild: Boolean
)
Parameters | |
---|---|
secondaryInputFile: File! |
the |
supportsIncrementalBuild: Boolean |
if true, changes to the file can be handled incrementally by the transform |
See also | |
---|---|
incremental |
|
nonIncremental |
Public functions
getFile
fungetFile(): File!
Returns the file handle for this secondary input to a Transform.
Returns | |
---|---|
File! |
a file handle. |
getFileCollection
fun getFileCollection(project: Project!): FileCollection!
Returns the FileCollection
handle for this secondary input to a Transform
If this SecondaryFile
is constructed with File
, the supplied will be used to create a FileCollection
.
Parameters | |
---|---|
project: Project! |
for creating a FileCollection when necessary. |
Returns | |
---|---|
FileCollection! |
FileCollection of this SecondaryFile |
getFileCollection
fun getFileCollection(): FileCollection!
Returns the FileCollection
handle for this secondary input to a Transform
if this SecondaryFile
is constructed with FileCollection
. Otherwise, null is returned.
Note this method is not part of the API of SecondaryFile
.
Returns | |
---|---|
FileCollection! |
FileCollection of this SecondaryFile |
incremental
java-static funincremental(file: File!): SecondaryFile!
Creates a SecondaryFile
instance that, when modified, will not trigger a full, non-incremental build.
incremental
java-static fun incremental(file: FileCollection!): SecondaryFile!
Creates a SecondaryFile
instance that, when modified, will not trigger a full, non-incremental build.
incremental
java-static fun incremental(file: Supplier<FileCollection!>!): SecondaryFile!
Creates a SecondaryFile
instance that, when modified, will not trigger a full non-incremental build.
Parameters | |
---|---|
file: Supplier<FileCollection!>! |
a supplier of file collection. |
nonIncremental
java-static funnonIncremental(file: File!): SecondaryFile!
Creates a SecondaryFile
instance that, when modified, will always trigger a full, non-incremental build.
nonIncremental
java-static fun nonIncremental(file: FileCollection!): SecondaryFile!
Creates a SecondaryFile
instance that, when modified, will always trigger a full, non-incremental build.
nonIncremental
java-static fun nonIncremental(file: Supplier<FileCollection!>!): SecondaryFile!
Creates a SecondaryFile
instance that, when modified, will always trigger a full non-incremental build.
Parameters | |
---|---|
file: Supplier<FileCollection!>! |
a supplier of file collection. |
supportsIncrementalBuild
fun supportsIncrementalBuild(): Boolean
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 will trigger a non incremental build.
Returns | |
---|---|
Boolean |
true when the input file changes can be handled incrementally, false otherwise. |