Module com.darkcollective.relix.value

Package com.darkcollective.relix.value.internal

Class ValuePath

java.lang.Object

com.darkcollective.relix.value.internal.ValuePath

public final class ValuePath
extends Object

Null-propagating navigation into nested Values — the runtime engine behind path access like user.name or items[0].price.

Navigation is optional-chaining: a missing field, an out-of-range index, or a step into a value of the wrong shape yields NullValue, never an error. This lets heterogeneous, schemaless documents be queried without crashing — matching Mongo / jq semantics.

The path syntax accepted by parse(String) is dotted field names with bracketed array indices: "a.b[0].c", "[2].name". This is the utility's own syntax; the query language's surface syntax for paths is a separate concern wired in later.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ValuePath.Step	A single navigation step: into a named struct field, or an array index.

Method Summary

Modifier and Type	Method	Description
static Value	navigate(Value root, String path)	Parses path and navigates root through it.
static Value	navigate(Value root, List<ValuePath.Step> steps)	Navigates root through steps, propagating NullValue on any miss.
static List<ValuePath.Step>	parse(String path)	Parses a path string into navigation steps.

Methods inherited from class java.lang.Object

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

Method Details

navigate

public static Value navigate(Value root,
 List<ValuePath.Step> steps)

Navigates root through steps, propagating NullValue on any miss.

Parameters:

root - the starting value; must not be null

steps - the steps to follow, in order; must not be null

Returns:

the value reached, or NullValue if any step misses

navigate

public static Value navigate(Value root,
 String path)

Parses path and navigates root through it.

Parameters:

root - the starting value; must not be null

path - a path like "user.name" or "items[0].price"

Returns:

the value reached, or NullValue if any step misses

parse

public static List<ValuePath.Step> parse(String path)

Parses a path string into navigation steps.

Parameters:

path - a path like "a.b[0].c"; empty/blank yields no steps

Returns:

the ordered steps

Throws:

IllegalArgumentException - if a [ is unterminated or an index is not an integer