Package org.jivesoftware.smackx.filetransfer

Enum FileTransfer.Status

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<FileTransfer.Status>
    Enclosing class:
    FileTransfer
    public static enum FileTransfer.Status
extends java.lang.Enum<FileTransfer.Status>
    A class to represent the current status of the file transfer.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      cancelled
      The file transfer was cancelled.
      complete
      The transfer has completed successfully.
      error
      An error occurred during the transfer.
      in_progress
      The transfer is in progress.
      initial
      The initial status of the file transfer.
      negotiated
      After the stream negotiation 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

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String toString()  
      static FileTransfer.Status valueOf​(java.lang.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 are declared.

      • Methods inherited from class java.lang.Enum

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

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • 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 Receiving 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 transferred.
        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 negotiation has completed the intermediate state between the time when the negotiation is finished and the actual transfer begins.

      • complete

        public static final FileTransfer.Status complete
        The transfer has completed successfully.

      • cancelled

        public static final FileTransfer.Status cancelled
        The file transfer was cancelled.

    • Method Detail

      • values

        public static FileTransfer.Status[] values()
        Returns an array containing the constants of this enum type, in the order they are 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 are declared

      • valueOf

        public static FileTransfer.Status valueOf​(java.lang.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:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Enum<FileTransfer.Status>