com.android.build.api.transform

Class SecondaryFile

java.lang.Object

com.android.build.api.transform.SecondaryFile

public class SecondaryFile
extends Object

A secondary input file 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

Constructor Summary

Constructors

Constructor and Description
SecondaryFile(File secondaryInputFile, boolean supportsIncrementalBuild)

Method Summary

Modifier and Type	Method and Description
File	getFile() Returns the file handle for this secondary input to a Transform.
static SecondaryFile	incremental(File file) Creates a SecondaryFile instance that, when modified, will not trigger a full, non-incremental build.
static SecondaryFile	nonIncremental(File 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
                     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

public static SecondaryFile incremental(@NonNull
                                        File file)

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

nonIncremental

public static SecondaryFile nonIncremental(@NonNull
                                           File file)

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

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 getFile() will trigger a non incremental build.

Returns:

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

getFile

@NonNull
public File getFile()

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

Returns:

a file handle.