<!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 Mon Jan 28 16:39:32 EST 2002 --> <TITLE> Perforce API: Uses of Class com.perforce.api.PerforceException </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> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../com/perforce/api/PerforceException.html"><FONT CLASS="NavBarFont1"><B>Class</B></FONT></A> </TD> <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Use</B></FONT> </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"> PREV NEXT</FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../index.html" TARGET="_top"><B>FRAMES</B></A> <A HREF="PerforceException.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD> </TR> </TABLE> <!-- =========== END OF NAVBAR =========== --> <HR> <CENTER> <H2> <B>Uses of Class<br>com.perforce.api.PerforceException</B></H2> </CENTER> <A NAME="com.perforce.api"><!-- --></A> <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TD COLSPAN=2><FONT SIZE="+2"> Uses of <A HREF="../../../../com/perforce/api/PerforceException.html">PerforceException</A> in <A HREF="../../../../com/perforce/api/package-summary.html">com.perforce.api</A></FONT></TD> </TR> </TABLE> <P> <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> <TR BGCOLOR="#CCCCFF" CLASS="TableSubHeadingColor"> <TD COLSPAN=2>Subclasses of <A HREF="../../../../com/perforce/api/PerforceException.html">PerforceException</A> in <A HREF="../../../../com/perforce/api/package-summary.html">com.perforce.api</A></FONT></TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> class</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../com/perforce/api/CommitException.html">CommitException</A></B></CODE> <BR> Signals that an exception occurred during the process of committing a cacheable object to perforce.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> class</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../com/perforce/api/SubmitException.html">SubmitException</A></B></CODE> <BR> Signals that an exception occurred during a submit to Perforce.</TD> </TR> </TABLE> <P> <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> <TR BGCOLOR="#CCCCFF" CLASS="TableSubHeadingColor"> <TD COLSPAN=2>Methods in <A HREF="../../../../com/perforce/api/package-summary.html">com.perforce.api</A> that throw <A HREF="../../../../com/perforce/api/PerforceException.html">PerforceException</A></FONT></TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>abstract void</CODE></FONT></TD> <TD><CODE><B>SourceControlObject.</B><B><A HREF="../../../../com/perforce/api/SourceControlObject.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="../../../../com/perforce/api/Change.html">Change</A></CODE></FONT></TD> <TD><CODE><B>Branch.</B><B><A HREF="../../../../com/perforce/api/Branch.html#integrate(com.perforce.api.Env, java.util.Vector, java.lang.String, java.lang.StringBuffer, java.lang.String)">integrate</A></B>(<A HREF="../../../../com/perforce/api/Env.html">Env</A> env, <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/util/Vector.html">Vector</A> fents, <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A> branch, <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/StringBuffer.html">StringBuffer</A> sb, <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A> description)</CODE> <BR> Integrate a set of files using the named branch.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static <A HREF="../../../../com/perforce/api/Change.html">Change</A></CODE></FONT></TD> <TD><CODE><B>Branch.</B><B><A HREF="../../../../com/perforce/api/Branch.html#integrate(com.perforce.api.Env, java.util.Vector, java.lang.String, java.lang.StringBuffer, com.perforce.api.Change)">integrate</A></B>(<A HREF="../../../../com/perforce/api/Env.html">Env</A> env, <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/util/Vector.html">Vector</A> fents, <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A> branch, <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/StringBuffer.html">StringBuffer</A> sb, <A HREF="../../../../com/perforce/api/Change.html">Change</A> c)</CODE> <BR> Integrate a set of files using the named branch.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../../com/perforce/api/Change.html">Change</A></CODE></FONT></TD> <TD><CODE><B>Branch.</B><B><A HREF="../../../../com/perforce/api/Branch.html#integrate(java.lang.String, java.lang.StringBuffer, com.perforce.api.Change)">integrate</A></B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A> source, <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/StringBuffer.html">StringBuffer</A> sb, <A HREF="../../../../com/perforce/api/Change.html">Change</A> c)</CODE> <BR> Class method for integrating using the instantiated Branch.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static <A HREF="../../../../com/perforce/api/Change.html">Change</A></CODE></FONT></TD> <TD><CODE><B>Branch.</B><B><A HREF="../../../../com/perforce/api/Branch.html#integrate(com.perforce.api.Env, java.lang.String, java.lang.String, java.lang.StringBuffer, com.perforce.api.Change)">integrate</A></B>(<A HREF="../../../../com/perforce/api/Env.html">Env</A> env, <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A> source, <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A> branch, <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/StringBuffer.html">StringBuffer</A> sb, <A HREF="../../../../com/perforce/api/Change.html">Change</A> c)</CODE> <BR> Integrate a set of files using the named branch.</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>Cacheable.</B><B><A HREF="../../../../com/perforce/api/Cacheable.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> void</CODE></FONT></TD> <TD><CODE><B>Counter.</B><B><A HREF="../../../../com/perforce/api/Counter.html#sync()">sync</A></B>()</CODE> <BR> </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static <A HREF="../../../../com/perforce/api/Counter.html">Counter</A>[]</CODE></FONT></TD> <TD><CODE><B>Counter.</B><B><A HREF="../../../../com/perforce/api/Counter.html#getCounters(com.perforce.api.Env)">getCounters</A></B>(<A HREF="../../../../com/perforce/api/Env.html">Env</A> env)</CODE> <BR> Returns an array of all the Counters established on the server.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../../com/perforce/api/Change.html">Change</A>[]</CODE></FONT></TD> <TD><CODE><B>Counter.</B><B><A HREF="../../../../com/perforce/api/Counter.html#review()">review</A></B>()</CODE> <BR> Determine the changelists that need to be reviewed.</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>Env.</B><B><A HREF="../../../../com/perforce/api/Env.html#checkValidity()">checkValidity</A></B>()</CODE> <BR> Checks the environment to see if it is valid.</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>Change.</B><B><A HREF="../../../../com/perforce/api/Change.html#addFile(com.perforce.api.FileEntry)">addFile</A></B>(<A HREF="../../../../com/perforce/api/FileEntry.html">FileEntry</A> fent)</CODE> <BR> Adds the given <code>FileEntry</code> to the changelist.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A></CODE></FONT></TD> <TD><CODE><B>Change.</B><B><A HREF="../../../../com/perforce/api/Change.html#resolve(boolean)">resolve</A></B>(boolean force)</CODE> <BR> Resolves the files associated with this change.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A></CODE></FONT></TD> <TD><CODE><B>Change.</B><B><A HREF="../../../../com/perforce/api/Change.html#deleteEmptyChange()">deleteEmptyChange</A></B>()</CODE> <BR> Deletes the Changelist if it is empty.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../../com/perforce/api/User.html">User</A>[]</CODE></FONT></TD> <TD><CODE><B>Change.</B><B><A HREF="../../../../com/perforce/api/Change.html#reviews()">reviews</A></B>()</CODE> <BR> Determine the users that review this changelist.</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">FileEntry</A></CODE></FONT></TD> <TD><CODE><B>FileEntry.</B><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">Env</A> env, <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A> path, <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">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>FileEntry.</B><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/products/jdk/1.3/docs/api/java/lang/String.html">String</A> type, <A HREF="../../../../com/perforce/api/Change.html">Change</A> chng)</CODE> <BR> Reopens the file with the new type or in the new change list.</TD> </TR> </TABLE> <P> <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> <TR BGCOLOR="#CCCCFF" CLASS="TableSubHeadingColor"> <TD COLSPAN=2>Constructors in <A HREF="../../../../com/perforce/api/package-summary.html">com.perforce.api</A> that throw <A HREF="../../../../com/perforce/api/PerforceException.html">PerforceException</A></FONT></TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE><B><A HREF="../../../../com/perforce/api/Env.html#Env(java.lang.String)">Env</A></B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A> propfile)</CODE> <BR> Constructs an environment from a properties file.</TD> </TR> </TABLE> <P> <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> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../com/perforce/api/PerforceException.html"><FONT CLASS="NavBarFont1"><B>Class</B></FONT></A> </TD> <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Use</B></FONT> </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"> PREV NEXT</FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../index.html" TARGET="_top"><B>FRAMES</B></A> <A HREF="PerforceException.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD> </TR> </TABLE> <!-- =========== END OF NAVBAR =========== --> <HR> <i><a href="doc-files/LICENSE.TXT">Copyright</a> © 2001, Perforce Software, All rights reserved.</i> </BODY> </HTML>
# | Change | User | Description | Committed | |
---|---|---|---|---|---|
#6 | 2001 | David Markley | Updated package documentation. | ||
#5 | 1387 | David Markley |
Added the ability to reopen files, add them to changelists, and updated the documentation to reflect these changes. |
||
#4 | 1360 | David Markley | Updated Env class. | ||
#3 | 1332 | David Markley |
Added more example code. Added the Counter class. Corrected the filelog methods for the FileEntry class. |
||
#2 | 1037 | David Markley | Updated the documentation. | ||
#1 | 1020 | David Markley |
Added Perforce Java API documentation. This is generated using JavaDoc. |