@Incubating public interface TextResourceFactory
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")File based factory methods optionally accept a character encoding. If no encoding is specified, the platform's default encoding is used.
Modifier and Type | Method and Description |
---|---|
TextResource |
fromArchiveEntry(Object archive,
String path)
Same as
fromArchiveEntry(archive, path, Charset.defaultCharset().name()) . |
TextResource |
fromArchiveEntry(Object archive,
String entryPath,
String charset)
Creates a text resource backed by the archive entry at the given path within the given archive.
|
TextResource |
fromFile(Object file)
Same as
fromFile(file, Charset.defaultCharset()) . |
TextResource |
fromFile(Object file,
String charset)
Creates a text resource backed by the given file.
|
TextResource |
fromString(String string)
Creates a text resource backed by the given string.
|
TextResource fromString(String string)
string
- a stringTextResource fromFile(Object file, String charset)
file
- a text file evaluated as per Project.files(Object...)
charset
- the file's character encoding (e.g. "utf-8"
)TextResource fromFile(Object file)
fromFile(file, Charset.defaultCharset())
.TextResource fromArchiveEntry(Object archive, String entryPath, String charset)
archive
- an archive file evaluated as per Project.files(Object...)
entryPath
- the path to an archive entrycharset
- the archive entry's character encoding (e.g. "utf-8"
)TextResource fromArchiveEntry(Object archive, String path)
fromArchiveEntry(archive, path, Charset.defaultCharset().name())
.