Subst_c

java.lang.Object
- polyglot.ext.param.types.Subst_c<Formal,Actual>

All Implemented Interfaces:

java.io.Serializable, Subst<Formal,Actual>

Direct Known Subclasses:

JL5Subst_c
```
public class Subst_c<Formal extends Param,Actual extends TypeObject>
extends java.lang.Object
implements Subst<Formal,Actual>
```
Utility class that performs substitutions on type objects using a map. Subclasses must define how the substitutions are performed and how to cache substituted types.

See Also:
Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`protected class`	`Subst_c.CacheTypeWrapper`
`class`	`Subst_c.ConstructorXform<T extends ConstructorInstance>` Function object for transforming constructors.
`class`	`Subst_c.FieldXform<T extends FieldInstance>` Function object for transforming fields.
`class`	`Subst_c.MethodXform<T extends MethodInstance>` Function object for transforming methods.
`class`	`Subst_c.TypeXform<T extends Type>` Function object for transforming types.

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.util.Map<Subst_c.CacheTypeWrapper,Type>`	`cache` Cache of types, from CacheTypeWrapper(t) to subst(t).
`protected java.util.Map<Formal,Actual>`	`subst` Map from formal parameters (of type Param) to actuals.
`protected java.util.Map<ClassType,ClassType>`	`substClassTypeCache`
`protected ParamTypeSystem<Formal,Actual>`	`ts`

Constructor Summary

Constructors
Constructor and Description

Subst_c(ParamTypeSystem<Formal,Actual> ts, java.util.Map<Formal,? extends Actual> subst)

Constructors
Constructor and Description
`Subst_c(ParamTypeSystem<Formal,Actual> ts, java.util.Map<Formal,? extends Actual> subst)`

Method Summary

Methods
Modifier and Type	Method and Description
`protected Type`	`cacheGet(Type t)`
`protected void`	`cachePut(Type t, Type cached)`
`protected boolean`	`cacheTypeEquality(Type t1, Type t2)` This method is used by the cache lookup to test type equality.
`java.util.Iterator<java.util.Map.Entry<Formal,Actual>>`	`entries()` Entries of the underlying substitution map.
`boolean`	`equals(java.lang.Object o)`
`int`	`hashCode()`
`java.lang.Iterable<java.util.Map.Entry<Formal,Actual>>`	`is_entry()` An Iterable that calls entries().
`ClassType`	`substClassType(ClassType t)` Perform substitutions on a class type.
`protected ClassType`	`substClassTypeImpl(ClassType t)`
`<T extends ConstructorInstance> T`	`substConstructor(T ci)` Perform substitutions on a constructor.
`<T extends ConstructorInstance> java.util.List<T>`	`substConstructorList(java.util.List<T> list)` Perform substitutions on a list of `ConstructorInstance`s.
`protected ReferenceType`	`substContainer(MemberInstance mi)`
`<T extends FieldInstance> T`	`substField(T fi)` Perform substitutions on a field.
`<T extends FieldInstance> java.util.List<T>`	`substFieldList(java.util.List<T> list)` Perform substitutions on a list of `FieldInstance`s.
`java.util.Map<Formal,Actual>`	`substitutions()` The map of formals to actuals.
`<T extends MethodInstance> T`	`substMethod(T mi)` Perform substitutions on a method.
`<T extends MethodInstance> java.util.List<T>`	`substMethodList(java.util.List<T> list)` Perform substitutions on a list of `MethodInstance`s.
`PClass<Formal,Actual>`	`substPClass(PClass<Formal,Actual> pclazz)` Perform substitutions on a PClass.
`protected Actual`	`substSubstValue(Actual value)` When adding a new substitution A->B to the map, we need to check if there are already any existing substitutions, say C->A, and if so, replace them appropriately, in this case with C->B.
`Type`	`substType(Type t)` Perform substitutions on a type.
`<T extends Type> java.util.List<T>`	`substTypeList(java.util.List<? extends Type> list)` Perform substitutions on a list of `Type`s.
`java.lang.String`	`toString()`
`ParamTypeSystem<Formal,Actual>`	`typeSystem()` Type system
`protected Subst_c.CacheTypeWrapper`	`typeWrapper(Type t)`
`protected Type`	`uncachedSubstType(Type t)` Perform substitutions on a type, without checking the cache.

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

- Field Detail
  - subst
```
protected java.util.Map<Formal extends Param,Actual extends TypeObject> subst
```
    Map from formal parameters (of type Param) to actuals.
  - cache
```
protected transient java.util.Map<Subst_c.CacheTypeWrapper,Type> cache
```
    Cache of types, from CacheTypeWrapper(t) to subst(t).
  - substClassTypeCache
```
protected transient java.util.Map<ClassType,ClassType> substClassTypeCache
```
  - ts
```
protected transient ParamTypeSystem<Formal extends Param,Actual extends TypeObject> ts
```
- Constructor Detail
  - Subst_c
```
public Subst_c(ParamTypeSystem<Formal,Actual> ts,
       java.util.Map<Formal,? extends Actual> subst)
```
- Method Detail
  - typeSystem
```
public ParamTypeSystem<Formal,Actual> typeSystem()
```
    Description copied from interface: Subst
    
    Type system
    
    Specified by:
    
    typeSystem in interface Subst<Formal extends Param,Actual extends TypeObject>
  - entries
```
public java.util.Iterator<java.util.Map.Entry<Formal,Actual>> entries()
```
    Description copied from interface: Subst
    
    Entries of the underlying substitution map.
    
    Specified by:
    
    entries in interface Subst<Formal extends Param,Actual extends TypeObject>
    
    Returns:
    An Iterator of Map.Entry.
  - is_entry
```
public java.lang.Iterable<java.util.Map.Entry<Formal,Actual>> is_entry()
```
    Description copied from interface: Subst
    
    An Iterable that calls entries().
    
    Specified by:
    
    is_entry in interface Subst<Formal extends Param,Actual extends TypeObject>
  - substitutions
```
public java.util.Map<Formal,Actual> substitutions()
```
    Description copied from interface: Subst
    
    The map of formals to actuals.
    
    Specified by:
    
    substitutions in interface Subst<Formal extends Param,Actual extends TypeObject>
  - uncachedSubstType
```
protected Type uncachedSubstType(Type t)
```
    Perform substitutions on a type, without checking the cache.
  - substSubstValue
```
protected Actual substSubstValue(Actual value)
```
    When adding a new substitution A->B to the map, we need to check if there are already any existing substitutions, say C->A, and if so, replace them appropriately, in this case with C->B. This method allows subclasses to perform substitution on a value in the substitution map (B in the example above). Subclasses may need to override this if the keys and values are not the same object.
  - substClassType
```
public final ClassType substClassType(ClassType t)
```
    Perform substitutions on a class type. Substitutions are performed lazily.
  - substClassTypeImpl
```
protected ClassType substClassTypeImpl(ClassType t)
```
  - substType
```
public Type substType(Type t)
```
    Description copied from interface: Subst
    
    Perform substitutions on a type.
    
    Specified by:
    
    substType in interface Subst<Formal extends Param,Actual extends TypeObject>
  - typeWrapper
```
protected Subst_c.CacheTypeWrapper typeWrapper(Type t)
```
  - cachePut
```
protected void cachePut(Type t,
            Type cached)
```
  - cacheGet
```
protected Type cacheGet(Type t)
```
  - cacheTypeEquality
```
protected boolean cacheTypeEquality(Type t1,
                        Type t2)
```
    This method is used by the cache lookup to test type equality. May be overridden by subclasses as appropriate.
  - substPClass
```
public PClass<Formal,Actual> substPClass(PClass<Formal,Actual> pclazz)
```
    Description copied from interface: Subst
    
    Perform substitutions on a PClass.
    
    Specified by:
    
    substPClass in interface Subst<Formal extends Param,Actual extends TypeObject>
  - substField
```
public <T extends FieldInstance> T substField(T fi)
```
    Description copied from interface: Subst
    
    Perform substitutions on a field.
    
    Specified by:
    
    substField in interface Subst<Formal extends Param,Actual extends TypeObject>
  - substMethod
```
public <T extends MethodInstance> T substMethod(T mi)
```
    Description copied from interface: Subst
    
    Perform substitutions on a method.
    
    Specified by:
    
    substMethod in interface Subst<Formal extends Param,Actual extends TypeObject>
  - substConstructor
```
public <T extends ConstructorInstance> T substConstructor(T ci)
```
    Description copied from interface: Subst
    
    Perform substitutions on a constructor.
    
    Specified by:
    
    substConstructor in interface Subst<Formal extends Param,Actual extends TypeObject>
  - substContainer
```
protected ReferenceType substContainer(MemberInstance mi)
```
  - substTypeList
```
public <T extends Type> java.util.List<T> substTypeList(java.util.List<? extends Type> list)
```
    Description copied from interface: Subst
    
    Perform substitutions on a list of Types.
    
    Specified by:
    
    substTypeList in interface Subst<Formal extends Param,Actual extends TypeObject>
  - substMethodList
```
public <T extends MethodInstance> java.util.List<T> substMethodList(java.util.List<T> list)
```
    Description copied from interface: Subst
    
    Perform substitutions on a list of MethodInstances.
    
    Specified by:
    
    substMethodList in interface Subst<Formal extends Param,Actual extends TypeObject>
  - substConstructorList
```
public <T extends ConstructorInstance> java.util.List<T> substConstructorList(java.util.List<T> list)
```
    Description copied from interface: Subst
    
    Perform substitutions on a list of ConstructorInstances.
    
    Specified by:
    
    substConstructorList in interface Subst<Formal extends Param,Actual extends TypeObject>
  - substFieldList
```
public <T extends FieldInstance> java.util.List<T> substFieldList(java.util.List<T> list)
```
    Description copied from interface: Subst
    
    Perform substitutions on a list of FieldInstances.
    
    Specified by:
    
    substFieldList in interface Subst<Formal extends Param,Actual extends TypeObject>
  - equals
```
public boolean equals(java.lang.Object o)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class Subst_c<Formal extends Param,Actual extends TypeObject>

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

subst

cache

substClassTypeCache

ts

Constructor Detail

Subst_c

Method Detail

typeSystem

entries

is_entry

substitutions

uncachedSubstType

substSubstValue

substClassType

substClassTypeImpl

substType

typeWrapper

cachePut

cacheGet

cacheTypeEquality

substPClass

substField

substMethod

substConstructor

substContainer

substTypeList

substMethodList

substConstructorList

substFieldList

equals

hashCode

toString