/*
   XBN Java:  Generically useful, non-GUI Java code.
   http://sourceforge.net/projects/xbnjava

   Copyright (C) 1997-2003, Jeff Epstein
   All rights reserved.

   Modifications: No

   Redistribution in binary form, with or without modifications, are permitted provided that the following conditions are met:

      * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
      * If modifications are made to source code then this license should indicate that fact in the "Modifications" section above.
      * Neither the author, nor the contributors may be used to endorse or promote products derived from this software without specific prior written permission.

   THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

   [NOTE:  This license contains NO advertising clause.]
 */
package xbn.output;

/**
   <P>A class implementing Debuggable has permanent, optional and configurable output.</P>

   <P><CODE><I><B>Source code:</B> &nbsp;<A HREF="../../../CODE/xbn/output/Debuggable.java">Debuggable.java</A></I></CODE></P>

   <H4>Example implementation parts</H4>

<P><CODE>&nbsp; &nbsp;//REQUIRED BY xbn.output.Outputter...START
<BR>&nbsp; &nbsp;&nbsp; &nbsp;private Outputter outPutter = new Outputter();
<BR>&nbsp; &nbsp;//REQUIRED BY xbn.output.Outputter...END
<BR>
<BR>&nbsp; &nbsp;//REQUIRED BY xbn.output.Debuggable...START
<BR>&nbsp; &nbsp;&nbsp; &nbsp;public Outputter getOptrDbg()&nbsp; {
<BR>&nbsp; &nbsp;&nbsp; &nbsp;&nbsp; &nbsp;return outPutter;
<BR>&nbsp; &nbsp;&nbsp; &nbsp;}
<BR>&nbsp; &nbsp;&nbsp; &nbsp;public void setOptrDbg(Outputter o_utputter)&nbsp; {
<BR>&nbsp; &nbsp;&nbsp; &nbsp;&nbsp; &nbsp;if(o_utputter == null)&nbsp; {
<BR>&nbsp; &nbsp;&nbsp; &nbsp;&nbsp; &nbsp;&nbsp; &nbsp;throw new AssertException(&quot;ERROR in [YOUR CLASS].setOutputter:&nbsp; o_utputter is null.&quot;);
<BR>&nbsp; &nbsp;&nbsp; &nbsp;&nbsp; &nbsp;}
<BR>&nbsp; &nbsp;&nbsp; &nbsp;&nbsp; &nbsp;outPutter = o_utputter;
<BR>&nbsp; &nbsp;&nbsp; &nbsp;}
<BR>&nbsp; &nbsp;&nbsp; &nbsp;public void dbg(String s_message)&nbsp; {
<BR>&nbsp; &nbsp;&nbsp; &nbsp;&nbsp; &nbsp;getOptrDbg().write(s_message);
<BR>&nbsp; &nbsp;&nbsp; &nbsp;}
<BR>&nbsp; &nbsp;&nbsp; &nbsp;public void dbgnl(String s_message)&nbsp; {
<BR>&nbsp; &nbsp;&nbsp; &nbsp;&nbsp; &nbsp;getOptrDbg().writeNoln(s_message);
<BR>&nbsp; &nbsp;&nbsp; &nbsp;}
<BR>&nbsp; &nbsp;//REQUIRED BY xbn.output.Debuggable...END
</CODE></P>

   @version  0.9b
   @author  Jeff Epstein, <A HREF="http://sourceforge.net/projects/xbnjava">http://sourceforge.net/projects/xbnjava</A>.
 **/
public interface Debuggable  {


   /**
      <P>Get the Outputter object for direct manipulation.</P>

      <P><CODE><I>Set with <A HREF="~JD~setOptrDbg(optr)~EJD~">setOutputter</A>.</I></CODE></P>
    **/
   Outputter getOptrDbg();

   /**
      <P>Set the Outputter object.</P>

      <P><CODE><I>Get with <A HREF="#getOptrDbg()">getOutputter</A>.</I></CODE></P>

      @param  out_putter  The Outputter object.  May not be null.
    **/
   void setOptrDbg(Outputter out_putter);

   /**
      <P>Output a line of text.</P>

      @param  s_message  The message to output.
    **/
   void dbg(String s_message);

   /**
      <P>Output a line of text without an ending newline.</P>

      @param  s_message  The message to output.
    **/
   void dbgnl(String s_message);
}