ErrorsBuffer.html revision d81978a0815d5b8a75633c35e3e1f8708d36f017
<!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.6.0_06) on Wed Jun 25 13:23:27 CEST 2008 -->
<TITLE>
ErrorsBuffer
</TITLE>
<META NAME="date" CONTENT="2008-06-25">
<SCRIPT type="text/javascript">
function windowTitle()
{
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="ErrorsBuffer";
}
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<HR>
<!-- ========= 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="/org/opends/testqa/monitoringclient/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/ErrorsBuffer.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="/deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="/index-files/index-1.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>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="/org/opends/testqa/monitoringclient/Error.html" title="class in org.opends.testqa.monitoringclient"><B>PREV CLASS</B></A>
<A HREF="/org/opends/testqa/monitoringclient/ErrorsOutputFile.html" title="class in org.opends.testqa.monitoringclient"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="/index.html?org/opends/testqa/monitoringclient/ErrorsBuffer.html" target="_top"><B>FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="/allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
</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">
<BR>
Class ErrorsBuffer</H2>
<PRE>
<IMG SRC="/resources/inherit.gif" ALT="extended by "><B>org.opends.testqa.monitoringclient.ErrorsBuffer</B>
</PRE>
<HR>
<DL>
</PRE>
<P>
Buffer to store the errors who occured
while the monitoring client is running.
<P>
<P>
<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="/org/opends/testqa/monitoringclient/ErrorsBuffer.html#ErrorsBuffer(org.opends.testqa.monitoringclient.MonitoringClient)">ErrorsBuffer</A></B>(<A HREF="/org/opends/testqa/monitoringclient/MonitoringClient.html" title="class in org.opends.testqa.monitoringclient">MonitoringClient</A> client)</CODE>
<BR>
Construct a ErrorsBuffer object.</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> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="/org/opends/testqa/monitoringclient/ErrorsBuffer.html#addError(java.lang.String, java.lang.String, java.util.Date)">addError</A></B>(java.lang.String protocol,
<BR>
Add a general error in the buffer and notify the consumers.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="/org/opends/testqa/monitoringclient/ErrorsBuffer.html#addError(java.lang.String, java.lang.String, java.lang.String)">addError</A></B>(java.lang.String protocol,
<BR>
Add an error in the buffer and notify the consumers.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="/org/opends/testqa/monitoringclient/ErrorsBuffer.html#addError(java.lang.String, java.lang.String, java.lang.String, java.util.Date)">addError</A></B>(java.lang.String protocol,
<BR>
Add an error in the buffer and notify the consumers.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="/org/opends/testqa/monitoringclient/ErrorsBuffer.html" title="class in org.opends.testqa.monitoringclient">ErrorsBuffer</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="/org/opends/testqa/monitoringclient/ErrorsBuffer.html#clone()">clone</A></B>()</CODE>
<BR>
Clone the ErrorsBuffer and clear it if all the consumers have cloned it.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="/org/opends/testqa/monitoringclient/ErrorsBuffer.html#isEmpty()">isEmpty</A></B>()</CODE>
<BR>
Test if there is at least one error in the buffer.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="/org/opends/testqa/monitoringclient/Error.html" title="class in org.opends.testqa.monitoringclient">Error</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="/org/opends/testqa/monitoringclient/ErrorsBuffer.html#removeFirstError()">removeFirstError</A></B>()</CODE>
<BR>
Return the first error in the buffer and remove it.</TD>
</TR>
</TABLE>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</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>
ErrorsBuffer</H3>
<PRE>
public <B>ErrorsBuffer</B>(<A HREF="/org/opends/testqa/monitoringclient/MonitoringClient.html" title="class in org.opends.testqa.monitoringclient">MonitoringClient</A> client)</PRE>
<DL>
<DD>Construct a ErrorsBuffer object.
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>client</CODE> - The main class of the client.</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>
addError</H3>
<PRE>
<DL>
<DD>Add a general error in the buffer and notify the consumers.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>protocol</CODE> - The name of the protocol.<DD><CODE>message</CODE> - The message of the error.<DD><CODE>date</CODE> - The date of the error.
<DT><B>Returns:</B><DD>true if the error have been add in the buffer, false otherwise.</DL>
</DD>
</DL>
<HR>
addError</H3>
<PRE>
<DL>
<DD>Add an error in the buffer and notify the consumers.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>protocol</CODE> - The name of the protocol.<DD><CODE>attribute</CODE> - The name of the attribute monitored.<DD><CODE>message</CODE> - The message of the error.
<DT><B>Returns:</B><DD>true if the error have been add in the buffer, false otherwise.</DL>
</DD>
</DL>
<HR>
<A NAME="addError(java.lang.String, java.lang.String, java.lang.String, java.util.Date)"><!-- --></A><H3>
addError</H3>
<PRE>
<DL>
<DD>Add an error in the buffer and notify the consumers.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>protocol</CODE> - The name of the protocol.<DD><CODE>attribute</CODE> - The name of the attribute monitored.<DD><CODE>message</CODE> - The message of the error.<DD><CODE>date</CODE> - The date of the error.
<DT><B>Returns:</B><DD>true if the error have been add in the buffer, false otherwise.</DL>
</DD>
</DL>
<HR>
<A NAME="isEmpty()"><!-- --></A><H3>
isEmpty</H3>
<PRE>
public boolean <B>isEmpty</B>()</PRE>
<DL>
<DD>Test if there is at least one error in the buffer.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>true if there is at least one error in the buffer, false otherwise.</DL>
</DD>
</DL>
<HR>
<A NAME="removeFirstError()"><!-- --></A><H3>
removeFirstError</H3>
<PRE>
public <A HREF="/org/opends/testqa/monitoringclient/Error.html" title="class in org.opends.testqa.monitoringclient">Error</A> <B>removeFirstError</B>()</PRE>
<DL>
<DD>Return the first error in the buffer and remove it.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>The first error in the buffer.</DL>
</DD>
</DL>
<HR>
<A NAME="clone()"><!-- --></A><H3>
clone</H3>
<PRE>
public <A HREF="/org/opends/testqa/monitoringclient/ErrorsBuffer.html" title="class in org.opends.testqa.monitoringclient">ErrorsBuffer</A> <B>clone</B>()</PRE>
<DL>
<DD>Clone the ErrorsBuffer and clear it if all the consumers have cloned it.
<P>
<DD><DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>A clone of the ErrorsBuffer.</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="/org/opends/testqa/monitoringclient/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/ErrorsBuffer.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="/deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="/index-files/index-1.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>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="/org/opends/testqa/monitoringclient/Error.html" title="class in org.opends.testqa.monitoringclient"><B>PREV CLASS</B></A>
<A HREF="/org/opends/testqa/monitoringclient/ErrorsOutputFile.html" title="class in org.opends.testqa.monitoringclient"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="/index.html?org/opends/testqa/monitoringclient/ErrorsBuffer.html" target="_top"><B>FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="/allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
</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>
</BODY>
</HTML>