rocks.xmpp.extensions.si.profile.filetransfer.model

Class SIFileTransferOffer

java.lang.Object

rocks.xmpp.extensions.si.profile.filetransfer.model.SIFileTransferOffer

All Implemented Interfaces:

FileTransferOffer

public final class SIFileTransferOffer
extends java.lang.Object
implements FileTransferOffer

The implementation of the file transfer profile, i.e. the <file/> element.

This class is immutable.

See Also:

XEP-0096: SI File Transfer, XML Schema

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SIFileTransferOffer.SIRange Allows to do ranged transfers.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAMESPACE http://jabber.org/protocol/si/profile/file-transfer

Constructor Summary

Constructors

Constructor and Description
SIFileTransferOffer(java.lang.String name, long size)
SIFileTransferOffer(java.lang.String name, long size, java.time.Instant lastModified, java.lang.String hash, java.lang.String description, SIFileTransferOffer.SIRange range)

Method Summary

Modifier and Type	Method and Description
java.time.Instant	getDate() Gets the last modification time of the file.
java.lang.String	getDescription() Gets a sender-generated description of the file.
java.util.List<Hash>	getHashes() Gets the MD5 sum of the file contents.
java.lang.String	getName() Gets the name of the file that the Sender wishes to send.
Range	getRange() Gets the range.
long	getSize() Gets the size, in bytes, of the data to be sent.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NAMESPACE

public static final java.lang.String NAMESPACE

http://jabber.org/protocol/si/profile/file-transfer

See Also:

Constant Field Values

Constructor Detail

SIFileTransferOffer

public SIFileTransferOffer(java.lang.String name,
                           long size)

SIFileTransferOffer

public SIFileTransferOffer(java.lang.String name,
                           long size,
                           java.time.Instant lastModified,
                           java.lang.String hash,
                           java.lang.String description,
                           SIFileTransferOffer.SIRange range)

Method Detail

getSize

public final long getSize()

Gets the size, in bytes, of the data to be sent.

Specified by:

getSize in interface FileTransferOffer

Returns:

The size.

getName

public final java.lang.String getName()

Gets the name of the file that the Sender wishes to send.

Specified by:

getName in interface FileTransferOffer

Returns:

The file name.

getDate

public final java.time.Instant getDate()

Gets the last modification time of the file.

Specified by:

getDate in interface FileTransferOffer

Returns:

The date.

getHashes

public final java.util.List<Hash> getHashes()

Gets the MD5 sum of the file contents.

Specified by:

getHashes in interface FileTransferOffer

Returns:

The MD5 sum.

getDescription

public final java.lang.String getDescription()

Gets a sender-generated description of the file.

Specified by:

getDescription in interface FileTransferOffer

Returns:

The description.

getRange

public final Range getRange()

Gets the range.

Specified by:

getRange in interface FileTransferOffer

Returns:

The range.