Package spoon.reflect.visitor

Class ImportConflictDetector

java.lang.Object

spoon.processing.AbstractProcessor<CtElement>

spoon.reflect.visitor.ImportConflictDetector

All Implemented Interfaces:

FactoryAccessor, Processor<CtElement>

public class ImportConflictDetector
extends AbstractProcessor<CtElement>

Detects conflicts needed to be required be a fully-qualified name. 1) Example: conflict of field name with an variable name and fixes it by making field target explicit.

 class A {
  int xxx;
  void m(String xxx) {
    this.xxx //the target `this.` must be explicit, otherwise parameter `String xxx` hides it
  }
 }

2) Example: conflict of package name with an variable name and fixes it by making field target implicit.

 class A {
  int com;
  void m() {
    com.package.Type.doSomething(); //the package `com` is in conflict with field `com`. Must be imported
  }
 }

and fixes them by call of CtElement.setImplicit(boolean) and CtTypeReference.setSimplyQualified(boolean)

Field Summary

Fields

Modifier and Type	Field	Description
protected static Set<CtRole>	IGNORED_ROLES_WHEN_IMPLICIT
protected EarlyTerminatingScanner	scanner

Constructor Summary

Constructors

Constructor	Description
ImportConflictDetector()

Method Summary

Modifier and Type	Method	Description
protected LexicalScopeScanner	createScanner()	creates the scanner that will be used to visit the model
protected CtScannerListener	createScannerListener()
protected static <T extends CtElement> T	getParentIfType(CtElement element, Class<T> type)
protected LexicalScope	getScannerContextInformation()	extract the required information from the scanner to take a decision
protected void	handleTargetedExpression(CtTargetedExpression<?,?> targetedExpression, LexicalScope nameScope)	what do we do a target expression (print target or not) ?
protected void	handleTypeReference(CtTypeReference<?> ref, LexicalScope nameScope, CtRole role)	what do we do a type reference?
protected void	onEnter(LexicalScope context, CtRole role, CtElement element)
void	process(CtElement el)	A callback method called by the meta-model scanner to perform a dedicated job on the currently scanned element.
protected static void	process(CtScanner scanner, CtCompilationUnit cu)

Methods inherited from class spoon.processing.AbstractProcessor

addProcessedElementType, clearProcessedElementType, getEnvironment, getFactory, getProcessedElementTypes, getTraversalStrategy, init, initProperties, interrupt, isToBeProcessed, loadProperties, process, processingDone, removeProcessedElementType, setFactory

Methods inherited from class java.lang.Object

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

Field Details

scanner

protected EarlyTerminatingScanner scanner

IGNORED_ROLES_WHEN_IMPLICIT

protected static Set<CtRole> IGNORED_ROLES_WHEN_IMPLICIT

Constructor Details

ImportConflictDetector

public ImportConflictDetector()

Method Details

createScanner

protected LexicalScopeScanner createScanner()

creates the scanner that will be used to visit the model

getScannerContextInformation

protected LexicalScope getScannerContextInformation()

extract the required information from the scanner to take a decision

handleTargetedExpression

protected void handleTargetedExpression(CtTargetedExpression<?,?> targetedExpression,
 LexicalScope nameScope)

what do we do a target expression (print target or not) ?

handleTypeReference

protected void handleTypeReference(CtTypeReference<?> ref,
 LexicalScope nameScope,
 CtRole role)

what do we do a type reference?

process

public void process(CtElement el)

Description copied from interface: Processor

A callback method called by the meta-model scanner to perform a dedicated job on the currently scanned element. The way Spoon calls this method depends on the processed element types ( Processor.getProcessedElementTypes()), the traversal strategy ( Processor.getTraversalStrategy()), and the used processing manager ( Environment.getManager(). Also, this method is called only if the method Processor.isToBeProcessed(CtElement) returns true for a given scanned element. In order to manually scan the meta-model, one can define the Processor.process() method instead.

Parameters:

el - the element that is currently being scanned

process

protected static void process(CtScanner scanner,
 CtCompilationUnit cu)

createScannerListener

protected CtScannerListener createScannerListener()

onEnter

protected void onEnter(LexicalScope context,
 CtRole role,
 CtElement element)

getParentIfType

protected static <T extends CtElement> T getParentIfType(CtElement element,
 Class<T> type)

Returns:

parent of `element`, but only if it's type is `type`