Class HttpRequest.Base64

java.lang.Object

com.github.kevinsawicki.http.HttpRequest.Base64

Enclosing class:

HttpRequest

public static class HttpRequest.Base64
extends Object

Encodes and decodes to and from Base64 notation.

I am placing this code in the Public Domain. Do with it as you will. This software comes with no guarantees or warranties but with plenty of well-wishing instead! Please visit http://iharder.net/base64 periodically to check for updates or to contribute improvements.

Version:

2.3.7

Author:

Robert Harder, rob@iharder.net

Method Summary

Modifier and Type	Method	Description
static String	encode(String string)	Encode string as a byte array in Base64 annotation.
static String	encodeBytes(byte[] source)	Encodes a byte array into Base64 notation.
static String	encodeBytes(byte[] source, int off, int len)	Encodes a byte array into Base64 notation.
static byte[]	encodeBytesToBytes(byte[] source, int off, int len)	Similar to encodeBytes(byte[], int, int) but returns a byte array instead of instantiating a String.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

encode

public static String encode(String string)

Encode string as a byte array in Base64 annotation.

Parameters:

string -

Returns:

The Base64-encoded data as a string

encodeBytes

public static String encodeBytes(byte[] source)

Encodes a byte array into Base64 notation.

Parameters:

source - The data to convert

Returns:

The Base64-encoded data as a String

Throws:

NullPointerException - if source array is null

IllegalArgumentException - if source array, offset, or length are invalid

Since:

2.0

encodeBytes

public static String encodeBytes(byte[] source,
 int off,
 int len)

Encodes a byte array into Base64 notation.

Parameters:

source - The data to convert

off - Offset in array where conversion should begin

len - Length of data to convert

Returns:

The Base64-encoded data as a String

Throws:

NullPointerException - if source array is null

IllegalArgumentException - if source array, offset, or length are invalid

Since:

2.0

encodeBytesToBytes

public static byte[] encodeBytesToBytes(byte[] source,
 int off,
 int len)

Similar to encodeBytes(byte[], int, int) but returns a byte array instead of instantiating a String. This is more efficient if you're working with I/O streams and have large data sets to encode.

Parameters:

source - The data to convert

off - Offset in array where conversion should begin

len - Length of data to convert

Returns:

The Base64-encoded data as a String if there is an error

Throws:

NullPointerException - if source array is null

IllegalArgumentException - if source array, offset, or length are invalid

Since:

2.3.1