/*
   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;
   import xbn.XBNObject;

/**
   <P>Represents the "destination" where output should go.  For example, you could send output to <A HREF="OWSysDotOut.html">STDOUT</A>, <A HREF="OWFile.html">file</A> or even <A HREF="OWEmpty.html">nowhere</A>.  This class must be extended to do something.</P>


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

   @version  0.9b
   @author  Jeff Epstein, <A HREF="http://sourceforge.net/projects/xbnjava">http://sourceforge.net/projects/xbnjava</A>.
 **/
public abstract class OWriter extends XBNObject  {

   /**
      <P>Output a line of text to the destination, with a newline added to the end.</P>

      <P>See <A HREF="~JD~writeNoln(s)~EJD~">writeNoln</A> and <A HREF="#newln()">newln</A>.</P>

      @param  s_message  The message to output.
    **/
   public abstract void write(String s_message);

   /**
      <P>Output a line of text to the destination.  No newline is added.</P>

      <P>See <A HREF="~JD~write(s)~EJD~">write</A> and <A HREF="#newln()">newln</A>.</P>

      @param  s_message  The message to output.
    **/
   public abstract void writeNoln(String s_message);

   /**
      <P>Output a newline only to the destination.</P>

      <P>See <A HREF="~JD~write(s)~EJD~">write</A> and <A HREF="~JD~writeNoln(s)~EJD~">writeNoln</A>.</P>
    **/
   public abstract void newln();

   /**
      <P>Does this OWriter actually write output somewhere?</P>

      <P>If your OWriter does not write output at any time, you must override this function and return false, when applicable.</P>

      <P><I>Note:  <CODE>OWriter.isActive</CODE>'s version of isActive returns <B>true</B>.</I></P>

      @return  <B>true</B> If this OWriter's <A HREF="~JD~write(s)~EJD~">write</A>, <A HREF="~JD~writeNoln(s)~EJD~">writeNoln</A> and <A HREF="#newln()">newln</A> functions actually output somewhere currently.
      <BR><B>false</B>  If the write, writeNoln and newln functions are not outputting anything currently.
    **/
   public boolean isActive()  {
      return true;
   }
}