CINXE.COM

<!DOCTYPE HTML>  <html lang="en"> <head>  <title>DirectoryProperty (Gradle API 8.11.1)</title> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <link rel="stylesheet" type="text/css" href="../../../../javadoc.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.min.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> <script type="text/javascript" src="../../../../script.js"></script> <script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script> <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>  <script type="text/javascript" src="../../../../jquery/jquery-3.6.1.min.js"></script> <script type="text/javascript" src="../../../../jquery/jquery-ui.min.js"></script>  <link rel="prefetch" href="/site-header.html"><link rel="prefetch" href="/site-footer.html">    <link rel="stylesheet" href="/build-tool-modern.css">  <style type="text/css"> cloudflare-app[app="cookiless"] cookiless-div { font-family: "Lato","Helvetica Neue",Arial,sans-serif; font-weight: 300; background-color: #02303A !important; opacity: 1 !important; } cloudflare-app[app="cookiless"] cookiless-div .iAccept { font-weight: 400; } @media (max-width: 1023px) { .notification { display: none; } } @media (min-width: 1024px) { cloudflare-app[app="cookiless"] { position: fixed !important; width: 400px !important; left: auto !important; right: 0 !important; bottom: 0 !important; } /* Overrides for banner */ .notification { height: 44px; line-height: 44px; vertical-align: middle; background-color: #02303A; text-align: center; color: white; z-index: 1; } .notification a { color: white; text-decoration: underline; } .notification ~ .main-content #header #toc, .notification ~ .main-content .toc { top: 98px; } } </style>  <script src="/build-tool.js" type="text/javascript" defer></script>  <script> (function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start': new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0], j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src= 'https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f); })(window,document,'script','dataLayer','GTM-WRTQKGT'); </script>   <script type="text/javascript" defer> window.siteDecorateVersion = "8.11.1"; </script> <script src="/decorate.js" type="text/javascript" defer></script>     <link rel="canonical" href="https://docs.gradle.org/current/javadoc/org/gradle/api/file/DirectoryProperty.html" /> <script type="application/ld+json"> { "@context": "http://schema.org", "@type": "WebPage", "name": "Gradle Documentation", "url": "https://docs.gradle.org/current/javadoc/org/gradle/api/file/DirectoryProperty.html" } </script> <meta name="google-site-verification" content="kCnBfMu0lbnMpfg3t1-ZgJHbSOSYRSquWsxQ4HgqLkA" /></head> <body> <noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-WRTQKGT" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>  <script type="text/javascript"> var data = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6}; var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; var altColor = "altColor"; var rowColor = "rowColor"; var tableTab = "tableTab"; var activeTableTab = "activeTableTab"; var pathtoroot = "../../../../"; var useModuleDirectories = true; loadScripts(document, 'script');</script> <noscript> <div>JavaScript is disabled on your browser.</div> </noscript> <header role="banner"> <nav role="navigation"> <div class="fixedNav">  <div class="topNav"><a id="navbar.top">  </a> <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> <a id="navbar.top.firstrow">  </a> <ul class="navList" title="Navigation"> <li><a href="../../../../index.html">Overview</a></li> <li><a href="package-summary.html">Package</a></li> <li class="navBarCell1Rev">Class</li> <li><a href="package-tree.html">Tree</a></li> <li><a href="../../../../deprecated-list.html">Deprecated</a></li> <li><a href="../../../../index-all.html">Index</a></li> <li><a href="../../../../help-doc.html">Help</a></li> </ul> </div> <div class="subNav"> <ul class="navList" id="allclasses_navbar_top"> <li><a href="../../../../allclasses.html">All Classes</a></li> </ul> <ul class="navListSearch"> <li><label for="search">SEARCH:</label> <input type="text" id="search" value="search" disabled="disabled"> <input type="reset" id="reset" value="reset" disabled="disabled"> </li> </ul> <div> <script type="text/javascript"> </script> <noscript> <div>JavaScript is disabled on your browser.</div> </noscript> </div> <div> <ul class="subNavList"> <li>Summary: </li> <li>Nested | </li> <li>Field | </li> <li>Constr | </li> <li><a href="#method.summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li>Field | </li> <li>Constr | </li> <li><a href="#method.detail">Method</a></li> </ul> </div> <a id="skip.navbar.top">  </a></div>  </div> <div class="navPadding"> </div> <script type="text/javascript"> </script> </nav> </header>  <main role="main"> <div class="header"> <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.gradle.api.file</a></div> <h2 title="Interface DirectoryProperty" class="title">Interface DirectoryProperty</h2> </div> <div class="contentContainer"> <div class="description"> <ul class="blockList"> <li class="blockList"> <dl> <dt>All Superinterfaces:</dt> <dd><code><a href="FileSystemLocationProperty.html" title="interface in org.gradle.api.file">FileSystemLocationProperty</a><<a href="Directory.html" title="interface in org.gradle.api.file">Directory</a>></code>, <code><a href="../provider/HasConfigurableValue.html" title="interface in org.gradle.api.provider">HasConfigurableValue</a></code>, <code><a href="../provider/Property.html" title="interface in org.gradle.api.provider">Property</a><<a href="Directory.html" title="interface in org.gradle.api.file">Directory</a>></code>, <code><a href="../provider/Provider.html" title="interface in org.gradle.api.provider">Provider</a><<a href="Directory.html" title="interface in org.gradle.api.file">Directory</a>></code>, <code><a href="../provider/SupportsConvention.html" title="interface in org.gradle.api.provider">SupportsConvention</a></code></dd> </dl> <hr> <pre>public interface <span class="typeNameLabel">DirectoryProperty</span> extends <a href="FileSystemLocationProperty.html" title="interface in org.gradle.api.file">FileSystemLocationProperty</a><<a href="Directory.html" title="interface in org.gradle.api.file">Directory</a>></pre> <div class="block">Represents some configurable directory location, whose value is mutable. <p> You can create a <a href="DirectoryProperty.html" title="interface in org.gradle.api.file"><code>DirectoryProperty</code></a> using <a href="../model/ObjectFactory.html#directoryProperty()"><code>ObjectFactory.directoryProperty()</code></a>. </p> <p><b>Note:</b> This interface is not intended for implementation by build script or plugin authors.</p></div> <dl> <dt><span class="simpleTagLabel">Since:</span></dt> <dd>4.3</dd> </dl> </li> </ul> </div> <div class="summary"> <ul class="blockList"> <li class="blockList">  <section> <ul class="blockList"> <li class="blockList"><a id="method.summary">  </a> <h3>Method Summary</h3> <table class="memberSummary"> <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> <tr> <th class="colFirst" scope="col">Modifier and Type</th> <th class="colSecond" scope="col">Method</th> <th class="colLast" scope="col">Description</th> </tr> <tr id="i0" class="altColor"> <td class="colFirst"><code><a href="DirectoryProperty.html" title="interface in org.gradle.api.file">DirectoryProperty</a></code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#convention(org.gradle.api.file.Directory)">convention</a></span>(<a href="Directory.html" title="interface in org.gradle.api.file">Directory</a> value)</code></th> <td class="colLast"> <div class="block">Specifies the value to use as the convention (default value) for this property.</div> </td> </tr> <tr id="i1" class="rowColor"> <td class="colFirst"><code><a href="DirectoryProperty.html" title="interface in org.gradle.api.file">DirectoryProperty</a></code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#convention(org.gradle.api.provider.Provider)">convention</a></span>(<a href="../provider/Provider.html" title="interface in org.gradle.api.provider">Provider</a><? extends <a href="Directory.html" title="interface in org.gradle.api.file">Directory</a>> provider)</code></th> <td class="colLast"> <div class="block">Specifies the provider to be used to query the convention (default value) for this property.</div> </td> </tr> <tr id="i2" class="altColor"> <td class="colFirst"><code><a href="../provider/Provider.html" title="interface in org.gradle.api.provider">Provider</a><<a href="Directory.html" title="interface in org.gradle.api.file">Directory</a>></code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#dir(java.lang.String)">dir</a></span>(java.lang.String path)</code></th> <td class="colLast"> <div class="block">Returns a <a href="Directory.html" title="interface in org.gradle.api.file"><code>Directory</code></a> whose value is the given path resolved relative to the value of this directory.</div> </td> </tr> <tr id="i3" class="rowColor"> <td class="colFirst"><code><a href="../provider/Provider.html" title="interface in org.gradle.api.provider">Provider</a><<a href="Directory.html" title="interface in org.gradle.api.file">Directory</a>></code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#dir(org.gradle.api.provider.Provider)">dir</a></span>(<a href="../provider/Provider.html" title="interface in org.gradle.api.provider">Provider</a><? extends java.lang.CharSequence> path)</code></th> <td class="colLast"> <div class="block">Returns a <a href="Directory.html" title="interface in org.gradle.api.file"><code>Directory</code></a> whose value is the given path resolved relative to the value of this directory.</div> </td> </tr> <tr id="i4" class="altColor"> <td class="colFirst"><code><a href="../provider/Provider.html" title="interface in org.gradle.api.provider">Provider</a><<a href="RegularFile.html" title="interface in org.gradle.api.file">RegularFile</a>></code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#file(java.lang.String)">file</a></span>(java.lang.String path)</code></th> <td class="colLast"> <div class="block">Returns a <a href="RegularFile.html" title="interface in org.gradle.api.file"><code>RegularFile</code></a> whose value is the given path resolved relative to the value of this directory.</div> </td> </tr> <tr id="i5" class="rowColor"> <td class="colFirst"><code><a href="../provider/Provider.html" title="interface in org.gradle.api.provider">Provider</a><<a href="RegularFile.html" title="interface in org.gradle.api.file">RegularFile</a>></code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#file(org.gradle.api.provider.Provider)">file</a></span>(<a href="../provider/Provider.html" title="interface in org.gradle.api.provider">Provider</a><? extends java.lang.CharSequence> path)</code></th> <td class="colLast"> <div class="block">Returns a <a href="RegularFile.html" title="interface in org.gradle.api.file"><code>RegularFile</code></a> whose value is the given path resolved relative to the value of this directory.</div> </td> </tr> <tr id="i6" class="altColor"> <td class="colFirst"><code><a href="DirectoryProperty.html" title="interface in org.gradle.api.file">DirectoryProperty</a></code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#fileProvider(org.gradle.api.provider.Provider)">fileProvider</a></span>(<a href="../provider/Provider.html" title="interface in org.gradle.api.provider">Provider</a><java.io.File> provider)</code></th> <td class="colLast"> <div class="block">Sets the location of this file, using a <code>File</code> <a href="../provider/Provider.html" title="interface in org.gradle.api.provider"><code>Provider</code></a> instance.</div> </td> </tr> <tr id="i7" class="rowColor"> <td class="colFirst"><code><a href="FileCollection.html" title="interface in org.gradle.api.file">FileCollection</a></code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#files(java.lang.Object...)">files</a></span>(java.lang.Object... paths)</code></th> <td class="colLast"> <div class="block">Returns a <a href="FileCollection.html" title="interface in org.gradle.api.file"><code>FileCollection</code></a> containing the given files, whose locations are the given paths resolved relative to this directory, as defined by <a href="../Project.html#files(java.lang.Object...)"><code>Project.files(Object...)</code></a>.</div> </td> </tr> <tr id="i8" class="altColor"> <td class="colFirst"><code><a href="DirectoryProperty.html" title="interface in org.gradle.api.file">DirectoryProperty</a></code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#fileValue(java.io.File)">fileValue</a></span>(java.io.File file)</code></th> <td class="colLast"> <div class="block">Sets the location of this file, using a <code>File</code> instance.</div> </td> </tr> <tr id="i9" class="rowColor"> <td class="colFirst"><code><a href="FileTree.html" title="interface in org.gradle.api.file">FileTree</a></code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAsFileTree()">getAsFileTree</a></span>()</code></th> <td class="colLast"> <div class="block">Returns a <a href="FileTree.html" title="interface in org.gradle.api.file"><code>FileTree</code></a> that allows the files and directories contained in this directory to be queried.</div> </td> </tr> <tr id="i10" class="altColor"> <td class="colFirst"><code><a href="DirectoryProperty.html" title="interface in org.gradle.api.file">DirectoryProperty</a></code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#value(org.gradle.api.file.Directory)">value</a></span>(<a href="Directory.html" title="interface in org.gradle.api.file">Directory</a> value)</code></th> <td class="colLast"> <div class="block">Sets the value of the property to the given value, replacing whatever value the property already had.</div> </td> </tr> <tr id="i11" class="rowColor"> <td class="colFirst"><code><a href="DirectoryProperty.html" title="interface in org.gradle.api.file">DirectoryProperty</a></code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#value(org.gradle.api.provider.Provider)">value</a></span>(<a href="../provider/Provider.html" title="interface in org.gradle.api.provider">Provider</a><? extends <a href="Directory.html" title="interface in org.gradle.api.file">Directory</a>> provider)</code></th> <td class="colLast"> <div class="block">Sets the property to have the same value as the given provider, replacing whatever value the property already had.</div> </td> </tr> </table> <ul class="blockList"> <li class="blockList"><a id="methods.inherited.from.class.org.gradle.api.file.FileSystemLocationProperty">  </a> <h3>Methods inherited from interface org.gradle.api.file.<a href="FileSystemLocationProperty.html" title="interface in org.gradle.api.file">FileSystemLocationProperty</a></h3> <code><a href="FileSystemLocationProperty.html#getAsFile()">getAsFile</a>, <a href="FileSystemLocationProperty.html#getLocationOnly()">getLocationOnly</a>, <a href="FileSystemLocationProperty.html#set(java.io.File)">set</a></code></li> </ul> <ul class="blockList"> <li class="blockList"><a id="methods.inherited.from.class.org.gradle.api.provider.HasConfigurableValue">  </a> <h3>Methods inherited from interface org.gradle.api.provider.<a href="../provider/HasConfigurableValue.html" title="interface in org.gradle.api.provider">HasConfigurableValue</a></h3> <code><a href="../provider/HasConfigurableValue.html#disallowChanges()">disallowChanges</a>, <a href="../provider/HasConfigurableValue.html#disallowUnsafeRead()">disallowUnsafeRead</a>, <a href="../provider/HasConfigurableValue.html#finalizeValueOnRead()">finalizeValueOnRead</a></code></li> </ul> <ul class="blockList"> <li class="blockList"><a id="methods.inherited.from.class.org.gradle.api.provider.Property">  </a> <h3>Methods inherited from interface org.gradle.api.provider.<a href="../provider/Property.html" title="interface in org.gradle.api.provider">Property</a></h3> <code><a href="../provider/Property.html#finalizeValue()">finalizeValue</a>, <a href="../provider/Property.html#set(org.gradle.api.provider.Provider)">set</a>, <a href="../provider/Property.html#set(T)">set</a>, <a href="../provider/Property.html#unset()">unset</a>, <a href="../provider/Property.html#unsetConvention()">unsetConvention</a></code></li> </ul> <ul class="blockList"> <li class="blockList"><a id="methods.inherited.from.class.org.gradle.api.provider.Provider">  </a> <h3>Methods inherited from interface org.gradle.api.provider.<a href="../provider/Provider.html" title="interface in org.gradle.api.provider">Provider</a></h3> <code><a href="../provider/Provider.html#filter(org.gradle.api.specs.Spec)">filter</a>, <a href="../provider/Provider.html#flatMap(org.gradle.api.Transformer)">flatMap</a>, <a href="../provider/Provider.html#forUseAtConfigurationTime()">forUseAtConfigurationTime</a>, <a href="../provider/Provider.html#get()">get</a>, <a href="../provider/Provider.html#getOrElse(T)">getOrElse</a>, <a href="../provider/Provider.html#getOrNull()">getOrNull</a>, <a href="../provider/Provider.html#isPresent()">isPresent</a>, <a href="../provider/Provider.html#map(org.gradle.api.Transformer)">map</a>, <a href="../provider/Provider.html#orElse(org.gradle.api.provider.Provider)">orElse</a>, <a href="../provider/Provider.html#orElse(T)">orElse</a>, <a href="../provider/Provider.html#zip(org.gradle.api.provider.Provider,java.util.function.BiFunction)">zip</a></code></li> </ul> </li> </ul> </section> </li> </ul> </div> <div class="details"> <ul class="blockList"> <li class="blockList">  <section> <ul class="blockList"> <li class="blockList"><a id="method.detail">  </a> <h3>Method Detail</h3> <a id="getAsFileTree()">  </a> <ul class="blockList"> <li class="blockList"> <h4>getAsFileTree</h4> <pre class="methodSignature"><a href="FileTree.html" title="interface in org.gradle.api.file">FileTree</a> getAsFileTree()</pre> <div class="block">Returns a <a href="FileTree.html" title="interface in org.gradle.api.file"><code>FileTree</code></a> that allows the files and directories contained in this directory to be queried.</div> </li> </ul> <a id="value(org.gradle.api.file.Directory)">  </a> <ul class="blockList"> <li class="blockList"> <h4>value</h4> <pre class="methodSignature"><a href="DirectoryProperty.html" title="interface in org.gradle.api.file">DirectoryProperty</a> value(@Nullable <a href="Directory.html" title="interface in org.gradle.api.file">Directory</a> value)</pre> <div class="block">Sets the value of the property to the given value, replacing whatever value the property already had. This is the same as <a href="../provider/Property.html#set(T)"><code>Property.set(Object)</code></a> but returns this property to allow method chaining. <p> This method can also be used to discard the value of the property, by passing it <code>null</code>. When the value is discarded (or has never been set in the first place), the convention (default value) for this property, if specified, will be used to provide the value instead. </p></div> <dl> <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> <dd><code><a href="../provider/Property.html#value(T)">value</a></code> in interface <code><a href="../provider/Property.html" title="interface in org.gradle.api.provider">Property</a><<a href="Directory.html" title="interface in org.gradle.api.file">Directory</a>></code></dd> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>value</code> - The value, can be null.</dd> <dt><span class="returnLabel">Returns:</span></dt> <dd>this</dd> </dl> </li> </ul> <a id="value(org.gradle.api.provider.Provider)">  </a> <ul class="blockList"> <li class="blockList"> <h4>value</h4> <pre class="methodSignature"><a href="DirectoryProperty.html" title="interface in org.gradle.api.file">DirectoryProperty</a> value(<a href="../provider/Provider.html" title="interface in org.gradle.api.provider">Provider</a><? extends <a href="Directory.html" title="interface in org.gradle.api.file">Directory</a>> provider)</pre> <div class="block">Sets the property to have the same value as the given provider, replacing whatever value the property already had. This property will track the value of the provider and query its value each time the value of the property is queried. When the provider has no value, this property will also have no value. This is the same as <a href="../provider/Property.html#set(org.gradle.api.provider.Provider)"><code>Property.set(Provider)</code></a> but returns this property to allow method chaining. <p> This method can NOT be used to discard the value of the property. Specifying a <code>null</code> provider will result in an <code>IllegalArgumentException</code> being thrown. When the provider has no value, this property will also have no value - regardless of whether or not a convention has been set. </p> <p> When the given provider represents a task output, this property will also carry the task dependency information from the provider. </p></div> <dl> <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> <dd><code><a href="../provider/Property.html#value(org.gradle.api.provider.Provider)">value</a></code> in interface <code><a href="../provider/Property.html" title="interface in org.gradle.api.provider">Property</a><<a href="Directory.html" title="interface in org.gradle.api.file">Directory</a>></code></dd> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>provider</code> - The provider whose value to use.</dd> <dt><span class="returnLabel">Returns:</span></dt> <dd>this</dd> </dl> </li> </ul> <a id="fileValue(java.io.File)">  </a> <ul class="blockList"> <li class="blockList"> <h4>fileValue</h4> <pre class="methodSignature"><a href="DirectoryProperty.html" title="interface in org.gradle.api.file">DirectoryProperty</a> fileValue(@Nullable java.io.File file)</pre> <div class="block">Sets the location of this file, using a <code>File</code> instance. <code>File</code> instances with relative paths are resolved relative to the project directory of the project that owns this property instance. <p>This method is the same as <a href="FileSystemLocationProperty.html#set(java.io.File)"><code>FileSystemLocationProperty.set(File)</code></a> but allows method chaining.</p></div> <dl> <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> <dd><code><a href="FileSystemLocationProperty.html#fileValue(java.io.File)">fileValue</a></code> in interface <code><a href="FileSystemLocationProperty.html" title="interface in org.gradle.api.file">FileSystemLocationProperty</a><<a href="Directory.html" title="interface in org.gradle.api.file">Directory</a>></code></dd> <dt><span class="returnLabel">Returns:</span></dt> <dd>this</dd> </dl> </li> </ul> <a id="fileProvider(org.gradle.api.provider.Provider)">  </a> <ul class="blockList"> <li class="blockList"> <h4>fileProvider</h4> <pre class="methodSignature"><a href="DirectoryProperty.html" title="interface in org.gradle.api.file">DirectoryProperty</a> fileProvider(<a href="../provider/Provider.html" title="interface in org.gradle.api.provider">Provider</a><java.io.File> provider)</pre> <div class="block">Sets the location of this file, using a <code>File</code> <a href="../provider/Provider.html" title="interface in org.gradle.api.provider"><code>Provider</code></a> instance. <code>File</code> instances with relative paths are resolved relative to the project directory of the project that owns this property instance.</div> <dl> <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> <dd><code><a href="FileSystemLocationProperty.html#fileProvider(org.gradle.api.provider.Provider)">fileProvider</a></code> in interface <code><a href="FileSystemLocationProperty.html" title="interface in org.gradle.api.file">FileSystemLocationProperty</a><<a href="Directory.html" title="interface in org.gradle.api.file">Directory</a>></code></dd> <dt><span class="returnLabel">Returns:</span></dt> <dd>this</dd> </dl> </li> </ul> <a id="convention(org.gradle.api.file.Directory)">  </a> <ul class="blockList"> <li class="blockList"> <h4>convention</h4> <pre class="methodSignature"><a href="DirectoryProperty.html" title="interface in org.gradle.api.file">DirectoryProperty</a> convention(@Nullable <a href="Directory.html" title="interface in org.gradle.api.file">Directory</a> value)</pre> <div class="block">Specifies the value to use as the convention (default value) for this property. If the convention is set and no explicit value or value provider has been specified, then the convention will be returned as the value of the property (when queried). <p> This method can be used to specify that the property does not have a default value, by passing it <code>null</code>. </p></div> <dl> <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> <dd><code><a href="../provider/Property.html#convention(T)">convention</a></code> in interface <code><a href="../provider/Property.html" title="interface in org.gradle.api.provider">Property</a><<a href="Directory.html" title="interface in org.gradle.api.file">Directory</a>></code></dd> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>value</code> - The convention value, or <code>null</code> if the property should have no default value.</dd> <dt><span class="returnLabel">Returns:</span></dt> <dd>this</dd> </dl> </li> </ul> <a id="convention(org.gradle.api.provider.Provider)">  </a> <ul class="blockList"> <li class="blockList"> <h4>convention</h4> <pre class="methodSignature"><a href="DirectoryProperty.html" title="interface in org.gradle.api.file">DirectoryProperty</a> convention(<a href="../provider/Provider.html" title="interface in org.gradle.api.provider">Provider</a><? extends <a href="Directory.html" title="interface in org.gradle.api.file">Directory</a>> provider)</pre> <div class="block">Specifies the provider to be used to query the convention (default value) for this property. If a convention provider has been set and no explicit value or value provider has been specified, then the convention provider's value will be returned as the value of the property (when queried). <p> The property's convention tracks the convention provider. Whenever the convention's actual value is needed, the convention provider will be queried anew. </p> <p> This method can't be used to specify that a property does not have a default value. Passing in a <code>null</code> provider will result in an <code>IllegalArgumentException</code> being thrown. When the provider doesn't have a value, then the property will behave as if it wouldn't have a convention specified. </p></div> <dl> <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> <dd><code><a href="../provider/Property.html#convention(org.gradle.api.provider.Provider)">convention</a></code> in interface <code><a href="../provider/Property.html" title="interface in org.gradle.api.provider">Property</a><<a href="Directory.html" title="interface in org.gradle.api.file">Directory</a>></code></dd> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>provider</code> - The provider of the property's convention value, can't be null.</dd> <dt><span class="returnLabel">Returns:</span></dt> <dd>this</dd> </dl> </li> </ul> <a id="dir(java.lang.String)">  </a> <ul class="blockList"> <li class="blockList"> <h4>dir</h4> <pre class="methodSignature"><a href="../provider/Provider.html" title="interface in org.gradle.api.provider">Provider</a><<a href="Directory.html" title="interface in org.gradle.api.file">Directory</a>> dir(java.lang.String path)</pre> <div class="block">Returns a <a href="Directory.html" title="interface in org.gradle.api.file"><code>Directory</code></a> whose value is the given path resolved relative to the value of this directory.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>path</code> - The path. Can be absolute.</dd> <dt><span class="returnLabel">Returns:</span></dt> <dd>The directory.</dd> </dl> </li> </ul> <a id="dir(org.gradle.api.provider.Provider)">  </a> <ul class="blockList"> <li class="blockList"> <h4>dir</h4> <pre class="methodSignature"><a href="../provider/Provider.html" title="interface in org.gradle.api.provider">Provider</a><<a href="Directory.html" title="interface in org.gradle.api.file">Directory</a>> dir(<a href="../provider/Provider.html" title="interface in org.gradle.api.provider">Provider</a><? extends java.lang.CharSequence> path)</pre> <div class="block">Returns a <a href="Directory.html" title="interface in org.gradle.api.file"><code>Directory</code></a> whose value is the given path resolved relative to the value of this directory.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>path</code> - The path. Can have a value that is an absolute path.</dd> <dt><span class="returnLabel">Returns:</span></dt> <dd>The directory.</dd> </dl> </li> </ul> <a id="file(java.lang.String)">  </a> <ul class="blockList"> <li class="blockList"> <h4>file</h4> <pre class="methodSignature"><a href="../provider/Provider.html" title="interface in org.gradle.api.provider">Provider</a><<a href="RegularFile.html" title="interface in org.gradle.api.file">RegularFile</a>> file(java.lang.String path)</pre> <div class="block">Returns a <a href="RegularFile.html" title="interface in org.gradle.api.file"><code>RegularFile</code></a> whose value is the given path resolved relative to the value of this directory.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>path</code> - The path. Can be absolute.</dd> <dt><span class="returnLabel">Returns:</span></dt> <dd>The file.</dd> </dl> </li> </ul> <a id="file(org.gradle.api.provider.Provider)">  </a> <ul class="blockList"> <li class="blockList"> <h4>file</h4> <pre class="methodSignature"><a href="../provider/Provider.html" title="interface in org.gradle.api.provider">Provider</a><<a href="RegularFile.html" title="interface in org.gradle.api.file">RegularFile</a>> file(<a href="../provider/Provider.html" title="interface in org.gradle.api.provider">Provider</a><? extends java.lang.CharSequence> path)</pre> <div class="block">Returns a <a href="RegularFile.html" title="interface in org.gradle.api.file"><code>RegularFile</code></a> whose value is the given path resolved relative to the value of this directory.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>path</code> - The path. Can have a value that is an absolute path.</dd> <dt><span class="returnLabel">Returns:</span></dt> <dd>The file.</dd> </dl> </li> </ul> <a id="files(java.lang.Object...)">  </a> <ul class="blockListLast"> <li class="blockList"> <h4>files</h4> <pre class="methodSignature"><a href="FileCollection.html" title="interface in org.gradle.api.file">FileCollection</a> files(java.lang.Object... paths)</pre> <div class="block">Returns a <a href="FileCollection.html" title="interface in org.gradle.api.file"><code>FileCollection</code></a> containing the given files, whose locations are the given paths resolved relative to this directory, as defined by <a href="../Project.html#files(java.lang.Object...)"><code>Project.files(Object...)</code></a>. This method can also be used to create an empty collection, but the collection may not be mutated later.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>paths</code> - The paths to the files. May be empty.</dd> <dt><span class="returnLabel">Returns:</span></dt> <dd>The file collection.</dd> <dt><span class="simpleTagLabel">Since:</span></dt> <dd>6.0</dd> </dl> </li> </ul> </li> </ul> </section> </li> </ul> </div> </div> </main>  <footer role="contentinfo"> <nav role="navigation">  <div class="bottomNav"><a id="navbar.bottom">  </a> <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> <a id="navbar.bottom.firstrow">  </a> <ul class="navList" title="Navigation"> <li><a href="../../../../index.html">Overview</a></li> <li><a href="package-summary.html">Package</a></li> <li class="navBarCell1Rev">Class</li> <li><a href="package-tree.html">Tree</a></li> <li><a href="../../../../deprecated-list.html">Deprecated</a></li> <li><a href="../../../../index-all.html">Index</a></li> <li><a href="../../../../help-doc.html">Help</a></li> </ul> <div class="aboutLanguage"><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/styles/default.min.css"><script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/highlight.min.js"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/languages/kotlin.min.js"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/languages/groovy.min.js"></script><script>hljs.highlightAll();</script><script type="text/javascript">const btn = document.querySelector('.theme-toggle');const prefersDarkScheme = window.matchMedia('(prefers-color-scheme: dark)');const currentTheme = localStorage.getItem('theme');if (currentTheme == 'dark') { document.body.classList.toggle('dark-theme');} else if (currentTheme == 'light') { document.body.classList.toggle('light-theme');}btn.addEventListener('click', function () { if (prefersDarkScheme.matches) { document.body.classList.toggle('light-theme'); var theme = document.body.classList.contains('light-theme')? 'light' : 'dark'; } else { document.body.classList.toggle('dark-theme'); var theme = document.body.classList.contains('dark-theme')? 'dark' : 'light'; } localStorage.setItem('theme', theme);});</script></div> </div> <div class="subNav"> <ul class="navList" id="allclasses_navbar_bottom"> <li><a href="../../../../allclasses.html">All Classes</a></li> </ul> <div> <script type="text/javascript"> </script> <noscript> <div>JavaScript is disabled on your browser.</div> </noscript> </div> <div> <ul class="subNavList"> <li>Summary: </li> <li>Nested | </li> <li>Field | </li> <li>Constr | </li> <li><a href="#method.summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li>Field | </li> <li>Constr | </li> <li><a href="#method.detail">Method</a></li> </ul> </div> <a id="skip.navbar.bottom">  </a></div>  </nav> </footer> </body> </html>