Coverage Report - org.as3coreaddendum.system.comparators.BooleanComparator
 
Classes in this File Line Coverage Branch Coverage Complexity
BooleanComparator
100%
14/14
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  
 
 34  
         /**
 35  
          * A comparator for <code>Boolean</code> objects.
 36  
          * 
 37  
          * @example
 38  
          * 
 39  
          * <listing version="3.0">
 40  
          * import org.as3coreaddendum.system.comparators.BooleanComparator;
 41  
          * 
 42  
          * var b1:BooleanComparator = new BooleanComparator(BooleanComparison.TRUE_FIRST);
 43  
          * 
 44  
          * b1.compare(true, false);    // -1
 45  
          * b1.compare(false, true);    // 1
 46  
          * 
 47  
          * var b2:BooleanComparator = new BooleanComparator(BooleanComparison.FALSE_FIRST);
 48  
          * 
 49  
          * b2.compare(true, false);    // 1
 50  
          * b2.compare(false, true);    // -1
 51  
          * </listing>
 52  
          * 
 53  
          * @author Flávio Silva
 54  
          */
 55  
         public class BooleanComparator implements IComparator
 56  
         {
 57  
                 private var _comparison: BooleanComparison;
 58  
 
 59  
                 /**
 60  
                  * Defines the type of comparison to be used.
 61  
                  * @throws         ArgumentError If is assigned a <code>null</code> value.
 62  
                  * @see         org.as3coreaddendum.system.comparators.BooleanComparison BooleanComparison
 63  
                  */
 64  
                 public function get comparison(): BooleanComparison { return _comparison; }
 65  
 
 66  
                 public function set comparison(value:BooleanComparison): void
 67  
                 {
 68  1
                         if (value == null) throw new ArgumentError("The property 'comparison' must not be 'null'.");
 69  1
                         _comparison = value;
 70  1
                 }
 71  
 
 72  
                 /**
 73  
                  * Constructor, creates a new <code>BooleanComparator</code> object.
 74  
                  * 
 75  
                  * @param         comparison                Indicates which type of comparison will be used.
 76  
                  * @throws         ArgumentError         If the 'comparison' argument is <code>null</code>.
 77  
                  * @see         org.as3coreaddendum.system.comparators.BooleanComparison BooleanComparison
 78  
                  */
 79  
                 public function BooleanComparator(comparison:BooleanComparison)
 80  1
                 {
 81  1
                         this.comparison = comparison;
 82  1
                 }
 83  
 
 84  
                 /**
 85  
                  * Performs the comparison between the two arguments.
 86  
                  * 
 87  
                  * @param         o1         The first <code>Boolean</code> object to be compared.
 88  
                  * @param         o2         The second <code>Boolean</code> object to be compared.
 89  
                  * @throws         ArgumentError         if any of the arguments are not of type <code>Boolean</code>.
 90  
                  * @return         A negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second.
 91  
                  */
 92  
                 public function compare(o1:*, o2:*): int
 93  
                 {
 94  1
                         if (!(o1 is Boolean) || !(o2 is Boolean)) throw new ArgumentError("Both arguments must be of type 'Boolean'.");
 95  
                         
 96  1
                         if (o1 == o2)
 97  
                         {
 98  1
                                 return 0;
 99  
                         }
 100  1
                         else if (o1 == true && o2 == false)
 101  
                         {
 102  1
                                 return (_comparison == BooleanComparison.TRUE_FIRST) ? -1 : 1;
 103  
                         }
 104  
                         else
 105  
                         {
 106  1
                                 return (_comparison == BooleanComparison.TRUE_FIRST) ? 1 : -1;
 107  
                         }
 108  
                 }
 109  
 
 110  
                 /**
 111  
                  * Returns the string representation of this object.
 112  
                  * 
 113  
                  * @return         the string representation of the this object.
 114  
                  */
 115  
                 public function toString():String
 116  
                 {
 117  1
                         return "[BooleanComparator: comparison = " + comparison + "]";
 118  
                 }
 119  
 
 120  
         }
 121  
 
 122  
 }