/*
   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.util.LockOneWay;
   import xbn.array.UtilArray;
   import xbn.named.Named;
   import xbn.named.PASNamed;
   import xbn.string.StringOrBuffer;

/**
   <P>A PrimitiveArrayString that wraps around an array of java.lang.Objects.  This class defines the string (see <A HREF="~JD~pa~EJD~">PrimitiveArray</A>.<A HREF="~JD~pa#getString(i)~EJD~">getString</A>) to be the <A HREF="~JD~o~EJD~">Object</A>'s <A HREF="~JD~o~EJD~#toString()">toString</A>.  Extend this class to make the string represent something else.</P>

   <P><CODE><I><B>Source code:</B> &nbsp;<A HREF="../../../../CODE/xbn/array/primitive/PASAOObject.java">PASAOObject.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 PASAOObject extends PrimitiveArrayString implements LockOneWay  {
   public final static String sPASAOO = "xbn.array.primitive.PASAOObject";
   private final UtilArray uArray = new UtilArray();
   private Object[] aObject = null;
   private boolean bLocked = false;

   /**
      <P>Create a PASAOObject with default values.</P>

      <P>Equal to <CODE><A HREF="~JD~pasaoo(o[])~EJD~">PASAOObject</A>(null)</CODE></P>
    **/
   public PASAOObject()  {
      this(null);
   }

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

      <P>Equal to <CODE><A HREF="~JD~pasaoo(s,o[])~EJD~">PASAOObject</A>(<a href="#sPASAOO">sPASAOO</a>, a_object)</CODE></P>
    **/
   public PASAOObject(Object[] a_object)  {
      this(sPASAOO, a_object);
   }

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

      <P>Equal to <CODE><A HREF="~JD~pasaoo(s,o[],pars)~EJD~">PASAOObject</A>(s_fqExtendingClass, a_object, (new <A HREF="~JD~pars#pars()~EJD~">PARString</A>())))</CODE></P>
    **/
   public PASAOObject(String s_fqExtendingClass, Object[] a_object)  {
      this(s_fqExtendingClass, a_object, (new PARString()));
   }

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

      <P>Equal to <CODE><A HREF="~JD~pasaoo(s,o[],pars)~EJD~">PASAOObject</A>(<a href="#sPASAOO">sPASAOO</a>, a_object, par_string)</CODE></P>
    **/
   public PASAOObject(Object[] a_object, PARString par_string)  {
      this(sPASAOO, a_object, par_string);
   }

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

      <P>Equal to <CODE><A HREF="~JD~pasaoo(s,o[],pars,b)~EJD~">PASAOObject</A>(<a href="#sPASAOO">sPASAOO</a>, a_object, (new <A HREF="~JD~pars#pars()~EJD~">PARString</A>()), b_lock)</CODE></P>
    **/
   public PASAOObject(Object[] a_object, boolean b_lock)  {
      this(sPASAOO, a_object, (new PARString()), b_lock);
   }


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

      <P>Equal to <CODE><A HREF="~JD~pasaoo(s,o[],pars,b)~EJD~">PASAOObject</A>(<a href="#sPASAOO">sPASAOO</a>, a_object, par_string, b_lock)</CODE></P>
    **/
   public PASAOObject(Object[] a_object, PARString par_string, boolean b_lock)  {
      this(sPASAOO, a_object, par_string, b_lock);
   }

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

      <P>Equal to <CODE><A HREF="~JD~pasaoo(s,o[],pars,b)~EJD~">PASAOObject</A>(s_fqExtendingClass, a_object, par_string, false)</CODE></P>
    **/
   public PASAOObject(String s_fqExtendingClass, Object[] a_object, PARString par_string)  {
      this(s_fqExtendingClass, a_object, par_string, false);
   }

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

      <P>Equal to <CODE><A HREF="~JD~pasaoo(s,o[],pars,b)~EJD~">PASAOObject</A>(s_fqExtendingClass, a_object, (new <A HREF="~JD~pars#pars()~EJD~">PARString</A>()), b_lock)</CODE></P>
    **/
   public PASAOObject(String s_fqExtendingClass, Object[] a_object, boolean b_lock)  {
      this(s_fqExtendingClass, a_object, (new PARString()), b_lock);
   }

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

      <P>The first line of this constructor calls <CODE><A HREF="~JD~pas#pas(s,pars)~EJD~">PrimitiveArrayChar</A>(s_fqExtendingClass, par_string)</CODE></P>

      @param  a_object  The array of Objects that should somehow appear like an array of strings.
      @param  b_lock  Should a_object be directly accessible, via <A HREF="#getAOObject()">getAOObject</A>?  If true, yes.  If false, no.  See <A HREF="#lock()">lock</A> and <A HREF="#isLocked()">isLocked</A>.
    **/
   public PASAOObject(String s_fqExtendingClass, Object[] a_object, PARString par_string, boolean b_lock)  {
      super(s_fqExtendingClass, par_string);
      aObject = a_object;
      bLocked = b_lock;
   }

   /**
      <P>How many strings exist in this PASAOObject?</P>
      @exception  AssertException  If <A HREF="#isNull()">isNull</A> equals true.
    **/
   public final int getLength()  {
      try  {
         return aObject.length;
      }  catch(NullPointerException npx)  {
         throwAX("getLength:  isNull() is true.");
      }

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

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

      @param  i_dx  The array index.  Must range 0..<CODE>[<A HREF="#getLength()">getLength</A>() - 1]</CODE>, inclusive
      @exception  AssertException  If <A HREF="#isNull()">isNull</A> equals true.
    **/
   public final Object getObject(int i_dx)  {
      try  {
         return aObject[i_dx];
      }  catch(NullPointerException npx)  {
         throwAX("getObject:  isNull() is true.");
      }  catch(ArrayIndexOutOfBoundsException aioobx)  {
         throwAX("get:  i_dx (" + i_dx + ") is invalid.  getLength()=" + getLength() + ".");
      }

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

   /**
      <P>Get the array of objects for direct manipulation.</P>

      @return  <B>a_object</B>  Exactly as provided to the <A HREF="~JD~pasaoo(o[],b)~EJD~">constructor</A>.
      @exception  LockedException  If <A HREF="#isLocked()">isLocked</A> equals false.
    **/
   public final Object[] getAOObject()  {
      throwLXIfLocked(isLocked(), "getAOObject");
      return aObject;
   }

   /**
      <P>Is the array of objects null?</P>

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

   /**
      <P>Is the object at the requested array index null?</P>

      @return <CODE>(a_object[i_dx] == null)</CODE> where a_object is exactly as provided to the <A HREF="~JD~pasaoo(o[],b)~EJD~">constructor</A>.
      @param  i_dx  The array index.  Must range 0..<CODE>[<A HREF="#getLength()">getLength</A>() - 1]</CODE>, inclusive
    **/
   public final boolean isNull(int i_dx)  {
      try  {
         return (aObject[i_dx] == null);
      }  catch(ArrayIndexOutOfBoundsException aioobx)  {
         throwAX("get:  i_dx (" + i_dx + ") is invalid.  getLength()=" + getLength() + ".");
      }

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

   public final PASNamed getPASNamed()  {
      try  {
         return (new PASNamed((Named[])aObject, true));
      }  catch(ClassCastException ccx)  {
         throwAX("getPASNamed:  As provided to the constructor, a_object is not of type 'xbn.named.Named[]'.  Currently:  '" + aObject.getClass().getName() + "'.");
      }

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

   /**
      <P>Get the toString of the requested element.</P>

      @return  <CODE><A HREF="~JD~getObject(i)~EJD~">getObject</A>(i_dx).<A HREF="~JD~o~EJD~#toString()">toString</A>()</CODE>
    **/
   public String getString(int i_dx)  {
      return getObject(i_dx).toString();
   }

   /**
      <P>Get a new PASString representing the internally-held array of Objects (as Strings).</P>

      @return  <CODE>(new <A HREF="~JD~pass#pass(s[],b)~EJD~">PASString</A>((<A HREF="~JD~s~EJD~">String</A>[])[the internally-held array of Objects], <A HREF="#isLocked()">isLocked</A>()))</CODE>
    **/
   public final PASString getPASString()  {
      return (new PASString((String[])aObject, isLocked()));
   }

   /**
      <P>Get a new PASString representing the toStrings() of the internally-held array of Objects.</P>

      <P>Equal to <CODE>[<A HREF="~JD~utila~EJD~">UtilArray</A>].<A HREF="~JD~utila#appendTSList(sob,o[],s,s,s,s,s,s)~EJD~">appendTSList</A>(str_orBfr, [the internally-held array of objects], s_prefix, s_divider, s_postfix, s_ifNull, s_ifEmpty, s_ifLmntNull)</CODE></P>
    **/
   public final void appendTSList(StringOrBuffer str_orBfr, String s_prefix, String s_divider, String s_postfix, String s_ifNull, String s_ifEmpty, String s_ifLmntNull)  {
      uArray.appendTSList(str_orBfr, aObject, null, "  |  ", null, null, null, null);
   }


   //Required by LockOneWay...START
      public final void lock()  {
         bLocked = true;
      }

      public final boolean isLocked()  {
         return bLocked;
      }
   //Required by LockOneWay...END
}