Module dev.metaschema.core

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

Class ArrayPut

java.lang.Object

dev.metaschema.core.metapath.function.library.ArrayPut

public final class ArrayPut
extends Object

Implements the XPath 3.1 array:put function.

Method Summary

Modifier and Type	Method	Description
static <T extends ICollectionValue> IArrayItem<T>	put(IArrayItem<T> array, int position, T member)	An implementation of XPath 3.1 array:put.
static <T extends ICollectionValue> IArrayItem<T>	put(IArrayItem<T> array, IIntegerItem positionItem, T member)	An implementation of XPath 3.1 array:put.

Methods inherited from class java.lang.Object

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

Method Details

put

@NonNull
public static <T extends ICollectionValue>
IArrayItem<T> put(@NonNull
 IArrayItem<T> array,
 @NonNull
 IIntegerItem positionItem,
 @NonNull
 T member)

An implementation of XPath 3.1 array:put.

Type Parameters:

T - the type of items in the given Metapath array

Parameters:

array - the target Metapath array

positionItem - the integer position of the item to replace

member - the Metapath item to replace the identified array member with

Returns:

a new array containing the modification

Throws:

NegativeLengthArrayMetapathException - if the position is negative

IndexOutOfBoundsArrayMetapathException - if the position is not in the range of 1 to array:size

put

@NonNull
public static <T extends ICollectionValue>
IArrayItem<T> put(@NonNull
 IArrayItem<T> array,
 int position,
 @NonNull
 T member)

An implementation of XPath 3.1 array:put.

Type Parameters:

T - the type of items in the given Metapath array

Parameters:

array - the target Metapath array

position - the integer position of the item to replace

member - the Metapath item to replace the identified array member with

Returns:

a new array containing the modification

Throws:

NegativeLengthArrayMetapathException - if the position is negative

IndexOutOfBoundsArrayMetapathException - if the position is not in the range of 1 to array:size