Package org.gradle.api.resources

Schnittstelle TextResource

Alle Superschnittstellen:
Buildable
public interface TextResource extends Buildable
A read-only body of text backed by a string, file, archive entry, or other source. To create a text resource, use one of the factory methods in TextResourceFactory (e.g. project.resources.text.fromFile(myFile)).
Seit:
2.2

  • Methodenübersicht

    Modifizierer und Typ
    Methode
    Beschreibung
    File
    asFile()
    Same as asFile(Charset.defaultCharset().name()).
    File
    asFile(String charset)
    Returns a file containing the resource's text and using the given character encoding.
    Reader
    asReader()
    Returns an unbuffered Reader that allows the resource's text to be read.
    String
    asString()
    Returns a string containing the resource's text
    TaskDependency
    getBuildDependencies()
    Returns a dependency which contains the tasks which build this artifact.
    FileCollection
    getInputFiles()
    Returns the input files registered when this resource is used as task input.
    Object
    getInputProperties()
    Returns the input properties registered when this resource is used as task input.

  • Methodendetails

    • asString

      String asString()
      Returns a string containing the resource's text
      Gibt zurück:
      a string containing the resource's text

    • asReader

      Reader asReader()
      Returns an unbuffered Reader that allows the resource's text to be read. The caller is responsible for closing the reader.
      Gibt zurück:
      a reader that allows the resource's text to be read.

    • asFile

      File asFile(String charset)
      Returns a file containing the resource's text and using the given character encoding. If this resource is backed by a file with a matching encoding, that file may be returned. Otherwise, a temporary file will be created and returned.
      Parameter:
      charset - a character encoding (e.g. "utf-8")
      Gibt zurück:
      a file containing the resource's text and using the given character encoding

    • asFile

      File asFile()
      Same as asFile(Charset.defaultCharset().name()).

    • getInputProperties

      @Nullable @Optional @Input Object getInputProperties()
      Returns the input properties registered when this resource is used as task input. Not typically used directly.
      Gibt zurück:
      the input properties registered when this resource is used as task input

    • getInputFiles

      @Nullable @Optional @PathSensitive(NONE) @InputFiles FileCollection getInputFiles()
      Returns the input files registered when this resource is used as task input. Not typically used directly.
      Gibt zurück:
      the input files registered when this resource is used as task input

    • getBuildDependencies

      @Internal TaskDependency getBuildDependencies()
      Beschreibung aus Schnittstelle kopiert: Buildable
      Returns a dependency which contains the tasks which build this artifact. All Buildable implementations must ensure that the returned dependency object is live, so that it tracks changes to the dependencies of this buildable.
      Angegeben von:
      getBuildDependencies in Schnittstelle Buildable
      Gibt zurück:
      The dependency. Never returns null. Returns an empty dependency when this artifact is not built by any tasks.