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

/**
   <P>An ArrayProtector for an array of strings.</P>

   <P><CODE><I><B>Source code:</B> &nbsp;<A HREF="../../../CODE/xbn/array/APString.java">APString.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 APString extends ArrayProtector  {
   private String[] as = null;
   private String[] asShallowClone = null;

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

      <P>Equal to <CODE><A HREF="~JD~aps(s[],b)~EJD~">APString</A>(a_string, false)</CODE></P>
    **/
   public APString(String[] a_string)  {
      this(a_string, false);
   }

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

      @param  a_string  The array of strings to protect.
      @param  b_shallowCloneAOS  Should a_string be (shallow-ly) cloned to start off--here in this constructor?  This recreates a_string as a <A HREF="#getAOSShallowClone()">shallow clone</A> of itself, to prevent external code from altering it.
    **/
   public APString(String[] a_string, boolean b_shallowCloneAOS)  {

      //Must assign a_string to as before getting the shallow clone.
      //Otherwise the shallow clone will clone as, which would be
      //*null*.
      as = a_string;

      if(b_shallowCloneAOS)  {
         as = getAOSShallowClone();
         //Now asShallowClone is set, too.
      }
   }

   /**
      @return  <CODE>(a_string == null)</CODE>  Where a_string is exactly as provided to the <A HREF="~JD~aps(s[],b)~EJD~">constructor</A>.
    **/
   public final boolean isNull()  {
      return (as == null);
   }

   /**
      <P>Is the string at the provided array index null?</P>

      @return  <CODE>(as[i_dx] == null)</CODE>
    **/
   public final boolean isNull(int i_dx)  {
      try  {
         return (as[i_dx] == null);
      }  catch(NullPointerException npx)  {
         throwAX("isNull(int):  isNull() equals true.");
      }  catch(IndexOutOfBoundsException ioobx)  {
         throwAX("isNull:  i_dx (" + i_dx + ") is invalid.  getLength()=" + getLength() + ".");
      }

      //Never reached.  Required for compile.
      return false;
   }

   /**
      @return  <CODE>a_string.length</CODE>  Where a_string is exactly as provided to the <A HREF="~JD~aps(s[],b)~EJD~">constructor</A>.
      @exception  AssertException  If <A HREF="#isNull()">isNull</A> is true.
    **/
   public final int getLength()  {
      try  {
         return as.length;
      }  catch(NullPointerException npx)  {
         throwAX("getLength:  isNull() equals true.");
      }

      //Never reached.  Required for compile.
      return -1;
   }

   /**
      <P>Get the string at the requested array index.</P>

      @param  i_dx  The array index.  Must range 0..<CODE>[<A HREF="#getLength()">getLength</A>() - 1]</CODE>, inclusive.
      @return  <CODE>a_string[i_dx]</CODE>  Where a_string is exactly as provided to the <A HREF="~JD~aps(s[],b)~EJD~">constructor</A>.
      @exception  AssertException  If <A HREF="#isNull()">isNull</A> is true.
    **/
   public final String getString(int i_dx)  {
      try  {
         return as[i_dx];
      }  catch(NullPointerException npx)  {
         throwAX("getString:  isNull() equals true.");
      }  catch(IndexOutOfBoundsException ioobx)  {
         throwAX("getString:  i_dx (" + i_dx + ") is invalid.  getLength()=" + getLength() + ".");
      }

      //Never reached.  Required for compile.
      return null;
   }

   /**
      <P>Add the string-array-being-protected to the provided VWString.</P>

      <P>If <A HREF="#isNull()">isNull</A> equals true, nothing is done.  If false, then <CODE>ac_string.<A HREF="~JD~vws#addArray(s[])~EJD~">addArray</A>([INTERNAL STRING ARRAY])</CODE> is called.</P>

      @param  ac_string  The VWString to add to.  May not be null.
    **/
   public final void addToVWString(VWString ac_string)  {
      if(isNull())  {
         return;
      }

      try  {
         ac_string.addArray(as);
      }  catch(NullPointerException npx)  {
         throwAX("addToVWString:  ac_string is null.");
      }
   }

   /**
      <P>Get a copy of the string-array-being-wrapped, with references to the original string elements.</P>

      @return  <CODE>(new <A HREF="~JD~utila~EJD~">UtilArray</A>()).<A HREF="~JD~utila#getAOSShallowClone(s[])~EJD~">getAOOShallowClone</A>(a_string)</CODE>  Where a_string is exactly as provided to the <A HREF="~JD~aps(s[],b)~EJD~">constructor</A>.  <I>Note that this function only creates the clone once.  Once created, the copy is then internally stored, and returned for all subsequent calls.</I>
    **/
   public final synchronized String[] getAOSShallowClone()  {
      if(asShallowClone != null  ||  isNull())  {
         return as;
      }

      as = (new UtilArray()).getAOSShallowClone(as);
      return as;
   }

   /**
      <P>Get a new PASString wrapping around the string-array-being-protected.</P>

      @return  <CODE><A HREF="~JD~getPASString(pars)~EJD~">getPASString</A>(new <A HREF="~JD~pars#pars()~EJD~">PARString</A>())</CODE>
    **/
   public final PASString getPASString()  {
      return getPASString(new PARString());
   }


   /**
      <P>Get a new PASString wrapping around the string-array-being-protected.</P>

      @return  <CODE>(new <A HREF="~JD~pass#pass(s[],pars,b)~EJD~">PASString</A>(<A HREF="#getAOSShallowClone()">getAOSShallowClone</A>(), par_string, true))</CODE>
    **/
   public final PASString getPASString(PARString par_string)  {
      return (new PASString(getAOSShallowClone(), par_string, true));
   }

   public String toString()  {
      StringBuffer sb = new StringBuffer(this.getClass().getName()).append(":  ");

      if(isNull())  {
         sb.append("isNull()=true");
         return sb.toString();
      }
      //It's not null.

      sb.append("['").append(getPASString().getList("', '")).append("']");

      return sb.toString();
   }

   //Cloning...START
      /**
         <P>Get a full (deep) copy of this APString.</P>

         @return  <CODE>(APString)<A HREF="#clone()">clone</A>()</CODE>
       **/
      public final APString getAPSClone()  {
         try  {
            return (APString)clone();
         }  catch(CloneNotSupportedException cnsx)  {
            throwAX("getAPSClone [SHOULD NEVER HAPPEN!]:  " + cnsx.toString());
         }

         //Never reached.  Required for compile.
         return null;
      }

      /**
         <P>Get a full (deep) copy of this APString as an Object.</P>

         <P><I>I know this uses a "shallow" clone of the string array.  Does it matter?  Is it no different than manually creating new string copies?</I></P>

         @return  <CODE>(new <A HREF="~JD~aps(s[])~EJD~">APString</A>(<A HREF="#getAOSShallowClone()">getAOSShallowClone</A>()))</CODE>
       **/
      protected final Object clone() throws CloneNotSupportedException  {
         return (new APString(getAOSShallowClone()));
      }
   //Cloning...END

   final String[] getAOString()  {
      return as;
   }
}