////////////////////////////////////////////////////////////////////////////////
   // MillScript-XML: an Open Spice interpreter and batch website creation tool
   // Copyright (C) 2005 Kevin Rogers
   //
   // This file is part of MillScript-XML.
   //
   // MillScript-XML is free software; you can redistribute it and/or modify it under
   // the terms of the GNU General Public License as published by the Free
   // Software Foundation; either version 2 of the License, or (at your option)
  // any later version.
  //
  // MillScript-XML is distributed in the hope that it will be useful, but WITHOUT
  // ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  // FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
  // more details.
  //
  // You should have received a copy of the GNU General Public License along with
  // MillScript-XML; if not, write to the Free Software Foundation, Inc., 59 Temple
  // Place, Suite 330, Boston, MA  02111-1307  USA
  ////////////////////////////////////////////////////////////////////////////////
  package org.millscript.commons.xml.tokenizer;
  
  import org.millscript.commons.alert.Alert;
  import org.millscript.commons.util.IMap;
  import org.millscript.commons.xml.alerts.XmlNamespaceWellFormednessAlert;
  
  /**
   * This class provides a <code>Name</code> implementation for prefixed, or
   * namespace aware, names.
   */
  public class PrefixedName extends AbstractName {
  
      /**
       * This is the ID from the release 0.3.0 for future compatibility.
       */
      private static final long serialVersionUID = -2766284273553889013L;
  
      /**
       * The local part of the prefixed name.
       */
      private final String localName;
  
      /**
       * The namespace this name belongs to.
       */
      private final String namespace;
  
      /**
       * The prefix part of the prefixed name.
       */
      private final String prefix;
  
      /**
       * The full qualified name.
       */
      private final String qName;
  
      /**
       * Constructs a new prefixed name, in the specified namespace, with the
       * specified qualified name and prefix length within the qualified name.
       *
       * @param n the namespace this name belongs in
       * @param q the fully qualified name
       * @param prefixLength  the length of the prefix part of the qualified name
       */
      public PrefixedName( final String n, final String q, final int prefixLength ) {
          // If the following changes such that name could be null, the equals
          // and hashCode methods will need updating.
          if ( n == null ) {
              throw new NullPointerException( "namespace cannot be null" );
  //        } else if ( n.length() == 0 ) {
  //            throw new XmlNamespaceWellFormednessAlert(
  //                "Namespace cannot be an empty string"
  //            );
          }
          this.namespace = n;
          // If the following changes such that qName could be null, the equals
          // and hashCode methods will need updating.
          this.qName = q;
          this.prefix = this.qName.substring( 0, prefixLength );
          this.localName = this.qName.substring( prefixLength + 1 );
      }
  
      /**
       * Constructs a new prefixed name, in the specified namespace, with the
       * specified qualified name and prefix length within the qualified name.
       *
       * @param n the namespace this name belongs in
       * @param l the local name
       * @param p the namespace prefix
       * @param q the fully qualified name
       */
      private PrefixedName( final String n, final String l, final String p, final String q ) {
          this.localName = l;
          this.namespace = n;
          this.prefix = p;
          this.qName = q;
      }
  
     /**
      * @see org.millscript.commons.alert.AlertDecorator#decorate(org.millscript.commons.alert.Alert)
      */
     public Alert decorate( final Alert alert ) {
         final StringBuffer buffer = new StringBuffer( this.getQName() );
         if ( this.namespace != null ) {
             buffer.append( "(" );
             buffer.append( this.namespace );
             buffer.append( ")" );
         }
         return alert.culprit( "xml name", buffer );
     }
 
     /**
      * @see org.millscript.commons.xml.api.Name#getLocalName()
      */
     public String getLocalName() {
         return this.localName;
     }
 
     /**
      * @see org.millscript.commons.xml.api.Name#getNamespace()
      */
     public String getNamespace() {
         return this.namespace;
     }
 
     /**
      * @see org.millscript.commons.xml.api.Name#getPrefix()
      */
     public String getPrefix() {
         return this.prefix;
     }
 
     /**
      * @see org.millscript.commons.xml.api.Name#getQName()
      */
     public String getQName() {
         return this.qName;
     }
 
     /**
      * @see org.millscript.commons.xml.tokenizer.ProtoName#setNamespace(IMap)
      */
     @Override
     public PrefixedName setNamespace( final IMap< String, String > scope ) {
         final String ns = scope.get( this.getPrefix() );
         // When handling a prefixed name, the prefix MUST be declared in the
         // current scope and it is an error otherwise
         if ( "".equals( ns ) ) {
             throw new XmlNamespaceWellFormednessAlert(
                 "A Namespace prefix must be declared and in scope before it can be used"
             ).culprit( "prefix", this.getPrefix() ).mishap();
         }
         // Return a new prefixed name with the namespace for this names prefix
         // from the specified scope
         return new PrefixedName(
             ns,
             this.getLocalName(),
             this.getPrefix(),
             this.getQName()
         );
     }
 
     /**
      * @see java.lang.Object#toString()
      */
     @Override
     public String toString() {
         return this.prefix + ':' + this.localName + "(" + this.namespace + ")";
     }
 
 }