Package net.solarnetwork.service

Class PingTestResult

java.lang.Object

net.solarnetwork.service.PingTestResult

All Implemented Interfaces:

PingTest.Result

Direct Known Subclasses:

PingTestResultDisplay

public class PingTestResult
extends Object
implements PingTest.Result

A results object for a single PingTest result.

Since:

1.52

Version:

1.0

Author:

matt

Constructor Summary

Constructors

Constructor	Description
PingTestResult(boolean success, String message)	Construct with status flag and message.
PingTestResult(boolean success, String message, Map<String,?> properties)	Construct values.

Method Summary

Modifier and Type	Method	Description
String	getMessage()	Get a descriptive message
Map<String,?>	getProperties()	Get optional properties related to the test.
boolean	isSuccess()	Test if the test was successful.

Methods inherited from class java.lang.Object

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

Constructor Details

PingTestResult

public PingTestResult(boolean success,
 String message,
 Map<String,?> properties)

Construct values.

Parameters:

success - The success flag.

message - The message.

properties - Optional properties.

PingTestResult

public PingTestResult(boolean success,
 String message)

Construct with status flag and message.

Parameters:

success - The success flag.

message - The message.

Method Details

getMessage

public String getMessage()

Description copied from interface: PingTest.Result

Get a descriptive message

Specified by:

getMessage in interface PingTest.Result

Returns:

the message

isSuccess

public boolean isSuccess()

Description copied from interface: PingTest.Result

Test if the test was successful.

Specified by:

isSuccess in interface PingTest.Result

Returns:

true if the test is successful (passed), false otherwise

getProperties

public Map<String,?> getProperties()

Description copied from interface: PingTest.Result

Get optional properties related to the test.

Specified by:

getProperties in interface PingTest.Result

Returns:

optional test properties