Coverage Report - org.as3coreaddendum.system.comparators.DateComparator
 
Classes in this File Line Coverage Branch Coverage Complexity
DateComparator
100%
10/10
N/A
0
 
 1  
 /*
 2  
  * Licensed under the MIT License
 3  
  * 
 4  
  * Copyright 2010 (c) Flávio Silva, http://flsilva.com
 5  
  *
 6  
  * Permission is hereby granted, free of charge, to any person
 7  
  * obtaining a copy of this software and associated documentation
 8  
  * files (the "Software"), to deal in the Software without
 9  
  * restriction, including without limitation the rights to use,
 10  
  * copy, modify, merge, publish, distribute, sublicense, and/or sell
 11  
  * copies of the Software, and to permit persons to whom the
 12  
  * Software is furnished to do so, subject to the following
 13  
  * conditions:
 14  
  *
 15  
  * The above copyright notice and this permission notice shall be
 16  
  * included in all copies or substantial portions of the Software.
 17  
  *
 18  
  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 19  
  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
 20  
  * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 21  
  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
 22  
  * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
 23  
  * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 24  
  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 25  
  * OTHER DEALINGS IN THE SOFTWARE.
 26  
  * 
 27  
  * http://www.opensource.org/licenses/mit-license.php
 28  
  */
 29  
 
 30  1
 package org.as3coreaddendum.system.comparators {
 31  
         import org.as3coreaddendum.system.IComparator;
 32  
 
 33  
         /**
 34  
          * A comparator for <code>Date</code> objects.
 35  
          * 
 36  
          * @example
 37  
          * 
 38  
          * <listing version="3.0">
 39  
          * import org.as3coreaddendum.system.comparators.DateComparator;
 40  
          * 
 41  
          * var c:DateComparator = new DateComparator();
 42  
          * 
 43  
          * var d1:Date = new Date(2010, 04, 09);
 44  
          * var d2:Date = new Date(2010, 04, 10);
 45  
          * var d3:Date = new Date(2009, 04, 10);
 46  
          * var d4:Date = new Date(1980, 01, 15);
 47  
          * 
 48  
          * c.compare(d1, d1)    // 0
 49  
          * c.compare(d1, d2)    // -1
 50  
          * c.compare(d2, d1)    // 1
 51  
          * c.compare(d2, d3)    // 1
 52  
          * c.compare(d3, d2)    // -1
 53  
          * c.compare(d1, d4)    // 1
 54  
          * c.compare(d4, d1)    // -1
 55  
          * 
 56  
          * </listing>
 57  
          * 
 58  
          * @author Flávio Silva
 59  
          */
 60  
         public class DateComparator implements IComparator
 61  
         {
 62  
                 private var _numberComparator: NumberComparator;
 63  
 
 64  
                 /**
 65  
                  * Constructor, creates a new <code>StringComparator</code> object.
 66  
                  */
 67  
                 public function DateComparator()
 68  1
                 {
 69  1
                         _numberComparator = new NumberComparator();
 70  1
                 }
 71  
 
 72  
                 /**
 73  
                  * Performs the comparison between the two arguments.
 74  
                  * 
 75  
                  * @param         o1        The first <code>Date</code> object to be compared.
 76  
                  * @param         o2        The second <code>Date</code> object to be compared.
 77  
                  * @throws         ArgumentError         if any of the arguments is not of type <code>Date</code>.
 78  
                  * @return        A negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second.
 79  
                  */
 80  
                 public function compare(o1:*, o2:*): int
 81  
                 {
 82  1
                         if (!(o1 is Date) || !(o2 is Date)) throw new ArgumentError("Both arguments must be of type 'Date'.");
 83  
                         
 84  1
                         var d1:Date = o1;
 85  1
                         var d2:Date = o2;
 86  
                         
 87  1
                         var n1:Number = d1.valueOf();
 88  1
                         var n2:Number = d2.valueOf();
 89  
                         
 90  1
                         return _numberComparator.compare(n1, n2);
 91  
                 }
 92  
 
 93  
         }
 94  
 
 95  
 }