com.hfg.xml.XMLName Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of com_hfg Show documentation
com.hfg xml, html, svg, and bioinformatics utility library
There is a newer version: 20240423
package com.hfg.xml;


//------------------------------------------------------------------------------
/**
 XMLName is a container for XML tag names that consists of a namespace and a local name.

 @author J. Alex Taylor, hairyfatguy.com
 */
//------------------------------------------------------------------------------
// com.hfg XML/HTML Coding Library
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library 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
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
//
// J. Alex Taylor, President, Founder, CEO, COO, CFO, OOPS hairyfatguy.com
// [email protected]
//------------------------------------------------------------------------------


public class XMLName
{
   //###########################################################################
   // PRIVATE FIELDS
   //###########################################################################

   private String       mLocalName;
   private XMLNamespace mNamespace;

   //###########################################################################
   // CONSTRUCTORS
   //###########################################################################

   //---------------------------------------------------------------------------
   public XMLName(String inName)
   {
      this(inName, null);
   }

   //---------------------------------------------------------------------------
   public XMLName(String inName, XMLNamespace inNamespace)
   {
      if (null == inNamespace
          && inName.contains(":"))
      {
         int index = inName.indexOf(":");
         mLocalName = inName.substring(index + 1);
         mNamespace = XMLNamespace.getNamespaceViaPrefix(inName.substring(0, index));
      }
      else
      {
         mLocalName = inName;
         mNamespace = inNamespace;
      }
   }


   //###########################################################################
   // PUBLIC METHODS
   //###########################################################################


   //---------------------------------------------------------------------------
   @Override
   public String toString()
   {
      return getQualifiedName();
   }

   //---------------------------------------------------------------------------
   public String getLocalName()
   {
      return mLocalName;
   }

   //---------------------------------------------------------------------------
   public String getQualifiedName()
   {
      return (mNamespace != null && mNamespace.getPrefix() != null ? mNamespace.getPrefix() + ":" : "") + mLocalName;
   }

   //---------------------------------------------------------------------------
   public XMLNamespace getNamespace()
   {
      return mNamespace;
   }

   //---------------------------------------------------------------------------
   public XMLName setNamespace(XMLNamespace inValue)
   {
      mNamespace = inValue;
      return this;
   }
}