• Home
• org.activecomponents.jadex
• jadex-serialization-xml
• 4.0.261
• source code
• QName.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

jadex.xml.stax.QName Maven / Gradle / Ivy

package jadex.xml.stax;

/**
 * StaX API: QName
 */
public class QName implements java.io.Serializable
{
	// -------- attributes --------

	private String namespaceURI;
	private String localPart;

	private String prefix;

	// -------- constructors --------

	/**
	 * Constructor for the QName with just a local part. This assigns an empty
	 * string as the default values for namespaceURI,
	 * prefix and localPart.
	 * 
	 * 
	 * @param localPart
	 *            Local part of the QName
	 * @throws java.lang.IllegalArgumentException
	 *             If null local part is specified
	 **/
	public QName(String localPart)
	{
		this("", localPart);
	}

	/**
	 * Constructor for the QName with a namespace URI and a local part. This
	 * method assigns an empty string as the default value for
	 * prefix.
	 * 
	 * @param namespaceURI
	 *            Namespace URI for the QName
	 * @param localPart
	 *            Local part of the QName
	 * @throws java.lang.IllegalArgumentException
	 *             If null local part or namespaceURI is specified
	 **/
	public QName(String namespaceURI, String localPart)
	{
		this(namespaceURI, localPart, "");
	}

	/**
	 * Constructor for the QName.
	 * 
	 * @param namespaceURI
	 *            Namespace URI for the QName
	 * @param localPart
	 *            Local part of the QName
	 * @param prefix
	 *            The prefix of the QName
	 * @throws java.lang.IllegalArgumentException
	 *             If null local part or prefix is specified
	 **/
	public QName(String namespaceURI, String localPart, String prefix)
	{
		if (localPart == null)
			throw new IllegalArgumentException("Local part not allowed to be null");

		if (namespaceURI == null)
			namespaceURI = "";
		// throw new
		// IllegalArgumentException("namespaceURI not allowed to be null");

		if (prefix == null)
			prefix = "";
		// throw new IllegalArgumentException("prefix not allowed to be null");

		this.namespaceURI = namespaceURI;
		this.localPart = localPart;
		this.prefix = prefix;
	}

	// -------- methods --------

	/**
	 * Gets the Namespace URI for this QName.
	 * 
	 * @return Namespace URI
	 **/
	public String getNamespaceURI()
	{
		return namespaceURI;
	}

	/**
	 * Gets the Local part for this QName.
	 * 
	 * @return Local part
	 **/
	public String getLocalPart()
	{
		return localPart;
	}

	/**
	 * Gets the prefix for this QName. Note that the prefix assigned to a QName
	 * may not be valid in a different context. For example, a QName may be
	 * assigned a prefix in the context of parsing a document but that prefix
	 * may be invalid in the context of a different document.
	 * 
	 * @return a String value of the prefix.
	 */
	public String getPrefix()
	{
		return prefix;
	}

	/**
	 * Returns a string representation of this QName.
	 * 
	 * @return a string representation of the QName
	 **/
	public String toString()
	{
		if (namespaceURI.equals(""))
		{
			return localPart;
		} else
		{
			return "{" + namespaceURI + "}" + localPart;
		}
	}

	/**
	 * Returns a QName holding the value of the specified String.
	 * 
	 * The string must be in the form returned by the QName.toString() method,
	 * i.e. "{namespaceURI}localPart", with the "{namespaceURI}" part being
	 * optional.
	 * 
	 * This method doesn't do a full validation of the resulting QName. In
	 * particular, it doesn't check that the resulting namespace URI is a legal
	 * URI (per RFC 2396 and RFC 2732), nor that the resulting local part is a
	 * legal NCName per the XML Namespaces specification.
	 * 
	 * @param s
	 *            the string to be parsed
	 * @return QName corresponding to the given String
	 * @throws java.lang.IllegalArgumentException
	 *             If the specified String cannot be parsed as a QName
	 **/
	public static QName valueOf(String s)
	{
		if (s == null || s.equals(""))
		{
			throw new IllegalArgumentException("invalid QName literal");
		}

		if (s.charAt(0) == '{')
		{
			// qualified name
			int i = s.indexOf('}');
			if (i == -1)
			{
				throw new IllegalArgumentException("invalid QName literal");
			}
			if (i == s.length() - 1)
			{
				throw new IllegalArgumentException("invalid QName literal");
			}
			return new QName(s.substring(1, i), s.substring(i + 1));
		} else
		{
			return new QName(s);
		}
	}

	/**
	 * Returns a hash code value for this QName object. The hash code is based
	 * on both the localPart and namespaceURI parts of the QName. This method
	 * satisfies the general contract of the {@link java.lang.Object#hashCode()
	 * Object.hashCode} method. 

	 * 
	 * @return A hash code value for this Qname object
	 **/
	public final int hashCode()
	{
		return namespaceURI.hashCode() ^ localPart.hashCode();
	}

	/**
	 * Tests this QName for equality with another object.
	 * 
	 * 

	 * If the given object is not a QName or is null then this method returns
	 * false.
	 * 
	 * 

	 * For two QNames to be considered equal requires that both localPart and
	 * namespaceURI must be equal. This method uses String.equals
	 * to check equality of localPart and namespaceURI.
	 * 
	 * 

	 * This method satisfies the general contract of the
	 * {@link java.lang.Object#equals(Object) Object.equals} method.
	 * 
	 * 
	 * 
	 * @param obj
	 *            the reference object with which to compare.
	 * @return true if the given object is identical to this QName:
	 *         false otherwise.
	 **/
	public final boolean equals(Object obj)
	{
		if (obj == null)
		{
			return false;
		}

		if (!(obj instanceof QName))
		{
			return false;
		}

		QName qname = (QName) obj;

		return this.localPart.equals(qname.localPart) && this.namespaceURI.equals(qname.namespaceURI);
	}
}