Main Page   Packages   Namespace List   Class Hierarchy   Compound List   Compound Members  

Namespace Class Reference

List of all members.

Public Methods

String getPrefix ()
String getURI ()
boolean equals (Object ob)
String toString ()
int hashCode ()

Static Public Methods

Namespace getNamespace (String prefix, String uri)
Namespace getNamespace (String uri)

Static Public Attributes

final Namespace NO_NAMESPACE = new Namespace("", "")
final Namespace XML_NAMESPACE

Detailed Description

Namespace defines both a factory for creating XML namespaces, and a namespace itself. This class represents an XML namespace in Java.

Elements and Attributes containing Namespaces can be serialized; however the Namespace class itself does not implement java.io.Serializable. This works because the Element and Attribute classes handle serialization of their Namespaces manually. The classes use the getNamespace() method on deserialization to ensure there may be only one unique Namespace object for any unique prefix/uri pair, something needed for efficiency reasons.

Author:
Brett McLaughlin , Elliotte Rusty Harold , Wesley Biggs
Version:
Revision:
1.30
,
Date:
2002/01/08 09:17:10


Member Function Documentation

boolean Namespace::equals Object    ob [inline]
 

This tests for equality - Two Namespaces are equal if and only if their URIs are byte-for-byte equals.

Parameters:
ob  Object to compare to this Namespace.
Returns:
boolean - whether the supplied object is equal to this Namespace.

Namespace Namespace::getNamespace String    uri [inline, static]
 

This will retrieve (if in existence) or create (if not) a Namespace for the supplied URI, and make it usable as a default namespace, as no prefix is supplied.

Parameters:
uri  String URI of new Namespace.
Returns:
Namespace - ready to use namespace.

Namespace Namespace::getNamespace String    prefix,
String    uri
[inline, static]
 

This will retrieve (if in existence) or create (if not) a Namespace for the supplied prefix and URI.

Parameters:
prefix  String prefix to map to Namespace.
uri  String URI of new Namespace.
Returns:
Namespace - ready to use namespace.
Exceptions:
IllegalNameException  if the given prefix and uri make up an invalid namespace name.

String Namespace::getPrefix   [inline]
 

This returns the prefix mapped to this Namespace.

Returns:
String - prefix for this Namespace.

String Namespace::getURI   [inline]
 

This returns the namespace URI for this Namespace.

Returns:
String - URI for this Namespace.

int Namespace::hashCode   [inline]
 

This returns a probably unique hash code for the Namespace. If two namespaces have the same URI, they are equal and have the same hash code, even if they have different prefixes.

Returns:
int - hash code for this Namespace.

String Namespace::toString   [inline]
 

This returns a String representation of this Namespace, suitable for use in debugging.

Returns:
String - information about this instance.


Member Data Documentation

final Namespace Namespace::NO_NAMESPACE = new Namespace("", "") [static]
 

Define a Namespace for when not in a namespace

final Namespace Namespace::XML_NAMESPACE [static]
 

Initial value:

 
        new Namespace("xml", "http://www.w3.org/XML/1998/namespace")


The documentation for this class was generated from the following file:
Generated on Sat Mar 30 18:53:03 2002 for JDOM by doxygen1.2.12 written by Dimitri van Heesch, © 1997-2001