Packagesystem.comparators
Classpublic class DateComparator
InheritanceDateComparator Inheritance Object
Implements Comparator

This comparator compare Date objects.

Example :

     import system.comparators.DateComparator;
     
     var comp:DateComparator = new DateComparator() ;
     
     var d1:Date   = new Date(2007, 1, 1) ;
     var d2:Number =  1170284400000 ;
     var d3:Date   = new Date(2007, 2, 2) ;
     var d4:Number = 1172790000000 ;
     
     trace( comp.compare(d1, d1) ) ; // 0
     trace( comp.compare(d1, d2) ) ; // 0
     trace( comp.compare(d2, d1) ) ; // 0
     trace( comp.compare(d1, d3) ) ; // -1
     trace( comp.compare(d1, d4) ) ; // -1
     trace( comp.compare(d3, d1) ) ; // 1
     trace( comp.compare(d4, d1) ) ; // 1
     



Public Methods
 MethodDefined By
  
Creates a new DateComparator instance.
DateComparator
  
compare(o1:*, o2:*, options:* = null):int
Returns an integer value to compare two Date objects.
DateComparator
Constructor Detail
DateComparator()Constructor
public function DateComparator()

Creates a new DateComparator instance.

Method Detail
compare()method
public function compare(o1:*, o2:*, options:* = null):int

Returns an integer value to compare two Date objects.

Parameters

o1:* — the first Date object to compare.
 
o2:* — the second Date object to compare.
 
options:* (default = null)

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.

  • Throws
    ArgumentError — if compare(a, b) and 'a' and 'b' must be Date or uint objects.