org.specrunner.result

Interface IResultSet

All Superinterfaces:

Collection<IResult>, IPresentation, IStatus, Iterable<IResult>, List<IResult>

All Known Implementing Classes:

ResultSetImpl

public interface IResultSet
extends List<IResult>, IStatus, IPresentation

A result set.

Author:

Thiago Santos

Field Summary

Fields

Modifier and Type	Field and Description
static String	FEATURE_ERROR_MAX_SIZE Feature for limit quantity of errors in toString().
static String	FEATURE_EXPECTED_CRITERIA Feature for messages criteria.
static String	FEATURE_EXPECTED_MESSAGES Feature for expected messages.
static String	FEATURE_EXPECTED_SORTED Feature for messages expectation order.
static String	FEATURE_FULL_TRACE Feature for full trace on results.
static String	FEATURE_RECORD_SUCCESS Feature for disable success recording.
static String	FEATURE_RESULT_FILTER Feature for result filter.

Method Summary

Methods

Modifier and Type	Method and Description
List<ActionType>	actionTypes() List action types available for all results.
List<ActionType>	actionTypes(List<IResult> subset) List action types available for the result subset.
IResult	addResult(Status status, IBlock source) Add a result.
IResult	addResult(Status status, IBlock source, IWritable writable) Adds a result.
IResult	addResult(Status status, IBlock source, String message) Adds a result with a message.
IResult	addResult(Status status, IBlock source, String message, IWritable writable) Adds a result with a message and a writable information.
IResult	addResult(Status status, IBlock source, Throwable failure) Adds a result with failure information.
IResult	addResult(Status status, IBlock source, Throwable failure, IWritable writable) Adds a result with failure and a writable information.
<T extends Status> List<T>	availableStatus() Lists status in result.
void	consolidate(IContext context) Consolidate expectations and received errors.
int	countErrors() Return number of errors.
int	countErrors(int start) Return number of errors.
<T extends Status> int	countStatus(int start, int end, T... status) Counts the status of a given type.
<T extends Status> int	countStatus(List<IResult> subset, T... status) Counts the status of a given type.
<T extends Status> int	countStatus(T... status) Counts the status of a given type.
int	countType(ActionType... actionType) Count results of a given set of action types.
int	countType(List<IResult> subset, ActionType... actionType) Count results of a given type in a list.
<T extends Status> List<T>	errorStatus() Lists error status in result.
<T extends Status> List<IResult>	filterByStatus(int start, int end, T... status) Filters result by status type.
<T extends Status> List<IResult>	filterByStatus(List<IResult> subset, T... status) Filters result by status type.
<T extends Status> List<IResult>	filterByStatus(T... status) Filters result by status type.
List<IResult>	filterByType(ActionType... actionType) Filter the result itself by ActionType.
List<IResult>	filterByType(List<IResult> subset, ActionType... actionType) Filter the subset by ActionType.
IStringTest	getCriteria() String comparison criteria for messages.
Integer	getErrorMaxSize() Set max size of error list in toString()
Boolean	getFullTrace() Get full trace status.
String[]	getMessages() Get the expected messages.
Boolean	getRecordSuccess() Flag to record status which isError returns true.
IResultFilter	getResultFilter() Return the filter.
Boolean	getSorted() Get the sort flag.
void	setCriteria(IStringTest criteria) Set a string comparison criteria for messages.
void	setErrorMaxSize(Integer size) Set max quantity of erros in toString().
void	setFullTrace(Boolean fullTrace) Set full trace on results dump.
void	setMessages(String[] expected) Set expected messages.
void	setRecordSuccess(Boolean recordSuccess) Setting to record success action in result set.
void	setResultFilter(IResultFilter resultFilter) Set result filter.
void	setSorted(Boolean sorted) Set expected order of messages.
IResultSet	subSet(int start, int end) Get a subset of result as a result set itself.

Methods inherited from interface java.util.List

add, add, addAll, addAll, clear, contains, containsAll, equals, get, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, retainAll, set, size, subList, toArray, toArray

Methods inherited from interface org.specrunner.result.IStatus

getStatus

Methods inherited from interface org.specrunner.util.xom.IPresentation

asNode, asString

Field Detail

FEATURE_FULL_TRACE

static final String FEATURE_FULL_TRACE

Feature for full trace on results.

FEATURE_ERROR_MAX_SIZE

static final String FEATURE_ERROR_MAX_SIZE

Feature for limit quantity of errors in toString(). Default value is 50.

FEATURE_RESULT_FILTER

static final String FEATURE_RESULT_FILTER

Feature for result filter.

FEATURE_RECORD_SUCCESS

static final String FEATURE_RECORD_SUCCESS

Feature for disable success recording.

FEATURE_EXPECTED_MESSAGES

static final String FEATURE_EXPECTED_MESSAGES

Feature for expected messages.

FEATURE_EXPECTED_SORTED

static final String FEATURE_EXPECTED_SORTED

Feature for messages expectation order.

FEATURE_EXPECTED_CRITERIA

static final String FEATURE_EXPECTED_CRITERIA

Feature for messages criteria.

Method Detail

setFullTrace

void setFullTrace(Boolean fullTrace)

Set full trace on results dump.

Parameters:

fullTrace - true, to show full trace, false, otherwise. Default is 'true'.

getFullTrace

Boolean getFullTrace()

Get full trace status.

Returns:

true, if full trace is enabled, false, otherwise.

setErrorMaxSize

void setErrorMaxSize(Integer size)

Set max quantity of erros in toString().

Parameters:

fullTrace - true, to show full trace, false, otherwise. Default is 'Integer.MAX'.

getErrorMaxSize

Integer getErrorMaxSize()

Set max size of error list in toString()

Returns:

Max size.

setResultFilter

void setResultFilter(IResultFilter resultFilter)

Set result filter.

Parameters:

resultFilter - A filter.

getResultFilter

IResultFilter getResultFilter()

Return the filter.

Returns:

The result filter.

setRecordSuccess

void setRecordSuccess(Boolean recordSuccess)

Setting to record success action in result set.

Parameters:

recordSuccess - The record success.

getRecordSuccess

Boolean getRecordSuccess()

Flag to record status which isError returns true. Default is true.

Returns:

true, if record success flag is enabled, false, to record only error status.

setMessages

void setMessages(String[] expected)

Set expected messages.

Parameters:

expected - Expected messages.

getMessages

String[] getMessages()

Get the expected messages.

Returns:

The messages.

setSorted

void setSorted(Boolean sorted)

Set expected order of messages.

Parameters:

sorted - true, if expected messages must obey the specification order, false, otherwise. Default might be false.

getSorted

Boolean getSorted()

Get the sort flag.

Returns:

true, of order required, false, otherwise.

getCriteria

IStringTest getCriteria()

String comparison criteria for messages.

Returns:

Criteria.

setCriteria

void setCriteria(IStringTest criteria)

Set a string comparison criteria for messages.

Parameters:

criteria - A criteria.

consolidate

void consolidate(IContext context)

Consolidate expectations and received errors.

Parameters:

context - The context.

availableStatus

<T extends Status> List<T> availableStatus()

Lists status in result.

Type Parameters:

T - A subclass of Status.

Returns:

An iterator of status.

errorStatus

<T extends Status> List<T> errorStatus()

Lists error status in result.

Type Parameters:

T - A subclass of Status.

Returns:

An iterator of status of type error in result.

filterByStatus

<T extends Status> List<IResult> filterByStatus(T... status)

Filters result by status type.

Type Parameters:

T - A subclass of Status.

Parameters:

status - The filters.

Returns:

The subset of status.

filterByStatus

<T extends Status> List<IResult> filterByStatus(int start,
                                              int end,
                                              T... status)

Filters result by status type.

Type Parameters:

T - A subtype of Status.

Parameters:

start - Range start.

end - Range end.

status - The filters.

Returns:

The subset of status.

filterByStatus

<T extends Status> List<IResult> filterByStatus(List<IResult> subset,
                                              T... status)

Filters result by status type.

Type Parameters:

T - A subtype of Status.

Parameters:

subset - Subset list.

status - The filters.

Returns:

The subset of status.

countErrors

int countErrors()

Return number of errors.

Returns:

The errors number.

countErrors

int countErrors(int start)

Return number of errors.

Parameters:

start - Start index.

Returns:

The errors number starting from a index position.

countStatus

<T extends Status> int countStatus(T... status)

Counts the status of a given type.

Type Parameters:

T - A subtype of Status.

Parameters:

status - The filters.

Returns:

The number of result.

countStatus

<T extends Status> int countStatus(int start,
                                 int end,
                                 T... status)

Counts the status of a given type.

Type Parameters:

T - A status class.

Parameters:

start - Range start.

end - Range end.

status - The filters.

Returns:

The number of result.

countStatus

<T extends Status> int countStatus(List<IResult> subset,
                                 T... status)

Counts the status of a given type.

Type Parameters:

T - A status class.

Parameters:

subset - A subset list.

status - The filters.

Returns:

The number of result.

actionTypes

List<ActionType> actionTypes()

List action types available for all results.

Returns:

The list of types.

actionTypes

List<ActionType> actionTypes(List<IResult> subset)

List action types available for the result subset.

Parameters:

subset - Subset to be analyzed.

Returns:

The list of types.

filterByType

List<IResult> filterByType(ActionType... actionType)

Filter the result itself by ActionType.

Parameters:

actionType - The action types.

Returns:

The filtered subset.

filterByType

List<IResult> filterByType(List<IResult> subset,
                         ActionType... actionType)

Filter the subset by ActionType.

Parameters:

subset - The subset to be filtered.

actionType - The action types.

Returns:

The filtered subset.

countType

int countType(ActionType... actionType)

Count results of a given set of action types.

Parameters:

actionType - The action types.

Returns:

The size of the filtered set.

countType

int countType(List<IResult> subset,
            ActionType... actionType)

Count results of a given type in a list.

Parameters:

subset - A subset of results.

actionType - The action types.

Returns:

The size of the filtered set.

addResult

IResult addResult(Status status,
                IBlock source)

Add a result.

Parameters:

status - The status.

source - The source block.

Returns:

The result.

addResult

IResult addResult(Status status,
                IBlock source,
                IWritable writable)

Adds a result.

Parameters:

status - The status.

source - The source block.

writable - A writable information.

Returns:

The result.

addResult

IResult addResult(Status status,
                IBlock source,
                String message)

Adds a result with a message.

Parameters:

status - The status.

source - The source block.

message - The message.

Returns:

The result.

addResult

IResult addResult(Status status,
                IBlock source,
                String message,
                IWritable writable)

Adds a result with a message and a writable information.

Parameters:

status - The status.

source - The source block.

message - The message.

writable - The extra information.

Returns:

The result.

addResult

IResult addResult(Status status,
                IBlock source,
                Throwable failure)

Adds a result with failure information.

Parameters:

status - The status.

source - The source block.

failure - The failure.

Returns:

The result.

addResult

IResult addResult(Status status,
                IBlock source,
                Throwable failure,
                IWritable writable)

Adds a result with failure and a writable information.

Parameters:

status - The status.

source - The source block.

failure - The failure.

writable - The extra information.

Returns:

The result.

subSet

IResultSet subSet(int start,
                int end)

Get a subset of result as a result set itself.

Parameters:

start - The start index.

end - The end index.

Returns:

The corresponding subset.