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

/**
   <P>A PASAOObject that holds an array of Named objects.</P>

   <P><CODE><I><B>Source code:</B> &nbsp;<A HREF="../../../CODE/xbn/named/PASNamed.java">PASNamed.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 PASNamed extends PASAOObject  {
   /**
      <P>To shorten code and Javadoc.</P>

      <P>Equal to <B>"xbn.named.PASNamed"</B></P>
    **/
   public static final String sPASN = "xbn.named.PASNamed";

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

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

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

      <P>Equal to <CODE><A HREF="~JD~pasaoo#pasaoo(s,o[])~EJD~">PASAOObject</A>(<A HREF="#sPASN">sPASN</A>, a_named)</CODE></P>
    **/
   public PASNamed(Named[] a_named)  {
      super(sPASN, a_named);
   }

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

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

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

      <P>Equal to <CODE><A HREF="~JD~pasaoo#pasaoo(s,o[],pars)~EJD~">PASAOObject</A>(<A HREF="#sPASN">sPASN</A>, a_named, par_string)</CODE></P>
    **/
   public PASNamed(Named[] a_named, PARString par_string)  {
      super(sPASN, a_named, par_string);
   }

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

      <P>Equal to <CODE><A HREF="~JD~pasaoo#pasaoo(s,o[],pars)~EJD~">PASAOObject</A>(s_fqExtendingClass, a_named, par_string)</CODE></P>
    **/
   public PASNamed(String s_fqExtendingClass, Named[] a_named, PARString par_string)  {
      super(s_fqExtendingClass, a_named, par_string, false);
   }

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

      <P>Equal to <CODE><A HREF="~JD~pasaoo#pasaoo(s,o[],pars,b)~EJD~">PASAOObject</A>(<A HREF="#sPASN">sPASN</A>, a_named, (new <A HREF="~JD~pars#pars()~EJD~">PARString</A>()), b_lock)</CODE></P>
    **/
   public PASNamed(Named[] a_named, boolean b_lock)  {
      super(sPASN, a_named, (new PARString()), b_lock);
   }

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

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

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

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

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

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

   /**
      <P>Get the Named object's <I>name</I>, at the requested array index.</P>

      @return  <CODE>(Named)<A HREF="#getNamed(int)">getNamed</A>(i_dx).<A HREF="~JD~n~EJD~#getName()">getName</A>()</CODE>
    **/
   public final String getString(int i_dx)  {
      Named n = getNamed(i_dx);

      try  {
         return n.getName();
      }  catch(NullPointerException npx)  {
         throwAX("get:  isNull(" + i_dx + ") equals true.");
      }

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

   public final Named[] getAONamed()  {
      return (Named[])getAOObject();
   }
}