<!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:37 PST 2008 -->
<TITLE>
Branch (Perforce API)
</TITLE>
<META NAME="keywords" CONTENT="com.perforce.api.Branch class">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="Branch (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/Branch.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">
PREV CLASS
<A HREF="../../../com/perforce/api/Cacheable.html" title="interface 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/Branch.html" target="_top"><B>FRAMES</B></A>
<A HREF="Branch.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 Branch</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 "><A HREF="../../../com/perforce/api/Mapping.html" title="class in com.perforce.api">com.perforce.api.Mapping</A>
<IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>com.perforce.api.Branch</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>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Comparable.html" title="class or interface in java.lang">Comparable</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>public class <B>Branch</B><DT>extends <A HREF="../../../com/perforce/api/Mapping.html" title="class in com.perforce.api">Mapping</A></DL>
</PRE>
<P>
Representation of a source control branch. There are static class methods
that can be used to list
<a href="#getBranches()">all P4 branches</a> or to get
<a href="#getBranch(java.lang.String)">a particular branch</a>.
<P>
<P>
<DL>
<DT><B>Version:</B></DT>
<DD>$Date: 2008/08/06 $ $Revision: #6 $</DD>
<DT><B>Author:</B></DT>
<DD><a href="mailto:[email protected]">David Markley</a>, <a href="mailto:[email protected]">Sivananda Poreddy</a></DD>
</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/Branch.html#Branch()">Branch</A></B>()</CODE>
<BR>
Default no-argument constructor.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../com/perforce/api/Branch.html#Branch(java.lang.String)">Branch</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> name)</CODE>
<BR>
Constructor that is passed the branch name.</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 boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/perforce/api/Branch.html#canIntegrate(com.perforce.api.Env, java.lang.String, java.lang.String, java.lang.StringBuffer)">canIntegrate</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> source,
<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> target,
<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/StringBuffer.html" title="class or interface in java.lang">StringBuffer</A> sb)</CODE>
<BR>
Check for the integration feasibility on 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><A HREF="../../../com/perforce/api/Branch.html#commit()">commit</A></B>()</CODE>
<BR>
Stores this object back into Perforce, creating it if it
didn't already exist.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static <A HREF="../../../com/perforce/api/Branch.html" title="class in com.perforce.api">Branch</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/perforce/api/Branch.html#getBranch(com.perforce.api.Env, java.lang.String, boolean)">getBranch</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> name,
boolean force)</CODE>
<BR>
Returns a Branch with the specified name, or null if not found.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static <A HREF="../../../com/perforce/api/Branch.html" title="class in com.perforce.api">Branch</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/perforce/api/Branch.html#getBranch(java.lang.String)">getBranch</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> name)</CODE>
<BR>
Returns a Branch with the specified name, or null if not found.</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/Enumeration.html" title="class or interface in java.util">Enumeration</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/perforce/api/Branch.html#getBranches(com.perforce.api.Env)">getBranches</A></B>(<A HREF="../../../com/perforce/api/Env.html" title="class in com.perforce.api">Env</A> env)</CODE>
<BR>
</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/Iterator.html" title="class or interface in java.util">Iterator</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/perforce/api/Branch.html#getBranchIterator(com.perforce.api.Env)">getBranchIterator</A></B>(<A HREF="../../../com/perforce/api/Env.html" title="class in com.perforce.api">Env</A> env)</CODE>
<BR>
</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/Enumeration.html" title="class or interface in java.util">Enumeration</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/perforce/api/Branch.html#getBranchNames(com.perforce.api.Env)">getBranchNames</A></B>(<A HREF="../../../com/perforce/api/Env.html" title="class in com.perforce.api">Env</A> env)</CODE>
<BR>
Returns list of all branch names.</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/Branch.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>static <A HREF="../../../com/perforce/api/Change.html" title="class in com.perforce.api">Change</A></CODE></FONT></TD>
<TD><CODE><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" 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> source,
<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> target,
<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/StringBuffer.html" title="class or interface in java.lang">StringBuffer</A> sb,
<A HREF="../../../com/perforce/api/Change.html" title="class in com.perforce.api">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>static <A HREF="../../../com/perforce/api/Change.html" title="class in com.perforce.api">Change</A></CODE></FONT></TD>
<TD><CODE><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" title="class in com.perforce.api">Env</A> env,
<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> fents,
<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> branch,
<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/StringBuffer.html" title="class or interface in java.lang">StringBuffer</A> sb,
<A HREF="../../../com/perforce/api/Change.html" title="class in com.perforce.api">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>static <A HREF="../../../com/perforce/api/Change.html" title="class in com.perforce.api">Change</A></CODE></FONT></TD>
<TD><CODE><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" title="class in com.perforce.api">Env</A> env,
<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> fents,
<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> branch,
<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/StringBuffer.html" title="class or interface in java.lang">StringBuffer</A> sb,
<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>
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" title="class in com.perforce.api">Change</A></CODE></FONT></TD>
<TD><CODE><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/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> source,
<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/StringBuffer.html" title="class or interface in java.lang">StringBuffer</A> sb,
<A HREF="../../../com/perforce/api/Change.html" title="class in com.perforce.api">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 boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/perforce/api/Branch.html#integrated(com.perforce.api.Env, java.lang.String, java.lang.String, java.lang.StringBuffer)">integrated</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> source,
<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> target,
<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/StringBuffer.html" title="class or interface in java.lang">StringBuffer</A> sb)</CODE>
<BR>
Check for the integration history on the named branch.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/perforce/api/Branch.html#loadBranches()">loadBranches</A></B>()</CODE>
<BR>
Loads the list of branches using the default environment.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/perforce/api/Branch.html#loadBranches(com.perforce.api.Env)">loadBranches</A></B>(<A HREF="../../../com/perforce/api/Env.html" title="class in com.perforce.api">Env</A> env)</CODE>
<BR>
Loads a list of all the branches into an internal class HashDecay.</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/Enumeration.html" title="class or interface in java.util">Enumeration</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/perforce/api/Branch.html#lookupBranches(java.lang.String)">lookupBranches</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> prefix)</CODE>
<BR>
Returns a list of branches that begin with the specified prefix.</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/Branch.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><A HREF="../../../com/perforce/api/Branch.html#sync(java.lang.String)">sync</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> name)</CODE>
<BR>
Synchronizes the Branch with the latest information from P4.</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/Branch.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.Mapping"><!-- --></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/Mapping.html" title="class in com.perforce.api">Mapping</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../com/perforce/api/Mapping.html#addView(java.lang.String)">addView</A>, <A HREF="../../../com/perforce/api/Mapping.html#addView(java.lang.String, java.lang.String)">addView</A>, <A HREF="../../../com/perforce/api/Mapping.html#compareTo(java.lang.Object)">compareTo</A>, <A HREF="../../../com/perforce/api/Mapping.html#getDescription()">getDescription</A>, <A HREF="../../../com/perforce/api/Mapping.html#getName()">getName</A>, <A HREF="../../../com/perforce/api/Mapping.html#getOwner()">getOwner</A>, <A HREF="../../../com/perforce/api/Mapping.html#getView()">getView</A>, <A HREF="../../../com/perforce/api/Mapping.html#getViews()">getViews</A>, <A HREF="../../../com/perforce/api/Mapping.html#lookupMappings(com.perforce.api.HashDecay, java.lang.String)">lookupMappings</A>, <A HREF="../../../com/perforce/api/Mapping.html#setDescription(java.lang.String)">setDescription</A>, <A HREF="../../../com/perforce/api/Mapping.html#setName(java.lang.String)">setName</A>, <A HREF="../../../com/perforce/api/Mapping.html#setOwner(java.lang.String)">setOwner</A>, <A HREF="../../../com/perforce/api/Mapping.html#toString()">toString</A></CODE></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="Branch()"><!-- --></A><H3>
Branch</H3>
<PRE>
public <B>Branch</B>()</PRE>
<DL>
<DD>Default no-argument constructor.
<P>
</DL>
<HR>
<A NAME="Branch(java.lang.String)"><!-- --></A><H3>
Branch</H3>
<PRE>
public <B>Branch</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> name)</PRE>
<DL>
<DD>Constructor that is passed the branch name.
<P>
</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="canIntegrate(com.perforce.api.Env, java.lang.String, java.lang.String, java.lang.StringBuffer)"><!-- --></A><H3>
canIntegrate</H3>
<PRE>
public static boolean <B>canIntegrate</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> source,
<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> target,
<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/StringBuffer.html" title="class or interface in java.lang">StringBuffer</A> sb)
throws <A HREF="../../../com/perforce/api/PerforceException.html" title="class in com.perforce.api">PerforceException</A></PRE>
<DL>
<DD>Check for the integration feasibility on the named branch.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>env</CODE> - environment to use when working with P4.<DD><CODE>source</CODE> - source files to integrate from.<DD><CODE>target</CODE> - target path to integrate the file to<DD><CODE>sb</CODE> - buffer that will contain a log of the integration.
<DT><B>Returns:</B><DD>boolean to indicate the integration done or not
<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>()
throws <A HREF="../../../com/perforce/api/CommitException.html" title="class in com.perforce.api">CommitException</A></PRE>
<DL>
<DD><B>Description copied from class: <CODE><A HREF="../../../com/perforce/api/SourceControlObject.html#commit()">SourceControlObject</A></CODE></B></DD>
<DD>Stores this object back into Perforce, creating it if it
didn't already exist.
<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/Mapping.html#commit()">commit</A></CODE> in class <CODE><A HREF="../../../com/perforce/api/Mapping.html" title="class in com.perforce.api">Mapping</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../com/perforce/api/CommitException.html" title="class in com.perforce.api">CommitException</A></CODE></DL>
</DD>
</DL>
<HR>
<A NAME="getBranch(com.perforce.api.Env, java.lang.String, boolean)"><!-- --></A><H3>
getBranch</H3>
<PRE>
public static <A HREF="../../../com/perforce/api/Branch.html" title="class in com.perforce.api">Branch</A> <B>getBranch</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> name,
boolean force)</PRE>
<DL>
<DD>Returns a Branch with the specified name, or null if not found.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>env</CODE> - Environment to use when working with P4.<DD><CODE>name</CODE> - Name of the branch to find.<DD><CODE>force</CODE> - Indicates that the Branch should be sync'd.</DL>
</DD>
</DL>
<HR>
<A NAME="getBranch(java.lang.String)"><!-- --></A><H3>
getBranch</H3>
<PRE>
public static <A HREF="../../../com/perforce/api/Branch.html" title="class in com.perforce.api">Branch</A> <B>getBranch</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> name)</PRE>
<DL>
<DD>Returns a Branch with the specified name, or null if not found.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - Name of the branch to find.</DL>
</DD>
</DL>
<HR>
<A NAME="getBranches(com.perforce.api.Env)"><!-- --></A><H3>
getBranches</H3>
<PRE>
public static <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> <B>getBranches</B>(<A HREF="../../../com/perforce/api/Env.html" title="class in com.perforce.api">Env</A> env)</PRE>
<DL>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>env</CODE> - Source control environment.
<DT><B>Returns:</B><DD><code>Enumeration</code> of <code>Branch</code>es.</DL>
</DD>
</DL>
<HR>
<A NAME="getBranchIterator(com.perforce.api.Env)"><!-- --></A><H3>
getBranchIterator</H3>
<PRE>
public static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Iterator.html" title="class or interface in java.util">Iterator</A> <B>getBranchIterator</B>(<A HREF="../../../com/perforce/api/Env.html" title="class in com.perforce.api">Env</A> env)</PRE>
<DL>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>env</CODE> - Source control environment.
<DT><B>Returns:</B><DD><code>Iterator</code> of <code>Branch</code>es.</DL>
</DD>
</DL>
<HR>
<A NAME="getBranchNames(com.perforce.api.Env)"><!-- --></A><H3>
getBranchNames</H3>
<PRE>
public static <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> <B>getBranchNames</B>(<A HREF="../../../com/perforce/api/Env.html" title="class in com.perforce.api">Env</A> env)</PRE>
<DL>
<DD>Returns list of all branch names.
<P>
<DD><DL>
<DT><B>Returns:</B><DD><code>Enumeration</code> of <code>String</code>s containing branch names.</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="integrate(com.perforce.api.Env, java.lang.String, java.lang.String, java.lang.StringBuffer, com.perforce.api.Change)"><!-- --></A><H3>
integrate</H3>
<PRE>
public static <A HREF="../../../com/perforce/api/Change.html" title="class in com.perforce.api">Change</A> <B>integrate</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> source,
<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> target,
<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/StringBuffer.html" title="class or interface in java.lang">StringBuffer</A> sb,
<A HREF="../../../com/perforce/api/Change.html" title="class in com.perforce.api">Change</A> c)
throws <A HREF="../../../com/perforce/api/PerforceException.html" title="class in com.perforce.api">PerforceException</A></PRE>
<DL>
<DD>Integrate a set of files using the named branch. Uses the Change passed
in to contain the integraed files. The change will be *PENDING* after this
completes.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>env</CODE> - environment to use when working with P4.<DD><CODE>source</CODE> - source files to integrate from.<DD><CODE>target</CODE> - target path to integrate the file to<DD><CODE>sb</CODE> - buffer that will contain a log of the integration.<DD><CODE>c</CODE> - Change to be used to contain the integrated files.
<DT><B>Returns:</B><DD>Change containing the files integrated.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../com/perforce/api/PerforceException.html" title="class in com.perforce.api">PerforceException</A></CODE><DT><B>See Also:</B><DD><A HREF="../../../com/perforce/api/Change.html" title="class in com.perforce.api"><CODE>Change</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="integrate(com.perforce.api.Env, java.util.Vector, java.lang.String, java.lang.StringBuffer, com.perforce.api.Change)"><!-- --></A><H3>
integrate</H3>
<PRE>
public static <A HREF="../../../com/perforce/api/Change.html" title="class in com.perforce.api">Change</A> <B>integrate</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/Vector.html" title="class or interface in java.util">Vector</A> fents,
<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> branch,
<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/StringBuffer.html" title="class or interface in java.lang">StringBuffer</A> sb,
<A HREF="../../../com/perforce/api/Change.html" title="class in com.perforce.api">Change</A> c)
throws <A HREF="../../../com/perforce/api/PerforceException.html" title="class in com.perforce.api">PerforceException</A></PRE>
<DL>
<DD>Integrate a set of files using the named branch. Uses the Change passed
in to contain the integraed files. The change will be *PENDING* after this
completes.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>env</CODE> - environment to use when working with P4.<DD><CODE>fents</CODE> - list of FileEntries to be integrated.<DD><CODE>branch</CODE> - name of the branch to integrate with.<DD><CODE>sb</CODE> - buffer that will contain a log of the integration.<DD><CODE>c</CODE> - Change to be used to contain the integrated files.
<DT><B>Returns:</B><DD>Change containing the files integrated.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../com/perforce/api/PerforceException.html" title="class in com.perforce.api">PerforceException</A></CODE><DT><B>See Also:</B><DD><A HREF="../../../com/perforce/api/Change.html" title="class in com.perforce.api"><CODE>Change</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="integrate(com.perforce.api.Env, java.util.Vector, java.lang.String, java.lang.StringBuffer, java.lang.String)"><!-- --></A><H3>
integrate</H3>
<PRE>
public static <A HREF="../../../com/perforce/api/Change.html" title="class in com.perforce.api">Change</A> <B>integrate</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/Vector.html" title="class or interface in java.util">Vector</A> fents,
<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> branch,
<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/StringBuffer.html" title="class or interface in java.lang">StringBuffer</A> sb,
<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/CommitException.html" title="class in com.perforce.api">CommitException</A>,
<A HREF="../../../com/perforce/api/PerforceException.html" title="class in com.perforce.api">PerforceException</A></PRE>
<DL>
<DD>Integrate a set of files using the named branch. Creates a Change that
contains the integraed files. The change will be *PENDING* after this
completes.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>env</CODE> - environment to use when working with P4.<DD><CODE>fents</CODE> - list of FileEntries to be integrated.<DD><CODE>branch</CODE> - name of the branch to integrate with.<DD><CODE>sb</CODE> - buffer that will contain a log of the integration.<DD><CODE>description</CODE> - description to be used for the Change created.
<DT><B>Returns:</B><DD>Change containing the files integrated.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../com/perforce/api/CommitException.html" title="class in com.perforce.api">CommitException</A></CODE>
<DD><CODE><A HREF="../../../com/perforce/api/PerforceException.html" title="class in com.perforce.api">PerforceException</A></CODE><DT><B>See Also:</B><DD><A HREF="../../../com/perforce/api/Change.html" title="class in com.perforce.api"><CODE>Change</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="integrate(java.lang.String, java.lang.StringBuffer, com.perforce.api.Change)"><!-- --></A><H3>
integrate</H3>
<PRE>
public <A HREF="../../../com/perforce/api/Change.html" title="class in com.perforce.api">Change</A> <B>integrate</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> source,
<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/StringBuffer.html" title="class or interface in java.lang">StringBuffer</A> sb,
<A HREF="../../../com/perforce/api/Change.html" title="class in com.perforce.api">Change</A> c)
throws <A HREF="../../../com/perforce/api/PerforceException.html" title="class in com.perforce.api">PerforceException</A></PRE>
<DL>
<DD>Class method for integrating using the instantiated Branch.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>source</CODE> - source files to integrate from.<DD><CODE>sb</CODE> - buffer that will contain a log of the integration.<DD><CODE>c</CODE> - Change to be used to contain the integrated files.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../com/perforce/api/PerforceException.html" title="class in com.perforce.api">PerforceException</A></CODE><DT><B>See Also:</B><DD><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)"><CODE>integrate(Env,String,String,StringBuffer,Change)</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="integrated(com.perforce.api.Env, java.lang.String, java.lang.String, java.lang.StringBuffer)"><!-- --></A><H3>
integrated</H3>
<PRE>
public static boolean <B>integrated</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> source,
<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> target,
<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/StringBuffer.html" title="class or interface in java.lang">StringBuffer</A> sb)
throws <A HREF="../../../com/perforce/api/PerforceException.html" title="class in com.perforce.api">PerforceException</A></PRE>
<DL>
<DD>Check for the integration history on the named branch.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>env</CODE> - environment to use when working with P4.<DD><CODE>source</CODE> - source files to integrate from.<DD><CODE>target</CODE> - target path to integrate the file to<DD><CODE>sb</CODE> - buffer that will contain a log of the integration.
<DT><B>Returns:</B><DD>boolean to indicate the integration done or not
<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="loadBranches()"><!-- --></A><H3>
loadBranches</H3>
<PRE>
public static void <B>loadBranches</B>()</PRE>
<DL>
<DD>Loads the list of branches using the default environment.
<P>
<DD><DL>
<DT><B>See Also:</B><DD><A HREF="../../../com/perforce/api/Env.html" title="class in com.perforce.api"><CODE>Env</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="loadBranches(com.perforce.api.Env)"><!-- --></A><H3>
loadBranches</H3>
<PRE>
public static void <B>loadBranches</B>(<A HREF="../../../com/perforce/api/Env.html" title="class in com.perforce.api">Env</A> env)</PRE>
<DL>
<DD>Loads a list of all the branches into an internal class HashDecay. This
method will only be called by the class itself if the HashDecay is
empty. Users should call this method if they believe the p4 branch
information needs to be brought up to date.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>env</CODE> - Environment to use when working with P4<DT><B>See Also:</B><DD><A HREF="../../../com/perforce/api/HashDecay.html" title="class in com.perforce.api"><CODE>HashDecay</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="lookupBranches(java.lang.String)"><!-- --></A><H3>
lookupBranches</H3>
<PRE>
public static <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> <B>lookupBranches</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> prefix)</PRE>
<DL>
<DD>Returns a list of branches that begin with the specified prefix.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>prefix</CODE> - Prefix for all branches to be returned
<DT><B>Returns:</B><DD>List of branches matching the prefix.</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="sync(java.lang.String)"><!-- --></A><H3>
sync</H3>
<PRE>
public void <B>sync</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> name)</PRE>
<DL>
<DD>Synchronizes the Branch with the latest information from P4. This method
forces the Branch to contain the latest, correct information if it didn't
already.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../com/perforce/api/Mapping.html#sync(java.lang.String)">sync</A></CODE> in class <CODE><A HREF="../../../com/perforce/api/Mapping.html" title="class in com.perforce.api">Mapping</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - Name of the Branch to synchronize.</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>Overrides:</B><DD><CODE><A HREF="../../../com/perforce/api/Mapping.html#toXML()">toXML</A></CODE> in class <CODE><A HREF="../../../com/perforce/api/Mapping.html" title="class in com.perforce.api">Mapping</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/Branch.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">
PREV CLASS
<A HREF="../../../com/perforce/api/Cacheable.html" title="interface 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/Branch.html" target="_top"><B>FRAMES</B></A>
<A HREF="Branch.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 | |
|---|---|---|---|---|---|
| #6 | 6430 | Sivananda Poreddy | Change the references to email, fix obsolete/redundant information | ||
| #5 | 6165 | Sivananda Poreddy | Fixing problem with the last checkin | ||
| #4 | 6163 | Sivananda Poreddy | Updating javadoc to include all the new changes | ||
| #3 | 6009 | Sivananda Poreddy | Fixing up javadoc problem during checkin | ||
| #2 | 5995 | Sivananda Poreddy | Checkin the updated files for javadoc | ||
| #1 | 5992 | Sivananda Poreddy | Creating my own branch from original base | ||
| //public/perforce/api/java/p4package/docs/com/perforce/api/Branch.html | |||||
| #6 | 2002 | David Markley | Integrated the latest changes for p4package to the public depot. | ||
| #5 | 1808 | David Markley |
Updated Env class and fixed fstat issues. Published new Javadocs. |
||
| #4 | 1361 | David Markley | Added convenience methods to the Env class. | ||
| #3 | 1334 | David Markley |
Added more example code. Added the Counter class. Corrected the filelog methods for the FileEntry class. |
||
| #2 | 1149 | David Markley | Added more documentation, a few examples, a cleanUp method, and a server timeout threshold. | ||
| #1 | 1043 | David Markley | Initial branch to public area. | ||
| //guest/david_markley/p4package/docs/com/perforce/api/Branch.html | |||||
| #3 | 1037 | David Markley | Updated the documentation. | ||
| #2 | 1021 | David Markley |
Corrected spelling of deprecated in the source. Added <pre> tag around license information. |
||
| #1 | 1020 | David Markley |
Added Perforce Java API documentation. This is generated using JavaDoc. |
||