nl.lxtreme.ols.api.acquisition
Class AcquisitionResultStatus

java.lang.Object
  extended by nl.lxtreme.ols.api.acquisition.AcquisitionResultStatus

public final class AcquisitionResultStatus
extends Object

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

AcquisitionResultStatus

public AcquisitionResultStatus(AcquisitionResultStatus.ResultStatus aStatus)
Creates a new AcquisitionResultStatus instance.

Parameters:
aStatus - the status of the acquisition result, cannot be null.

AcquisitionResultStatus

public AcquisitionResultStatus(AcquisitionResultStatus.ResultStatus aStatus,
                               String aMessage)
Creates a new AcquisitionResultStatus instance.

Parameters:
aStatus - the status of the acquisition result, cannot be null;
aMessage - the message of the acquisition result, may be null.
Method Detail

create

public static AcquisitionResultStatus create(Throwable aThrowable)
Creates an AcquisitionResultStatus instance for the given exception with the status FAILED.

Parameters:
aThrowable - the exception to create a AcquisitionResultStatus for, cannot be null.
Returns:
a new instance of AcquisitionResultStatus, never null.

equals

public boolean equals(Object aObject)

Overrides:
equals in class Object

getMessage

public String getMessage()
Returns an optional status message, for example, containing details about why an acquisition failed.

Returns:
a status message, can be null.

getStatus

public AcquisitionResultStatus.ResultStatus getStatus()
Returns the status of the acquisition.

Returns:
a status, never null.

hashCode

public int hashCode()

Overrides:
hashCode in class Object

isAborted

public boolean isAborted()
Returns whether the status of this AcquisitionResultStatus is aborted.

Returns:
true if this AcquisitionResultStatus has the status aborted, false otherwise.

isCompletedNormally

public boolean isCompletedNormally()
Returns whether the status of this AcquisitionResultStatus is normal.

Returns:
true if this AcquisitionResultStatus has the status normal, false otherwise.

isFailed

public boolean isFailed()
Returns whether the status of this AcquisitionResultStatus is failed.

Returns:
true if this AcquisitionResultStatus has the status failed, false otherwise.


Copyright © 2012 L'Xtreme IT consultancy. All Rights Reserved.