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

/**
   <P>Configuration for a ListAOS.</P>

   <P><CODE><I><B>Source code:</B> &nbsp;<A HREF="../../../../CODE/xbn/array/primitive/LPAConfig.java">LPAConfig.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 LPAConfig extends XBNObject  {
   private String sPrefix = null;
   private String sDivider = null;
   private String sPostfix = null;
   private String sIfNull = null;
   private String sIfEmpty = null;
   private boolean bMakeVisible = false;


   /**
      <P>Create an LPAConfig with default settings.</P>

      <P>Equal to <CODE><A HREF="~JD~lpac(s,s)~EJD~">LPAConfig</A>("'", "'")</CODE></P>
    **/
   public LPAConfig()  {
      this("'", "'");
   }
   /**
      <P>Create an LPAConfig.</P>

      <P>Equal to <CODE><A HREF="~JD~lpac(s,s,s)~EJD~">LPAConfig</A>(null, s_divider, null)</CODE></P>
    **/
   public LPAConfig(String s_divider)  {
      this(null, s_divider, null);
   }

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

      <P>Equal to <CODE><A HREF="~JD~lpac(s,s,b)~EJD~">LPAConfig</A>(s_prefix, s_postfix, false)</CODE></P>
    **/
   public LPAConfig(String s_prefix, String s_postfix)  {
      this(s_prefix, s_postfix, false);
   }

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

      <P>Equal to <CODE><A HREF="~JD~lpac(s,s,s,b)~EJD~">LPAConfig</A>(s_prefix, s_divider, s_postfix, false)</CODE></P>
    **/
   public LPAConfig(String s_prefix, String s_divider, String s_postfix)  {
      this(s_prefix, s_divider, s_postfix, false);
   }

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

      <P>Equal to <CODE><A HREF="~JD~lpac(s,s,b)~EJD~">LPAConfig</A>(null, null, b_makeVisible)</CODE></P>
    **/
   public LPAConfig(boolean b_makeVisible)  {
      this(null, null, b_makeVisible);
   }

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

      <P>Equal to <CODE><A HREF="~JD~lpac(s,s,s,b)~EJD~">LPAConfig</A>(null, s_divider, null, b_makeVisible)</CODE></P>
    **/
   public LPAConfig(String s_divider, boolean b_makeVisible)  {
      this(null, s_divider, null, b_makeVisible);
   }

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

      <P>Equal to <CODE><A HREF="~JD~lpac(s,s,s,b)~EJD~">LPAConfig</A>(s_prefix, ", ", s_postfix, b_makeVisible)</CODE></P>
    **/
   public LPAConfig(String s_prefix, String s_postfix, boolean b_makeVisible)  {
      this(s_prefix, ", ", s_postfix, b_makeVisible);
   }

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

      <P>Equal to <CODE><A HREF="~JD~lpac(s,s,s,s,s,b)~EJD~">LPAConfig</A>(s_prefix, s_divider, s_postfix, null, "__ZERO_ELEMENTS__", b_makeVisible)</CODE></P>
    **/
   public LPAConfig(String s_prefix, String s_divider, String s_postfix, boolean b_makeVisible)  {
      this(s_prefix, s_divider, s_postfix, null, "__ZERO_ELEMENTS__", b_makeVisible);
   }

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

      <P>Equal to <CODE><A HREF="~JD~lpac(s,s,s,s,s)~EJD~">LPAConfig</A>(s_prefix, s_divider, s_postfix, s_ifNull, "__ZERO_ELEMENTS__")</CODE></P>
    **/
   public LPAConfig(String s_prefix, String s_divider, String s_postfix, String s_ifNull)  {
      this(s_prefix, s_divider, s_postfix, s_ifNull, "__ZERO_ELEMENTS__");
   }

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

      <P>Equal to <CODE><A HREF="~JD~lpac(s,s,s,s,s,b)~EJD~">LPAConfig</A>(s_prefix, s_divider, s_postfix, s_ifNull, s_ifEmpty, false)</CODE></P>
    **/
   public LPAConfig(String s_prefix, String s_divider, String s_postfix, String s_ifNull, String s_ifEmpty)  {
      this(s_prefix, s_divider, s_postfix, s_ifNull, s_ifEmpty, false);
   }




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

      <P>Regarding s_prefix and s_postfix:  If you do not want any value for the prefix or postfix, set it to null.  You could set it to empty string, but null is quicker (with null, you do nothing...with empty string, you actually concatenate empty string onto the returned value).</P>

      @param  s_prefix  What the (whole) returned string should start with.  See <A HREF="#getPrefix()">getPrefix</A>.
      @param  s_divider  What should go between each item.  (This is the only item that) may not be null.  See <A HREF="#getDivider()">getDivider</A>.
      @param  s_postfix  What the (whole) returned string should end with.  See <A HREF="#getPostfix()">getPostfix</A>.
      @param  s_ifNull  If the array of objects to list is null (as a whole), this is the string returned.  See <A HREF="#getIfNull()">getIfNull</A>.
      @param  s_ifEmpty  If the array of objects to list has no elements, this is the string returned.  See <A HREF="#getIfEmpty()">getIfEmpty</A>.
      @param  b_makeVisible  If true, then all items are <A HREF="~JD~utilsob#makeVisible(sob)~EJD~">made visible</A> before being listed.  See <A HREF="#doMakeVisible()">doMakeVisible</A>.
    **/
   public LPAConfig(String s_prefix, String s_divider, String s_postfix, String s_ifNull, String s_ifEmpty, boolean b_makeVisible)  {
      throwAXIfNull(s_divider, "s_divider", sCNSTR);
      sPrefix = s_prefix;
      sDivider = s_divider;
      sPostfix = s_postfix;
      sIfNull = s_ifNull;
      sIfEmpty = s_ifEmpty;
      bMakeVisible = b_makeVisible;
   }

   /**
      <P>Get the string that should precede the entire list.</P>

      @return  <B>s_prefix</B>  Exactly as provided to the <A HREF="~JD~lpac(s,s,s,s,s,b)~EJD~">constructor</A>.
    **/
   public final String getPrefix()  {
      return sPrefix;
   }

   /**
      <P>Get the string that should go between each item in the list.</P>

      @return  <B>s_divider</B>  Exactly as provided to the <A HREF="~JD~lpac(s,s,s,s,s,b)~EJD~">constructor</A>.
    **/
   public final String getDivider()  {
      return sDivider;
   }

   /**
      <P>Get the string that should follow the entire list.</P>

      @return  <B>s_postfix</B>  Exactly as provided to the <A HREF="~JD~lpac(s,s,s,s,s,b)~EJD~">constructor</A>.
    **/
   public final String getPostfix()  {
      return sPostfix;
   }

   /**
      <P>Get the string that should be returned in the case that the object-to-be-listed, as a whole, is null.</P>

      @return  <B>s_ifNull</B>  Exactly as provided to the <A HREF="~JD~lpac(s,s,s,s,s,b)~EJD~">constructor</A>.
    **/
   public final String getIfNull()  {
      return sIfNull;
   }

   /**
      <P>Get the string that should be returned in the case that the object-to-be-listed has zero elements.</P>

      @return  <B>s_ifEmpty</B>  Exactly as provided to the <A HREF="~JD~lpac(s,s,s,s,s,b)~EJD~">constructor</A>.
    **/
   public final String getIfEmpty()  {
      return sIfEmpty;
   }

   /**
      <P>Get the string that should precede the entire list.</P>

      @return  <B>b_makeVisible</B>  Exactly as provided to the <A HREF="~JD~lpac(s,s,s,s,s,b)~EJD~">constructor</A>.
    **/
   public final boolean doMakeVisible()  {
      return bMakeVisible;
   }

}