<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <!--NewPage--> <HTML> <HEAD> <!-- Generated by javadoc (build 1.5.0_08) on Mon Jan 28 12:25:38 PST 2008 --> <TITLE> FileEntry (Perforce API) </TITLE> <META NAME="keywords" CONTENT="com.perforce.api.FileEntry class"> <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style"> <SCRIPT type="text/javascript"> function windowTitle() { parent.document.title="FileEntry (Perforce API)"; } </SCRIPT> <NOSCRIPT> </NOSCRIPT> </HEAD> <BODY BGCOLOR="white" onload="windowTitle();"> <!-- ========= START OF TOP NAVBAR ======= --> <A NAME="navbar_top"><!-- --></A> <A HREF="#skip-navbar_top" title="Skip navigation links"></A> <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> <TR> <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A NAME="navbar_top_firstrow"><!-- --></A> <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> <TR ALIGN="center" VALIGN="top"> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../com/perforce/api/package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/FileEntry.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </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"> <A HREF="../../../com/perforce/api/EventLog.html" title="class in com.perforce.api"><B>PREV CLASS</B></A> <A HREF="../../../com/perforce/api/Group.html" title="class in com.perforce.api"><B>NEXT CLASS</B></A></FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../index.html?com/perforce/api/FileEntry.html" target="_top"><B>FRAMES</B></A> <A HREF="FileEntry.html" target="_top"><B>NO FRAMES</B></A> <SCRIPT type="text/javascript"> <!-- if(window==top) { document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>'); } //--> </SCRIPT> <NOSCRIPT> <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A> </NOSCRIPT> </FONT></TD> </TR> <TR> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> </TR> </TABLE> <A NAME="skip-navbar_top"></A> <!-- ========= END OF TOP NAVBAR ========= --> <HR> <!-- ======== START OF CLASS DATA ======== --> <H2> <FONT SIZE="-1"> com.perforce.api</FONT> <BR> Class FileEntry</H2> <PRE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">java.lang.Object</A> <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../com/perforce/api/SourceControlObject.html" title="class in com.perforce.api">com.perforce.api.SourceControlObject</A> <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>com.perforce.api.FileEntry</B> </PRE> <DL> <DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../com/perforce/api/Cacheable.html" title="interface in com.perforce.api">Cacheable</A></DD> </DL> <HR> <DL> <DT><PRE>public final class <B>FileEntry</B><DT>extends <A HREF="../../../com/perforce/api/SourceControlObject.html" title="class in com.perforce.api">SourceControlObject</A></DL> </PRE> <P> Representation of a source control file. <P> <P> <DL> <DT><B>Version:</B></DT> <DD>$Date: 2008/01/28 $ $Revision: #10 $</DD> <DT><B>Author:</B></DT> <DD><a href="mailto:david@markley.cc">David Markley</a>, <a href="mailto:sporeddy@quinstreet.com">Sivananda Poreddy</a></DD> <DT><B>See Also:</B><DD><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Hashtable.html" title="class or interface in java.util"><CODE>Hashtable</CODE></A></DL> <HR> <P> <!-- ======== CONSTRUCTOR SUMMARY ======== --> <A NAME="constructor_summary"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> <B>Constructor Summary</B></FONT></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE><B><A HREF="../../../com/perforce/api/FileEntry.html#FileEntry()">FileEntry</A></B>()</CODE> <BR> Default no-argument constructor.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE><B><A HREF="../../../com/perforce/api/FileEntry.html#FileEntry(com.perforce.api.Env)">FileEntry</A></B>(<A HREF="../../../com/perforce/api/Env.html" title="class in com.perforce.api">Env</A> env)</CODE> <BR> Constructs a file entry using the environment.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE><B><A HREF="../../../com/perforce/api/FileEntry.html#FileEntry(com.perforce.api.Env, java.lang.String)">FileEntry</A></B>(<A HREF="../../../com/perforce/api/Env.html" title="class in com.perforce.api">Env</A> env, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> p)</CODE> <BR> Constructs a file entry using the environment and path.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE><B><A HREF="../../../com/perforce/api/FileEntry.html#FileEntry(java.lang.String)">FileEntry</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> p)</CODE> <BR> Constructs a file entry using the path.</TD> </TR> </TABLE> <!-- ========== METHOD SUMMARY =========== --> <A NAME="method_summary"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> <B>Method Summary</B></FONT></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static <A HREF="../../../com/perforce/api/FileEntry.html" title="class in com.perforce.api">FileEntry</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/perforce/api/FileEntry.html#checkIn(com.perforce.api.Env, java.lang.String, java.lang.String)">checkIn</A></B>(<A HREF="../../../com/perforce/api/Env.html" title="class in com.perforce.api">Env</A> env, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> path, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> description)</CODE> <BR> Checks in a file that has already been opened on the client using the description given.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/perforce/api/FileEntry.html#commit()">commit</A></B>()</CODE> <BR> No-op.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/perforce/api/FileEntry.html#customizePath(java.lang.String, char, char)">customizePath</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> str, char from_char, char to_char)</CODE> <BR> Returns the path after converting characters.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/perforce/api/FileEntry.html#depotizePath(java.lang.String)">depotizePath</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> path)</CODE> <BR> Returns the path in depot format.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../com/perforce/api/HashDecay.html" title="class in com.perforce.api">HashDecay</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/perforce/api/FileEntry.html#getCache()">getCache</A></B>()</CODE> <BR> 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> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/perforce/api/FileEntry.html#getClientPath()">getClientPath</A></B>()</CODE> <BR> Returns the client path for this file.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/perforce/api/FileEntry.html#getDepotPath()">getDepotPath</A></B>()</CODE> <BR> Returns the depot path for this file.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/perforce/api/FileEntry.html#getDescription()">getDescription</A></B>()</CODE> <BR> Returns the decription for this file</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static <A HREF="../../../com/perforce/api/FileEntry.html" title="class in com.perforce.api">FileEntry</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/perforce/api/FileEntry.html#getFile(java.lang.String)">getFile</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> p)</CODE> <BR> Gets the file information for the specified path.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/perforce/api/FileEntry.html#getFileContents()">getFileContents</A></B>()</CODE> <BR> Returns a <code>String</code> that contains this file's contents.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/perforce/api/FileEntry.html#getFileContents(com.perforce.api.Env, java.lang.String)">getFileContents</A></B>(<A HREF="../../../com/perforce/api/Env.html" title="class in com.perforce.api">Env</A> env, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> path)</CODE> <BR> Returns a <code>String</code> that contains this file's contents.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Vector.html" title="class or interface in java.util">Vector</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/perforce/api/FileEntry.html#getFileLog(com.perforce.api.Env, java.lang.String)">getFileLog</A></B>(<A HREF="../../../com/perforce/api/Env.html" title="class in com.perforce.api">Env</A> env, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> path)</CODE> <BR> Returns a list of <code>FileEntry</code> objects that represent the history of the specified file.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Vector.html" title="class or interface in java.util">Vector</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/perforce/api/FileEntry.html#getFiles(com.perforce.api.Env, java.lang.String)">getFiles</A></B>(<A HREF="../../../com/perforce/api/Env.html" title="class in com.perforce.api">Env</A> env, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> path)</CODE> <BR> Returns the list of files for the path.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> int</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/perforce/api/FileEntry.html#getHaveRev()">getHaveRev</A></B>()</CODE> <BR> Returns the revision number the client has for this file.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/perforce/api/FileEntry.html#getHeadAction()">getHeadAction</A></B>()</CODE> <BR> Returns the head revision action for this file.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> int</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/perforce/api/FileEntry.html#getHeadChange()">getHeadChange</A></B>()</CODE> <BR> Returns the head revision change number for this file.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/perforce/api/FileEntry.html#getHeadDate()">getHeadDate</A></B>()</CODE> <BR> Returns a String representation of date for the head revsision of the file.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> int</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/perforce/api/FileEntry.html#getHeadRev()">getHeadRev</A></B>()</CODE> <BR> Returns the head revision number for this file.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> long</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/perforce/api/FileEntry.html#getHeadTime()">getHeadTime</A></B>()</CODE> <BR> Returns the head revision time for this file.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/perforce/api/FileEntry.html#getHeadTimeString()">getHeadTimeString</A></B>()</CODE> <BR> Returns the head revision time as a <code>String</code> for this file.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/perforce/api/FileEntry.html#getHeadType()">getHeadType</A></B>()</CODE> <BR> Returns the head revision type for this file.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/perforce/api/FileEntry.html#getName()">getName</A></B>()</CODE> <BR> Returns the file name.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Vector.html" title="class or interface in java.util">Vector</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/perforce/api/FileEntry.html#getOpened()">getOpened</A></B>()</CODE> <BR> Returns a list of files that are open for edit or add.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Vector.html" title="class or interface in java.util">Vector</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/perforce/api/FileEntry.html#getOpened(com.perforce.api.Env, boolean)">getOpened</A></B>(<A HREF="../../../com/perforce/api/Env.html" title="class in com.perforce.api">Env</A> env, boolean stat)</CODE> <BR> Returns a list of files that are open for edit or add.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Vector.html" title="class or interface in java.util">Vector</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/perforce/api/FileEntry.html#getOpened(com.perforce.api.Env, boolean, boolean, int, java.util.Vector)">getOpened</A></B>(<A HREF="../../../com/perforce/api/Env.html" title="class in com.perforce.api">Env</A> env, boolean stat, boolean all, int changelist, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Vector.html" title="class or interface in java.util">Vector</A> files)</CODE> <BR> Returns a list of files that are open for edit or add.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/perforce/api/FileEntry.html#getOwner()">getOwner</A></B>()</CODE> <BR> Returns the owner for this file</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../com/perforce/api/FileEntry.html" title="class in com.perforce.api">FileEntry</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/perforce/api/FileEntry.html#getSource()">getSource</A></B>()</CODE> <BR> Returns the source file entry associated with this file.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/perforce/api/FileEntry.html#localizePath(java.lang.String)">localizePath</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> path)</CODE> <BR> Returns the path in local format.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/perforce/api/FileEntry.html#obtainLock()">obtainLock</A></B>()</CODE> <BR> Obtains the lock for this file.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/perforce/api/FileEntry.html#openForAdd()">openForAdd</A></B>()</CODE> <BR> Opens this file for addition.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/perforce/api/FileEntry.html#openForAdd(com.perforce.api.Change)">openForAdd</A></B>(<A HREF="../../../com/perforce/api/Change.html" title="class in com.perforce.api">Change</A> chng)</CODE> <BR> Opens this file for addition.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static <A HREF="../../../com/perforce/api/FileEntry.html" title="class in com.perforce.api">FileEntry</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/perforce/api/FileEntry.html#openForAdd(com.perforce.api.Env, java.lang.String, com.perforce.api.Change)">openForAdd</A></B>(<A HREF="../../../com/perforce/api/Env.html" title="class in com.perforce.api">Env</A> env, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> path, <A HREF="../../../com/perforce/api/Change.html" title="class in com.perforce.api">Change</A> chng)</CODE> <BR> Opens the file on the path for add under the change.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/perforce/api/FileEntry.html#openForDelete(com.perforce.api.Change)">openForDelete</A></B>(<A HREF="../../../com/perforce/api/Change.html" title="class in com.perforce.api">Change</A> chng)</CODE> <BR> Opens this file for deletion.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/perforce/api/FileEntry.html#openForEdit()">openForEdit</A></B>()</CODE> <BR> Opens this file for edit.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/perforce/api/FileEntry.html#openForEdit(boolean)">openForEdit</A></B>(boolean lock)</CODE> <BR> Opens this file for edit.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/perforce/api/FileEntry.html#openForEdit(boolean, com.perforce.api.Change)">openForEdit</A></B>(boolean lock, <A HREF="../../../com/perforce/api/Change.html" title="class in com.perforce.api">Change</A> chng)</CODE> <BR> Opens this file for edit.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static <A HREF="../../../com/perforce/api/FileEntry.html" title="class in com.perforce.api">FileEntry</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/perforce/api/FileEntry.html#openForEdit(com.perforce.api.Env, java.lang.String, boolean, boolean, com.perforce.api.Change)">openForEdit</A></B>(<A HREF="../../../com/perforce/api/Env.html" title="class in com.perforce.api">Env</A> env, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> path, boolean sync, boolean lock, <A HREF="../../../com/perforce/api/Change.html" title="class in com.perforce.api">Change</A> chng)</CODE> <BR> Opens the file on the path for edit under the change.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/perforce/api/FileEntry.html#reopen(java.lang.String, com.perforce.api.Change)">reopen</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> type, <A HREF="../../../com/perforce/api/Change.html" title="class in com.perforce.api">Change</A> chng)</CODE> <BR> Reopens the file with the new type or in the new change list.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/perforce/api/FileEntry.html#resolve(boolean)">resolve</A></B>(boolean force)</CODE> <BR> Resolves this file.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/perforce/api/FileEntry.html#resolveAll(com.perforce.api.Env, java.lang.String, java.lang.String)">resolveAll</A></B>(<A HREF="../../../com/perforce/api/Env.html" title="class in com.perforce.api">Env</A> env, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> flags, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> path)</CODE> <BR> Resolves all the files in the path.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/perforce/api/FileEntry.html#resolveAT(com.perforce.api.Env, java.util.Enumeration)">resolveAT</A></B>(<A HREF="../../../com/perforce/api/Env.html" title="class in com.perforce.api">Env</A> env, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Enumeration.html" title="class or interface in java.util">Enumeration</A> en)</CODE> <BR> Forces a resolve on a set of files.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> boolean</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/perforce/api/FileEntry.html#revert()">revert</A></B>()</CODE> <BR> Reverts this file.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/perforce/api/FileEntry.html#setClientPath(java.lang.String)">setClientPath</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> p)</CODE> <BR> Sets the client path for this file.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/perforce/api/FileEntry.html#setDepotPath(java.lang.String)">setDepotPath</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> p)</CODE> <BR> Sets the depot path for this file.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/perforce/api/FileEntry.html#setDescription(java.lang.String)">setDescription</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> d)</CODE> <BR> Sets the decription for this file</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/perforce/api/FileEntry.html#setHaveRev(int)">setHaveRev</A></B>(int rev)</CODE> <BR> Sets the revision number the client has for this file.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/perforce/api/FileEntry.html#setHeadAction(java.lang.String)">setHeadAction</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> action)</CODE> <BR> Sets the head revision action for this file.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/perforce/api/FileEntry.html#setHeadChange(int)">setHeadChange</A></B>(int change)</CODE> <BR> Sets the head revision change number for this file.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/perforce/api/FileEntry.html#setHeadDate(java.lang.String)">setHeadDate</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> date)</CODE> <BR> Sets the head date for this file.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/perforce/api/FileEntry.html#setHeadRev(int)">setHeadRev</A></B>(int rev)</CODE> <BR> Sets the head revision number for this file.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/perforce/api/FileEntry.html#setHeadTime(long)">setHeadTime</A></B>(long time)</CODE> <BR> Sets the head revision time for this file.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/perforce/api/FileEntry.html#setHeadType(java.lang.String)">setHeadType</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> type)</CODE> <BR> Sets the head revision type for this file.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/perforce/api/FileEntry.html#setOwner(java.lang.String)">setOwner</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> o)</CODE> <BR> Sets the owner for this file</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/perforce/api/FileEntry.html#setSource(com.perforce.api.FileEntry)">setSource</A></B>(<A HREF="../../../com/perforce/api/FileEntry.html" title="class in com.perforce.api">FileEntry</A> fent)</CODE> <BR> Sets the source file entry associated with this file.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/perforce/api/FileEntry.html#setTimeFormat(java.lang.String)">setTimeFormat</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> format)</CODE> <BR> Sets the format used by the getHeadTimeString method.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/perforce/api/FileEntry.html#sync()">sync</A></B>()</CODE> <BR> Brings this object back into sync with Perforce.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Vector.html" title="class or interface in java.util">Vector</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/perforce/api/FileEntry.html#synchronizeWorkspace(com.perforce.api.Env, java.lang.String)">synchronizeWorkspace</A></B>(<A HREF="../../../com/perforce/api/Env.html" title="class in com.perforce.api">Env</A> env, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> path)</CODE> <BR> Returns a <code>Vector</code> of <code>FileEntry</code> objects that reflect what files were changed by the sync process.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/perforce/api/FileEntry.html#syncWorkspace(com.perforce.api.Env, java.lang.String)">syncWorkspace</A></B>(<A HREF="../../../com/perforce/api/Env.html" title="class in com.perforce.api">Env</A> env, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> path)</CODE> <BR> Synchronizes the workspace.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/perforce/api/FileEntry.html#syncWorkspace(com.perforce.api.Env, java.lang.String, boolean)">syncWorkspace</A></B>(<A HREF="../../../com/perforce/api/Env.html" title="class in com.perforce.api">Env</A> env, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> path, boolean force)</CODE> <BR> Synchronizes the workspace.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/perforce/api/FileEntry.html#toString()">toString</A></B>()</CODE> <BR> </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/perforce/api/FileEntry.html#toXML()">toXML</A></B>()</CODE> <BR> Returns a string containing the object in XML form.</TD> </TR> </TABLE> <A NAME="methods_inherited_from_class_com.perforce.api.SourceControlObject"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> <TH ALIGN="left"><B>Methods inherited from class com.perforce.api.<A HREF="../../../com/perforce/api/SourceControlObject.html" title="class in com.perforce.api">SourceControlObject</A></B></TH> </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> <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> <TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A></B></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD> </TR> </TABLE> <P> <!-- ========= CONSTRUCTOR DETAIL ======== --> <A NAME="constructor_detail"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> <B>Constructor Detail</B></FONT></TH> </TR> </TABLE> <A NAME="FileEntry()"><!-- --></A><H3> FileEntry</H3> <PRE> public <B>FileEntry</B>()</PRE> <DL> <DD>Default no-argument constructor. <P> </DL> <HR> <A NAME="FileEntry(com.perforce.api.Env)"><!-- --></A><H3> FileEntry</H3> <PRE> public <B>FileEntry</B>(<A HREF="../../../com/perforce/api/Env.html" title="class in com.perforce.api">Env</A> env)</PRE> <DL> <DD>Constructs a file entry using the environment. <P> <DL> <DT><B>Parameters:</B><DD><CODE>env</CODE> - Source control environement to use.</DL> </DL> <HR> <A NAME="FileEntry(com.perforce.api.Env, java.lang.String)"><!-- --></A><H3> FileEntry</H3> <PRE> public <B>FileEntry</B>(<A HREF="../../../com/perforce/api/Env.html" title="class in com.perforce.api">Env</A> env, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> p)</PRE> <DL> <DD>Constructs a file entry using the environment and path. <P> <DL> <DT><B>Parameters:</B><DD><CODE>env</CODE> - Source control environement to use.<DD><CODE>p</CODE> - Path to the file.</DL> </DL> <HR> <A NAME="FileEntry(java.lang.String)"><!-- --></A><H3> FileEntry</H3> <PRE> public <B>FileEntry</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> p)</PRE> <DL> <DD>Constructs a file entry using the path. <P> <DL> <DT><B>Parameters:</B><DD><CODE>p</CODE> - Path to the file.</DL> </DL> <!-- ============ METHOD DETAIL ========== --> <A NAME="method_detail"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> <B>Method Detail</B></FONT></TH> </TR> </TABLE> <A NAME="checkIn(com.perforce.api.Env, java.lang.String, java.lang.String)"><!-- --></A><H3> checkIn</H3> <PRE> public static <A HREF="../../../com/perforce/api/FileEntry.html" title="class in com.perforce.api">FileEntry</A> <B>checkIn</B>(<A HREF="../../../com/perforce/api/Env.html" title="class in com.perforce.api">Env</A> env, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> path, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> description) throws <A HREF="../../../com/perforce/api/PerforceException.html" title="class in com.perforce.api">PerforceException</A></PRE> <DL> <DD>Checks in a file that has already been opened on the client using the description given. A new changelist is created and used for this submission. The returned <code>FileEntry</code> contains the latest information for the checked-in file. <P> <DD><DL> <DT><B>Throws:</B> <DD><CODE><A HREF="../../../com/perforce/api/PerforceException.html" title="class in com.perforce.api">PerforceException</A></CODE></DL> </DD> </DL> <HR> <A NAME="commit()"><!-- --></A><H3> commit</H3> <PRE> public void <B>commit</B>()</PRE> <DL> <DD>No-op. This makes no sense for a FileEntry. <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../com/perforce/api/Cacheable.html#commit()">commit</A></CODE> in interface <CODE><A HREF="../../../com/perforce/api/Cacheable.html" title="interface in com.perforce.api">Cacheable</A></CODE><DT><B>Specified by:</B><DD><CODE><A HREF="../../../com/perforce/api/SourceControlObject.html#commit()">commit</A></CODE> in class <CODE><A HREF="../../../com/perforce/api/SourceControlObject.html" title="class in com.perforce.api">SourceControlObject</A></CODE></DL> </DD> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="customizePath(java.lang.String, char, char)"><!-- --></A><H3> customizePath</H3> <PRE> public static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>customizePath</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> str, char from_char, char to_char)</PRE> <DL> <DD>Returns the path after converting characters. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>str</CODE> - String to convert.<DD><CODE>from_char</CODE> - Character to be changed from.<DD><CODE>to_char</CODE> - Character to be changed to.</DL> </DD> </DL> <HR> <A NAME="depotizePath(java.lang.String)"><!-- --></A><H3> depotizePath</H3> <PRE> public static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>depotizePath</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> path)</PRE> <DL> <DD>Returns the path in depot format. Uses the depot delimeter: '/'. <P> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="getCache()"><!-- --></A><H3> getCache</H3> <PRE> public <A HREF="../../../com/perforce/api/HashDecay.html" title="class in com.perforce.api">HashDecay</A> <B>getCache</B>()</PRE> <DL> <DD><B>Description copied from class: <CODE><A HREF="../../../com/perforce/api/SourceControlObject.html#getCache()">SourceControlObject</A></CODE></B></DD> <DD>Returns the HashDecay instance for this class <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../com/perforce/api/Cacheable.html#getCache()">getCache</A></CODE> in interface <CODE><A HREF="../../../com/perforce/api/Cacheable.html" title="interface in com.perforce.api">Cacheable</A></CODE><DT><B>Specified by:</B><DD><CODE><A HREF="../../../com/perforce/api/SourceControlObject.html#getCache()">getCache</A></CODE> in class <CODE><A HREF="../../../com/perforce/api/SourceControlObject.html" title="class in com.perforce.api">SourceControlObject</A></CODE></DL> </DD> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="getClientPath()"><!-- --></A><H3> getClientPath</H3> <PRE> public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getClientPath</B>()</PRE> <DL> <DD>Returns the client path for this file. <P> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="getDepotPath()"><!-- --></A><H3> getDepotPath</H3> <PRE> public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getDepotPath</B>()</PRE> <DL> <DD>Returns the depot path for this file. <P> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="getDescription()"><!-- --></A><H3> getDescription</H3> <PRE> public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getDescription</B>()</PRE> <DL> <DD>Returns the decription for this file <P> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="getFile(java.lang.String)"><!-- --></A><H3> getFile</H3> <PRE> public static <A HREF="../../../com/perforce/api/FileEntry.html" title="class in com.perforce.api">FileEntry</A> <B>getFile</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> p)</PRE> <DL> <DD>Gets the file information for the specified path. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>p</CODE> - Path of the file to gather information about.</DL> </DD> </DL> <HR> <A NAME="getFileContents()"><!-- --></A><H3> getFileContents</H3> <PRE> public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getFileContents</B>()</PRE> <DL> <DD>Returns a <code>String</code> that contains this file's contents. This only works well for text files. <P> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="getFileContents(com.perforce.api.Env, java.lang.String)"><!-- --></A><H3> getFileContents</H3> <PRE> public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getFileContents</B>(<A HREF="../../../com/perforce/api/Env.html" title="class in com.perforce.api">Env</A> env, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> path)</PRE> <DL> <DD>Returns a <code>String</code> that contains this file's contents. This only works well for text files. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>env</CODE> - Source control environment.<DD><CODE>path</CODE> - Path to the file. Must be specific. No wildcards.</DL> </DD> </DL> <HR> <A NAME="getFileLog(com.perforce.api.Env, java.lang.String)"><!-- --></A><H3> getFileLog</H3> <PRE> public static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Vector.html" title="class or interface in java.util">Vector</A> <B>getFileLog</B>(<A HREF="../../../com/perforce/api/Env.html" title="class in com.perforce.api">Env</A> env, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> path)</PRE> <DL> <DD>Returns a list of <code>FileEntry</code> objects that represent the history of the specified file. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>env</CODE> - Source control environment to use.<DD><CODE>path</CODE> - Path to the file. Must be specific. No wildcards.</DL> </DD> </DL> <HR> <A NAME="getFiles(com.perforce.api.Env, java.lang.String)"><!-- --></A><H3> getFiles</H3> <PRE> public static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Vector.html" title="class or interface in java.util">Vector</A> <B>getFiles</B>(<A HREF="../../../com/perforce/api/Env.html" title="class in com.perforce.api">Env</A> env, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> path)</PRE> <DL> <DD>Returns the list of files for the path. The path may include wildcards. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>env</CODE> - Source control environment to use.<DD><CODE>path</CODE> - Path for set of files.</DL> </DD> </DL> <HR> <A NAME="getHaveRev()"><!-- --></A><H3> getHaveRev</H3> <PRE> public int <B>getHaveRev</B>()</PRE> <DL> <DD>Returns the revision number the client has for this file. <P> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="getHeadAction()"><!-- --></A><H3> getHeadAction</H3> <PRE> public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getHeadAction</B>()</PRE> <DL> <DD>Returns the head revision action for this file. <P> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="getHeadChange()"><!-- --></A><H3> getHeadChange</H3> <PRE> public int <B>getHeadChange</B>()</PRE> <DL> <DD>Returns the head revision change number for this file. <P> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="getHeadDate()"><!-- --></A><H3> getHeadDate</H3> <PRE> public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getHeadDate</B>()</PRE> <DL> <DD>Returns a String representation of date for the head revsision of the file. The format is yyyy/MM/dd. <P> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="getHeadRev()"><!-- --></A><H3> getHeadRev</H3> <PRE> public int <B>getHeadRev</B>()</PRE> <DL> <DD>Returns the head revision number for this file. <P> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="getHeadTime()"><!-- --></A><H3> getHeadTime</H3> <PRE> public long <B>getHeadTime</B>()</PRE> <DL> <DD>Returns the head revision time for this file. <P> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="getHeadTimeString()"><!-- --></A><H3> getHeadTimeString</H3> <PRE> public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getHeadTimeString</B>()</PRE> <DL> <DD>Returns the head revision time as a <code>String</code> for this file. <P> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="getHeadType()"><!-- --></A><H3> getHeadType</H3> <PRE> public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getHeadType</B>()</PRE> <DL> <DD>Returns the head revision type for this file. <P> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="getName()"><!-- --></A><H3> getName</H3> <PRE> public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getName</B>()</PRE> <DL> <DD>Returns the file name. <P> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="getOpened()"><!-- --></A><H3> getOpened</H3> <PRE> public static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Vector.html" title="class or interface in java.util">Vector</A> <B>getOpened</B>()</PRE> <DL> <DD>Returns a list of files that are open for edit or add. The list is a <code>Vectore</code> of <code>FileEntry</code> objects. The only information that is valid for the object will be the path, until the <A HREF="../../../com/perforce/api/FileEntry.html#sync()"><CODE>sync</CODE></A> method is called. <P> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="getOpened(com.perforce.api.Env, boolean)"><!-- --></A><H3> getOpened</H3> <PRE> public static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Vector.html" title="class or interface in java.util">Vector</A> <B>getOpened</B>(<A HREF="../../../com/perforce/api/Env.html" title="class in com.perforce.api">Env</A> env, boolean stat)</PRE> <DL> <DD>Returns a list of files that are open for edit or add. The list is a <code>Vectore</code> of <code>FileEntry</code> objects. <p> Getting the stats for each <code>FileEntry</code> is a more expensive operation. By default, this is not done. What this means is that the only information that is valid for the object will be the path, until the <A HREF="../../../com/perforce/api/FileEntry.html#sync()"><CODE>sync</CODE></A> method is called. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>env</CODE> - Source control environment to use.<DD><CODE>stat</CODE> - Indicates that file statistics should be gathered.</DL> </DD> </DL> <HR> <A NAME="getOpened(com.perforce.api.Env, boolean, boolean, int, java.util.Vector)"><!-- --></A><H3> getOpened</H3> <PRE> public static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Vector.html" title="class or interface in java.util">Vector</A> <B>getOpened</B>(<A HREF="../../../com/perforce/api/Env.html" title="class in com.perforce.api">Env</A> env, boolean stat, boolean all, int changelist, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Vector.html" title="class or interface in java.util">Vector</A> files)</PRE> <DL> <DD>Returns a list of files that are open for edit or add. The list is a <code>Vector</code> of <code>FileEntry</code> objects. <p> Getting the stats for each <code>FileEntry</code> is a more expensive operation. By default, this is not done. What this means is that the only information that is valid for the object will be the path, until the <A HREF="../../../com/perforce/api/FileEntry.html#sync()"><CODE>sync</CODE></A> method is called. <p> If changelist is 0, all the changes in the default changelist are returned. If it is less than 0, all opened files are returned. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>env</CODE> - Source control environment to use.<DD><CODE>stat</CODE> - Indicates that file statistics should be gathered.<DD><CODE>all</CODE> - Indicates that all open files should be returned.<DD><CODE>changelist</CODE> - If non-zero, show files open in this changelist.<DD><CODE>files</CODE> - If non-null, show files open in this <code>Vector</code> of <code>FileEntry</code> objects.</DL> </DD> </DL> <HR> <A NAME="getOwner()"><!-- --></A><H3> getOwner</H3> <PRE> public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getOwner</B>()</PRE> <DL> <DD>Returns the owner for this file <P> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="getSource()"><!-- --></A><H3> getSource</H3> <PRE> public <A HREF="../../../com/perforce/api/FileEntry.html" title="class in com.perforce.api">FileEntry</A> <B>getSource</B>()</PRE> <DL> <DD>Returns the source file entry associated with this file. <P> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="localizePath(java.lang.String)"><!-- --></A><H3> localizePath</H3> <PRE> public static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>localizePath</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> path)</PRE> <DL> <DD>Returns the path in local format. Uses the local path delimeter. <P> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="obtainLock()"><!-- --></A><H3> obtainLock</H3> <PRE> public void <B>obtainLock</B>() throws <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Exception.html" title="class or interface in java.lang">Exception</A></PRE> <DL> <DD>Obtains the lock for this file. The file must have been opened for edit prior to this method being called. <P> <DD><DL> <DT><B>Throws:</B> <DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Exception.html" title="class or interface in java.lang">Exception</A></CODE></DL> </DD> </DL> <HR> <A NAME="openForAdd()"><!-- --></A><H3> openForAdd</H3> <PRE> public void <B>openForAdd</B>() throws <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Exception.html" title="class or interface in java.lang">Exception</A></PRE> <DL> <DD>Opens this file for addition. <P> <DD><DL> <DT><B>Throws:</B> <DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Exception.html" title="class or interface in java.lang">Exception</A></CODE><DT><B>See Also:</B><DD><A HREF="../../../com/perforce/api/FileEntry.html#openForAdd(com.perforce.api.Env, java.lang.String, com.perforce.api.Change)"><CODE>openForAdd(Env, String, Change)</CODE></A></DL> </DD> </DL> <HR> <A NAME="openForAdd(com.perforce.api.Change)"><!-- --></A><H3> openForAdd</H3> <PRE> public void <B>openForAdd</B>(<A HREF="../../../com/perforce/api/Change.html" title="class in com.perforce.api">Change</A> chng) throws <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Exception.html" title="class or interface in java.lang">Exception</A></PRE> <DL> <DD>Opens this file for addition. <P> <DD><DL> <DT><B>Throws:</B> <DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Exception.html" title="class or interface in java.lang">Exception</A></CODE><DT><B>See Also:</B><DD><A HREF="../../../com/perforce/api/FileEntry.html#openForAdd(com.perforce.api.Env, java.lang.String, com.perforce.api.Change)"><CODE>openForAdd(Env, String, Change)</CODE></A></DL> </DD> </DL> <HR> <A NAME="openForAdd(com.perforce.api.Env, java.lang.String, com.perforce.api.Change)"><!-- --></A><H3> openForAdd</H3> <PRE> public static <A HREF="../../../com/perforce/api/FileEntry.html" title="class in com.perforce.api">FileEntry</A> <B>openForAdd</B>(<A HREF="../../../com/perforce/api/Env.html" title="class in com.perforce.api">Env</A> env, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> path, <A HREF="../../../com/perforce/api/Change.html" title="class in com.perforce.api">Change</A> chng) throws <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Exception.html" title="class or interface in java.lang">Exception</A></PRE> <DL> <DD>Opens the file on the path for add under the change. If the change is null, the file is opened under the default changelist. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>env</CODE> - P4 Environment<DD><CODE>path</CODE> - Depot or client path to the file being opened for add.<DD><CODE>chng</CODE> - The change that the file will be opened for add in. <DT><B>Throws:</B> <DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Exception.html" title="class or interface in java.lang">Exception</A></CODE></DL> </DD> </DL> <HR> <A NAME="openForDelete(com.perforce.api.Change)"><!-- --></A><H3> openForDelete</H3> <PRE> public void <B>openForDelete</B>(<A HREF="../../../com/perforce/api/Change.html" title="class in com.perforce.api">Change</A> chng) throws <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Exception.html" title="class or interface in java.lang">Exception</A></PRE> <DL> <DD>Opens this file for deletion. <P> <DD><DL> <DT><B>Throws:</B> <DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Exception.html" title="class or interface in java.lang">Exception</A></CODE></DL> </DD> </DL> <HR> <A NAME="openForEdit()"><!-- --></A><H3> openForEdit</H3> <PRE> public void <B>openForEdit</B>() throws <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Exception.html" title="class or interface in java.lang">Exception</A></PRE> <DL> <DD>Opens this file for edit. <P> <DD><DL> <DT><B>Throws:</B> <DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Exception.html" title="class or interface in java.lang">Exception</A></CODE><DT><B>See Also:</B><DD><A HREF="../../../com/perforce/api/FileEntry.html#openForEdit(com.perforce.api.Env, java.lang.String, boolean, boolean, com.perforce.api.Change)"><CODE>openForEdit(Env, String, boolean, boolean, Change)</CODE></A></DL> </DD> </DL> <HR> <A NAME="openForEdit(boolean)"><!-- --></A><H3> openForEdit</H3> <PRE> public void <B>openForEdit</B>(boolean lock) throws <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Exception.html" title="class or interface in java.lang">Exception</A></PRE> <DL> <DD>Opens this file for edit. <P> <DD><DL> <DT><B>Throws:</B> <DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Exception.html" title="class or interface in java.lang">Exception</A></CODE><DT><B>See Also:</B><DD><A HREF="../../../com/perforce/api/FileEntry.html#openForEdit(com.perforce.api.Env, java.lang.String, boolean, boolean, com.perforce.api.Change)"><CODE>openForEdit(Env, String, boolean, boolean, Change)</CODE></A></DL> </DD> </DL> <HR> <A NAME="openForEdit(boolean, com.perforce.api.Change)"><!-- --></A><H3> openForEdit</H3> <PRE> public void <B>openForEdit</B>(boolean lock, <A HREF="../../../com/perforce/api/Change.html" title="class in com.perforce.api">Change</A> chng) throws <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Exception.html" title="class or interface in java.lang">Exception</A></PRE> <DL> <DD>Opens this file for edit. <P> <DD><DL> <DT><B>Throws:</B> <DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Exception.html" title="class or interface in java.lang">Exception</A></CODE><DT><B>See Also:</B><DD><A HREF="../../../com/perforce/api/FileEntry.html#openForEdit(com.perforce.api.Env, java.lang.String, boolean, boolean, com.perforce.api.Change)"><CODE>openForEdit(Env, String, boolean, boolean, Change)</CODE></A></DL> </DD> </DL> <HR> <A NAME="openForEdit(com.perforce.api.Env, java.lang.String, boolean, boolean, com.perforce.api.Change)"><!-- --></A><H3> openForEdit</H3> <PRE> public static <A HREF="../../../com/perforce/api/FileEntry.html" title="class in com.perforce.api">FileEntry</A> <B>openForEdit</B>(<A HREF="../../../com/perforce/api/Env.html" title="class in com.perforce.api">Env</A> env, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> path, boolean sync, boolean lock, <A HREF="../../../com/perforce/api/Change.html" title="class in com.perforce.api">Change</A> chng) throws <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Exception.html" title="class or interface in java.lang">Exception</A></PRE> <DL> <DD>Opens the file on the path for edit under the change. If the change is null, the file is opened under the default changelist. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>env</CODE> - P4 Environment<DD><CODE>path</CODE> - Depot or client path to the file being opened for edit.<DD><CODE>sync</CODE> - If true, the file will be sync'd before opened for edit.<DD><CODE>lock</CODE> - If true, the file will be locked once opened.<DD><CODE>chng</CODE> - The change that the file will be opened for edit in. <DT><B>Throws:</B> <DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Exception.html" title="class or interface in java.lang">Exception</A></CODE></DL> </DD> </DL> <HR> <A NAME="reopen(java.lang.String, com.perforce.api.Change)"><!-- --></A><H3> reopen</H3> <PRE> public void <B>reopen</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> type, <A HREF="../../../com/perforce/api/Change.html" title="class in com.perforce.api">Change</A> chng) throws <A HREF="../../../com/perforce/api/PerforceException.html" title="class in com.perforce.api">PerforceException</A></PRE> <DL> <DD>Reopens the file with the new type or in the new change list. <P> <DD><DL> <DT><B>Throws:</B> <DD><CODE><A HREF="../../../com/perforce/api/PerforceException.html" title="class in com.perforce.api">PerforceException</A></CODE></DL> </DD> </DL> <HR> <A NAME="resolve(boolean)"><!-- --></A><H3> resolve</H3> <PRE> public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>resolve</B>(boolean force) throws <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></PRE> <DL> <DD>Resolves this file. If the force flag is false, and auto-resolve is attempted (p4 resolve -am). If the force flag is true, an "accept theirs" resolve is completed (p4 resolve -at). <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>force</CODE> - Indicates whether the resolve should be forced. <DT><B>Throws:</B> <DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></CODE></DL> </DD> </DL> <HR> <A NAME="resolveAll(com.perforce.api.Env, java.lang.String, java.lang.String)"><!-- --></A><H3> resolveAll</H3> <PRE> public static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>resolveAll</B>(<A HREF="../../../com/perforce/api/Env.html" title="class in com.perforce.api">Env</A> env, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> flags, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> path) throws <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></PRE> <DL> <DD>Resolves all the files in the path. The flags are used by the 'p4 resolve' command to resolve any files in the path. This is just a simple way to execute the 'p4 resolve' command. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>env</CODE> - Source control environment to use.<DD><CODE>flags</CODE> - 'p4 resolve' command flags.<DD><CODE>path</CODE> - Path over which to resolve. May include wildcards. <DT><B>Throws:</B> <DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></CODE></DL> </DD> </DL> <HR> <A NAME="resolveAT(com.perforce.api.Env, java.util.Enumeration)"><!-- --></A><H3> resolveAT</H3> <PRE> public static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>resolveAT</B>(<A HREF="../../../com/perforce/api/Env.html" title="class in com.perforce.api">Env</A> env, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Enumeration.html" title="class or interface in java.util">Enumeration</A> en) throws <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></PRE> <DL> <DD>Forces a resolve on a set of files. The <code>Enumeration</code> contains the set of <code>FileEntry</code> objects that need resolved. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>env</CODE> - Source control environment to use.<DD><CODE>en</CODE> - <code>Enumeration</code> of <code>FileEntry</code>. <DT><B>Throws:</B> <DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></CODE></DL> </DD> </DL> <HR> <A NAME="revert()"><!-- --></A><H3> revert</H3> <PRE> public boolean <B>revert</B>()</PRE> <DL> <DD>Reverts this file. <P> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="setClientPath(java.lang.String)"><!-- --></A><H3> setClientPath</H3> <PRE> public void <B>setClientPath</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> p)</PRE> <DL> <DD>Sets the client path for this file. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>p</CODE> - path for this file on the client system.</DL> </DD> </DL> <HR> <A NAME="setDepotPath(java.lang.String)"><!-- --></A><H3> setDepotPath</H3> <PRE> public void <B>setDepotPath</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> p)</PRE> <DL> <DD>Sets the depot path for this file. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>p</CODE> - path for this file in the depot.</DL> </DD> </DL> <HR> <A NAME="setDescription(java.lang.String)"><!-- --></A><H3> setDescription</H3> <PRE> public void <B>setDescription</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> d)</PRE> <DL> <DD>Sets the decription for this file <P> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="setHaveRev(int)"><!-- --></A><H3> setHaveRev</H3> <PRE> public void <B>setHaveRev</B>(int rev)</PRE> <DL> <DD>Sets the revision number the client has for this file. <P> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="setHeadAction(java.lang.String)"><!-- --></A><H3> setHeadAction</H3> <PRE> public void <B>setHeadAction</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> action)</PRE> <DL> <DD>Sets the head revision action for this file. <P> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="setHeadChange(int)"><!-- --></A><H3> setHeadChange</H3> <PRE> public void <B>setHeadChange</B>(int change)</PRE> <DL> <DD>Sets the head revision change number for this file. <P> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="setHeadDate(java.lang.String)"><!-- --></A><H3> setHeadDate</H3> <PRE> public void <B>setHeadDate</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> date)</PRE> <DL> <DD>Sets the head date for this file. The expected format for the date is yyyy/MM/dd. The time will default to 12:00:00 AM. <P> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="setHeadRev(int)"><!-- --></A><H3> setHeadRev</H3> <PRE> public void <B>setHeadRev</B>(int rev)</PRE> <DL> <DD>Sets the head revision number for this file. <P> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="setHeadTime(long)"><!-- --></A><H3> setHeadTime</H3> <PRE> public void <B>setHeadTime</B>(long time)</PRE> <DL> <DD>Sets the head revision time for this file. <P> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="setHeadType(java.lang.String)"><!-- --></A><H3> setHeadType</H3> <PRE> public void <B>setHeadType</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> type)</PRE> <DL> <DD>Sets the head revision type for this file. <P> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="setOwner(java.lang.String)"><!-- --></A><H3> setOwner</H3> <PRE> public void <B>setOwner</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> o)</PRE> <DL> <DD>Sets the owner for this file <P> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="setSource(com.perforce.api.FileEntry)"><!-- --></A><H3> setSource</H3> <PRE> public void <B>setSource</B>(<A HREF="../../../com/perforce/api/FileEntry.html" title="class in com.perforce.api">FileEntry</A> fent)</PRE> <DL> <DD>Sets the source file entry associated with this file. <P> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="setTimeFormat(java.lang.String)"><!-- --></A><H3> setTimeFormat</H3> <PRE> public void <B>setTimeFormat</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> format)</PRE> <DL> <DD>Sets the format used by the getHeadTimeString method. The format of this string is that of the SimpleDateFormat class. <p> An example format would be setTimeFormat("MM/dd HH:mm:ss"); <P> <DD><DL> <DT><B>See Also:</B><DD><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/text/SimpleDateFormat.html" title="class or interface in java.text"><CODE>SimpleDateFormat</CODE></A></DL> </DD> </DL> <HR> <A NAME="sync()"><!-- --></A><H3> sync</H3> <PRE> public void <B>sync</B>()</PRE> <DL> <DD><B>Description copied from class: <CODE><A HREF="../../../com/perforce/api/SourceControlObject.html#sync()">SourceControlObject</A></CODE></B></DD> <DD>Brings this object back into sync with Perforce. This also sets the sets the update and sync time for this object. <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../com/perforce/api/Cacheable.html#sync()">sync</A></CODE> in interface <CODE><A HREF="../../../com/perforce/api/Cacheable.html" title="interface in com.perforce.api">Cacheable</A></CODE><DT><B>Specified by:</B><DD><CODE><A HREF="../../../com/perforce/api/SourceControlObject.html#sync()">sync</A></CODE> in class <CODE><A HREF="../../../com/perforce/api/SourceControlObject.html" title="class in com.perforce.api">SourceControlObject</A></CODE></DL> </DD> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="synchronizeWorkspace(com.perforce.api.Env, java.lang.String)"><!-- --></A><H3> synchronizeWorkspace</H3> <PRE> public static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Vector.html" title="class or interface in java.util">Vector</A> <B>synchronizeWorkspace</B>(<A HREF="../../../com/perforce/api/Env.html" title="class in com.perforce.api">Env</A> env, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> path) throws <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></PRE> <DL> <DD>Returns a <code>Vector</code> of <code>FileEntry</code> objects that reflect what files were changed by the sync process. If path is null, the entire workspace is synchronized to the head revision. The path may contain wildcard characters, as with the command line 'p4 sync' command. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>env</CODE> - Source control environment.<DD><CODE>path</CODE> - Path to synchronize. May include wildcards. <DT><B>Throws:</B> <DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></CODE></DL> </DD> </DL> <HR> <A NAME="syncWorkspace(com.perforce.api.Env, java.lang.String)"><!-- --></A><H3> syncWorkspace</H3> <PRE> public static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>syncWorkspace</B>(<A HREF="../../../com/perforce/api/Env.html" title="class in com.perforce.api">Env</A> env, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> path) throws <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></PRE> <DL> <DD>Synchronizes the workspace. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>env</CODE> - Source control environment.<DD><CODE>path</CODE> - Path to synchronize. May include wildcards. <DT><B>Throws:</B> <DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></CODE></DL> </DD> </DL> <HR> <A NAME="syncWorkspace(com.perforce.api.Env, java.lang.String, boolean)"><!-- --></A><H3> syncWorkspace</H3> <PRE> public static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>syncWorkspace</B>(<A HREF="../../../com/perforce/api/Env.html" title="class in com.perforce.api">Env</A> env, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> path, boolean force) throws <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></PRE> <DL> <DD>Synchronizes the workspace. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>env</CODE> - Source control environment.<DD><CODE>path</CODE> - Path to synchronize. May include wildcards.<DD><CODE>force</CODE> - Whether to do a force sync <DT><B>Throws:</B> <DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></CODE></DL> </DD> </DL> <HR> <A NAME="toString()"><!-- --></A><H3> toString</H3> <PRE> public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>toString</B>()</PRE> <DL> <DD><DL> <DT><B>Overrides:</B><DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#toString()" title="class or interface in java.lang">toString</A></CODE> in class <CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A></CODE></DL> </DD> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="toXML()"><!-- --></A><H3> toXML</H3> <PRE> public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>toXML</B>()</PRE> <DL> <DD><B>Description copied from class: <CODE><A HREF="../../../com/perforce/api/SourceControlObject.html#toXML()">SourceControlObject</A></CODE></B></DD> <DD>Returns a string containing the object in XML form. <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../com/perforce/api/SourceControlObject.html#toXML()">toXML</A></CODE> in class <CODE><A HREF="../../../com/perforce/api/SourceControlObject.html" title="class in com.perforce.api">SourceControlObject</A></CODE></DL> </DD> <DD><DL> </DL> </DD> </DL> <!-- ========= END OF CLASS DATA ========= --> <HR> <!-- ======= START OF BOTTOM NAVBAR ====== --> <A NAME="navbar_bottom"><!-- --></A> <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> <TR> <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A NAME="navbar_bottom_firstrow"><!-- --></A> <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> <TR ALIGN="center" VALIGN="top"> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../com/perforce/api/package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/FileEntry.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </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"> <A HREF="../../../com/perforce/api/EventLog.html" title="class in com.perforce.api"><B>PREV CLASS</B></A> <A HREF="../../../com/perforce/api/Group.html" title="class in com.perforce.api"><B>NEXT CLASS</B></A></FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../index.html?com/perforce/api/FileEntry.html" target="_top"><B>FRAMES</B></A> <A HREF="FileEntry.html" target="_top"><B>NO FRAMES</B></A> <SCRIPT type="text/javascript"> <!-- if(window==top) { document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>'); } //--> </SCRIPT> <NOSCRIPT> <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A> </NOSCRIPT> </FONT></TD> </TR> <TR> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> </TR> </TABLE> <A NAME="skip-navbar_bottom"></A> <!-- ======== END OF BOTTOM NAVBAR ======= --> <HR> <i><a href="doc-files/LICENSE.TXT">Copyright</a> © 2008, Perforce Software, All rights reserved.</i> </BODY> </HTML>
# | Change | User | Description | Committed | |
---|---|---|---|---|---|
#12 | 8157 | michael | Archiving legacy java api projects which predate the supported P4Java api. | ||
#11 | 6433 | Sivananda Poreddy | Changing the communication preferences, and some documentation updates | ||
#10 | 6166 | Sivananda Poreddy | Fixing problem with last check related to javadoc | ||
#9 | 6164 | Sivananda Poreddy | Updating the javadoc to include all the new changes | ||
#8 | 6141 | Sivananda Poreddy | Updating the p4package with fixes, some new features, jar update, and doc updates | ||
#7 | 2002 | David Markley | Integrated the latest changes for p4package to the public depot. | ||
#6 | 1888 | David Markley | Ingegrated the changes into the public depot. | ||
#5 | 1808 | David Markley |
Updated Env class and fixed fstat issues. Published new Javadocs. |
||
#4 | 1387 | David Markley |
Added the ability to reopen files, add them to changelists, and updated the documentation to reflect these changes. |
||
#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/FileEntry.html | |||||
#2 | 1037 | David Markley | Updated the documentation. | ||
#1 | 1020 | David Markley |
Added Perforce Java API documentation. This is generated using JavaDoc. |