Package pascal.taie.config

Record Class Plan

java.lang.Object

java.lang.Record

pascal.taie.config.Plan

Record Components:

analyses - list of analyses to be executed.

dependenceGraph - graph that describes dependencies among analyses. This graph is used to clear unused analysis results.

keepResult - set of IDs for the analyses whose results are kept.

public record Plan(List<AnalysisConfig> analyses, Graph<AnalysisConfig> dependenceGraph, Set<String> keepResult)
extends Record

Contains information about analysis execution plan.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	KEEP_ALL	Special element for keepResult, which means to keep results of all analyses.

Constructor Summary

Constructors

Constructor	Description
Plan(List<AnalysisConfig> analyses, Graph<AnalysisConfig> dependenceGraph, Set<String> keepResult)	Creates an instance of a Plan record class.

Method Summary

Modifier and Type	Method	Description
List<AnalysisConfig>	analyses()	Returns the value of the analyses record component.
Graph<AnalysisConfig>	dependenceGraph()	Returns the value of the dependenceGraph record component.
static Plan	emptyPlan()
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
Set<String>	keepResult()	Returns the value of the keepResult record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

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

Field Details

KEEP_ALL

public static final String KEEP_ALL

Special element for keepResult, which means to keep results of all analyses.

See Also:

• Constant Field Values

Constructor Details

Plan

public Plan(List<AnalysisConfig> analyses,
 Graph<AnalysisConfig> dependenceGraph,
 Set<String> keepResult)

Creates an instance of a Plan record class.

Parameters:

analyses - the value for the analyses record component

dependenceGraph - the value for the dependenceGraph record component

keepResult - the value for the keepResult record component

Method Details

emptyPlan

public static Plan emptyPlan()

Returns:

an empty plan.

toString

public final 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

hashCode

public final 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 final boolean equals(Object o)

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:

o - the object with which to compare

Returns:

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

analyses

public List<AnalysisConfig> analyses()

Returns the value of the analyses record component.

Returns:

the value of the analyses record component

dependenceGraph

public Graph<AnalysisConfig> dependenceGraph()

Returns the value of the dependenceGraph record component.

Returns:

the value of the dependenceGraph record component

keepResult

public Set<String> keepResult()

Returns the value of the keepResult record component.

Returns:

the value of the keepResult record component