neureka

Interface Nda.Item<V>

Type Parameters:

V - The type of the items of this nd-array.

All Known Subinterfaces:

MutateNda.Item<V>

Enclosing interface:

Nda<V>

public static interface Nda.Item<V>

Instances of this are being returned by the Nda.at(int...) method, and they allow you to get individual nd-array items

Method Summary

Modifier and Type	Method and Description
default boolean	doesNotExist()
default boolean	exists()
default V	get() Get the value at the targeted position or throw an exception if the item does not exist.
default java.util.Optional<V>	map(java.util.function.Function<V,V> mapper) Maps this item to an optional value based on the provided lambda.
default V	orElse(V defaultValue) Get the value at the targeted position or return the provided default value if the item does not exist.
V	orElseNull() Get the value at the targeted position or return null if the item does not exist.
default java.util.Optional<V>	toOptional() Converts this item into an optional value.

Method Detail

get

default V get()

Get the value at the targeted position or throw an exception if the item does not exist.

Returns:

The value at the targeted position.

orElse

default V orElse(V defaultValue)

Get the value at the targeted position or return the provided default value if the item does not exist.

Parameters:

defaultValue - The default value to return if the item does not exist.

Returns:

The value at the targeted position or the provided default value.

Throws:

java.lang.IllegalArgumentException - If the provided default value is null.

orElseNull

V orElseNull()

Get the value at the targeted position or return null if the item does not exist.

Returns:

The value at the targeted position or null.

toOptional

default java.util.Optional<V> toOptional()

Converts this item into an optional value. If the item exists, the resulting optional will contain the value. Otherwise, the resulting optional will be empty.

Returns:

An optional value.

map

default java.util.Optional<V> map(java.util.function.Function<V,V> mapper)

Maps this item to an optional value based on the provided lambda. The lambda will be executed if the item exists. If the lambda returns null the resulting optional will be empty. Otherwise, the resulting optional will contain the value returned by the lambda.

Parameters:

mapper - The lambda which maps the item to an optional value.

Returns:

An optional value based on the provided lambda.

exists

default boolean exists()

Returns:

true if the item exists, false otherwise.

doesNotExist

default boolean doesNotExist()

Returns:

true if the item does not exist, false otherwise.