/*
   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 java.text.SimpleDateFormat;
   import java.util.Date;

/**
   <P>A MsgFormat that precedes every line of output with a date-time stamp.</P>

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

   <h4>Example</h4>

   Create a date-time stamp with two spaces at the end, and configure it to the Eastern Standard time zone.  Then feed the SimpleDateFormat object into this class, for subseqent use in <A HREF="OConfig.html">OConfig</A>.

<PRE>SimpleDateFormat sdf = (new SimpleDateFormat("MM-dd-yyyy HH:mm:ss  "));
sdf.setTimeZone(TimeZone.getTimeZone(&quot;EST&quot;));
MFDate MFDate = new MFDate(sdf);</PRE>

   For further information, see Sun's documentation for java.text.<A HREF="~JD~sdf~EJD~">SimpleDateFormat</A> and java.text.<A HREF="~JD~tz~EJD~">TimeZone</A>.


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

   private SimpleDateFormat sdf = null;
   private boolean bIndentAfterDate = false;

   /**
      <P>Create a MFDate with the default SimpleDateFormat.</P>

      <P>Equal to <CODE><A HREF="~JD~mfd(sdf)~EJD~">MFPlain</A>(new SimpleDateFormat("MM-dd-yyyy HH:mm:ss  "))</CODE></P>
    **/
   public MFDate()  {
      this(new SimpleDateFormat("MM-dd-yyyy HH:mm:ss  "));
   }

   /**
      <P>Create a MFDate.</P>

      <P>Equal to <CODE><A HREF="~JD~mfd(sdf,s)~EJD~">MFPlain</A>(sd_format, null)</CODE></P>
    **/
   public MFDate(SimpleDateFormat sd_format)  {
      this(sd_format, null, true);
   }

   /**
      <P>Create a MFDate.</P>

      <P>Equal to <CODE><A HREF="~JD~mfd(sdf,s,b)~EJD~">MFPlain</A>(sd_format, s_indent, true)</CODE></P>
    **/
   public MFDate(SimpleDateFormat sd_format, String s_indent)  {
      this(sd_format, s_indent, true);
   }

   /**
      <P>Create a MFDate.</P>

      @param  sd_format  The <A HREF="~JD~sdf~EJD~">SimpleDateFormat</A> object.  See the documentation at the top of this page for an example.  May not be null.
      @param  s_indent  Passed directly to <A HREF="MsgFormat.html">MsgFormat</A> <A HREF="~JD~mf#mf(s)~EJD~">constructor</A>.
      @param  b_indentAfterDate  Should the indent text be put before or after the date stamp?  It looks cooler when after.
    **/
   public MFDate(SimpleDateFormat sd_format, String s_indent, boolean b_indentAfterDate)  {
      super(s_indent);

      if(sd_format == null)  {
         throw new NullPointerException("ERROR in MFDate.constructor:  'sd_format' is null.");
      }

      sdf = sd_format;

      setIndentAfterDate(b_indentAfterDate);
   }

   /**
      <P>Get the formatted message.</P>

      @return  If both b_useIndent and <A HREF="~JD~mf~EJD~#hasIndent()">hasIndent</A> equal true and <A HREF="#isIndentAfterDate()">isIndentAfterDate</A> equals...<UL>
         <LI><B>true:</B>  Return <CODE><A HREF="#getDateStamp()">getDateStamp</A>() + <A HREF="~JD~mf~EJD~#getIndent()">getIndent</A>() + s_message</CODE></LI>
         <LI><B>false:</B>  Return <CODE>getIndent() + getDateStamp() + s_message</CODE></LI>
      </UL>
      <BR>Otherwise:  Return <CODE>getDateStamp() + s_message</CODE>
    **/
   public String getFormatted(boolean b_useIndent, String s_message)  {
      if(b_useIndent  &&  hasIndent())  {
         if(isIndentAfterDate())  {
            return getDateStamp() + getIndent() + s_message;

         }  else  {
            return getIndent() + getDateStamp() + s_message;

         }
      }
      //There is no indent.

      return getDateStamp() + s_message;
   }

   /**
      <P>Declare if the indent should go after the date stamp, or before.</P>

      @param  b_indentAfterDate  If true, then the indent text (if <A HREF="~JD~mf~EJD~#hasIndent()">hasIndent</A> equals true) will be printed after the date stamp.  If false, the indent text will be printed before the date stamp.
    **/
   public final void setIndentAfterDate(boolean b_indentAfterDate)  {
      bIndentAfterDate = b_indentAfterDate;
   }

   /**
      <P>Will the indent be printed after or before the date stamp?</P>

      @return  <B>true</B>  If the indent text (only when <A HREF="~JD~mf~EJD~#hasIndent()">hasIndent</A> equals true) will be printed after the date stamp.
      <BR><B>false</B>  If the indent text will be printed before the date stamp.
    **/
   public boolean isIndentAfterDate()  {
      return bIndentAfterDate;
   }

   /**
      <P>Get the date prefix as a string.</P>

      @return <CODE><A HREF="#getSimpleDateFormat()">getSimpleDateFormat</A>().<A HREF="~JD~dtfmt#format(jud)~EJD~">format</A>(new <A HREF="~JD~jud~EJD~">Date</A>())</CODE></P>
    **/
   public String getDateStamp()  {
      return getSimpleDateFormat().format(new Date());
   }

   /**
      <P>Get the SimpleDateFormat for direct manipulation.</P>
    **/
   public SimpleDateFormat getSimpleDateFormat()  {
      return sdf;
   }
}