CountersInterface (SAFS API DOCUMENT)

All Known Implementing Classes:

SAFSCOUNTERS
```
public interface CountersInterface
```

Field Summary

Fields
Modifier and Type	Field and Description
`static long`	`ALL_STATUS_INFO_MODE` 1L
`static long`	`STATUS_GENERAL_FAILURE` '5L' status type for incrementing counters.
`static long`	`STATUS_GENERAL_PASS` '3L' status type for incrementing counters.
`static long`	`STATUS_GENERAL_WARNING` '4L' status type for incrementing counters.
`static long`	`STATUS_IO_FAILURE` '7L' status type for incrementing counters.
`static long`	`STATUS_SKIPPED_RECORD` '6L' status type for incrementing counters.
`static long`	`STATUS_TEST_FAILURE` '2L' status type for incrementing counters.
`static long`	`STATUS_TEST_IO_FAILURE` '8L' status type for incrementing counters.
`static long`	`STATUS_TEST_PASS` '0L' status type for incrementing counters.
`static long`	`STATUS_TEST_WARNING` '1L' status type for incrementing counters.
`static long`	`STEP_TESTS_ONLY_MODE` 2L

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`clearCounter(UniqueIDInterface counter)` Clear all counts on the specified counter.
`void`	`copyCounter(UniqueIDInterface from_counter, UniqueIDInterface to_counter)` Copy the from_counter counts to the specified to_counter.
`void`	`copyStatus(StatusInterface from_status, UniqueIDInterface to_counter)` Copy the from_status counts to the specified to_counter.
`void`	`deleteCounter(UniqueIDInterface counter)` Delete a counter out of storage.
`void`	`diffCounters(UniqueIDInterface sub_counter, UniqueIDInterface from_counter)` Substract the sub_counter counts from the specified from_counter.
`void`	`diffStatus(StatusInterface sub_status, UniqueIDInterface from_counter)` Substract the sub_status counts from the specified from_counter.
`long`	`getCounterMode(UniqueIDInterface counter)` Get a counter's mode.
`CountStatusInterface`	`getStatus(UniqueIDInterface counter)` Get the status counts from the specified counter.
`void`	`incrementAllCounters(UniqueCounterInterface testlevel, long status)` Increment the Total Records and the appropriate status count for ALL counters.
`long`	`incrementGeneralFailures(UniqueCounterInterface counter)` Increment the Total Records and General Failures count for the counter.
`long`	`incrementGeneralPasses(UniqueCounterInterface counter)` Increment the Total Records and General Passes count for the counter.
`long`	`incrementGeneralWarnings(UniqueCounterInterface counter)` Increment the Total Records and General Warnings count for the counter.
`long`	`incrementIOFailures(UniqueCounterInterface counter)` Increment the Total Records and IO Failure Records count for the counter.
`long`	`incrementSkippedRecords(UniqueCounterInterface counter)` Increment the Total Records and Skipped Records count for the counter.
`long`	`incrementTestFailures(UniqueCounterInterface counter)` Increment the Total Records and Test Failures count for the counter.
`long`	`incrementTestIOFailures(UniqueCounterInterface counter)` Increment the Total Records, Test Failures, and IO Failure Records count for the counter.
`long`	`incrementTestPasses(UniqueCounterInterface counter)` Increment the Total Records and Test Passes count for the counter.
`long`	`incrementTestWarnings(UniqueCounterInterface counter)` Increment the Total Records and Test Warnings count for the counter.
`void`	`initCounter(UniqueIDInterface counter)` Initialize/Start a new counter.
`void`	`resumeAllCounting()` Resumes counting suspended by suspendAllCounting.
`void`	`resumeCounter(UniqueIDInterface counter)` Resume counting on a single counter suspended by suspendCounter.
`void`	`setCounterMode(UniqueIDInterface counter, long mode)` Set a counter's mode.
`void`	`sumCounters(UniqueIDInterface add_counter, UniqueIDInterface to_counter)` Add the add_counter counts to the specified to_counter.
`void`	`sumStatus(StatusInterface add_status, UniqueIDInterface to_counter)` Add the add_status counts to the specified to_counter.
`void`	`suspendAllCounting()` Suspends counting on ALL counters until counting is resumed with resumeAllCounting.
`void`	`suspendCounter(UniqueIDInterface counter)` Suspend counting on a specific counter.

- Field Detail
  - ALL_STATUS_INFO_MODE
```
static final long ALL_STATUS_INFO_MODE
```
    1L
    
    See Also:
    
    Constant Field Values
  - STEP_TESTS_ONLY_MODE
```
static final long STEP_TESTS_ONLY_MODE
```
    2L
    
    See Also:
    
    Constant Field Values
  - STATUS_TEST_PASS
```
static final long STATUS_TEST_PASS
```
    '0L' status type for incrementing counters.
    
    See Also:
    
    Constant Field Values
  - STATUS_TEST_WARNING
```
static final long STATUS_TEST_WARNING
```
    '1L' status type for incrementing counters.
    
    See Also:
    
    Constant Field Values
  - STATUS_TEST_FAILURE
```
static final long STATUS_TEST_FAILURE
```
    '2L' status type for incrementing counters.
    
    See Also:
    
    Constant Field Values
  - STATUS_GENERAL_PASS
```
static final long STATUS_GENERAL_PASS
```
    '3L' status type for incrementing counters.
    
    See Also:
    
    Constant Field Values
  - STATUS_GENERAL_WARNING
```
static final long STATUS_GENERAL_WARNING
```
    '4L' status type for incrementing counters.
    
    See Also:
    
    Constant Field Values
  - STATUS_GENERAL_FAILURE
```
static final long STATUS_GENERAL_FAILURE
```
    '5L' status type for incrementing counters.
    
    See Also:
    
    Constant Field Values
  - STATUS_SKIPPED_RECORD
```
static final long STATUS_SKIPPED_RECORD
```
    '6L' status type for incrementing counters.
    
    See Also:
    
    Constant Field Values
  - STATUS_IO_FAILURE
```
static final long STATUS_IO_FAILURE
```
    '7L' status type for incrementing counters.
    
    See Also:
    
    Constant Field Values
  - STATUS_TEST_IO_FAILURE
```
static final long STATUS_TEST_IO_FAILURE
```
    '8L' status type for incrementing counters.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - initCounter
```
void initCounter(UniqueIDInterface counter)
```
    Initialize/Start a new counter.
  - getStatus
```
CountStatusInterface getStatus(UniqueIDInterface counter)
```
    Get the status counts from the specified counter.
  - copyCounter
```
void copyCounter(UniqueIDInterface from_counter,
                 UniqueIDInterface to_counter)
```
    Copy the from_counter counts to the specified to_counter.
  - copyStatus
```
void copyStatus(StatusInterface from_status,
                UniqueIDInterface to_counter)
```
    Copy the from_status counts to the specified to_counter.
  - sumCounters
```
void sumCounters(UniqueIDInterface add_counter,
                 UniqueIDInterface to_counter)
```
    Add the add_counter counts to the specified to_counter. The results are stored in the to_counter.
  - sumStatus
```
void sumStatus(StatusInterface add_status,
               UniqueIDInterface to_counter)
```
    Add the add_status counts to the specified to_counter. The results are stored in the to_counter.
  - diffCounters
```
void diffCounters(UniqueIDInterface sub_counter,
                  UniqueIDInterface from_counter)
```
    Substract the sub_counter counts from the specified from_counter. The results are stored in the from_counter.
  - diffStatus
```
void diffStatus(StatusInterface sub_status,
                UniqueIDInterface from_counter)
```
    Substract the sub_status counts from the specified from_counter. The results are stored in the from_counter.
  - clearCounter
```
void clearCounter(UniqueIDInterface counter)
```
    Clear all counts on the specified counter.
  - suspendCounter
```
void suspendCounter(UniqueIDInterface counter)
```
    Suspend counting on a specific counter.
  - suspendAllCounting
```
void suspendAllCounting()
```
    Suspends counting on ALL counters until counting is resumed with resumeAllCounting. Counters already suspended prior to this call will not resume counting due to a call to resumeAllCounting. You must use resumeCounter to resume counting for these.
  - resumeCounter
```
void resumeCounter(UniqueIDInterface counter)
```
    Resume counting on a single counter suspended by suspendCounter. Counting will not resume if suspendAllCounters is still "active". In this case, counting will resume once resumeAllCounting has been called.
  - resumeAllCounting
```
void resumeAllCounting()
```
    Resumes counting suspended by suspendAllCounting. Counters specifically suspended by suspendCounter are NOT resumed. You must use resumeCounter to resume counting for these.
  - incrementAllCounters
```
void incrementAllCounters(UniqueCounterInterface testlevel,
                          long status)
```
    Increment the Total Records and the appropriate status count for ALL counters.
  - incrementTestFailures
```
long incrementTestFailures(UniqueCounterInterface counter)
```
    Increment the Total Records and Test Failures count for the counter.
  - incrementTestWarnings
```
long incrementTestWarnings(UniqueCounterInterface counter)
```
    Increment the Total Records and Test Warnings count for the counter.
  - incrementTestPasses
```
long incrementTestPasses(UniqueCounterInterface counter)
```
    Increment the Total Records and Test Passes count for the counter.
  - incrementGeneralFailures
```
long incrementGeneralFailures(UniqueCounterInterface counter)
```
    Increment the Total Records and General Failures count for the counter.
  - incrementGeneralWarnings
```
long incrementGeneralWarnings(UniqueCounterInterface counter)
```
    Increment the Total Records and General Warnings count for the counter.
  - incrementGeneralPasses
```
long incrementGeneralPasses(UniqueCounterInterface counter)
```
    Increment the Total Records and General Passes count for the counter.
  - incrementIOFailures
```
long incrementIOFailures(UniqueCounterInterface counter)
```
    Increment the Total Records and IO Failure Records count for the counter.
  - incrementTestIOFailures
```
long incrementTestIOFailures(UniqueCounterInterface counter)
```
    Increment the Total Records, Test Failures, and IO Failure Records count for the counter.
  - incrementSkippedRecords
```
long incrementSkippedRecords(UniqueCounterInterface counter)
```
    Increment the Total Records and Skipped Records count for the counter.
  - deleteCounter
```
void deleteCounter(UniqueIDInterface counter)
```
    Delete a counter out of storage.
  - setCounterMode
```
void setCounterMode(UniqueIDInterface counter,
                    long mode)
```
    Set a counter's mode. mode==1: count everything (default). mode==2: count only STEP level results.
  - getCounterMode
```
long getCounterMode(UniqueIDInterface counter)
```
    Get a counter's mode. mode==1: count everything (default). mode==2: count only STEP level results.

Interface CountersInterface

Field Summary

Method Summary

Field Detail

ALL_STATUS_INFO_MODE

STEP_TESTS_ONLY_MODE

STATUS_TEST_PASS

STATUS_TEST_WARNING

STATUS_TEST_FAILURE

STATUS_GENERAL_PASS

STATUS_GENERAL_WARNING

STATUS_GENERAL_FAILURE

STATUS_SKIPPED_RECORD

STATUS_IO_FAILURE

STATUS_TEST_IO_FAILURE

Method Detail

initCounter

getStatus

copyCounter

copyStatus

sumCounters

sumStatus

diffCounters

diffStatus

clearCounter

suspendCounter

suspendAllCounting

resumeCounter

resumeAllCounting

incrementAllCounters

incrementTestFailures

incrementTestWarnings

incrementTestPasses

incrementGeneralFailures

incrementGeneralWarnings

incrementGeneralPasses

incrementIOFailures

incrementTestIOFailures

incrementSkippedRecords

deleteCounter

setCounterMode

getCounterMode