org.jqurantree.arabic
Enum DiacriticType

java.lang.Object
  extended by java.lang.Enum<DiacriticType>
      extended by org.jqurantree.arabic.DiacriticType
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<DiacriticType>

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

The DiacriticType enumeration specifies the type of diaciritcs attached to an ArabicCharacter, such as Fatha or Kasra.

Author:
Kais Dukes

Enum Constant Summary
AlifKhanjareeya
          Superscript Alif.
Damma
          Diacritic above a character.
Dammatan
          Double Damma.
Fatha
          Diacritic above a character.
Fathatan
          Double Fatha.
HamzaAbove
          Hamza above a character.
HamzaBelow
          Hamza below a character.
HamzatWasl
          Diacritic above an Alif.
Kasra
          Diacritic below a character.
Kasratan
          Double Kasra.
Maddah
          Diacritic above a character.
Shadda
          Diacritic above a character.
Sukun
          Diacritic above a character.
 
Field Summary
static DiacriticType[] values
          An ordered array of diacritic types.
 
Method Summary
static DiacriticType valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static DiacriticType[] 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

Fatha

public static final DiacriticType Fatha
Diacritic above a character.


Damma

public static final DiacriticType Damma
Diacritic above a character.


Kasra

public static final DiacriticType Kasra
Diacritic below a character.


Fathatan

public static final DiacriticType Fathatan
Double Fatha.


Dammatan

public static final DiacriticType Dammatan
Double Damma.


Kasratan

public static final DiacriticType Kasratan
Double Kasra.


Shadda

public static final DiacriticType Shadda
Diacritic above a character.


Sukun

public static final DiacriticType Sukun
Diacritic above a character.


Maddah

public static final DiacriticType Maddah
Diacritic above a character.


HamzaAbove

public static final DiacriticType HamzaAbove
Hamza above a character.


HamzaBelow

public static final DiacriticType HamzaBelow
Hamza below a character.


HamzatWasl

public static final DiacriticType HamzatWasl
Diacritic above an Alif.


AlifKhanjareeya

public static final DiacriticType AlifKhanjareeya
Superscript Alif.

Field Detail

values

public static DiacriticType[] values
An ordered array of diacritic types.

Method Detail

values

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

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

valueOf

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


Copyright© Kais Dukes, 2009. All Rights Reserved.