net.sf.mmm.util.query.api.path

Interface Path<V>

Type Parameters:

V - the generic type of the property value identified by this path.

All Superinterfaces:

Argument<V>, AttributeReadName, AttributeReadValue<V>, PathFactory, PropertyPath<V>

All Known Subinterfaces:

BooleanPath, CollectionPath<V,E>, ComparablePath<V>, EntityBeanPath<V>, ListPath<E>, MapPath<K,V>, NumberPath<V>, SetPath<E>, StringPath

All Known Implementing Classes:

BooleanPathImpl, CollectionPathImpl, ComparablePathImpl, EntityBeanPathImpl, ListPathImpl, MapPathImpl, NumberPathImpl, PathImpl, SetPathImpl, StringPathImpl

public interface Path<V>
extends PathFactory, PropertyPath<V>, Argument<V>

This is the interface for a typed path build by the properties to traverse.

Since:

8.0.0

Author:

hohwille

See Also:

Alias, PathFactory

Method Summary

Modifier and Type	Method and Description
void	format(Function<AttributeReadName,String> segmentFormatter, StringBuilder buffer)
default String	getName()
PathRoot<?>	getRoot()

Methods inherited from interface net.sf.mmm.util.query.api.path.PathFactory

to, to, to, to, to, to, to, to

Methods inherited from interface net.sf.mmm.util.lang.api.attribute.AttributeReadValue

getValue

Methods inherited from interface net.sf.mmm.util.query.api.argument.Argument

eq, eq, evaluate, getValue, getValuePath, in, in, isConstant, isNotNull, isNull, neq, neq, notIn, notIn

Method Detail

getName

default String getName()

Specified by:

getName in interface AttributeReadName

Specified by:

getName in interface PropertyPath<V>

Returns:

this entire Path as String (e.g. "alias.property", "size(alias.children)", or "$variable.link.property").

format

void format(Function<AttributeReadName,String> segmentFormatter,
            StringBuilder buffer)

Parameters:

segmentFormatter - a Function used to format a segment of this Path to its String representation. This formatter will receive instances of PathRoot or ReadableProperty.

buffer - the StringBuilder where to append the resulting String representation of this Path.

See Also:

getName()

getRoot

PathRoot<?> getRoot()

Returns:

the root of this Path. Will e.g. be an Alias or a Variable and NOT an instance of Path.