<!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>
Debug (Perforce API)
</TITLE>
<META NAME="keywords" CONTENT="com.perforce.api.Debug class">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="Debug (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/Debug.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/Counter.html" title="class in com.perforce.api"><B>PREV CLASS</B></A>
<A HREF="../../../com/perforce/api/DirEntry.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/Debug.html" target="_top"><B>FRAMES</B></A>
<A HREF="Debug.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 | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: <A HREF="#field_detail">FIELD</A> | <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 Debug</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 "><B>com.perforce.api.Debug</B>
</PRE>
<HR>
<DL>
<DT><PRE>public final class <B>Debug</B><DT>extends <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></DL>
</PRE>
<P>
Utility class used for debugging. The level of debugging
determines the amount of debugging information that is generated. The
process using this class for debugging should ensure that it
<A HREF="../../../com/perforce/api/Debug.html#setDebugLevel(int)"><CODE>sets the debugging level</CODE></A>
appropriately.
<P>
<P>
<DL>
<DT><B>Version:</B></DT>
<DD>$Date: 2008/01/28 $ $Revision: #8 $</DD>
<DT><B>Author:</B></DT>
<DD><a href="mailto:david@markley.cc">David Markley</a></DD>
</DL>
<HR>
<P>
<!-- =========== FIELD SUMMARY =========== -->
<A NAME="field_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>Field Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/perforce/api/Debug.html#ERROR">ERROR</A></B></CODE>
<BR>
Only error messages are displayed.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/perforce/api/Debug.html#LOG_NONE">LOG_NONE</A></B></CODE>
<BR>
Debugging output is discarded entirely.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/perforce/api/Debug.html#LOG_ONLY">LOG_ONLY</A></B></CODE>
<BR>
Debugging output is sent only to the <A HREF="../../../com/perforce/api/EventLog.html" title="class in com.perforce.api"><CODE>EventLog</CODE></A>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/perforce/api/Debug.html#LOG_SPLIT">LOG_SPLIT</A></B></CODE>
<BR>
Debugging output is sent to standard out and to the <A HREF="../../../com/perforce/api/EventLog.html" title="class in com.perforce.api"><CODE>EventLog</CODE></A>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/perforce/api/Debug.html#NONE">NONE</A></B></CODE>
<BR>
No debug messages are displayed.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/perforce/api/Debug.html#NOTICE">NOTICE</A></B></CODE>
<BR>
Error, warning, and notice messages are displayed.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/perforce/api/Debug.html#VERBOSE">VERBOSE</A></B></CODE>
<BR>
Error, warning, notice, and verbose messages are displayed.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/perforce/api/Debug.html#WARNING">WARNING</A></B></CODE>
<BR>
Error and warning messages are displayed.</TD>
</TR>
</TABLE>
<!-- ======== 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/Debug.html#Debug()">Debug</A></B>()</CODE>
<BR>
</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 void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/perforce/api/Debug.html#error(java.lang.String)">error</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> msg)</CODE>
<BR>
Displays an error message for debugging.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/perforce/api/Debug.html#getDebugLevel()">getDebugLevel</A></B>()</CODE>
<BR>
Returns the current debug level.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static <A HREF="../../../com/perforce/api/EventLog.html" title="class in com.perforce.api">EventLog</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/perforce/api/Debug.html#getEventLog()">getEventLog</A></B>()</CODE>
<BR>
Returns the current <code>EventLog</code> in use.</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/Debug.html#getLevelName(int)">getLevelName</A></B>(int level)</CODE>
<BR>
Returns the name associated with the specified level.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/perforce/api/Debug.html#getLogLevel()">getLogLevel</A></B>()</CODE>
<BR>
Returns the current logging level.</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/Debug.html#getShowThread()">getShowThread</A></B>()</CODE>
<BR>
Returns the state of showing threads in degugging output.</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/Debug.html#notify(java.lang.String)">notify</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> msg)</CODE>
<BR>
Displays a notice message for debugging.</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/Debug.html#notify(java.lang.String, java.lang.String[])">notify</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> msg,
<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>[] arry)</CODE>
<BR>
Displays a notice message for debugging.</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/Debug.html#out(int, java.lang.String)">out</A></B>(int level,
<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> msg)</CODE>
<BR>
Writes the message to the debugging output.</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/Debug.html#out(int, java.lang.String, java.lang.String[])">out</A></B>(int level,
<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> msg,
<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>[] arry)</CODE>
<BR>
Writes the message and associated array of Strings to the debugging
output.</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/Debug.html#out(int, java.lang.Throwable)">out</A></B>(int level,
<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Throwable.html" title="class or interface in java.lang">Throwable</A> t)</CODE>
<BR>
Writes the message associated with the <code>Throwable</code> to the
debugging output.</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/Debug.html#out(java.lang.String, int, java.lang.Throwable)">out</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,
int level,
<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Throwable.html" title="class or interface in java.lang">Throwable</A> t)</CODE>
<BR>
Writes the formatted message associated with the <code>Throwable</code> to the
debugging output.</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/Debug.html#setDebugLevel(int)">setDebugLevel</A></B>(int l)</CODE>
<BR>
Sets the debug level for the application.</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/Debug.html#setEventLog(com.perforce.api.EventLog)">setEventLog</A></B>(<A HREF="../../../com/perforce/api/EventLog.html" title="class in com.perforce.api">EventLog</A> elog)</CODE>
<BR>
Sets the <code>EventLog</code> that debugging output should be sent to.</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/Debug.html#setLogLevel(int)">setLogLevel</A></B>(int log_level)</CODE>
<BR>
Sets the logging level.</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/Debug.html#setLogLevel(java.lang.String)">setLogLevel</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> level)</CODE>
<BR>
Sets the logging level.</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/Debug.html#setProperties(java.util.Properties)">setProperties</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Properties.html" title="class or interface in java.util">Properties</A> props)</CODE>
<BR>
Sets the logging level from the supplied <code>Properties</code>.</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/Debug.html#setShowThread(boolean)">setShowThread</A></B>(boolean show)</CODE>
<BR>
If set <code>true</code>, the thread number is included in all debugging
output.</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/Debug.html#verbose(java.lang.String)">verbose</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> msg)</CODE>
<BR>
Displays a verbose message for debugging.</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/Debug.html#verbose(java.lang.String, java.lang.String[])">verbose</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> msg,
<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>[] arry)</CODE>
<BR>
Displays a verbose message for debugging.</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/Debug.html#warn(java.lang.String)">warn</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> msg)</CODE>
<BR>
Displays a warning message for debugging.</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#toString()" title="class or interface in java.lang">toString</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>
<!-- ============ FIELD DETAIL =========== -->
<A NAME="field_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>Field Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="ERROR"><!-- --></A><H3>
ERROR</H3>
<PRE>
public static final int <B>ERROR</B></PRE>
<DL>
<DD>Only error messages are displayed.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#com.perforce.api.Debug.ERROR">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="LOG_NONE"><!-- --></A><H3>
LOG_NONE</H3>
<PRE>
public static final int <B>LOG_NONE</B></PRE>
<DL>
<DD>Debugging output is discarded entirely.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#com.perforce.api.Debug.LOG_NONE">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="LOG_ONLY"><!-- --></A><H3>
LOG_ONLY</H3>
<PRE>
public static final int <B>LOG_ONLY</B></PRE>
<DL>
<DD>Debugging output is sent only to the <A HREF="../../../com/perforce/api/EventLog.html" title="class in com.perforce.api"><CODE>EventLog</CODE></A>.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#com.perforce.api.Debug.LOG_ONLY">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="LOG_SPLIT"><!-- --></A><H3>
LOG_SPLIT</H3>
<PRE>
public static final int <B>LOG_SPLIT</B></PRE>
<DL>
<DD>Debugging output is sent to standard out and to the <A HREF="../../../com/perforce/api/EventLog.html" title="class in com.perforce.api"><CODE>EventLog</CODE></A>.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#com.perforce.api.Debug.LOG_SPLIT">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="NONE"><!-- --></A><H3>
NONE</H3>
<PRE>
public static final int <B>NONE</B></PRE>
<DL>
<DD>No debug messages are displayed.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#com.perforce.api.Debug.NONE">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="NOTICE"><!-- --></A><H3>
NOTICE</H3>
<PRE>
public static final int <B>NOTICE</B></PRE>
<DL>
<DD>Error, warning, and notice messages are displayed.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#com.perforce.api.Debug.NOTICE">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="VERBOSE"><!-- --></A><H3>
VERBOSE</H3>
<PRE>
public static final int <B>VERBOSE</B></PRE>
<DL>
<DD>Error, warning, notice, and verbose messages are displayed.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#com.perforce.api.Debug.VERBOSE">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="WARNING"><!-- --></A><H3>
WARNING</H3>
<PRE>
public static final int <B>WARNING</B></PRE>
<DL>
<DD>Error and warning messages are displayed.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#com.perforce.api.Debug.WARNING">Constant Field Values</A></DL>
</DL>
<!-- ========= 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="Debug()"><!-- --></A><H3>
Debug</H3>
<PRE>
public <B>Debug</B>()</PRE>
<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="error(java.lang.String)"><!-- --></A><H3>
error</H3>
<PRE>
public static void <B>error</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> msg)</PRE>
<DL>
<DD>Displays an error message for debugging. If the debugging level is
set below ERROR, then no message is displayed.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>msg</CODE> - The debugging error message.</DL>
</DD>
</DL>
<HR>
<A NAME="getDebugLevel()"><!-- --></A><H3>
getDebugLevel</H3>
<PRE>
public static int <B>getDebugLevel</B>()</PRE>
<DL>
<DD>Returns the current debug level.
<P>
<DD><DL>
<DT><B>See Also:</B><DD><A HREF="../../../com/perforce/api/Debug.html#setDebugLevel(int)"><CODE>setDebugLevel(int)</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="getEventLog()"><!-- --></A><H3>
getEventLog</H3>
<PRE>
public static <A HREF="../../../com/perforce/api/EventLog.html" title="class in com.perforce.api">EventLog</A> <B>getEventLog</B>()</PRE>
<DL>
<DD>Returns the current <code>EventLog</code> in use.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getLevelName(int)"><!-- --></A><H3>
getLevelName</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>getLevelName</B>(int level)</PRE>
<DL>
<DD>Returns the name associated with the specified level.
<P>
<DD><DL>
<DT><B>See Also:</B><DD><A HREF="../../../com/perforce/api/Debug.html#setDebugLevel(int)"><CODE>setDebugLevel(int)</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="getLogLevel()"><!-- --></A><H3>
getLogLevel</H3>
<PRE>
public static int <B>getLogLevel</B>()</PRE>
<DL>
<DD>Returns the current logging level.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getShowThread()"><!-- --></A><H3>
getShowThread</H3>
<PRE>
public static boolean <B>getShowThread</B>()</PRE>
<DL>
<DD>Returns the state of showing threads in degugging output.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="notify(java.lang.String)"><!-- --></A><H3>
notify</H3>
<PRE>
public static void <B>notify</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> msg)</PRE>
<DL>
<DD>Displays a notice message for debugging. If the debugging level is
set below NOTICE, then no message is displayed.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>msg</CODE> - The debugging notice message.</DL>
</DD>
</DL>
<HR>
<A NAME="notify(java.lang.String, java.lang.String[])"><!-- --></A><H3>
notify</H3>
<PRE>
public static void <B>notify</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> msg,
<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>[] arry)</PRE>
<DL>
<DD>Displays a notice message for debugging. If the debugging level is
set below NOTICE, then no message is displayed.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>msg</CODE> - The debugging notice message.<DD><CODE>arry</CODE> - Array containing useful debug information.</DL>
</DD>
</DL>
<HR>
<A NAME="out(int, java.lang.String)"><!-- --></A><H3>
out</H3>
<PRE>
public static void <B>out</B>(int level,
<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> msg)</PRE>
<DL>
<DD>Writes the message to the debugging output.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>level</CODE> - Debugging level to associate with the message.<DD><CODE>msg</CODE> - Debugging message.</DL>
</DD>
</DL>
<HR>
<A NAME="out(int, java.lang.String, java.lang.String[])"><!-- --></A><H3>
out</H3>
<PRE>
public static void <B>out</B>(int level,
<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> msg,
<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>[] arry)</PRE>
<DL>
<DD>Writes the message and associated array of Strings to the debugging
output. The message will be followed by all the elements in the
<code>arry</code>.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>level</CODE> - Debugging level to associate with the message.<DD><CODE>msg</CODE> - Debugging message.<DD><CODE>arry</CODE> - Array of strings to be sent to the debugging output.</DL>
</DD>
</DL>
<HR>
<A NAME="out(int, java.lang.Throwable)"><!-- --></A><H3>
out</H3>
<PRE>
public static void <B>out</B>(int level,
<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Throwable.html" title="class or interface in java.lang">Throwable</A> t)</PRE>
<DL>
<DD>Writes the message associated with the <code>Throwable</code> to the
debugging output.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>level</CODE> - Debugging level to associate with the message.<DD><CODE>t</CODE> - Throwable that contains the message.</DL>
</DD>
</DL>
<HR>
<A NAME="out(java.lang.String, int, java.lang.Throwable)"><!-- --></A><H3>
out</H3>
<PRE>
public static void <B>out</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,
int level,
<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Throwable.html" title="class or interface in java.lang">Throwable</A> t)</PRE>
<DL>
<DD>Writes the formatted message associated with the <code>Throwable</code> to the
debugging output. The message will be placed in the string generated
wherever the '{0}' attribute is placed.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>format</CODE> - Format to use for the debugging output.<DD><CODE>level</CODE> - Debugging level to associate with the message.<DD><CODE>t</CODE> - Throwable that contains the message.<DT><B>See Also:</B><DD><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/text/MessageFormat.html" title="class or interface in java.text"><CODE>MessageFormat</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="setDebugLevel(int)"><!-- --></A><H3>
setDebugLevel</H3>
<PRE>
public static void <B>setDebugLevel</B>(int l)</PRE>
<DL>
<DD>Sets the debug level for the application. If this is 0, no debug
information is generated.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>l</CODE> - The level of debugging to use.<DT><B>See Also:</B><DD><A HREF="../../../com/perforce/api/Debug.html#NONE"><CODE>NONE</CODE></A>,
<A HREF="../../../com/perforce/api/Debug.html#ERROR"><CODE>ERROR</CODE></A>,
<A HREF="../../../com/perforce/api/Debug.html#WARNING"><CODE>WARNING</CODE></A>,
<A HREF="../../../com/perforce/api/Debug.html#NOTICE"><CODE>NOTICE</CODE></A>,
<A HREF="../../../com/perforce/api/Debug.html#VERBOSE"><CODE>VERBOSE</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="setEventLog(com.perforce.api.EventLog)"><!-- --></A><H3>
setEventLog</H3>
<PRE>
public static void <B>setEventLog</B>(<A HREF="../../../com/perforce/api/EventLog.html" title="class in com.perforce.api">EventLog</A> elog)</PRE>
<DL>
<DD>Sets the <code>EventLog</code> that debugging output should be sent to.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>elog</CODE> - <code>EventLog</code> to use.</DL>
</DD>
</DL>
<HR>
<A NAME="setLogLevel(int)"><!-- --></A><H3>
setLogLevel</H3>
<PRE>
public static void <B>setLogLevel</B>(int log_level)</PRE>
<DL>
<DD>Sets the logging level. This determines where the debugging output will
be sent. Valid values are: <A HREF="../../../com/perforce/api/Debug.html#LOG_SPLIT"><CODE>LOG_SPLIT</CODE></A>,
<A HREF="../../../com/perforce/api/Debug.html#LOG_ONLY"><CODE>LOG_ONLY</CODE></A>, and <A HREF="../../../com/perforce/api/Debug.html#LOG_NONE"><CODE>LOG_NONE</CODE></A>. The default is
<A HREF="../../../com/perforce/api/Debug.html#LOG_ONLY"><CODE>LOG_ONLY</CODE></A>.
<p>
If the log level is set to <A HREF="../../../com/perforce/api/Debug.html#LOG_NONE"><CODE>LOG_NONE</CODE></A>, then the debug
level is automatically set to <A HREF="../../../com/perforce/api/Debug.html#NONE"><CODE>NONE</CODE></A>.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="setLogLevel(java.lang.String)"><!-- --></A><H3>
setLogLevel</H3>
<PRE>
public static void <B>setLogLevel</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> level)</PRE>
<DL>
<DD>Sets the logging level. This determines where the debugging output will
be sent. Valid values are "none", "only", or "split". The default is
"only". The default value will be set, if the <code>String</code> does
not match.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="setProperties(java.util.Properties)"><!-- --></A><H3>
setProperties</H3>
<PRE>
public static void <B>setProperties</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Properties.html" title="class or interface in java.util">Properties</A> props)</PRE>
<DL>
<DD>Sets the logging level from the supplied <code>Properties</code>. This
looks for the "p4.log_level" property with the value of either "none",
"split", or "only".
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="setShowThread(boolean)"><!-- --></A><H3>
setShowThread</H3>
<PRE>
public static void <B>setShowThread</B>(boolean show)</PRE>
<DL>
<DD>If set <code>true</code>, the thread number is included in all debugging
output.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="verbose(java.lang.String)"><!-- --></A><H3>
verbose</H3>
<PRE>
public static void <B>verbose</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> msg)</PRE>
<DL>
<DD>Displays a verbose message for debugging. If the debugging level is
set below VERBOSE, then no message is displayed.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>msg</CODE> - The debugging notice message.</DL>
</DD>
</DL>
<HR>
<A NAME="verbose(java.lang.String, java.lang.String[])"><!-- --></A><H3>
verbose</H3>
<PRE>
public static void <B>verbose</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> msg,
<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>[] arry)</PRE>
<DL>
<DD>Displays a verbose message for debugging. If the debugging level is
set below VERBOSE, then no message is displayed.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>msg</CODE> - The debugging notice message.<DD><CODE>arry</CODE> - Array containing useful debug information.</DL>
</DD>
</DL>
<HR>
<A NAME="warn(java.lang.String)"><!-- --></A><H3>
warn</H3>
<PRE>
public static void <B>warn</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> msg)</PRE>
<DL>
<DD>Displays a warning message for debugging. If the debugging level is
set below WARNING, then no message is displayed.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>msg</CODE> - The debugging warning message.</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/Debug.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/Counter.html" title="class in com.perforce.api"><B>PREV CLASS</B></A>
<A HREF="../../../com/perforce/api/DirEntry.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/Debug.html" target="_top"><B>FRAMES</B></A>
<A HREF="Debug.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 | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: <A HREF="#field_detail">FIELD</A> | <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 | |
|---|---|---|---|---|---|
| #9 | 8157 | michael | Archiving legacy java api projects which predate the supported P4Java api. | ||
| #8 | 6166 | Sivananda Poreddy | Fixing problem with last check related to javadoc | ||
| #7 | 6164 | Sivananda Poreddy | Updating the javadoc to include all the new changes | ||
| #6 | 6141 | Sivananda Poreddy | Updating the p4package with fixes, some new features, jar update, and doc updates | ||
| #5 | 2002 | David Markley | Integrated the latest changes for p4package to the public depot. | ||
| #4 | 1808 | David Markley |
Updated Env class and fixed fstat issues. Published new Javadocs. |
||
| #3 | 1361 | David Markley | Added convenience methods to the Env class. | ||
| #2 | 1334 | David Markley |
Added more example code. Added the Counter class. Corrected the filelog methods for the FileEntry class. |
||
| #1 | 1043 | David Markley | Initial branch to public area. | ||
| //guest/david_markley/p4package/docs/com/perforce/api/Debug.html | |||||
| #2 | 1037 | David Markley | Updated the documentation. | ||
| #1 | 1020 | David Markley |
Added Perforce Java API documentation. This is generated using JavaDoc. |
||