AbstractTransfer (java-sdk 1.2.2-SNAPSHOT API)

java.lang.Object
- com.sinacloud.scs.services.scs.transfer.internal.AbstractTransfer

所有已实现的接口:

Transfer

直接已知子类:

DownloadImpl, MultipleFileTransfer, UploadImpl
```
public abstract class AbstractTransfer
extends Object
implements Transfer
```
Abstract transfer implementation.

嵌套类概要
- 从接口继承的嵌套类/接口 com.sinacloud.scs.services.scs.transfer.Transfer
  Transfer.TransferState

字段概要

字段
限定符和类型	字段和说明
`protected TransferMonitor`	`monitor`
`protected ProgressListenerChain`	`progressListenerChain` Hook for adding/removing more progress listeners.
`protected ProgressListenerCallbackExecutor`	`progressListenerChainCallbackExecutor` Listener call-back executor
`protected Transfer.TransferState`	`state` The current state of this transfer.
`protected Collection<TransferStateChangeListener>`	`stateChangeListeners` Collection of listeners to be notified for changes to the state of this transfer via setState()

方法概要

方法
限定符和类型	方法和说明
`void`	`addProgressListener(ProgressListener listener)` Adds the specified progress listener to the list of listeners receiving updates about this transfer's progress.
`void`	`addProgressListener(ProgressListener listener)` 已过时。 Replaced by `addProgressListener(ProgressListener)`
`void`	`addStateChangeListener(TransferStateChangeListener listener)` Adds the given state change listener to the collection of listeners.
`protected void`	`fireProgressEvent(int eventType)`
`String`	`getDescription()` Returns a human-readable description of this transfer.
`TransferMonitor`	`getMonitor()`
`TransferProgress`	`getProgress()` Returns progress information about this transfer.
`Transfer.TransferState`	`getState()` Returns the current state of this transfer.
`boolean`	`isDone()` Returns whether or not the transfer is finished (i.e. completed successfully, failed, or was canceled).
`void`	`notifyStateChangeListeners(Transfer.TransferState state)` Notifies all the registered state change listeners of the state update.
`void`	`removeProgressListener(ProgressListener listener)` Removes the specified progress listener from the list of progress listeners receiving updates about this transfer's progress.
`void`	`removeProgressListener(ProgressListener listener)` 已过时。 Replaced by `removeProgressListener(ProgressListener)`
`void`	`removeStateChangeListener(TransferStateChangeListener listener)` Removes the given state change listener from the collection of listeners.
`protected void`	`rethrowExecutionException(ExecutionException e)` Examines the cause of the specified ExecutionException and either rethrows it directly (if it's a type of SCSClientException) or wraps it in an SCSClientException and rethrows it.
`void`	`setMonitor(TransferMonitor monitor)` Sets the monitor used to poll for transfer completion.
`void`	`setState(Transfer.TransferState state)` Sets the current state of this transfer.
`protected SCSClientException`	`unwrapExecutionException(ExecutionException e)` Unwraps the root exception that caused the specified ExecutionException and returns it.
`void`	`waitForCompletion()` Waits for this transfer to complete.
`SCSClientException`	`waitForException()` Waits for this transfer to finish and returns any error that occurred, or returns `null` if no errors occurred.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - state
```
protected volatile Transfer.TransferState state
```
    The current state of this transfer.
  - monitor
```
protected TransferMonitor monitor
```
  - progressListenerChain
```
protected final ProgressListenerChain progressListenerChain
```
    Hook for adding/removing more progress listeners.
  - progressListenerChainCallbackExecutor
```
protected final ProgressListenerCallbackExecutor progressListenerChainCallbackExecutor
```
    Listener call-back executor
  - stateChangeListeners
```
protected final Collection<TransferStateChangeListener> stateChangeListeners
```
    Collection of listeners to be notified for changes to the state of this transfer via setState()
- 方法详细资料
  - isDone
```
public boolean isDone()
```
    Returns whether or not the transfer is finished (i.e. completed successfully, failed, or was canceled).
    
    指定者:
    
    isDone 在接口中 Transfer
    
    返回:
    Returns true if this transfer is finished (i.e. completed successfully, failed, or was canceled). Returns false if otherwise.
  - waitForCompletion
```
public void waitForCompletion()
                       throws SCSClientException,
                              SCSServiceException,
                              InterruptedException
```
    Waits for this transfer to complete. This is a blocking call; the current thread is suspended until this transfer completes.
    
    指定者:
    
    waitForCompletion 在接口中 Transfer
    
    抛出:
    
    SCSClientException - If any errors were encountered in the client while making the request or handling the response.
    
    SCSServiceException - If any errors occurred in Amazon S3 while processing the request.
    
    InterruptedException - If this thread is interrupted while waiting for the transfer to complete.
  - waitForException
```
public SCSClientException waitForException()
                                    throws InterruptedException
```
    Waits for this transfer to finish and returns any error that occurred, or returns null if no errors occurred. This is a blocking call; the current thread will be suspended until this transfer either fails or completes successfully.
    
    指定者:
    
    waitForException 在接口中 Transfer
    
    返回:
    Any error that occurred while processing this transfer. Otherwise returns null if no errors occurred.
    
    抛出:
    
    InterruptedException - If this thread is interrupted while waiting for the transfer to complete.
  - getDescription
```
public String getDescription()
```
    Returns a human-readable description of this transfer.
    
    指定者:
    
    getDescription 在接口中 Transfer
    
    返回:
    A human-readable description of this transfer.
  - getState
```
public Transfer.TransferState getState()
```
    Returns the current state of this transfer.
    
    指定者:
    
    getState 在接口中 Transfer
    
    返回:
    The current state of this transfer.
  - setState
```
public void setState(Transfer.TransferState state)
```
    Sets the current state of this transfer.
  - notifyStateChangeListeners
```
public void notifyStateChangeListeners(Transfer.TransferState state)
```
    Notifies all the registered state change listeners of the state update.
  - addProgressListener
```
public void addProgressListener(ProgressListener listener)
```
    Adds the specified progress listener to the list of listeners receiving updates about this transfer's progress.
    
    指定者:
    
    addProgressListener 在接口中 Transfer
    
    参数:
    listener - The progress listener to add.
  - removeProgressListener
```
public void removeProgressListener(ProgressListener listener)
```
    Removes the specified progress listener from the list of progress listeners receiving updates about this transfer's progress.
    
    指定者:
    
    removeProgressListener 在接口中 Transfer
    
    参数:
    listener - The progress listener to remove.
  - addProgressListener
```
@Deprecated
public void addProgressListener(ProgressListener listener)
```
    已过时。 Replaced by addProgressListener(ProgressListener)
    
    指定者:
    
    addProgressListener 在接口中 Transfer
  - removeProgressListener
```
@Deprecated
public void removeProgressListener(ProgressListener listener)
```
    已过时。 Replaced by removeProgressListener(ProgressListener)
    
    指定者:
    
    removeProgressListener 在接口中 Transfer
  - addStateChangeListener
```
public void addStateChangeListener(TransferStateChangeListener listener)
```
    Adds the given state change listener to the collection of listeners.
  - removeStateChangeListener
```
public void removeStateChangeListener(TransferStateChangeListener listener)
```
    Removes the given state change listener from the collection of listeners.
  - getProgress
```
public TransferProgress getProgress()
```
    Returns progress information about this transfer.
    
    指定者:
    
    getProgress 在接口中 Transfer
    
    返回:
    The progress information about this transfer.
  - setMonitor
```
public void setMonitor(TransferMonitor monitor)
```
    Sets the monitor used to poll for transfer completion.
  - getMonitor
```
public TransferMonitor getMonitor()
```
  - fireProgressEvent
```
protected void fireProgressEvent(int eventType)
```
  - rethrowExecutionException
```
protected void rethrowExecutionException(ExecutionException e)
```
    Examines the cause of the specified ExecutionException and either rethrows it directly (if it's a type of SCSClientException) or wraps it in an SCSClientException and rethrows it.
    
    参数:
    e - The execution exception to examine.
  - unwrapExecutionException
```
protected SCSClientException unwrapExecutionException(ExecutionException e)
```
    Unwraps the root exception that caused the specified ExecutionException and returns it. If it was not an instance of SCSClientException, it is wrapped as an SCSClientException.
    
    参数:
    e - The ExecutionException to unwrap.
    
    返回:
    The root exception that caused the specified ExecutionException.

类 AbstractTransfer

嵌套类概要

从接口继承的嵌套类/接口 com.sinacloud.scs.services.scs.transfer.Transfer

字段概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

state

monitor

progressListenerChain

progressListenerChainCallbackExecutor

stateChangeListeners

方法详细资料

isDone

waitForCompletion

waitForException

getDescription

getState

setState

notifyStateChangeListeners

addProgressListener

removeProgressListener

addProgressListener

removeProgressListener

addStateChangeListener

removeStateChangeListener

getProgress

setMonitor

getMonitor

fireProgressEvent

rethrowExecutionException

unwrapExecutionException