PsiType (Unofficial IntelliJ Community Edition API docs)

java.lang.Object
- com.intellij.psi.PsiType

All Implemented Interfaces:

JvmType, PsiAnnotationOwner, java.lang.Cloneable

Direct Known Subclasses:

Bottom, GrPsiTypeStub, GrTraitType, PsiClassType, PsiDiamondType, PsiLambdaExpressionType, PsiLambdaParameterType, PsiMethodReferenceType, PsiType.Stub, PsiTypeVariable
```
public abstract class PsiType
extends java.lang.Object
implements PsiAnnotationOwner, java.lang.Cloneable, JvmType
```
Representation of Java type (primitive type, array or class type).

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

protected static class PsiType.Stub

Nested Classes
Modifier and Type	Class and Description
`protected static class`	`PsiType.Stub`

Field Summary

Fields
Modifier and Type	Field and Description
`static ArrayFactory<PsiType>`	`ARRAY_FACTORY`
`static PsiPrimitiveType`	`BOOLEAN`
`static PsiPrimitiveType`	`BYTE`
`static PsiPrimitiveType`	`CHAR`
`static PsiPrimitiveType`	`DOUBLE`
`static PsiType[]`	`EMPTY_ARRAY`
`static PsiPrimitiveType`	`FLOAT`
`static PsiPrimitiveType`	`INT`
`static PsiPrimitiveType`	`LONG`
`static PsiPrimitiveType`	`NULL`
`static PsiPrimitiveType`	`SHORT`
`static PsiPrimitiveType`	`VOID`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`PsiType(PsiAnnotation [] annotations)` Constructs a PsiType with given annotations
`protected`	`PsiType(TypeAnnotationProvider annotations)` Constructs a PsiType that will take its annotations from the given annotation provider.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`abstract <A> A`	`accept(PsiTypeVisitor<A> visitor)` Passes the type to the specified visitor.
`PsiAnnotation`	`addAnnotation(java.lang.String qualifiedName)` Adds a new annotation to this owner.
`PsiType`	`annotate(TypeAnnotationProvider provider)`
`static PsiType []`	`createArray(int count)`
`PsiArrayType`	`createArrayType()` Creates array type with this type as a component.
`PsiArrayType`	`createArrayType(PsiAnnotation... annotations)` Deprecated. use `annotate(TypeAnnotationProvider)`
`abstract boolean`	`equalsToText(java.lang.String text)` Checks if the specified string is equivalent to the canonical text of the type.
`PsiAnnotation`	`findAnnotation(java.lang.String qualifiedName)` Searches the owner for an annotation with the specified fully qualified name and returns one if it is found.
`TypeAnnotationProvider`	`getAnnotationProvider()`
`PsiAnnotation []`	`getAnnotations()` Returns the list of annotations syntactically contained in the element.
`PsiAnnotation []`	`getApplicableAnnotations()`
`int`	`getArrayDimensions()` Returns the number of array dimensions for the type.
`abstract java.lang.String`	`getCanonicalText()` Same as `getCanonicalText(false)`.
`java.lang.String`	`getCanonicalText(boolean annotated)` Returns canonical representation of the type (all references fully-qualified).
`PsiType`	`getDeepComponentType()` Returns the innermost component type for an array type.
`java.lang.String`	`getInternalCanonicalText()` Return canonical text of the type with some internal details added for presentational purposes.
`static PsiClassType`	`getJavaLangClass(PsiManager manager, GlobalSearchScope resolveScope)` Returns the class type for the java.lang.Class class.
`static PsiClassType`	`getJavaLangError(PsiManager manager, GlobalSearchScope resolveScope)` Returns the class type for the java.lang.Error class.
`static PsiClassType`	`getJavaLangObject(PsiManager manager, GlobalSearchScope resolveScope)` Returns the class type for the java.lang.Object class.
`static PsiClassType`	`getJavaLangRuntimeException(PsiManager manager, GlobalSearchScope resolveScope)` Returns the class type for the java.lang.RuntimeException class.
`static PsiClassType`	`getJavaLangString(PsiManager manager, GlobalSearchScope resolveScope)` Returns the class type for the java.lang.String class.
`static PsiClassType`	`getJavaLangThrowable(PsiManager manager, GlobalSearchScope resolveScope)` Returns the class type for the java.lang.Throwable class.
`abstract java.lang.String`	`getPresentableText()` Same as `getPresentableText(false)`.
`java.lang.String`	`getPresentableText(boolean annotated)` Returns text of the type that can be presented to a user (references normally non-qualified).
`abstract GlobalSearchScope`	`getResolveScope()` Returns the scope in which the reference to the underlying class of a class type is searched.
`abstract PsiType []`	`getSuperTypes()` Returns the list of superclass types for a class type.
`static PsiClassType`	`getTypeByName(java.lang.String qName, Project project, GlobalSearchScope resolveScope)` Returns the class type for qualified class name.
`boolean`	`isAssignableFrom(PsiType type)`
`boolean`	`isConvertibleFrom(PsiType type)` Checks whether values of type `type` can be casted to this type.
`abstract boolean`	`isValid()` Checks if the type is currently valid.
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.intellij.psi.PsiAnnotationOwner
hasAnnotation

Methods inherited from interface com.intellij.lang.jvm.types.JvmType
accept

- Field Detail
  - BYTE
```
public static final PsiPrimitiveType BYTE
```
  - CHAR
```
public static final PsiPrimitiveType CHAR
```
  - DOUBLE
```
public static final PsiPrimitiveType DOUBLE
```
  - FLOAT
```
public static final PsiPrimitiveType FLOAT
```
  - INT
```
public static final PsiPrimitiveType INT
```
  - LONG
```
public static final PsiPrimitiveType LONG
```
  - SHORT
```
public static final PsiPrimitiveType SHORT
```
  - BOOLEAN
```
public static final PsiPrimitiveType BOOLEAN
```
  - VOID
```
public static final PsiPrimitiveType VOID
```
  - NULL
```
public static final PsiPrimitiveType NULL
```
  - EMPTY_ARRAY
```
public static final PsiType[] EMPTY_ARRAY
```
  - ARRAY_FACTORY
```
public static final ArrayFactory<PsiType> ARRAY_FACTORY
```
- Constructor Detail
  - PsiType
```
protected PsiType(PsiAnnotation [] annotations)
```
    Constructs a PsiType with given annotations
  - PsiType
```
protected PsiType(TypeAnnotationProvider annotations)
```
    Constructs a PsiType that will take its annotations from the given annotation provider.
- Method Detail
  - createArray
```
public static PsiType [] createArray(int count)
```
  - annotate
```
public PsiType annotate(TypeAnnotationProvider provider)
```
  - createArrayType
```
public PsiArrayType createArrayType()
```
    Creates array type with this type as a component.
  - createArrayType
```
@Deprecated
public PsiArrayType createArrayType(PsiAnnotation... annotations)
```
    Deprecated. use annotate(TypeAnnotationProvider)
  - getPresentableText
```
public java.lang.String getPresentableText(boolean annotated)
```
    Returns text of the type that can be presented to a user (references normally non-qualified).
  - getPresentableText
```
public abstract java.lang.String getPresentableText()
```
    Same as getPresentableText(false).
  - getCanonicalText
```
public java.lang.String getCanonicalText(boolean annotated)
```
    Returns canonical representation of the type (all references fully-qualified).
  - getCanonicalText
```
public abstract java.lang.String getCanonicalText()
```
    Same as getCanonicalText(false).
  - getInternalCanonicalText
```
public java.lang.String getInternalCanonicalText()
```
    Return canonical text of the type with some internal details added for presentational purposes. Use with care. todo[r.sh] merge with getPresentableText()
  - isValid
```
public abstract boolean isValid()
```
    Checks if the type is currently valid.
    
    Returns:
    
    true if the type is valid, false otherwise.
    
    See Also:
    
    PsiElement.isValid()
  - isAssignableFrom
```
public boolean isAssignableFrom(PsiType type)
```
    Returns:
    
    true if values of type type can be assigned to rvalues of this type.
  - isConvertibleFrom
```
public boolean isConvertibleFrom(PsiType type)
```
    Checks whether values of type type can be casted to this type.
  - equalsToText
```
public abstract boolean equalsToText(java.lang.String text)
```
    Checks if the specified string is equivalent to the canonical text of the type.
    
    Parameters:
    
    text - the text to compare with.
    
    Returns:
    
    true if the string is equivalent to the type, false otherwise
  - getTypeByName
```
public static PsiClassType getTypeByName(java.lang.String qName,
                                         Project project,
                                         GlobalSearchScope resolveScope)
```
    Returns the class type for qualified class name.
    
    Parameters:
    
    qName - qualified class name.
    
    resolveScope - the scope in which the class is searched.
    
    Returns:
    
    the class instance.
  - getJavaLangObject
```
public static PsiClassType getJavaLangObject(PsiManager manager,
                                             GlobalSearchScope resolveScope)
```
    Returns the class type for the java.lang.Object class.
    
    Parameters:
    
    manager - the PSI manager used to create the class type.
    
    resolveScope - the scope in which the class is searched.
    
    Returns:
    
    the class instance.
  - getJavaLangClass
```
public static PsiClassType getJavaLangClass(PsiManager manager,
                                            GlobalSearchScope resolveScope)
```
    Returns the class type for the java.lang.Class class.
    
    Parameters:
    
    manager - the PSI manager used to create the class type.
    
    resolveScope - the scope in which the class is searched.
    
    Returns:
    
    the class instance.
  - getJavaLangThrowable
```
public static PsiClassType getJavaLangThrowable(PsiManager manager,
                                                GlobalSearchScope resolveScope)
```
    Returns the class type for the java.lang.Throwable class.
    
    Parameters:
    
    manager - the PSI manager used to create the class type.
    
    resolveScope - the scope in which the class is searched.
    
    Returns:
    
    the class instance.
  - getJavaLangString
```
public static PsiClassType getJavaLangString(PsiManager manager,
                                             GlobalSearchScope resolveScope)
```
    Returns the class type for the java.lang.String class.
    
    Parameters:
    
    manager - the PSI manager used to create the class type.
    
    resolveScope - the scope in which the class is searched.
    
    Returns:
    
    the class instance.
  - getJavaLangError
```
public static PsiClassType getJavaLangError(PsiManager manager,
                                            GlobalSearchScope resolveScope)
```
    Returns the class type for the java.lang.Error class.
    
    Parameters:
    
    manager - the PSI manager used to create the class type.
    
    resolveScope - the scope in which the class is searched.
    
    Returns:
    
    the class instance.
  - getJavaLangRuntimeException
```
public static PsiClassType getJavaLangRuntimeException(PsiManager manager,
                                                       GlobalSearchScope resolveScope)
```
    Returns the class type for the java.lang.RuntimeException class.
    
    Parameters:
    
    manager - the PSI manager used to create the class type.
    
    resolveScope - the scope in which the class is searched.
    
    Returns:
    
    the class instance.
  - accept
```
public abstract <A> A accept(PsiTypeVisitor<A> visitor)
```
    Passes the type to the specified visitor.
    
    Parameters:
    
    visitor - the visitor to accept the type.
    
    Returns:
    
    the value returned by the visitor.
  - getArrayDimensions
```
public final int getArrayDimensions()
```
    Returns the number of array dimensions for the type.
    
    Returns:
    
    the number of dimensions, or 0 if the type is not an array type.
  - getDeepComponentType
```
public final PsiType getDeepComponentType()
```
    Returns the innermost component type for an array type.
    
    Returns:
    
    the innermost (non-array) component of the type, or this if the type is not an array type.
  - getResolveScope
```
public abstract GlobalSearchScope getResolveScope()
```
    Returns the scope in which the reference to the underlying class of a class type is searched.
    
    Returns:
    
    the resolve scope instance, or null if the type is a primitive or an array of primitives.
  - getSuperTypes
```
public abstract PsiType [] getSuperTypes()
```
    Returns the list of superclass types for a class type.
    
    Returns:
    
    the array of superclass types, or an empty array if the type is not a class type.
  - getAnnotationProvider
```
public final TypeAnnotationProvider getAnnotationProvider()
```
    Returns:
    
    provider for this type's annotations. Can be used to construct other PsiType instances without actually evaluating the annotation array, which can be computationally expensive sometimes.
  - getAnnotations
```
public PsiAnnotation [] getAnnotations()
```
    Description copied from interface: PsiAnnotationOwner
    
    Returns the list of annotations syntactically contained in the element.
    
    Specified by:
    
    getAnnotations in interface JvmType
    
    Specified by:
    
    getAnnotations in interface PsiAnnotationOwner
    
    Returns:
    
    annotations for this type. Uses getAnnotationProvider() to retrieve the annotations.
    
    See Also:
    
    AnnotatedElement.getAnnotations()
  - findAnnotation
```
public PsiAnnotation findAnnotation(java.lang.String qualifiedName)
```
    Description copied from interface: PsiAnnotationOwner
    
    Searches the owner for an annotation with the specified fully qualified name and returns one if it is found.
    
    Specified by:
    
    findAnnotation in interface PsiAnnotationOwner
    
    Parameters:
    
    qualifiedName - the fully qualified name of the annotation to find.
    
    Returns:
    
    the annotation instance, or null if no such annotation is found.
  - addAnnotation
```
public PsiAnnotation addAnnotation(java.lang.String qualifiedName)
```
    Description copied from interface: PsiAnnotationOwner
    
    Adds a new annotation to this owner. The annotation class name will be shortened. No attributes will be defined.
    
    Specified by:
    
    addAnnotation in interface PsiAnnotationOwner
    
    Parameters:
    
    qualifiedName - qualifiedName
    
    Returns:
    
    newly added annotation
  - getApplicableAnnotations
```
public PsiAnnotation [] getApplicableAnnotations()
```
    Specified by:
    
    getApplicableAnnotations in interface PsiAnnotationOwner
    
    Returns:
    
    the list of annotations which are applicable to this owner (e.g. type annotations on method belong to its type element, not the method).
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class PsiType

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.intellij.psi.PsiAnnotationOwner

Methods inherited from interface com.intellij.lang.jvm.types.JvmType

Field Detail

BYTE

CHAR

DOUBLE

FLOAT

INT

LONG

SHORT

BOOLEAN

VOID

NULL

EMPTY_ARRAY

ARRAY_FACTORY

Constructor Detail

PsiType

PsiType

Method Detail

createArray

annotate

createArrayType

createArrayType

getPresentableText

getPresentableText

getCanonicalText

getCanonicalText

getInternalCanonicalText

isValid

isAssignableFrom

isConvertibleFrom

equalsToText

getTypeByName

getJavaLangObject

getJavaLangClass

getJavaLangThrowable

getJavaLangString

getJavaLangError

getJavaLangRuntimeException

accept

getArrayDimensions

getDeepComponentType

getResolveScope

getSuperTypes

getAnnotationProvider

getAnnotations

findAnnotation

addAnnotation

getApplicableAnnotations

toString