# SecondaryFile

# SecondaryFile

<br />

```
public class SecondaryFile
```

<br />

*** ** * ** ***

| **This class is deprecated.**   

A secondary input file(s) for a[Transform](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/transform/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](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/transform/Transform#transform(com.android.build.api.transform.TransformInvocation)). call. The collection should only contain one file.

## Summary

|                                                                                                                                                     ### Public constructors                                                                                                                                                     |
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [SecondaryFile](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/transform/SecondaryFile#SecondaryFile(java.io.File,boolean))`(` ` `[File](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/File.html)` secondaryInputFile,` ` boolean supportsIncrementalBuild` `)` |

|                                                            ### Public methods                                                             |
|-------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [File](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/File.html)                                                    | ~~[getFile](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/transform/SecondaryFile#getFile())~~`()` **This method is deprecated.** use getFileCollection <br />                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| [FileCollection](https://docs.gradle.org/current/javadoc/org/gradle/api/file/FileCollection.html)                                         | [getFileCollection](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/transform/SecondaryFile#getFileCollection())`()` Returns the[FileCollection](https://docs.gradle.org/current/javadoc/org/gradle/api/file/FileCollection.html)handle for this secondary input to a[Transform](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/transform/Transform)if this[SecondaryFile](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/transform/SecondaryFile)is constructed with[FileCollection](https://docs.gradle.org/current/javadoc/org/gradle/api/file/FileCollection.html). |
| [FileCollection](https://docs.gradle.org/current/javadoc/org/gradle/api/file/FileCollection.html)                                         | [getFileCollection](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/transform/SecondaryFile#getFileCollection(org.gradle.api.Project))`(`[Project](https://docs.gradle.org/current/javadoc/org/gradle/api/Project.html)` project)` Returns the[FileCollection](https://docs.gradle.org/current/javadoc/org/gradle/api/file/FileCollection.html)handle for this secondary input to a[Transform](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/transform/Transform)                                                                                                                                               |
| `static `[SecondaryFile](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/transform/SecondaryFile) | ~~[incremental](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/transform/SecondaryFile#incremental(java.io.File))~~`(`[File](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/File.html)` file)` **This method is deprecated.** Use[incremental](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/transform/SecondaryFile#incremental(org.gradle.api.file.FileCollection)) <br />                                                                                                                                                                                                             |
| `static `[SecondaryFile](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/transform/SecondaryFile) | [incremental](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/transform/SecondaryFile#incremental(org.gradle.api.file.FileCollection))`(`[FileCollection](https://docs.gradle.org/current/javadoc/org/gradle/api/file/FileCollection.html)` file)` Creates a[SecondaryFile](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/transform/SecondaryFile)instance that, when modified, will not trigger a full, non-incremental build.                                                                                                                                                                                 |
| `static `[SecondaryFile](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/transform/SecondaryFile) | [incremental](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/transform/SecondaryFile#incremental(java.util.function.Supplier<org.gradle.api.file.FileCollection>))`(`[Supplier](https://developer.android.com/reference/tools/gradle-api/8.3/null/java/util/function/Supplier)`<`[FileCollection](https://docs.gradle.org/current/javadoc/org/gradle/api/file/FileCollection.html)`> file)` Creates a[SecondaryFile](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/transform/SecondaryFile)instance that, when modified, will not trigger a full non-incremental build.                                        |
| `static `[SecondaryFile](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/transform/SecondaryFile) | ~~[nonIncremental](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/transform/SecondaryFile#nonIncremental(java.io.File))~~`(`[File](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/File.html)` file)` **This method is deprecated.** Use[nonIncremental](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/transform/SecondaryFile#nonIncremental(org.gradle.api.file.FileCollection)) <br />                                                                                                                                                                                                 |
| `static `[SecondaryFile](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/transform/SecondaryFile) | [nonIncremental](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/transform/SecondaryFile#nonIncremental(org.gradle.api.file.FileCollection))`(`[FileCollection](https://docs.gradle.org/current/javadoc/org/gradle/api/file/FileCollection.html)` file)` Creates a[SecondaryFile](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/transform/SecondaryFile)instance that, when modified, will always trigger a full, non-incremental build.                                                                                                                                                                        |
| `static `[SecondaryFile](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/transform/SecondaryFile) | [nonIncremental](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/transform/SecondaryFile#nonIncremental(java.util.function.Supplier<org.gradle.api.file.FileCollection>))`(`[Supplier](https://developer.android.com/reference/tools/gradle-api/8.3/null/java/util/function/Supplier)`<`[FileCollection](https://docs.gradle.org/current/javadoc/org/gradle/api/file/FileCollection.html)`> file)` Creates a[SecondaryFile](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/transform/SecondaryFile)instance that, when modified, will always trigger a full non-incremental build.                               |
| `boolean`                                                                                                                                 | [supportsIncrementalBuild](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/transform/SecondaryFile#supportsIncrementalBuild())`()` Returns true if this secondary input changes can be handled by the receiving[Transform](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/transform/Transform)incrementally.                                                                                                                                                                                                                                                                                                     |

## Public constructors

### SecondaryFile

```
public SecondaryFile(
    File secondaryInputFile,
    boolean supportsIncrementalBuild
)
```  

|                                                 Parameters                                                  |
|-------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [File](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/File.html)` secondaryInputFile` | the[File](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/File.html)this[SecondaryFile](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/transform/SecondaryFile)will point to |
| `boolean supportsIncrementalBuild`                                                                          | if true, changes to the file can be handled incrementally by the transform                                                                                                                                                                 |

|                                                                            See also                                                                            |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------|---|
| [incremental](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/transform/SecondaryFile#incremental(java.io.File))       |   |
| [nonIncremental](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/transform/SecondaryFile#nonIncremental(java.io.File)) |   |

## Public methods

### getFile

```
public File [getFile](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/transform/SecondaryFile#getFile())()
```
| **This method is deprecated.**   
|
| use getFileCollection

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

|                                        Returns                                         |
|----------------------------------------------------------------------------------------|----------------|
| [File](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/File.html) | a file handle. |

### getFileCollection

```
public FileCollection getFileCollection()
```

Returns the[FileCollection](https://docs.gradle.org/current/javadoc/org/gradle/api/file/FileCollection.html)handle for this secondary input to a[Transform](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/transform/Transform)if this[SecondaryFile](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/transform/SecondaryFile)is constructed with[FileCollection](https://docs.gradle.org/current/javadoc/org/gradle/api/file/FileCollection.html). Otherwise, null is returned.

Note this method is not part of the API of[SecondaryFile](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/transform/SecondaryFile).  

|                                              Returns                                              |
|---------------------------------------------------------------------------------------------------|--------------------------------------|
| [FileCollection](https://docs.gradle.org/current/javadoc/org/gradle/api/file/FileCollection.html) | FileCollection of this SecondaryFile |

### getFileCollection

```
public FileCollection getFileCollection(Project project)
```

Returns the[FileCollection](https://docs.gradle.org/current/javadoc/org/gradle/api/file/FileCollection.html)handle for this secondary input to a[Transform](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/transform/Transform)

If this[SecondaryFile](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/transform/SecondaryFile)is constructed with[File](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/File.html), the supplied will be used to create a[FileCollection](https://docs.gradle.org/current/javadoc/org/gradle/api/file/FileCollection.html).  

|                                        Parameters                                        |
|------------------------------------------------------------------------------------------|-----------------------------------------------|
| [Project](https://docs.gradle.org/current/javadoc/org/gradle/api/Project.html)` project` | for creating a FileCollection when necessary. |

|                                              Returns                                              |
|---------------------------------------------------------------------------------------------------|--------------------------------------|
| [FileCollection](https://docs.gradle.org/current/javadoc/org/gradle/api/file/FileCollection.html) | FileCollection of this SecondaryFile |

### incremental

```
public static SecondaryFile [incremental](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/transform/SecondaryFile#incremental(java.io.File))(File file)
```
| **This method is deprecated.**   
|
| Use[incremental](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/transform/SecondaryFile#incremental(org.gradle.api.file.FileCollection))

Creates a[SecondaryFile](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/transform/SecondaryFile)instance that, when modified, will not trigger a full, non-incremental build.  

### incremental

```
public static SecondaryFile incremental(FileCollection file)
```

Creates a[SecondaryFile](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/transform/SecondaryFile)instance that, when modified, will not trigger a full, non-incremental build.  

### incremental

```
public static SecondaryFile incremental(Supplier<FileCollection> file)
```

Creates a[SecondaryFile](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/transform/SecondaryFile)instance that, when modified, will not trigger a full non-incremental build.  

|                                                                                                      Parameters                                                                                                       |
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------|
| [Supplier](https://developer.android.com/reference/tools/gradle-api/8.3/null/java/util/function/Supplier)`<`[FileCollection](https://docs.gradle.org/current/javadoc/org/gradle/api/file/FileCollection.html)`> file` | a supplier of file collection. |

### nonIncremental

```
public static SecondaryFile [nonIncremental](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/transform/SecondaryFile#nonIncremental(java.io.File))(File file)
```
| **This method is deprecated.**   
|
| Use[nonIncremental](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/transform/SecondaryFile#nonIncremental(org.gradle.api.file.FileCollection))

Creates a[SecondaryFile](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/transform/SecondaryFile)instance that, when modified, will always trigger a full, non-incremental build.  

### nonIncremental

```
public static SecondaryFile nonIncremental(FileCollection file)
```

Creates a[SecondaryFile](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/transform/SecondaryFile)instance that, when modified, will always trigger a full, non-incremental build.  

### nonIncremental

```
public static SecondaryFile nonIncremental(Supplier<FileCollection> file)
```

Creates a[SecondaryFile](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/transform/SecondaryFile)instance that, when modified, will always trigger a full non-incremental build.  

|                                                                                                      Parameters                                                                                                       |
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------|
| [Supplier](https://developer.android.com/reference/tools/gradle-api/8.3/null/java/util/function/Supplier)`<`[FileCollection](https://docs.gradle.org/current/javadoc/org/gradle/api/file/FileCollection.html)`> file` | a supplier of file collection. |

### supportsIncrementalBuild

```
public boolean supportsIncrementalBuild()
```

Returns true if this secondary input changes can be handled by the receiving[Transform](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/transform/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. |