Encoding

Overview

Base class for encodings from byte arrays to string

Location

 

constructor    (declared in Object)

 

constructor

 

Encoding()

 

init()

 

Encoding()

 

Sub New()

ASCII

ASCII encoding.

 

class property ASCII: Encoding read write;

 

class Encoding ASCII { get; set; }

 

static var ASCII: Encoding { get{} set{} }

 

class Encoding ASCII { __get; __set; }

 

Shared Property ASCII() As Encoding

Equals  virtual    (declared in Object)

 

method Equals(aOther: Object): Boolean

 

Boolean Equals(Object aOther)

 

func Equals(_ aOther: Object) -> Boolean

 

Boolean Equals(Object aOther)

 

Function Equals(aOther As Object) As Boolean

Parameters:

  • aOther:

Finalize  protected virtual    (declared in Object)

 

method Finalize

 

void Finalize()

 

func Finalize()

 

void Finalize()

 

Sub Finalize()

GetBytes

call this to convert a string to a byte array. aGenerateBOM can be used to insert a byte order marker.

 

method GetBytes(aValue: String; aGenerateBOM: Boolean): not nullable array of Byte

 

Byte[]! GetBytes(String aValue, Boolean aGenerateBOM)

 

func GetBytes(_ aValue: String, _ aGenerateBOM: Boolean) -> Byte...

 

Byte[] GetBytes(String aValue, Boolean aGenerateBOM)

 

Function GetBytes(aValue As String, aGenerateBOM As Boolean) As Byte()

Parameters:

  • aValue:
  • aGenerateBOM:

GetHashCode  virtual    (declared in Object)

Returns a hashcode for this object. Overriden implementations should make sure that the number returned here is constant given the same object.

 

method GetHashCode: Int32

 

Int32 GetHashCode()

 

func GetHashCode() -> Int32

 

Int32 GetHashCode()

 

Function GetHashCode() As Int32

GetString (array of Byte, Boolean): not nullable String

Convert a byte array to string.

 

method GetString(aValue: array of Byte; aGenerateBOM: Boolean): not nullable String

 

String! GetString(Byte[] aValue, Boolean aGenerateBOM)

 

func GetString(_ aValue: Byte..., _ aGenerateBOM: Boolean) -> String

 

String GetString(Byte[] aValue, Boolean aGenerateBOM)

 

Function GetString(aValue As Byte(), aGenerateBOM As Boolean) As String

Parameters:

  • aValue:
  • aGenerateBOM:

GetString (array of Byte, Int64, Int64, Boolean): not nullable String

Convert a byte array to string.

 

method GetString(aValue: array of Byte; aOffset: Int64; aCount: Int64; aGenerateBOM: Boolean): not nullable String

 

String! GetString(Byte[] aValue, Int64 aOffset, Int64 aCount, Boolean aGenerateBOM)

 

func GetString(_ aValue: Byte..., _ aOffset: Int64, _ aCount: Int64, _ aGenerateBOM: Boolean) -> String

 

String GetString(Byte[] aValue, Int64 aOffset, Int64 aCount, Boolean aGenerateBOM)

 

Function GetString(aValue As Byte(), aOffset As Int64, aCount As Int64, aGenerateBOM As Boolean) As String

Parameters:

  • aValue:
  • aOffset:
  • aCount:
  • aGenerateBOM:

GetType    (declared in Object)

Returns the actual type of this class

 

method GetType: Type

 

Type GetType()

 

func GetType() -> Type

 

Type GetType()

 

Function GetType() As Type

Name

Name of this encoding.

 

property Name: not nullable String read;

 

String! Name { get; }

 

var Name: String { get{} }

 

String Name { __get; }

 

ReadOnly Property Name() As String

ReferenceEquals    (declared in Object)

Compares two references for equivalence (even if they have an equals operator)

 

class method ReferenceEquals(a: Object; b: Object): Boolean

 

static Boolean ReferenceEquals(Object a, Object b)

 

static func ReferenceEquals(_ a: Object, _ b: Object) -> Boolean

 

static Boolean ReferenceEquals(Object a, Object b)

 

Shared Function ReferenceEquals(a As Object, b As Object) As Boolean

Parameters:

  • a: left value
  • b: right value

ToString  virtual    (declared in Object)

Gets the string representation of this method.

 

method ToString: String

 

String ToString()

 

func ToString() -> String

 

String ToString()

 

Function ToString() As String

UTF16

UTF16 encoding.

 

class property UTF16: Encoding read write;

 

class Encoding UTF16 { get; set; }

 

static var UTF16: Encoding { get{} set{} }

 

class Encoding UTF16 { __get; __set; }

 

Shared Property UTF16() As Encoding

UTF16BE

UTF16 encoding (big endian).

 

class property UTF16BE: Encoding read write;

 

class Encoding UTF16BE { get; set; }

 

static var UTF16BE: Encoding { get{} set{} }

 

class Encoding UTF16BE { __get; __set; }

 

Shared Property UTF16BE() As Encoding

UTF16LE

UTF16 encoding (little endian).

 

class property UTF16LE: Encoding read write;

 

class Encoding UTF16LE { get; set; }

 

static var UTF16LE: Encoding { get{} set{} }

 

class Encoding UTF16LE { __get; __set; }

 

Shared Property UTF16LE() As Encoding

UTF32

UTF32 encoding.

 

class property UTF32: Encoding read write;

 

class Encoding UTF32 { get; set; }

 

static var UTF32: Encoding { get{} set{} }

 

class Encoding UTF32 { __get; __set; }

 

Shared Property UTF32() As Encoding

UTF32BE

UTF16 encoding (big endian).

 

class property UTF32BE: Encoding read write;

 

class Encoding UTF32BE { get; set; }

 

static var UTF32BE: Encoding { get{} set{} }

 

class Encoding UTF32BE { __get; __set; }

 

Shared Property UTF32BE() As Encoding

UTF32LE

UTF16 encoding (little endian).

 

class property UTF32LE: Encoding read write;

 

class Encoding UTF32LE { get; set; }

 

static var UTF32LE: Encoding { get{} set{} }

 

class Encoding UTF32LE { __get; __set; }

 

Shared Property UTF32LE() As Encoding

UTF8

UTF8 encoding.

 

class property UTF8: Encoding read write;

 

class Encoding UTF8 { get; set; }

 

static var UTF8: Encoding { get{} set{} }

 

class Encoding UTF8 { __get; __set; }

 

Shared Property UTF8() As Encoding

 

Name

Name of this encoding.

 

property Name: not nullable String read;

 

String! Name { get; }

 

var Name: String { get{} }

 

String Name { __get; }

 

ReadOnly Property Name() As String

ASCII

ASCII encoding.

 

class property ASCII: Encoding read write;

 

class Encoding ASCII { get; set; }

 

static var ASCII: Encoding { get{} set{} }

 

class Encoding ASCII { __get; __set; }

 

Shared Property ASCII() As Encoding

UTF16

UTF16 encoding.

 

class property UTF16: Encoding read write;

 

class Encoding UTF16 { get; set; }

 

static var UTF16: Encoding { get{} set{} }

 

class Encoding UTF16 { __get; __set; }

 

Shared Property UTF16() As Encoding

UTF16BE

UTF16 encoding (big endian).

 

class property UTF16BE: Encoding read write;

 

class Encoding UTF16BE { get; set; }

 

static var UTF16BE: Encoding { get{} set{} }

 

class Encoding UTF16BE { __get; __set; }

 

Shared Property UTF16BE() As Encoding

UTF16LE

UTF16 encoding (little endian).

 

class property UTF16LE: Encoding read write;

 

class Encoding UTF16LE { get; set; }

 

static var UTF16LE: Encoding { get{} set{} }

 

class Encoding UTF16LE { __get; __set; }

 

Shared Property UTF16LE() As Encoding

UTF32

UTF32 encoding.

 

class property UTF32: Encoding read write;

 

class Encoding UTF32 { get; set; }

 

static var UTF32: Encoding { get{} set{} }

 

class Encoding UTF32 { __get; __set; }

 

Shared Property UTF32() As Encoding

UTF32BE

UTF16 encoding (big endian).

 

class property UTF32BE: Encoding read write;

 

class Encoding UTF32BE { get; set; }

 

static var UTF32BE: Encoding { get{} set{} }

 

class Encoding UTF32BE { __get; __set; }

 

Shared Property UTF32BE() As Encoding

UTF32LE

UTF16 encoding (little endian).

 

class property UTF32LE: Encoding read write;

 

class Encoding UTF32LE { get; set; }

 

static var UTF32LE: Encoding { get{} set{} }

 

class Encoding UTF32LE { __get; __set; }

 

Shared Property UTF32LE() As Encoding

UTF8

UTF8 encoding.

 

class property UTF8: Encoding read write;

 

class Encoding UTF8 { get; set; }

 

static var UTF8: Encoding { get{} set{} }

 

class Encoding UTF8 { __get; __set; }

 

Shared Property UTF8() As Encoding

 

ReferenceEquals    (declared in Object)

Compares two references for equivalence (even if they have an equals operator)

 

class method ReferenceEquals(a: Object; b: Object): Boolean

 

static Boolean ReferenceEquals(Object a, Object b)

 

static func ReferenceEquals(_ a: Object, _ b: Object) -> Boolean

 

static Boolean ReferenceEquals(Object a, Object b)

 

Shared Function ReferenceEquals(a As Object, b As Object) As Boolean

Parameters:

  • a: left value
  • b: right value

 

constructor    (declared in Object)

 

constructor

 

Encoding()

 

init()

 

Encoding()

 

Sub New()

Equals  virtual    (declared in Object)

 

method Equals(aOther: Object): Boolean

 

Boolean Equals(Object aOther)

 

func Equals(_ aOther: Object) -> Boolean

 

Boolean Equals(Object aOther)

 

Function Equals(aOther As Object) As Boolean

Parameters:

  • aOther:

Finalize  protected virtual    (declared in Object)

 

method Finalize

 

void Finalize()

 

func Finalize()

 

void Finalize()

 

Sub Finalize()

GetBytes

call this to convert a string to a byte array. aGenerateBOM can be used to insert a byte order marker.

 

method GetBytes(aValue: String; aGenerateBOM: Boolean): not nullable array of Byte

 

Byte[]! GetBytes(String aValue, Boolean aGenerateBOM)

 

func GetBytes(_ aValue: String, _ aGenerateBOM: Boolean) -> Byte...

 

Byte[] GetBytes(String aValue, Boolean aGenerateBOM)

 

Function GetBytes(aValue As String, aGenerateBOM As Boolean) As Byte()

Parameters:

  • aValue:
  • aGenerateBOM:

GetHashCode  virtual    (declared in Object)

Returns a hashcode for this object. Overriden implementations should make sure that the number returned here is constant given the same object.

 

method GetHashCode: Int32

 

Int32 GetHashCode()

 

func GetHashCode() -> Int32

 

Int32 GetHashCode()

 

Function GetHashCode() As Int32

GetString (array of Byte, Boolean): not nullable String

Convert a byte array to string.

 

method GetString(aValue: array of Byte; aGenerateBOM: Boolean): not nullable String

 

String! GetString(Byte[] aValue, Boolean aGenerateBOM)

 

func GetString(_ aValue: Byte..., _ aGenerateBOM: Boolean) -> String

 

String GetString(Byte[] aValue, Boolean aGenerateBOM)

 

Function GetString(aValue As Byte(), aGenerateBOM As Boolean) As String

Parameters:

  • aValue:
  • aGenerateBOM:

GetString (array of Byte, Int64, Int64, Boolean): not nullable String

Convert a byte array to string.

 

method GetString(aValue: array of Byte; aOffset: Int64; aCount: Int64; aGenerateBOM: Boolean): not nullable String

 

String! GetString(Byte[] aValue, Int64 aOffset, Int64 aCount, Boolean aGenerateBOM)

 

func GetString(_ aValue: Byte..., _ aOffset: Int64, _ aCount: Int64, _ aGenerateBOM: Boolean) -> String

 

String GetString(Byte[] aValue, Int64 aOffset, Int64 aCount, Boolean aGenerateBOM)

 

Function GetString(aValue As Byte(), aOffset As Int64, aCount As Int64, aGenerateBOM As Boolean) As String

Parameters:

  • aValue:
  • aOffset:
  • aCount:
  • aGenerateBOM:

GetType    (declared in Object)

Returns the actual type of this class

 

method GetType: Type

 

Type GetType()

 

func GetType() -> Type

 

Type GetType()

 

Function GetType() As Type

ToString  virtual    (declared in Object)

Gets the string representation of this method.

 

method ToString: String

 

String ToString()

 

func ToString() -> String

 

String ToString()

 

Function ToString() As String