sofya.ed.structural.processors
Class JUnitBranchSequenceProcessingStrategy

java.lang.Object
  sofya.ed.structural.processors.AbstractProcessingStrategy
      sofya.ed.structural.processors.AbstractJUnitProcessingStrategy
          sofya.ed.structural.processors.JUnitBranchSequenceProcessingStrategy

All Implemented Interfaces:

ActiveComponent, BranchInstrumentationStrategy, JUnitProcessingStrategy

public class JUnitBranchSequenceProcessingStrategy
extends AbstractJUnitProcessingStrategy
implements BranchInstrumentationStrategy

Processing strategy to receive JUnit branch sequence probes and dispatch branch sequence events.

Version:

04/24/2006

Author:

Alex Kinneer

Field Summary

Fields inherited from class sofya.ed.structural.processors.AbstractJUnitProcessingStrategy

err

Fields inherited from class sofya.ed.structural.processors.AbstractProcessingStrategy

instMode, sbjout, stderr, stdout

Constructor Summary

JUnitBranchSequenceProcessingStrategy()
Creates a new instance of the processing strategy.

Method Summary

void	addEventListener(BranchEventListener listener) Registers a listener for observable events.
boolean	areCallBranchesActive() Reports whether call branches are selected.
boolean	areEntryBranchesActive() Reports whether entry branches are selected.
boolean	areIfBranchesActive() Reports whether if branches are selected.
boolean	areSummaryBranchesActive() Reports whether summary branches are selected.
boolean	areSwitchBranchesActive() Reports whether switch branches are selected.
boolean	areThrowsBranchesActive() Reports whether throws branches are selected.
java.util.List	configure(java.util.List params) Configures this component from command line parameters.
void	endTest(int testNum) Notifies the processor that a test case has finished executing; this is normally relayed to attached listeners.
SConstants.TraceObjectType	getObjectType() Gets the type of structural object for which this processor can receive probes.
int	getTypeFlags() Gets the bitmask corresponding to the types of branches currently selected.
boolean	isReady() Reports whether this component is ready for the event dispatcher to begin dispatching events.
void	newTest(int testNum) Notifies the processor that a new test case is about to execute; this is normally relayed to attached listeners.
void	processData(java.lang.Object instArray, java.lang.String mSig, int fromIndex, int toIndex) Instrumentation data received from the subject.
void	register(EventDispatcherConfiguration edConfig) Registers this component with the event dispatcher.
void	release() Notifies this component that its current lifecycle has expired and that it should commit any stored state and release resources.
void	removeEventListener(BranchEventListener listener) Unregisters a listener for observable events.
void	setCallBranchesActive(boolean enable) Sets whether call branches are selected.
void	setEntryBranchesActive(boolean enable) Sets whether entry branches are selected.
void	setIfBranchesActive(boolean enable) Sets whether if branches are selected.
void	setMethodObjectCount(java.lang.String mSig, int objCount) Notification received from the instrumentated subject indicating a structural object count for a method.
void	setSummaryBranchesActive(boolean enable) Sets whether summary branches are selected.
void	setSwitchBranchesActive(boolean enable) Sets whether switch branches are selected.
void	setThrowsBranchesActive(boolean enable) Sets whether throws branches are selected.
void	setup() Notifies the processor to perform any setup required to receive probes from the subject.

Methods inherited from class sofya.ed.structural.processors.AbstractJUnitProcessingStrategy

checkError, reset, setInstrumentationMode

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JUnitBranchSequenceProcessingStrategy

public JUnitBranchSequenceProcessingStrategy()

Creates a new instance of the processing strategy.

Method Detail

addEventListener

public void addEventListener(BranchEventListener listener)

Registers a listener for observable events.

Parameters:

listener - Observer that wishes to receive branch events from the event dispatcher.

removeEventListener

public void removeEventListener(BranchEventListener listener)

Unregisters a listener for observable events.

Parameters:

listener - Object that no longer wishes to receive branch events from the event dispatcher.

register

public void register(EventDispatcherConfiguration edConfig)

Description copied from class: AbstractProcessingStrategy

Registers this component with the event dispatcher.

Specified by:

register in interface ActiveComponent

Overrides:

register in class AbstractProcessingStrategy

Parameters:

edConfig - The current configuration of system global resources and settings that the component will use as appropriate.

configure

public java.util.List configure(java.util.List params)

Description copied from interface: ActiveComponent

Configures this component from command line parameters.

This method provides a component the opportunity to define and process command line parameters required to configure itself. Components participate in a processing chain, initiated in Sofya-provided event dispatchers by calling this method on the processing strategy. The processing strategies provided by Sofya in turn invoke this method on any listeners implementing this interface.

Specified by:

configure in interface ActiveComponent

Overrides:

configure in class AbstractJUnitProcessingStrategy

Parameters:

params - A list of command line tokens that have not yet been processed by any previous components.

Returns:

The list of parameters, with any recognized parameters and associated values removed. This enables the chaining of parameter processing.

isReady

public boolean isReady()

Description copied from interface: ActiveComponent

Reports whether this component is ready for the event dispatcher to begin dispatching events.

Calls to this method are chained similarly to the ActiveComponent.configure(java.util.List) method. The event dispatcher will fail with an error if a client invokes ProgramEventDispatcher.startDispatcher() when any attached component returns false from this method.

Specified by:

isReady in interface ActiveComponent

Overrides:

isReady in class AbstractJUnitProcessingStrategy

Returns:

true if this component is ready for the event dispatcher to begin dispatching events, false otherwise.

release

public void release()

Description copied from interface: ActiveComponent

Notifies this component that its current lifecycle has expired and that it should commit any stored state and release resources.

Calls to this method are chained similary to the ActiveComponent.configure(java.util.List) method. This method is invoked directly by a client of the event dispatcher. Normally, it should be used to release any resources that were required to persist over multiple runs of the event dispatcher.

Specified by:

release in interface ActiveComponent

Overrides:

release in class AbstractJUnitProcessingStrategy

getObjectType

public SConstants.TraceObjectType getObjectType()

Description copied from interface: JUnitProcessingStrategy

Gets the type of structural object for which this processor can receive probes.

This is used by the JUnit event dispatcher for certain configuration activities.

Specified by:

getObjectType in interface JUnitProcessingStrategy

Returns:

The type of structural object for which this processor knows how to receive probes.

setup

public void setup()

Description copied from interface: JUnitProcessingStrategy

Notifies the processor to perform any setup required to receive probes from the subject.

Specified by:

setup in interface JUnitProcessingStrategy

newTest

public void newTest(int testNum)

Description copied from interface: JUnitProcessingStrategy

Notifies the processor that a new test case is about to execute; this is normally relayed to attached listeners.

Specified by:

newTest in interface JUnitProcessingStrategy

Parameters:

testNum - The number of the test case about to execute.

endTest

public void endTest(int testNum)

Description copied from interface: JUnitProcessingStrategy

Notifies the processor that a test case has finished executing; this is normally relayed to attached listeners.

Specified by:

endTest in interface JUnitProcessingStrategy

Parameters:

testNum - The number of the test case that finished executing.

setMethodObjectCount

public void setMethodObjectCount(java.lang.String mSig,
                                 int objCount)

Description copied from interface: JUnitProcessingStrategy

Notification received from the instrumentated subject indicating a structural object count for a method.

Specified by:

setMethodObjectCount in interface JUnitProcessingStrategy

Parameters:

mSig - Concatenation of the fully qualified class name, method name, and JNI signature of the method for which an object count is being reported.

objCount - The number of structural objects in the method.

processData

public void processData(java.lang.Object instArray,
                        java.lang.String mSig,
                        int fromIndex,
                        int toIndex)

Description copied from interface: JUnitProcessingStrategy

Instrumentation data received from the subject.

This is a mapping of the actual instrumentation method called from the subject. The data provided varies depending on the the type of instrumentation applied.

Specified by:

processData in interface JUnitProcessingStrategy

Parameters:

instArray - Array of instrumentation data. The type and contents depend on the type of instrumentation applied.

mSig - Concatenation of the fully qualified class name, method name, and JNI signature of the method for which an object count is being reported.

fromIndex - Start index of the segment of the array to be processed on this invocation.

toIndex - End index of the segment of the array to be processed on this invocation.

areIfBranchesActive

public boolean areIfBranchesActive()

Description copied from interface: BranchInstrumentationStrategy

Reports whether if branches are selected.

Specified by:

areIfBranchesActive in interface BranchInstrumentationStrategy

Returns:

true if if branches are selected, false otherwise.

setIfBranchesActive

public void setIfBranchesActive(boolean enable)

Description copied from interface: BranchInstrumentationStrategy

Sets whether if branches are selected.

Specified by:

setIfBranchesActive in interface BranchInstrumentationStrategy

Parameters:

enable - true to select if branches, false to ignore.

areSwitchBranchesActive

public boolean areSwitchBranchesActive()

Description copied from interface: BranchInstrumentationStrategy

Reports whether switch branches are selected.

Specified by:

areSwitchBranchesActive in interface BranchInstrumentationStrategy

Returns:

true if switch branches are selected, false otherwise.

setSwitchBranchesActive

public void setSwitchBranchesActive(boolean enable)

Description copied from interface: BranchInstrumentationStrategy

Sets whether switch branches are selected.

Specified by:

setSwitchBranchesActive in interface BranchInstrumentationStrategy

Parameters:

enable - true to select switch branches, false to ignore.

areThrowsBranchesActive

public boolean areThrowsBranchesActive()

Description copied from interface: BranchInstrumentationStrategy

Reports whether throws branches are selected.

Specified by:

areThrowsBranchesActive in interface BranchInstrumentationStrategy

Returns:

true if throws branches are selected, false otherwise.

setThrowsBranchesActive

public void setThrowsBranchesActive(boolean enable)

Description copied from interface: BranchInstrumentationStrategy

Sets whether throws branches are selected.

Specified by:

setThrowsBranchesActive in interface BranchInstrumentationStrategy

Parameters:

enable - true to select throws branches, false to ignore.

areCallBranchesActive

public boolean areCallBranchesActive()

Description copied from interface: BranchInstrumentationStrategy

Reports whether call branches are selected.

Specified by:

areCallBranchesActive in interface BranchInstrumentationStrategy

Returns:

true if call branches are selected, false otherwise.

setCallBranchesActive

public void setCallBranchesActive(boolean enable)

Description copied from interface: BranchInstrumentationStrategy

Sets whether call branches are selected.

Specified by:

setCallBranchesActive in interface BranchInstrumentationStrategy

Parameters:

enable - true to select call branches, false to ignore.

areEntryBranchesActive

public boolean areEntryBranchesActive()

Description copied from interface: BranchInstrumentationStrategy

Reports whether entry branches are selected.

Specified by:

areEntryBranchesActive in interface BranchInstrumentationStrategy

Returns:

true if entry branches are selected, false otherwise.

setEntryBranchesActive

public void setEntryBranchesActive(boolean enable)

Description copied from interface: BranchInstrumentationStrategy

Sets whether entry branches are selected.

Specified by:

setEntryBranchesActive in interface BranchInstrumentationStrategy

Parameters:

enable - true to select entry branches, false to ignore.

areSummaryBranchesActive

public boolean areSummaryBranchesActive()

Description copied from interface: BranchInstrumentationStrategy

Reports whether summary branches are selected.

Specified by:

areSummaryBranchesActive in interface BranchInstrumentationStrategy

Returns:

true if summary branches are selected, false otherwise.

setSummaryBranchesActive

public void setSummaryBranchesActive(boolean enable)

Description copied from interface: BranchInstrumentationStrategy

Sets whether summary branches are selected.

Specified by:

setSummaryBranchesActive in interface BranchInstrumentationStrategy

Parameters:

enable - true to select summary branches, false to ignore.

getTypeFlags

public int getTypeFlags()

Description copied from interface: BranchInstrumentationStrategy

Gets the bitmask corresponding to the types of branches currently selected.

Used for communicating configuration information to certain other components. To be phased out at a future date.

Specified by:

getTypeFlags in interface BranchInstrumentationStrategy

Returns:

The bitmask indicating which branch types have been selected in this configuration.