Package net.sf.saxon.ma.map

Class SingleEntryMap

java.lang.Object

net.sf.saxon.ma.MapOrArray

net.sf.saxon.ma.map.MapItem

net.sf.saxon.ma.map.SingleEntryMap

All Implemented Interfaces:

Callable, FunctionItem, GroundedValue, Item, Sequence

public class SingleEntryMap
extends MapItem

A map comprising a single key-value pair.

Nested Class Summary

Nested classes/interfaces inherited from class net.sf.saxon.ma.map.MapItem

MapItem.KeyIterator

Field Summary

Fields inherited from class net.sf.saxon.ma.map.MapItem

mapConstructorDuplicatesAction, xslMapDuplicatesAction, xslRecordDuplicatesAction

Constructor Summary

Constructors

Constructor	Description
SingleEntryMap(AtomicValue key, GroundedValue value, int specVersion)

Method Summary

Modifier and Type	Method	Description
boolean	conforms(PlainType keyType, SequenceType valueType)	Ask whether the map conforms to a given map type
GroundedValue	get(AtomicValue key)	Get an entry from the Map
ItemType	getItemType(TypeHierarchy th)	Get the type of the map.
AtomicValue	getKey()	Get the key
GroundedValue	getValue()	Get the value
boolean	isEmpty()	Ask whether the map is empty
AtomicIterator	keys()	Get the set of all key values in the map.
Iterable<KeyValuePair>	keyValuePairs()	Get the set of all key-value pairs in the map
MapItem	put(AtomicValue key, GroundedValue value)	Create a new map containing the existing entries in the map plus an additional entry, without modifying the original.
MapItem	remove(AtomicValue key)	Remove an entry from the map
int	size()	Get the size of the map
String	toString()

Methods inherited from class net.sf.saxon.ma.map.MapItem

atomize, call, deepEqual40, deepEquals, effectiveBooleanValue, entries, export, followingKeyValuePairs, getAnnotations, getArity, getDescription, getFunctionItemType, getFunctionName, getGenre, getItemTypeOfSequence, getOperandRoles, getSpecVersion, getTypedValue, getU, getUnicodeStringValue, getWithPlan, isArray, isKnownToConform, isMap, isTrustedResultType, itemAt, makeNewContext, mapToString, precedingKeyValuePairs, setSpecVersion, toShortString

Methods inherited from class net.sf.saxon.ma.MapOrArray

obtainRootJNode

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.sf.saxon.om.FunctionItem

isSequenceVariadic

Methods inherited from interface net.sf.saxon.om.GroundedValue

asIterable, concatenate, containsNode, materialize

Methods inherited from interface net.sf.saxon.om.Item

getLabel, getLength, getStringValue, head, isStreamed, iterate, reduce, subsequence

Methods inherited from interface net.sf.saxon.om.Sequence

makeRepeatable

Constructor Details

SingleEntryMap

public SingleEntryMap(AtomicValue key,
 GroundedValue value,
 int specVersion)

Method Details

getKey

public AtomicValue getKey()

Get the key

Returns:

the key (of the single entry in this map)

getValue

public GroundedValue getValue()

Get the value

Returns:

the value (of the single entry in this map)

get

public GroundedValue get(AtomicValue key)

Get an entry from the Map

Specified by:

get in class MapItem

Parameters:

key - the value of the key

Returns:

the value associated with the given key, or null if the key is not present in the map.

size

public int size()

Get the size of the map

Specified by:

size in class MapItem

Returns:

the number of keys/entries present in this map

isEmpty

public boolean isEmpty()

Ask whether the map is empty

Overrides:

isEmpty in class MapItem

Returns:

true if and only if the size of the map is zero

keys

public AtomicIterator keys()

Get the set of all key values in the map.

Overrides:

keys in class MapItem

Returns:

a set containing all the key values present in the map, in unpredictable order

keyValuePairs

public Iterable<KeyValuePair> keyValuePairs()

Get the set of all key-value pairs in the map

Specified by:

keyValuePairs in class MapItem

Returns:

an iterable containing all the key-value pairs

put

public MapItem put(AtomicValue key,
 GroundedValue value)

Create a new map containing the existing entries in the map plus an additional entry, without modifying the original. If there is already an entry with the specified key, this entry is replaced by the new entry.

Specified by:

put in class MapItem

Parameters:

key - the key of the new entry

value - the value associated with the new entry

Returns:

the new map containing the additional entry

remove

public MapItem remove(AtomicValue key)

Remove an entry from the map

Specified by:

remove in class MapItem

Parameters:

key - the key of the entry to be removed

Returns:

a new map in which the requested entry has been removed; or this map unchanged if the specified key was not present

conforms

public boolean conforms(PlainType keyType,
 SequenceType valueType)

Ask whether the map conforms to a given map type

Overrides:

conforms in class MapItem

Parameters:

keyType - the required keyType

valueType - the required valueType

Returns:

true if the map conforms to the required type

getItemType

public ItemType getItemType(TypeHierarchy th)

Get the type of the map. This method is used largely for diagnostics, to report the type of a map when it differs from the required type.

Overrides:

getItemType in class MapItem

Parameters:

th - the type hierarchy cache

Returns:

the type of this map

toString

public String toString()

Overrides:

toString in class Object