/*
   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;

/**
   <P>An APObject for UniqueStrings.  See <A HREF="~JD~unqs~EJD~">UniqueString</A>.</P>

   <P><CODE><I><B>Source code:</B> &nbsp;<A HREF="../../../CODE/xbn/array/UniqueStringAP.java">UniqueStringAP.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 UniqueStringAP extends APObject  {
   private UniqueString[] ausShallowClone = null;

   /**
      <P>Create an UniqueStringAP from the array of UniqueStrings.</P>

      <P>Equal to <A HREF="~JD~apo#apo(o[])~EJD~">APObject</A>(a_unqStrMD)</P>

      @param  a_unqStrMD  The array of UniqueStrings.  May not be null.
    **/
   public UniqueStringAP(UniqueString[] a_unqStrMD)  {
      super(a_unqStrMD);

      throwAXIfNull(a_unqStrMD, "a_unqStrMD", sCNSTR);
   }

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

      @return  <CODE>(UniqueString)<A HREF="~JD~apo#getObject(i)~EJD~">getObject</A>(i_dx)</CODE>
    **/
   public final UniqueString getUniqueString(int i_dx)  {
      return (UniqueString)getObject(i_dx);
   }

   /**
      <P>Get a shallow clone of the internally-held array of UniqueStrings.  The array is copied, but the elements are the same as provided to the <A HREF="~JD~usap(unqs[])~EJD~">constructor</A>.</P>

      <P>For a deep clone, use <A HREF="#getAOUSClone()">getAOUSClone</A>.</P>
    **/
   public final synchronized UniqueString[] getAOUSShallowClone()  {
      if(isNull())  {
         return null;
      }

      if(ausShallowClone != null)  {
         return ausShallowClone;
      }

      UniqueString[] aUniqueString = new UniqueString[getLength()];
      for(int i = 0; i < getLength(); i++)  {
         aUniqueString[i] = getUniqueString(i);
      }
      ausShallowClone = aUniqueString;

      return ausShallowClone;
   }

   /**
      <P>Get a full (deep) copy of the internally-held array of UniqueStrings.</P>
    **/
   public final synchronized UniqueString[] getAOUSClone()  {
      if(isNull())  {
         return null;
      }

      UniqueString[] ausClone = new UniqueString[getLength()];
      for(int i = 0; i < getLength(); i++)  {
         ausClone[i] = getUniqueString(i).getUSClone();
      }

      return ausClone;
   }

   /**
      <P>Get a UniqueStringPAS representing the string within each UniqueString.</P>

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

   /**
      <P>Get a UniqueStringPAS representing the string within each UniqueString.  See <A HREF="~JD~unqs~EJD~">UniqueString</A>.<A HREF="~JD~unqs~EJD~#getString()">getString</A>.</P>

      @return  <CODE>(new UniqueStringPAS(<A HREF="#getAOUSShallowClone()">getAOUSShallowClone</A>(), par_string))</CODE>
    **/
   public final UniqueStringPAS getUniqueStringPAS(PARString par_string)  {
      return (new UniqueStringPAS(getAOUSShallowClone(), par_string));
   }

   /**
      <P>Get a full (deep) copy ofthis UniqueStringAP.</P>

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

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

   /**
      <P>Get a full (deep) copy ofthis UniqueStringAP as an Object.</P>

      @return  <CODE>(new <A HREF="~JD~usap(unqs[])~EJD~">UniqueStringAP</A>(<A HREF="#getAOUSClone()">getAOUSClone</A>()))</CODE>
    **/
   protected Object clone() throws CloneNotSupportedException  {
      return (new UniqueStringAP(getAOUSClone()));
   }
}