DirEntry.html #4

  • //
  • public/
  • perforce/
  • api/
  • java/
  • p4package/
  • docs/
  • com/
  • perforce/
  • api/
  • DirEntry.html
  • View
  • Commits
  • Open Download .zip Download (25 KB)
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Frameset//EN""http://www.w3.org/TR/REC-html40/frameset.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc on Wed May 15 10:04:41 EDT 2002 -->
<TITLE>
Perforce API: Class  DirEntry
</TITLE>
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
</HEAD>
<BODY BGCOLOR="white">

<!-- ========== START OF NAVBAR ========== -->
<A NAME="navbar_top"><!-- --></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
  <TR ALIGN="center" VALIGN="top">
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/DirEntry.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
<a target="_top" href="http://www.perforce.com/"><img alt="Perforce" border="0" height="44" width="151" src="doc-files/perforce_logo.gif"></a></EM>
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../com/perforce/api/Debug.html"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../com/perforce/api/Env.html"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../../index.html" TARGET="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="DirEntry.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  SUMMARY: &nbsp;INNER&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: &nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<!-- =========== END OF NAVBAR =========== -->

<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
com.perforce.api</FONT>
<BR>
Class  DirEntry</H2>
<PRE>
<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/Object.html">java.lang.Object</A>
  |
  +--<A HREF="../../../com/perforce/api/SourceControlObject.html">com.perforce.api.SourceControlObject</A>
        |
        +--<B>com.perforce.api.DirEntry</B>
</PRE>
<DL>
<DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../com/perforce/api/Cacheable.html">Cacheable</A></DD>
</DL>
<HR>
<DL>
<DT>public final class <B>DirEntry</B><DT>extends <A HREF="../../../com/perforce/api/SourceControlObject.html">SourceControlObject</A></DL>

<P>
Representation of a source control directory.
<P>
<DL>
<DT><B>Version: </B><DD>$Date: 2002/05/15 $ $Revision: #4 $</DD>
<DT><B>Author: </B><DD><a href="mailto:[email protected]">David Markley</a></DD>
</DL>
<HR>

<P>
<!-- ======== INNER CLASS SUMMARY ======== -->


<!-- =========== FIELD SUMMARY =========== -->


<!-- ======== CONSTRUCTOR SUMMARY ======== -->

<A NAME="constructor_summary"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=2><FONT SIZE="+2">
<B>Constructor Summary</B></FONT></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../com/perforce/api/DirEntry.html#DirEntry()">DirEntry</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default, no-argument constructor.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../com/perforce/api/DirEntry.html#DirEntry(com.perforce.api.DirEntry, java.lang.String)">DirEntry</A></B>(<A HREF="../../../com/perforce/api/DirEntry.html">DirEntry</A>&nbsp;base,
         <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;path)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructs a directory entry.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../com/perforce/api/DirEntry.html#DirEntry(com.perforce.api.Env)">DirEntry</A></B>(<A HREF="../../../com/perforce/api/Env.html">Env</A>&nbsp;e)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructs a directory entry.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../com/perforce/api/DirEntry.html#DirEntry(com.perforce.api.Env, java.lang.String)">DirEntry</A></B>(<A HREF="../../../com/perforce/api/Env.html">Env</A>&nbsp;e,
         <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;path)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructs a directory entry.</TD>
</TR>
</TABLE>
&nbsp;
<!-- ========== METHOD SUMMARY =========== -->

<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=2><FONT SIZE="+2">
<B>Method Summary</B></FONT></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/perforce/api/DirEntry.html#commit()">commit</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Does nothing.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/perforce/api/DirEntry.html#getBasePath()">getBasePath</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the base path for this directory.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../com/perforce/api/HashDecay.html">HashDecay</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/perforce/api/DirEntry.html#getCache()">getCache</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the HashDecay instance for this class</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;<A HREF="../../../com/perforce/api/DirEntry.html">DirEntry</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/perforce/api/DirEntry.html#getDirEntry(com.perforce.api.Env, java.lang.String, boolean)">getDirEntry</A></B>(<A HREF="../../../com/perforce/api/Env.html">Env</A>&nbsp;env,
            <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;path,
            boolean&nbsp;sync)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a directory entry for the supplied path.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/perforce/api/DirEntry.html#getDirNames()">getDirNames</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns an array of directory names.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/perforce/api/DirEntry.html#getDirNames(com.perforce.api.Env)">getDirNames</A></B>(<A HREF="../../../com/perforce/api/Env.html">Env</A>&nbsp;env)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns an array of directory names.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/perforce/api/DirEntry.html#getFileNames()">getFileNames</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns an array of file names for this directory.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/perforce/api/DirEntry.html#getFileNames(com.perforce.api.Env)">getFileNames</A></B>(<A HREF="../../../com/perforce/api/Env.html">Env</A>&nbsp;env)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns an array of file names for this directory.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../com/perforce/api/FileEntry.html">FileEntry</A>[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/perforce/api/DirEntry.html#getFiles()">getFiles</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns an array of file entries for this directory.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../com/perforce/api/FileEntry.html">FileEntry</A>[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/perforce/api/DirEntry.html#getFiles(com.perforce.api.Env)">getFiles</A></B>(<A HREF="../../../com/perforce/api/Env.html">Env</A>&nbsp;env)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns an array of file entries for this directory.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../com/perforce/api/DirEntry.html">DirEntry</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/perforce/api/DirEntry.html#getParent()">getParent</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the parent director.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/perforce/api/DirEntry.html#getPath()">getPath</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the path for this directory.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/perforce/api/DirEntry.html#setPath(java.lang.String)">setPath</A></B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;path)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the path for this directory.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/perforce/api/DirEntry.html#sync()">sync</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Loads the directories and files for this directory.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/perforce/api/DirEntry.html#toXML()">toXML</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a string containing the object in XML form.</TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_com.perforce.api.SourceControlObject"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TD><B>Methods inherited from class com.perforce.api.<A HREF="../../../com/perforce/api/SourceControlObject.html">SourceControlObject</A></B></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../com/perforce/api/SourceControlObject.html#clearCache()">clearCache</A>, <A HREF="../../../com/perforce/api/SourceControlObject.html#getEnv()">getEnv</A>, <A HREF="../../../com/perforce/api/SourceControlObject.html#getSyncTime()">getSyncTime</A>, <A HREF="../../../com/perforce/api/SourceControlObject.html#getUpdateTime()">getUpdateTime</A>, <A HREF="../../../com/perforce/api/SourceControlObject.html#inSync()">inSync</A>, <A HREF="../../../com/perforce/api/SourceControlObject.html#invalidate()">invalidate</A>, <A HREF="../../../com/perforce/api/SourceControlObject.html#outOfSync(long)">outOfSync</A>, <A HREF="../../../com/perforce/api/SourceControlObject.html#refreshUpdateTime()">refreshUpdateTime</A>, <A HREF="../../../com/perforce/api/SourceControlObject.html#setEnv(com.perforce.api.Env)">setEnv</A></CODE></TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TD><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/Object.html">Object</A></B></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/Object.html#clone()">clone</A>, <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/Object.html#equals(java.lang.Object)">equals</A>, <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/Object.html#finalize()">finalize</A>, <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/Object.html#getClass()">getClass</A>, <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/Object.html#hashCode()">hashCode</A>, <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/Object.html#notify()">notify</A>, <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/Object.html#notifyAll()">notifyAll</A>, <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/Object.html#toString()">toString</A>, <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/Object.html#wait()">wait</A>, <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/Object.html#wait(long)">wait</A>, <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/Object.html#wait(long, int)">wait</A></CODE></TD>
</TR>
</TABLE>
&nbsp;
<P>

<!-- ============ FIELD DETAIL =========== -->


<!-- ========= CONSTRUCTOR DETAIL ======== -->

<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TD>
</TR>
</TABLE>

<A NAME="DirEntry()"><!-- --></A><H3>
DirEntry</H3>
<PRE>
public <B>DirEntry</B>()</PRE>
<DL>
<DD>Default, no-argument constructor.</DL>
<HR>

<A NAME="DirEntry(com.perforce.api.DirEntry, java.lang.String)"><!-- --></A><H3>
DirEntry</H3>
<PRE>
public <B>DirEntry</B>(<A HREF="../../../com/perforce/api/DirEntry.html">DirEntry</A>&nbsp;base,
                <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;path)</PRE>
<DL>
<DD>Constructs a directory entry.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>base</CODE> - Another <code>DirEntry</code> used to set the environment.<DD><CODE>path</CODE> - The path for this directory.</DL>
</DD>
</DL>
<HR>

<A NAME="DirEntry(com.perforce.api.Env)"><!-- --></A><H3>
DirEntry</H3>
<PRE>
public <B>DirEntry</B>(<A HREF="../../../com/perforce/api/Env.html">Env</A>&nbsp;e)</PRE>
<DL>
<DD>Constructs a directory entry.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>e</CODE> - Source control environment to use.</DL>
</DD>
</DL>
<HR>

<A NAME="DirEntry(com.perforce.api.Env, java.lang.String)"><!-- --></A><H3>
DirEntry</H3>
<PRE>
public <B>DirEntry</B>(<A HREF="../../../com/perforce/api/Env.html">Env</A>&nbsp;e,
                <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;path)</PRE>
<DL>
<DD>Constructs a directory entry.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>e</CODE> - Source control environment to use.<DD><CODE>path</CODE> - The path for this directory.</DL>
</DD>
</DL>

<!-- ============ METHOD DETAIL ========== -->

<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Method Detail</B></FONT></TD>
</TR>
</TABLE>

<A NAME="commit()"><!-- --></A><H3>
commit</H3>
<PRE>
public void <B>commit</B>()</PRE>
<DL>
<DD>Does nothing. Doesn't do anything here, since directories are not really
 stored in perforce.<DD><DL>
<DT><B>Overrides:</B><DD><CODE><A HREF="../../../com/perforce/api/SourceControlObject.html#commit()">commit</A></CODE> in class <CODE><A HREF="../../../com/perforce/api/SourceControlObject.html">SourceControlObject</A></CODE></DL>
</DD>
</DL>
<HR>

<A NAME="getBasePath()"><!-- --></A><H3>
getBasePath</H3>
<PRE>
public <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A> <B>getBasePath</B>()</PRE>
<DL>
<DD>Returns the base path for this directory. This includes everything up
 to the last path delimeter.</DL>
<HR>

<A NAME="getCache()"><!-- --></A><H3>
getCache</H3>
<PRE>
public <A HREF="../../../com/perforce/api/HashDecay.html">HashDecay</A> <B>getCache</B>()</PRE>
<DL>
<DD><B>Description copied from class: <CODE><A HREF="../../../com/perforce/api/SourceControlObject.html">SourceControlObject</A></CODE></B></DD>
<DD>Returns the HashDecay instance for this class<DD><DL>
<DT><B>Overrides:</B><DD><CODE><A HREF="../../../com/perforce/api/SourceControlObject.html#getCache()">getCache</A></CODE> in class <CODE><A HREF="../../../com/perforce/api/SourceControlObject.html">SourceControlObject</A></CODE></DL>
</DD>
</DL>
<HR>

<A NAME="getDirEntry(com.perforce.api.Env, java.lang.String, boolean)"><!-- --></A><H3>
getDirEntry</H3>
<PRE>
public static <A HREF="../../../com/perforce/api/DirEntry.html">DirEntry</A> <B>getDirEntry</B>(<A HREF="../../../com/perforce/api/Env.html">Env</A>&nbsp;env,
                                   <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;path,
                                   boolean&nbsp;sync)</PRE>
<DL>
<DD>Returns a directory entry for the supplied path.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>env</CODE> - Source control environment to use.<DD><CODE>path</CODE> - The path for this directory.<DD><CODE>sync</CODE> - Forces the directory information to be current.</DL>
</DD>
</DL>
<HR>

<A NAME="getDirNames()"><!-- --></A><H3>
getDirNames</H3>
<PRE>
public <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>[] <B>getDirNames</B>()</PRE>
<DL>
<DD>Returns an array of directory names.</DL>
<HR>

<A NAME="getDirNames(com.perforce.api.Env)"><!-- --></A><H3>
getDirNames</H3>
<PRE>
public <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>[] <B>getDirNames</B>(<A HREF="../../../com/perforce/api/Env.html">Env</A>&nbsp;env)</PRE>
<DL>
<DD>Returns an array of directory names.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>env</CODE> - Source control environment to use.</DL>
</DD>
</DL>
<HR>

<A NAME="getFileNames()"><!-- --></A><H3>
getFileNames</H3>
<PRE>
public <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>[] <B>getFileNames</B>()</PRE>
<DL>
<DD>Returns an array of file names for this directory.</DL>
<HR>

<A NAME="getFileNames(com.perforce.api.Env)"><!-- --></A><H3>
getFileNames</H3>
<PRE>
public <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>[] <B>getFileNames</B>(<A HREF="../../../com/perforce/api/Env.html">Env</A>&nbsp;env)</PRE>
<DL>
<DD>Returns an array of file names for this directory.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>env</CODE> - Source control environment to use.</DL>
</DD>
</DL>
<HR>

<A NAME="getFiles()"><!-- --></A><H3>
getFiles</H3>
<PRE>
public <A HREF="../../../com/perforce/api/FileEntry.html">FileEntry</A>[] <B>getFiles</B>()</PRE>
<DL>
<DD>Returns an array of file entries for this directory.</DL>
<HR>

<A NAME="getFiles(com.perforce.api.Env)"><!-- --></A><H3>
getFiles</H3>
<PRE>
public <A HREF="../../../com/perforce/api/FileEntry.html">FileEntry</A>[] <B>getFiles</B>(<A HREF="../../../com/perforce/api/Env.html">Env</A>&nbsp;env)</PRE>
<DL>
<DD>Returns an array of file entries for this directory.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>env</CODE> - Source control environment to use.</DL>
</DD>
</DL>
<HR>

<A NAME="getParent()"><!-- --></A><H3>
getParent</H3>
<PRE>
public <A HREF="../../../com/perforce/api/DirEntry.html">DirEntry</A> <B>getParent</B>()</PRE>
<DL>
<DD>Returns the parent director. Constructs a new <code>DirEntry</code> that
 represents the parent and returns it.</DL>
<HR>

<A NAME="getPath()"><!-- --></A><H3>
getPath</H3>
<PRE>
public <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A> <B>getPath</B>()</PRE>
<DL>
<DD>Returns the path for this directory.</DL>
<HR>

<A NAME="setPath(java.lang.String)"><!-- --></A><H3>
setPath</H3>
<PRE>
public void <B>setPath</B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;path)</PRE>
<DL>
<DD>Sets the path for this directory.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>path</CODE> - New path for this directory.</DL>
</DD>
</DL>
<HR>

<A NAME="sync()"><!-- --></A><H3>
sync</H3>
<PRE>
public void <B>sync</B>()</PRE>
<DL>
<DD>Loads the directories and files for this directory.<DD><DL>
<DT><B>Overrides:</B><DD><CODE><A HREF="../../../com/perforce/api/SourceControlObject.html#sync()">sync</A></CODE> in class <CODE><A HREF="../../../com/perforce/api/SourceControlObject.html">SourceControlObject</A></CODE></DL>
</DD>
</DL>
<HR>

<A NAME="toXML()"><!-- --></A><H3>
toXML</H3>
<PRE>
public <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A> <B>toXML</B>()</PRE>
<DL>
<DD><B>Description copied from class: <CODE><A HREF="../../../com/perforce/api/SourceControlObject.html">SourceControlObject</A></CODE></B></DD>
<DD>Returns a string containing the object in XML form.<DD><DL>
<DT><B>Overrides:</B><DD><CODE><A HREF="../../../com/perforce/api/SourceControlObject.html#toXML()">toXML</A></CODE> in class <CODE><A HREF="../../../com/perforce/api/SourceControlObject.html">SourceControlObject</A></CODE></DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>

<!-- ========== START OF NAVBAR ========== -->
<A NAME="navbar_bottom"><!-- --></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
  <TR ALIGN="center" VALIGN="top">
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/DirEntry.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
<a target="_top" href="http://www.perforce.com/"><img alt="Perforce" border="0" height="44" width="151" src="doc-files/perforce_logo.gif"></a></EM>
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../com/perforce/api/Debug.html"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../com/perforce/api/Env.html"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../../index.html" TARGET="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="DirEntry.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  SUMMARY: &nbsp;INNER&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: &nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<!-- =========== END OF NAVBAR =========== -->

<HR>
<i><a href="doc-files/LICENSE.TXT">Copyright</a> &#169; 2001, Perforce Software, All rights reserved.</i>
</BODY>
</HTML>
# Change User Description Committed
#10 8157 michael Archiving legacy java api projects which predate the supported P4Java api.
#9 6433 Sivananda Poreddy Changing the communication preferences, and some documentation updates
#8 6166 Sivananda Poreddy Fixing problem with last check related to javadoc
#7 6164 Sivananda Poreddy Updating the javadoc to include all the new changes
#6 6141 Sivananda Poreddy Updating the p4package with fixes, some new features, jar update, and doc updates
#5 2002 David Markley Integrated the latest changes for p4package to the public depot.
#4 1808 David Markley Updated Env class and fixed fstat issues.
Published new Javadocs.
#3 1361 David Markley Added convenience methods to the Env class.
#2 1334 David Markley Added more example code.
Added the Counter class.
Corrected the filelog methods for the FileEntry class.
#1 1043 David Markley Initial branch to public area.
//guest/david_markley/p4package/docs/com/perforce/api/DirEntry.html
#2 1037 David Markley Updated the documentation.
#1 1020 David Markley Added Perforce Java API documentation.
This is generated using JavaDoc.