Reporter (JPF API)

java.lang.Object
- gov.nasa.jpf.search.SearchListenerAdapter
- - gov.nasa.jpf.report.Reporter

All Implemented Interfaces:

JPFListener, SearchListener
```
public class Reporter
extends SearchListenerAdapter
```
this is our default report generator, which is heavily configurable via our standard properties. Note this gets instantiated and registered automatically via JPF.addListeners(), so you don't have to add it explicitly

Field Summary

Fields
Modifier and Type	Field and Description
`protected Config`	`conf`
`protected Date`	`finished`
`protected JPF`	`jpf`
`static Logger`	`log`
`protected List<Publisher>`	`publishers`
`protected Search`	`search`
`protected Date`	`started`
`protected Statistics`	`stat`
`protected VM`	`vm`

Constructor Summary

Constructors
Constructor and Description

Reporter(Config conf, JPF jpf)

Constructors
Constructor and Description
`Reporter(Config conf, JPF jpf)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addPublisher(Publisher newPublisher)`
`<T extends Publisher> boolean`	`addPublisherExtension(Class<T> publisherCls, PublisherExtension e)`
`void`	`cleanUp()` called after the JPF run is finished.
`String`	`getArch()`
`Error`	`getCurrentError()`
`String`	`getCurrentErrorId()`
`long`	`getElapsedTime()` in ms
`List<Error>`	`getErrors()`
`Date`	`getFinishedDate()`
`String`	`getHostName()`
`String`	`getJava()`
`String`	`getJPFBanner()`
`String`	`getLastSearchConstraint()`
`int`	`getNumberOfErrors()`
`String`	`getOS()`
`Path`	`getPath()`
`List<Publisher>`	`getPublishers()`
`Statistics`	`getRegisteredStatistics()`
`protected String`	`getRepositoryInfo()`
`protected String`	`getRevision()`
`Search`	`getSearch()`
`Date`	`getStartDate()`
`Statistics`	`getStatistics()`
`Statistics`	`getStatisticsSnapshot()`
`String`	`getSuT()`
`String`	`getUser()`
`VM`	`getVM()`
`boolean`	`hasToReportOutput()`
`boolean`	`hasToReportTrace()`
`void`	`propertyViolated(Search search)` JPF encountered a property violation.
`protected void`	`publishConstraintHit()`
`protected void`	`publishFinished()`
`protected void`	`publishPropertyViolation()`
`protected void`	`publishStart()`
`protected void`	`publishTransition()`
`void`	`searchConstraintHit(Search search)` there was some contraint hit in the search, we back out could have been turned into a property, but usually is an attribute of the search, not the application
`void`	`searchFinished(Search search)` we're done, either with or without a preceeding error
`void`	`searchStarted(Search search)` we get this after we enter the search loop, but BEFORE the first forward
`<T extends Publisher> void`	`setPublisherTopics(Class<T> publisherCls, int category, String[] topics)`
`void`	`stateAdvanced(Search search)` got the next state Note - this will be notified before any potential propertyViolated, in which case the currentError will be already set

Methods inherited from class gov.nasa.jpf.search.SearchListenerAdapter
stateBacktracked, stateProcessed, statePurged, stateRestored, stateStored

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

Field Detail

log
```
public static Logger log
```

conf
```
protected Config conf
```

jpf
```
protected JPF jpf
```

search
```
protected Search search
```

vm
```
protected VM vm
```

started
```
protected Date started
```

finished
```
protected Date finished
```

stat
```
protected Statistics stat
```

publishers
```
protected List<Publisher> publishers
```

Constructor Detail

Reporter

public Reporter(Config conf,
        JPF jpf)

Method Detail
- cleanUp
```
public void cleanUp()
```
  called after the JPF run is finished. Shouldn't be public, but is called by JPF
- getRegisteredStatistics
```
public Statistics getRegisteredStatistics()
```
- addPublisher
```
public void addPublisher(Publisher newPublisher)
```
- getPublishers
```
public List<Publisher> getPublishers()
```
- hasToReportTrace
```
public boolean hasToReportTrace()
```
- hasToReportOutput
```
public boolean hasToReportOutput()
```
- addPublisherExtension
```
public <T extends Publisher> boolean addPublisherExtension(Class<T> publisherCls,
                                                  PublisherExtension e)
```
- setPublisherTopics
```
public <T extends Publisher> void setPublisherTopics(Class<T> publisherCls,
                                            int category,
                                            String[] topics)
```
- publishStart
```
protected void publishStart()
```
- publishTransition
```
protected void publishTransition()
```
- publishPropertyViolation
```
protected void publishPropertyViolation()
```
- publishConstraintHit
```
protected void publishConstraintHit()
```
- publishFinished
```
protected void publishFinished()
```
- searchStarted
```
public void searchStarted(Search search)
```
  Description copied from interface: SearchListener
  
  we get this after we enter the search loop, but BEFORE the first forward
  
  Specified by:
  
  searchStarted in interface SearchListener
  
  Overrides:
  
  searchStarted in class SearchListenerAdapter
- stateAdvanced
```
public void stateAdvanced(Search search)
```
  Description copied from interface: SearchListener
  
  got the next state Note - this will be notified before any potential propertyViolated, in which case the currentError will be already set
  
  Specified by:
  
  stateAdvanced in interface SearchListener
  
  Overrides:
  
  stateAdvanced in class SearchListenerAdapter
- searchConstraintHit
```
public void searchConstraintHit(Search search)
```
  Description copied from interface: SearchListener
  
  there was some contraint hit in the search, we back out could have been turned into a property, but usually is an attribute of the search, not the application
  
  Specified by:
  
  searchConstraintHit in interface SearchListener
  
  Overrides:
  
  searchConstraintHit in class SearchListenerAdapter
- propertyViolated
```
public void propertyViolated(Search search)
```
  Description copied from interface: SearchListener
  
  JPF encountered a property violation. Note - this is always preceeded by a stateAdvanced
  
  Specified by:
  
  propertyViolated in interface SearchListener
  
  Overrides:
  
  propertyViolated in class SearchListenerAdapter
- searchFinished
```
public void searchFinished(Search search)
```
  Description copied from interface: SearchListener
  
  we're done, either with or without a preceeding error
  
  Specified by:
  
  searchFinished in interface SearchListener
  
  Overrides:
  
  searchFinished in class SearchListenerAdapter
- getStartDate
```
public Date getStartDate()
```
- getFinishedDate
```
public Date getFinishedDate()
```
- getVM
```
public VM getVM()
```
- getSearch
```
public Search getSearch()
```
- getErrors
```
public List<Error> getErrors()
```
- getCurrentError
```
public Error getCurrentError()
```
- getLastSearchConstraint
```
public String getLastSearchConstraint()
```
- getCurrentErrorId
```
public String getCurrentErrorId()
```
- getNumberOfErrors
```
public int getNumberOfErrors()
```
- getStatistics
```
public Statistics getStatistics()
```
- getStatisticsSnapshot
```
public Statistics getStatisticsSnapshot()
```
- getElapsedTime
```
public long getElapsedTime()
```
  in ms
- getPath
```
public Path getPath()
```
- getJPFBanner
```
public String getJPFBanner()
```
- getRevision
```
protected String getRevision()
```
- getRepositoryInfo
```
protected String getRepositoryInfo()
```
- getHostName
```
public String getHostName()
```
- getUser
```
public String getUser()
```
- getSuT
```
public String getSuT()
```
- getJava
```
public String getJava()
```
- getArch
```
public String getArch()
```
- getOS
```
public String getOS()
```

Class Reporter

Field Summary

Constructor Summary

Method Summary

Methods inherited from class gov.nasa.jpf.search.SearchListenerAdapter

Methods inherited from class java.lang.Object

Field Detail

log

conf

jpf

search

vm

started

finished

stat

publishers

Constructor Detail

Reporter

Method Detail

cleanUp

getRegisteredStatistics

addPublisher

getPublishers

hasToReportTrace

hasToReportOutput

addPublisherExtension

setPublisherTopics

publishStart

publishTransition

publishPropertyViolation

publishConstraintHit

publishFinished

searchStarted

stateAdvanced

searchConstraintHit

propertyViolated

searchFinished

getStartDate

getFinishedDate

getVM

getSearch

getErrors

getCurrentError

getLastSearchConstraint

getCurrentErrorId

getNumberOfErrors

getStatistics

getStatisticsSnapshot

getElapsedTime

getPath

getJPFBanner

getRevision

getRepositoryInfo

getHostName

getUser

getSuT

getJava

getArch

getOS