@Incubating interface TextResourceFactory
Creates TextResource
s backed by sources such as strings, files, and archive entries.
Example usages:
def sourcedFromString = resources.text.fromString("some text content") def sourcedFromFile = resources.text.fromFile("path/to/file.txt") task someTask {} // assumption: produces a text file and declares it as output def sourcedFromTask = resources.text.fromFile(someTask) def sourcedFromArchiveEntry = resources.text.fromArchiveEntry("path/to/archive.zip", "path/to/archive/entry.txt") configurations { someConfig } // assumption: contains a single archive def sourcedFromConfiguration = resources.text.fromArchiveEntry(configurations.someConfig, "path/to/archive/entry.txt") def sourceFromUri = resources.text.fromUri("https://path/to/the/resource")
File based factory methods optionally accept a character encoding. If no encoding is specified, the platform's default encoding is used.
Since
2.2
abstract fun fromArchiveEntry(archive: Any, entryPath: String, charset: String): TextResource
Creates a text resource backed by the archive entry at the given path within the given archive. The archive format is determined based on the archive's file extension. If the archive format is not supported or cannot be determined, any attempt to access the resource will fail with an exception. abstract fun fromArchiveEntry(archive: Any, path: String): TextResource
Same as |
|
abstract fun fromFile(file: Any, charset: String): TextResource
Creates a text resource backed by the given file. abstract fun fromFile(file: Any): TextResource
Same as |
|
abstract fun fromString(string: String): TextResource
Creates a text resource backed by the given string. |
|
abstract fun fromUri(uri: Any): TextResource
Creates a text resource backed by the given uri. |