com.ibm.designer.domino.xsp.api.util
Class XPagesKey

java.lang.Object
  com.ibm.designer.domino.xsp.api.util.XPagesKey

public class XPagesKey
extends java.lang.Object

An object that can be used to encapsulate data about an XPage control. The key if created properly will at all times be unique amongst XPage controls as the namespace URI and tag name should make a unique combination.

Constructor Summary

XPagesKey(org.w3c.dom.Node node)
Creates a new instance of this class based on the given node

XPagesKey(java.lang.String namespaceURI, java.lang.String tagName)
Creates a new instance of this class based on the given tag name and namespace.

Method Summary

boolean	equals(java.lang.Object obj)
java.lang.String	getNamespaceUri() Returns the namespace uri.
XPagesKey	getParent(FacesRegistry registry) Convienance method to cache and return the XPagesKey of this XSP item's parent.
java.lang.String	getTagName() Returns the tag name
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

XPagesKey

public XPagesKey(org.w3c.dom.Node node)

Creates a new instance of this class based on the given node

Parameters:

node - a node from which to extract a namespace uri and tag name

XPagesKey

public XPagesKey(java.lang.String namespaceURI,
                 java.lang.String tagName)

Creates a new instance of this class based on the given tag name and namespace.

Parameters:

namespaceURI - the namespace URI for the given tag

tagName - the XML tag local name

Method Detail

getNamespaceUri

public java.lang.String getNamespaceUri()

Returns the namespace uri.

Returns:

getTagName

public java.lang.String getTagName()

Returns the tag name

Returns:

getParent

public XPagesKey getParent(FacesRegistry registry)

Convienance method to cache and return the XPagesKey of this XSP item's parent. Caches the value. You may pass in null for a registry if you believe the key has been cached by some benevolent code.

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object