/*
   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.jdlcode;
   import xbn.XBNObject;
   import xbn.named.Named;
   import xbn.string.UtilString;
   import xbn.string.padchop.PadChopString;
   import xbn.string.padchop.ConfigPad;

/**
   <P>Defines a package type whose classes are liked to, from your JavaDoc html files.  Manage a set of PackageTypes with a <A HREF="~JD~pta~EJD~">PTArray</A>.</P>

   <P><CODE><I><B>Source code:</B> &nbsp;<A HREF="../../../CODE/xbn/jdlcode/PackageType.java">PackageType.java</A>.</I></CODE></P>

   <P>All package types are defined above the "\~" line, in the <A HREF="~JD~utiljdlc#getJDCAFromFLR(flr)~EJD~">doclet class map</A>.  See <A HREF="~JD~utiljdlc~EJD~">UtilJDLCode</A>.<A HREF="~JD~utiljdlc#getJDCAFromFLR(flr)~EJD~">getJDCAFromFLR</A> and <A HREF="~JD~utiljdlc#getPackageTypeFromLine(s,i)~EJD~">getPackageTypeFromLine</A>.</P>

   @version  0.9b
   @author  Jeff Epstein, <A HREF="http://sourceforge.net/projects/xbnjava">http://sourceforge.net/projects/xbnjava</A>.
 **/
public class PackageType extends XBNObject implements Named  {
   private static UtilString uStr = new UtilString();
   private static PadChopString pcspPrefix = new PadChopString(new ConfigPad(16));

   private boolean bFound = false;

   private String sPrefix = null;
   private String sExternalUrl = null;

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

      @param s_prefix  The prefix of a package type.  For example, the package type prefix for<UL>
      <LI><CODE>java.lang.<A HREF="~JD~o~EJD~">Object</A></CODE></LI>
      <LI><CODE>java.io.<A HREF="~JD~f~EJD~">File</A></CODE></LI>
      <LI><CODE>java.sql.<A HREF="~JD~conn~EJD~">Connection</A></CODE></LI>
   </UL>
   is <B>java</B></P>

   <P>The package type prefix for <UL>
      <LI><CODE>xbn.<A HREF="~JD~xbno~EJD~">XBNObject</A></CODE></LI>
      <LI><CODE>xbn.array.<A HREF="~JD~vwo~EJD~">VWObject</A></CODE></LI>
      <LI><CODE>xbn.util.<A HREF="~JD~utils~EJD~">UtilString</A></CODE></LI>
   </UL>

   <P><I>To do:  Package prefixes should be allowed to have a dot in them.  This will prevent conflicts when using multiple packages starting with "com.".</I></P>

   is <B>xbn</B></P>
      @param  s_externalUrl  The url to the <A HREF="#isExternal()">external</A> package's root JavaDoc directory, including the final slash.  Inside of this url directory must exist a folder named (the value of) s_prefix.  When null, this package type is <A HREF="#isLocal()">local</A>, meaning the JavaDoc files for these packages are generated by you.
    **/
   public PackageType(String s_prefix, String s_externalUrl)  {
      throwAXIfBadStr(s_prefix, "s_prefix", sCNSTR);

      sPrefix = s_prefix;
      sExternalUrl = s_externalUrl;

      bFound = false;
   }

   /**
      <P>Get the prefix for this PackageType.</P>

      @return  <B>s_prefix</B>, exactly as provided to the <A HREF="~JD~pt(s,s)~EJD~">constructor</A>.
    **/
   public String getPrefix()  {
      return sPrefix;
   }

   /**
      <P>Is this PackageType external?</P>

      @return  <CODE>(<A HREF="#getExternalUrl()">getExternalUrl</A>() != null)</CODE>
    **/
   public boolean isExternal()  {
      return (getExternalUrl() != null);
   }

   /**
      <P>Is this PackageType local?</P>

      @return  <CODE>!<A HREF="#isExternal()">isExternal</A>()</CODE>
    **/
   public boolean isLocal()  {
      return !isExternal();
   }

   /**
      <P>Get the prefix for this PackageType.</P>

      @return  <B>s_externalUrl</B>, exactly as provided to the <A HREF="~JD~pt(s,s)~EJD~">constructor</A>.
    **/
   public String getExternalUrl()  {
      return sExternalUrl;
   }

   /**
      <P>A synonym for getPrefix().  See <A HREF="#getPrefix()">getPrefix</A>.</P>
    **/
   public String getName()  {
      return getPrefix();
   }

   void setFound()  {
      bFound = true;
   }

   boolean isFound()  {
      return bFound;
   }

   /**
      <P>Get some information about this PackageType.</P>
    **/
   public String toString()  {
      return pcspPrefix.get(sPrefix) + "  " + uStr.getConditional(getExternalUrl(), "[LOCAL]");
   }
}