net.sf.mmm.util.pojo.path.api

Interface PojoPropertyPath

All Known Subinterfaces:

PojoPath, TypedPath<T>

All Known Implementing Classes:

AbstractPojoPathNavigator.CachingPojoPath, BasicPojoPath, TypedProperty

public interface PojoPropertyPath

A PojoPropertyPath represents a path to a simple property of a Pojo.

Since:

3.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field and Description
static char	SEPARATOR The character that separates the segments of a PojoPath.

Method Summary

Modifier and Type	Method and Description
String	getParentPath() This method gets the parent-path of this path.
String	getPojoPath() This method gets the actual Pojo path represented by this object.
String	getSegment() This method gets the last segment of this current Pojo path.

Field Detail

SEPARATOR

static final char SEPARATOR

The character that separates the segments of a PojoPath. The value ( 46 ) will never change. It is NOT necessary to use this constant to construct a PojoPropertyPath.

See Also:

Constant Field Values

Method Detail

getPojoPath

String getPojoPath()

This method gets the actual Pojo path represented by this object. As an example this method may return "foo.bar.property".

Returns:

the actual PojoPropertyPath.

getParentPath

String getParentPath()

This method gets the parent-path of this path.
E.g. if this path represents "foo.bar.property" then this method would return "foo.bar".

Returns:

the parent-path or null if this is the root-segment.

getSegment

String getSegment()

This method gets the last segment of this current Pojo path. E.g. if this path represents "foo.bar.property" then this method would return "property".

Returns:

the last segment.