Packagesystem.comparators
Classpublic class ReverseComparator
InheritanceReverseComparator Inheritance Object
Implements Comparator, Sortable

Reverse a Comparator object. For example if the comparator must return 1 the reverse comparator return -1.

Example :

     import system.comparators.ReverseComparator ;
     import system.comparators.StringComparator ;
     
     var c:StringComparator  = new StringComparator() ;
     var s:ReverseComparator = new ReverseComparator( c ) ;
     
     trace( c.compare( "hello", "world" ) ) ; // -1
     trace( s.compare( "hello", "world" ) ) ; // 1
     



Public Properties
 PropertyDefined By
  comparator : Comparator
Determinates the internal Comparator instance to reverse.
ReverseComparator
Public Methods
 MethodDefined By
  
Creates a new ReverseComparator instance.
ReverseComparator
  
compare(o1:*, o2:*, options:* = null):int
Returns an integer value to compare two objects (reverse the value).
ReverseComparator
Property Detail
comparatorproperty
comparator:Comparator

Determinates the internal Comparator instance to reverse.


Implementation
    public function get comparator():Comparator
    public function set comparator(value:Comparator):void

Throws
ReferenceError — If the 'comparator' property is 'null'.
Constructor Detail
ReverseComparator()Constructor
public function ReverseComparator(comp:Comparator = null)

Creates a new ReverseComparator instance.

Parameters
comp:Comparator (default = null) — the Comparator to be reverse.
Method Detail
compare()method
public function compare(o1:*, o2:*, options:* = null):int

Returns an integer value to compare two objects (reverse the value).

Parameters

o1:* — the first object to compare.
 
o2:* — the second object to compare.
 
options:* (default = null) — An optional object used to compare the two objects.

Returns
int

  • -1 if o1 is "lower" than (less than, before, etc.) o2 ;
  • 1 if o1 is "higher" than (greater than, after, etc.) o2 ;
  • 0 if o1 and o2 are equal.