Nested and Inner Type Summary

Modifier and Type	Class and Description
private static class	Namespace.NamespaceSerializationProxy

Field Summary

Modifier and Type	Field and Description
private static final ConcurrentMap<String, ConcurrentMap<String, Namespace>>	namespacemap Factory list of namespaces.
public static final Namespace	NO_NAMESPACE Define a `Namespace` for when not in a namespace
private final transient String	prefix The prefix mapped to this namespace
private static final long	serialVersionUID JDOM 2.0.0 Serialization version
private final transient String	uri The URI for this namespace
public static final Namespace	XML_NAMESPACE Define a `Namespace` for the standard xml prefix.
private static final Namespace	XMLNS_NAMESPACE

Constructor Summary

Access	Constructor and Description
private	Namespace(final String `String` prefix to map to this namespace. prefix, final String `String` URI for namespace. uri) This constructor handles creation of a `Namespace` object with a prefix and URI; it is intentionally left `private` so that it cannot be invoked by external programs/code.

Method Summary

Modifier and Type	Method and Description
public boolean	Returns: `boolean` - whether the supplied object is equal to this `Namespace`. equals(final Object `Object` to compare to this `Namespace`. ob) Overrides java.lang.Object.equals. This tests for equality - Two `Namespaces` are equal if and only if their URIs are byte-for-byte equals.
public static Namespace	Returns: `Namespace` - ready to use namespace. getNamespace(final String `String` prefix to map to `Namespace`. prefix, final String `String` URI of new `Namespace`. uri) This will retrieve (if in existence) or create (if not) a `Namespace` for the supplied prefix and uri.
public static Namespace	Returns: `Namespace` - ready to use namespace. getNamespace(final String `String` URI of new `Namespace`. uri) 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.
public String	Returns: `String` - prefix for this `Namespace`. getPrefix() This returns the prefix mapped to this `Namespace`.
public String	Returns: `String` - URI for this `Namespace`. getURI() This returns the namespace URI for this `Namespace`.
public int	Returns: `int` - hash code for this `Namespace`. hashCode() Overrides java.lang.Object.hashCode. This returns the hash code for the `Namespace` that conforms to the 'equals()' contract.
private Object	Returns: nothing. readResolve() Because Namespace is serialized by proxy, the reading of direct Namespace instances is illegal and prohibited.
public String	Returns: `String` - information about this instance. toString() Overrides java.lang.Object.toString. This returns a `String` representation of this `Namespace`, suitable for use in debugging.
private Object	Returns: the Namespace proxy instance. writeReplace() Serializes Namespace by using a proxy serialization instance.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

Field Detail

namespacemap	back to summary
private static final ConcurrentMap<String, ConcurrentMap<String, Namespace>> namespacemap Factory list of namespaces. Keys are URI&prefix. Values are Namespace objects

NO_NAMESPACE	back to summary
public static final Namespace NO_NAMESPACE Define a `Namespace` for when not in a namespace

prefix	back to summary
private final transient String prefix The prefix mapped to this namespace

serialVersionUID	back to summary
private static final long serialVersionUID JDOM 2.0.0 Serialization version

uri	back to summary
private final transient String uri The URI for this namespace

XML_NAMESPACE	back to summary
public static final Namespace XML_NAMESPACE Define a `Namespace` for the standard xml prefix.

XMLNS_NAMESPACE	back to summary
private static final Namespace XMLNS_NAMESPACE

Constructor Detail

Namespace back to summary

Namespace	back to summary
private Namespace(final String prefix, final String uri) This constructor handles creation of a `Namespace` object with a prefix and URI; it is intentionally left `private` so that it cannot be invoked by external programs/code. Parameters prefix:String `String` prefix to map to this namespace. uri:String `String` URI for namespace.

private Namespace(final String prefix, final String uri)

This constructor handles creation of a Namespace object with a prefix and URI; it is intentionally left private so that it cannot be invoked by external programs/code.

Parameters

prefix:String: String prefix to map to this namespace.
uri:String: String URI for namespace.

Method Detail

equals back to summary

equals	back to summary
public boolean equals(final Object ob) Overrides java.lang.Object.equals. This tests for equality - Two `Namespaces` are equal if and only if their URIs are byte-for-byte equals. Parameters ob:Object `Object` to compare to this `Namespace`. Returns:boolean `boolean` - whether the supplied object is equal to this `Namespace`. Annotations @Override

public boolean equals(final Object ob)

Overrides java.lang.Object.equals.

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

Parameters

ob:Object: Object to compare to this Namespace.

Returns:boolean

boolean - whether the supplied object is equal to this Namespace.

Annotations

@Override

getNamespace back to summary

getNamespace	back to summary
public static Namespace getNamespace(final String prefix, final String uri) This will retrieve (if in existence) or create (if not) a `Namespace` for the supplied prefix and uri. This method is thread-safe. Parameters prefix:String `String` prefix to map to `Namespace`. uri:String `String` URI of new `Namespace`. Returns:Namespace `Namespace` - ready to use namespace. Exceptions IllegalNameException: if the given prefix and uri make up an illegal namespace name. See Also `Verifier#checkNamespacePrefix(String)`, `Verifier#checkNamespaceURI(String)`

public static Namespace getNamespace(final String prefix, final String uri)

This will retrieve (if in existence) or create (if not) a Namespace for the supplied prefix and uri. This method is thread-safe.

Parameters

prefix:String: String prefix to map to Namespace.
uri:String: String URI of new Namespace.

Returns:Namespace

Namespace - ready to use namespace.

Exceptions

IllegalNameException:: if the given prefix and uri make up an illegal namespace name.

getNamespace back to summary

getNamespace	back to summary
public static Namespace getNamespace(final String uri) 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. This method is thread-safe. Parameters uri:String `String` URI of new `Namespace`. Returns:Namespace `Namespace` - ready to use namespace.

public static Namespace getNamespace(final String uri)

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. This method is thread-safe.

Parameters

uri:String: String URI of new Namespace.

Returns:Namespace

Namespace - ready to use namespace.

getPrefix back to summary

getPrefix	back to summary
public String getPrefix() This returns the prefix mapped to this `Namespace`. Returns:String `String` - prefix for this `Namespace`.

public String getPrefix()

This returns the prefix mapped to this Namespace.

Returns:String: String - prefix for this Namespace.

getURI back to summary

getURI	back to summary
public String getURI() This returns the namespace URI for this `Namespace`. Returns:String `String` - URI for this `Namespace`.

public String getURI()

This returns the namespace URI for this Namespace.

Returns:String: String - URI for this Namespace.

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. This returns the hash code for the `Namespace` that conforms to the 'equals()' contract. If two namespaces have the same URI, they are equal and have the same hash code, even if they have different prefixes. Returns:int `int` - hash code for this `Namespace`. Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

This returns the hash code for the Namespace that conforms to the 'equals()' contract.

If two namespaces have the same URI, they are equal and have the same hash code, even if they have different prefixes.

Returns:int

int - hash code for this Namespace.

Annotations

@Override

readResolve	back to summary
private Object readResolve() throws InvalidObjectException Because Namespace is serialized by proxy, the reading of direct Namespace instances is illegal and prohibited. Returns:Object nothing. Exceptions InvalidObjectException: always

readResolve

back to summary

private Object readResolve() throws InvalidObjectException

Because Namespace is serialized by proxy, the reading of direct Namespace instances is illegal and prohibited.

Returns:Object

nothing.

Exceptions

InvalidObjectException:: always

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. This returns a `String` representation of this `Namespace`, suitable for use in debugging. Returns:String `String` - information about this instance. Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

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

Returns:String

String - information about this instance.

Annotations

@Override

writeReplace	back to summary
private Object writeReplace() Serializes Namespace by using a proxy serialization instance. Returns:Object the Namespace proxy instance. Serial data The proxy deals with the protocol.

writeReplace

back to summary

private Object writeReplace()

Serializes Namespace by using a proxy serialization instance.

Returns:Object: the Namespace proxy instance.
Serial data: The proxy deals with the protocol.

org.jdom2 back to summary

private final Class Namespace.NamespaceSerializationProxy

Class Inheritance

extends Object
implements Serializable

java.lang.Object
org.jdom2.Namespace.NamespaceSerializationProxy

All Implemented Interfaces

java.io.Serializable

Field Summary

Modifier and Type	Field and Description
private final String	pprefix
private final String	puri
private static final long	serialVersionUID

Constructor Summary

Access	Constructor and Description
public	NamespaceSerializationProxy(String pprefix, String puri)

Method Summary

Modifier and Type	Method and Description
private Object	readResolve()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

pprefix	back to summary
private final String pprefix

puri	back to summary
private final String puri

serialVersionUID	back to summary
private static final long serialVersionUID

Constructor Detail

NamespaceSerializationProxy	back to summary
public NamespaceSerializationProxy(String pprefix, String puri)

Method Detail

readResolve	back to summary
private Object readResolve()

public final Class Namespace

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class Namespace.NamespaceSerializationProxy

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail