CINXE.COM

<!DOCTYPE HTML>  <html lang="en"> <head>  <title>ConfigurableFileTree (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/ConfigurableFileTree.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/ConfigurableFileTree.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}; 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><a href="#nested.class.summary">Nested</a> | </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 ConfigurableFileTree" class="title">Interface ConfigurableFileTree</h2> </div> <div class="contentContainer"> <div class="description"> <ul class="blockList"> <li class="blockList"> <dl> <dt>All Superinterfaces:</dt> <dd><code><a href="../tasks/AntBuilderAware.html" title="interface in org.gradle.api.tasks">AntBuilderAware</a></code>, <code><a href="../Buildable.html" title="interface in org.gradle.api">Buildable</a></code>, <code><a href="DirectoryTree.html" title="interface in org.gradle.api.file">DirectoryTree</a></code>, <code><a href="FileCollection.html" title="interface in org.gradle.api.file">FileCollection</a></code>, <code><a href="FileTree.html" title="interface in org.gradle.api.file">FileTree</a></code>, <code>java.lang.Iterable<java.io.File></code>, <code><a href="../tasks/util/PatternFilterable.html" title="interface in org.gradle.api.tasks.util">PatternFilterable</a></code></dd> </dl> <hr> <pre>public interface <span class="typeNameLabel">ConfigurableFileTree</span> extends <a href="FileTree.html" title="interface in org.gradle.api.file">FileTree</a>, <a href="DirectoryTree.html" title="interface in org.gradle.api.file">DirectoryTree</a>, <a href="../tasks/util/PatternFilterable.html" title="interface in org.gradle.api.tasks.util">PatternFilterable</a>, <a href="../Buildable.html" title="interface in org.gradle.api">Buildable</a></pre> <div class="block"><p>A <a href="FileTree.html" title="interface in org.gradle.api.file"><code>FileTree</code></a> with a single base directory, which can be configured and modified.</p> <p>You can obtain a <code>ConfigurableFileTree</code> instance by calling <a href="../Project.html#fileTree(java.util.Map)"><code>Project.fileTree(java.util.Map)</code></a>.</p></div> </li> </ul> </div> <div class="summary"> <ul class="blockList"> <li class="blockList">  <section> <ul class="blockList"> <li class="blockList"><a id="nested.class.summary">  </a> <h3>Nested Class Summary</h3> <ul class="blockList"> <li class="blockList"><a id="nested.classes.inherited.from.class.org.gradle.api.file.FileCollection">  </a> <h3>Nested classes/interfaces inherited from interface org.gradle.api.file.<a href="FileCollection.html" title="interface in org.gradle.api.file">FileCollection</a></h3> <code><a href="FileCollection.AntType.html" title="enum in org.gradle.api.file">FileCollection.AntType</a></code></li> </ul> </li> </ul> </section>  <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="ConfigurableFileTree.html" title="interface in org.gradle.api.file">ConfigurableFileTree</a></code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#builtBy(java.lang.Object...)">builtBy</a></span>(java.lang.Object... tasks)</code></th> <td class="colLast"> <div class="block">Registers some tasks which build the files of this collection.</div> </td> </tr> <tr id="i1" class="rowColor"> <td class="colFirst"><code><a href="ConfigurableFileTree.html" title="interface in org.gradle.api.file">ConfigurableFileTree</a></code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#from(java.lang.Object)">from</a></span>(java.lang.Object dir)</code></th> <td class="colLast"> <div class="block">Specifies base directory for this file tree using the given path.</div> </td> </tr> <tr id="i2" class="altColor"> <td class="colFirst"><code>java.util.Set<java.lang.Object></code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getBuiltBy()">getBuiltBy</a></span>()</code></th> <td class="colLast"> <div class="block">Returns the set of tasks which build the files of this collection.</div> </td> </tr> <tr id="i3" class="rowColor"> <td class="colFirst"><code>java.io.File</code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDir()">getDir</a></span>()</code></th> <td class="colLast"> <div class="block">Returns the base directory of this file tree.</div> </td> </tr> <tr id="i4" class="altColor"> <td class="colFirst"><code><a href="ConfigurableFileTree.html" title="interface in org.gradle.api.file">ConfigurableFileTree</a></code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setBuiltBy(java.lang.Iterable)">setBuiltBy</a></span>(java.lang.Iterable<?> tasks)</code></th> <td class="colLast"> <div class="block">Sets the tasks which build the files of this collection.</div> </td> </tr> <tr id="i5" class="rowColor"> <td class="colFirst"><code><a href="ConfigurableFileTree.html" title="interface in org.gradle.api.file">ConfigurableFileTree</a></code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setDir(java.lang.Object)">setDir</a></span>(java.lang.Object dir)</code></th> <td class="colLast"> <div class="block">Specifies base directory for this file tree using the given path.</div> </td> </tr> </table> <ul class="blockList"> <li class="blockList"><a id="methods.inherited.from.class.org.gradle.api.Buildable">  </a> <h3>Methods inherited from interface org.gradle.api.<a href="../Buildable.html" title="interface in org.gradle.api">Buildable</a></h3> <code><a href="../Buildable.html#getBuildDependencies()">getBuildDependencies</a></code></li> </ul> <ul class="blockList"> <li class="blockList"><a id="methods.inherited.from.class.org.gradle.api.file.DirectoryTree">  </a> <h3>Methods inherited from interface org.gradle.api.file.<a href="DirectoryTree.html" title="interface in org.gradle.api.file">DirectoryTree</a></h3> <code><a href="DirectoryTree.html#getPatterns()">getPatterns</a></code></li> </ul> <ul class="blockList"> <li class="blockList"><a id="methods.inherited.from.class.org.gradle.api.file.FileCollection">  </a> <h3>Methods inherited from interface org.gradle.api.file.<a href="FileCollection.html" title="interface in org.gradle.api.file">FileCollection</a></h3> <code><a href="FileCollection.html#addToAntBuilder(java.lang.Object,java.lang.String)">addToAntBuilder</a>, <a href="FileCollection.html#addToAntBuilder(java.lang.Object,java.lang.String,org.gradle.api.file.FileCollection.AntType)">addToAntBuilder</a>, <a href="FileCollection.html#contains(java.io.File)">contains</a>, <a href="FileCollection.html#filter(groovy.lang.Closure)">filter</a>, <a href="FileCollection.html#filter(org.gradle.api.specs.Spec)">filter</a>, <a href="FileCollection.html#getAsPath()">getAsPath</a>, <a href="FileCollection.html#getElements()">getElements</a>, <a href="FileCollection.html#getSingleFile()">getSingleFile</a>, <a href="FileCollection.html#isEmpty()">isEmpty</a>, <a href="FileCollection.html#minus(org.gradle.api.file.FileCollection)">minus</a>, <a href="FileCollection.html#plus(org.gradle.api.file.FileCollection)">plus</a></code></li> </ul> <ul class="blockList"> <li class="blockList"><a id="methods.inherited.from.class.org.gradle.api.file.FileTree">  </a> <h3>Methods inherited from interface org.gradle.api.file.<a href="FileTree.html" title="interface in org.gradle.api.file">FileTree</a></h3> <code><a href="FileTree.html#getAsFileTree()">getAsFileTree</a>, <a href="FileTree.html#getFiles()">getFiles</a>, <a href="FileTree.html#matching(groovy.lang.Closure)">matching</a>, <a href="FileTree.html#matching(org.gradle.api.Action)">matching</a>, <a href="FileTree.html#matching(org.gradle.api.tasks.util.PatternFilterable)">matching</a>, <a href="FileTree.html#plus(org.gradle.api.file.FileTree)">plus</a>, <a href="FileTree.html#visit(groovy.lang.Closure)">visit</a>, <a href="FileTree.html#visit(org.gradle.api.Action)">visit</a>, <a href="FileTree.html#visit(org.gradle.api.file.FileVisitor)">visit</a></code></li> </ul> <ul class="blockList"> <li class="blockList"><a id="methods.inherited.from.class.java.lang.Iterable">  </a> <h3>Methods inherited from interface java.lang.Iterable</h3> <code>forEach, iterator, spliterator</code></li> </ul> <ul class="blockList"> <li class="blockList"><a id="methods.inherited.from.class.org.gradle.api.tasks.util.PatternFilterable">  </a> <h3>Methods inherited from interface org.gradle.api.tasks.util.<a href="../tasks/util/PatternFilterable.html" title="interface in org.gradle.api.tasks.util">PatternFilterable</a></h3> <code><a href="../tasks/util/PatternFilterable.html#exclude(groovy.lang.Closure)">exclude</a>, <a href="../tasks/util/PatternFilterable.html#exclude(java.lang.Iterable)">exclude</a>, <a href="../tasks/util/PatternFilterable.html#exclude(java.lang.String...)">exclude</a>, <a href="../tasks/util/PatternFilterable.html#exclude(org.gradle.api.specs.Spec)">exclude</a>, <a href="../tasks/util/PatternFilterable.html#getExcludes()">getExcludes</a>, <a href="../tasks/util/PatternFilterable.html#getIncludes()">getIncludes</a>, <a href="../tasks/util/PatternFilterable.html#include(groovy.lang.Closure)">include</a>, <a href="../tasks/util/PatternFilterable.html#include(java.lang.Iterable)">include</a>, <a href="../tasks/util/PatternFilterable.html#include(java.lang.String...)">include</a>, <a href="../tasks/util/PatternFilterable.html#include(org.gradle.api.specs.Spec)">include</a>, <a href="../tasks/util/PatternFilterable.html#setExcludes(java.lang.Iterable)">setExcludes</a>, <a href="../tasks/util/PatternFilterable.html#setIncludes(java.lang.Iterable)">setIncludes</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="from(java.lang.Object)">  </a> <ul class="blockList"> <li class="blockList"> <h4>from</h4> <pre class="methodSignature"><a href="ConfigurableFileTree.html" title="interface in org.gradle.api.file">ConfigurableFileTree</a> from(java.lang.Object dir)</pre> <div class="block">Specifies base directory for this file tree using the given path. The path is evaluated as per <a href="../Project.html#file(java.lang.Object)"><code>Project.file(Object)</code></a>.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>dir</code> - The base directory.</dd> <dt><span class="returnLabel">Returns:</span></dt> <dd>this</dd> </dl> </li> </ul> <a id="getDir()">  </a> <ul class="blockList"> <li class="blockList"> <h4>getDir</h4> <pre class="methodSignature">java.io.File getDir()</pre> <div class="block">Returns the base directory of this file tree.</div> <dl> <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> <dd><code><a href="DirectoryTree.html#getDir()">getDir</a></code> in interface <code><a href="DirectoryTree.html" title="interface in org.gradle.api.file">DirectoryTree</a></code></dd> <dt><span class="returnLabel">Returns:</span></dt> <dd>The base directory. Never returns null.</dd> </dl> </li> </ul> <a id="setDir(java.lang.Object)">  </a> <ul class="blockList"> <li class="blockList"> <h4>setDir</h4> <pre class="methodSignature"><a href="ConfigurableFileTree.html" title="interface in org.gradle.api.file">ConfigurableFileTree</a> setDir(java.lang.Object dir)</pre> <div class="block">Specifies base directory for this file tree using the given path. The path is evaluated as per <a href="../Project.html#file(java.lang.Object)"><code>Project.file(Object)</code></a>.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>dir</code> - The base directory.</dd> <dt><span class="returnLabel">Returns:</span></dt> <dd>this</dd> </dl> </li> </ul> <a id="getBuiltBy()">  </a> <ul class="blockList"> <li class="blockList"> <h4>getBuiltBy</h4> <pre class="methodSignature">java.util.Set<java.lang.Object> getBuiltBy()</pre> <div class="block">Returns the set of tasks which build the files of this collection.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>The set. Returns an empty set when there are no such tasks.</dd> </dl> </li> </ul> <a id="setBuiltBy(java.lang.Iterable)">  </a> <ul class="blockList"> <li class="blockList"> <h4>setBuiltBy</h4> <pre class="methodSignature"><a href="ConfigurableFileTree.html" title="interface in org.gradle.api.file">ConfigurableFileTree</a> setBuiltBy(java.lang.Iterable<?> tasks)</pre> <div class="block">Sets the tasks which build the files of this collection.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>tasks</code> - The tasks. These are evaluated as per <a href="../Task.html#dependsOn(java.lang.Object...)"><code>Task.dependsOn(Object...)</code></a>.</dd> <dt><span class="returnLabel">Returns:</span></dt> <dd>this</dd> </dl> </li> </ul> <a id="builtBy(java.lang.Object...)">  </a> <ul class="blockListLast"> <li class="blockList"> <h4>builtBy</h4> <pre class="methodSignature"><a href="ConfigurableFileTree.html" title="interface in org.gradle.api.file">ConfigurableFileTree</a> builtBy(java.lang.Object... tasks)</pre> <div class="block">Registers some tasks which build the files of this collection.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>tasks</code> - The tasks. These are evaluated as per <a href="../Task.html#dependsOn(java.lang.Object...)"><code>Task.dependsOn(Object...)</code></a>.</dd> <dt><span class="returnLabel">Returns:</span></dt> <dd>this</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><a href="#nested.class.summary">Nested</a> | </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>