Package com.intellij.psi

Interface PsiSubstitutor

All Known Implementing Classes:

EmptySubstitutor, PsiSubstitutorImpl

public interface PsiSubstitutor

Represents a mapping between type parameters and their values.

See Also:

JavaResolveResult.getSubstitutor()

Field Summary

Fields

Modifier and Type	Field and Description
static PsiSubstitutor	EMPTY Empty, or natural, substitutor.
static Key<PsiSubstitutor>	KEY
static PsiSubstitutor	UNKNOWN

Method Summary

Modifier and Type	Method and Description
static PsiSubstitutor	createSubstitutor(java.util.Map<? extends PsiTypeParameter,? extends PsiType> map) Create a substitutor from the supplied map
void	ensureValid() If this substitutor is not valid, throws an exception with some diagnostics
java.util.Map<PsiTypeParameter,PsiType>	getSubstitutionMap() Returns the map from type parameters to types used for substitution by this substitutor.
boolean	isValid() Checks if all types which the substitutor can substitute are valid.
PsiSubstitutor	put(PsiTypeParameter classParameter, PsiType mapping) Creates a substitutor instance which provides the specified parameter to type mapping in addition to mappings contained in this substitutor.
default PsiSubstitutor	putAll(java.util.Map<? extends PsiTypeParameter,? extends PsiType> map) Creates a substitutor instance containing all mappings from this substitutor and the specified map.
PsiSubstitutor	putAll(PsiClass parentClass, PsiType[] mappings) Creates a substitutor instance which maps the type parameters of the specified class to the specified types in addition to mappings contained in this substitutor.
PsiSubstitutor	putAll(PsiSubstitutor another) Creates a substitutor instance containing all mappings from this substitutor and the specified substitutor.
PsiType	substitute(PsiType type) Substitutes type parameters occurring in type with their values.
PsiType	substitute(PsiTypeParameter typeParameter) Returns a mapping that this substitutor contains for a given type parameter.
PsiType	substituteWithBoundsPromotion(PsiTypeParameter typeParameter)

Field Detail

EMPTY

static final PsiSubstitutor EMPTY

Empty, or natural, substitutor. For any type parameter T, substitutes type T. Example: consider class List<E>. this inside class List has type List with EMPTY substitutor.

KEY

static final Key<PsiSubstitutor> KEY

UNKNOWN

static final PsiSubstitutor UNKNOWN

Method Detail

substitute

PsiType substitute(PsiTypeParameter typeParameter)

Returns a mapping that this substitutor contains for a given type parameter. Does not perform bounds promotion

Parameters:

typeParameter - the parameter to return the mapping for.

Returns:

the mapping for the type parameter, or null for a raw type.

substitute

PsiType substitute(PsiType type)

Substitutes type parameters occurring in type with their values. If value for type parameter is null, appropriate erasure is returned.

Parameters:

type - the type to substitute the type parameters for.

Returns:

the result of the substitution.

substituteWithBoundsPromotion

PsiType substituteWithBoundsPromotion(PsiTypeParameter typeParameter)

put

PsiSubstitutor put(PsiTypeParameter classParameter,
                   PsiType mapping)

Creates a substitutor instance which provides the specified parameter to type mapping in addition to mappings contained in this substitutor.

Parameters:

classParameter - the parameter which is mapped.

mapping - the type to which the parameter is mapped.

Returns:

the new substitutor instance.

putAll

PsiSubstitutor putAll(PsiClass parentClass,
                      PsiType[] mappings)

Creates a substitutor instance which maps the type parameters of the specified class to the specified types in addition to mappings contained in this substitutor.

Parameters:

parentClass - the class whose parameters are mapped.

mappings - the types to which the parameters are mapped.

Returns:

the new substitutor instance.

putAll

PsiSubstitutor putAll(PsiSubstitutor another)

Creates a substitutor instance containing all mappings from this substitutor and the specified substitutor.

Parameters:

another - the substitutor to get the mappings from.

Returns:

the new substitutor instance.

putAll

default PsiSubstitutor putAll(java.util.Map<? extends PsiTypeParameter,? extends PsiType> map)

Creates a substitutor instance containing all mappings from this substitutor and the specified map.

Parameters:

map - a map which contains additional mappings

Returns:

the new substitutor instance.

getSubstitutionMap

java.util.Map<PsiTypeParameter,PsiType> getSubstitutionMap()

Returns the map from type parameters to types used for substitution by this substitutor.

Returns:

the substitution map instance.

createSubstitutor

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

Create a substitutor from the supplied map

Parameters:

map - a map to create a substitutor from

Returns:

a substitutor backed by the supplied map

isValid

boolean isValid()

Checks if all types which the substitutor can substitute are valid.

Returns:

true if all types are valid, false otherwise.

See Also:

PsiType.isValid()

ensureValid

void ensureValid()

If this substitutor is not valid, throws an exception with some diagnostics