Packagemx.utils
Classpublic class Base64Encoder

A utility class to encode a String or ByteArray as a Base64 encoded String.


Public Properties
 PropertyDefined by
  insertNewLines : Boolean = true
A Boolean flag to control whether the sequence of characters specified for Base64Encoder.newLine are inserted every 76 characters to wrap the encoded output.
Base64Encoder
  newLine : int = 10
[static] The character codepoint to be inserted into the encoded output to denote a new line if insertNewLines is true.
Base64Encoder
Public Methods
 MethodDefined by
  
Base64Encoder()
Constructor.
Base64Encoder
  
encode(data:String, offset:uint = 0, length:uint = 0):void
Encodes the characters of a String in Base64 and adds the result to an internal buffer.
Base64Encoder
  
encodeBytes(data:ByteArray, offset:uint = 0, length:uint = 0):void
Encodes a ByteArray in Base64 and adds the result to an internal buffer.
Base64Encoder
  
encodeUTFBytes(data:String):void
Encodes the UTF-8 bytes of a String in Base64 and adds the result to an internal buffer.
Base64Encoder
  
reset():void
Clears all buffers and resets the encoder to its initial state.
Base64Encoder
  
toString():String
Returns the current buffer as a Base64 encoded String.
Base64Encoder
Public Constants
 ConstantDefined by
  CHARSET_UTF_8 : String = "UTF-8"
[static]
Base64Encoder
Property detail
insertNewLinesproperty
public var insertNewLines:Boolean = true

A Boolean flag to control whether the sequence of characters specified for Base64Encoder.newLine are inserted every 76 characters to wrap the encoded output. The default is true.

newLineproperty 
public static var newLine:int = 10

The character codepoint to be inserted into the encoded output to denote a new line if insertNewLines is true. The default is 10 to represent the line feed \n.

Constructor detail
Base64Encoder()constructor
public function Base64Encoder()

Constructor.

Method detail
encode()method
public function encode(data:String, offset:uint = 0, length:uint = 0):void

Encodes the characters of a String in Base64 and adds the result to an internal buffer. Subsequent calls to this method add on to the internal buffer. After all data have been encoded, call toString() to obtain a Base64 encoded String.

Parameters
data:String — The String to encode.
 
offset:uint (default = 0) — The character position from which to start encoding.
 
length:uint (default = 0) — The number of characters to encode from the offset.
encodeBytes()method 
public function encodeBytes(data:ByteArray, offset:uint = 0, length:uint = 0):void

Encodes a ByteArray in Base64 and adds the result to an internal buffer. Subsequent calls to this method add on to the internal buffer. After all data have been encoded, call toString() to obtain a Base64 encoded String.

Parameters
data:ByteArray — The ByteArray to encode.
 
offset:uint (default = 0) — The index from which to start encoding.
 
length:uint (default = 0) — The number of bytes to encode from the offset.
encodeUTFBytes()method 
public function encodeUTFBytes(data:String):void

Encodes the UTF-8 bytes of a String in Base64 and adds the result to an internal buffer. The UTF-8 information does not contain a length prefix. Subsequent calls to this method add on to the internal buffer. After all data have been encoded, call toString() to obtain a Base64 encoded String.

Parameters
data:String — The String to encode.
reset()method 
public function reset():void

Clears all buffers and resets the encoder to its initial state.

toString()method 
public function toString():String

Returns the current buffer as a Base64 encoded String. Note that calling this method also clears the buffer and resets the encoder to its initial state.

Returns
String — The Base64 encoded String.
Constant detail
CHARSET_UTF_8constant
public static const CHARSET_UTF_8:String = "UTF-8"



Copyright 2011 IncrediBots.