/*
   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;
   import xbn.named.Named;
   import xbn.string.UtilString;

/**
   <P>Configuration for a single "level" of output, consisting of a MsgFormat and on/off state.  This is for use in <A HREF="Outputter.html">Outputter</A>.</P>

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

   <P>A OConfig contains three elements:<UL>
      <LI>A <B>MsgFormat</B> (<A HREF="MsgFormat.html">MsgFormat</A>):  The most common example is a <A HREF="MFDate.html">date-time stamp</A>.  When no MsgFormat is desired, use <A HREF="MFPlain.html">MFPlain</A>.</LI>
      <LI><B>"On/Off" state</B> (<A HREF="#setOn(boolean)">setOn</A> and <A HREF="#isOn()">isOn</A>):  Is this level on or off?  This allows you to keep debug/write statements in your code, even when you don't need to use them.</LI>
      <LI>A <B>name</B> (<A HREF="#getName()">getName</A>):  Identifier for this OConfig object, required by MLOConfig.</LI>
   </UL></P>

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

   private String sName = null;
   private MsgFormat msgFormat = null;
   private boolean bOn = false;

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

      <P>Equal to <CODE><A HREF="~JD~oc(b)~EJD~">OConfig</A>(false)</CODE></P>
    **/
   public OConfig()  {
      this(false);
   }

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

      <P>Equal to <CODE><A HREF="~JD~oc(mf,b)~EJD~">OConfig</A>((new <A HREF="MFPlain.html">MFPlain</A>()), b_on)</CODE></P>
    **/
   public OConfig(boolean b_on)  {
      this((new MFPlain()), b_on);
   }

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

      <P>Equal to <CODE><A HREF="~JD~oc(mf,b)~EJD~">OConfig</A>(msg_format, false)</CODE></P>
    **/
   public OConfig(MsgFormat msg_format)  {
      this(msg_format, false);
   }

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

      <P>Equal to <CODE><A HREF="~JD~oc(s,mf,b)~EJD~">OConfig</A>(null, msg_format, b_on)</CODE></P>
    **/
   public OConfig(MsgFormat msg_format, boolean b_on)  {
      this(null, msg_format, b_on);
   }

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

      @param  s_name  The name of this OConfig object.  See <A HREF="#getName()">getName</A>.
      @param  msg_format  The MsgFormat.  See <A HREF="~JD~setMsgFormat(mf)~EJD~">setMsgFormat</A> and <A HREF="#getMsgFormat()">getMsgFormat </A>.
      @param  b_on  If true, this output level is on.  If false, this output level is off.  See <A HREF="#setOn(boolean)">setOn</A> and <A HREF="#isOn()">isOn</A>.
    **/
   public OConfig(String s_name, MsgFormat msg_format, boolean b_on)  {
      sName = s_name;
      setMsgFormat(msg_format);
      setOn(b_on);
   }

   /**
      <P>Set the MsgFormat.</P>

      @param  msg_format  The MsgFormat.  May not be null.  If no prefix is desired, set this to <CODE>(new <A HREF="~JD~mfp#mfp()~EJD~">MFPlain</A>())</CODE>.
    **/
   public final  void setMsgFormat(MsgFormat msg_format)  {
      throwAXIfNull(msg_format, "msg_format", "setMsgFormat");
      msgFormat = msg_format;
   }

   /**
      <P>Get the MsgFormat for direct manipulation.</P>
    **/
   public MsgFormat getMsgFormat()  {
      return msgFormat;
   }

   /**
      <P>Turn this OConfig output level on or off.</P>

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

      @param  b_on  If true, then this output level is on.  If false, this output level is off.
    **/
   public final void setOn(boolean b_on)  {
      bOn = b_on;
   }

   /**
      <P>Is this OConfig output level on or off?</P>

      <P><CODE><I>Set with <A HREF="#setOn(boolean)">setOn</A>.</I></CODE></P>

      <P>This setting is only notification for external classes, it does not directly affect (nor is used by) anything in this class.</P>

      @return <B>true</B>  If this output level is on.
      <BR><B>false</B>  If this output level is off.
    **/
   public boolean isOn()  {
      return bOn;
   }

   /**
      <P>Given the provided message body, what is the full message?</P>

      @param  s_message  The body of the message.
      @return  <CODE><A HREF="#getMsgFormat()">getMsgFormat</A>().<A HREF="~JD~mf#getFormatted(b,s)~EJD~">getFormatted</A>(b_useIndent, s_message)</CODE>
    **/
   public String getFormatted(boolean b_useIndent, String s_message)  {
      return getMsgFormat().getFormatted(b_useIndent, s_message);
   }

   /**
      <P>Get some information about this OConfig object.</P>
    **/
   public String toString()  {
      return "OConfig:  " + (new UtilString()).getConditional("getName()=", sName, ", ") + "isOn()=" + isOn() + ", [" + getMsgFormat().toString() + "]";
   }


   //REQUIRED BY xbn.named.Named...START
      public String getName()  {
         return sName;
      }
   //REQUIRED BY xbn.named.Named...END
}