com.likethesalad.placeholder.data.storage.FilesProvider.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of string-reference Show documentation
Show all versions of string-reference Show documentation
This is a Gradle plugin for Android applications which resolves XML string references in other XML strings.
package com.likethesalad.placeholder.data.storage
import com.likethesalad.placeholder.models.raw.RawFiles
import java.io.File
interface FilesProvider {
/**
* Returns the final file where all of the resolved strings
* will go to, this will be into the project's sourceSets resources.
* @param suffix - The values folder name suffix.
*/
fun getResolvedFile(suffix: String): File
fun getAllExpectedResolvedFiles(): List
/**
* Internal incremental file of all strings gathered from one values folder.
* @param suffix - The suffix of the values folder name.
*/
fun getGatheredStringsFile(suffix: String = ""): File
fun getAllGatheredStringsFiles(): List
/**
* Internal incremental file that contains only template strings and their values.
* @param suffix - The string file name suffix.
*/
fun getTemplateFile(suffix: String = ""): File
fun getAllTemplatesFiles(): List
fun getAllExpectedTemplatesFiles(): List
/**
* Returns a list of lists for all of the files within the values folder of the application/flavor except for the
* 'resolved.xml' file which is this plugin's output.
* @param valuesFolderName - The name of the folder where the placeholders are being resolved. This is usually
* `values` but it could change for other languages.
*/
fun getRawResourcesFilesForFolder(valuesFolderName: String): RawFiles
fun getAllFoldersRawResourcesFiles(): List
}