public final class AcquisitionResultStatus extends Object
Modifier and Type | Class and Description |
---|---|
static class |
AcquisitionResultStatus.ResultStatus
Denotes the how the acquisition ended.
|
Constructor and Description |
---|
AcquisitionResultStatus(AcquisitionResultStatus.ResultStatus aStatus)
Creates a new AcquisitionResultStatus instance.
|
AcquisitionResultStatus(AcquisitionResultStatus.ResultStatus aStatus,
String aMessage)
Creates a new AcquisitionResultStatus instance.
|
Modifier and Type | Method and Description |
---|---|
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. |
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
.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 String getMessage()
null
.public AcquisitionResultStatus.ResultStatus getStatus()
null
.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.Copyright © 2015 L'Xtreme IT consultancy. All rights reserved.