EncodingType (JQuranTree API Documentation)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD

DETAIL: ENUM CONSTANTS | FIELD | METHOD

org.jqurantree.arabic.encoding
Enum EncodingType

java.lang.Object
  java.lang.Enum<EncodingType>
      org.jqurantree.arabic.encoding.EncodingType

All Implemented Interfaces:: java.io.Serializable, java.lang.Comparable<EncodingType>

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

The EncodingType enumeration specifies which encoding scheme to use when encoding or decoding ArabicText.

Author:: Kais Dukes

Enum Constant Summary
`Buckwalter` Buckwalter transliteration, see `BuckwalterEncoder`.
`None` No encoding scheme.
`Simple` Simple encoding, see `SimpleEncoder`.
`Unicode` Unicode encoding, see `UnicodeEncoder`.

Method Summary
`static EncodingType`	`valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
`static EncodingType[]`	`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

None

public static final EncodingType None

No encoding scheme.

Simple

public static final EncodingType Simple

Simple encoding, see SimpleEncoder.

Unicode

public static final EncodingType Unicode

Unicode encoding, see UnicodeEncoder.

Buckwalter

public static final EncodingType Buckwalter

Buckwalter transliteration, see BuckwalterEncoder.

Method Detail

values

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

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

valueOf

public static EncodingType 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