Package com.intellij.codeInspection.streamToLoop

Class ChainVariable

java.lang.Object

com.intellij.codeInspection.streamToLoop.ChainVariable

public class ChainVariable
extends java.lang.Object

This class represents a variable which holds chain element. Its lifecycle is the following: 1. Construction: fast, in case you don't need to perform a fix actually 2. Preprocessing (addBestNameCandidate/addOtherNameCandidate/markFinal can be called). 3. Register variable in ChainContext: actual variable name is assigned here 4. Usage in code generation: getName()/getType()/isFinal() could be called.

Field Summary

Fields

Modifier and Type	Field and Description
static ChainVariable	STUB

Constructor Summary

Constructors

Constructor and Description
ChainVariable(PsiType type)
ChainVariable(PsiType type, java.lang.String name)

Method Summary

Modifier and Type	Method and Description
void	addBestNameCandidate(java.lang.String candidate) Register best name candidate for this variable (like lambda argument which was explicitly present in the original code).
java.lang.String	getDeclaration()
java.lang.String	getDeclaration(java.lang.String initializer)
java.lang.String	getName()
PsiType	getType()
boolean	isFinal()
boolean	isRegistered()
void	markFinal() Call if the resulting variable must be declared final (e.g.
void	register(ChainContext context) Register variable within ChainContext.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

STUB

public static final ChainVariable STUB

Constructor Detail

ChainVariable

public ChainVariable(PsiType type)

ChainVariable

public ChainVariable(PsiType type,
                     java.lang.String name)

Method Detail

markFinal

public void markFinal()

Call if the resulting variable must be declared final (e.g. used in lambdas)

addBestNameCandidate

public void addBestNameCandidate(java.lang.String candidate)

Register best name candidate for this variable (like lambda argument which was explicitly present in the original code).

Parameters:

candidate - name candidate

register

public void register(ChainContext context)

Register variable within ChainContext. Must be called once after all name candidates are registered. Now variable gets an actual name.

Parameters:

context - context to use

getName

public java.lang.String getName()

getType

public PsiType getType()

getDeclaration

public java.lang.String getDeclaration()

getDeclaration

public java.lang.String getDeclaration(java.lang.String initializer)

isFinal

public boolean isFinal()

isRegistered

public boolean isRegistered()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object