com.exalead.mercury.mami.connect.v10

Class ScanStatus

java.lang.Object

com.exalead.mercury.mami.connect.v10.ScanStatus

All Implemented Interfaces:

com.exalead.util.Checkable, java.io.Serializable

public class ScanStatus
extends java.lang.Object
implements com.exalead.util.Checkable, java.io.Serializable

Status of a scan or session

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ScanStatus.SpecificMeasures

Field Summary

Fields

Modifier and Type	Field and Description
boolean	aborted
static boolean	DEFAULT_ABORTED
long	deletedObjects
long	endTime
java.lang.String	exception
java.lang.String	progress
long	pushedObjects
java.lang.String	result
long	scannedObjects
long	scanRetries
protected ScanStatus.SpecificMeasures	specificMeasures
long	startTime
long	time

Constructor Summary

Constructors

Constructor and Description
ScanStatus()
ScanStatus(ScanStatus o) Copy constructor

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this ScanStatus.
static ScanStatus	fromString(java.lang.String s) String representation of this ScanStatus.
long	getDeletedObjects()
long	getEndTime() Stop timestamp in ms since Epoch.
java.lang.String	getException() Trace of uncaught exception thrown by the scan, if any
java.lang.String	getProgress() If the scan is running, progress message
long	getPushedObjects()
java.lang.String	getResult() Applicative result for this scan
long	getScannedObjects()
long	getScanRetries()
ScanStatus.SpecificMeasures	getSpecificMeasures()
long	getStartTime() Start timestamp in ms since Epoch
long	getTime() Scan running time in ms
boolean	isAborted() Was this scan aborted before completion?
ScanStatus	makeCopy() Creates and returns a deep copy of this ScanStatus.
static ScanStatus	readFrom(java.io.InputStream is) Read this ScanStatus from an XML fragment.
void	setAborted(boolean aborted) Was this scan aborted before completion?
void	setDeletedObjects(long deletedObjects)
void	setEndTime(long endTime) Stop timestamp in ms since Epoch.
void	setException(java.lang.String exception) Trace of uncaught exception thrown by the scan, if any
void	setProgress(java.lang.String progress) If the scan is running, progress message
void	setPushedObjects(long pushedObjects)
void	setResult(java.lang.String result) Applicative result for this scan
void	setScannedObjects(long scannedObjects)
void	setScanRetries(long scanRetries)
void	setSpecificMeasures(ScanStatus.SpecificMeasures __value)
void	setStartTime(long startTime) Start timestamp in ms since Epoch
void	setTime(long time) Scan running time in ms
java.lang.String	toString() String representation of this ScanStatus.
ScanStatus	withAborted(boolean aborted)
ScanStatus	withAborted(java.lang.Boolean aborted)
ScanStatus	withDeletedObjects(long deletedObjects)
ScanStatus	withDeletedObjects(java.lang.Long deletedObjects)
ScanStatus	withEndTime(long endTime)
ScanStatus	withEndTime(java.lang.Long endTime)
ScanStatus	withException(java.lang.String exception)
ScanStatus	withProgress(java.lang.String progress)
ScanStatus	withPushedObjects(long pushedObjects)
ScanStatus	withPushedObjects(java.lang.Long pushedObjects)
ScanStatus	withResult(java.lang.String result)
ScanStatus	withScannedObjects(long scannedObjects)
ScanStatus	withScannedObjects(java.lang.Long scannedObjects)
ScanStatus	withScanRetries(long scanRetries)
ScanStatus	withScanRetries(java.lang.Long scanRetries)
ScanStatus	withSpecificMeasures(java.util.Collection<KeyValue> __values)
ScanStatus	withSpecificMeasures(KeyValue... __values)
ScanStatus	withSpecificMeasures(ScanStatus.SpecificMeasures __value)
ScanStatus	withStartTime(long startTime)
ScanStatus	withStartTime(java.lang.Long startTime)
ScanStatus	withTime(long time)
ScanStatus	withTime(java.lang.Long time)
void	writeTo(java.io.OutputStream os) Write this ScanStatus as an XML fragment

Methods inherited from class java.lang.Object

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

Field Detail

aborted

public boolean aborted

DEFAULT_ABORTED

public static final boolean DEFAULT_ABORTED

See Also:

Constant Field Values

result

public java.lang.String result

exception

public java.lang.String exception

time

public long time

startTime

public long startTime

endTime

public long endTime

progress

public java.lang.String progress

scannedObjects

public long scannedObjects

pushedObjects

public long pushedObjects

deletedObjects

public long deletedObjects

scanRetries

public long scanRetries

specificMeasures

protected ScanStatus.SpecificMeasures specificMeasures

Constructor Detail

ScanStatus

public ScanStatus()

ScanStatus

public ScanStatus(ScanStatus o)

Copy constructor

Method Detail

setAborted

public void setAborted(boolean aborted)

Was this scan aborted before completion?

isAborted

public boolean isAborted()

Was this scan aborted before completion?

withAborted

public ScanStatus withAborted(boolean aborted)

withAborted

public ScanStatus withAborted(java.lang.Boolean aborted)

setResult

public void setResult(java.lang.String result)

Applicative result for this scan

getResult

public java.lang.String getResult()

Applicative result for this scan

withResult

public ScanStatus withResult(java.lang.String result)

setException

public void setException(java.lang.String exception)

Trace of uncaught exception thrown by the scan, if any

getException

public java.lang.String getException()

Trace of uncaught exception thrown by the scan, if any

withException

public ScanStatus withException(java.lang.String exception)

setTime

public void setTime(long time)

Scan running time in ms

getTime

public long getTime()

Scan running time in ms

withTime

public ScanStatus withTime(long time)

withTime

public ScanStatus withTime(java.lang.Long time)

setStartTime

public void setStartTime(long startTime)

Start timestamp in ms since Epoch

getStartTime

public long getStartTime()

Start timestamp in ms since Epoch

withStartTime

public ScanStatus withStartTime(long startTime)

withStartTime

public ScanStatus withStartTime(java.lang.Long startTime)

setEndTime

public void setEndTime(long endTime)

Stop timestamp in ms since Epoch. 0 if scan is not finished.

getEndTime

public long getEndTime()

Stop timestamp in ms since Epoch. 0 if scan is not finished.

withEndTime

public ScanStatus withEndTime(long endTime)

withEndTime

public ScanStatus withEndTime(java.lang.Long endTime)

setProgress

public void setProgress(java.lang.String progress)

If the scan is running, progress message

getProgress

public java.lang.String getProgress()

If the scan is running, progress message

withProgress

public ScanStatus withProgress(java.lang.String progress)

setScannedObjects

public void setScannedObjects(long scannedObjects)

getScannedObjects

public long getScannedObjects()

withScannedObjects

public ScanStatus withScannedObjects(long scannedObjects)

withScannedObjects

public ScanStatus withScannedObjects(java.lang.Long scannedObjects)

setPushedObjects

public void setPushedObjects(long pushedObjects)

getPushedObjects

public long getPushedObjects()

withPushedObjects

public ScanStatus withPushedObjects(long pushedObjects)

withPushedObjects

public ScanStatus withPushedObjects(java.lang.Long pushedObjects)

setDeletedObjects

public void setDeletedObjects(long deletedObjects)

getDeletedObjects

public long getDeletedObjects()

withDeletedObjects

public ScanStatus withDeletedObjects(long deletedObjects)

withDeletedObjects

public ScanStatus withDeletedObjects(java.lang.Long deletedObjects)

setScanRetries

public void setScanRetries(long scanRetries)

getScanRetries

public long getScanRetries()

withScanRetries

public ScanStatus withScanRetries(long scanRetries)

withScanRetries

public ScanStatus withScanRetries(java.lang.Long scanRetries)

getSpecificMeasures

public ScanStatus.SpecificMeasures getSpecificMeasures()

setSpecificMeasures

public void setSpecificMeasures(ScanStatus.SpecificMeasures __value)

withSpecificMeasures

public ScanStatus withSpecificMeasures(KeyValue... __values)

withSpecificMeasures

public ScanStatus withSpecificMeasures(java.util.Collection<KeyValue> __values)

withSpecificMeasures

public ScanStatus withSpecificMeasures(ScanStatus.SpecificMeasures __value)

makeCopy

public ScanStatus makeCopy()

Creates and returns a deep copy of this ScanStatus.

readFrom

public static ScanStatus readFrom(java.io.InputStream is)
                           throws javax.xml.bind.JAXBException

Read this ScanStatus from an XML fragment.

Throws:

javax.xml.bind.JAXBException

writeTo

public void writeTo(java.io.OutputStream os)
             throws javax.xml.bind.JAXBException,
                    java.io.IOException

Write this ScanStatus as an XML fragment

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

public static ScanStatus fromString(java.lang.String s)
                             throws javax.xml.bind.JAXBException,
                                    java.io.UnsupportedEncodingException

String representation of this ScanStatus.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this ScanStatus.

Overrides:

toString in class java.lang.Object

check

public void check(boolean deep,
                  java.lang.String errorContext)
           throws com.exalead.util.TypedException

Checks this ScanStatus.

Specified by:

check in interface com.exalead.util.Checkable

Throws:

com.exalead.util.TypedException