OverviewStats (Cucumber Report Generator 1.2-SNAPSHOT API)

java.lang.Object
- com.github.mkolisnyk.cucumber.reporting.types.OverviewStats

```
public class OverviewStats
extends Object
```
Data structure containing run statistics for features/scenarios/steps. It is used by wide range of reports and data beans providing data for them. Also, it contains functionality which valuates statistics from given feature/scenario results.

Author:

Mykola Kolisnyk

Field Summary

Fields
Modifier and Type	Field and Description
`private int`	`featuresFailed` The number of failed features.
`private int`	`featuresKnown` The number of features failed on known errors.
`private int`	`featuresPassed` The number of passed features.
`private int`	`featuresUndefined` The number of features in undefined state.
`private float`	`overallDuration` The overall duration for all steps.
`private int`	`scenariosFailed` The number of failed scenarios.
`private int`	`scenariosKnown` The number of scenarios failing on known error.
`private int`	`scenariosPassed` The number of scenarios passed.
`private int`	`scenariosUndefined` The number of undefined scenairos.
`private int`	`stepsFailed` The number of failed steps.
`private int`	`stepsKnown` The number of steps failed on known error.
`private int`	`stepsPassed` The number of passed steps.
`private int`	`stepsUndefined` The number of undefined steps.

Constructor Summary

Constructors
Constructor and Description

OverviewStats()

Constructors
Constructor and Description
`OverviewStats()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`OverviewStats`	`add(OverviewStats other)` Merges 2 overview statistic structures where all corresponding values are simply added to current object.
`void`	`addFeaturesFailed(int featuresFailedValue)`
`void`	`addFeaturesKnown(int featuresKnownValue)`
`void`	`addFeaturesPassed(int featuresPassedValue)`
`void`	`addFeaturesUndefined(int featuresUndefinedValue)`
`void`	`addOverallDuration(float overallDurationValue)`
`void`	`addScenariosFailed(int scenariosFailedValue)`
`void`	`addScenariosKnown(int scenariosKnownValue)`
`void`	`addScenariosPassed(int scenariosPassedValue)`
`void`	`addScenariosUndefined(int scenariosUndefinedValue)`
`void`	`addStepsFailed(int stepsFailedValue)`
`void`	`addStepsKnown(int stepsKnownValue)`
`void`	`addStepsPassed(int stepsPassedValue)`
`void`	`addStepsUndefined(int stepsUndefinedValue)`
`int`	`getFeaturesFailed()`
`int`	`getFeaturesKnown()`
`int`	`getFeaturesPassed()`
`String`	`getFeatureStatus()` Calculates the feature run status.
`int`	`getFeaturesTotal()`
`int`	`getFeaturesUndefined()`
`float`	`getOverallDuration()`
`int`	`getScenariosFailed()`
`int`	`getScenariosKnown()`
`int`	`getScenariosPassed()`
`String`	`getScenarioStatus()` Calculates the scenario run status.
`int`	`getScenariosTotal()`
`int`	`getScenariosUndefined()`
`int`	`getStepsFailed()`
`int`	`getStepsKnown()`
`int`	`getStepsPassed()`
`int`	`getStepsTotal()`
`int`	`getStepsUndefined()`
`boolean`	`isEmpty()` Checks if current data structure actually doesn't contain any statistics.
`private void`	`reset()`
`OverviewStats`	`valuate(CucumberFeatureResult result)` Calculates run statistics for the single feature result.
`OverviewStats`	`valuate(CucumberFeatureResult[] results)` Calculates overall statistics for the group of features.
`OverviewStats`	`valuate(CucumberScenarioResult scenario)` Calculates overall statistics for specific scenario.

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

- Field Detail
  - featuresPassed
```
private int featuresPassed
```
    The number of passed features. Feature is treated as passed if all scenarios in the feature have passed status.
  - featuresFailed
```
private int featuresFailed
```
    The number of failed features. Feature is treated as failed if at least 1 scenario has failed status.
  - featuresKnown
```
private int featuresKnown
```
    The number of features failed on known errors. They aren't treated as failed. Feature is treated as of known status when it has at least one scenario of known status and no failed scenarios.
  - featuresUndefined
```
private int featuresUndefined
```
    The number of features in undefined state.
  - scenariosPassed
```
private int scenariosPassed
```
    The number of scenarios passed. Scenario is passed only if all steps are passed.
  - scenariosFailed
```
private int scenariosFailed
```
    The number of failed scenarios. Scenario is treated failed when at least one step is failed.
  - scenariosKnown
```
private int scenariosKnown
```
    The number of scenarios failing on known error. Scenario is considered of known status if it has failure on known error but no other errors.
  - scenariosUndefined
```
private int scenariosUndefined
```
    The number of undefined scenairos.
  - stepsPassed
```
private int stepsPassed
```
    The number of passed steps.
  - stepsFailed
```
private int stepsFailed
```
    The number of failed steps.
  - stepsKnown
```
private int stepsKnown
```
    The number of steps failed on known error.
  - stepsUndefined
```
private int stepsUndefined
```
    The number of undefined steps.
  - overallDuration
```
private float overallDuration
```
    The overall duration for all steps.
- Constructor Detail
  - OverviewStats
```
public OverviewStats()
```
- Method Detail
  - reset
```
private void reset()
```
  - getFeaturesPassed
```
public final int getFeaturesPassed()
```
  - getFeaturesFailed
```
public final int getFeaturesFailed()
```
  - getFeaturesUndefined
```
public final int getFeaturesUndefined()
```
  - getFeaturesTotal
```
public final int getFeaturesTotal()
```
  - getScenariosPassed
```
public final int getScenariosPassed()
```
  - getScenariosFailed
```
public final int getScenariosFailed()
```
  - getScenariosUndefined
```
public final int getScenariosUndefined()
```
  - getScenariosTotal
```
public final int getScenariosTotal()
```
  - getStepsPassed
```
public final int getStepsPassed()
```
  - getStepsFailed
```
public final int getStepsFailed()
```
  - getStepsUndefined
```
public final int getStepsUndefined()
```
  - getStepsTotal
```
public final int getStepsTotal()
```
  - getOverallDuration
```
public final float getOverallDuration()
```
  - getFeaturesKnown
```
public int getFeaturesKnown()
```
  - getScenariosKnown
```
public int getScenariosKnown()
```
  - getStepsKnown
```
public int getStepsKnown()
```
  - addFeaturesPassed
```
public final void addFeaturesPassed(int featuresPassedValue)
```
  - addFeaturesFailed
```
public final void addFeaturesFailed(int featuresFailedValue)
```
  - addFeaturesUndefined
```
public final void addFeaturesUndefined(int featuresUndefinedValue)
```
  - addScenariosPassed
```
public final void addScenariosPassed(int scenariosPassedValue)
```
  - addScenariosFailed
```
public final void addScenariosFailed(int scenariosFailedValue)
```
  - addScenariosUndefined
```
public final void addScenariosUndefined(int scenariosUndefinedValue)
```
  - addStepsPassed
```
public final void addStepsPassed(int stepsPassedValue)
```
  - addStepsFailed
```
public final void addStepsFailed(int stepsFailedValue)
```
  - addStepsUndefined
```
public final void addStepsUndefined(int stepsUndefinedValue)
```
  - addOverallDuration
```
public final void addOverallDuration(float overallDurationValue)
```
  - addFeaturesKnown
```
public void addFeaturesKnown(int featuresKnownValue)
```
  - addScenariosKnown
```
public void addScenariosKnown(int scenariosKnownValue)
```
  - addStepsKnown
```
public void addStepsKnown(int stepsKnownValue)
```
  - add
```
public OverviewStats add(OverviewStats other)
```
    Merges 2 overview statistic structures where all corresponding values are simply added to current object.
    
    Parameters:
    
    other - the other structure of the OverviewStats type to add values from.
    
    Returns:
    
    the structure containing the sum of current statistics and the statistics from the parameter.
  - valuate
```
public OverviewStats valuate(CucumberScenarioResult scenario)
```
    Calculates overall statistics for specific scenario.
    
    Parameters:
    
    scenario - the scenario result to calculate statistics for.
    
    Returns:
    
    calculated statistics for specific scenario.
  - valuate
```
public OverviewStats valuate(CucumberFeatureResult result)
```
    Calculates run statistics for the single feature result.
    
    Parameters:
    
    result - the feature result data to calculate statistics for.
    
    Returns:
    
    the calculated statistics for the specific feature.
  - valuate
```
public OverviewStats valuate(CucumberFeatureResult[] results)
```
    Calculates overall statistics for the group of features.
    
    Parameters:
    
    results - the list of features to calculate run statistics for.
    
    Returns:
    
    calculated statistics for the specified set of features.
  - getFeatureStatus
```
public String getFeatureStatus()
```
    Calculates the feature run status.
    
    Returns:
    
    the run status string which can be one of the following: "passed", "failed", "known", "undefined".
  - getScenarioStatus
```
public String getScenarioStatus()
```
    Calculates the scenario run status.
    
    Returns:
    
    the run status string which can be one of the following: "passed", "failed", "known", "undefined".
  - isEmpty
```
public boolean isEmpty()
```
    Checks if current data structure actually doesn't contain any statistics.
    
    Returns:
    
    Returns true if all of the fields are 0. False otherwise.

Class OverviewStats

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

featuresPassed

featuresFailed

featuresKnown

featuresUndefined

scenariosPassed

scenariosFailed

scenariosKnown

scenariosUndefined

stepsPassed

stepsFailed

stepsKnown

stepsUndefined

overallDuration

Constructor Detail

OverviewStats

Method Detail

reset

getFeaturesPassed

getFeaturesFailed

getFeaturesUndefined

getFeaturesTotal

getScenariosPassed

getScenariosFailed

getScenariosUndefined

getScenariosTotal

getStepsPassed

getStepsFailed

getStepsUndefined

getStepsTotal

getOverallDuration

getFeaturesKnown

getScenariosKnown

getStepsKnown

addFeaturesPassed

addFeaturesFailed

addFeaturesUndefined

addScenariosPassed

addScenariosFailed

addScenariosUndefined

addStepsPassed

addStepsFailed

addStepsUndefined

addOverallDuration

addFeaturesKnown

addScenariosKnown

addStepsKnown

add

valuate

valuate

valuate

getFeatureStatus

getScenarioStatus

isEmpty