Packagevegas.net
Classpublic class BOM
InheritanceBOM Inheritance Object

The BOM enumeration class. A byte-order mark (BOM) is the Unicode character at code point U+FEFF ("zero-width no-break space") when that character is used to denote the endianness of a string of UCS/Unicode characters encoded in UTF-16 or UTF-32. It is conventionally used as a marker to indicate that text is encoded in UTF-8, UTF-16 or UTF-32.

More informations in Wikipedia : Byte-order mark



Public Properties
 PropertyDefined By
  option : *
[read-only] The optional value of the BOM (only in the BOCU-1 BOM).
BOM
Public Methods
 MethodDefined By
  
BOM(name:String, values:Array = null, option:* = null)
Creates a new BOM instance.
BOM
  
toSource(indent:int = 0):String
Returns the source code String representation of the object.
BOM
  
toString():String
Returns the String representation of the object.
BOM
  
Returns the primitive value of the object.
BOM
Public Constants
 ConstantDefined By
  BOCU_1 : BOM
[static] The BOCU-1 BOM.
BOM
  SCSU : BOM
[static] The SCSU BOM.
BOM
  UTF1 : BOM
[static] The UTF-1 BOM.
BOM
  UTF16_BE : BOM
[static] The UTF-16 (BE) BOM.
BOM
  UTF16_LE : BOM
[static] The UTF-16 (LE) BOM.
BOM
  UTF32_BE : BOM
[static] The UTF-32 (BE) BOM.
BOM
  UTF32_LE : BOM
[static] The UTF-32 (LE) BOM.
BOM
  UTF7 : BOM
[static] The UTF-7 BOM.
BOM
  UTF8 : BOM
[static] The UTF-8 BOM.
BOM
  UTF_EBCDIC : BOM
[static] The UTF-EBCDIC BOM.
BOM
Property Detail
optionproperty
option:*  [read-only]

The optional value of the BOM (only in the BOCU-1 BOM).


Implementation
    public function get option():*
Constructor Detail
BOM()Constructor
public function BOM(name:String, values:Array = null, option:* = null)

Creates a new BOM instance.

Parameters
name:String — The name key of the enumeration.
 
values:Array (default = null) — The Array representation of all values of the BOM enumeration.
 
option:* (default = null)
Method Detail
toSource()method
public function toSource(indent:int = 0):String

Returns the source code String representation of the object.

Parameters

indent:int (default = 0)

Returns
String — the source code String representation of the object.
toString()method 
public function toString():String

Returns the String representation of the object.

Returns
String — the String representation of the object.
valueOf()method 
public function valueOf():*

Returns the primitive value of the object.

Returns
* — the primitive value of the object.
Constant Detail
BOCU_1Constant
public static const BOCU_1:BOM

The BOCU-1 BOM.

More informations in Wikipedia : Binary Ordered Compression for Unicode

SCSUConstant 
public static const SCSU:BOM

The SCSU BOM.

More informations in Wikipedia : Standard Compression Scheme for Unicode

UTF_EBCDICConstant 
public static const UTF_EBCDIC:BOM

The UTF-EBCDIC BOM.

More informations in Wikipedia : UTF-EBCDIC

UTF1Constant 
public static const UTF1:BOM

The UTF-1 BOM.

More informations in Wikipedia : UTF-1

UTF16_BEConstant 
public static const UTF16_BE:BOM

The UTF-16 (BE) BOM.

More informations in Wikipedia : UTF-16/UCS-2

UTF16_LEConstant 
public static const UTF16_LE:BOM

The UTF-16 (LE) BOM.

More informations in Wikipedia : UTF-16/UCS-2

UTF32_BEConstant 
public static const UTF32_BE:BOM

The UTF-32 (BE) BOM.

More informations in Wikipedia : UTF-32/UCS-4

UTF32_LEConstant 
public static const UTF32_LE:BOM

The UTF-32 (LE) BOM.

More informations in Wikipedia : UTF-32/UCS-4

UTF7Constant 
public static const UTF7:BOM

The UTF-7 BOM.

More informations in Wikipedia : UTF-7

UTF8Constant 
public static const UTF8:BOM

The UTF-8 BOM.

More informations in Wikipedia : UTF-8