Package jp.vmi.selenium.selenese.result

Class Result

java.lang.Object

jp.vmi.selenium.selenese.result.Result

All Implemented Interfaces:

Comparable<Result>

Direct Known Subclasses:

Error, Failure, MaxTimeExceeded, Success, Unexecuted, Warning

public abstract class Result
extends Object
implements Comparable<Result>

Result of command execution.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Result.Level	Result Level.

Constructor Summary

Constructors

Modifier	Constructor	Description
	Result(String message)	Constructor.
	Result(String prefix, Exception e)	Constructor.
	Result(String prefix, String message)	Constructor.
	Result(String prefix, String message, Exception e)	Constructor.
protected	Result(Result childResult)

Method Summary

Modifier and Type	Method	Description
List<Map.Entry<Selenese,Result>>	collectChildResults(Selenese.Type type)	Collect child results specified Selenese.Type.
int	compareTo(Result result)
protected String	generateExceptionMessage(StringBuilder result, Exception e)	Generate exception message.
protected String	generateExceptionMessage(String prefix, Exception e)	Get exception message for result.
List<Map.Entry<Selenese,Result>>	getChildResults()	Get child results.
abstract Result.Level	getLevel()	Get result level.
String	getMessage()	Get result message.
boolean	isAborted()	Is command interrupted?
boolean	isFailed()	Is command failed?
boolean	isSuccess()	Is result of success?
protected Result	newUpdatedResult(Result targetResult)
String	toString()
Result	update(Result newResult)	Deprecated. use #updateWithChildResult(Selenese, Result) instead.
Result	updateWithChildResult(Selenese childSource, Result childResult)	Update total result with child result.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Result

public Result(String message)

Constructor.

Parameters:

message - result message.

Result

public Result(String prefix,
              String message)

Constructor.

Parameters:

prefix - prefix of message.

message - result massage.

Result

public Result(String prefix,
              Exception e)

Constructor.

Parameters:

prefix - prefix of message.

e - Exception.

Result

public Result(String prefix,
              String message,
              Exception e)

Constructor.

Parameters:

prefix - prefix of message.

message - result massage.

e - Exception.

Result

protected Result(Result childResult)

Method Detail

newUpdatedResult

protected Result newUpdatedResult(Result targetResult)

generateExceptionMessage

protected String generateExceptionMessage(String prefix,
                                          Exception e)

Get exception message for result.

Parameters:

prefix - prefix of message.

e - exception.

Returns:

message.

generateExceptionMessage

protected String generateExceptionMessage(StringBuilder result,
                                          Exception e)

Generate exception message.

Parameters:

result - message buffer.

e - exception.

Returns:

message.

getLevel

public abstract Result.Level getLevel()

Get result level.

Returns:

result level.

getMessage

public String getMessage()

Get result message.

Returns:

result message.

isSuccess

public boolean isSuccess()

Is result of success?

Returns:

true if this is Success.

isAborted

public boolean isAborted()

Is command interrupted?

Returns:

true if command is interrupted.

isFailed

public boolean isFailed()

Is command failed?

Returns:

true if command is failed.

update

@Deprecated
public Result update(Result newResult)

Deprecated.

use #updateWithChildResult(Selenese, Result) instead.

Update total result.

Parameters:

newResult - new result.

Returns:

updated total result.

updateWithChildResult

public Result updateWithChildResult(Selenese childSource,
                                    Result childResult)

Update total result with child result.

Parameters:

childSource - child result source.

childResult - child result.

Returns:

updated total result.

getChildResults

public List<Map.Entry<Selenese,Result>> getChildResults()

Get child results.

Returns:

child results.

collectChildResults

public List<Map.Entry<Selenese,Result>> collectChildResults(Selenese.Type type)

Collect child results specified Selenese.Type.

Parameters:

type - Selenese type.

Returns:

child results.

compareTo

public int compareTo(Result result)

Specified by:

compareTo in interface Comparable<Result>

toString

public String toString()

Overrides:

toString in class Object