Module io.github.mmm.value

Package io.github.mmm.value

Interface ReadablePath

All Known Subinterfaces:

PropertyPath<V>, TypedPropertyPath<V>, WritablePath

public interface ReadablePath

Interface to read a path().

Since:

1.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ReadablePath.PathBuilder	Interface for a builder to a path.

Method Summary

Modifier and Type	Method	Description
default ReadablePath	parentPath()
default String	path()	This method is not a regular getter to avoid conflicts with custom properties of beans implementing this interface.
default String	path(boolean fixed)
default void	path(ReadablePath.PathBuilder builder)
String	pathSegment()	This method is not a regular getter to avoid conflicts with custom properties of beans implementing this interface.

Method Details

pathSegment

String pathSegment()

This method is not a regular getter to avoid conflicts with custom properties of beans implementing this interface.

Returns:

the path-segment of this object. Should be a single property name (e.g. "MyProperty") or alias (e.g. "entity").

path

default String path()

This method is not a regular getter to avoid conflicts with custom properties of beans implementing this interface.

Returns:

the path of this object. May be a single property name (e.g. "MyProperty") or a dot-separated path (e.g. "MyEntity.MyProperty").

path

default String path(boolean fixed)

Parameters:

fixed - true to prefer static segments if available, false otherwise.

Returns:

the path of this object. May be a single property name (e.g. "MyProperty") or a dot-separated path (e.g. "MyEntity.MyProperty").

path

default void path(ReadablePath.PathBuilder builder)

Parameters:

builder - the ReadablePath.PathBuilder where to add the segments of all properties from the root (recursively via parentPath() to this object).

parentPath

default ReadablePath parentPath()

Returns:

the parent of this path or null if this is the root property that has no parent.