From: "Shawn O. Pearce" <spearce@spearce.org>
To: Robin Rosenberg <robin.rosenberg@dewire.com>,
Marek Zawirski <marek.zawirski@gmail.com>
Cc: git@vger.kernel.org
Subject: [JGIT PATCH 17/21] Misc. documentation fixes to Base64 utility
Date: Sun, 29 Jun 2008 03:59:27 -0400 [thread overview]
Message-ID: <1214726371-93520-18-git-send-email-spearce@spearce.org> (raw)
In-Reply-To: <1214726371-93520-17-git-send-email-spearce@spearce.org>
These fixes silence warnings in the utility which are triggered
by our (rather pedantic) Eclipse compiler settings.
Signed-off-by: Shawn O. Pearce <spearce@spearce.org>
---
.../src/org/spearce/jgit/util/Base64.java | 8 +++++++-
1 files changed, 7 insertions(+), 1 deletions(-)
diff --git a/org.spearce.jgit/src/org/spearce/jgit/util/Base64.java b/org.spearce.jgit/src/org/spearce/jgit/util/Base64.java
index b0c19b6..9254bd0 100644
--- a/org.spearce.jgit/src/org/spearce/jgit/util/Base64.java
+++ b/org.spearce.jgit/src/org/spearce/jgit/util/Base64.java
@@ -378,6 +378,7 @@ public class Base64
* Does not GZip-compress data.
*
* @param source The data to convert
+ * @return encoded base64 representation of source.
* @since 1.4
*/
public static String encodeBytes( byte[] source )
@@ -403,6 +404,7 @@ public class Base64
*
* @param source The data to convert
* @param options Specified options
+ * @return encoded base64 representation of source.
* @see Base64#GZIP
* @see Base64#DONT_BREAK_LINES
* @since 2.0
@@ -420,6 +422,7 @@ public class Base64
* @param source The data to convert
* @param off Offset in array where conversion should begin
* @param len Length of data to convert
+ * @return encoded base64 representation of source.
* @since 1.4
*/
public static String encodeBytes( byte[] source, int off, int len )
@@ -447,6 +450,7 @@ public class Base64
* @param off Offset in array where conversion should begin
* @param len Length of data to convert
* @param options Specified options
+ * @return encoded base64 representation of source.
* @see Base64#GZIP
* @see Base64#DONT_BREAK_LINES
* @since 2.0
@@ -729,7 +733,7 @@ public class Base64
if( bytes != null && bytes.length >= 4 )
{
- int head = ((int)bytes[0] & 0xff) | ((bytes[1] << 8) & 0xff00);
+ int head = (bytes[0] & 0xff) | ((bytes[1] << 8) & 0xff00);
if( java.util.zip.GZIPInputStream.GZIP_MAGIC == head )
{
java.io.ByteArrayInputStream bais = null;
@@ -1386,6 +1390,7 @@ public class Base64
/**
* Method added by PHIL. [Thanks, PHIL. -Rob]
* This pads the buffer without closing the stream.
+ * @throws java.io.IOException input was not properly padded.
*/
public void flushBase64() throws java.io.IOException
{
@@ -1430,6 +1435,7 @@ public class Base64
* May be helpful if you need to embed a piece of
* base640-encoded data in a stream.
*
+ * @throws java.io.IOException input was not properly padded.
* @since 1.5.1
*/
public void suspendEncoding() throws java.io.IOException
--
1.5.6.74.g8a5e
next prev parent reply other threads:[~2008-06-29 8:02 UTC|newest]
Thread overview: 27+ messages / expand[flat|nested] mbox.gz Atom feed top
2008-06-29 7:59 [JGIT PATCH 00/21] Push support over SFTP and (encrypted) Amazon S3 Shawn O. Pearce
2008-06-29 7:59 ` [JGIT PATCH 01/21] Remove unused index files when WalkFetchConnection closes Shawn O. Pearce
2008-06-29 7:59 ` [JGIT PATCH 02/21] Do not show URIish passwords in TransportExceptions Shawn O. Pearce
2008-06-29 7:59 ` [JGIT PATCH 03/21] Use PackedObjectInfo as a base class for PackWriter's ObjectToPack Shawn O. Pearce
2008-06-29 7:59 ` [JGIT PATCH 04/21] Refactor PackWriter to hold onto the sorted object list Shawn O. Pearce
2008-06-29 7:59 ` [JGIT PATCH 05/21] Save the pack checksum after computing it in PackWriter Shawn O. Pearce
2008-06-29 7:59 ` [JGIT PATCH 06/21] Allow PackIndexWriter to use any subclass of PackedObjectInfo Shawn O. Pearce
2008-06-29 7:59 ` [JGIT PATCH 07/21] Allow PackWriter to create a corresponding index file Shawn O. Pearce
2008-06-29 7:59 ` [JGIT PATCH 08/21] Allow PackWriter to prepare object list and compute name before writing Shawn O. Pearce
2008-06-29 7:59 ` [JGIT PATCH 09/21] Remember how a Ref was read in from disk and created Shawn O. Pearce
2008-06-29 7:59 ` [JGIT PATCH 10/21] Simplify walker transport ref advertisement setup Shawn O. Pearce
2008-06-29 7:59 ` [JGIT PATCH 11/21] Indicate the protocol jgit doesn't support push over Shawn O. Pearce
2008-06-29 7:59 ` [JGIT PATCH 12/21] WalkTransport must allow subclasses to implement openPush Shawn O. Pearce
2008-06-29 7:59 ` [JGIT PATCH 13/21] Support push over the sftp:// dumb transport Shawn O. Pearce
2008-06-29 7:59 ` [JGIT PATCH 14/21] Extract readPackedRefs from TransportSftp for reuse Shawn O. Pearce
2008-06-29 7:59 ` [JGIT PATCH 15/21] Specialized byte array output stream for large files Shawn O. Pearce
2008-06-29 7:59 ` [JGIT PATCH 16/21] Add Robert Harder's public domain Base64 encoding utility Shawn O. Pearce
2008-06-29 7:59 ` Shawn O. Pearce [this message]
2008-06-29 7:59 ` [JGIT PATCH 18/21] Extract the basic HTTP proxy support to its own class Shawn O. Pearce
2008-06-29 7:59 ` [JGIT PATCH 19/21] Create a really simple Amazon S3 REST client Shawn O. Pearce
2008-06-29 7:59 ` [JGIT PATCH 20/21] Add client side encryption to Amazon S3 client library Shawn O. Pearce
2008-06-29 7:59 ` [JGIT PATCH 21/21] Bidirectional protocol support for Amazon S3 Shawn O. Pearce
2008-06-29 13:51 ` [JGIT PATCH 16/21] Add Robert Harder's public domain Base64 encoding utility Robin Rosenberg
2008-06-29 18:06 ` Shawn O. Pearce
2008-06-29 13:51 ` [JGIT PATCH 09/21] Remember how a Ref was read in from disk and created Robin Rosenberg
2008-06-29 14:17 ` Johannes Schindelin
2008-06-29 18:00 ` Shawn O. Pearce
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1214726371-93520-18-git-send-email-spearce@spearce.org \
--to=spearce@spearce.org \
--cc=git@vger.kernel.org \
--cc=marek.zawirski@gmail.com \
--cc=robin.rosenberg@dewire.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).