Skip to content

Commit

Permalink
Document path and relativePath properties
Browse files Browse the repository at this point in the history
  • Loading branch information
michel-kraemer committed Oct 15, 2022
1 parent a8504f9 commit 0f43ce6
Showing 1 changed file with 13 additions and 3 deletions.
16 changes: 13 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -220,8 +220,8 @@ has been modified on the server since the last download <em>(default:
be applied to each source URL before it is downloaded. The action is called
with a <a href="#downloaddetails">DownloadDetails</a> object and can modify
some aspects of the target file in the destination directory (e.g. the
filename). If only one download source has been given, adding an
<code>eachFile</code> action will make the plugin fail.</dd>
filename or relative path). If only one download source has been given, adding
an <code>eachFile</code> action will make the plugin fail.</dd>
</dl>

<em>Tip!</em> You may provide Groovy Closures or Kotlin Lambdas to the `src`
Expand Down Expand Up @@ -373,7 +373,7 @@ DownloadDetails
If you specify an [`eachFile`](#general) action, it will be called with an
instance of the `DownloadDetails` class, which provides details about a
download source and its target file. It can be used to change some aspects of
the target file (e.g. its name).
the target file (e.g. its name or relative path).

The `DownloadDetails` class provides the following methods:

Expand All @@ -384,6 +384,16 @@ The `DownloadDetails` class provides the following methods:
<dd>Get the name of the target file</dd>
<dt>void setName(String)</dt>
<dd>Set the name of the target file</dd>
<dt>String getPath()</dt>
<dd>Get the path of the target file (including the filename), relative to
download directory</dd>
<dt>void setPath(String)</dt>
<dd>Set the path of the target file (including the filename)</dd>
<dt><a href="https://docs.gradle.org/current/javadoc/org/gradle/api/file/RelativePath.html">RelativePath</a> getRelativePath()</dt>
<dd>Get the path of the target file (including the filename), relative to
download directory</dd>
<dt>void setRelativePath(<a href="https://docs.gradle.org/current/javadoc/org/gradle/api/file/RelativePath.html">RelativePath</a> path)</dt>
<dd>Set the path of the target file (including the filename)</dd>
</dl>

Proxy configuration
Expand Down

0 comments on commit 0f43ce6

Please sign in to comment.