Package com.intellij.psi

Interface PsiElementFactory

All Superinterfaces:

JVMElementFactory, PsiJavaParserFacade

All Known Implementing Classes:

PsiElementFactoryImpl

public interface PsiElementFactory
extends PsiJavaParserFacade, JVMElementFactory

Service for creating instances of Java and JavaDoc PSI elements which don't have an underlying source code file.

See Also:

JavaPsiFacade.getElementFactory(), PsiFileFactory

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	PsiElementFactory.SERVICE Deprecated. please use PsiElementFactory.SERVICE.getInstance(Project)

Method Summary

Modifier and Type	Method and Description
PsiClass	createAnnotationType(java.lang.String name) Creates an empty annotation type with the specified name.
PsiCatchSection	createCatchSection(PsiType exceptionType, java.lang.String exceptionName, PsiElement context) Creates a catch section for catching an exception of the specified type and name.
PsiClass	createClass(java.lang.String name) Creates an empty class with the specified name.
PsiClassInitializer	createClassInitializer() Creates an empty class initializer block.
PsiJavaCodeReferenceElement	createClassReferenceElement(PsiClass aClass) Creates a reference element resolving to the specified class.
PsiCodeBlock	createCodeBlock() Creates an empty Java code block.
PsiMethod	createConstructor() Creates an empty constructor.
PsiMethod	createConstructor(java.lang.String name) Creates an empty constructor with a given name.
PsiElement	createDummyHolder(java.lang.String text, IElementType type, PsiElement context) Create a lightweight PsiElement of given element type in a lightweight non-physical PsiFile (aka DummyHolder) in a given context.
PsiClass	createEnum(java.lang.String name) Creates an empty enum with the specified name.
PsiExpression	createExpressionFromText(java.lang.String text, PsiElement context) Creates a Java expression from the specified text.
PsiField	createField(java.lang.String name, PsiType type) Creates a field with the specified name and type.
PsiJavaCodeReferenceElement	createFQClassNameReferenceElement(java.lang.String qName, GlobalSearchScope resolveScope) Creates a reference element resolving to the class with the specified name in the specified search scope.
PsiIdentifier	createIdentifier(java.lang.String text) Creates a Java identifier with the specified text.
PsiImportStatement	createImportStatement(PsiClass aClass) Creates an import statement for importing the specified class.
PsiImportStatement	createImportStatementOnDemand(java.lang.String packageName) Creates an on-demand import statement for importing classes from the package with the specified name.
PsiImportStaticStatement	createImportStaticStatement(PsiClass aClass, java.lang.String memberName) Creates an import static statement for importing the specified member from the specified class.
PsiClass	createInterface(java.lang.String name) Creates an empty interface with the specified name.
PsiKeyword	createKeyword(java.lang.String keyword) Creates a Java keyword with the specified text.
PsiKeyword	createKeyword(java.lang.String keyword, PsiElement context)
PsiMethod	createMethod(java.lang.String name, PsiType returnType) Creates an empty method with the specified name and return type.
PsiJavaCodeReferenceElement	createPackageReferenceElement(PsiPackage aPackage) Creates a reference element resolving to the specified package.
PsiJavaCodeReferenceElement	createPackageReferenceElement(java.lang.String packageName) Creates a reference element resolving to the package with the specified name.
PsiPackageStatement	createPackageStatement(java.lang.String name) Creates a package statement for the specified package name.
PsiParameter	createParameter(java.lang.String name, PsiType type) Creates a parameter with the specified name and type.
PsiParameterList	createParameterList(java.lang.String [] names, PsiType [] types) Creates a parameter list from the specified parameter names and types.
PsiDocTag	createParamTag(java.lang.String parameterName, java.lang.String description) Creates a PSI element for the "@param" JavaDoc tag.
PsiPrimitiveType	createPrimitiveType(java.lang.String text) Returns the primitive type instance for the specified type name.
PsiSubstitutor	createRawSubstitutor(PsiSubstitutor baseSubstitutor, PsiTypeParameter [] typeParameters)
PsiSubstitutor	createRawSubstitutor(PsiTypeParameterListOwner owner) Creates a substitutor for the specified class which replaces all type parameters with their corresponding raw types.
PsiClass	createRecord(java.lang.String name) Creates a record with no components with the specified name.
PsiJavaCodeReferenceElement	createReferenceElementByFQClassName(java.lang.String qName, GlobalSearchScope resolveScope) Creates a reference element resolving to the class with the specified name in the specified search scope.
PsiJavaCodeReferenceElement	createReferenceElementByType(PsiClassType type) Creates a reference element resolving to the specified class type.
PsiReferenceExpression	createReferenceExpression(PsiClass aClass) Creates a reference expression resolving to the specified class.
PsiReferenceExpression	createReferenceExpression(PsiPackage aPackage) Creates a reference expression resolving to the specified package.
PsiReferenceList	createReferenceList(PsiJavaCodeReferenceElement [] references) Creates a reference list element from the specified array of references.
PsiResourceVariable	createResourceVariable(java.lang.String name, PsiType type, PsiExpression initializer, PsiElement context) Creates a resource variable (which can be inserted into the resource list of try-with-resources statement) with the specified name, type and initializer
PsiSubstitutor	createSubstitutor(java.util.Map<PsiTypeParameter,PsiType> map) Creates a substitutor which uses the specified mapping between type parameters and types.
PsiClassType	createType(PsiClass resolve, PsiSubstitutor substitutor) Creates a class type for the specified class, using the specified substitutor to replace generic type parameters on the class.
PsiClassType	createType(PsiClass resolve, PsiSubstitutor substitutor, LanguageLevel languageLevel) Creates a class type for the specified class, using the specified substitutor to replace generic type parameters on the class.
PsiClassType	createType(PsiClass aClass, PsiType... parameters)
PsiClassType	createType(PsiClass aClass, PsiType parameters)
PsiClassType	createType(PsiJavaCodeReferenceElement classReference) Creates a class type for the specified reference pointing to a class.
PsiClassType	createTypeByFQClassName(java.lang.String qName) The same as createTypeByFQClassName(String, GlobalSearchScope) with GlobalSearchScope.allScope(Project).
PsiClassType	createTypeByFQClassName(java.lang.String qName, GlobalSearchScope resolveScope) Creates a class type referencing a class with the specified class name in the specified search scope.
PsiTypeElement	createTypeElement(PsiType psiType) Creates a type element referencing the specified type.
PsiDeclarationStatement	createVariableDeclarationStatement(java.lang.String name, PsiType type, PsiExpression initializer) Creates a local variable declaration statement with the specified name, type and initializer, optionally without reformatting the declaration.
PsiDeclarationStatement	createVariableDeclarationStatement(java.lang.String name, PsiType type, PsiExpression initializer, PsiElement context) Creates a local variable declaration statement with the specified name, type and initializer, optionally without reformatting the declaration.
PsiClass	getArrayClass(LanguageLevel languageLevel) Returns a synthetic Java class containing methods which are defined on Java arrays.
PsiClassType	getArrayClassType(PsiType componentType, LanguageLevel languageLevel) Returns the class type for a synthetic Java class containing methods which are defined on Java arrays with the specified element type.
static PsiElementFactory	getInstance(Project project)

Methods inherited from interface com.intellij.psi.PsiJavaParserFacade

createAnnotationFromText, createClassFromText, createCodeBlockFromText, createCommentFromText, createDocCommentFromText, createDocCommentFromText, createDocTagFromText, createEnumConstantFromText, createFieldFromText, createMethodFromText, createMethodFromText, createModuleFromText, createModuleFromText, createModuleReferenceFromText, createModuleStatementFromText, createParameterFromText, createPrimitiveTypeFromText, createRecordHeaderFromText, createReferenceFromText, createResourceFromText, createStatementFromText, createTypeElementFromText, createTypeFromText, createTypeParameterFromText

Methods inherited from interface com.intellij.psi.JVMElementFactory

createAnnotationFromText, createConstructor, createDocCommentFromText, createMethod, createMethodFromText, createParameter, createType, createTypeParameter, createTypeParameterList, isValidClassName, isValidFieldName, isValidLocalVariableName, isValidMethodName, isValidParameterName

Method Detail

getInstance

static PsiElementFactory getInstance(Project project)

createClass

PsiClass createClass(java.lang.String name)
              throws IncorrectOperationException

Creates an empty class with the specified name.

Specified by:

createClass in interface JVMElementFactory

Throws:

IncorrectOperationException - if name is not a valid Java identifier.

createInterface

PsiClass createInterface(java.lang.String name)
                  throws IncorrectOperationException

Creates an empty interface with the specified name.

Specified by:

createInterface in interface JVMElementFactory

Throws:

IncorrectOperationException - if name is not a valid Java identifier.

createEnum

PsiClass createEnum(java.lang.String name)
             throws IncorrectOperationException

Creates an empty enum with the specified name.

Specified by:

createEnum in interface JVMElementFactory

Throws:

IncorrectOperationException - if name is not a valid Java identifier.

createRecord

PsiClass createRecord(java.lang.String name)
               throws IncorrectOperationException

Creates a record with no components with the specified name.

Throws:

IncorrectOperationException - if name is not a valid Java identifier.

createAnnotationType

PsiClass createAnnotationType(java.lang.String name)
                       throws IncorrectOperationException

Creates an empty annotation type with the specified name.

Specified by:

createAnnotationType in interface JVMElementFactory

Throws:

IncorrectOperationException - if name is not a valid Java identifier.

createField

PsiField createField(java.lang.String name,
                     PsiType type)
              throws IncorrectOperationException

Creates a field with the specified name and type.

Specified by:

createField in interface JVMElementFactory

Throws:

IncorrectOperationException - name is not a valid Java identifier or type represents an invalid type.

createMethod

PsiMethod createMethod(java.lang.String name,
                       PsiType returnType)
                throws IncorrectOperationException

Creates an empty method with the specified name and return type.

Specified by:

createMethod in interface JVMElementFactory

Throws:

IncorrectOperationException - name is not a valid Java identifier or type represents an invalid type.

createConstructor

PsiMethod createConstructor()

Creates an empty constructor.

Specified by:

createConstructor in interface JVMElementFactory

createConstructor

PsiMethod createConstructor(java.lang.String name)

Creates an empty constructor with a given name.

Specified by:

createConstructor in interface JVMElementFactory

createClassInitializer

PsiClassInitializer createClassInitializer()
                                    throws IncorrectOperationException

Creates an empty class initializer block.

Specified by:

createClassInitializer in interface JVMElementFactory

Throws:

IncorrectOperationException - in case of an internal error.

createParameter

PsiParameter createParameter(java.lang.String name,
                             PsiType type)
                      throws IncorrectOperationException

Creates a parameter with the specified name and type.

Specified by:

createParameter in interface JVMElementFactory

Throws:

IncorrectOperationException - name is not a valid Java identifier or type represents an invalid type.

createCodeBlock

PsiCodeBlock createCodeBlock()

Creates an empty Java code block.

createType

PsiClassType createType(PsiClass resolve,
                        PsiSubstitutor substitutor)

Creates a class type for the specified class, using the specified substitutor to replace generic type parameters on the class.

Specified by:

createType in interface JVMElementFactory

createType

PsiClassType createType(PsiClass resolve,
                        PsiSubstitutor substitutor,
                        LanguageLevel languageLevel)

Creates a class type for the specified class, using the specified substitutor to replace generic type parameters on the class.

Specified by:

createType in interface JVMElementFactory

Parameters:

languageLevel - to memorize language level for allowing/prohibiting boxing/unboxing.

resolve - the class for which the class type is created.

substitutor - the substitutor to use.

Returns:

the class type instance.

createType

PsiClassType createType(PsiJavaCodeReferenceElement classReference)

Creates a class type for the specified reference pointing to a class.

createType

PsiClassType createType(PsiClass aClass,
                        PsiType parameters)

Specified by:

createType in interface JVMElementFactory

createType

PsiClassType createType(PsiClass aClass,
                        PsiType... parameters)

Specified by:

createType in interface JVMElementFactory

createRawSubstitutor

PsiSubstitutor createRawSubstitutor(PsiTypeParameterListOwner owner)

Creates a substitutor for the specified class which replaces all type parameters with their corresponding raw types.

Specified by:

createRawSubstitutor in interface JVMElementFactory

createSubstitutor

PsiSubstitutor createSubstitutor(java.util.Map<PsiTypeParameter,PsiType> map)

Creates a substitutor which uses the specified mapping between type parameters and types.

Specified by:

createSubstitutor in interface JVMElementFactory

createPrimitiveType

PsiPrimitiveType createPrimitiveType(java.lang.String text)

Returns the primitive type instance for the specified type name.

Specified by:

createPrimitiveType in interface JVMElementFactory

Parameters:

text - the name of a Java primitive type (for example, int)

Returns:

the primitive type instance, or null if name is not a valid primitive type name.

createTypeByFQClassName

PsiClassType createTypeByFQClassName(java.lang.String qName)

The same as createTypeByFQClassName(String, GlobalSearchScope) with GlobalSearchScope.allScope(Project).

Specified by:

createTypeByFQClassName in interface JVMElementFactory

createTypeByFQClassName

PsiClassType createTypeByFQClassName(java.lang.String qName,
                                     GlobalSearchScope resolveScope)

Creates a class type referencing a class with the specified class name in the specified search scope.

Specified by:

createTypeByFQClassName in interface JVMElementFactory

createTypeElement

PsiTypeElement createTypeElement(PsiType psiType)

Creates a type element referencing the specified type.

createReferenceElementByType

PsiJavaCodeReferenceElement createReferenceElementByType(PsiClassType type)

Creates a reference element resolving to the specified class type.

Specified by:

createReferenceElementByType in interface JVMElementFactory

Parameters:

type - the class type to create the reference to.

Returns:

the reference element instance.

createClassReferenceElement

PsiJavaCodeReferenceElement createClassReferenceElement(PsiClass aClass)

Creates a reference element resolving to the specified class.

createReferenceElementByFQClassName

PsiJavaCodeReferenceElement createReferenceElementByFQClassName(java.lang.String qName,
                                                                GlobalSearchScope resolveScope)

Creates a reference element resolving to the class with the specified name in the specified search scope. The text of the created reference is the short name of the class.

createFQClassNameReferenceElement

PsiJavaCodeReferenceElement createFQClassNameReferenceElement(java.lang.String qName,
                                                              GlobalSearchScope resolveScope)

Creates a reference element resolving to the class with the specified name in the specified search scope. The text of the created reference is the fully qualified name of the class.

createPackageReferenceElement

PsiJavaCodeReferenceElement createPackageReferenceElement(PsiPackage aPackage)
                                                   throws IncorrectOperationException

Creates a reference element resolving to the specified package.

Throws:

IncorrectOperationException - if aPackage is the default (root) package.

createPackageReferenceElement

PsiJavaCodeReferenceElement createPackageReferenceElement(java.lang.String packageName)
                                                   throws IncorrectOperationException

Creates a reference element resolving to the package with the specified name.

Throws:

IncorrectOperationException - if packageName is an empty string.

createReferenceExpression

PsiReferenceExpression createReferenceExpression(PsiClass aClass)
                                          throws IncorrectOperationException

Creates a reference expression resolving to the specified class.

Throws:

IncorrectOperationException - never (the exception is kept for compatibility purposes).

createReferenceExpression

PsiReferenceExpression createReferenceExpression(PsiPackage aPackage)
                                          throws IncorrectOperationException

Creates a reference expression resolving to the specified package.

Throws:

IncorrectOperationException - if aPackage is the default (root) package.

createIdentifier

PsiIdentifier createIdentifier(java.lang.String text)
                        throws IncorrectOperationException

Creates a Java identifier with the specified text.

Throws:

IncorrectOperationException - if text is not a valid Java identifier.

createKeyword

PsiKeyword createKeyword(java.lang.String keyword)
                  throws IncorrectOperationException

Creates a Java keyword with the specified text.

Throws:

IncorrectOperationException - if text is not a valid Java keyword.

createKeyword

PsiKeyword createKeyword(java.lang.String keyword,
                         PsiElement context)
                  throws IncorrectOperationException

Throws:

IncorrectOperationException

createImportStatement

PsiImportStatement createImportStatement(PsiClass aClass)
                                  throws IncorrectOperationException

Creates an import statement for importing the specified class.

Throws:

IncorrectOperationException - if aClass is an anonymous or local class.

createImportStatementOnDemand

PsiImportStatement createImportStatementOnDemand(java.lang.String packageName)
                                          throws IncorrectOperationException

Creates an on-demand import statement for importing classes from the package with the specified name.

Throws:

IncorrectOperationException - if packageName is not a valid qualified package name.

createVariableDeclarationStatement

PsiDeclarationStatement createVariableDeclarationStatement(java.lang.String name,
                                                           PsiType type,
                                                           PsiExpression initializer)
                                                    throws IncorrectOperationException

Creates a local variable declaration statement with the specified name, type and initializer, optionally without reformatting the declaration.

Note that depending on code style settings the resulting variable may be declared as final.

Throws:

IncorrectOperationException - if name is not a valid identifier or type is not a valid type.

createVariableDeclarationStatement

PsiDeclarationStatement createVariableDeclarationStatement(java.lang.String name,
                                                           PsiType type,
                                                           PsiExpression initializer,
                                                           PsiElement context)
                                                    throws IncorrectOperationException

Creates a local variable declaration statement with the specified name, type and initializer, optionally without reformatting the declaration.

Note that depending on code style settings the resulting variable may be declared as final.

Parameters:

context - the context used to resolve symbols in the resulting declaration.

Throws:

IncorrectOperationException - if name is not a valid identifier or type is not a valid type.

createResourceVariable

PsiResourceVariable createResourceVariable(java.lang.String name,
                                           PsiType type,
                                           PsiExpression initializer,
                                           PsiElement context)

Creates a resource variable (which can be inserted into the resource list of try-with-resources statement) with the specified name, type and initializer

Parameters:

context - the context for dummy holder

createParamTag

PsiDocTag createParamTag(java.lang.String parameterName,
                         java.lang.String description)
                  throws IncorrectOperationException

Creates a PSI element for the "@param" JavaDoc tag.

Throws:

IncorrectOperationException - if the name or description are invalid.

getArrayClass

PsiClass getArrayClass(LanguageLevel languageLevel)

Returns a synthetic Java class containing methods which are defined on Java arrays.

Parameters:

languageLevel - language level used to construct array class.

getArrayClassType

PsiClassType getArrayClassType(PsiType componentType,
                               LanguageLevel languageLevel)

Returns the class type for a synthetic Java class containing methods which are defined on Java arrays with the specified element type.

Parameters:

languageLevel - language level used to construct array class.

createPackageStatement

PsiPackageStatement createPackageStatement(java.lang.String name)
                                    throws IncorrectOperationException

Creates a package statement for the specified package name.

Throws:

IncorrectOperationException - if name is not a valid package name.

createImportStaticStatement

PsiImportStaticStatement createImportStaticStatement(PsiClass aClass,
                                                     java.lang.String memberName)
                                              throws IncorrectOperationException

Creates an import static statement for importing the specified member from the specified class.

Throws:

IncorrectOperationException - if the class is inner or local, or memberName is not a valid identifier.

createParameterList

PsiParameterList createParameterList(java.lang.String [] names,
                                     PsiType [] types)
                              throws IncorrectOperationException

Creates a parameter list from the specified parameter names and types.

Specified by:

createParameterList in interface JVMElementFactory

Throws:

IncorrectOperationException - if any of the parameter names or types are invalid.

createReferenceList

PsiReferenceList createReferenceList(PsiJavaCodeReferenceElement [] references)
                              throws IncorrectOperationException

Creates a reference list element from the specified array of references.

Throws:

IncorrectOperationException - if some of the references are invalid.

createRawSubstitutor

PsiSubstitutor createRawSubstitutor(PsiSubstitutor baseSubstitutor,
                                    PsiTypeParameter [] typeParameters)

createDummyHolder

PsiElement createDummyHolder(java.lang.String text,
                             IElementType type,
                             PsiElement context)

Create a lightweight PsiElement of given element type in a lightweight non-physical PsiFile (aka DummyHolder) in a given context. Element type's language should have a parser definition which supports parsing for this element type (first parameter in PsiParser.parse(IElementType, com.intellij.lang.PsiBuilder).

Parameters:

text - text to parse

type - node type

context - context

Returns:

PsiElement of the desired element type

createCatchSection

PsiCatchSection createCatchSection(PsiType exceptionType,
                                   java.lang.String exceptionName,
                                   PsiElement context)
                            throws IncorrectOperationException

Creates a catch section for catching an exception of the specified type and name.

Parameters:

exceptionType - the type of the exception to catch (either PsiClassType or PsiDisjunctionType).

exceptionName - the name of the variable in which the caught exception is stored (may be an empty string).

context - the context for resolving references.

Throws:

IncorrectOperationException - if any of the parameters are not valid.

createExpressionFromText

PsiExpression createExpressionFromText(java.lang.String text,
                                       PsiElement context)
                                throws IncorrectOperationException

Description copied from interface: PsiJavaParserFacade

Creates a Java expression from the specified text.

Specified by:

createExpressionFromText in interface JVMElementFactory

Specified by:

createExpressionFromText in interface PsiJavaParserFacade

Parameters:

text - the text of the expression to create.

context - the PSI element used as context for resolving references from the expression.

Returns:

the created expression instance.

Throws:

IncorrectOperationException - if the text does not specify a valid expression.