org.hawkular.inventory.paths

Class Path.HintedTypeProvider

java.lang.Object

org.hawkular.inventory.paths.Path.StructuredDataHintingTypeProvider

org.hawkular.inventory.paths.Path.HintedTypeProvider

All Implemented Interfaces:

Path.TypeProvider

Enclosing class:

Path

public static class Path.HintedTypeProvider
extends Path.StructuredDataHintingTypeProvider

This is a type provider (Path.TypeProvider) implementation that tries to deduce the types on the path based on the current position and the intended type of the final segment of the path.

Constructor Summary

Constructors

Constructor and Description
HintedTypeProvider(SegmentType intendedFinalType, Path.Extender extender) Constructs a new instance.

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

HintedTypeProvider

public HintedTypeProvider(SegmentType intendedFinalType,
                          Path.Extender extender)

Constructs a new instance.

Parameters:

intendedFinalType - the anticipated type of the final segment

extender - an initial path

Method Detail

segmentParsed

public void segmentParsed(Path.Segment segment)

Description copied from interface: Path.TypeProvider

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.

Specified by:

segmentParsed in interface Path.TypeProvider

Overrides:

segmentParsed in class Path.StructuredDataHintingTypeProvider

Parameters:

segment - the segment parsed

deduceSegment

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

Description copied from interface: Path.TypeProvider

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.

Specified by:

deduceSegment in interface Path.TypeProvider

Overrides:

deduceSegment in class Path.StructuredDataHintingTypeProvider

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

public void finished()

Description copied from interface: Path.TypeProvider

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

Specified by:

finished in interface Path.TypeProvider

Overrides:

finished in class Path.StructuredDataHintingTypeProvider