BranchPool (evosuite-client 1.0.5 API)

java.lang.Object
- org.evosuite.coverage.branch.BranchPool

```
public class BranchPool
extends Object
```
This class is supposed to hold all the available information concerning Branches. The addBranch()-Method gets called during class analysis. Whenever the BytecodeInstructionPool detects a BytecodeInstruction that corresponds to a Branch in the class under test as defined in BytecodeInstruction.isActualBranch() it calls the registerAsBranch() method of this class which in turn properly registers the instruction within this pool. There are two kinds of Branch objects: normal branches and switch case branches. For more details about the difference between these two look at the Branch class.

Author:

Andre Mis

Constructor Summary

Constructors
Constructor and Description

BranchPool()

Constructors
Constructor and Description
`BranchPool()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addBranchlessMethod(String className, String methodName, int lineNumber)` Gets called by the CFGMethodAdapter whenever it detects a method without any branches.
`void`	`clear()` clear
`void`	`clear(String className)` clear
`void`	`clear(String className, String methodName)` clear
`int`	`getActualBranchIdForNormalBranchInstruction(BytecodeInstruction ins)` getActualBranchIdForNormalBranchInstruction
`Collection<Branch>`	`getAllBranches()`
`Branch`	`getBranch(int branchId)` Returns the Branch object associated with the given branchID
`int`	`getBranchCounter()` Returns the number of currently known Branches
`int`	`getBranchCountForClass(String className)` Returns the number of known Branches for a given class
`int`	`getBranchCountForMemberClasses(String prefix)` Returns the number of known Branches for a given class
`int`	`getBranchCountForMethod(String className, String methodName)` Returns the number of known Branches for a given methodName in a given class.
`int`	`getBranchCountForPrefix(String prefix)` Returns the number of known Branches for a given class
`Branch`	`getBranchForInstruction(BytecodeInstruction instruction)` getBranchForInstruction
`List<Branch>`	`getBranchForLabel(org.objectweb.asm.tree.LabelNode label)` getBranchForLabel
`Set<Integer>`	`getBranchIdsForPrefix(String prefix)` Returns the number of known Branches for a given class
`int`	`getBranchlessMethodLineNumber(String className, String methodName)`
`Set<String>`	`getBranchlessMethods()` Returns a set with all unique methodNames of methods without Branches.
`Set<String>`	`getBranchlessMethods(String className)` Returns a set with all unique methodNames of methods without Branches.
`Set<String>`	`getBranchlessMethodsMemberClasses(String className)` Returns a set with all unique methodNames of methods without Branches.
`Set<String>`	`getBranchlessMethodsPrefix(String className)` Returns a set with all unique methodNames of methods without Branches.
`List<Branch>`	`getCaseBranchesForSwitch(BytecodeInstruction instruction)` getCaseBranchesForSwitch
`Branch`	`getDefaultBranchForSwitch(BytecodeInstruction v)` getDefaultBranchForSwitch
`static BranchPool`	`getInstance(ClassLoader classLoader)`
`int`	`getNonArtificialBranchCountForMethod(String className, String methodName)`
`int`	`getNumArtificialBranches()`
`int`	`getNumBranchlessMethods()` Returns the total number of methods without branches in the instrumented classes
`int`	`getNumBranchlessMethods(String className)` Returns the number of methods without Branches for class className
`int`	`getNumBranchlessMethodsMemberClasses(String className)` Returns the number of methods without Branches for class className
`int`	`getNumBranchlessMethodsPrefix(String className)` Returns the number of methods without Branches for class className
`boolean`	`isBranchlessMethod(String className, String methodName)`
`boolean`	`isKnownAsBranch(BytecodeInstruction instruction)` Checks whether the given instruction has Branch objects associated with it.
`boolean`	`isKnownAsNormalBranchInstruction(BytecodeInstruction ins)` isKnownAsNormalBranchInstruction
`boolean`	`isKnownAsSwitchBranchInstruction(BytecodeInstruction instruction)` isKnownAsSwitchBranchInstruction
`Set<String>`	`knownClasses()` Returns a Set containing all classes for which this pool knows Branches for as Strings
`Set<String>`	`knownMethods(String className)` Returns a Set containing all methods in the class represented by the given String for which this pool knows Branches for as Strings
`void`	`registerAsBranch(BytecodeInstruction instruction)` Called by the BytecodeInstructionPool whenever it detects an instruction that corresponds to a Branch in the class under test as defined by BytecodeInstruction.isActualBranch().
`void`	`reset()` Reset all the data structures used to keep track of the branch information
`List<Branch>`	`retrieveBranchesInMethod(String className, String methodName)` Returns a List containing all Branches in the given class and method Should no such Branch exist an empty List is returned

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

- Constructor Detail
  - BranchPool
```
public BranchPool()
```
- Method Detail
  - getInstance
```
public static BranchPool getInstance(ClassLoader classLoader)
```
  - addBranchlessMethod
```
public void addBranchlessMethod(String className,
                                String methodName,
                                int lineNumber)
```
    Gets called by the CFGMethodAdapter whenever it detects a method without any branches.
    
    Parameters:
    
    methodName - Unique methodName - consisting of . - of a method without Branches
    
    className - a String object.
  - registerAsBranch
```
public void registerAsBranch(BytecodeInstruction instruction)
```
    Called by the BytecodeInstructionPool whenever it detects an instruction that corresponds to a Branch in the class under test as defined by BytecodeInstruction.isActualBranch().
    
    Parameters:
    
    instruction - a BytecodeInstruction object.
  - isKnownAsBranch
```
public boolean isKnownAsBranch(BytecodeInstruction instruction)
```
    Checks whether the given instruction has Branch objects associated with it. Returns true if the given BytecodeInstruction previously passed a call to registerAsBranch(instruction), false otherwise
    
    Parameters:
    
    instruction - a BytecodeInstruction object.
    
    Returns:
    
    a boolean.
  - isKnownAsNormalBranchInstruction
```
public boolean isKnownAsNormalBranchInstruction(BytecodeInstruction ins)
```
    isKnownAsNormalBranchInstruction
    
    Parameters:
    
    ins - a BytecodeInstruction object.
    
    Returns:
    
    a boolean.
  - isKnownAsSwitchBranchInstruction
```
public boolean isKnownAsSwitchBranchInstruction(BytecodeInstruction instruction)
```
    isKnownAsSwitchBranchInstruction
    
    Parameters:
    
    instruction - a BytecodeInstruction object.
    
    Returns:
    
    a boolean.
  - getActualBranchIdForNormalBranchInstruction
```
public int getActualBranchIdForNormalBranchInstruction(BytecodeInstruction ins)
```
    getActualBranchIdForNormalBranchInstruction
    
    Parameters:
    
    ins - a BytecodeInstruction object.
    
    Returns:
    
    a int.
  - getCaseBranchesForSwitch
```
public List<Branch> getCaseBranchesForSwitch(BytecodeInstruction instruction)
```
    getCaseBranchesForSwitch
    
    Parameters:
    
    instruction - a BytecodeInstruction object.
    
    Returns:
    
    a List object.
  - getBranchForInstruction
```
public Branch getBranchForInstruction(BytecodeInstruction instruction)
```
    getBranchForInstruction
    
    Parameters:
    
    instruction - a BytecodeInstruction object.
    
    Returns:
    
    a Branch object.
  - getBranchForLabel
```
public List<Branch> getBranchForLabel(org.objectweb.asm.tree.LabelNode label)
```
    getBranchForLabel
    
    Parameters:
    
    label - a LabelNode object.
    
    Returns:
    
    a List object.
  - getBranchCountForMethod
```
public int getBranchCountForMethod(String className,
                                   String methodName)
```
    Returns the number of known Branches for a given methodName in a given class.
    
    Parameters:
    
    className - a String object.
    
    methodName - a String object.
    
    Returns:
    
    The number of currently known Branches inside the given method
  - getNonArtificialBranchCountForMethod
```
public int getNonArtificialBranchCountForMethod(String className,
                                                String methodName)
```
  - getBranchCountForClass
```
public int getBranchCountForClass(String className)
```
    Returns the number of known Branches for a given class
    
    Parameters:
    
    className - a String object.
    
    Returns:
    
    The number of currently known Branches inside the given class
  - getBranchCountForPrefix
```
public int getBranchCountForPrefix(String prefix)
```
    Returns the number of known Branches for a given class
    
    Parameters:
    
    prefix - a String object.
    
    Returns:
    
    The number of currently known Branches inside the given class
  - getBranchIdsForPrefix
```
public Set<Integer> getBranchIdsForPrefix(String prefix)
```
    Returns the number of known Branches for a given class
    
    Parameters:
    
    prefix - a String object.
    
    Returns:
    
    The number of currently known Branches inside the given class
  - getBranchCountForMemberClasses
```
public int getBranchCountForMemberClasses(String prefix)
```
    Returns the number of known Branches for a given class
    
    Parameters:
    
    prefix - a String object.
    
    Returns:
    
    The number of currently known Branches inside the given class
  - getBranchCounter
```
public int getBranchCounter()
```
    Returns the number of currently known Branches
    
    Returns:
    
    The number of currently known Branches
  - getNumArtificialBranches
```
public int getNumArtificialBranches()
```
  - getBranch
```
public Branch getBranch(int branchId)
```
    Returns the Branch object associated with the given branchID
    
    Parameters:
    
    branchId - The ID of a branch
    
    Returns:
    
    The branch, or null if it does not exist
  - getAllBranches
```
public Collection<Branch> getAllBranches()
```
  - getBranchlessMethods
```
public Set<String> getBranchlessMethods(String className)
```
    Returns a set with all unique methodNames of methods without Branches.
    
    Parameters:
    
    className - a String object.
    
    Returns:
    
    A set with all unique methodNames of methods without Branches.
  - getBranchlessMethodsPrefix
```
public Set<String> getBranchlessMethodsPrefix(String className)
```
    Returns a set with all unique methodNames of methods without Branches.
    
    Parameters:
    
    className - a String object.
    
    Returns:
    
    A set with all unique methodNames of methods without Branches.
  - getBranchlessMethodsMemberClasses
```
public Set<String> getBranchlessMethodsMemberClasses(String className)
```
    Returns a set with all unique methodNames of methods without Branches.
    
    Parameters:
    
    className - a String object.
    
    Returns:
    
    A set with all unique methodNames of methods without Branches.
  - getBranchlessMethodLineNumber
```
public int getBranchlessMethodLineNumber(String className,
                                         String methodName)
```
  - getBranchlessMethods
```
public Set<String> getBranchlessMethods()
```
    Returns a set with all unique methodNames of methods without Branches.
    
    Returns:
    
    A set with all unique methodNames of methods without Branches.
  - isBranchlessMethod
```
public boolean isBranchlessMethod(String className,
                                  String methodName)
```
  - getNumBranchlessMethods
```
public int getNumBranchlessMethods(String className)
```
    Returns the number of methods without Branches for class className
    
    Parameters:
    
    className - a String object.
    
    Returns:
    
    The number of methods without Branches.
  - getNumBranchlessMethodsPrefix
```
public int getNumBranchlessMethodsPrefix(String className)
```
    Returns the number of methods without Branches for class className
    
    Parameters:
    
    className - a String object.
    
    Returns:
    
    The number of methods without Branches.
  - getNumBranchlessMethodsMemberClasses
```
public int getNumBranchlessMethodsMemberClasses(String className)
```
    Returns the number of methods without Branches for class className
    
    Parameters:
    
    className - a String object.
    
    Returns:
    
    The number of methods without Branches.
  - getNumBranchlessMethods
```
public int getNumBranchlessMethods()
```
    Returns the total number of methods without branches in the instrumented classes
    
    Returns:
  - knownClasses
```
public Set<String> knownClasses()
```
    Returns a Set containing all classes for which this pool knows Branches for as Strings
    
    Returns:
    
    a Set object.
  - knownMethods
```
public Set<String> knownMethods(String className)
```
    Returns a Set containing all methods in the class represented by the given String for which this pool knows Branches for as Strings
    
    Parameters:
    
    className - a String object.
    
    Returns:
    
    a Set object.
  - retrieveBranchesInMethod
```
public List<Branch> retrieveBranchesInMethod(String className,
                                             String methodName)
```
    Returns a List containing all Branches in the given class and method Should no such Branch exist an empty List is returned
    
    Parameters:
    
    className - a String object.
    
    methodName - a String object.
    
    Returns:
    
    a List object.
  - getDefaultBranchForSwitch
```
public Branch getDefaultBranchForSwitch(BytecodeInstruction v)
```
    getDefaultBranchForSwitch
    
    Parameters:
    
    v - a BytecodeInstruction object.
    
    Returns:
    
    a Branch object.
  - reset
```
public void reset()
```
    Reset all the data structures used to keep track of the branch information
  - clear
```
public void clear()
```
    clear
    TODO: One of these two methods should go
  - clear
```
public void clear(String className)
```
    clear
    
    Parameters:
    
    className - a String object.
  - clear
```
public void clear(String className,
                  String methodName)
```
    clear
    
    Parameters:
    
    className - a String object.
    
    methodName - a String object.

Class BranchPool

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BranchPool

Method Detail

getInstance

addBranchlessMethod

registerAsBranch

isKnownAsBranch

isKnownAsNormalBranchInstruction

isKnownAsSwitchBranchInstruction

getActualBranchIdForNormalBranchInstruction

getCaseBranchesForSwitch

getBranchForInstruction

getBranchForLabel

getBranchCountForMethod

getNonArtificialBranchCountForMethod

getBranchCountForClass

getBranchCountForPrefix

getBranchIdsForPrefix

getBranchCountForMemberClasses

getBranchCounter

getNumArtificialBranches

getBranch

getAllBranches

getBranchlessMethods

getBranchlessMethodsPrefix

getBranchlessMethodsMemberClasses

getBranchlessMethodLineNumber

getBranchlessMethods

isBranchlessMethod

getNumBranchlessMethods

getNumBranchlessMethodsPrefix

getNumBranchlessMethodsMemberClasses

getNumBranchlessMethods

knownClasses

knownMethods

retrieveBranchesInMethod

getDefaultBranchForSwitch

reset

clear

clear

clear