DelegatingMapItem

java.lang.Object
- com.saxonica.xsltextn.pedigree.DelegatingMapItem

All Implemented Interfaces:

java.lang.Iterable<Function>, Callable, MapItem, Function, GroundedValue<Function>, Item<Function>, Sequence<Function>

Direct Known Subclasses:

PedigreeMapItem
```
public abstract class DelegatingMapItem
extends java.lang.Object
implements MapItem
```
A DelegatingMapItem is an abstract class representing a map that is implemented by delegating all map-related functionality to another map. Unless any methods are overridden, the functionality is identical to that of the wrapped map item.
Note that methods such as addEntry(net.sf.saxon.value.AtomicValue, net.sf.saxon.om.GroundedValue<?>) that create a new map will (unless overridden) simply delegate to the base map, and the new map will therefore not be a delegating map.

Constructor Summary

Constructors
Constructor and Description

DelegatingMapItem(MapItem base)
Create a DelegatingMapItem that delegates all map-related access to a specified base map.

Constructors
Constructor and Description
`DelegatingMapItem(MapItem base)` Create a `DelegatingMapItem` that delegates all map-related access to a specified base map.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`MapItem`	`addEntry(AtomicValue key, GroundedValue<?> value)` Create a new map containing the existing entries in the map plus an additional entry, without modifying the original.
`boolean`	`conforms(AtomicType keyType, SequenceType valueType, TypeHierarchy th)` Ask whether the map conforms to a given map type
`GroundedValue<?>`	`get(AtomicValue key)` Get an entry from the Map
`MapItem`	`getBaseItem()`
`MapType`	`getItemType(TypeHierarchy th)` Get the type of the map.
`UType`	`getKeyUType()` Get the lowest common item type of the keys in the map
`boolean`	`isEmpty()` Ask whether the map is empty
`AtomicIterator`	`keys()` Get the set of all key values in the map.
`java.lang.Iterable<KeyValuePair>`	`keyValuePairs()` Get the set of all key-value pairs in the map
`MapItem`	`remove(AtomicValue key)` Remove an entry from the map
`int`	`size()` Get the size of the map
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.sf.saxon.ma.map.MapItem
atomize, call, deepEquals, effectiveBooleanValue, export, getAnnotations, getArity, getDescription, getFunctionItemType, getFunctionName, getGenre, getItemTypeOfSequence, getOperandRoles, getStringValue, getStringValueCS, getTypedValue, isArray, isKnownToConform, isMap, isTrustedResultType, itemAt, makeNewContext, mapToString, toShortString

Methods inherited from interface net.sf.saxon.om.Function
argumentArray

Methods inherited from interface net.sf.saxon.om.Item
getLength, head, isStreamed, iterate, iterator, reduce, subsequence, toGroundedValue

Methods inherited from interface net.sf.saxon.om.GroundedValue
asIterable, materialize

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

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Constructor Detail
  - DelegatingMapItem
```
public DelegatingMapItem(MapItem base)
```
    Create a DelegatingMapItem that delegates all map-related access to a specified base map.
    
    Parameters:
    
    base - the map item to which this implementation delegates
- Method Detail
  - get
```
public GroundedValue<?> get(AtomicValue key)
```
    Description copied from interface: MapItem
    
    Get an entry from the Map
    
    Specified by:
    
    get in interface 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()
```
    Description copied from interface: MapItem
    
    Get the size of the map
    
    Specified by:
    
    size in interface MapItem
    
    Returns:
    
    the number of keys/entries present in this map
  - isEmpty
```
public boolean isEmpty()
```
    Description copied from interface: MapItem
    
    Ask whether the map is empty
    
    Specified by:
    
    isEmpty in interface MapItem
    
    Returns:
    
    true if and only if the size of the map is zero
  - keys
```
public AtomicIterator keys()
```
    Description copied from interface: MapItem
    
    Get the set of all key values in the map.
    
    Specified by:
    
    keys in interface MapItem
    
    Returns:
    
    a set containing all the key values present in the map, in unpredictable order
  - keyValuePairs
```
public java.lang.Iterable<KeyValuePair> keyValuePairs()
```
    Description copied from interface: MapItem
    
    Get the set of all key-value pairs in the map
    
    Specified by:
    
    keyValuePairs in interface MapItem
    
    Returns:
    
    an iterable containing all the key-value pairs
  - addEntry
```
public MapItem addEntry(AtomicValue key,
                        GroundedValue<?> value)
```
    Description copied from interface: MapItem
    
    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:
    
    addEntry in interface 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)
```
    Description copied from interface: MapItem
    
    Remove an entry from the map
    
    Specified by:
    
    remove in interface 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(AtomicType keyType,
                        SequenceType valueType,
                        TypeHierarchy th)
```
    Description copied from interface: MapItem
    
    Ask whether the map conforms to a given map type
    
    Specified by:
    
    conforms in interface MapItem
    
    Parameters:
    
    keyType - the required keyType
    
    valueType - the required valueType
    
    th - the type hierarchy cache for the configuration
    
    Returns:
    
    true if the map conforms to the required type
  - getItemType
```
public MapType getItemType(TypeHierarchy th)
```
    Description copied from interface: MapItem
    
    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.
    
    Specified by:
    
    getItemType in interface MapItem
    
    Returns:
    
    the type of this map
  - getKeyUType
```
public UType getKeyUType()
```
    Description copied from interface: MapItem
    
    Get the lowest common item type of the keys in the map
    
    Specified by:
    
    getKeyUType in interface MapItem
    
    Returns:
    
    the most specific type to which all the keys belong. If the map is empty, return UType.VOID
  - getBaseItem
```
public MapItem getBaseItem()
```
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class DelegatingMapItem

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

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

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

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

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

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

Methods inherited from interface java.lang.Iterable

Constructor Detail

DelegatingMapItem

Method Detail

get

size

isEmpty

keys

keyValuePairs

addEntry

remove

conforms

getItemType

getKeyUType

getBaseItem

toString