java/javadoc/ch/wlkl/wsh/Dir.html

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_05) on Sat Jul 22 13:32:41 CEST 2017 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Dir</title>
<meta name="date" content="2017-07-22">
<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="Dir";
        }
    }
    catch(err) {
    }
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":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="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/Dir.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../ch/wlkl/wsh/Compiler.html" title="class in ch.wlkl.wsh"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../ch/wlkl/wsh/Env.html" title="class in ch.wlkl.wsh"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?ch/wlkl/wsh/Dir.html" target="_top">Frames</a></li>
<li><a href="Dir.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#fields.inherited.from.class.ch.wlkl.wsh.Top">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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">ch.wlkl.wsh</div>
<h2 title="Class Dir" class="title">Class Dir</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../../ch/wlkl/wsh/Top.html" title="class in ch.wlkl.wsh">ch.wlkl.wsh.Top</a></li>
<li>
<ul class="inheritance">
<li>ch.wlkl.wsh.Dir</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../ch/wlkl/wsh/OpenClose.html" title="interface in ch.wlkl.wsh">OpenClose</a>, <a href="../../../ch/wlkl/wsh/Read.html" title="interface in ch.wlkl.wsh">Read</a>&lt;java.lang.String&gt;</dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">Dir</span>
extends <a href="../../../ch/wlkl/wsh/Top.html" title="class in ch.wlkl.wsh">Top</a>
implements <a href="../../../ch/wlkl/wsh/Read.html" title="interface in ch.wlkl.wsh">Read</a>&lt;java.lang.String&gt;</pre>
<div class="block">The <a href="../../../ch/wlkl/wsh/Read.html" title="interface in ch.wlkl.wsh"><code>Read</code></a> interface to a filesystem directory.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!--   -->
</a>
<h3>Field Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.ch.wlkl.wsh.Top">
<!--   -->
</a>
<h3>Fields inherited from class&nbsp;ch.wlkl.wsh.<a href="../../../ch/wlkl/wsh/Top.html" title="class in ch.wlkl.wsh">Top</a></h3>
<code><a href="../../../ch/wlkl/wsh/Top.html#emptyStrings">emptyStrings</a>, <a href="../../../ch/wlkl/wsh/Top.html#trace">trace</a></code></li>
</ul>
</li>
</ul>
<!-- ======== 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">&nbsp;</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="../../../ch/wlkl/wsh/Dir.html#Dir-java.lang.String...-">Dir</a></span>(java.lang.String...&nbsp;a)</code>&nbsp;</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">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</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>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../ch/wlkl/wsh/Dir.html#close--">close</a></span>()</code>
<div class="block">close the receiver.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../ch/wlkl/wsh/Dir.html#open-java.lang.String-">open</a></span>(java.lang.String&nbsp;a)</code>
<div class="block">open the receiver for read or write.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../ch/wlkl/wsh/Dir.html#read--">read</a></span>()</code>
<div class="block">return the next line or null iff at end.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../ch/wlkl/wsh/Dir.html#reset-java.lang.Object...-">reset</a></span>(java.lang.Object...&nbsp;a)</code>
<div class="block">redefine the receiver by args.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../ch/wlkl/wsh/Dir.html#reset-java.lang.String...-">reset</a></span>(java.lang.String...&nbsp;a)</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.ch.wlkl.wsh.Top">
<!--   -->
</a>
<h3>Methods inherited from class&nbsp;ch.wlkl.wsh.<a href="../../../ch/wlkl/wsh/Top.html" title="class in ch.wlkl.wsh">Top</a></h3>
<code><a href="../../../ch/wlkl/wsh/Top.html#fail-java.lang.String-">fail</a>, <a href="../../../ch/wlkl/wsh/Top.html#name-java.lang.Object-">name</a>, <a href="../../../ch/wlkl/wsh/Top.html#nameCnt-int-">nameCnt</a>, <a href="../../../ch/wlkl/wsh/Top.html#say-java.lang.String-">say</a>, <a href="../../../ch/wlkl/wsh/Top.html#sFail-java.lang.Object-java.lang.String-">sFail</a>, <a href="../../../ch/wlkl/wsh/Top.html#sFail-java.lang.String-">sFail</a>, <a href="../../../ch/wlkl/wsh/Top.html#sSay-java.lang.Object-java.lang.String-">sSay</a>, <a href="../../../ch/wlkl/wsh/Top.html#sSay-java.lang.String-">sSay</a>, <a href="../../../ch/wlkl/wsh/Top.html#sTrc-java.lang.Object-java.lang.String-">sTrc</a>, <a href="../../../ch/wlkl/wsh/Top.html#sTrc-java.lang.String-">sTrc</a>, <a href="../../../ch/wlkl/wsh/Top.html#toString--">toString</a>, <a href="../../../ch/wlkl/wsh/Top.html#trc-java.lang.String-">trc</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&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</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="Dir-java.lang.String...-">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Dir</h4>
<pre>public&nbsp;Dir(java.lang.String...&nbsp;a)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!--   -->
</a>
<h3>Method Detail</h3>
<a name="reset-java.lang.Object...-">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>reset</h4>
<pre>public&nbsp;void&nbsp;reset(java.lang.Object...&nbsp;a)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../ch/wlkl/wsh/OpenClose.html#reset-java.lang.Object...-">OpenClose</a></code></span></div>
<div class="block">redefine the receiver by args.
 After reset the receiver should be initialised to args as after new...(args).
 If the receiver is open, reset should close it before reinitialising.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../ch/wlkl/wsh/OpenClose.html#reset-java.lang.Object...-">reset</a></code>&nbsp;in interface&nbsp;<code><a href="../../../ch/wlkl/wsh/OpenClose.html" title="interface in ch.wlkl.wsh">OpenClose</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>a</code> - the specification for the next open</dd>
</dl>
</li>
</ul>
<a name="reset-java.lang.String...-">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>reset</h4>
<pre>public&nbsp;void&nbsp;reset(java.lang.String...&nbsp;a)</pre>
</li>
</ul>
<a name="open-java.lang.String-">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>open</h4>
<pre>public&nbsp;void&nbsp;open(java.lang.String&nbsp;a)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../ch/wlkl/wsh/OpenClose.html#open-java.lang.String-">OpenClose</a></code></span></div>
<div class="block">open the receiver for read or write.
 If already open, close it first.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../ch/wlkl/wsh/OpenClose.html#open-java.lang.String-">open</a></code>&nbsp;in interface&nbsp;<code><a href="../../../ch/wlkl/wsh/OpenClose.html" title="interface in ch.wlkl.wsh">OpenClose</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>a</code> - the first character means the following:
 <br><ul>
 <li> "r" open for read
 <li> "w" open for write, erase previous content
 <li> "a" open for write, append to previous content
 </ul>an implementation may only support a part of these possiblities or add further ones.</dd>
</dl>
</li>
</ul>
<a name="close--">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>close</h4>
<pre>public&nbsp;void&nbsp;close()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../ch/wlkl/wsh/OpenClose.html#close--">OpenClose</a></code></span></div>
<div class="block">close the receiver.
 if not open do nothing.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../ch/wlkl/wsh/OpenClose.html#close--">close</a></code>&nbsp;in interface&nbsp;<code><a href="../../../ch/wlkl/wsh/OpenClose.html" title="interface in ch.wlkl.wsh">OpenClose</a></code></dd>
</dl>
</li>
</ul>
<a name="read--">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>read</h4>
<pre>public&nbsp;java.lang.String&nbsp;read()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../ch/wlkl/wsh/Read.html#read--">Read</a></code></span></div>
<div class="block">return the next line or null iff at end.
 Fail it not open for reading. How to fail is unspecified, a null pointer exception or a <a href="../../../ch/wlkl/wsh/Top.html#fail-java.lang.String-"><code>Top.fail(String)</code></a> are common possibilities.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../ch/wlkl/wsh/Read.html#read--">read</a></code>&nbsp;in interface&nbsp;<code><a href="../../../ch/wlkl/wsh/Read.html" title="interface in ch.wlkl.wsh">Read</a>&lt;java.lang.String&gt;</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the next line</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="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/Dir.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../ch/wlkl/wsh/Compiler.html" title="class in ch.wlkl.wsh"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../ch/wlkl/wsh/Env.html" title="class in ch.wlkl.wsh"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?ch/wlkl/wsh/Dir.html" target="_top">Frames</a></li>
<li><a href="Dir.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#fields.inherited.from.class.ch.wlkl.wsh.Top">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!--   -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>