Coverage Report - org.as3coreaddendum.system.comparators.IndexComparator
 
Classes in this File Line Coverage Branch Coverage Complexity
IndexComparator
100%
8/8
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  
 {
 32  
         import org.as3coreaddendum.system.IComparator;
 33  
         import org.as3coreaddendum.system.IIndexable;
 34  
 
 35  
         /**
 36  
          * A comparator for objects that implements the <code>org.as3coreaddendum.system.IIndexable</code> interface, comparing the <code>index</code> property.
 37  
          * 
 38  
          * @see org.as3coreaddendum.system.IComparator IComparator
 39  
          * @see org.as3coreaddendum.system.IIndexable IIndexable
 40  
          * @author Flávio Silva
 41  
          */
 42  
         public class IndexComparator implements IComparator
 43  
         {
 44  
                 private var _numberComparator: NumberComparator;
 45  
                 
 46  
                 /**
 47  
                  * Constructor, creates a new <code>IndexComparator</code> object.
 48  
                  */
 49  
                 public function IndexComparator()
 50  1
                 {
 51  1
                         _numberComparator = new NumberComparator();
 52  1
                 }
 53  
 
 54  
                 /**
 55  
                  * Performs the comparison between the two arguments.
 56  
                  * 
 57  
                  * @param         o1        The first <code>Number</code> object to be compared.
 58  
                  * @param         o2        The second <code>Number</code> object to be compared.
 59  
                  * @throws         ArgumentError         if any of the arguments does not implements the <code>IIndexable</code> interface.
 60  
                  * @return         A negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second.
 61  
                  */
 62  
                 public function compare(o1:*, o2:*): int
 63  
                 {
 64  1
                         if (!(o1 is IIndexable) || !(o2 is IIndexable)) throw new ArgumentError("Both arguments must implements the 'IIndexable' interface.");
 65  
                         
 66  1
                         var i1:int = (o1 as IIndexable).index;
 67  1
                         var i2:int = (o2 as IIndexable).index;
 68  
                         
 69  1
                         return _numberComparator.compare(i1, i2);
 70  
                 }
 71  
 
 72  
         }
 73  
 
 74  
 }