Quality (TestHelpers 1.0-SNAPSHOT API)

java.lang.Object
- java.lang.Enum<Quality>
- - eu.simuline.testhelpers.Quality

All Implemented Interfaces:: Serializable, Comparable<Quality>

enum Quality
extends Enum<Quality>

Represents the phases in the life-cycle of a TestCase from being Scheduled to Ignored or via Started to finished which means either Invalidated, Success, Failure or even Error.

The phase transitions are triggered by the events notified by a RunListener as depicted below.

                              |RunListener.testRunStarted(Description)
                              |
                   Scheduled
                             /|
                            / |
 #testIgnored(Description)/   |RunListener.testStarted(Description)
                         /    |
                        /     |
          Ignored    |
                              |
                    Started
                             /|\
 #testFinished(Description)/  |#testAssumptionFailure(Failure)
                         /    |    \
                        /     |     \ 
        _______________/      |      \__________
       /                      |                 \ 
      / RunListener.testFailure(Failure) \ 
     /                        /\                  \
    /                        /  \                  \ 
   /                        /    \                  \
 Success Failure Error Invalidated.

Accordingly, there are methods setXXX for transition to the next state: setScheduled(), setStarted() prior to testing, setIgnored() if not to be tested and setFinished(), setAssumptionFailure() and setFailure(Throwable) after the test finished. All these methods prevent invalid phase transitions throwin an IllegalStateException.

For each of these phases, there are methods to represent the quality or further aspects of a testcase graphically: Each Quality defines

a separate icon given by getIcon(),
a status message given by getMessage()
a color getColor() influencing the color of the progress bar
a method setTime(long) to compute the time required for a test run.

Finally, there are further methods to ask for certain properties as isNeutral() and hasFailure(). Created: Wed Jun 12 16:41:14 2006

Version:: 1.0
Author:: Ernst Reissner

Enum Constant Summary

Enum Constants
Enum Constant and Description
`Error` The execution of the testcase failed indicated by finishing with exception or error other than `AssertionFailedError`.
`Failure` The execution of the testcase finished gracefully but did not succeed: At least one assertion is hurt, indicated by an `AssertionFailedError`.
`Ignored` The testcase was ignored, i.e. was scheduled for execution but then decided not to start execution.
`Invalidated` The execution of the testcase ran onto an hurt assumption before maybe running into further exceptions or errors and is thus invalidated.
`Scheduled` The testcase is scheduled for execution but execution has not yet been started nor has it been decided to ignore, i.e. not to execute the testcase.
`Started` The execution of the testcase started but did not finish in any way.
`Success` The execution of the testcase finished and the test succeeded (passed): All assertions hold and no throwable has been thrown.

Field Summary

Fields
Modifier and Type	Field and Description
`private static Color`	`COLOR_FAIL` Represents a failed testcase.
`private static Color`	`COLOR_IGNORED` Represents an ignored testcase.
`private static Color`	`COLOR_OK` Represents a testcase which did neither failed.
`private int`	`level` Encoding how good the result of the test is: `2` if something went wrong: `Error` or `Failure`.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`(package private) Color`	`getColor()` Returns the color associated with this phase: If this phase represents an irregular ending testcase, `COLOR_FAIL` is returned.
`(package private) abstract ImageIcon`	`getIcon()` Returns an icon representing this phase on the GUI.
`(package private) abstract String`	`getMessage()` Returns a status message which describes this phase.
`(package private) boolean`	`hasFailure()` Returns whether the given state is tied to a throwable.
`(package private) boolean`	`isNeutral()` Returns whether the underlying testcase is neither finished unsuccessfully nor ignored.
`(package private) Quality`	`max(Quality other)` Determines a Quality with the maximum level of `this` and `other`.
`(package private) Quality`	`setAssumptionFailure()` Returns the next phase when `RunListener.testAssumptionFailure(Failure)` is invoked.
`(package private) Quality`	`setFailure(Throwable thrw)` Returns the next phase when `RunListener.testFailure(Failure)` is invoked.
`(package private) Quality`	`setFinished()` Returns the next phase when `RunListener.testFinished(Description)` is invoked.
`(package private) Quality`	`setIgnored()` Returns the next phase when `RunListener.testIgnored(Description)` is invoked.
`(package private) Quality`	`setScheduled()` Returns the next phase when `RunListener.testRunStarted(Description)` is invoked.
`(package private) Quality`	`setStarted()` Returns the next phase when `RunListener.testStarted(Description)` is invoked.
`(package private) long`	`setTime(long time)` Returns the difference of the current time in milliseconds.
`static Quality`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static Quality[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

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

- Enum Constant Detail
  - Scheduled
```
public static final Quality Scheduled
```
    The testcase is scheduled for execution but execution has not yet been started nor has it been decided to ignore, i.e. not to execute the testcase.
    
    See Also:
    
    Started, Ignored
  - Started
```
public static final Quality Started
```
    The execution of the testcase started but did not finish in any way. Thus it is neither clear whether the execution succeeds nor the outcoming of the test.
  - Success
```
public static final Quality Success
```
    The execution of the testcase finished and the test succeeded (passed): All assertions hold and no throwable has been thrown.
  - Invalidated
```
public static final Quality Invalidated
```
    The execution of the testcase ran onto an hurt assumption before maybe running into further exceptions or errors and is thus invalidated.
  - Ignored
```
public static final Quality Ignored
```
    The testcase was ignored, i.e. was scheduled for execution but then decided not to start execution. In particular, nothing can be said about the course of the test run.
  - Failure
```
public static final Quality Failure
```
    The execution of the testcase finished gracefully but did not succeed: At least one assertion is hurt, indicated by an AssertionFailedError. This excludes further throwables.
  - Error
```
public static final Quality Error
```
    The execution of the testcase failed indicated by finishing with exception or error other than AssertionFailedError. Thus there is no valid test result.
- Field Detail
  - level
```
private int level
```
    Encoding how good the result of the test is:
    - 2 if something went wrong: Error or Failure.
    - 1 if something was ignored Ignored or Invalidated.
    - 0 else: Scheduled, Started or Success.
    This is used to define the color of the progress bar.
    See Also:
    
    max(Quality)
  - COLOR_FAIL
```
private static final Color COLOR_FAIL
```
    Represents a failed testcase.
  - COLOR_OK
```
private static final Color COLOR_OK
```
    Represents a testcase which did neither failed.
  - COLOR_IGNORED
```
private static final Color COLOR_IGNORED
```
    Represents an ignored testcase.
- Method Detail
  - values
```
public static Quality[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (Quality c : Quality.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static Quality valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - setScheduled
```
Quality setScheduled()
```
    Returns the next phase when RunListener.testRunStarted(Description) is invoked.
    
    Returns:
    
    Scheduled except this is Started. Even for Scheduled itself.
    
    Throws:
    
    IllegalStateException - for Started. **** it is a decision to disallow rescheduling a running testcase.
  - setStarted
```
Quality setStarted()
```
    Returns the next phase when RunListener.testStarted(Description) is invoked.
    
    Returns:
    
    Started if this is Scheduled.
    
    Throws:
    
    IllegalStateException - except if this is Scheduled
  - setIgnored
```
Quality setIgnored()
```
    Returns the next phase when RunListener.testIgnored(Description) is invoked.
    
    Returns:
    
    Ignored if this is Scheduled.
    
    Throws:
    
    IllegalStateException - except for Scheduled.
  - setFinished
```
Quality setFinished()
```
    Returns the next phase when RunListener.testFinished(Description) is invoked.
    Returns:
    this for Failure, Invalidated and Error
    Success for Started.
    Throws:
    
    IllegalStateException - for Scheduled, Success and Ignored.
  - setAssumptionFailure
```
Quality setAssumptionFailure()
```
    Returns the next phase when RunListener.testAssumptionFailure(Failure) is invoked.
    
    Returns:
    
    Invalidated for Started.
    
    Throws:
    
    IllegalStateException - for all but Started.
  - setFailure
```
Quality setFailure(Throwable thrw)
```
    Returns the next phase when RunListener.testFailure(Failure) is invoked.
    
    Parameters:
    
    thrw - a throwable which determines whether the returned phase indicates a failure or an error.
    
    Returns:
    
    Failure or Error for Started depending on whether thrw is an AssertionError (should be AssertionFailedError).
    
    Throws:
    
    IllegalStateException - for all but Started. If this is Started but failure is an AssumptionViolatedException.
  - getIcon
```
abstract ImageIcon getIcon()
```
    Returns an icon representing this phase on the GUI.
    
    Returns:
    
    an icon representing this phase on the GUI.
  - getMessage
```
abstract String getMessage()
```
    Returns a status message which describes this phase.
    
    Returns:
    
    a status message which describes this phase.
  - max
```
Quality max(Quality other)
```
    Determines a Quality with the maximum level of this and other. In conjunction with getColor(), this is used to determine the color of the progress bar in a JUnit GUI
    
    Returns:
    
    the Quality with the maximum level of this and other.
    
    See Also:
    
    GUIRunner.TestProgressBar.noteReportResult(TestCase)
  - getColor
```
Color getColor()
```
    Returns the color associated with this phase: If this phase represents an irregular ending testcase, COLOR_FAIL is returned. Else if this phase represents an ignored testcase, COLOR_IGNORED is returned. Else COLOR_OK is returned.
    
    Returns:
    
    the color associated with this phase.
    
    See Also:
    
    max(Quality)
  - setTime
```
long setTime(long time)
```
    Returns the difference of the current time in milliseconds.
    Parameters:
    time - some time in milliseconds. The details depend on this:
    
    Scheduled, Ignored and Started ignore that parameter.
    Failure, Invalidated, Error and Success interprete time as the start time of the underlying testcase.
    Returns:
    -1 for Scheduled.
    -0 for Ignored.
    The current time System.currentTimeMillis() for Started.
    the span of time the underlying testcase took from start to finish
  - isNeutral
```
boolean isNeutral()
```
    Returns whether the underlying testcase is neither finished unsuccessfully nor ignored. This is false except for Scheduled, Started and Success. Neutral qualities do not occur in the statistics given by GUIRunner.StatisticsTestState.
    
    Returns:
    
    whether the underlying testcase is neither finished unsuccessfully nor ignored.
  - hasFailure
```
boolean hasFailure()
```
    Returns whether the given state is tied to a throwable.
    
    Returns:
    
    true iff this is Invalidated, Failure or Error.

Enum Quality

Enum Constant Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

Scheduled

Started

Success

Invalidated

Ignored

Failure

Error

Field Detail

level

COLOR_FAIL

COLOR_OK

COLOR_IGNORED

Method Detail

values

valueOf

setScheduled

setStarted

setIgnored

setFinished

setAssumptionFailure

setFailure

getIcon

getMessage

max

getColor

setTime

isNeutral

hasFailure