ResultSet (dark-matter 3.1.15 API)

java.lang.Object
- org.dmd.util.exceptions.ResultSet

```
public class ResultSet
extends Object
```
The ResultSet class manages a set of Results that can be passed back from an arbitrarily deep set of function calls. It maintains an indication of the total number of results that came back and what the worst severity encountered was.
The ResultSet can also be used in conjunction with the MessageManager class that provide Locale independent messaging. The ResultSet has an associated Locale that users of the class can use to generate the appropriate messages dependent on the Locale.

Version:

1.0

Author:

Peter Strong

Constructor Summary

Constructors
Constructor and Description

ResultSet()
Creates a new Results container.

ResultSet(Locale l)
Creates a new Results container with the specified Locale.

Constructors
Constructor and Description
`ResultSet()` Creates a new Results container.
`ResultSet(Locale l)` Creates a new Results container with the specified Locale.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Result`	`addResult(int sev, String message)` Returns a Result container that can be populated with further information if required.
`Result`	`addResult(Result r)` Makes a copy of the specified result and adds it to this result set.
`void`	`addResults(ResultSet rs)` Adds copies of the results in the specified result set to this result set.
`int`	`errors()` Returns the number of errors encountered.
`Iterator<Result>`	`iterator()` Returns an iterator over the current set of results.
`Result`	`lastResult()` Provides access to the last result that was added to the set.
`Locale`	`locale()` Returns the number of results in the set.
`void`	`reset()` Resets the result to have no results.
`int`	`resultCount()` Returns the number of results in the set.
`String`	`toString()` Returns the entire set of results as a string.
`int`	`warnings()` Returns the number of warnings encountered.
`int`	`worst()` Returns the worst severity that's been added to the set.

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

- Constructor Detail
  - ResultSet
```
public ResultSet()
```
    Creates a new Results container.
  - ResultSet
```
public ResultSet(Locale l)
```
    Creates a new Results container with the specified Locale.
- Method Detail
  - reset
```
public void reset()
```
    Resets the result to have no results.
  - iterator
```
public Iterator<Result> iterator()
```
    Returns an iterator over the current set of results.
  - locale
```
public Locale locale()
```
    Returns the number of results in the set.
  - resultCount
```
public int resultCount()
```
    Returns the number of results in the set.
  - errors
```
public int errors()
```
    Returns the number of errors encountered.
  - warnings
```
public int warnings()
```
    Returns the number of warnings encountered.
  - addResult
```
public Result addResult(int sev,
                        String message)
```
    Returns a Result container that can be populated with further information if required. This increases the number of results in the result set by 1.
  - addResult
```
public Result addResult(Result r)
```
    Makes a copy of the specified result and adds it to this result set.
  - lastResult
```
public Result lastResult()
```
    Provides access to the last result that was added to the set.
    
    Returns:
    
    The last Result or null if no results in the set.
  - worst
```
public int worst()
```
    Returns the worst severity that's been added to the set.
  - toString
```
public String toString()
```
    Returns the entire set of results as a string.
    
    Overrides:
    
    toString in class Object
  - addResults
```
public void addResults(ResultSet rs)
```
    Adds copies of the results in the specified result set to this result set.

Class ResultSet

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ResultSet

ResultSet

Method Detail

reset

iterator

locale

resultCount

errors

warnings

addResult

addResult

lastResult

worst

toString

addResults