com.marklogic.client.util

Interface NameMap<V>

Type Parameters:

V - the type for the values stored in the map

All Superinterfaces:

Map<QName,V>

All Known Subinterfaces:

DocumentMetadataHandle.DocumentProperties, RuleDefinition.RuleMetadata

public interface NameMap<V>
extends Map<QName,V>

A NameMap defines the interface for maps where the key is a QName (a name qualified by a URI for global uniqueness or for association with a domain).

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Method Summary

Modifier and Type	Method and Description
boolean	containsKey(String name) Whether the map contains the string name as a key.
<T> T	get(QName name, Class<T> as) Returns the value of the QName, cast to the supplied type.
V	get(String name) Returns the value of the string name.
<T> T	get(String name, Class<T> as) Returns the value of the string name, cast to the supplied type.
NamespaceContext	getNamespaceContext() Returns the namespace context (if any) that declares the namespace bindings used to convert prefixed string names into QNames.
V	put(String name, V value) Specifies the value of the string name.
V	remove(String name) Removes the key-value pair from the map.
void	setNamespaceContext(NamespaceContext context) Specifies a namespace context that declares the namespace bindings used to convert prefixed string names into QNames.

Methods inherited from interface java.util.Map

clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Method Detail

getNamespaceContext

NamespaceContext getNamespaceContext()

Returns the namespace context (if any) that declares the namespace bindings used to convert prefixed string names into QNames.

Returns:

the namespace context (if any)

setNamespaceContext

void setNamespaceContext(NamespaceContext context)

Specifies a namespace context that declares the namespace bindings used to convert prefixed string names into QNames.

Parameters:

context - the namespace context (if any)

containsKey

boolean containsKey(String name)

Whether the map contains the string name as a key.

Parameters:

name - the key expressed as a string

Returns:

true if the map contains a QName equivalent to the key

get

V get(String name)

Returns the value of the string name.

Parameters:

name - the key expressed as a string

Returns:

the value of the key or null if the key doesn't exist in the map

get

<T> T get(QName name,
          Class<T> as)

Returns the value of the QName, cast to the supplied type.

Type Parameters:

T - the type for the value

Parameters:

name - the key

as - the type for the value

Returns:

the value cast to the type

get

<T> T get(String name,
          Class<T> as)

Returns the value of the string name, cast to the supplied type.

Type Parameters:

T - the type for the value

Parameters:

name - the key expressed as a string

as - the type for the value

Returns:

the value cast to the type

put

V put(String name,
      V value)

Specifies the value of the string name.

Parameters:

name - the key expressed as a string

value - the value of the key

Returns:

the previous value or null if the key did not have a value

remove

V remove(String name)

Removes the key-value pair from the map.

Parameters:

name - the key expressed as a string

Returns:

the previous value or null if the key did not have a value