gov.nasa.jpf.vm

Interface ChoiceGenerator<T>

All Superinterfaces:

Cloneable

All Known Subinterfaces:

DoubleChoiceGenerator, FloatChoiceGenerator, IntChoiceGenerator, LongChoiceGenerator, ReferenceChoiceGenerator, ThreadChoiceGenerator

All Known Implementing Classes:

BooleanChoiceGenerator, BreakGenerator, ChoiceGeneratorBase, DoubleChoiceFromList, DoubleChoiceFromSet, DoubleThresholdGenerator, EventGenerator, FloatChoiceFromList, IntChoiceFromList, IntChoiceFromSet, IntIntervalGenerator, InvocationCG, LongChoiceFromList, NumberChoiceFromList, RandomIntIntervalGenerator, RandomOrderIntCG, RandomOrderLongCG, ThreadChoiceFromSet, TypedObjectChoice

public interface ChoiceGenerator<T>
extends Cloneable

generic interface for configurable choice generators

Method Summary

Methods

Modifier and Type	Method and Description
void	addAttr(Object a)
void	advance() advance to the next choice.
void	advance(int nChoices)
ObjectList.Iterator	attrIterator()
<A> ObjectList.TypedIterator<A>	attrIterator(Class<A> attrType)
ChoiceGenerator<?>	clone()
ChoiceGenerator<?>	deepClone()
ChoiceGenerator<?>[]	getAll() return array with all parents and this CG, in registration order
<C extends ChoiceGenerator<?>> C[]	getAllOfType(Class<C> cgType) return array with all CGs (including this one) of given 'cgType', in registration order
Object	getAttr() this returns all of them - use either if you know there will be only one attribute at a time, or check/process result with ObjectList
<A> A	getAttr(Class<A> attrType) this only returns the first attr of this type, there can be more if you don't use client private types or the provided type is too general
ChoiceGenerator<?>[]	getCascade() return array with all cascaded parents and this CG, in registration order
ChoiceGenerator<?>	getCascadedParent() returns the prev CG if it was registered for the same insn
Class<T>	getChoiceType()
String	getId()
int	getIdRef()
Instruction	getInsn()
<A> A	getNextAttr(Class<A> attrType, Object prev)
T	getNextChoice()
ChoiceGenerator<?>	getPreviousChoiceGenerator()
<T extends ChoiceGenerator<?>> T	getPreviousChoiceGeneratorOfType(Class<T> cls)
int	getProcessedNumberOfChoices()
String	getSourceLocation()
ThreadInfo	getThreadInfo()
int	getTotalNumberOfChoices()
boolean	hasAttr()
boolean	hasAttr(Class<?> attrType)
boolean	hasMoreChoices()
boolean	isCascaded()
boolean	isDone()
boolean	isProcessed()
boolean	isSchedulingPoint()
ChoiceGenerator<T>	randomize() turn the order of choices random (if it isn't already).
void	removeAttr(Object a)
ChoiceGenerator<T>	reorder(Comparator<T> comparator) reorder according to a user provided comparator
void	replaceAttr(Object oldAttr, Object newAttr)
void	reset() this has to reset the CG to its initial state, which includes resetting 'isDone'
void	select(int nChoice)
void	setAttr(Object a) this replaces all of them - use only if you know - there will be only one attribute at a time - you obtained the value you set by a previous getXAttr() - you constructed a multi value list with ObjectList.createList()
void	setCascaded()
void	setContext(ThreadInfo tiCreator)
void	setDone()
void	setId(String id)
void	setIdRef(int idRef)
void	setInsn(Instruction insn)
void	setPreviousChoiceGenerator(ChoiceGenerator<?> cg)
void	setThreadInfo(ThreadInfo ti)
boolean	supportsReordering()

Method Detail

getNextChoice

T getNextChoice()

getChoiceType

Class<T> getChoiceType()

hasMoreChoices

boolean hasMoreChoices()

advance

void advance()

advance to the next choice. This is the only method that really advances our enumeration

advance

void advance(int nChoices)

select

void select(int nChoice)

isDone

boolean isDone()

setDone

void setDone()

isProcessed

boolean isProcessed()

reset

void reset()

this has to reset the CG to its initial state, which includes resetting 'isDone'

getTotalNumberOfChoices

int getTotalNumberOfChoices()

getProcessedNumberOfChoices

int getProcessedNumberOfChoices()

getPreviousChoiceGenerator

ChoiceGenerator<?> getPreviousChoiceGenerator()

randomize

ChoiceGenerator<T> randomize()

turn the order of choices random (if it isn't already). Only drawback of this generic method (which might be a decorator factory) is that our type layer (e.g. IntChoiceGenerator) has to guarantee type safety. But hey - this is the first case where we can use covariant return types! NOTES: - this method may alter this ChoiceGenerator and return that or return a new "decorated" version. - random data can be read from the "Random random" field in this class.

clone

ChoiceGenerator<?> clone()
                         throws CloneNotSupportedException

Throws:

CloneNotSupportedException

deepClone

ChoiceGenerator<?> deepClone()
                             throws CloneNotSupportedException

Throws:

CloneNotSupportedException

getId

String getId()

getIdRef

int getIdRef()

setIdRef

void setIdRef(int idRef)

setId

void setId(String id)

isSchedulingPoint

boolean isSchedulingPoint()

setThreadInfo

void setThreadInfo(ThreadInfo ti)

getThreadInfo

ThreadInfo getThreadInfo()

setInsn

void setInsn(Instruction insn)

getInsn

Instruction getInsn()

setContext

void setContext(ThreadInfo tiCreator)

getSourceLocation

String getSourceLocation()

supportsReordering

boolean supportsReordering()

reorder

ChoiceGenerator<T> reorder(Comparator<T> comparator)

reorder according to a user provided comparator

setPreviousChoiceGenerator

void setPreviousChoiceGenerator(ChoiceGenerator<?> cg)

setCascaded

void setCascaded()

isCascaded

boolean isCascaded()

getPreviousChoiceGeneratorOfType

<T extends ChoiceGenerator<?>> T getPreviousChoiceGeneratorOfType(Class<T> cls)

getCascadedParent

ChoiceGenerator<?> getCascadedParent()

returns the prev CG if it was registered for the same insn

getCascade

ChoiceGenerator<?>[] getCascade()

return array with all cascaded parents and this CG, in registration order

getAll

ChoiceGenerator<?>[] getAll()

return array with all parents and this CG, in registration order

getAllOfType

<C extends ChoiceGenerator<?>> C[] getAllOfType(Class<C> cgType)

return array with all CGs (including this one) of given 'cgType', in registration order

hasAttr

boolean hasAttr()

hasAttr

boolean hasAttr(Class<?> attrType)

getAttr

Object getAttr()

this returns all of them - use either if you know there will be only one attribute at a time, or check/process result with ObjectList

setAttr

void setAttr(Object a)

this replaces all of them - use only if you know - there will be only one attribute at a time - you obtained the value you set by a previous getXAttr() - you constructed a multi value list with ObjectList.createList()

addAttr

void addAttr(Object a)

removeAttr

void removeAttr(Object a)

replaceAttr

void replaceAttr(Object oldAttr,
               Object newAttr)

getAttr

<A> A getAttr(Class<A> attrType)

this only returns the first attr of this type, there can be more if you don't use client private types or the provided type is too general

getNextAttr

<A> A getNextAttr(Class<A> attrType,
                Object prev)

attrIterator

ObjectList.Iterator attrIterator()

attrIterator

<A> ObjectList.TypedIterator<A> attrIterator(Class<A> attrType)