com.helger.commons.microdom.MicroQName Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of com.liferay.frontend.css.rtl.servlet
There is a newer version: 5.0.12
/**
 * Copyright (C) 2014-2015 Philip Helger (www.helger.com)
 * philip[at]helger[dot]com
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.helger.commons.microdom;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import javax.annotation.concurrent.Immutable;
import javax.xml.XMLConstants;
import javax.xml.namespace.QName;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import com.helger.commons.ValueEnforcer;
import com.helger.commons.annotation.Nonempty;
import com.helger.commons.compare.CompareHelper;
import com.helger.commons.debug.GlobalDebug;
import com.helger.commons.equals.EqualsHelper;
import com.helger.commons.hashcode.HashCodeGenerator;
import com.helger.commons.string.StringHelper;
import com.helger.commons.string.ToStringGenerator;
import com.helger.commons.xml.CXML;
import com.helger.commons.xml.CXMLRegEx;

/**
 * Represents a simple qualified name. A combination of namespace URI and local
 * name.
 *
 * @author Philip Helger
 */
@Immutable
public final class MicroQName implements IMicroQName, Comparable 
{
  private static final Logger s_aLogger = LoggerFactory.getLogger (MicroQName.class);

  private final String m_sNamespaceURI;
  private final String m_sName;
  // Status vars
  private Integer m_aHashCode;

  public MicroQName (@Nonnull @Nonempty final String sName)
  {
    this (XMLConstants.NULL_NS_URI, sName);
  }

  public MicroQName (@Nullable final String sNamespaceURI, @Nonnull @Nonempty final String sName)
  {
    ValueEnforcer.notEmpty (sName, sName);
    // Unify empty string to null
    m_sNamespaceURI = StringHelper.hasNoText (sNamespaceURI) ? null : sNamespaceURI;

    // Store only the local name (cut the prefix) if a namespace is present
    final int nPrefixEnd = sNamespaceURI != null ? sName.indexOf (CXML.XML_PREFIX_NAMESPACE_SEP) : -1;
    if (nPrefixEnd == -1)
      m_sName = sName;
    else
    {
      // Cut the prefix
      s_aLogger.warn ("Removing namespace prefix '" +
                      sName.substring (0, nPrefixEnd) +
                      "' from micro XML name '" +
                      sName +
                      "'");
      m_sName = sName.substring (nPrefixEnd + 1);
    }

    // Only for the debug version, as this slows things down heavily
    if (GlobalDebug.isDebugMode ())
      if (!CXMLRegEx.PATTERN_NAME_QUICK.matcher (m_sName).matches ())
        if (!CXMLRegEx.PATTERN_NAME.matcher (m_sName).matches ())
          throw new IllegalArgumentException ("The micro XML name '" + m_sName + "' is not a valid XML name!");
  }

  @Nullable
  public String getNamespaceURI ()
  {
    return m_sNamespaceURI;
  }

  public boolean hasNamespaceURI ()
  {
    return StringHelper.hasText (m_sNamespaceURI);
  }

  public boolean hasNoNamespaceURI ()
  {
    return StringHelper.hasNoText (m_sNamespaceURI);
  }

  public boolean hasNamespaceURI (@Nullable final String sNamespaceURI)
  {
    return EqualsHelper.equals (m_sNamespaceURI, sNamespaceURI);
  }

  @Nonnull
  @Nonempty
  public String getName ()
  {
    return m_sName;
  }

  @Nonnull
  public QName getAsXMLQName ()
  {
    return new QName (m_sNamespaceURI, m_sName);
  }

  @Nonnull
  public QName getAsXMLQName (@Nonnull final String sPrefix)
  {
    return new QName (m_sNamespaceURI, m_sName, sPrefix);
  }

  public int compareTo (@Nonnull final MicroQName o)
  {
    int ret = CompareHelper.compare (m_sNamespaceURI, o.m_sNamespaceURI);
    if (ret == 0)
      ret = m_sName.compareTo (o.m_sName);
    return ret;
  }

  @Override
  public boolean equals (final Object o)
  {
    if (o == this)
      return true;
    if (o == null || !getClass ().equals (o.getClass ()))
      return false;
    final MicroQName rhs = (MicroQName) o;
    return EqualsHelper.equals (m_sNamespaceURI, rhs.m_sNamespaceURI) && m_sName.equals (rhs.m_sName);
  }

  @Override
  public int hashCode ()
  {
    if (m_aHashCode == null)
      m_aHashCode = new HashCodeGenerator (this).append (m_sNamespaceURI).append (m_sName).getHashCodeObj ();
    return m_aHashCode.intValue ();
  }

  @Override
  public String toString ()
  {
    return new ToStringGenerator (null).appendIfNotNull ("NamespaceURI", m_sNamespaceURI)
                                       .append ("Name", m_sName)
                                       .toString ();
  }
}