|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectnl.lxtreme.ols.api.acquisition.AcquisitionResultStatus
public final class AcquisitionResultStatus
Denotes the status of an acquisition.
Nested Class Summary | |
---|---|
static class |
AcquisitionResultStatus.ResultStatus
Denotes the how the acquisition ended. |
Constructor Summary | |
---|---|
AcquisitionResultStatus(AcquisitionResultStatus.ResultStatus aStatus)
Creates a new AcquisitionResultStatus instance. |
|
AcquisitionResultStatus(AcquisitionResultStatus.ResultStatus aStatus,
String aMessage)
Creates a new AcquisitionResultStatus instance. |
Method Summary | |
---|---|
static AcquisitionResultStatus |
create(Throwable aThrowable)
Creates an AcquisitionResultStatus instance for the given exception
with the status FAILED. |
boolean |
equals(Object aObject)
|
String |
getMessage()
Returns an optional status message, for example, containing details about why an acquisition failed. |
AcquisitionResultStatus.ResultStatus |
getStatus()
Returns the status of the acquisition. |
int |
hashCode()
|
boolean |
isAborted()
Returns whether the status of this AcquisitionResultStatus is
aborted. |
boolean |
isCompletedNormally()
Returns whether the status of this AcquisitionResultStatus is
normal. |
boolean |
isFailed()
Returns whether the status of this AcquisitionResultStatus is
failed. |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public AcquisitionResultStatus(AcquisitionResultStatus.ResultStatus aStatus)
aStatus
- the status of the acquisition result, cannot be null
.public AcquisitionResultStatus(AcquisitionResultStatus.ResultStatus aStatus, String aMessage)
aStatus
- the status of the acquisition result, cannot be null
;aMessage
- the message of the acquisition result, may be null
.Method Detail |
---|
public static AcquisitionResultStatus create(Throwable aThrowable)
AcquisitionResultStatus
instance for the given exception
with the status FAILED.
aThrowable
- the exception to create a AcquisitionResultStatus
for,
cannot be null
.
AcquisitionResultStatus
, never
null
.public boolean equals(Object aObject)
equals
in class Object
public String getMessage()
null
.public AcquisitionResultStatus.ResultStatus getStatus()
null
.public int hashCode()
hashCode
in class Object
public boolean isAborted()
AcquisitionResultStatus
is
aborted.
true
if this AcquisitionResultStatus
has the
status aborted, false
otherwise.public boolean isCompletedNormally()
AcquisitionResultStatus
is
normal.
true
if this AcquisitionResultStatus
has the
status normal, false
otherwise.public boolean isFailed()
AcquisitionResultStatus
is
failed.
true
if this AcquisitionResultStatus
has the
status failed, false
otherwise.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |