From cd2b479b5bb7de0472233aecea04b62d608b430b Mon Sep 17 00:00:00 2001 From: Rogiel Date: Wed, 18 Jan 2012 20:39:40 -0200 Subject: [PATCH] Adds SeekableDownloadChannel documentation page --- .../site/xdoc/seekable-download-channel.xml | 36 +++++++++++++++++++ pom.xml | 3 +- src/site/site.xml | 2 ++ src/site/xdoc/seekable-download-channel.xml | 36 +++++++++++++++++++ 4 files changed, 76 insertions(+), 1 deletion(-) create mode 100644 httpchannel-api/src/site/xdoc/seekable-download-channel.xml create mode 100644 src/site/xdoc/seekable-download-channel.xml diff --git a/httpchannel-api/src/site/xdoc/seekable-download-channel.xml b/httpchannel-api/src/site/xdoc/seekable-download-channel.xml new file mode 100644 index 0000000..b268344 --- /dev/null +++ b/httpchannel-api/src/site/xdoc/seekable-download-channel.xml @@ -0,0 +1,36 @@ + + + + Home + Rogiel Sulzbach + + + + +
+

+ The + SeekableDownloadChannel + allows you to emulate the download stream as if it was a local file: + you can go back and forth. All of that comes at a cost, you need to + restart the download everytime you set the channel position. +

+ + + + Creates a new + SeekableDownloadChannel + channel and set its position to the 12288 byte offset. + + +

+ If the channel does not support seeking, an + IOException + is thrown at construction time. +

+
+ + \ No newline at end of file diff --git a/pom.xml b/pom.xml index 1c5584f..12f786c 100644 --- a/pom.xml +++ b/pom.xml @@ -172,6 +172,7 @@ site-maven-plugin 0.4 + Creating ${project.artifactId} site for ${project.version} seedbox httpchannel.github.com @@ -207,7 +208,7 @@ 2.2.2 true - deploy site-deploy + deploy diff --git a/src/site/site.xml b/src/site/site.xml index b64cd59..9b9c54b 100644 --- a/src/site/site.xml +++ b/src/site/site.xml @@ -6,6 +6,8 @@ + diff --git a/src/site/xdoc/seekable-download-channel.xml b/src/site/xdoc/seekable-download-channel.xml new file mode 100644 index 0000000..b268344 --- /dev/null +++ b/src/site/xdoc/seekable-download-channel.xml @@ -0,0 +1,36 @@ + + + + Home + Rogiel Sulzbach + + + + +
+

+ The + SeekableDownloadChannel + allows you to emulate the download stream as if it was a local file: + you can go back and forth. All of that comes at a cost, you need to + restart the download everytime you set the channel position. +

+ + + + Creates a new + SeekableDownloadChannel + channel and set its position to the 12288 byte offset. + + +

+ If the channel does not support seeking, an + IOException + is thrown at construction time. +

+
+ + \ No newline at end of file