org.jboss.dna.graph.properties.basic
Class BasicNamespaceRegistry

java.lang.Object
  org.jboss.dna.graph.properties.basic.BasicNamespaceRegistry

All Implemented Interfaces:

NamespaceRegistry

@ThreadSafe
public class BasicNamespaceRegistry
extends Object
implements NamespaceRegistry

Author:

Randall Hauch

Field Summary

static String	DEFAULT_NAMESPACE_URI
static String	DEFAULT_PREFIX_NUMBER_FORMAT
static String	DEFAULT_PREFIX_TEMPLATE

Constructor Summary

BasicNamespaceRegistry()

BasicNamespaceRegistry(String defaultNamespaceUri)

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	getGeneratedPrefixTemplate()
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.
void	setGeneratedPrefixTemplate(String prefixTemplate)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_NAMESPACE_URI

public static final String DEFAULT_NAMESPACE_URI

See Also:

Constant Field Values

DEFAULT_PREFIX_TEMPLATE

public static final String DEFAULT_PREFIX_TEMPLATE

See Also:

Constant Field Values

DEFAULT_PREFIX_NUMBER_FORMAT

public static final String DEFAULT_PREFIX_NUMBER_FORMAT

See Also:

Constant Field Values

Constructor Detail

BasicNamespaceRegistry

public BasicNamespaceRegistry()

BasicNamespaceRegistry

public BasicNamespaceRegistry(String defaultNamespaceUri)

Parameters:

defaultNamespaceUri - the namespace URI to use for the default prefix

Method Detail

getGeneratedPrefixTemplate

public String getGeneratedPrefixTemplate()

Returns:

prefixTemplate

setGeneratedPrefixTemplate

public void setGeneratedPrefixTemplate(String prefixTemplate)

Parameters:

prefixTemplate - Sets prefixTemplate to the specified value.

getNamespaceForPrefix

public String getNamespaceForPrefix(String prefix)

Get the namespace URI for the supplied prefix.

Specified by:

getNamespaceForPrefix in interface NamespaceRegistry

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

getPrefixForNamespaceUri

public String getPrefixForNamespaceUri(String namespaceUri,
                                       boolean generateIfMissing)

Return the prefix used for the supplied namespace URI.

Specified by:

getPrefixForNamespaceUri in interface NamespaceRegistry

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

See Also:

NamespaceRegistry.isRegisteredNamespaceUri(String)

isRegisteredNamespaceUri

public boolean isRegisteredNamespaceUri(String namespaceUri)

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

Specified by:

isRegisteredNamespaceUri in interface NamespaceRegistry

Parameters:

namespaceUri - the namespace URI

Returns:

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

getDefaultNamespaceUri

public String getDefaultNamespaceUri()

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

Specified by:

getDefaultNamespaceUri in interface NamespaceRegistry

Returns:

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

register

public String register(String prefix,
                       String namespaceUri)

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

Specified by:

register in interface NamespaceRegistry

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

getRegisteredNamespaceUris

public Set<String> getRegisteredNamespaceUris()

Obtain the set of namespaces that are registered.

Specified by:

getRegisteredNamespaceUris in interface NamespaceRegistry

Returns:

the set of