Package com.intellij.codeInsight.completion.proc

Class VariablesProcessor

java.lang.Object

com.intellij.codeInsight.completion.proc.VariablesProcessor

All Implemented Interfaces:

ElementClassHint, PsiScopeProcessor

public class VariablesProcessor
extends java.lang.Object
implements PsiScopeProcessor, ElementClassHint

Simple processor to get all visible variables

See Also:

PsiScopesUtil

Nested Class Summary

Nested classes/interfaces inherited from interface com.intellij.psi.scope.PsiScopeProcessor

PsiScopeProcessor.Event

Nested classes/interfaces inherited from interface com.intellij.psi.scope.ElementClassHint

ElementClassHint.DeclarationKind

Field Summary

Fields inherited from interface com.intellij.psi.scope.ElementClassHint

KEY

Constructor Summary

Constructors

Constructor and Description
VariablesProcessor(java.lang.String _prefix, boolean staticSensitiveFlag) Collecting _all_ variables in scope
VariablesProcessor(java.lang.String _prefix, boolean staticSensitiveFlag, java.util.List<? super PsiVariable> lst) Collecting _all_ variables in scope

Method Summary

Modifier and Type	Method and Description
boolean	execute(PsiElement pe, ResolveState state) Always return true since we wanna get all vars in scope
<T> T	getHint(Key<T> hintKey)
PsiVariable[]	getResultsAsArray() sometimes it is important to get results as array
void	handleEvent(PsiScopeProcessor.Event event, java.lang.Object associated)
boolean	shouldProcess(ElementClassHint.DeclarationKind kind)

Methods inherited from class java.lang.Object

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

Constructor Detail

VariablesProcessor

public VariablesProcessor(java.lang.String _prefix,
                          boolean staticSensitiveFlag)

Collecting _all_ variables in scope

VariablesProcessor

public VariablesProcessor(java.lang.String _prefix,
                          boolean staticSensitiveFlag,
                          java.util.List<? super PsiVariable> lst)

Collecting _all_ variables in scope

Method Detail

shouldProcess

public boolean shouldProcess(ElementClassHint.DeclarationKind kind)

Specified by:

shouldProcess in interface ElementClassHint

execute

public boolean execute(PsiElement pe,
                       ResolveState state)

Always return true since we wanna get all vars in scope

Specified by:

execute in interface PsiScopeProcessor

Parameters:

pe - candidate element.

state - current state of resolver.

Returns:

false to stop processing.

handleEvent

public final void handleEvent(PsiScopeProcessor.Event event,
                              java.lang.Object associated)

Specified by:

handleEvent in interface PsiScopeProcessor

getResultsAsArray

public PsiVariable[] getResultsAsArray()

sometimes it is important to get results as array

getHint

public <T> T getHint(Key<T> hintKey)

Specified by:

getHint in interface PsiScopeProcessor