com.cinterion.io

Class ATStringConverter

java.lang.Object

com.cinterion.io.ATStringConverter

public class ATStringConverter
extends Object

The ATStringConverter class contains conversion functions for easy conversion between Java strings and GSM or UCS2 encoded strings to be used for parameters of several AT commands via the ATCommand class.

See Also:

ATCommand

Constructor Summary

Constructors

Constructor and Description
ATStringConverter()

Method Summary

Methods

Modifier and Type	Method and Description
static String	GSM2Java(String gsmStr) Convert GSM encoded string into a Java string, "\xy" character escaping is supported.
static String	GSM2Java(String gsmStr, boolean handleEscaping) Convert GSM encoded string into a Java string, "\xy" character escaping is switchable.
static String	Java2GSM(String str) Converts a Java encoded string into a GSM encoded string.
static String	Java2UCS2Hex(String str) Converts a Java encoded string into a string containing the characters in the UCS2 hex format.
static String	UCS2Hex2Java(String str) Converts a string in the UCS2 hex format into a Java encoded string.

Methods inherited from class java.lang.Object

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

Constructor Detail

ATStringConverter

public ATStringConverter()

Method Detail

Java2GSM

public static String Java2GSM(String str)
                       throws IllegalArgumentException

Converts a Java encoded string into a GSM encoded string.

Parameters:

str - The String instance from Java to be converted.

Returns:

A Java String instance that holds the GSM encoded string.

Throws:

IllegalArgumentException - If one or more characters cannot be mapped to GSM encoding, i.e. a character is not defined within the GSM alphabet.

GSM2Java

public static String GSM2Java(String gsmStr)
                       throws IllegalArgumentException

Convert GSM encoded string into a Java string, "\xy" character escaping is supported.

Parameters:

gsmStr - GSM encoded string to be converted, which may contain "\xy" escape sequences with xy in the range of 0x00 ~ 0x7F, which are converted to single characters.

Returns:

A Java String instance that holds the conversion result.

Throws:

IllegalArgumentException - If one or more characters cannot be mapped from GSM encoding, e.g. a character value was > 0x7F.

GSM2Java

public static String GSM2Java(String gsmStr,
              boolean handleEscaping)
                       throws IllegalArgumentException

Convert GSM encoded string into a Java string, "\xy" character escaping is switchable.

Parameters:

gsmStr - GSM encoded string to be converted.

handleEscaping - "\xy" character escape handling selector

• true: gsmStr may contain "\xy" escape sequences with xy in the range of 0x00 ~ 0x7F, which are converted to single characters.
• false: "\xy" escape sequences whithin gsmStr are not evaluated, i.e. they are printed as these three characters.

Returns:

A Java String instance that holds the conversion result.

Throws:

IllegalArgumentException - If one or more characters cannot be mapped from GSM encoding, e.g. a character value was > 0x7F.

Java2UCS2Hex

public static String Java2UCS2Hex(String str)

Converts a Java encoded string into a string containing the characters in the UCS2 hex format.

Parameters:

str - The String instance from Java to be converted.

Returns:

A Java String instance that holds the UCS2 encoded hex string.

UCS2Hex2Java

public static String UCS2Hex2Java(String str)
                           throws IllegalArgumentException

Converts a string in the UCS2 hex format into a Java encoded string.

Parameters:

str - The UCS2 hex string to be converted.

Returns:

A Java String instance that holds the conversion result.

Throws:

IllegalArgumentException - If the passed string isn't in proper UCS2 hex format.