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

/**
   <P>A PrimitiveArrayChar that wraps around an array of chars.</P>

   <P><CODE><I><B>Source code:</B> &nbsp;<A HREF="../../../../CODE/xbn/array/primitive/PACChar.java">PACChar.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 PACChar extends PrimitiveArrayChar implements LockOneWay  {
   /**
      <P>To shorten code and Javadoc.</P>

      <P>Equal to <B>"xbn.array.primitive.PACChar"</B></P>
    **/
   public static final String sPACC = "xbn.array.primitive.PACChar";

   private char[] aChar = null;
   private boolean bLocked = false;

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

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

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

      <P>Equal to <CODE><A HREF="~JD~pacc(s,c[])~EJD~">PACChar</A>(<A HREF="#sPACC">sPACC</A>, a_char)</CODE></P>
    **/
   public PACChar(char[] a_char)  {
      this(sPACC, a_char);
   }

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

      <P>Equal to <CODE><A HREF="~JD~pacc(s,c[],parc)~EJD~">PACChar</A>(s_fqExtendingClass, a_char, (new <A HREF="~JD~parc#parc()~EJD~">PARChar</A>()))</CODE></P>
    **/
   public PACChar(String s_fqExtendingClass, char[] a_char)  {
      this(s_fqExtendingClass, a_char, (new PARChar()));
   }

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

      <P>Equal to <CODE><A HREF="~JD~pacc(s,c[],parc)~EJD~">PACChar</A>(<A HREF="#sPACC">sPACC</A>, a_char)</CODE></P>
    **/
   public PACChar(char[] a_char, PARChar par_char)  {
      this(sPACC, a_char, par_char);
   }

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

      <P>Equal to <CODE><A HREF="~JD~pacc(s,c[],parc,b)~EJD~">PACChar</A>(s_fqExtendingClass, a_char, par_char)</CODE></P>
    **/
   public PACChar(String s_fqExtendingClass, char[] a_char, PARChar par_char)  {
      this(s_fqExtendingClass, a_char, par_char, false);
   }

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

      <P>Equal to <CODE><A HREF="~JD~pacc(s,c[],parc,b)~EJD~">PACChar</A>(<A HREF="#sPACC">sPACC</A>, a_char, (new PARChar()), b_lock)</CODE></P>
    **/
   public PACChar(char[] a_char, boolean b_lock)  {
      this(sPACC, a_char, (new PARChar()), b_lock);
   }

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

      <P>Equal to <CODE><A HREF="~JD~pacc(s,c[],parc,b)~EJD~">PACChar</A>(s_fqExtendingClass, a_char, (new PARChar()), b_lock)</CODE></P>
    **/
   public PACChar(String s_fqExtendingClass, char[] a_char, boolean b_lock)  {
      this(s_fqExtendingClass, a_char, (new PARChar()), b_lock);
   }

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

      <P>Equal to <CODE><A HREF="~JD~pac#pac(s,parc)~EJD~">PrimitiveArrayChar</A>(s_fqExtendingClass, a_char, par_char, b_lock)</CODE></P>

      @param  a_char  The array of ints to analyze.
      @param  b_lock  Should the char array be directly accessible, via <A HREF="#getAOChar()">getAOChar</A>?  If true, yes.  If false, no.
    **/
   public PACChar(String s_fqExtendingClass, char[] a_char, PARChar par_char, boolean b_lock)  {
      super(s_fqExtendingClass, par_char);
      aChar = a_char;
      bLocked = b_lock;
   }


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

      @return  <B>a_char</B>  Exactly as provided to the <A HREF="~JD~pacc(s,c[],parc,b)~EJD~">constructor</A>.
    **/
   public char[] getAOChar()  {
      throwLXIfLocked(isLocked(), "getAOChar");
      return aChar;
   }

   /**
      <P>Get the char at the provide array index.</P>

      @param  i_dx  The array index.  Must range 0..<CODE>[<A HREF="#getLength()">getLength</A>() - 1]</CODE>, inclusive
      @return  <CODE>a_char[i_dx]</CODE>  Where a_char is exactly as pacced into the <A HREF="~JD~pacc(c[],parc)~EJD~">constructor</A>.
      @exception  AssertException  If <A HREF="#isNull()">isNull</A> equals true.
    **/
   public char getChar(int i_dx)  {
      try  {
         return aChar[i_dx];
      }  catch(NullPointerException npx)  {
         throwAX("getChar:  isNull() equals true.");
      }  catch(ArrayIndexOutOfBoundsException aioobx)  {
         throwAX("getChar:  i_dx (" + i_dx + ") is invalid.  getLength()=" + getLength() + ".");
      }

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

   /**
      <P>How many chars are in the char array?</P>

      @return  <CODE>a_char.length</CODE>  Where a_char is exactly as pacced into the <A HREF="~JD~pacc(c[],parc)~EJD~">constructor</A>.
      @exception  AssertException  If <A HREF="#isNull()">isNull</A> equals true.
    **/
   public int getLength()  {
      try  {
         return aChar.length;
      }  catch(NullPointerException npx)  {
         throwAX("getLength:  isNull() equals true.");
      }

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

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

      @return  <CODE>(a_char == null)</CODE>  Where a_char is exactly as pacced into the <A HREF="~JD~pacc(c[],parc)~EJD~">constructor</A>.
    **/
   public boolean isNull()  {
      return (aChar == null);
   }

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

      @return  <B>false</B>  It is not possible for a char to be null.
    **/
   public boolean isNull(int i_dx)  {
      return false;
   }


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

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