Package soot.toolkits.scalar

Class AbstractFlowSet<T>

java.lang.Object

soot.toolkits.scalar.AbstractFlowSet<T>

All Implemented Interfaces:

Iterable<T>, FlowSet<T>

Direct Known Subclasses:

AbstractBoundedFlowSet, ArraySparseSet, DavaFlowSet, HashSparseSet, ToppedSet

public abstract class AbstractFlowSet<T>
extends Object
implements FlowSet<T>

provides functional code for most of the methods. Subclasses are invited to provide a more efficient version. Most often this will be done in the following way:

 public void yyy(FlowSet dest) {
   if (dest instanceof xxx) {
     blahblah;
   } else
     super.yyy(dest)
 }
 

Constructor Summary

Constructors

Constructor	Description
AbstractFlowSet()

Method Summary

Modifier and Type	Method	Description
abstract void	add(T obj)	Adds obj to this.
void	add(T obj, FlowSet<T> dest)	puts this union obj into dest.
void	clear()	implemented, but *very* inefficient.
abstract AbstractFlowSet<T>	clone()	Clones the current FlowSet.
abstract boolean	contains(T obj)	Returns true if this FlowSet contains obj.
void	copy(FlowSet<T> dest)	Copies the current FlowSet into dest.
void	difference(FlowSet<T> other)	Returns the set difference (this intersect ~other) of this FlowSet and other, putting result into this.
void	difference(FlowSet<T> other, FlowSet<T> dest)	Returns the set difference (this intersect ~other) of this FlowSet and other, putting result into dest.
FlowSet<T>	emptySet()	implemented, but inefficient.
boolean	equals(Object o)
int	hashCode()
void	intersection(FlowSet<T> other)	Returns the intersection (meet) of this FlowSet and other, putting result into this.
void	intersection(FlowSet<T> other, FlowSet<T> dest)	Returns the intersection (meet) of this FlowSet and other, putting result into dest.
abstract boolean	isEmpty()	Returns true if this FlowSet is the empty set.
boolean	isSubSet(FlowSet<T> other)	Returns true if the other FlowSet is a subset of this FlowSet.
abstract Iterator<T>	iterator()	returns an iterator over the elements of the flowSet.
abstract void	remove(T obj)	Removes obj from this.
void	remove(T obj, FlowSet<T> dest)	Puts this minus obj into dest.
abstract int	size()	Returns the size of the current FlowSet.
abstract List<T>	toList()	Returns an unbacked list of contained objects for this FlowSet.
String	toString()
void	union(FlowSet<T> other)	Returns the union (join) of this FlowSet and other, putting result into this.
void	union(FlowSet<T> other, FlowSet<T> dest)	Returns the union (join) of this FlowSet and other, putting result into dest.

Methods inherited from class java.lang.Object

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

Methods inherited from interface soot.toolkits.scalar.FlowSet

copyFreshToExisting

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

AbstractFlowSet

public AbstractFlowSet()

Method Detail

clone

public abstract AbstractFlowSet<T> clone()

Description copied from interface: FlowSet

Clones the current FlowSet.

Specified by:

clone in interface FlowSet<T>

Overrides:

clone in class Object

emptySet

public FlowSet<T> emptySet()

implemented, but inefficient.

Specified by:

emptySet in interface FlowSet<T>

copy

public void copy(FlowSet<T> dest)

Description copied from interface: FlowSet

Copies the current FlowSet into dest.

Specified by:

copy in interface FlowSet<T>

clear

public void clear()

implemented, but *very* inefficient.

Specified by:

clear in interface FlowSet<T>

union

public void union(FlowSet<T> other)

Description copied from interface: FlowSet

Returns the union (join) of this FlowSet and other, putting result into this.

Specified by:

union in interface FlowSet<T>

union

public void union(FlowSet<T> other,
                  FlowSet<T> dest)

Description copied from interface: FlowSet

Returns the union (join) of this FlowSet and other, putting result into dest. dest, other and this could be the same object.

Specified by:

union in interface FlowSet<T>

intersection

public void intersection(FlowSet<T> other)

Description copied from interface: FlowSet

Returns the intersection (meet) of this FlowSet and other, putting result into this.

Specified by:

intersection in interface FlowSet<T>

intersection

public void intersection(FlowSet<T> other,
                         FlowSet<T> dest)

Description copied from interface: FlowSet

Returns the intersection (meet) of this FlowSet and other, putting result into dest. dest, other and this could be the same object.

Specified by:

intersection in interface FlowSet<T>

difference

public void difference(FlowSet<T> other)

Description copied from interface: FlowSet

Returns the set difference (this intersect ~other) of this FlowSet and other, putting result into this.

Specified by:

difference in interface FlowSet<T>

difference

public void difference(FlowSet<T> other,
                       FlowSet<T> dest)

Description copied from interface: FlowSet

Returns the set difference (this intersect ~other) of this FlowSet and other, putting result into dest. dest, other and this could be the same object.

Specified by:

difference in interface FlowSet<T>

isEmpty

public abstract boolean isEmpty()

Description copied from interface: FlowSet

Returns true if this FlowSet is the empty set.

Specified by:

isEmpty in interface FlowSet<T>

size

public abstract int size()

Description copied from interface: FlowSet

Returns the size of the current FlowSet.

Specified by:

size in interface FlowSet<T>

add

public abstract void add(T obj)

Description copied from interface: FlowSet

Adds obj to this.

Specified by:

add in interface FlowSet<T>

add

public void add(T obj,
                FlowSet<T> dest)

Description copied from interface: FlowSet

puts this union obj into dest.

Specified by:

add in interface FlowSet<T>

remove

public abstract void remove(T obj)

Description copied from interface: FlowSet

Removes obj from this.

Specified by:

remove in interface FlowSet<T>

remove

public void remove(T obj,
                   FlowSet<T> dest)

Description copied from interface: FlowSet

Puts this minus obj into dest.

Specified by:

remove in interface FlowSet<T>

isSubSet

public boolean isSubSet(FlowSet<T> other)

Description copied from interface: FlowSet

Returns true if the other FlowSet is a subset of this FlowSet.

Specified by:

isSubSet in interface FlowSet<T>

contains

public abstract boolean contains(T obj)

Description copied from interface: FlowSet

Returns true if this FlowSet contains obj.

Specified by:

contains in interface FlowSet<T>

iterator

public abstract Iterator<T> iterator()

Description copied from interface: FlowSet

returns an iterator over the elements of the flowSet. Note that the iterator might be backed, and hence be faster in the creation, than doing toList().iterator().

Specified by:

iterator in interface FlowSet<T>

Specified by:

iterator in interface Iterable<T>

toList

public abstract List<T> toList()

Description copied from interface: FlowSet

Returns an unbacked list of contained objects for this FlowSet.

Specified by:

toList in interface FlowSet<T>

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object