com.mapcode

Enum Alphabet

java.lang.Object

java.lang.Enum<Alphabet>

com.mapcode.Alphabet

All Implemented Interfaces:

Serializable, Comparable<Alphabet>

public enum Alphabet
extends Enum<Alphabet>

This enum defines all alphabets supported for mapcodes. Note that an alphabet is different from a language or locale. Note that the term alphabet was historically chosen. Script is a more precise term. Mapcodes can be safely converted between alphabets/scripts and fed to the mapcode decoder in the regular ASCII Roman alphabet or any other. The characters within an alphabet/script have been carefully chosen to resemble each other as much as possible.

Enum Constant Summary

Enum Constants

Enum Constant and Description
AMHARIC
ARABIC
ARMENIAN
BENGALI
BURMESE
CHINESE
CYRILLIC
DEVANAGARI
GEORGIAN
GREEK
GUJARATI
GURMUKHI
HEBREW
KANNADA
KATAKANA
KHMER
KOREAN
LAO
MALAYALAM
ODIA
ROMAN
SINHALESE
TAMIL
TELUGU
THAANA
THAI
TIBETAN
TIFINAGH

Method Summary

Modifier and Type	Method and Description
static Alphabet	fromString(String alphaCode) Return alphabet from a string, which needs to be an alphanumeric code.
static Alphabet	valueOf(String name) Returns the enum constant of this type with the specified name.
static Alphabet[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ROMAN

public static final Alphabet ROMAN

GREEK

public static final Alphabet GREEK

CYRILLIC

public static final Alphabet CYRILLIC

HEBREW

public static final Alphabet HEBREW

DEVANAGARI

public static final Alphabet DEVANAGARI

MALAYALAM

public static final Alphabet MALAYALAM

GEORGIAN

public static final Alphabet GEORGIAN

KATAKANA

public static final Alphabet KATAKANA

THAI

public static final Alphabet THAI

LAO

public static final Alphabet LAO

ARMENIAN

public static final Alphabet ARMENIAN

BENGALI

public static final Alphabet BENGALI

GURMUKHI

public static final Alphabet GURMUKHI

TIBETAN

public static final Alphabet TIBETAN

ARABIC

public static final Alphabet ARABIC

KOREAN

public static final Alphabet KOREAN

BURMESE

public static final Alphabet BURMESE

KHMER

public static final Alphabet KHMER

SINHALESE

public static final Alphabet SINHALESE

THAANA

public static final Alphabet THAANA

CHINESE

public static final Alphabet CHINESE

TIFINAGH

public static final Alphabet TIFINAGH

TAMIL

public static final Alphabet TAMIL

AMHARIC

public static final Alphabet AMHARIC

TELUGU

public static final Alphabet TELUGU

ODIA

public static final Alphabet ODIA

KANNADA

public static final Alphabet KANNADA

GUJARATI

public static final Alphabet GUJARATI

Method Detail

values

public static Alphabet[] 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 (Alphabet c : Alphabet.values())
    System.out.println(c);

Returns:

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

valueOf

public static Alphabet valueOf(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:

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

NullPointerException - if the argument is null

fromString

@Nonnull
public static Alphabet fromString(@Nonnull
                                           String alphaCode)
                                    throws UnknownAlphabetException

Return alphabet from a string, which needs to be an alphanumeric code.

Parameters:

alphaCode - Alphabet, alphanumeric code.

Returns:

Alphabet.

Throws:

UnknownAlphabetException - Thrown if incorrect numeric or alphanumeric code.