EncodingOptions (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 EncodingOptions

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

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

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

The EncodingOptions enumeration specifies which options to use when encoding or decoding ArabicText.

Author:: Kais Dukes

Enum Constant Summary
`CombineAlifWithMaddah` Specifies that an Alif `ArabicCharacter` with an attached Maddah should be combined and encoded into a single output character.

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

CombineAlifWithMaddah

public static final EncodingOptions CombineAlifWithMaddah

Specifies that an Alif ArabicCharacter with an attached Maddah should be combined and encoded into a single output character.

Method Detail

values

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

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

valueOf

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