com.smsjuice.api.wrapper.domain.model

Enum SMSCharacterEncoding

java.lang.Object

java.lang.Enum<SMSCharacterEncoding>

com.smsjuice.api.wrapper.domain.model.SMSCharacterEncoding

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<SMSCharacterEncoding>

public enum SMSCharacterEncoding
extends java.lang.Enum<SMSCharacterEncoding>

Author:

Wilson Mazaiwana

Enum Constant Summary

Enum Constants

Enum Constant and Description
ASCII
CYRLLIC
JIS
LATIN
LATINHEBREW
SMSC_DEFAULT
UCS2
UNSPEC1
UNSPEC2

Method Summary

Modifier and Type	Method and Description
int	getEncoding()
static SMSCharacterEncoding	instanceFromValue(int encoding) Returns the character encoding to send with the message.
static SMSCharacterEncoding	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static SMSCharacterEncoding[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SMSC_DEFAULT

public static final SMSCharacterEncoding SMSC_DEFAULT

ASCII

public static final SMSCharacterEncoding ASCII

UNSPEC1

public static final SMSCharacterEncoding UNSPEC1

LATIN

public static final SMSCharacterEncoding LATIN

UNSPEC2

public static final SMSCharacterEncoding UNSPEC2

JIS

public static final SMSCharacterEncoding JIS

CYRLLIC

public static final SMSCharacterEncoding CYRLLIC

LATINHEBREW

public static final SMSCharacterEncoding LATINHEBREW

UCS2

public static final SMSCharacterEncoding UCS2

Method Detail

values

public static SMSCharacterEncoding[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (SMSCharacterEncoding c : SMSCharacterEncoding.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static SMSCharacterEncoding valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

instanceFromValue

public static SMSCharacterEncoding instanceFromValue(int encoding)
                                              throws MessageException

Returns the character encoding to send with the message.

Parameters:

encoding - The encoding caluse to use. Recommendation is to use 0, 3 or 8 as values as they are the most commonly used. The default is 0 if one doesn't select which one they want to use, and it usually suffices.

Returns:

The character encoding to send with the message.

Throws:

MessageException - triggered when one tries to instansiate the object with a value less than 0 or grater than 8 .

getEncoding

public int getEncoding()