Packageorg.as3coreaddendum.system.comparators
Classpublic class AlphabeticalComparison
InheritanceAlphabeticalComparison Inheritance Enum Inheritance Object

The enumeration class that defines the acceptable values for the AlphabeticalComparator.

This is a type-safe enumeration class, which means there is no possibility of creating instances externally. All acceptable values will be created automaticaly by this class internaly, through its constants.



Public Properties
 PropertyDefined By
 Inheritedname : String
[read-only] The name of this enum constant exactly as supplied by the constructor.
Enum
 Inheritedordinal : int
[read-only] The ordinal of this enumeration constant (its position in its enum declaration, where the initial constant is assigned an ordinal of zero).
Enum
Public Methods
 MethodDefined By
  
AlphabeticalComparison(name:String, ordinal:int)
Constructor, creates a new AlphabeticalComparison object.
AlphabeticalComparison
 Inherited
compareTo(o:*):int
Compares this enum with the specified object for order.
Enum
 Inherited
equals(other:*):Boolean
Compares the target object for equality with this object.
Enum
 Inherited
toSource():String
Returns the source code String representation of the object.
Enum
 Inherited
toString():String
Returns the name of this enum constant, as contained in the declaration.
Enum
 Inherited
valueOf():int
Returns the primitive value of the object.
Enum
Public Constants
 ConstantDefined By
  CASE_INSENSITIVE : AlphabeticalComparison
[static] Defines the constant which indicates that the comparison should ignore case.
AlphabeticalComparison
  LOWER_CASE_FIRST : AlphabeticalComparison
[static] Defines the constant which indicates that the comparison should return lower case first.
AlphabeticalComparison
  UPPER_CASE_FIRST : AlphabeticalComparison
[static] Defines the constant which indicates that the comparison should return upper case first.
AlphabeticalComparison
Constructor Detail
AlphabeticalComparison()Constructor
public function AlphabeticalComparison(name:String, ordinal:int)

Constructor, creates a new AlphabeticalComparison object.

Parameters
name:String — The name of this enumeration constant.
 
ordinal:int — The ordinal of this enumeration constant, that is its position in the enum declaration (where the initial constant is assigned an ordinal of zero).

Throws
IllegalOperationError — If there is an attempt to instantiation outside the internal code of this class. All acceptable values will be created automaticaly by this class internaly, through the constants. There's no possibility to use this constructor externally.
Constant Detail
CASE_INSENSITIVEConstant
public static const CASE_INSENSITIVE:AlphabeticalComparison

Defines the constant which indicates that the comparison should ignore case.

LOWER_CASE_FIRSTConstant 
public static const LOWER_CASE_FIRST:AlphabeticalComparison

Defines the constant which indicates that the comparison should return lower case first.

UPPER_CASE_FIRSTConstant 
public static const UPPER_CASE_FIRST:AlphabeticalComparison

Defines the constant which indicates that the comparison should return upper case first.