com.oracle.graal.pointsto.typestate

Class TypeState

java.lang.Object

com.oracle.graal.pointsto.typestate.TypeState

Direct Known Subclasses:

MultiTypeState, SingleTypeState

public abstract class TypeState
extends Object

Constructor Summary

Constructors

Constructor and Description
TypeState()

Method Summary

Modifier and Type	Method and Description
JavaConstant	asConstant() Returns a non-null value when this type state represents a single constant value, or null if this type state is not a single constant.
abstract boolean	canBeNull()
abstract boolean	containsType(AnalysisType exactType) Returns true if this type state contains the type, otherwise it returns false.
abstract boolean	equals(Object o)
abstract AnalysisType	exactType() If this type state has a single, exact type it returns that type, otherwise it returns null.
abstract TypeState	forCanBeNull(PointsToAnalysis bb, boolean stateCanBeNull)
static TypeState	forConstant(PointsToAnalysis bb, JavaConstant constant, AnalysisType exactType) Wraps the analysis object corresponding to a JavaConstant into a non-null type state.
static TypeState	forEmpty()
static SingleTypeState	forExactType(PointsToAnalysis bb, AnalysisObject object, boolean canBeNull)
static SingleTypeState	forExactType(PointsToAnalysis bb, AnalysisType exactType, boolean canBeNull)
static TypeState	forIntersection(PointsToAnalysis bb, TypeState s1, TypeState s2)
TypeState	forNonNull(PointsToAnalysis bb)
static TypeState	forNonNullObject(PointsToAnalysis bb, AnalysisObject object) Wraps an analysis object into a non-null type state.
static TypeState	forNull()
static TypeState	forSubtraction(PointsToAnalysis bb, TypeState s1, TypeState s2)
static TypeState	forType(PointsToAnalysis bb, AnalysisObject object, boolean canBeNull)
static TypeState	forType(PointsToAnalysis bb, AnalysisType type, boolean canBeNull)
static TypeState	forUnion(PointsToAnalysis bb, TypeState s1, TypeState s2)
int	hashCode()
boolean	isAllocation()
boolean	isEmpty()
boolean	isMerged()
boolean	isNull()
void	noteMerge(PointsToAnalysis bb) Note that the objects of this type state have been merged.
Iterable<AnalysisObject>	objects(AnalysisType type) Provides an iterable for the objects corresponding to the type.
Iterable<AnalysisObject>	objects(BigBang bb)
abstract int	objectsCount() Get the number of objects.
protected abstract Iterator<AnalysisObject>	objectsIterator(AnalysisType type) Provides an iterator for the objects corresponding to the type.
protected abstract Iterator<AnalysisObject>	objectsIterator(BigBang bb)
Iterable<AnalysisType>	types(BigBang bb) Provides an iterable for the types for easy "for-each loop" iteration.
abstract int	typesCount() Get the number of types.
protected abstract Iterator<AnalysisType>	typesIterator(BigBang bb) Provides an iterator over the types.
Stream<AnalysisType>	typesStream(BigBang bb) Provides a stream for the types.
boolean	verifyDeclaredType(BigBang bb, AnalysisType declaredType)

Methods inherited from class java.lang.Object

clone, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TypeState

public TypeState()

Method Detail

typesCount

public abstract int typesCount()

Get the number of types.

exactType

public abstract AnalysisType exactType()

If this type state has a single, exact type it returns that type, otherwise it returns null.

typesIterator

protected abstract Iterator<AnalysisType> typesIterator(BigBang bb)

Provides an iterator over the types.

types

public Iterable<AnalysisType> types(BigBang bb)

Provides an iterable for the types for easy "for-each loop" iteration.

typesStream

public Stream<AnalysisType> typesStream(BigBang bb)

Provides a stream for the types.

containsType

public abstract boolean containsType(AnalysisType exactType)

Returns true if this type state contains the type, otherwise it returns false.

objectsCount

public abstract int objectsCount()

Get the number of objects.

objectsIterator

protected abstract Iterator<AnalysisObject> objectsIterator(BigBang bb)

objects

public final Iterable<AnalysisObject> objects(BigBang bb)

objectsIterator

protected abstract Iterator<AnalysisObject> objectsIterator(AnalysisType type)

Provides an iterator for the objects corresponding to the type. The objects are returned from the internal objects array and are not materialized to a different data structure.

objects

public Iterable<AnalysisObject> objects(AnalysisType type)

Provides an iterable for the objects corresponding to the type. The objects are returned from the internal objects array and are not materialized to a different data structure.

isAllocation

public boolean isAllocation()

asConstant

public JavaConstant asConstant()

Returns a non-null value when this type state represents a single constant value, or null if this type state is not a single constant. Note that the TypeState.canBeNull() flag still applies when a constant is returned. A type state that is a "constant or null" both returns a non-null result for TypeState.asConstant()} and true for TypeState.canBeNull().

isEmpty

public boolean isEmpty()

isNull

public boolean isNull()

canBeNull

public abstract boolean canBeNull()

noteMerge

public void noteMerge(PointsToAnalysis bb)

Note that the objects of this type state have been merged.

isMerged

public boolean isMerged()

verifyDeclaredType

public boolean verifyDeclaredType(BigBang bb,
                                  AnalysisType declaredType)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public abstract boolean equals(Object o)

Overrides:

equals in class Object

forEmpty

public static TypeState forEmpty()

forNull

public static TypeState forNull()

forNonNullObject

public static TypeState forNonNullObject(PointsToAnalysis bb,
                                         AnalysisObject object)

Wraps an analysis object into a non-null type state.

forConstant

public static TypeState forConstant(PointsToAnalysis bb,
                                    JavaConstant constant,
                                    AnalysisType exactType)

Wraps the analysis object corresponding to a JavaConstant into a non-null type state.

forExactType

public static SingleTypeState forExactType(PointsToAnalysis bb,
                                           AnalysisType exactType,
                                           boolean canBeNull)

forExactType

public static SingleTypeState forExactType(PointsToAnalysis bb,
                                           AnalysisObject object,
                                           boolean canBeNull)

forType

public static TypeState forType(PointsToAnalysis bb,
                                AnalysisType type,
                                boolean canBeNull)

forType

public static TypeState forType(PointsToAnalysis bb,
                                AnalysisObject object,
                                boolean canBeNull)

forNonNull

public final TypeState forNonNull(PointsToAnalysis bb)

forCanBeNull

public abstract TypeState forCanBeNull(PointsToAnalysis bb,
                                       boolean stateCanBeNull)

forUnion

public static TypeState forUnion(PointsToAnalysis bb,
                                 TypeState s1,
                                 TypeState s2)

forIntersection

public static TypeState forIntersection(PointsToAnalysis bb,
                                        TypeState s1,
                                        TypeState s2)

forSubtraction

public static TypeState forSubtraction(PointsToAnalysis bb,
                                       TypeState s1,
                                       TypeState s2)