/*
   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>An OWFile where the destination is System.out, <I>and</I> optionally to file.  This is primarily used in xbn.unittest.UTRunner.</P>

   <P><CODE><I><B>Source code:</B> &nbsp;<A HREF="../../../CODE/xbn/output/OWSDOAndFile.java">OWSDOAndFile.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 class OWSDOAndFile extends OWFile  {


   /**
      <P>Create an OWSDOAndFile that only prints via System.out.</P>

      <P>Equal to <CODE><A HREF="~JD~owf#owf()~EJD~">OWFile</A>()</CODE></P>
    **/
   public OWSDOAndFile()  {
      super();
   }


   /**
      <P>Create an OWSDOAndFile.</P>

      <P>Equal to <CODE><A HREF="~JD~owf#owf(s)~EJD~">OWFile</A>(s_fileName)</CODE></P>
    **/
   public OWSDOAndFile(String s_fileName)  {
      super(s_fileName);
   }


   /**
      <P>Create an OWSDOAndFile.</P>

      <P>Equal to <CODE><A HREF="~JD~owf#owf(s,b)~EJD~">OWFile</A>(s_fileName, b_append)</CODE></P>
    **/
   public OWSDOAndFile(String s_fileName, boolean b_append)  {
      super(s_fileName, b_append);
   }

   /**
      <P>Write a line of output to to both standard out and file.</P>

      <P>Equal to <CODE><A HREF="~JD~write(b,b,s)~EJD~">write(true, true, s_message)</A></CODE></P>
    **/
   public void write(String s_message)  {
      write(true, true, s_message);
   }

   /**
      <P>Write a line of output to to both standard out and file.</P>

      <P>Output is written to file (via <A HREF="OWFile.html">OWFile</A>.<A HREF="~JD~owf#write(s)~EJD~">write</A>) only when <A HREF="~JD~ow~EJD~#isActive()">isActive</A> equals true.</P>

      @param  b_sdo  If true, then write this message to <CODE>System.out</CODE>.  If false, don't.
      @param  b_file  If true, then write this message to file (assuming the file is active).  If false, don't.
      @param  s_message  The message to write.
    **/
   public void write(boolean b_sdo, boolean b_file, String s_message)  {
      if(b_sdo)  {
         sopl(s_message);
      }

      if(b_file  &&  isActive())  {
         super.write(s_message);
      }
   }

   /**
      <P>Write a line of output to to both standard out and file.</P>

      <P>Equal to <CODE><A HREF="~JD~writeNoln(b,b,s)~EJD~">writeNoln(true, true, s_message)</A></CODE></P>
    **/
   public void writeNoln(String s_message)  {
      writeNoln(true, true, s_message);
   }

   /**
      <P>Write a line of output (with no ending line break) to to both standard out and file.</P>

      <P>Output is written to file (via <A HREF="OWFile.html">OWFile</A>.<A HREF="~JD~owf#writeNoln(s)~EJD~">writeNoln</A>) only when <A HREF="~JD~ow~EJD~#isActive()">isActive</A> equals true.</P>

      @param  b_sdo  If true, then write this message to <CODE>System.out</CODE>.  If false, don't.
      @param  b_file  If true, then write this message to file (assuming the file is active).  If false, don't.
      @param  s_message  The message to write.
    **/
   public void writeNoln(boolean b_sdo, boolean b_file, String s_message)  {
      if(b_sdo)  {
         sop(s_message);
      }

      if(b_file  &&  isActive())  {
         super.writeNoln(s_message);
      }
   }

   /**
      <P>Write a newline only, to both standard out and file.</P>

      <P>Output is written to file (via <A HREF="OWFile.html">OWFile</A>.<A HREF="~JD~owf~EJD~#newln()">newln</A>) only when <A HREF="~JD~ow~EJD~#isActive()">isActive</A> equals true.</P>
    **/
   public void newln()  {
      sopl();
      if(isActive())  {
         super.newln();
      }
   }
}