doc/bundles/org.eclipse.ecf.doc/html/reference/api/org/eclipse/ecf/filetransfer/IFileTransfer.html - ecf/org.eclipse.ecf - Git at Google

 <!DOCTYPE HTML>
 <!-- NewPage -->
 <html lang="en">
 <head>
 <!-- Generated by javadoc (14.0.1) on Tue Jun 15 20:48:08 PDT 2021 -->
 <title>IFileTransfer (Eclipse Communication Framework (ECF) 3.14.22 API)</title>
 <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
 <meta name="dc.created" content="2021-06-15">
 <meta name="description" content="declaration: package: org.eclipse.ecf.filetransfer, interface: IFileTransfer">
 <meta name="generator" content="javadoc/ClassWriterImpl">
 <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
 <link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.css" title="Style">
 <script type="text/javascript" src="../../../../script.js"></script>
 <script type="text/javascript" src="../../../../script-dir/jszip/dist/jszip.min.js"></script>
 <script type="text/javascript" src="../../../../script-dir/jszip-utils/dist/jszip-utils.min.js"></script>
 <!--[if IE]>
 <script type="text/javascript" src="../../../../script-dir/jszip-utils/dist/jszip-utils-ie.min.js"></script>
 <![endif]-->
 <script type="text/javascript" src="../../../../script-dir/jquery-3.4.1.js"></script>
 <script type="text/javascript" src="../../../../script-dir/jquery-ui.js"></script>
 </head>
 <body class="class-declaration">
 <script type="text/javascript">var data = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6};
 var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
 var altColor = "altColor";
 var rowColor = "rowColor";
 var tableTab = "tableTab";
 var activeTableTab = "activeTableTab";
 var pathtoroot = "../../../../";
 loadScripts(document, 'script');</script>
 <noscript>
 <div>JavaScript is disabled on your browser.</div>
 </noscript>
 <div class="flexBox">
 <header role="banner" class="flexHeader">
 <nav role="navigation">
 <!-- ========= START OF TOP NAVBAR ======= -->
 <div class="topNav"><a id="navbar.top">
 <!--   -->
 </a>
 <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
 <a id="navbar.top.firstrow">
 <!--   -->
 </a>
 <ul class="navList" title="Navigation">
 <li><a href="../../../../index.html">Overview</a></li>
 <li><a href="package-summary.html">Package</a></li>
 <li class="navBarCell1Rev">Class</li>
 <li><a href="class-use/IFileTransfer.html">Use</a></li>
 <li><a href="package-tree.html">Tree</a></li>
 <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
 <li><a href="../../../../index-files/index-1.html">Index</a></li>
 <li><a href="../../../../help-doc.html">Help</a></li>
 </ul>
 </div>
 <div class="subNav">
 <div>
 <ul class="subNavList">
 <li>Summary:&nbsp;</li>
 <li>Nested&nbsp;|&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li>Constr&nbsp;|&nbsp;</li>
 <li><a href="#method.summary">Method</a></li>
 </ul>
 <ul class="subNavList">
 <li>Detail:&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li>Constr&nbsp;|&nbsp;</li>
 <li><a href="#method.detail">Method</a></li>
 </ul>
 </div>
 <div class="navListSearch"><label for="search">SEARCH:</label>
 <input type="text" id="search" value="search" disabled="disabled">
 <input type="reset" id="reset" value="reset" disabled="disabled">
 </div>
 </div>
 <!-- ========= END OF TOP NAVBAR ========= -->
 <div class="skipNav"><a id="skip.navbar.top">
 <!--   -->
 </a></div>
 </nav>
 </header>
 <div class="flexContent">
 <main role="main">
 <!-- ======== START OF CLASS DATA ======== -->
 <div class="header">
 <div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.eclipse.ecf.filetransfer</a></div>
 <h1 title="Interface IFileTransfer" class="title">Interface IFileTransfer</h1>
 </div>
 <div class="contentContainer">
 <section class="description">
 <dl>
 <dt>All Superinterfaces:</dt>
 <dd><code>org.eclipse.core.runtime.IAdaptable</code>, <code><a href="../core/identity/IIdentifiable.html" title="interface in org.eclipse.ecf.core.identity">IIdentifiable</a></code></dd>
 </dl>
 <dl>
 <dt>All Known Subinterfaces:</dt>
 <dd><code><a href="IIncomingFileTransfer.html" title="interface in org.eclipse.ecf.filetransfer">IIncomingFileTransfer</a></code>, <code><a href="IOutgoingFileTransfer.html" title="interface in org.eclipse.ecf.filetransfer">IOutgoingFileTransfer</a></code></dd>
 </dl>
 <dl>
 <dt>All Known Implementing Classes:</dt>
 <dd><code><a href="../provider/filetransfer/outgoing/AbstractOutgoingFileTransfer.html" title="class in org.eclipse.ecf.provider.filetransfer.outgoing">AbstractOutgoingFileTransfer</a></code>, <code><a href="../provider/filetransfer/retrieve/AbstractRetrieveFileTransfer.html" title="class in org.eclipse.ecf.provider.filetransfer.retrieve">AbstractRetrieveFileTransfer</a></code>, <code><a href="../provider/filetransfer/outgoing/AbstractUrlConnectionOutgoingFileTransfer.html" title="class in org.eclipse.ecf.provider.filetransfer.outgoing">AbstractUrlConnectionOutgoingFileTransfer</a></code>, <code><a href="../provider/filetransfer/httpclient4/HttpClientRetrieveFileTransfer.html" title="class in org.eclipse.ecf.provider.filetransfer.httpclient4">HttpClientRetrieveFileTransfer</a></code>, <code><a href="../provider/filetransfer/httpclient45/HttpClientRetrieveFileTransfer.html" title="class in org.eclipse.ecf.provider.filetransfer.httpclient45">HttpClientRetrieveFileTransfer</a></code>, <code><a href="../provider/filetransfer/httpclient5/HttpClientRetrieveFileTransfer.html" title="class in org.eclipse.ecf.provider.filetransfer.httpclient5">HttpClientRetrieveFileTransfer</a></code>, <code><a href="../provider/filetransfer/outgoing/LocalFileOutgoingFileTransfer.html" title="class in org.eclipse.ecf.provider.filetransfer.outgoing">LocalFileOutgoingFileTransfer</a></code>, <code><a href="../provider/filetransfer/retrieve/UrlConnectionRetrieveFileTransfer.html" title="class in org.eclipse.ecf.provider.filetransfer.retrieve">UrlConnectionRetrieveFileTransfer</a></code></dd>
 </dl>
 <hr>
 <pre>public interface <span class="typeNameLabel">IFileTransfer</span>
 extends org.eclipse.core.runtime.IAdaptable, <a href="../core/identity/IIdentifiable.html" title="interface in org.eclipse.ecf.core.identity">IIdentifiable</a></pre>
 <div class="block">File transfer super interface. This interface provides the abstract file
  transfer semantics for both <a href="IOutgoingFileTransfer.html" title="interface in org.eclipse.ecf.filetransfer"><code>IOutgoingFileTransfer</code></a> and
  <a href="IIncomingFileTransfer.html" title="interface in org.eclipse.ecf.filetransfer"><code>IIncomingFileTransfer</code></a> transfer sub interfaces.</div>
 </section>
 <section class="summary">
 <ul class="blockList">
 <!-- ========== METHOD SUMMARY =========== -->
 <li class="blockList">
 <section class="methodSummary"><a id="method.summary">
 <!--   -->
 </a>
 <h2>Method Summary</h2>
 <div class="memberSummary">
 <div role="tablist" aria-orientation="horizontal"><button role="tab" aria-selected="true" aria-controls="memberSummary_tabpanel" tabindex="0" onkeydown="switchTab(event)" id="t0" class="activeTableTab">All Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t2" class="tableTab" onclick="show(2);">Instance Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t3" class="tableTab" onclick="show(4);">Abstract Methods</button></div>
 <div id="memberSummary_tabpanel" role="tabpanel">
 <table aria-labelledby="t0">
 <thead>
 <tr>
 <th class="colFirst" scope="col">Modifier and Type</th>
 <th class="colSecond" scope="col">Method</th>
 <th class="colLast" scope="col">Description</th>
 </tr>
 </thead>
 <tbody>
 <tr class="altColor" id="i0">
 <td class="colFirst"><code>void</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#cancel()">cancel</a></span>()</code></th>
 <td class="colLast">
 <div class="block">Cancel this file transfer.</div>
 </td>
 </tr>
 <tr class="rowColor" id="i1">
 <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getException()">getException</a></span>()</code></th>
 <td class="colLast">
 <div class="block">Get any exception associated with this file transfer.</div>
 </td>
 </tr>
 <tr class="altColor" id="i2">
 <td class="colFirst"><code>long</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getFileLength()">getFileLength</a></span>()</code></th>
 <td class="colLast">
 <div class="block">Return resulting file length (in bytes) for this file transfer instance.</div>
 </td>
 </tr>
 <tr class="rowColor" id="i3">
 <td class="colFirst"><code>double</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPercentComplete()">getPercentComplete</a></span>()</code></th>
 <td class="colLast">
 <div class="block">Get the percent complete for this file transfer.</div>
 </td>
 </tr>
 <tr class="altColor" id="i4">
 <td class="colFirst"><code>boolean</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isDone()">isDone</a></span>()</code></th>
 <td class="colLast">
 <div class="block">Return true if this file transfer is done, false if not yet completed.</div>
 </td>
 </tr>
 </tbody>
 </table>
 </div>
 </div>
 <div class="inheritedList">
 <h3>Methods inherited from interface&nbsp;org.eclipse.core.runtime.IAdaptable</h3>
 <a id="methods.inherited.from.class.org.eclipse.core.runtime.IAdaptable">
 <!--   -->
 </a><code>getAdapter</code></div>
 <div class="inheritedList">
 <h3>Methods inherited from interface&nbsp;org.eclipse.ecf.core.identity.<a href="../core/identity/IIdentifiable.html" title="interface in org.eclipse.ecf.core.identity">IIdentifiable</a></h3>
 <a id="methods.inherited.from.class.org.eclipse.ecf.core.identity.IIdentifiable">
 <!--   -->
 </a><code><a href="../core/identity/IIdentifiable.html#getID()">getID</a></code></div>
 </section>
 </li>
 </ul>
 </section>
 <section class="details">
 <ul class="blockList">
 <!-- ============ METHOD DETAIL ========== -->
 <li class="blockList">
 <section class="methodDetails"><a id="method.detail">
 <!--   -->
 </a>
 <h2>Method Details</h2>
 <ul class="blockList">
 <li class="blockList">
 <section class="detail">
 <h3><a id="cancel()">cancel</a></h3>
 <div class="memberSignature"><span class="returnType">void</span>&nbsp;<span class="memberName">cancel</span>()</div>
 <div class="block">Cancel this file transfer. If file transfer has already been completed,
  then this method has no effect. If the file transfer has not been
  completed then calling this method will result in an
  <a href="events/IFileTransferEvent.html" title="interface in org.eclipse.ecf.filetransfer.events"><code>IFileTransferEvent</code></a> being delivered to the
  <a href="IFileTransferListener.html" title="interface in org.eclipse.ecf.filetransfer"><code>IFileTransferListener</code></a> indicating that transfer is done (<a href="#isDone()"><code>isDone()</code></a>
  returns true), and some exception will be made available</div>
 </section>
 </li>
 <li class="blockList">
 <section class="detail">
 <h3><a id="getPercentComplete()">getPercentComplete</a></h3>
 <div class="memberSignature"><span class="returnType">double</span>&nbsp;<span class="memberName">getPercentComplete</span>()</div>
 <div class="block">Get the percent complete for this file transfer. The returned value will
  be either -1.0, meaning that the underlying provider does not support
  reporting percent complete for this file transfer, or a value between 0
  and 1 reflecting the percent complete for this file transfer. If 0.0 no
  data has been sent, if 1.0, the file transfer is 100 percent complete.

  The value returned from this method should <b>not</b> be used to
  determine whether the transfer has completed, as it may not show
  completion in the event of an transfer failure. Note that the
  <a href="#isDone()"><code>isDone()</code></a> method should be consulted to determine if the file
  transfer has completed (with or without error).</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>double percent complete. Returns -1.0 if the underlying provider
          does not support reporting percentage complete, or between 0 and
          1 to indicate actual percent complete for this file transfer</dd>
 </dl>
 </section>
 </li>
 <li class="blockList">
 <section class="detail">
 <h3><a id="getException()">getException</a></h3>
 <div class="memberSignature"><span class="returnType"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></span>&nbsp;<span class="memberName">getException</span>()</div>
 <div class="block">Get any exception associated with this file transfer. The value returned
  from this method is valid only if <a href="#isDone()"><code>isDone()</code></a> method returns true.
  If the file transfer completed successfully, <a href="#isDone()"><code>isDone()</code></a> will
  return true, and this method will return null. If the file transfer
  completed unsuccessfully (some exception occurred), then
  <a href="#isDone()"><code>isDone()</code></a> will return true, and this method will return a
  non-null Exception instance that occurred.
  <p>
  If the the file transfer was canceled by the user, then the exception
  returned will be an instance of <a href="UserCancelledException.html" title="class in org.eclipse.ecf.filetransfer"><code>UserCancelledException</code></a>.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>Exception associated with this file transfer. <code>null</code>
          if transfer completed successfully, non-null if transfer
          completed with some exception. Only valid <b>after</b>
          <a href="#isDone()"><code>isDone()</code></a> returns true.</dd>
 </dl>
 </section>
 </li>
 <li class="blockList">
 <section class="detail">
 <h3><a id="isDone()">isDone</a></h3>
 <div class="memberSignature"><span class="returnType">boolean</span>&nbsp;<span class="memberName">isDone</span>()</div>
 <div class="block">Return true if this file transfer is done, false if not yet completed.
  The file transfer can be completed successfully, or an exception can
  occur and the file transfer will have failed. In either case of
  successful or unsuccessful transfer, this method will return true when
  the file transfer is complete. To determine whether the transfer
  completed <b>successfully</b>, it is necessary to also consult the
  <a href="#getException()"><code>getException()</code></a> method.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>boolean true if file transfer is done, false if file transfer is
          still in progress.</dd>
 </dl>
 </section>
 </li>
 <li class="blockList">
 <section class="detail">
 <h3><a id="getFileLength()">getFileLength</a></h3>
 <div class="memberSignature"><span class="returnType">long</span>&nbsp;<span class="memberName">getFileLength</span>()</div>
 <div class="block">Return resulting file length (in bytes) for this file transfer instance.  If the length is not known,
  -1 will be returned.  Note that if a <a href="IFileRangeSpecification.html" title="interface in org.eclipse.ecf.filetransfer"><code>IFileRangeSpecification</code></a> is provided that the returned
  file length is the expected file length of just the range retrieved (and not the entire file).</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>long file length</dd>
 <dt><span class="simpleTagLabel">Since:</span></dt>
 <dd>2.0</dd>
 </dl>
 </section>
 </li>
 </ul>
 </section>
 </li>
 </ul>
 </section>
 </div>
 <!-- ========= END OF CLASS DATA ========= -->
 </main>
 <footer role="contentinfo">
 <nav role="navigation">
 <!-- ======= START OF BOTTOM NAVBAR ====== -->
 <div class="bottomNav"><a id="navbar.bottom">
 <!--   -->
 </a>
 <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
 <a id="navbar.bottom.firstrow">
 <!--   -->
 </a>
 <ul class="navList" title="Navigation">
 <li><a href="../../../../index.html">Overview</a></li>
 <li><a href="package-summary.html">Package</a></li>
 <li class="navBarCell1Rev">Class</li>
 <li><a href="class-use/IFileTransfer.html">Use</a></li>
 <li><a href="package-tree.html">Tree</a></li>
 <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
 <li><a href="../../../../index-files/index-1.html">Index</a></li>
 <li><a href="../../../../help-doc.html">Help</a></li>
 </ul>
 </div>
 <div class="subNav">
 <div>
 <ul class="subNavList">
 <li>Summary:&nbsp;</li>
 <li>Nested&nbsp;|&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li>Constr&nbsp;|&nbsp;</li>
 <li><a href="#method.summary">Method</a></li>
 </ul>
 <ul class="subNavList">
 <li>Detail:&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li>Constr&nbsp;|&nbsp;</li>
 <li><a href="#method.detail">Method</a></li>
 </ul>
 </div>
 </div>
 <a id="skip.navbar.bottom">
 <!--   -->
 </a>
 <!-- ======== END OF BOTTOM NAVBAR ======= -->
 </nav>
 <p class="legalCopy"><small>Copyright &#169; 2004&#x2013;2020 <a href="https://www.eclipse.org/">Eclipse Foundation</a>. All rights reserved.</small></p>
 </footer>
 </div>
 </div>
 </body>
 </html>
	<!DOCTYPE HTML>
	<!-- NewPage -->
	<html lang="en">
	<head>
	<!-- Generated by javadoc (14.0.1) on Tue Jun 15 20:48:08 PDT 2021 -->
	<title>IFileTransfer (Eclipse Communication Framework (ECF) 3.14.22 API)</title>
	<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
	<meta name="dc.created" content="2021-06-15">
	<meta name="description" content="declaration: package: org.eclipse.ecf.filetransfer, interface: IFileTransfer">
	<meta name="generator" content="javadoc/ClassWriterImpl">
	<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
	<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.css" title="Style">
	<script type="text/javascript" src="../../../../script.js"></script>
	<script type="text/javascript" src="../../../../script-dir/jszip/dist/jszip.min.js"></script>
	<script type="text/javascript" src="../../../../script-dir/jszip-utils/dist/jszip-utils.min.js"></script>
	<!--[if IE]>
	<script type="text/javascript" src="../../../../script-dir/jszip-utils/dist/jszip-utils-ie.min.js"></script>
	<![endif]-->
	<script type="text/javascript" src="../../../../script-dir/jquery-3.4.1.js"></script>
	<script type="text/javascript" src="../../../../script-dir/jquery-ui.js"></script>
	</head>
	<body class="class-declaration">
	<script type="text/javascript">var data = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6};
	var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
	var altColor = "altColor";
	var rowColor = "rowColor";
	var tableTab = "tableTab";
	var activeTableTab = "activeTableTab";
	var pathtoroot = "../../../../";
	loadScripts(document, 'script');</script>
	<noscript>
	<div>JavaScript is disabled on your browser.</div>
	</noscript>
	<div class="flexBox">
	<header role="banner" class="flexHeader">
	<nav role="navigation">
	<!-- ========= START OF TOP NAVBAR ======= -->
	<div class="topNav"><a id="navbar.top">
	<!-- -->
	</a>
	<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
	<a id="navbar.top.firstrow">
	<!-- -->
	</a>
	<ul class="navList" title="Navigation">
	<li><a href="../../../../index.html">Overview</a></li>
	<li><a href="package-summary.html">Package</a></li>
	<li class="navBarCell1Rev">Class</li>
	<li><a href="class-use/IFileTransfer.html">Use</a></li>
	<li><a href="package-tree.html">Tree</a></li>
	<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
	<li><a href="../../../../index-files/index-1.html">Index</a></li>
	<li><a href="../../../../help-doc.html">Help</a></li>
	</ul>
	</div>
	<div class="subNav">
	<div>
	<ul class="subNavList">
	<li>Summary: </li>
	<li>Nested \| </li>
	<li>Field \| </li>
	<li>Constr \| </li>
	<li><a href="#method.summary">Method</a></li>
	</ul>
	<ul class="subNavList">
	<li>Detail: </li>
	<li>Field \| </li>
	<li>Constr \| </li>
	<li><a href="#method.detail">Method</a></li>
	</ul>
	</div>
	<div class="navListSearch"><label for="search">SEARCH:</label>
	<input type="text" id="search" value="search" disabled="disabled">
	<input type="reset" id="reset" value="reset" disabled="disabled">
	</div>
	</div>
	<!-- ========= END OF TOP NAVBAR ========= -->
	<div class="skipNav"><a id="skip.navbar.top">
	<!-- -->
	</a></div>
	</nav>
	</header>
	<div class="flexContent">
	<main role="main">
	<!-- ======== START OF CLASS DATA ======== -->
	<div class="header">
	<div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.eclipse.ecf.filetransfer</a></div>
	<h1 title="Interface IFileTransfer" class="title">Interface IFileTransfer</h1>
	</div>
	<div class="contentContainer">
	<section class="description">
	<dl>
	<dt>All Superinterfaces:</dt>
	<dd><code>org.eclipse.core.runtime.IAdaptable</code>, <code><a href="../core/identity/IIdentifiable.html" title="interface in org.eclipse.ecf.core.identity">IIdentifiable</a></code></dd>
	</dl>
	<dl>
	<dt>All Known Subinterfaces:</dt>
	<dd><code><a href="IIncomingFileTransfer.html" title="interface in org.eclipse.ecf.filetransfer">IIncomingFileTransfer</a></code>, <code><a href="IOutgoingFileTransfer.html" title="interface in org.eclipse.ecf.filetransfer">IOutgoingFileTransfer</a></code></dd>
	</dl>
	<dl>
	<dt>All Known Implementing Classes:</dt>
	<dd><code><a href="../provider/filetransfer/outgoing/AbstractOutgoingFileTransfer.html" title="class in org.eclipse.ecf.provider.filetransfer.outgoing">AbstractOutgoingFileTransfer</a></code>, <code><a href="../provider/filetransfer/retrieve/AbstractRetrieveFileTransfer.html" title="class in org.eclipse.ecf.provider.filetransfer.retrieve">AbstractRetrieveFileTransfer</a></code>, <code><a href="../provider/filetransfer/outgoing/AbstractUrlConnectionOutgoingFileTransfer.html" title="class in org.eclipse.ecf.provider.filetransfer.outgoing">AbstractUrlConnectionOutgoingFileTransfer</a></code>, <code><a href="../provider/filetransfer/httpclient4/HttpClientRetrieveFileTransfer.html" title="class in org.eclipse.ecf.provider.filetransfer.httpclient4">HttpClientRetrieveFileTransfer</a></code>, <code><a href="../provider/filetransfer/httpclient45/HttpClientRetrieveFileTransfer.html" title="class in org.eclipse.ecf.provider.filetransfer.httpclient45">HttpClientRetrieveFileTransfer</a></code>, <code><a href="../provider/filetransfer/httpclient5/HttpClientRetrieveFileTransfer.html" title="class in org.eclipse.ecf.provider.filetransfer.httpclient5">HttpClientRetrieveFileTransfer</a></code>, <code><a href="../provider/filetransfer/outgoing/LocalFileOutgoingFileTransfer.html" title="class in org.eclipse.ecf.provider.filetransfer.outgoing">LocalFileOutgoingFileTransfer</a></code>, <code><a href="../provider/filetransfer/retrieve/UrlConnectionRetrieveFileTransfer.html" title="class in org.eclipse.ecf.provider.filetransfer.retrieve">UrlConnectionRetrieveFileTransfer</a></code></dd>
	</dl>
	<hr>
	<pre>public interface <span class="typeNameLabel">IFileTransfer</span>
	extends org.eclipse.core.runtime.IAdaptable, <a href="../core/identity/IIdentifiable.html" title="interface in org.eclipse.ecf.core.identity">IIdentifiable</a></pre>
	<div class="block">File transfer super interface. This interface provides the abstract file
	transfer semantics for both <a href="IOutgoingFileTransfer.html" title="interface in org.eclipse.ecf.filetransfer"><code>IOutgoingFileTransfer</code></a> and
	<a href="IIncomingFileTransfer.html" title="interface in org.eclipse.ecf.filetransfer"><code>IIncomingFileTransfer</code></a> transfer sub interfaces.</div>
	</section>
	<section class="summary">
	<ul class="blockList">
	<!-- ========== METHOD SUMMARY =========== -->
	<li class="blockList">
	<section class="methodSummary"><a id="method.summary">
	<!-- -->
	</a>
	<h2>Method Summary</h2>
	<div class="memberSummary">
	<div role="tablist" aria-orientation="horizontal"><button role="tab" aria-selected="true" aria-controls="memberSummary_tabpanel" tabindex="0" onkeydown="switchTab(event)" id="t0" class="activeTableTab">All Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t2" class="tableTab" onclick="show(2);">Instance Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t3" class="tableTab" onclick="show(4);">Abstract Methods</button></div>
	<div id="memberSummary_tabpanel" role="tabpanel">
	<table aria-labelledby="t0">
	<thead>
	<tr>
	<th class="colFirst" scope="col">Modifier and Type</th>
	<th class="colSecond" scope="col">Method</th>
	<th class="colLast" scope="col">Description</th>
	</tr>
	</thead>
	<tbody>
	<tr class="altColor" id="i0">
	<td class="colFirst"><code>void</code></td>
	<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#cancel()">cancel</a></span>()</code></th>
	<td class="colLast">
	<div class="block">Cancel this file transfer.</div>
	</td>
	</tr>
	<tr class="rowColor" id="i1">
	<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></code></td>
	<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getException()">getException</a></span>()</code></th>
	<td class="colLast">
	<div class="block">Get any exception associated with this file transfer.</div>
	</td>
	</tr>
	<tr class="altColor" id="i2">
	<td class="colFirst"><code>long</code></td>
	<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getFileLength()">getFileLength</a></span>()</code></th>
	<td class="colLast">
	<div class="block">Return resulting file length (in bytes) for this file transfer instance.</div>
	</td>
	</tr>
	<tr class="rowColor" id="i3">
	<td class="colFirst"><code>double</code></td>
	<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPercentComplete()">getPercentComplete</a></span>()</code></th>
	<td class="colLast">
	<div class="block">Get the percent complete for this file transfer.</div>
	</td>
	</tr>
	<tr class="altColor" id="i4">
	<td class="colFirst"><code>boolean</code></td>
	<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isDone()">isDone</a></span>()</code></th>
	<td class="colLast">
	<div class="block">Return true if this file transfer is done, false if not yet completed.</div>
	</td>
	</tr>
	</tbody>
	</table>
	</div>
	</div>
	<div class="inheritedList">
	<h3>Methods inherited from interface org.eclipse.core.runtime.IAdaptable</h3>
	<a id="methods.inherited.from.class.org.eclipse.core.runtime.IAdaptable">
	<!-- -->
	</a><code>getAdapter</code></div>
	<div class="inheritedList">
	<h3>Methods inherited from interface org.eclipse.ecf.core.identity.<a href="../core/identity/IIdentifiable.html" title="interface in org.eclipse.ecf.core.identity">IIdentifiable</a></h3>
	<a id="methods.inherited.from.class.org.eclipse.ecf.core.identity.IIdentifiable">
	<!-- -->
	</a><code><a href="../core/identity/IIdentifiable.html#getID()">getID</a></code></div>
	</section>
	</li>
	</ul>
	</section>
	<section class="details">
	<ul class="blockList">
	<!-- ============ METHOD DETAIL ========== -->
	<li class="blockList">
	<section class="methodDetails"><a id="method.detail">
	<!-- -->
	</a>
	<h2>Method Details</h2>
	<ul class="blockList">
	<li class="blockList">
	<section class="detail">
	<h3><a id="cancel()">cancel</a></h3>
	<div class="memberSignature"><span class="returnType">void</span> <span class="memberName">cancel</span>()</div>
	<div class="block">Cancel this file transfer. If file transfer has already been completed,
	then this method has no effect. If the file transfer has not been
	completed then calling this method will result in an
	<a href="events/IFileTransferEvent.html" title="interface in org.eclipse.ecf.filetransfer.events"><code>IFileTransferEvent</code></a> being delivered to the
	<a href="IFileTransferListener.html" title="interface in org.eclipse.ecf.filetransfer"><code>IFileTransferListener</code></a> indicating that transfer is done (<a href="#isDone()"><code>isDone()</code></a>
	returns true), and some exception will be made available</div>
	</section>
	</li>
	<li class="blockList">
	<section class="detail">
	<h3><a id="getPercentComplete()">getPercentComplete</a></h3>
	<div class="memberSignature"><span class="returnType">double</span> <span class="memberName">getPercentComplete</span>()</div>
	<div class="block">Get the percent complete for this file transfer. The returned value will
	be either -1.0, meaning that the underlying provider does not support
	reporting percent complete for this file transfer, or a value between 0
	and 1 reflecting the percent complete for this file transfer. If 0.0 no
	data has been sent, if 1.0, the file transfer is 100 percent complete.

	The value returned from this method should <b>not</b> be used to
	determine whether the transfer has completed, as it may not show
	completion in the event of an transfer failure. Note that the
	<a href="#isDone()"><code>isDone()</code></a> method should be consulted to determine if the file
	transfer has completed (with or without error).</div>
	<dl>
	<dt><span class="returnLabel">Returns:</span></dt>
	<dd>double percent complete. Returns -1.0 if the underlying provider
	does not support reporting percentage complete, or between 0 and
	1 to indicate actual percent complete for this file transfer</dd>
	</dl>
	</section>
	</li>
	<li class="blockList">
	<section class="detail">
	<h3><a id="getException()">getException</a></h3>
	<div class="memberSignature"><span class="returnType"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></span> <span class="memberName">getException</span>()</div>
	<div class="block">Get any exception associated with this file transfer. The value returned
	from this method is valid only if <a href="#isDone()"><code>isDone()</code></a> method returns true.
	If the file transfer completed successfully, <a href="#isDone()"><code>isDone()</code></a> will
	return true, and this method will return null. If the file transfer
	completed unsuccessfully (some exception occurred), then
	<a href="#isDone()"><code>isDone()</code></a> will return true, and this method will return a
	non-null Exception instance that occurred.
	<p>
	If the the file transfer was canceled by the user, then the exception
	returned will be an instance of <a href="UserCancelledException.html" title="class in org.eclipse.ecf.filetransfer"><code>UserCancelledException</code></a>.</div>
	<dl>
	<dt><span class="returnLabel">Returns:</span></dt>
	<dd>Exception associated with this file transfer. <code>null</code>
	if transfer completed successfully, non-null if transfer
	completed with some exception. Only valid <b>after</b>
	<a href="#isDone()"><code>isDone()</code></a> returns true.</dd>
	</dl>
	</section>
	</li>
	<li class="blockList">
	<section class="detail">
	<h3><a id="isDone()">isDone</a></h3>
	<div class="memberSignature"><span class="returnType">boolean</span> <span class="memberName">isDone</span>()</div>
	<div class="block">Return true if this file transfer is done, false if not yet completed.
	The file transfer can be completed successfully, or an exception can
	occur and the file transfer will have failed. In either case of
	successful or unsuccessful transfer, this method will return true when
	the file transfer is complete. To determine whether the transfer
	completed <b>successfully</b>, it is necessary to also consult the
	<a href="#getException()"><code>getException()</code></a> method.</div>
	<dl>
	<dt><span class="returnLabel">Returns:</span></dt>
	<dd>boolean true if file transfer is done, false if file transfer is
	still in progress.</dd>
	</dl>
	</section>
	</li>
	<li class="blockList">
	<section class="detail">
	<h3><a id="getFileLength()">getFileLength</a></h3>
	<div class="memberSignature"><span class="returnType">long</span> <span class="memberName">getFileLength</span>()</div>
	<div class="block">Return resulting file length (in bytes) for this file transfer instance. If the length is not known,
	-1 will be returned. Note that if a <a href="IFileRangeSpecification.html" title="interface in org.eclipse.ecf.filetransfer"><code>IFileRangeSpecification</code></a> is provided that the returned
	file length is the expected file length of just the range retrieved (and not the entire file).</div>
	<dl>
	<dt><span class="returnLabel">Returns:</span></dt>
	<dd>long file length</dd>
	<dt><span class="simpleTagLabel">Since:</span></dt>
	<dd>2.0</dd>
	</dl>
	</section>
	</li>
	</ul>
	</section>
	</li>
	</ul>
	</section>
	</div>
	<!-- ========= END OF CLASS DATA ========= -->
	</main>
	<footer role="contentinfo">
	<nav role="navigation">
	<!-- ======= START OF BOTTOM NAVBAR ====== -->
	<div class="bottomNav"><a id="navbar.bottom">
	<!-- -->
	</a>
	<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
	<a id="navbar.bottom.firstrow">
	<!-- -->
	</a>
	<ul class="navList" title="Navigation">
	<li><a href="../../../../index.html">Overview</a></li>
	<li><a href="package-summary.html">Package</a></li>
	<li class="navBarCell1Rev">Class</li>
	<li><a href="class-use/IFileTransfer.html">Use</a></li>
	<li><a href="package-tree.html">Tree</a></li>
	<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
	<li><a href="../../../../index-files/index-1.html">Index</a></li>
	<li><a href="../../../../help-doc.html">Help</a></li>
	</ul>
	</div>
	<div class="subNav">
	<div>
	<ul class="subNavList">
	<li>Summary: </li>
	<li>Nested \| </li>
	<li>Field \| </li>
	<li>Constr \| </li>
	<li><a href="#method.summary">Method</a></li>
	</ul>
	<ul class="subNavList">
	<li>Detail: </li>
	<li>Field \| </li>
	<li>Constr \| </li>
	<li><a href="#method.detail">Method</a></li>
	</ul>
	</div>
	</div>
	<a id="skip.navbar.bottom">
	<!-- -->
	</a>
	<!-- ======== END OF BOTTOM NAVBAR ======= -->
	</nav>
	<p class="legalCopy"><small>Copyright © 2004–2020 <a href="https://www.eclipse.org/">Eclipse Foundation</a>. All rights reserved.</small></p>
	</footer>
	</div>
	</div>
	</body>
	</html>