Package com.intellij.codeInspection.streamToLoop

Class FunctionHelper

java.lang.Object

com.intellij.codeInspection.streamToLoop.FunctionHelper

public abstract class FunctionHelper
extends java.lang.Object

A helper class which represents an expression mapped to the functional interface (like lambda, method reference or normal reference)

Constructor Summary

Constructors

Constructor and Description
FunctionHelper(PsiType resultType)

Method Summary

Modifier and Type	Method and Description
static FunctionHelper	create(PsiExpression expression, int paramCount)
static FunctionHelper	create(PsiExpression expression, int paramCount, boolean allowReturns)
abstract PsiExpression	getExpression()
java.lang.String	getParameterName(int index)
PsiType	getResultType()
java.lang.String	getStatementText()
java.lang.String	getText()
void	preprocessVariable(ChainContext context, ChainVariable var, int index)
void	registerReusedElements(java.util.function.Consumer<? super PsiElement> consumer)
void	rename(java.lang.String oldName, java.lang.String newName, ChainContext context) Rename the references of some variable if it's used inside this function
static <T extends PsiElement> T	replaceVarReference(T expressionOrCodeBlock, java.lang.String name, java.lang.String replacement, ChainContext context) Replaces all the references to the variable name in given expression with replacement.
static void	suggestFromExpression(ChainVariable var, Project project, PsiExpression expression)
void	suggestOutputNames(ChainContext context, ChainVariable var)
abstract void	transform(ChainContext context, java.lang.String... argumentValues) Adapts this function helper converting it to the valid expression and inlining SAM parameters with provided values.
java.lang.String	tryLightTransform() Try to perform "light" transformation.

Methods inherited from class java.lang.Object

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

Constructor Detail

FunctionHelper

public FunctionHelper(PsiType resultType)

Method Detail

getResultType

public PsiType getResultType()

getText

public final java.lang.String getText()

getStatementText

public java.lang.String getStatementText()

getExpression

public abstract PsiExpression getExpression()

tryLightTransform

public java.lang.String tryLightTransform()

Try to perform "light" transformation. Works only for single-argument SAM. The function helper decides by itself how to name the SAM argument and returns the assigned name. After this method invocation normal transform cannot be performed.

Returns:

SAM argument name or null if function helper refused to perform a transformation.

transform

public abstract void transform(ChainContext context,
                               java.lang.String... argumentValues)

Adapts this function helper converting it to the valid expression and inlining SAM parameters with provided values. Must be called exactly once prior using getExpression() or getText().

Parameters:

context - a context for which transformation should be performed

argumentValues - values (expressions) of the SAM parameters to be inlined into function body (the length must be exactly the same as the number of SAM parameters). Usually it's just the references to the existing variables, but other expressions (e.g. constant literals) could be used as well if necessary.

rename

public void rename(java.lang.String oldName,
                   java.lang.String newName,
                   ChainContext context)

Rename the references of some variable if it's used inside this function

Parameters:

oldName - old variable name

newName - new variable name

context - a context

registerReusedElements

public void registerReusedElements(java.util.function.Consumer<? super PsiElement> consumer)

getParameterName

public java.lang.String getParameterName(int index)

preprocessVariable

public void preprocessVariable(ChainContext context,
                               ChainVariable var,
                               int index)

suggestOutputNames

public void suggestOutputNames(ChainContext context,
                               ChainVariable var)

suggestFromExpression

public static void suggestFromExpression(ChainVariable var,
                                         Project project,
                                         PsiExpression expression)

create

public static FunctionHelper create(PsiExpression expression,
                                    int paramCount)

create

public static FunctionHelper create(PsiExpression expression,
                                    int paramCount,
                                    boolean allowReturns)

replaceVarReference

public static <T extends PsiElement> T replaceVarReference(T expressionOrCodeBlock,
                                                           java.lang.String name,
                                                           java.lang.String replacement,
                                                           ChainContext context)

Replaces all the references to the variable name in given expression with replacement.

If the replacement is a new name to the variable, the caller must take care that this new name was not used before.

Parameters:

expressionOrCodeBlock - an expression or code block to search-and-replace references inside

name - a reference name to replace

replacement - a replacement expression (new name or literal)

context - context

Returns:

resulting expression (might be the same as input expression)