Top Description Fields Constructors Methods
com.fasterxml.aalto.in

public abstract Class PName

extends Object
Class Inheritance
Known Direct Subclasses
com.fasterxml.aalto.in.PNameC, com.fasterxml.aalto.in.ByteBasedPName
Imports
javax.xml.namespace.QName

Prefixed Name is similar to javax.xml.namespace.QName (qualified name), but only contains information about local name optionally prefixed by a prefix and colon, without namespace binding information.

Field Summary

Modifier and TypeField and Description
protected final String
protected NsBinding
_namespaceBinding

Binding of this qualified/prefixed name.

protected final String
protected final String

Constructor Summary

AccessConstructor and Description
protected
PName(String pname, String prefix, String ln)

Method Summary

Modifier and TypeMethod and Description
public final boolean
boundEquals(PName other)

Method that compares two bound PNames for semantic equality.

public final boolean
public final int
public static int
boundHashCode(String nsURI, String localName)

public final QName
public final QName
constructQName(NsBinding defaultNs)

Method called to construct a QName representation of elemented represented by this PName.

public abstract PName
public final boolean
equals(Object
the reference object with which to compare.
o
)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.
public abstract int
public abstract int
public final String
public final NsBinding
public final String
public final String

Returns:

Prefix of this name, if it has one; null if not.
getPrefix
()

public final String
public abstract int
getQuad(int index)

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for the object.
public boolean
public boolean
public final boolean

Returns:

True if the name as described either has no prefix (either belongs to the default ns [elems], or to 'no namespace' [attrs]), or has a prefix that is bound currently. False if name has a prefix that is unbound.
isBound
()

public final boolean

Returns:

True if the name has no binding object, but will need one (has prefix)
needsBinding
()

public abstract int
public final String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.
public final boolean
public final int
Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

_localNameback to summary
protected final String _localName
_namespaceBindingback to summary
protected NsBinding _namespaceBinding

Binding of this qualified/prefixed name. Null if there is no prefix; in which case name is either bound to the default namespace (when element name), or no namespace (when other name, like attribute)

_prefixback to summary
protected final String _prefix
_prefixedNameback to summary
protected final String _prefixedName

Constructor Detail

PNameback to summary
protected PName(String pname, String prefix, String ln)

Method Detail

boundEqualsback to summary
public final boolean boundEquals(PName other)

Method that compares two bound PNames for semantic equality. This means that the local name, as well as bound URI are compared.

boundEqualsback to summary
public final boolean boundEquals(String nsUri, String ln)
boundHashCodeback to summary
public final int boundHashCode()
boundHashCodeback to summary
public static int boundHashCode(String nsURI, String localName)
constructQNameback to summary
public final QName constructQName()
constructQNameback to summary
public final QName constructQName(NsBinding defaultNs)

Method called to construct a QName representation of elemented represented by this PName. Because of namespace defaulting, current default namespace binding also needs to be passed (since only explicit ones get bound to PName instances).

createBoundNameback to summary
public abstract PName createBoundName(NsBinding nsb)
equalsback to summary
public final boolean equals(Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
o:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
getFirstQuadback to summary
public abstract int getFirstQuad()
getLastQuadback to summary
public abstract int getLastQuad()
getLocalNameback to summary
public final String getLocalName()
getNsBindingback to summary
public final NsBinding getNsBinding()
getNsUriback to summary
public final String getNsUri()
getPrefixback to summary
public final String getPrefix()
Returns:String

Prefix of this name, if it has one; null if not.

getPrefixedNameback to summary
public final String getPrefixedName()
getQuadback to summary
public abstract int getQuad(int index)
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object.

Annotations
@Override
hasPrefixback to summary
public boolean hasPrefix()
hasPrefixedNameback to summary
public boolean hasPrefixedName(String n)
isBoundback to summary
public final boolean isBound()
Returns:boolean

True if the name as described either has no prefix (either belongs to the default ns [elems], or to 'no namespace' [attrs]), or has a prefix that is bound currently. False if name has a prefix that is unbound.

needsBindingback to summary
public final boolean needsBinding()
Returns:boolean

True if the name has no binding object, but will need one (has prefix)

sizeInQuadsback to summary
public abstract int sizeInQuads()
toStringback to summary
public final String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations
@Override
unboundEqualsback to summary
public final boolean unboundEquals(PName other)
unboundHashCodeback to summary
public final int unboundHashCode()