ChoiceGeneratorBase (JPF API)

java.lang.Object
- gov.nasa.jpf.vm.ChoiceGeneratorBase<T>

All Implemented Interfaces:

ChoiceGenerator<T>, Cloneable

Direct Known Subclasses:

BooleanChoiceGenerator, BreakGenerator, DoubleThresholdGenerator, EventGenerator, IntIntervalGenerator, InvocationCG, NumberChoiceFromList, RandomIntIntervalGenerator, RandomOrderIntCG, RandomOrderLongCG, ThreadChoiceFromSet, TypedObjectChoice
```
public abstract class ChoiceGeneratorBase<T>
extends Object
implements ChoiceGenerator<T>
```
abstract root class for configurable choice generators

Field Summary

Fields
Modifier and Type	Field and Description
`protected Object`	`attr`
`protected String`	`id`
`protected int`	`idRef`
`protected Instruction`	`insn`
`protected boolean`	`isCascaded`
`protected boolean`	`isDone`
`static char`	`MARKER`
`protected ChoiceGenerator<?>`	`prev`
`protected static Random`	`random`
`protected ThreadInfo`	`ti`

Constructor Summary

Constructors
Modifier Constructor and Description

protected ChoiceGeneratorBase()
Deprecated.

protected ChoiceGeneratorBase(String id)

Constructors
Modifier	Constructor and Description
`protected`	`ChoiceGeneratorBase()` Deprecated.
`protected`	`ChoiceGeneratorBase(String id)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addAttr(Object a)`
`void`	`advance(int nChoices)` advance n choices pretty braindead generic solution, but if more speed is needed, we can easily override in the concrete CGs (it's used for path replay)
`ObjectList.Iterator`	`attrIterator()`
`<T> ObjectList.TypedIterator<T>`	`attrIterator(Class<T> attrType)`
`ChoiceGeneratorBase<?>`	`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
`<T> T`	`getAttr(Class<T> 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
`String`	`getId()`
`int`	`getIdRef()`
`Instruction`	`getInsn()`
`<T> T`	`getNextAttr(Class<T> attrType, Object prev)`
`ChoiceGenerator<?>`	`getPreviousChoiceGenerator()`
`<C extends ChoiceGenerator<?>> C`	`getPreviousChoiceGeneratorOfType(Class<C> cls)`
`String`	`getSourceLocation()`
`ThreadInfo`	`getThreadInfo()`
`boolean`	`hasAttr()`
`boolean`	`hasAttr(Class<?> attrType)`
`boolean`	`hasAttrValue(Object a)`
`static void`	`init(Config config)`
`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`	`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()`
`String`	`toString()`
`static boolean`	`useRandomization()`

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface gov.nasa.jpf.vm.ChoiceGenerator
advance, getChoiceType, getNextChoice, getProcessedNumberOfChoices, getTotalNumberOfChoices, hasMoreChoices, reset

- Field Detail
  - MARKER
```
public static final char MARKER
```
    See Also:
    Constant Field Values
  - random
```
protected static Random random
```
  - id
```
protected String id
```
  - idRef
```
protected int idRef
```
  - isDone
```
protected boolean isDone
```
  - prev
```
protected ChoiceGenerator<?> prev
```
  - insn
```
protected Instruction insn
```
  - ti
```
protected ThreadInfo ti
```
  - attr
```
protected Object attr
```
  - isCascaded
```
protected boolean isCascaded
```
- Constructor Detail
  - ChoiceGeneratorBase
```
@Deprecated
protected ChoiceGeneratorBase()
```
    Deprecated.
    
    don't use this since it is not safe for cascaded ChoiceGenerators (we need the 'id' to be as context specific as possible)
  - ChoiceGeneratorBase
```
protected ChoiceGeneratorBase(String id)
```
- Method Detail
  - init
```
public static void init(Config config)
```
  - useRandomization
```
public static boolean useRandomization()
```
  - clone
```
public ChoiceGeneratorBase<?> clone()
                             throws CloneNotSupportedException
```
    Specified by:
    
    clone in interface ChoiceGenerator<T>
    
    Overrides:
    
    clone in class Object
    
    Throws:
    
    CloneNotSupportedException
  - deepClone
```
public ChoiceGenerator<?> deepClone()
                             throws CloneNotSupportedException
```
    Specified by:
    
    deepClone in interface ChoiceGenerator<T>
    
    Throws:
    
    CloneNotSupportedException
  - getId
```
public String getId()
```
    Specified by:
    
    getId in interface ChoiceGenerator<T>
  - getIdRef
```
public int getIdRef()
```
    Specified by:
    
    getIdRef in interface ChoiceGenerator<T>
  - setIdRef
```
public void setIdRef(int idRef)
```
    Specified by:
    
    setIdRef in interface ChoiceGenerator<T>
  - setId
```
public void setId(String id)
```
    Specified by:
    
    setId in interface ChoiceGenerator<T>
  - isSchedulingPoint
```
public boolean isSchedulingPoint()
```
    Specified by:
    
    isSchedulingPoint in interface ChoiceGenerator<T>
  - setThreadInfo
```
public void setThreadInfo(ThreadInfo ti)
```
    Specified by:
    
    setThreadInfo in interface ChoiceGenerator<T>
  - getThreadInfo
```
public ThreadInfo getThreadInfo()
```
    Specified by:
    
    getThreadInfo in interface ChoiceGenerator<T>
  - setInsn
```
public void setInsn(Instruction insn)
```
    Specified by:
    
    setInsn in interface ChoiceGenerator<T>
  - getInsn
```
public Instruction getInsn()
```
    Specified by:
    
    getInsn in interface ChoiceGenerator<T>
  - setContext
```
public void setContext(ThreadInfo tiCreator)
```
    Specified by:
    
    setContext in interface ChoiceGenerator<T>
  - getSourceLocation
```
public String getSourceLocation()
```
    Specified by:
    
    getSourceLocation in interface ChoiceGenerator<T>
  - supportsReordering
```
public boolean supportsReordering()
```
    Specified by:
    
    supportsReordering in interface ChoiceGenerator<T>
  - reorder
```
public ChoiceGenerator<T> reorder(Comparator<T> comparator)
```
    reorder according to a user provided comparator
    
    Specified by:
    
    reorder in interface ChoiceGenerator<T>
  - setPreviousChoiceGenerator
```
public void setPreviousChoiceGenerator(ChoiceGenerator<?> cg)
```
    Specified by:
    
    setPreviousChoiceGenerator in interface ChoiceGenerator<T>
  - setCascaded
```
public void setCascaded()
```
    Specified by:
    
    setCascaded in interface ChoiceGenerator<T>
  - isCascaded
```
public boolean isCascaded()
```
    Specified by:
    
    isCascaded in interface ChoiceGenerator<T>
  - getPreviousChoiceGeneratorOfType
```
public <C extends ChoiceGenerator<?>> C getPreviousChoiceGeneratorOfType(Class<C> cls)
```
    Specified by:
    
    getPreviousChoiceGeneratorOfType in interface ChoiceGenerator<T>
  - getCascadedParent
```
public ChoiceGenerator<?> getCascadedParent()
```
    returns the prev CG if it was registered for the same insn
    
    Specified by:
    
    getCascadedParent in interface ChoiceGenerator<T>
  - getCascade
```
public ChoiceGenerator<?>[] getCascade()
```
    return array with all cascaded parents and this CG, in registration order
    
    Specified by:
    
    getCascade in interface ChoiceGenerator<T>
  - getAll
```
public ChoiceGenerator<?>[] getAll()
```
    return array with all parents and this CG, in registration order
    
    Specified by:
    
    getAll in interface ChoiceGenerator<T>
  - getAllOfType
```
public <C extends ChoiceGenerator<?>> C[] getAllOfType(Class<C> cgType)
```
    return array with all CGs (including this one) of given 'cgType', in registration order
    
    Specified by:
    
    getAllOfType in interface ChoiceGenerator<T>
  - advance
```
public void advance(int nChoices)
```
    advance n choices pretty braindead generic solution, but if more speed is needed, we can easily override in the concrete CGs (it's used for path replay)
    
    Specified by:
    
    advance in interface ChoiceGenerator<T>
  - select
```
public void select(int nChoice)
```
    Specified by:
    
    select in interface ChoiceGenerator<T>
  - isDone
```
public boolean isDone()
```
    Specified by:
    
    isDone in interface ChoiceGenerator<T>
  - setDone
```
public void setDone()
```
    Specified by:
    
    setDone in interface ChoiceGenerator<T>
  - isProcessed
```
public boolean isProcessed()
```
    Specified by:
    
    isProcessed in interface ChoiceGenerator<T>
  - hasAttr
```
public boolean hasAttr()
```
    Specified by:
    
    hasAttr in interface ChoiceGenerator<T>
  - hasAttr
```
public boolean hasAttr(Class<?> attrType)
```
    Specified by:
    
    hasAttr in interface ChoiceGenerator<T>
  - hasAttrValue
```
public boolean hasAttrValue(Object a)
```
  - getAttr
```
public 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
    
    Specified by:
    
    getAttr in interface ChoiceGenerator<T>
  - setAttr
```
public 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()
    
    Specified by:
    
    setAttr in interface ChoiceGenerator<T>
  - addAttr
```
public void addAttr(Object a)
```
    Specified by:
    
    addAttr in interface ChoiceGenerator<T>
  - removeAttr
```
public void removeAttr(Object a)
```
    Specified by:
    
    removeAttr in interface ChoiceGenerator<T>
  - replaceAttr
```
public void replaceAttr(Object oldAttr,
               Object newAttr)
```
    Specified by:
    
    replaceAttr in interface ChoiceGenerator<T>
  - getAttr
```
public <T> T getAttr(Class<T> 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
    
    Specified by:
    
    getAttr in interface ChoiceGenerator<T>
  - getNextAttr
```
public <T> T getNextAttr(Class<T> attrType,
                Object prev)
```
    Specified by:
    
    getNextAttr in interface ChoiceGenerator<T>
  - attrIterator
```
public ObjectList.Iterator attrIterator()
```
    Specified by:
    
    attrIterator in interface ChoiceGenerator<T>
  - attrIterator
```
public <T> ObjectList.TypedIterator<T> attrIterator(Class<T> attrType)
```
    Specified by:
    
    attrIterator in interface ChoiceGenerator<T>
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getPreviousChoiceGenerator
```
public ChoiceGenerator<?> getPreviousChoiceGenerator()
```
    Specified by:
    
    getPreviousChoiceGenerator in interface ChoiceGenerator<T>
  - randomize
```
public ChoiceGenerator<T> randomize()
```
    Description copied from interface: ChoiceGenerator
    
    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.
    
    Specified by:
    
    randomize in interface ChoiceGenerator<T>

Class ChoiceGeneratorBase<T>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface gov.nasa.jpf.vm.ChoiceGenerator

Field Detail

MARKER

random

id

idRef

isDone

prev

insn

ti

attr

isCascaded

Constructor Detail

ChoiceGeneratorBase

ChoiceGeneratorBase

Method Detail

init

useRandomization

clone

deepClone

getId

getIdRef

setIdRef

setId

isSchedulingPoint

setThreadInfo

getThreadInfo

setInsn

getInsn

setContext

getSourceLocation

supportsReordering

reorder

setPreviousChoiceGenerator

setCascaded

isCascaded

getPreviousChoiceGeneratorOfType

getCascadedParent

getCascade

getAll

getAllOfType

advance

select

isDone

setDone

isProcessed

hasAttr

hasAttr

hasAttrValue

getAttr

setAttr

addAttr

removeAttr

replaceAttr

getAttr

getNextAttr

attrIterator

attrIterator

toString

getPreviousChoiceGenerator

randomize