Package org.checkerframework.afu.annotator.find

Class Insertions

java.lang.Object

org.checkerframework.afu.annotator.find.Insertions

All Implemented Interfaces:

Iterable<Insertion>

public class Insertions
extends Object
implements Iterable<Insertion>

A collection of Insertions, indexed by outer class and inner class. It has methods to select Insertions for a given class (forClass(com.sun.source.tree.CompilationUnitTree, java.lang.String)) or for an outer class along with its local classes (forOuterClass(com.sun.source.tree.CompilationUnitTree, java.lang.String)). When a single JAIF stores annotations for many source files, this class reduces the number of insertions to be considered for any AST node.

The class now serves a second purpose, which should probably be separated out: It attaches ASTPath-based inner type Insertions to a TypedInsertion on the outer type if one exists (see organizeTypedInsertions(CompilationUnitTree, String, Collection). Since getting these insertions right depends on this organization, this class is now essential for correctness, not merely for performance.

Constructor Summary

Constructors

Constructor	Description
Insertions()

Method Summary

Modifier and Type	Method	Description
void	add(Insertion ins)	Add an Insertion to this collection.
void	addAll(Collection<? extends Insertion> c)	Add all the given Insertions to this collection.
Set<Insertion>	forClass(CompilationUnitTree cut, String qualifiedClassName)	Selects Insertions relevant to a given class.
Set<Insertion>	forOuterClass(CompilationUnitTree cut, String qualifiedOuterClassName)	Selects Insertions relevant to a given outer class and its local classes.
Iterator<Insertion>	iterator()
int	size()	Returns the number of Insertions in this collection.
List<Insertion>	toList()	Returns a List containing all Insertions in this collection.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Details

Insertions

public Insertions()

Method Details

forClass

public Set<Insertion> forClass(CompilationUnitTree cut,
 String qualifiedClassName)

Selects Insertions relevant to a given class.

Parameters:

cut - the current compilation unit

qualifiedClassName - the fully qualified class name

Returns:

Set of Insertions with an InClassCriterion for the given class

forOuterClass

public Set<Insertion> forOuterClass(CompilationUnitTree cut,
 String qualifiedOuterClassName)

Selects Insertions relevant to a given outer class and its local classes.

Parameters:

cut - the current compilation unit

qualifiedOuterClassName - the fully qualified outer class name

Returns:

set of Insertions with an InClassCriterion for the given outer class or one of its local classes

add

public void add(Insertion ins)

Add an Insertion to this collection.

addAll

public void addAll(Collection<? extends Insertion> c)

Add all the given Insertions to this collection.

size

public int size()

Returns the number of Insertions in this collection.

iterator

public Iterator<Insertion> iterator()

Specified by:

iterator in interface Iterable<Insertion>

toList

public List<Insertion> toList()

Returns a List containing all Insertions in this collection.