????

Your IP : 216.73.216.152

Current Path : /opt/ant/manual/api/org/apache/tools/ant/taskdefs/optional/ssh/
Upload File :
Current File : //opt/ant/manual/api/org/apache/tools/ant/taskdefs/optional/ssh/Directory.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 (version 1.7.0_03) on Tue May 22 06:24:54 CEST 2012 -->
<title>Directory (Apache Ant API)</title>
<meta name="date" content="2012-05-22">
<link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
    if (location.href.indexOf('is-external=true') == -1) {
        parent.document.title="Directory (Apache Ant API)";
    }
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!--   -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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="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="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/AbstractSshMessage.html" title="class in org.apache.tools.ant.taskdefs.optional.ssh"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/LogListener.html" title="interface in org.apache.tools.ant.taskdefs.optional.ssh"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/tools/ant/taskdefs/optional/ssh/Directory.html" target="_top">Frames</a></li>
<li><a href="Directory.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&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">org.apache.tools.ant.taskdefs.optional.ssh</div>
<h2 title="Class Directory" class="title">Class Directory</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.tools.ant.taskdefs.optional.ssh.Directory</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="strong">Directory</span>
extends java.lang.Object</pre>
<div class="block">A helper object for Scp representing a directory in a file system.</div>
</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="overviewSummary" 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><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/Directory.html#Directory(java.io.File)">Directory</a></strong>(java.io.File&nbsp;directory)</code>
<div class="block">Constructor for a Directory.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/Directory.html#Directory(java.io.File, org.apache.tools.ant.taskdefs.optional.ssh.Directory)">Directory</a></strong>(java.io.File&nbsp;directory,
         <a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/Directory.html" title="class in org.apache.tools.ant.taskdefs.optional.ssh">Directory</a>&nbsp;parent)</code>
<div class="block">Constructor for a 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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/Directory.html#addDirectory(org.apache.tools.ant.taskdefs.optional.ssh.Directory)">addDirectory</a></strong>(<a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/Directory.html" title="class in org.apache.tools.ant.taskdefs.optional.ssh">Directory</a>&nbsp;directory)</code>
<div class="block">Add a directory to the child directories.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/Directory.html#addFile(java.io.File)">addFile</a></strong>(java.io.File&nbsp;file)</code>
<div class="block">Add a file to the list of files.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.util.Iterator</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/Directory.html#directoryIterator()">directoryIterator</a></strong>()</code>
<div class="block">Get an iterator over the child Directories.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/Directory.html#equals(java.lang.Object)">equals</a></strong>(java.lang.Object&nbsp;obj)</code>
<div class="block">The equality method.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.util.Iterator</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/Directory.html#filesIterator()">filesIterator</a></strong>()</code>
<div class="block">Get an iterator over the files.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/Directory.html#fileSize()">fileSize</a></strong>()</code>
<div class="block">Get the number of files in the files attribute.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/Directory.html" title="class in org.apache.tools.ant.taskdefs.optional.ssh">Directory</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/Directory.html#getChild(java.io.File)">getChild</a></strong>(java.io.File&nbsp;dir)</code>
<div class="block">Get a child directory of this directory.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.io.File</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/Directory.html#getDirectory()">getDirectory</a></strong>()</code>
<div class="block">Get the directory file.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/Directory.html" title="class in org.apache.tools.ant.taskdefs.optional.ssh">Directory</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/Directory.html#getParent()">getParent</a></strong>()</code>
<div class="block">Get the parent Directory.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String[]</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/Directory.html#getPath()">getPath</a></strong>()</code>
<div class="block">Get the path components of this directory.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String[]</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/Directory.html#getPath(java.lang.String)">getPath</a></strong>(java.lang.String&nbsp;thePath)</code>
<div class="block">Convert a file path to an array of path components.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/Directory.html#hashCode()">hashCode</a></strong>()</code>
<div class="block">The hashcode method.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/Directory.html#isRoot()">isRoot</a></strong>()</code>
<div class="block">Is this a root Directory?</div>
</td>
</tr>
</table>
<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, finalize, getClass, notify, notifyAll, toString, 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="Directory(java.io.File)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Directory</h4>
<pre>public&nbsp;Directory(java.io.File&nbsp;directory)</pre>
<div class="block">Constructor for a Directory.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>directory</code> - a directory.</dd></dl>
</li>
</ul>
<a name="Directory(java.io.File, org.apache.tools.ant.taskdefs.optional.ssh.Directory)">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Directory</h4>
<pre>public&nbsp;Directory(java.io.File&nbsp;directory,
         <a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/Directory.html" title="class in org.apache.tools.ant.taskdefs.optional.ssh">Directory</a>&nbsp;parent)</pre>
<div class="block">Constructor for a Directory.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>directory</code> - a directory</dd><dd><code>parent</code> - a parent 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="addDirectory(org.apache.tools.ant.taskdefs.optional.ssh.Directory)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addDirectory</h4>
<pre>public&nbsp;void&nbsp;addDirectory(<a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/Directory.html" title="class in org.apache.tools.ant.taskdefs.optional.ssh">Directory</a>&nbsp;directory)</pre>
<div class="block">Add a directory to the child directories.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>directory</code> - a Directory</dd></dl>
</li>
</ul>
<a name="addFile(java.io.File)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addFile</h4>
<pre>public&nbsp;void&nbsp;addFile(java.io.File&nbsp;file)</pre>
<div class="block">Add a file to the list of files.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>file</code> - a file to add</dd></dl>
</li>
</ul>
<a name="directoryIterator()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>directoryIterator</h4>
<pre>public&nbsp;java.util.Iterator&nbsp;directoryIterator()</pre>
<div class="block">Get an iterator over the child Directories.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>an iterator</dd></dl>
</li>
</ul>
<a name="filesIterator()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>filesIterator</h4>
<pre>public&nbsp;java.util.Iterator&nbsp;filesIterator()</pre>
<div class="block">Get an iterator over the files.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>an iterator</dd></dl>
</li>
</ul>
<a name="getParent()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getParent</h4>
<pre>public&nbsp;<a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/Directory.html" title="class in org.apache.tools.ant.taskdefs.optional.ssh">Directory</a>&nbsp;getParent()</pre>
<div class="block">Get the parent Directory.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the parent Directory.</dd></dl>
</li>
</ul>
<a name="isRoot()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isRoot</h4>
<pre>public&nbsp;boolean&nbsp;isRoot()</pre>
<div class="block">Is this a root Directory?</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>true if there is no parent Directory</dd></dl>
</li>
</ul>
<a name="getDirectory()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDirectory</h4>
<pre>public&nbsp;java.io.File&nbsp;getDirectory()</pre>
<div class="block">Get the directory file.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the directory file</dd></dl>
</li>
</ul>
<a name="getChild(java.io.File)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getChild</h4>
<pre>public&nbsp;<a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/Directory.html" title="class in org.apache.tools.ant.taskdefs.optional.ssh">Directory</a>&nbsp;getChild(java.io.File&nbsp;dir)</pre>
<div class="block">Get a child directory of this directory.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>dir</code> - the directory to look for</dd>
<dt><span class="strong">Returns:</span></dt><dd>the child directory, or null if not found</dd></dl>
</li>
</ul>
<a name="equals(java.lang.Object)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>equals</h4>
<pre>public&nbsp;boolean&nbsp;equals(java.lang.Object&nbsp;obj)</pre>
<div class="block">The equality method.
 This checks if the directory field is the same.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code>equals</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>obj</code> - the object to compare to</dd>
<dt><span class="strong">Returns:</span></dt><dd>true if this object has an equal directory field as the other object</dd></dl>
</li>
</ul>
<a name="hashCode()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hashCode</h4>
<pre>public&nbsp;int&nbsp;hashCode()</pre>
<div class="block">The hashcode method.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code>hashCode</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
<dt><span class="strong">Returns:</span></dt><dd>the hash code of the directory field</dd></dl>
</li>
</ul>
<a name="getPath()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPath</h4>
<pre>public&nbsp;java.lang.String[]&nbsp;getPath()</pre>
<div class="block">Get the path components of this directory.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the path components as an array of strings.</dd></dl>
</li>
</ul>
<a name="getPath(java.lang.String)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPath</h4>
<pre>public static&nbsp;java.lang.String[]&nbsp;getPath(java.lang.String&nbsp;thePath)</pre>
<div class="block">Convert a file path to an array of path components.
 This uses File.sepatator to split the file path string.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>thePath</code> - the file path string to convert</dd>
<dt><span class="strong">Returns:</span></dt><dd>an array of path components</dd></dl>
</li>
</ul>
<a name="fileSize()">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>fileSize</h4>
<pre>public&nbsp;int&nbsp;fileSize()</pre>
<div class="block">Get the number of files in the files attribute.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the number of 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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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="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="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/AbstractSshMessage.html" title="class in org.apache.tools.ant.taskdefs.optional.ssh"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/ssh/LogListener.html" title="interface in org.apache.tools.ant.taskdefs.optional.ssh"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/tools/ant/taskdefs/optional/ssh/Directory.html" target="_top">Frames</a></li>
<li><a href="Directory.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&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>