com.jayway.android.robotium.remotecontrol.solo

Class RemoteResults

java.lang.Object

com.jayway.android.robotium.remotecontrol.solo.RemoteResults

public class RemoteResults
extends java.lang.Object

Parses a SoloRemoteControl results Properties object into useful primitives.

Author:

Carl Nagle

Constructor Summary

Constructors

Constructor and Description
RemoteResults(java.util.Properties resultProperties) Instantiate a RemoteResults Properties object and parse the known values from the Properties into useful primitive methods.

Method Summary

Modifier and Type	Method and Description
boolean	getBoolean(java.lang.String item) Retrieve an expected boolean value from the results.
boolean	getBoolean(java.lang.String item, boolean defaultValue) Retrieve an expected boolean value from the results or a defaultValue if the item is not found.
java.lang.String	getErrorMessage()
int	getInt(java.lang.String item) Retrieve an expected int value from the results.
int	getInt(java.lang.String item, int defaultValue) Retrieve an expected int value from the results or a defaultValue if the item was not found.
java.util.Properties	getResultsProperties()
int	getStatusCode()
java.lang.String	getStatusInfo()
java.lang.String	getString(java.lang.String item) Retrieves an item out of the results.
java.lang.String	getString(java.lang.String item, java.lang.String defaultValue) Retrieves an item out of the results or a defaultValue if the item was not found.
boolean	hasItem(java.lang.String key)
boolean	isRemoteResult()

Methods inherited from class java.lang.Object

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

Constructor Detail

RemoteResults

public RemoteResults(java.util.Properties resultProperties)

Instantiate a RemoteResults Properties object and parse the known values from the Properties into useful primitive methods.

Parameters:

resultProperties -

Method Detail

getResultsProperties

public java.util.Properties getResultsProperties()

Returns:

the original Properties used when created, if any.

isRemoteResult

public boolean isRemoteResult()

Returns:

true if the parsed results set this to true.

getStatusCode

public int getStatusCode()

Returns:

the statusCode parsed from the results.

getStatusInfo

public java.lang.String getStatusInfo()

Returns:

the statusInfo parsed from the results, if any. Can be null.

getErrorMessage

public java.lang.String getErrorMessage()

Returns:

the errorMessage parsed from the results, if any. Can be null.

hasItem

public boolean hasItem(java.lang.String key)

Returns:

true if the wrapped result contains a value for the provided key.

getString

public java.lang.String getString(java.lang.String item)

Retrieves an item out of the results.

Parameters:

key - name of the item in the results to retrieve. This is case-sensitive. Subclasses could override this method to make item names insensitive to case.

Returns:

the item as stored in the results.

Throws:

java.lang.RuntimeException - if the item does not exist in the results.

getString

public java.lang.String getString(java.lang.String item,
                                  java.lang.String defaultValue)

Retrieves an item out of the results or a defaultValue if the item was not found.

Parameters:

key - name of the item in the results to retrieve. This is case-sensitive. Subclasses could override this method to make item names insensitive to case.

defaultValue - to return if the sought item is not in the result.

Returns:

the item as stored in the results, or the default if results does not contain the item.

getInt

public int getInt(java.lang.String item)

Retrieve an expected int value from the results.

Parameters:

item - Key or Parameter name expected to be stored in the results.

Returns:

the int value of a results item expected to be an integer.

Throws:

java.lang.NumberFormatException - if the requested item is not a parsable integer.

java.lang.RuntimeException - if the requested item does not exist in the results.

See Also:

Integer.parseInt(String)

getInt

public int getInt(java.lang.String item,
                  int defaultValue)

Retrieve an expected int value from the results or a defaultValue if the item was not found.

Parameters:

item - Key or Parameter name expected to be stored in the results.

defaultValue - to return if the sought item is not in the result.

Returns:

the int value of a results item expected to be an integer, or the defaultValue.

getBoolean

public boolean getBoolean(java.lang.String item)

Retrieve an expected boolean value from the results.

Parameters:

item - Key or Parameter name expected to be stored in the results.

Returns:

true if the requested item exists and the Boolean class recognizes the value as equivalent to boolean true. Otherwise, returns false.

Throws:

java.lang.RuntimeException - if the requested item does not exist in the results.

See Also:

Boolean.parseBoolean(String)

getBoolean

public boolean getBoolean(java.lang.String item,
                          boolean defaultValue)

Retrieve an expected boolean value from the results or a defaultValue if the item is not found.

Parameters:

item - Key or Parameter name expected to be stored in the results.

defaultValue - to return if the sought item is not in the result.

Returns:

true if the requested item exists and the Boolean class recognizes the value as equivalent to boolean true. Otherwise, returns false.

See Also:

Boolean.parseBoolean(String)