Class LineToSourceSectionMap
- All Implemented Interfaces:
Probe.ProbeListener
LineLocation
(a line number in a specific piece of Source
code) to
a collection of SourceSection
s that exist on that line. This class assumes that all nodes
are instrumented as it uses the Probe.ProbeListener
interface to determine the source sections
that exist in the file.-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected void
addSourceSectionToLine
(LineLocation line, SourceSection sourceSection) Adds a source section to the given line.void
endASTProbing
(Source source) Notifies that the application of all registeredASTProber
s to a newly constructed AST has completed.Returns a collection ofSourceSection
s at the givenLineLocation
, an empty list if none.getSourceSectionsAtLineNumber
(int lineNumber) Convenience method to get source sections according to a int line number.void
newProbeInserted
(Probe probe) Notifies that aProbe
has been newly attached to an AST viaProbeNode.Instrumentable.probe()
.void
probeTaggedAs
(Probe probe, SyntaxTag tag, Object tagValue) Notifies that aSyntaxTag
has been newly added to the set of tags associated with aProbe
viaProbe.tagAs(SyntaxTag, Object)
.void
startASTProbing
(Source source) Notifies that all registeredASTProber
s are about to be applied to a newly constructed AST.
-
Constructor Details
-
LineToSourceSectionMap
public LineToSourceSectionMap()
-
-
Method Details
-
startASTProbing
Description copied from interface:Probe.ProbeListener
Notifies that all registeredASTProber
s are about to be applied to a newly constructed AST.- Specified by:
startASTProbing
in interfaceProbe.ProbeListener
- Parameters:
source
- source code from which the AST was constructed
-
newProbeInserted
Description copied from interface:Probe.ProbeListener
Notifies that aProbe
has been newly attached to an AST viaProbeNode.Instrumentable.probe()
.There can be no more than one
Probe
at a node; this notification will only be delivered the first time probe() is called at a particular AST node. There will also be no notification when the AST to which the Probe is attached is cloned.- Specified by:
newProbeInserted
in interfaceProbe.ProbeListener
-
probeTaggedAs
Description copied from interface:Probe.ProbeListener
Notifies that aSyntaxTag
has been newly added to the set of tags associated with aProbe
viaProbe.tagAs(SyntaxTag, Object)
.The tags at a
Probe
are a set; this notification will only be delivered the first time a particular tag is added at aProbe
.An optional value supplied with tagAs(SyntaxTag, Object) is reported to all listeners, but not stored. As a consequence, the optional value will have no effect at all if the tag had already been added.
- Specified by:
probeTaggedAs
in interfaceProbe.ProbeListener
- Parameters:
probe
- where a tag has been addedtag
- the tag that has been newly added (subsequent additions of the tag are unreported).tagValue
- an optional value associated with the tag for the purposes of reporting.
-
endASTProbing
Description copied from interface:Probe.ProbeListener
Notifies that the application of all registeredASTProber
s to a newly constructed AST has completed.- Specified by:
endASTProbing
in interfaceProbe.ProbeListener
- Parameters:
source
- source code from which the AST was constructed
-
addSourceSectionToLine
Adds a source section to the given line.If the line already exists in the internal
lineToSourceSectionsMap
, this source section will be added to the existing collection. If no line already exists in the internal map, then a new key is added along with a new collection containing the source section.This class does not check if a source section has already been added to a line.
- Parameters:
line
- TheLineLocation
to attach the source section to.sourceSection
- TheSourceSection
to attach for that line location.
-
getSourceSectionsAtLine
Returns a collection ofSourceSection
s at the givenLineLocation
, an empty list if none.- Parameters:
line
- The line to check.- Returns:
- the source sections at the given line.
-
getSourceSectionsAtLineNumber
Convenience method to get source sections according to a int line number. Returns a collection ofSourceSection
s at the given line number. If there are no source sections at that line, an empty list is returned.- Parameters:
lineNumber
- The line number to check.- Returns:
- A collection of source sections at the given line.
-