# AndroidResources

# AndroidResources

<br />

```
public interface AndroidResources
```

<br />

Known direct subclasses  
[AaptOptions](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/AaptOptions),[ApplicationAndroidResources](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/ApplicationAndroidResources),[DynamicFeatureAndroidResources](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/DynamicFeatureAndroidResources),[LibraryAndroidResources](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/LibraryAndroidResources),[TestAndroidResources](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/TestAndroidResources)  

|--------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------|
| [AaptOptions](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/AaptOptions)                                       | **This interface is deprecated.**Renamed to AndroidResources |
| [ApplicationAndroidResources](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/ApplicationAndroidResources)       |                                                              |
| [DynamicFeatureAndroidResources](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/DynamicFeatureAndroidResources) |                                                              |
| [LibraryAndroidResources](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/LibraryAndroidResources)               |                                                              |
| [TestAndroidResources](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/TestAndroidResources)                     |                                                              |

*** ** * ** ***

DSL object for configuring aapt options.

## Summary

|                                                                                                                                                                                                            ### Public methods                                                                                                                                                                                                             |
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `abstract void`                                                                                                                                                                                                                                                                                                                                                                                                                           | ~~[additionalParameters](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/AndroidResources#additionalParameters(kotlin.String))~~`(@`[NonNull](https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull)` `[String](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html)` params)` **This method is deprecated.**Replaced with property additionalParameters |
| `abstract void`                                                                                                                                                                                                                                                                                                                                                                                                                           | ~~[additionalParameters](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/AndroidResources#additionalParameters(kotlin.Array))~~`(@`[NonNull](https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull)` `[String](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html)` params)` **This method is deprecated.**Replaced with property additionalParameters  |
| `abstract @`[NonNull](https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull)` `[List](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html)`<@`[NonNull](https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull)` `[String](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html)`>`             | [getAdditionalParameters](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/AndroidResources#getAdditionalParameters())`()` List of additional parameters to pass to`aapt`.                                                                                                                                                                                                                                                       |
| `abstract boolean`                                                                                                                                                                                                                                                                                                                                                                                                                        | [getFailOnMissingConfigEntry](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/AndroidResources#getFailOnMissingConfigEntry())`()` Forces aapt to return an error if it fails to find an entry for a configuration.                                                                                                                                                                                                              |
| `abstract `[String](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html)                                                                                                                                                                                                                                                                                                                                   | [getIgnoreAssetsPattern](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/AndroidResources#getIgnoreAssetsPattern())`()` Pattern describing assets to be ignored.                                                                                                                                                                                                                                                                |
| `abstract @`[NonNull](https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull)` `[Collection](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Collection.html)`<@`[NonNull](https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull)` `[String](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html)`>` | [getIgnoreAssetsPatterns](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/AndroidResources#getIgnoreAssetsPatterns())`()` Patterns describing assets to be ignored.                                                                                                                                                                                                                                                             |
| `abstract boolean`                                                                                                                                                                                                                                                                                                                                                                                                                        | `@`[Incubating](https://docs.gradle.org/current/javadoc/org/gradle/api/Incubating.html) [getNamespaced](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/AndroidResources#getNamespaced())`()` Indicates whether the resources in this sub-project are fully namespaced.                                                                                                                                                         |
| `abstract @`[NonNull](https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull)` `[Collection](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Collection.html)`<@`[NonNull](https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull)` `[String](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html)`>` | [getNoCompress](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/AndroidResources#getNoCompress())`()` File extensions of Android resources, assets, and Java resources to be stored uncompressed in the APK.                                                                                                                                                                                                                    |
| `abstract void`                                                                                                                                                                                                                                                                                                                                                                                                                           | ~~[noCompress](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/AndroidResources#noCompress(kotlin.String))~~`(@`[NonNull](https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull)` `[String](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html)` noCompress)` **This method is deprecated.**Replaced with property noCompress                           |
| `abstract void`                                                                                                                                                                                                                                                                                                                                                                                                                           | ~~[noCompress](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/AndroidResources#noCompress(kotlin.Array))~~`(@`[NonNull](https://developer.android.com/reference/tools/gradle-api/8.3/null/androidx/annotation/NonNull)` `[String](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html)` noCompress)` **This method is deprecated.**Replaced with property noCompress                            |
| `abstract void`                                                                                                                                                                                                                                                                                                                                                                                                                           | [setFailOnMissingConfigEntry](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/AndroidResources#setFailOnMissingConfigEntry(kotlin.Boolean))`(boolean failOnMissingConfigEntry)` Forces aapt to return an error if it fails to find an entry for a configuration.                                                                                                                                                                |
| `abstract void`                                                                                                                                                                                                                                                                                                                                                                                                                           | [setIgnoreAssetsPattern](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/AndroidResources#setIgnoreAssetsPattern(kotlin.String))`(`[String](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html)` ignoreAssetsPattern)` Pattern describing assets to be ignored.                                                                                                                                 |
| `abstract void`                                                                                                                                                                                                                                                                                                                                                                                                                           | `@`[Incubating](https://docs.gradle.org/current/javadoc/org/gradle/api/Incubating.html) [setNamespaced](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/AndroidResources#setNamespaced(kotlin.Boolean))`(boolean namespaced)` Indicates whether the resources in this sub-project are fully namespaced.                                                                                                                         |

## Public methods

### additionalParameters

```
abstract void [additionalParameters](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/AndroidResources#additionalParameters(kotlin.String))(@NonNull String params)
```
| **This method is deprecated.**   
| Replaced with property additionalParameters

Adds additional parameters to be passed to`aapt`.  

### additionalParameters

```
abstract void [additionalParameters](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/AndroidResources#additionalParameters(kotlin.Array))(@NonNull String params)
```
| **This method is deprecated.**   
| Replaced with property additionalParameters

Adds additional parameters to be passed to`aapt`.  

### getAdditionalParameters

```
abstract @NonNull List<@NonNull String> getAdditionalParameters()
```

List of additional parameters to pass to`aapt`.  

### getFailOnMissingConfigEntry

```
abstract boolean getFailOnMissingConfigEntry()
```

Forces aapt to return an error if it fails to find an entry for a configuration.

See`aapt --help`  

### getIgnoreAssetsPattern

```
abstract String getIgnoreAssetsPattern()
```

Pattern describing assets to be ignored.

This is[ignoreAssetsPatterns](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/AndroidResources#ignoreAssetsPatterns())joined by ':'.  

### getIgnoreAssetsPatterns

```
abstract @NonNull Collection<@NonNull String> getIgnoreAssetsPatterns()
```

Patterns describing assets to be ignored.

If empty, defaults to`["!.svn", "!.git", "!.ds_store", "!*.scc", ".*", "<dir>_*", "!CVS", "!thumbs.db", "!picasa.ini", "!*~"]`  

### getNamespaced

```
@Incubating
abstract boolean getNamespaced()
```

Indicates whether the resources in this sub-project are fully namespaced.

This property is incubating and may change in a future release.  

### getNoCompress

```
abstract @NonNull Collection<@NonNull String> getNoCompress()
```

File extensions of Android resources, assets, and Java resources to be stored uncompressed in the APK. Adding an empty extension (e.g., setting`noCompress ''`) will disable compression for all Android resources, assets, and Java resources.  

### noCompress

```
abstract void [noCompress](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/AndroidResources#noCompress(kotlin.String))(@NonNull String noCompress)
```
| **This method is deprecated.**   
| Replaced with property noCompress

Adds a file extension of Android resources, assets, and Java resources to be stored uncompressed in the APK. Adding an empty extension (i.e.,`noCompress('')`) will disable compression for all Android resources, assets, and Java resources.  

### noCompress

```
abstract void [noCompress](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/AndroidResources#noCompress(kotlin.Array))(@NonNull String noCompress)
```
| **This method is deprecated.**   
| Replaced with property noCompress

Adds file extensions of Android resources, assets, and Java resources to be stored uncompressed in the APK. Adding an empty extension (e.g.,`noCompress('')`) will disable compression for all Android resources, assets, and Java resources.  

### setFailOnMissingConfigEntry

```
abstract void setFailOnMissingConfigEntry(boolean failOnMissingConfigEntry)
```

Forces aapt to return an error if it fails to find an entry for a configuration.

See`aapt --help`  

### setIgnoreAssetsPattern

```
abstract void setIgnoreAssetsPattern(String ignoreAssetsPattern)
```

Pattern describing assets to be ignored.

This is[ignoreAssetsPatterns](https://developer.android.com/reference/tools/gradle-api/8.3/null/com/android/build/api/dsl/AndroidResources#ignoreAssetsPatterns())joined by ':'.  

### setNamespaced

```
@Incubating
abstract void setNamespaced(boolean namespaced)
```

Indicates whether the resources in this sub-project are fully namespaced.

This property is incubating and may change in a future release.