Record Class AllocationSite

java.lang.Object

java.lang.Record

com.ibm.wala.ipa.callgraph.propagation.AllocationSite

All Implemented Interfaces:

ContextItem, InstanceKey

public record AllocationSite(IMethod method, NewSiteReference site, IClass concreteType)
extends Record
implements InstanceKey

An InstanceKey which represents a NewSiteReference in some IMethod. Note that this differs from AllocationSiteInNode, which represents an allocation in a CGNode that may carry some Context. This type is useful for a context-insensitive heap abstraction.

Nested Class Summary

Nested classes/interfaces inherited from interface ContextItem

ContextItem.Value<T>

Modifier and Type	Interface	Description
static class	ContextItem.Value<T>

Constructor Summary

Constructors

Constructor	Description
AllocationSite(IMethod method, NewSiteReference site, IClass concreteType)	Creates an instance of a AllocationSite record class.

Method Summary

Modifier and Type	Method	Description
IClass	concreteType()	Returns the value of the concreteType record component.
boolean	equals(Object obj)	Indicates whether some other object is "equal to" this one.
Iterator<Pair<CGNode, NewSiteReference>>	getCreationSites(CallGraph CG)	Get the creation sites of this, i.e., the statements that may allocate objects represented by this.
IMethod	getMethod()	Deprecated, for removal: This API element is subject to removal in a future version. Use method() instead
NewSiteReference	getSite()	Deprecated, for removal: This API element is subject to removal in a future version. Use site() instead
int	hashCode()	Returns a hash code value for this object.
IMethod	method()	Returns the value of the method record component.
NewSiteReference	site()	Returns the value of the site record component.
String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

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

Methods inherited from interface InstanceKey

getConcreteType

Modifier and Type	Method	Description
default IClass	getConcreteType()	Deprecated, for removal: This API element is subject to removal in a future version. Use InstanceKey.concreteType() instead

Constructor Details

AllocationSite

public AllocationSite(IMethod method,
 NewSiteReference site,
 IClass concreteType)

Creates an instance of a AllocationSite record class.

Parameters:

method - the value for the method record component

site - the value for the site record component

concreteType - the value for the concreteType record component

Method Details

toString

public String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

getSite

@Deprecated(forRemoval=true,
            since="1.8.0")
public NewSiteReference getSite()

Deprecated, for removal: This API element is subject to removal in a future version.

Use site() instead

getMethod

@Deprecated(forRemoval=true,
            since="1.8.0")
public IMethod getMethod()

Deprecated, for removal: This API element is subject to removal in a future version.

Use method() instead

hashCode

public int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public boolean equals(Object obj)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

obj - the object with which to compare

Returns:

true if this object is the same as the obj argument; false otherwise.

getCreationSites

public Iterator<Pair<CGNode, NewSiteReference>> getCreationSites(CallGraph CG)

Description copied from interface: InstanceKey

Get the creation sites of this, i.e., the statements that may allocate objects represented by this. A creation site is a pair (n,s), where n is the containing CGNode in the given CallGraph CG and s is the allocating NewSiteReference.

Specified by:

getCreationSites in interface InstanceKey

method

public IMethod method()

Returns the value of the method record component.

Returns:

the value of the method record component

site

public NewSiteReference site()

Returns the value of the site record component.

Returns:

the value of the site record component

concreteType

public IClass concreteType()

Returns the value of the concreteType record component.

Specified by:

concreteType in interface InstanceKey

Returns:

the value of the concreteType record component