/usr/share/doc/starlink-connect-java-doc/api/uk/ac/starlink/connect/FileBranch.html is in starlink-connect-java-doc 0.1+2016.05.03-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html>
<head>
<title>FileBranch (Starjava CONNECT API)</title>
<meta name="date" content="2017-04-08">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="FileBranch (Starjava CONNECT API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../uk/ac/starlink/connect/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">
<li><a href="../../../../uk/ac/starlink/connect/ErrorLeaf.html" title="class in uk.ac.starlink.connect"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../uk/ac/starlink/connect/FileNode.html" title="class in uk.ac.starlink.connect"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?uk/ac/starlink/connect/FileBranch.html" target="_top">Frames</a></li>
<li><a href="FileBranch.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li><a href="#constructor.summary">Constr</a> | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor.detail">Constr</a> | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">uk.ac.starlink.connect</div>
<h2 title="Class FileBranch" class="title">Class FileBranch</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../../../uk/ac/starlink/connect/FileNode.html" title="class in uk.ac.starlink.connect">uk.ac.starlink.connect.FileNode</a></li>
<li>
<ul class="inheritance">
<li>uk.ac.starlink.connect.FileBranch</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../uk/ac/starlink/connect/Branch.html" title="interface in uk.ac.starlink.connect">Branch</a>, <a href="../../../../uk/ac/starlink/connect/Node.html" title="interface in uk.ac.starlink.connect">Node</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">FileBranch</span>
extends <a href="../../../../uk/ac/starlink/connect/FileNode.html" title="class in uk.ac.starlink.connect">FileNode</a>
implements <a href="../../../../uk/ac/starlink/connect/Branch.html" title="interface in uk.ac.starlink.connect">Branch</a></pre>
<div class="block">Branch representing a directory file.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>18 Feb 2005</dd>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>Mark Taylor (Starlink)</dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../uk/ac/starlink/connect/FileBranch.html#FileBranch-java.io.File-">FileBranch</a></span>(java.io.File dir)</code>
<div class="block">Constructs a branch from a File object representing an existing
directory.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="../../../../uk/ac/starlink/connect/Node.html" title="interface in uk.ac.starlink.connect">Node</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../uk/ac/starlink/connect/FileBranch.html#createNode-java.lang.String-">createNode</a></span>(java.lang.String location)</code>
<div class="block">Attempts to construct a new node in the context of this one.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../uk/ac/starlink/connect/Node.html" title="interface in uk.ac.starlink.connect">Node</a>[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../uk/ac/starlink/connect/FileBranch.html#getChildren--">getChildren</a></span>()</code>
<div class="block">Returns the array of child nodes belonging to this branch.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../uk/ac/starlink/connect/FileBranch.html#isHidingEnabled--">isHidingEnabled</a></span>()</code>
<div class="block">Indicates whether files marked as hidden by the default FileSystemView
are shown or not.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../uk/ac/starlink/connect/FileBranch.html#setHidingEnabled-boolean-">setHidingEnabled</a></span>(boolean hiding)</code>
<div class="block">Sets whether files marked as hidden by the default FileSystemView
are shown or not.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.uk.ac.starlink.connect.FileNode">
<!-- -->
</a>
<h3>Methods inherited from class uk.ac.starlink.connect.<a href="../../../../uk/ac/starlink/connect/FileNode.html" title="class in uk.ac.starlink.connect">FileNode</a></h3>
<code><a href="../../../../uk/ac/starlink/connect/FileNode.html#createNode-java.io.File-">createNode</a>, <a href="../../../../uk/ac/starlink/connect/FileNode.html#equals-java.lang.Object-">equals</a>, <a href="../../../../uk/ac/starlink/connect/FileNode.html#getFile--">getFile</a>, <a href="../../../../uk/ac/starlink/connect/FileNode.html#getName--">getName</a>, <a href="../../../../uk/ac/starlink/connect/FileNode.html#getParent--">getParent</a>, <a href="../../../../uk/ac/starlink/connect/FileNode.html#hashCode--">hashCode</a>, <a href="../../../../uk/ac/starlink/connect/FileNode.html#toString--">toString</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.Object</h3>
<code>clone, finalize, getClass, notify, notifyAll, wait, wait, wait</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.uk.ac.starlink.connect.Node">
<!-- -->
</a>
<h3>Methods inherited from interface uk.ac.starlink.connect.<a href="../../../../uk/ac/starlink/connect/Node.html" title="interface in uk.ac.starlink.connect">Node</a></h3>
<code><a href="../../../../uk/ac/starlink/connect/Node.html#getName--">getName</a>, <a href="../../../../uk/ac/starlink/connect/Node.html#getParent--">getParent</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="FileBranch-java.io.File-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>FileBranch</h4>
<pre>public FileBranch(java.io.File dir)</pre>
<div class="block">Constructs a branch from a File object representing an existing
directory.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>dir</code> - directory</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if <tt>dir</tt> is not a directory</dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getChildren--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getChildren</h4>
<pre>public <a href="../../../../uk/ac/starlink/connect/Node.html" title="interface in uk.ac.starlink.connect">Node</a>[] getChildren()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../uk/ac/starlink/connect/Branch.html#getChildren--">Branch</a></code></span></div>
<div class="block">Returns the array of child nodes belonging to this branch.
All the returned values represent file objects which actuallly exist
in the filesystem.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../uk/ac/starlink/connect/Branch.html#getChildren--">getChildren</a></code> in interface <code><a href="../../../../uk/ac/starlink/connect/Branch.html" title="interface in uk.ac.starlink.connect">Branch</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>child nodes of this one</dd>
</dl>
</li>
</ul>
<a name="createNode-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createNode</h4>
<pre>public <a href="../../../../uk/ac/starlink/connect/Node.html" title="interface in uk.ac.starlink.connect">Node</a> createNode(java.lang.String location)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../uk/ac/starlink/connect/Branch.html#createNode-java.lang.String-">Branch</a></code></span></div>
<div class="block">Attempts to construct a new node in the context of this one.
The new item may represent a new or an existing node in the
filesystem. This call should not in itself perform any write
operations on the filesystem (such as creating a node which
doesn't currently exist), though a subsequent
<a href="../../../../uk/ac/starlink/connect/Leaf.html#getOutputStream--"><code>Leaf.getOutputStream()</code></a> call may do so.
<p>The returned node will typically be a child of this branch,
but need not be, for instance if <tt>name</tt> is interpreted as an
absolute path.
<p>If the named node cannot be created, <tt>null</tt> may be returned.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../uk/ac/starlink/connect/Branch.html#createNode-java.lang.String-">createNode</a></code> in interface <code><a href="../../../../uk/ac/starlink/connect/Branch.html" title="interface in uk.ac.starlink.connect">Branch</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>location</code> - name of a node in the context of this branch</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>node representing the location of an existing or new node</dd>
</dl>
</li>
</ul>
<a name="isHidingEnabled--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isHidingEnabled</h4>
<pre>public boolean isHidingEnabled()</pre>
<div class="block">Indicates whether files marked as hidden by the default FileSystemView
are shown or not.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if hidden files are not shown</dd>
</dl>
</li>
</ul>
<a name="setHidingEnabled-boolean-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setHidingEnabled</h4>
<pre>public void setHidingEnabled(boolean hiding)</pre>
<div class="block">Sets whether files marked as hidden by the default FileSystemView
are shown or not. The default is true.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>hiding</code> - true to hide hidden files</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../uk/ac/starlink/connect/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">
<li><a href="../../../../uk/ac/starlink/connect/ErrorLeaf.html" title="class in uk.ac.starlink.connect"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../uk/ac/starlink/connect/FileNode.html" title="class in uk.ac.starlink.connect"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?uk/ac/starlink/connect/FileBranch.html" target="_top">Frames</a></li>
<li><a href="FileBranch.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li><a href="#constructor.summary">Constr</a> | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor.detail">Constr</a> | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small><i>Copyright © 2017 Central Laboratory of the Research Councils. All Rights Reserved.<i></small></p>
</body>
</html>
|