Skip to content

Commit 8824428

Browse files
committed
DbxClient: Fix typo and improve docs for startGetFile.
1 parent 2ba62d0 commit 8824428

1 file changed

Lines changed: 9 additions & 11 deletions

File tree

src/com/dropbox/core/DbxClient.java

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -348,18 +348,12 @@ public void disableAccessToken()
348348
}
349349

350350
/**
351-
* Retrieve a file's content and content metadata. Returns a {@link Downloader}
352-
* which is just an {@link InputStream} (can be used to read the file contents) and
353-
* a {@link DbxEntry.File} (the file's metadata).
354-
*
355-
* <p>
356-
* You need to close the {@link Downloader} yourself.
357-
* Use a {@code try}/{@code finally} to make sure you close it in all cases.
358-
* </p>
351+
* Retrieve a file's content and content metadata. You must call the {@link Downloader}'s
352+
* {@code close()} method; use a {@code try}/{@code finally}.
359353
*
360354
* <pre>
361355
* DbxClient dbxClient = ...
362-
* DbxClient.Downloader downloader = dbxClient.getFileStart("/ReadMe.txt")
356+
* DbxClient.Downloader downloader = dbxClient.startGetFile("/ReadMe.txt")
363357
* try {
364358
* printStream(downloader.body)
365359
* }
@@ -435,8 +429,8 @@ public void disableAccessToken()
435429
}
436430

437431
/**
438-
* A pairing of the file content's metadata and an {@link InputStream} to read the
439-
* file content. Make sure you always close the {@code InputStream}.
432+
* A pairing of a metadata and main content of a download. Make sure you always
433+
* call {@code close()}.
440434
*/
441435
public static final class Downloader
442436
{
@@ -449,6 +443,10 @@ public Downloader(DbxEntry.File metadata, InputStream body)
449443
this.body = body;
450444
}
451445

446+
/**
447+
* Copies all of {@code #body} to the given output stream. As a convenience, also
448+
* returns {@code #metadata}.
449+
*/
452450
DbxEntry.File copyBodyAndClose(OutputStream target)
453451
throws DbxException, IOException
454452
{

0 commit comments

Comments
 (0)