org.jboss.dna.graph.properties
Interface NamespaceRegistry

All Known Implementing Classes:

BasicNamespaceRegistry, JcrNamespaceRegistry

@ThreadSafe
public interface NamespaceRegistry

Registry of namespaces, which are used to provide isolated and independent domains for names.

Author:

Randall Hauch

Method Summary

String	getDefaultNamespaceUri() Return the namespace URI that is currently mapped to the empty prefix, or null if there is no current default namespace.
String	getNamespaceForPrefix(String prefix) Get the namespace URI for the supplied prefix.
String	getPrefixForNamespaceUri(String namespaceUri, boolean generateIfMissing) Return the prefix used for the supplied namespace URI.
Set<String>	getRegisteredNamespaceUris() Obtain the set of namespaces that are registered.
boolean	isRegisteredNamespaceUri(String namespaceUri) Return whether there is a registered prefix for the supplied namespace URI.
String	register(String prefix, String namespaceUri) Register a new namespace using the supplied prefix, returning the namespace URI previously registered under that prefix.

Method Detail

getDefaultNamespaceUri

String getDefaultNamespaceUri()

Return the namespace URI that is currently mapped to the empty prefix, or null if there is no current default namespace.

Returns:

the namespace URI that represents the default namespace, or null if there is no default namespace

getNamespaceForPrefix

String getNamespaceForPrefix(String prefix)

Get the namespace URI for the supplied prefix.

Parameters:

prefix - the namespace prefix

Returns:

the namespace URI for the supplied prefix, or null if there is no namespace currently registered to use that prefix

Throws:

IllegalArgumentException - if the prefix is null

getPrefixForNamespaceUri

String getPrefixForNamespaceUri(String namespaceUri,
                                boolean generateIfMissing)

Return the prefix used for the supplied namespace URI.

Parameters:

namespaceUri - the namespace URI

generateIfMissing - true if the namespace URI has not already been registered and the method should auto-register the namespace with a generated prefix, or false if the method should never auto-register the namespace

Returns:

the prefix currently being used for the namespace, or null if the namespace has not been registered and generateIfMissing is false

Throws:

IllegalArgumentException - if the namespace URI is null

See Also:

isRegisteredNamespaceUri(String)

isRegisteredNamespaceUri

boolean isRegisteredNamespaceUri(String namespaceUri)

Return whether there is a registered prefix for the supplied namespace URI.

Parameters:

namespaceUri - the namespace URI

Returns:

true if the supplied namespace has been registered with a prefix, or false otherwise

Throws:

IllegalArgumentException - if the namespace URI is null

register

String register(String prefix,
                String namespaceUri)

Register a new namespace using the supplied prefix, returning the namespace URI previously registered under that prefix.

Parameters:

prefix - the prefix for the namespace, or null if a namesapce prefix should be generated automatically

namespaceUri - the namespace URI

Returns:

the namespace URI that was previously registered with the supplied prefix, or null if the prefix was not previously bound to a namespace URI

Throws:

IllegalArgumentException - if the namespace URI is null

getRegisteredNamespaceUris

Set<String> getRegisteredNamespaceUris()

Obtain the set of namespaces that are registered.

Returns:

the set of