Package com.intellij.psi

Class PsiPrimitiveType

java.lang.Object

com.intellij.psi.PsiType

com.intellij.psi.PsiType.Stub

com.intellij.psi.PsiPrimitiveType

All Implemented Interfaces:

JvmPrimitiveType, JvmType, PsiAnnotationOwner, java.lang.Cloneable

public class PsiPrimitiveType
extends PsiType.Stub
implements JvmPrimitiveType

Represents primitive types of Java language.

Nested Class Summary

Nested classes/interfaces inherited from class com.intellij.psi.PsiType

PsiType.Stub

Field Summary

Fields inherited from class com.intellij.psi.PsiType

ARRAY_FACTORY, BOOLEAN, BYTE, CHAR, DOUBLE, EMPTY_ARRAY, FLOAT, INT, LONG, NULL, SHORT, VOID

Constructor Summary

Constructors

Constructor and Description
PsiPrimitiveType(JvmPrimitiveTypeKind kind, PsiAnnotation [] annotations)
PsiPrimitiveType(JvmPrimitiveTypeKind kind, TypeAnnotationProvider provider)
PsiPrimitiveType(java.lang.String name, PsiAnnotation [] annotations) Deprecated. please don't use PsiPrimitiveType to represent fake types
PsiPrimitiveType(java.lang.String name, TypeAnnotationProvider provider)

Method Summary

Modifier and Type	Method and Description
<A> A	accept(PsiTypeVisitor<A> visitor) Passes the type to the specified visitor.
PsiPrimitiveType	annotate(TypeAnnotationProvider provider)
boolean	equals(java.lang.Object obj)
boolean	equalsToText(java.lang.String text) Checks if the specified string is equivalent to the canonical text of the type.
static java.util.Collection<java.lang.String>	getAllBoxedTypeNames() Deprecated. please use JvmPrimitiveTypeKind.getBoxedFqns()
PsiClassType	getBoxedType(PsiElement context) Returns a boxed class type corresponding to the primitive type.
PsiClassType	getBoxedType(PsiManager manager, GlobalSearchScope resolveScope)
java.lang.String	getBoxedTypeName() This method is nullable since PsiType.NULL has no FQN. Consider using JvmPrimitiveTypeKind.getBoxedFqn() if you know the type you need to get FQN of, e.g.
java.lang.String	getCanonicalText(boolean annotated) Returns canonical representation of the type (all references fully-qualified).
java.lang.String	getInternalCanonicalText() Return canonical text of the type with some internal details added for presentational purposes.
JvmPrimitiveTypeKind	getKind()
java.lang.String	getName()
static PsiPrimitiveType	getOptionallyUnboxedType(PsiType type)
java.lang.String	getPresentableText(boolean annotated) Returns text of the type that can be presented to a user (references normally non-qualified).
GlobalSearchScope	getResolveScope() Returns the scope in which the reference to the underlying class of a class type is searched.
PsiType []	getSuperTypes() Returns the list of superclass types for a class type.
static PsiPrimitiveType	getUnboxedType(PsiType type) Returns the primitive type corresponding to a boxed class type.
int	hashCode()
boolean	isValid() Always returns true.

Methods inherited from class com.intellij.psi.PsiType.Stub

getCanonicalText, getPresentableText

Methods inherited from class com.intellij.psi.PsiType

addAnnotation, createArray, createArrayType, createArrayType, findAnnotation, getAnnotationProvider, getAnnotations, getApplicableAnnotations, getArrayDimensions, getDeepComponentType, getJavaLangClass, getJavaLangError, getJavaLangObject, getJavaLangRuntimeException, getJavaLangString, getJavaLangThrowable, getTypeByName, isAssignableFrom, isConvertibleFrom, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

accept

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

getAnnotations

Methods inherited from interface com.intellij.psi.PsiAnnotationOwner

hasAnnotation

Constructor Detail

PsiPrimitiveType

public PsiPrimitiveType(JvmPrimitiveTypeKind kind,
                        PsiAnnotation [] annotations)

PsiPrimitiveType

public PsiPrimitiveType(JvmPrimitiveTypeKind kind,
                        TypeAnnotationProvider provider)

PsiPrimitiveType

public PsiPrimitiveType(java.lang.String name,
                        TypeAnnotationProvider provider)

Parameters:

name - valid primitive name, or NoSuchElementException will be thrown

PsiPrimitiveType

@Deprecated
public PsiPrimitiveType(java.lang.String name,
                        PsiAnnotation [] annotations)

Deprecated. please don't use PsiPrimitiveType to represent fake types

Method Detail

getKind

public final JvmPrimitiveTypeKind getKind()

Specified by:

getKind in interface JvmPrimitiveType

getName

public java.lang.String getName()

annotate

public PsiPrimitiveType annotate(TypeAnnotationProvider provider)

Overrides:

annotate in class PsiType

getPresentableText

public java.lang.String getPresentableText(boolean annotated)

Description copied from class: PsiType

Returns text of the type that can be presented to a user (references normally non-qualified).

Specified by:

getPresentableText in class PsiType.Stub

getCanonicalText

public java.lang.String getCanonicalText(boolean annotated)

Description copied from class: PsiType

Returns canonical representation of the type (all references fully-qualified).

Specified by:

getCanonicalText in class PsiType.Stub

getInternalCanonicalText

public java.lang.String getInternalCanonicalText()

Description copied from class: PsiType

Return canonical text of the type with some internal details added for presentational purposes. Use with care. todo[r.sh] merge with getPresentableText()

Overrides:

getInternalCanonicalText in class PsiType

isValid

public boolean isValid()

Always returns true.

Specified by:

isValid in class PsiType

Returns:

true if the type is valid, false otherwise.

See Also:

PsiElement.isValid()

equalsToText

public boolean equalsToText(java.lang.String text)

Description copied from class: PsiType

Checks if the specified string is equivalent to the canonical text of the type.

Specified by:

equalsToText in class PsiType

Parameters:

text - the text to compare with.

Returns:

true if the string is equivalent to the type, false otherwise

accept

public <A> A accept(PsiTypeVisitor<A> visitor)

Description copied from class: PsiType

Passes the type to the specified visitor.

Specified by:

accept in class PsiType

Parameters:

visitor - the visitor to accept the type.

Returns:

the value returned by the visitor.

getResolveScope

public GlobalSearchScope getResolveScope()

Description copied from class: PsiType

Returns the scope in which the reference to the underlying class of a class type is searched.

Specified by:

getResolveScope in class PsiType

Returns:

the resolve scope instance, or null if the type is a primitive or an array of primitives.

getSuperTypes

public PsiType [] getSuperTypes()

Description copied from class: PsiType

Returns the list of superclass types for a class type.

Specified by:

getSuperTypes in class PsiType

Returns:

the array of superclass types, or an empty array if the type is not a class type.

getUnboxedType

public static PsiPrimitiveType getUnboxedType(PsiType type)

Returns the primitive type corresponding to a boxed class type.

Parameters:

type - the type to get the unboxed primitive type for.

Returns:

the primitive type, or null if the type does not represent a boxed primitive type.

getOptionallyUnboxedType

public static PsiPrimitiveType getOptionallyUnboxedType(PsiType type)

getBoxedTypeName

public java.lang.String getBoxedTypeName()

This method is nullable since PsiType.NULL has no FQN.
Consider using JvmPrimitiveTypeKind.getBoxedFqn() if you know the type you need to get FQN of, e.g. instead of PsiType.INT.getBoxedTypeName() use JvmPrimitiveTypeKind.INT.getBoxedFqn().

See Also:

JvmPrimitiveTypeKind.getBoxedFqn()

getBoxedType

public PsiClassType getBoxedType(PsiElement context)

Returns a boxed class type corresponding to the primitive type.

Parameters:

context - where this boxed type is to be used

Returns:

the class type, or null if the current language level does not support autoboxing or it was not possible to resolve the reference to the class.

getBoxedType

public PsiClassType getBoxedType(PsiManager manager,
                                 GlobalSearchScope resolveScope)

getAllBoxedTypeNames

@Deprecated
public static java.util.Collection<java.lang.String> getAllBoxedTypeNames()

Deprecated. please use JvmPrimitiveTypeKind.getBoxedFqns()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object