org.jivesoftware.smackx.filetransfer
Enum FileTransfer.Status

java.lang.Object
  java.lang.Enum<FileTransfer.Status>
      org.jivesoftware.smackx.filetransfer.FileTransfer.Status

All Implemented Interfaces:

Serializable, Comparable<FileTransfer.Status>

Enclosing class:

FileTransfer

public static enum FileTransfer.Status
extends Enum<FileTransfer.Status>

A class to represent the current status of the file transfer.

Author:

Alexander Wenckus

Enum Constant Summary

cancelled
The file transfer was canceled

complete
The transfer has completed successfully.

error
An error occured during the transfer.

in_progress
The transfer is in progress.

initial
The initial status of the file transfer.

negotiated
After the stream negotitation has completed the intermediate state between the time when the negotiation is finished and the actual transfer begins.

negotiating_stream
The stream to transfer the file is being negotiated over the chosen stream type.

negotiating_transfer
The file transfer is being negotiated with the peer.

refused
The peer has refused the file transfer request halting the file transfer negotiation process.

Method Summary

String	toString()
static FileTransfer.Status	valueOf(String name) Returns the enum constant of this type with the specified name.
static FileTransfer.Status[]	values() Returns an array containing the constants of this enum type, in the order they're declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

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

Enum Constant Detail

error

public static final FileTransfer.Status error

An error occured during the transfer.

See Also:

FileTransfer.getError()

initial

public static final FileTransfer.Status initial

The initial status of the file transfer.

negotiating_transfer

public static final FileTransfer.Status negotiating_transfer

The file transfer is being negotiated with the peer. The party recieving the file has the option to accept or refuse a file transfer request. If they accept, then the process of stream negotiation will begin. If they refuse the file will not be transfered.

See Also:

negotiating_stream

refused

public static final FileTransfer.Status refused

The peer has refused the file transfer request halting the file transfer negotiation process.

negotiating_stream

public static final FileTransfer.Status negotiating_stream

The stream to transfer the file is being negotiated over the chosen stream type. After the stream negotiating process is complete the status becomes negotiated.

See Also:

negotiated

negotiated

public static final FileTransfer.Status negotiated

After the stream negotitation has completed the intermediate state between the time when the negotiation is finished and the actual transfer begins.

in_progress

public static final FileTransfer.Status in_progress

The transfer is in progress.

See Also:

FileTransfer.getProgress()

complete

public static final FileTransfer.Status complete

The transfer has completed successfully.

cancelled

public static final FileTransfer.Status cancelled

The file transfer was canceled

Method Detail

values

public static final FileTransfer.Status[] values()

Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants as follows:

for(FileTransfer.Status c : FileTransfer.Status.values())
        System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they're declared

valueOf

public static FileTransfer.Status valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

toString

public String toString()

Overrides:

toString in class Enum<FileTransfer.Status>