org.jmythapi.protocol.events.impl
Class DownloadFileFinished

java.lang.Object
  org.jmythapi.impl.AData<E>
      org.jmythapi.protocol.response.impl.AMythResponse<E>
          org.jmythapi.protocol.events.impl.AMythEvent<IDownloadFileFinished.Props>
              org.jmythapi.protocol.events.impl.DownloadFileFinished

All Implemented Interfaces:

Cloneable, IPropertyAware<IDownloadFileFinished.Props>, IVersionable, IDownloadFile<IDownloadFileFinished.Props>, IDownloadFileFinished, IMythEvent<IDownloadFileFinished.Props>, ISendable, IMythResponse<IDownloadFileFinished.Props>

public class DownloadFileFinished
extends AMythEvent<IDownloadFileFinished.Props>
implements IDownloadFileFinished

Nested Class Summary

Nested classes/interfaces inherited from interface org.jmythapi.protocol.events.IDownloadFileFinished

IDownloadFileFinished.Props

Field Summary

Fields inherited from class org.jmythapi.impl.AData

logger, propsClass, protoVersion, respArgs

Constructor Summary

DownloadFileFinished(ProtocolVersion protoVersion, List<String> eventArguments)

Method Summary

Long	getBytesTotal() Gets the total size of the file in bytes.
Integer	getErrorCode() Gets a error code to describe a download error.
String	getErrorText() Gets a text to describe a download error.
URI	getLocalURI() Gets the URI to the local copy of the remote file, stored into a backend storage-group
Float	getReceivedPercent() Returns how many percent of the remote file were downloaded so far.
URI	getRemoteURI() Gets the URI to the remote file, which is downloaded by the backend.

Methods inherited from class org.jmythapi.protocol.events.impl.AMythEvent

decodeProperty, encodeProperty, extractArgumentsList, extractEventName, getEventName, getPacket, toString

Methods inherited from class org.jmythapi.protocol.response.impl.AMythResponse

checkSize, getExpectedSize, getProperties, getProperty, getPropertyIndex

Methods inherited from class org.jmythapi.impl.AData

clone, equals, getPropertyClass, getPropertyCount, getPropertyMap, getPropertyValue, getPropertyValue, getPropertyValueObject, getPropertyValueObject, getPropertyValues, getVersionNr, hashCode, init, postProcessArguments, setPropertyValue, setPropertyValue, setPropertyValueObject

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.jmythapi.protocol.events.IMythEvent

getEventName

Methods inherited from interface org.jmythapi.IPropertyAware

getProperties, getProperty, getPropertyClass, getPropertyCount, getPropertyIndex, getPropertyMap, getPropertyValue, getPropertyValue, getPropertyValueObject, getPropertyValues, setPropertyValue, setPropertyValue, setPropertyValueObject

Methods inherited from interface org.jmythapi.IVersionable

getVersionNr

Methods inherited from interface org.jmythapi.protocol.ISendable

getPacket

Constructor Detail

DownloadFileFinished

public DownloadFileFinished(ProtocolVersion protoVersion,
                            List<String> eventArguments)

Method Detail

getBytesTotal

public Long getBytesTotal()

Description copied from interface: IDownloadFile

Gets the total size of the file in bytes.

Specified by:

getBytesTotal in interface IDownloadFile<IDownloadFileFinished.Props>

Returns:

the total size of the file in bytes

getReceivedPercent

public Float getReceivedPercent()

Description copied from interface: IDownloadFile

Returns how many percent of the remote file were downloaded so far.

Specified by:

getReceivedPercent in interface IDownloadFile<IDownloadFileFinished.Props>

Returns:

how many percent of the file were downloaded so far.

getLocalURI

public URI getLocalURI()

Description copied from interface: IDownloadFile

Gets the URI to the local copy of the remote file, stored into a backend storage-group

Specified by:

getLocalURI in interface IDownloadFile<IDownloadFileFinished.Props>

Returns:

the URI of the local file stored in a storage group

getRemoteURI

public URI getRemoteURI()

Description copied from interface: IDownloadFile

Gets the URI to the remote file, which is downloaded by the backend.

Specified by:

getRemoteURI in interface IDownloadFile<IDownloadFileFinished.Props>

Returns:

the URI of a remote file

getErrorCode

public Integer getErrorCode()

Description copied from interface: IDownloadFileFinished

Gets a error code to describe a download error.

Specified by:

getErrorCode in interface IDownloadFileFinished

Returns:

an error code

getErrorText

public String getErrorText()

Description copied from interface: IDownloadFileFinished

Gets a text to describe a download error.

Specified by:

getErrorText in interface IDownloadFileFinished

Returns:

an error text