# TextResourceFactory

API Documentation: | `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://example.com/resource")

    def sourceFromInsecureUri = resources.text.fromInsecureUri("http://example.com/resource")

File based factory methods optionally accept a character encoding. If no encoding is specified, the platform's default encoding is used.

### Properties

No properties

### Methods

Method | Description
`fromArchiveEntry(archive, path)` | Same as `fromArchiveEntry(archive, path, Charset.defaultCharset().name())`.
`fromArchiveEntry(archive, entryPath, charset)` | 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.
`fromFile(file)` | Same as `fromFile(file, Charset.defaultCharset())`.
`fromFile(file, charset)` | Creates a text resource backed by the given file.
`fromInsecureUri(uri)` | Creates a text resource backed by the given uri. NOTE: This method allows insecure protocols (like HTTP) to be used. Only use this method if you're comfortable with the dangers.
`fromString(string)` | Creates a text resource backed by the given string.
`fromUri(uri)` | Creates a text resource backed by the given uri.

### Script blocks

No script blocks

### Method details

#### `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. 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.

#### `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` `fromInsecureUri`(`Object` uri)

Creates a text resource backed by the given uri. NOTE: This method allows insecure protocols (like HTTP) to be used. Only use this method if you're comfortable with the dangers.

#### `TextResource` `fromString`(`String` string)

Creates a text resource backed by the given string.

#### `TextResource` `fromUri`(`Object` uri)

Creates a text resource backed by the given uri.