Package spoon.reflect.visitor

Class ImportScannerImpl

java.lang.Object

spoon.reflect.visitor.CtScanner

spoon.reflect.visitor.ImportScannerImpl

All Implemented Interfaces:

CtVisitor, ImportScanner

public class ImportScannerImpl
extends CtScanner
implements ImportScanner

A scanner that calculates the imports for a given model. This class is not used anymore, it has been replaced by all subclasses of ImportAnalyzer. Still, we keep ImportScannerImpl for backward compatibility because it is used by some clients.

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<String,CtTypeReference<?>>	classImports
protected Map<String,CtFieldReference<?>>	fieldImports
protected Map<String,CtExecutableReference<?>>	methodImports
protected CtTypeReference<?>	targetType

Constructor Summary

Constructors

Constructor	Description
ImportScannerImpl()

Method Summary

Modifier and Type	Method	Description
protected boolean	addClassImport(CtTypeReference<?> ref)	Adds a type to the classImports.
protected boolean	addFieldImport(CtFieldReference ref)
protected boolean	addMethodImport(CtExecutableReference ref)
protected boolean	classNamePresentInJavaLang(CtTypeReference<?> ref)
void	computeImports(CtElement element)	Computes import of a CtElement
Set<CtImport>	getAllImports()	Use computeImports or computeAllImports before getting the different imports.
void	initWithImports(Iterable<CtImport> importCollection)	Specify the original imports to use before computing new imports.
boolean	isImported(CtReference ref)	Checks if the type is already imported.
protected boolean	isImportedInClassImports(CtTypeReference<?> ref)
protected boolean	isImportedInFieldImports(CtFieldReference<?> ref)
protected boolean	isImportedInMethodImports(CtExecutableReference<?> ref)
protected boolean	isTypeInCollision(CtReference ref, boolean fqnMode)	Test if the reference can be imported, i.e.
protected Set<String>	lookForLocalVariables(CtElement parent)
void	scan(CtElement element)	Generically scans a meta-model element.
<A extends Annotation> void	visitCtAnnotationType(CtAnnotationType<A> annotationType)	Visits an annotation type declaration.
<T> void	visitCtCatchVariable(CtCatchVariable<T> catchVariable)	Visits a catch variable declaration.
<T> void	visitCtClass(CtClass<T> ctClass)	Visits a class declaration.
<T extends Enum<?>> void	visitCtEnum(CtEnum<T> ctEnum)	Visits an enumeration declaration.
<T> void	visitCtExecutableReference(CtExecutableReference<T> reference)	Visits a reference to an executable.
<T> void	visitCtFieldRead(CtFieldRead<T> fieldRead)	Visits a field read access.
<T> void	visitCtFieldReference(CtFieldReference<T> reference)	Visits a reference to a field.
<T> void	visitCtInterface(CtInterface<T> intrface)	Visits an interface declaration.
void	visitCtInvocation(CtInvocation invocation)	Visits an executable invocation.
void	visitCtJavaDoc(CtJavaDoc ctJavaDoc)	Visits a javadoc comment
<T> void	visitCtTypeReference(CtTypeReference<T> reference)	Visits a reference to a type.

Methods inherited from class spoon.reflect.visitor.CtScanner

enter, exit, scan, scan, scan, scan, scan, scan, visitCtAnnotation, visitCtAnnotationFieldAccess, visitCtAnnotationMethod, visitCtAnonymousExecutable, visitCtArrayRead, visitCtArrayTypeReference, visitCtArrayWrite, visitCtAssert, visitCtAssignment, visitCtBinaryOperator, visitCtBlock, visitCtBreak, visitCtCase, visitCtCatch, visitCtCatchVariableReference, visitCtCodeSnippetExpression, visitCtCodeSnippetStatement, visitCtComment, visitCtCompilationUnit, visitCtConditional, visitCtConstructor, visitCtConstructorCall, visitCtContinue, visitCtDo, visitCtEnumValue, visitCtExecutableReferenceExpression, visitCtField, visitCtFieldWrite, visitCtFor, visitCtForEach, visitCtIf, visitCtImport, visitCtIntersectionTypeReference, visitCtJavaDocTag, visitCtLambda, visitCtLiteral, visitCtLocalVariable, visitCtLocalVariableReference, visitCtMethod, visitCtModule, visitCtModuleReference, visitCtModuleRequirement, visitCtNewArray, visitCtNewClass, visitCtOperatorAssignment, visitCtPackage, visitCtPackageDeclaration, visitCtPackageExport, visitCtPackageReference, visitCtParameter, visitCtParameterReference, visitCtProvidedService, visitCtRecord, visitCtRecordComponent, visitCtReturn, visitCtStatementList, visitCtSuperAccess, visitCtSwitch, visitCtSwitchExpression, visitCtSynchronized, visitCtTextBlock, visitCtThisAccess, visitCtThrow, visitCtTry, visitCtTryWithResource, visitCtTypeAccess, visitCtTypeMemberWildcardImportReference, visitCtTypeParameter, visitCtTypeParameterReference, visitCtTypePattern, visitCtUnaryOperator, visitCtUnboundVariableReference, visitCtUsedService, visitCtVariableRead, visitCtVariableWrite, visitCtWhile, visitCtWildcardReference, visitCtYieldStatement

Methods inherited from class java.lang.Object

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

Field Details

classImports

protected Map<String,CtTypeReference<?>> classImports

fieldImports

protected Map<String,CtFieldReference<?>> fieldImports

methodImports

protected Map<String,CtExecutableReference<?>> methodImports

targetType

protected CtTypeReference<?> targetType

Constructor Details

ImportScannerImpl

public ImportScannerImpl()

Method Details

visitCtFieldRead

public <T> void visitCtFieldRead(CtFieldRead<T> fieldRead)

Description copied from interface: CtVisitor

Visits a field read access.

Specified by:

visitCtFieldRead in interface CtVisitor

Overrides:

visitCtFieldRead in class CtScanner

visitCtFieldReference

public <T> void visitCtFieldReference(CtFieldReference<T> reference)

Description copied from interface: CtVisitor

Visits a reference to a field.

Specified by:

visitCtFieldReference in interface CtVisitor

Overrides:

visitCtFieldReference in class CtScanner

visitCtExecutableReference

public <T> void visitCtExecutableReference(CtExecutableReference<T> reference)

Description copied from interface: CtVisitor

Visits a reference to an executable.

Specified by:

visitCtExecutableReference in interface CtVisitor

Overrides:

visitCtExecutableReference in class CtScanner

visitCtTypeReference

public <T> void visitCtTypeReference(CtTypeReference<T> reference)

Description copied from interface: CtVisitor

Visits a reference to a type.

Specified by:

visitCtTypeReference in interface CtVisitor

Overrides:

visitCtTypeReference in class CtScanner

scan

public void scan(CtElement element)

Description copied from class: CtScanner

Generically scans a meta-model element.

Overrides:

scan in class CtScanner

Parameters:

element - An element to scan

visitCtJavaDoc

public void visitCtJavaDoc(CtJavaDoc ctJavaDoc)

Description copied from interface: CtVisitor

Visits a javadoc comment

Specified by:

visitCtJavaDoc in interface CtVisitor

Overrides:

visitCtJavaDoc in class CtScanner

visitCtAnnotationType

public <A extends Annotation> void visitCtAnnotationType(CtAnnotationType<A> annotationType)

Description copied from interface: CtVisitor

Visits an annotation type declaration.

Specified by:

visitCtAnnotationType in interface CtVisitor

Overrides:

visitCtAnnotationType in class CtScanner

visitCtEnum

public <T extends Enum<?>> void visitCtEnum(CtEnum<T> ctEnum)

Description copied from interface: CtVisitor

Visits an enumeration declaration.

Specified by:

visitCtEnum in interface CtVisitor

Overrides:

visitCtEnum in class CtScanner

visitCtInterface

public <T> void visitCtInterface(CtInterface<T> intrface)

Description copied from interface: CtVisitor

Visits an interface declaration.

Specified by:

visitCtInterface in interface CtVisitor

Overrides:

visitCtInterface in class CtScanner

visitCtClass

public <T> void visitCtClass(CtClass<T> ctClass)

Description copied from interface: CtVisitor

Visits a class declaration.

Specified by:

visitCtClass in interface CtVisitor

Overrides:

visitCtClass in class CtScanner

visitCtCatchVariable

public <T> void visitCtCatchVariable(CtCatchVariable<T> catchVariable)

Description copied from interface: CtVisitor

Visits a catch variable declaration.

Specified by:

visitCtCatchVariable in interface CtVisitor

Overrides:

visitCtCatchVariable in class CtScanner

visitCtInvocation

public void visitCtInvocation(CtInvocation invocation)

Description copied from interface: CtVisitor

Visits an executable invocation.

Specified by:

visitCtInvocation in interface CtVisitor

Overrides:

visitCtInvocation in class CtScanner

getAllImports

public Set<CtImport> getAllImports()

Description copied from interface: ImportScanner

Use computeImports or computeAllImports before getting the different imports.

Specified by:

getAllImports in interface ImportScanner

Returns:

the list of computed imports or an empty collection if not imports has been computed.

computeImports

public void computeImports(CtElement element)

Description copied from interface: ImportScanner

Computes import of a CtElement

Specified by:

computeImports in interface ImportScanner

isImported

public boolean isImported(CtReference ref)

Description copied from interface: ImportScanner

Checks if the type is already imported.

Specified by:

isImported in interface ImportScanner

initWithImports

public void initWithImports(Iterable<CtImport> importCollection)

Description copied from interface: ImportScanner

Specify the original imports to use before computing new imports.

Specified by:

initWithImports in interface ImportScanner

addClassImport

protected boolean addClassImport(CtTypeReference<?> ref)

Adds a type to the classImports.

isImportedInClassImports

protected boolean isImportedInClassImports(CtTypeReference<?> ref)

addMethodImport

protected boolean addMethodImport(CtExecutableReference ref)

isImportedInMethodImports

protected boolean isImportedInMethodImports(CtExecutableReference<?> ref)

addFieldImport

protected boolean addFieldImport(CtFieldReference ref)

isImportedInFieldImports

protected boolean isImportedInFieldImports(CtFieldReference<?> ref)

classNamePresentInJavaLang

protected boolean classNamePresentInJavaLang(CtTypeReference<?> ref)

lookForLocalVariables

protected Set<String> lookForLocalVariables(CtElement parent)

isTypeInCollision

protected boolean isTypeInCollision(CtReference ref,
 boolean fqnMode)

Test if the reference can be imported, i.e. test if the importation could lead to a collision.

Parameters:

ref -

Returns:

true if the ref should be imported.