Module dev.metaschema.core

Package dev.metaschema.core.metapath.function.library

Class MapFind

java.lang.Object

dev.metaschema.core.metapath.function.library.MapFind

public final class MapFind
extends Object

Implements the XPath 3.1 map:find function.

Method Summary

Modifier and Type	Method	Description
static Stream<ICollectionValue>	find(IMapItem<?> item, IAnyAtomicItem key)	An implementation of XPath 3.1 map:find.
static Stream<ICollectionValue>	find(IItem item, IAnyAtomicItem key)	An implementation of XPath 3.1 map:find.
static Stream<ICollectionValue>	find(Collection<? extends IItem> items, IAnyAtomicItem key)	An implementation of XPath 3.1 map:find.

Methods inherited from class java.lang.Object

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

Method Details

find

@NonNull
public static Stream<ICollectionValue> find(@NonNull
 Collection<? extends IItem> items,
 @NonNull
 IAnyAtomicItem key)

An implementation of XPath 3.1 map:find.

Parameters:

items - the item sequence to search for key matches

key - the key for the item to retrieve

Returns:

the retrieved item

find

@NonNull
public static Stream<ICollectionValue> find(@NonNull
 IItem item,
 @NonNull
 IAnyAtomicItem key)

An implementation of XPath 3.1 map:find.

Parameters:

item - the item to search for key matches

key - the key for the item to retrieve

Returns:

the retrieved item

find

@NonNull
public static Stream<ICollectionValue> find(@NonNull
 IMapItem<?> item,
 @NonNull
 IAnyAtomicItem key)

An implementation of XPath 3.1 map:find.

This is a specialized method for processing an item that is a map item, which can be searched for a key in a much more efficient way.

Parameters:

item - the item to search for key matches

key - the key for the item to retrieve

Returns:

the retrieved item