class Base64 extends AnyRef
A very fast and memory efficient class to encode and decode to and from BASE64 in full accordance
with RFC 2045.
On Windows XP sp1 with 1.4.2_04 and later ;), this encoder and decoder is about 10 times faster
on small arrays (10 - 1000 bytes) and 2-3 times as fast on larger arrays (10000 - 1000000 bytes)
compared to sun.misc.Encoder()/Decoder().
On byte arrays the encoder is about 20% faster than Jakarta Commons Base64 Codec for encode and
about 50% faster for decoding large arrays. This implementation is about twice as fast on very small
arrays (< 30 bytes). If source/destination is a String this
version is about three times as fast due to the fact that the Commons Codec result has to be recoded
to a String from byte[], which is very expensive.
This encode/decode algorithm doesn't create any temporary arrays as many other codecs do, it only
allocates the resulting array. This produces less garbage and it is possible to handle arrays twice
as large as algorithms that create a temporary array. (E.g. Jakarta Commons Codec). It is unknown
whether Sun's sun.misc.Encoder()/Decoder() produce temporary arrays but since performance
is quite low it probably does.
The encoder produces the same output as the Sun one except that the Sun's encoder appends
a trailing line separator if the last character isn't a pad. Unclear why but it only adds to the
length and is probably a side effect. Both are in conformance with RFC 2045 though.
Commons codec seem to always att a trailing line separator.
Note!
The encode/decode method pairs (types) come in three versions with the exact same algorithm and
thus a lot of code redundancy. This is to not create any temporary arrays for transcoding to/from different
format types. The methods not used can simply be commented out.
There is also a "fast" version of all decode methods that works the same way as the normal ones, but
har a few demands on the decoded input. Normally though, these fast verions should be used if the source if
the input is known and it hasn't bee tampered with.
If you find the code useful or you find a bug, please send me a note at base64 @ miginfocom . com.
Licence (BSD):
Copyright (c) 2004, Mikael Grev, MiG InfoCom AB. (base64 @ miginfocom . com) All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. Neither the name of the MiG InfoCom AB nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- Source
- Base64.java
- Version
2.2
- Alphabetic
- By Inheritance
- Base64
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- All
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
- def +(other: String): String
- def ->[B](y: B): (Base64, B)
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
final
def
decode(str: String): Array[Byte]
Decodes a BASE64 encoded
String.Decodes a BASE64 encoded
String. All illegal characters will be ignored and can handle both strings with and without line separators.
Note! It can be up to about 2x the speed to calldecode(str.toCharArray())instead. That will create a temporary array though. This version will usestr.charAt(i)to iterate the string.- str
The source string.
nullor length 0 will return an empty array.- returns
The decoded array of bytes. May be of length 0. Will be
nullif the legal characters (including '=') isn't divideable by 4. (I.e. definitely corrupted).
-
final
def
decode(sArr: Array[Byte]): Array[Byte]
Decodes a BASE64 encoded byte array.
Decodes a BASE64 encoded byte array. All illegal characters will be ignored and can handle both arrays with and without line separators.
- sArr
The source array. Length 0 will return an empty array.
nullwill throw an exception.- returns
The decoded array of bytes. May be of length 0. Will be
nullif the legal characters (including '=') isn't divideable by 4. (I.e. definitely corrupted).
-
final
def
decode(sArr: Array[Char]): Array[Byte]
Decodes a BASE64 encoded char array.
Decodes a BASE64 encoded char array. All illegal characters will be ignored and can handle both arrays with and without line separators.
- sArr
The source array.
nullor length 0 will return an empty array.- returns
The decoded array of bytes. May be of length 0. Will be
nullif the legal characters (including '=') isn't divideable by 4. (I.e. definitely corrupted).
-
final
def
decodeFast(s: String): Array[Byte]
Decodes a BASE64 encoded string that is known to be resonably well formatted.
Decodes a BASE64 encoded string that is known to be resonably well formatted. The method is about twice as fast as
#decode(String). The preconditions are:
+ The array must have a line length of 76 chars OR no line separators at all (one line).
+ Line separator must be "\r\n", as specified in RFC 2045 + The array must not contain illegal characters within the encoded string
+ The array CAN have illegal characters at the beginning and end, those will be dealt with appropriately.
- s
The source string. Length 0 will return an empty array.
nullwill throw an exception.- returns
The decoded array of bytes. May be of length 0.
-
final
def
decodeFast(sArr: Array[Byte]): Array[Byte]
Decodes a BASE64 encoded byte array that is known to be resonably well formatted.
Decodes a BASE64 encoded byte array that is known to be resonably well formatted. The method is about twice as fast as
#decode(byte[]). The preconditions are:
+ The array must have a line length of 76 chars OR no line separators at all (one line).
+ Line separator must be "\r\n", as specified in RFC 2045 + The array must not contain illegal characters within the encoded string
+ The array CAN have illegal characters at the beginning and end, those will be dealt with appropriately.
- sArr
The source array. Length 0 will return an empty array.
nullwill throw an exception.- returns
The decoded array of bytes. May be of length 0.
-
final
def
decodeFast(sArr: Array[Char]): Array[Byte]
Decodes a BASE64 encoded char array that is known to be resonably well formatted.
Decodes a BASE64 encoded char array that is known to be resonably well formatted. The method is about twice as fast as
#decode(char[]). The preconditions are:
+ The array must have a line length of 76 chars OR no line separators at all (one line).
+ Line separator must be "\r\n", as specified in RFC 2045 + The array must not contain illegal characters within the encoded string
+ The array CAN have illegal characters at the beginning and end, those will be dealt with appropriately.
- sArr
The source array. Length 0 will return an empty array.
nullwill throw an exception.- returns
The decoded array of bytes. May be of length 0.
-
final
def
encodeToByte(sArr: Array[Byte], lineSep: Boolean): Array[Byte]
Encodes a raw byte array into a BASE64
byte[]representation i accordance with RFC 2045.Encodes a raw byte array into a BASE64
byte[]representation i accordance with RFC 2045.- sArr
The bytes to convert. If
nullor length 0 an empty array will be returned.- lineSep
Optional "\r\n" after 76 characters, unless end of file.
No line separator will be in breach of RFC 2045 which specifies max 76 per line but will be a little faster.- returns
A BASE64 encoded array. Never
null.
-
final
def
encodeToChar(sArr: Array[Byte], lineSep: Boolean): Array[Char]
Encodes a raw byte array into a BASE64
char[]representation i accordance with RFC 2045.Encodes a raw byte array into a BASE64
char[]representation i accordance with RFC 2045.- sArr
The bytes to convert. If
nullor length 0 an empty array will be returned.- lineSep
Optional "\r\n" after 76 characters, unless end of file.
No line separator will be in breach of RFC 2045 which specifies max 76 per line but will be a little faster.- returns
A BASE64 encoded array. Never
null.
-
final
def
encodeToString(sArr: Array[Byte], lineSep: Boolean): String
Encodes a raw byte array into a BASE64
Stringrepresentation in accordance with RFC 2045.Encodes a raw byte array into a BASE64
Stringrepresentation in accordance with RFC 2045.- sArr
The bytes to convert. If
nullor length 0 an empty array will be returned.- lineSep
Optional "\r\n" after 76 characters, unless end of file.
No line separator will be in breach of RFC 2045 which specifies max 76 per line but will be a little faster.- returns
A BASE64 encoded array. Never
null.
- def ensuring(cond: (Base64) ⇒ Boolean, msg: ⇒ Any): Base64
- def ensuring(cond: (Base64) ⇒ Boolean): Base64
- def ensuring(cond: Boolean, msg: ⇒ Any): Base64
- def ensuring(cond: Boolean): Base64
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
- def formatted(fmtstr: String): String
- def getAlphabet(): Array[Char]
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
- def →[B](y: B): (Base64, B)