org.hawkular.inventory.paths

Interface Path.TypeProvider

All Known Implementing Classes:

Path.HintedTypeProvider, Path.StructuredDataHintingTypeProvider

Enclosing class:

Path

public static interface Path.TypeProvider

An interface that is used to help parsing partially untyped path strings.

Method Summary

Modifier and Type	Method and Description
Path.Segment	deduceSegment(String type, String id, boolean isLast) This is called during parsing of a single segment when the built-in defaults cannot determine the type and id to use for segment.
void	finished() Called when the parsing of the path finishes (either successfully or unsuccessfully).
void	segmentParsed(Path.Segment segment) This method gets called during the parsing process after a segment is successfully parsed.

Method Detail

segmentParsed

void segmentParsed(Path.Segment segment)

This method gets called during the parsing process after a segment is successfully parsed. This enables the type provider to keep track of the progress of the parsing.

Parameters:

segment - the segment parsed

deduceSegment

Path.Segment deduceSegment(String type,
                           String id,
                           boolean isLast)

This is called during parsing of a single segment when the built-in defaults cannot determine the type and id to use for segment.

If this method returns null, the parsing of the path will fail with an IllegalArgumentException.

Parameters:

type - the parsed type name

id - the parsed id

isLast - true if the parsed segment is the last in the path

Returns:

the segment based on the provided info or null if the type provider cannot deduce one.

finished

void finished()

Called when the parsing of the path finishes (either successfully or unsuccessfully).