com.ibm.are.plugin
Class ResultInfo
java.lang.Object
com.ibm.are.plugin.ResultInfo
- Direct Known Subclasses:
- ExtendedResultInfo
public class ResultInfo
- extends java.lang.Object
The ResultInfo
class is used to communicate the result status of running a plugin. The only
status that can be communicated via this plugin is a boolean one: either true or false. If a more
complex status needs to be communicated, consider using the ExtendedResultInfo
class.
By convention, a plugin should return a result info status of true even if problems were detected during
its verification. A result status of false should only be used if the plugin was not able to perform its
verification due to an unexpected condition or exception.
- Version:
- 1.0
- Author:
- IBM
Field Summary |
static java.lang.String |
COPYRIGHT
Copyright for class bytecode |
Constructor Summary |
ResultInfo(boolean success)
Constructs a new ResultInfo object with the specified result status |
Method Summary |
boolean |
isSuccessful()
Whether or not the plugin completed successfully |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
COPYRIGHT
public static final java.lang.String COPYRIGHT
- Copyright for class bytecode
- See Also:
- Constant Field Values
ResultInfo
public ResultInfo(boolean success)
- Constructs a new
ResultInfo
object with the specified result status
- Parameters:
success
- Whether or not the plugin completed successfully
isSuccessful
public boolean isSuccessful()
- Whether or not the plugin completed successfully
- Returns:
- true if the plugin completed successfully, false if it did not