Coverage Report - org.as3coreaddendum.system.comparators.StringComparator
 
Classes in this File Line Coverage Branch Coverage Complexity
StringComparator
100%
24/24
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  
         import org.as3coreaddendum.system.StringCase;
 33  
 
 34  
         /**
 35  
          * A comparator for <code>String</code> objects.
 36  
          * 
 37  
          * @example
 38  
          * 
 39  
          * <listing version="3.0">
 40  
          * import org.as3coreaddendum.system.comparators.StringComparator;
 41  
          * 
 42  
          * var c1:StringComparator = new StringComparator();
 43  
          * 
 44  
          * c1.compare("comparison", "between");    // 1
 45  
          * c1.compare("between", "comparison");    // -1
 46  
          * c1.compare("between", "strings");       // 1
 47  
          * c1.compare("strings", "between");       // -1
 48  
          * c1.compare("STRINGS", "strings");       // 1
 49  
          * c1.compare("strings", "Strings");       // -1
 50  
          * c1.compare("strings", "strings");       // 0
 51  
          * 
 52  
          * var c2:StringComparator = new StringComparator(false);
 53  
          * 
 54  
          * c2.compare("STRINGS", "strings");    // 0
 55  
          * c2.compare("strings", "Strings");    // 0
 56  
          * c2.compare("between", "strings");    // 1
 57  
          * </listing>
 58  
          * 
 59  
          * @author Flávio Silva
 60  
          */
 61  
         public class StringComparator implements IComparator
 62  
         {
 63  
                 private var _stringCase: StringCase;
 64  
 
 65  
                 /**
 66  
                  * Defines whether case is considered in the comparison.
 67  
                  */
 68  
                 public function get stringCase(): StringCase { return _stringCase; }
 69  
 
 70  
                 public function set stringCase(value:StringCase): void
 71  
                 {
 72  1
                         if (value == null) throw new ArgumentError("The property 'stringCase' must not be 'null'.");
 73  1
                         _stringCase = value;
 74  1
                 }
 75  
 
 76  
                 /**
 77  
                  * Constructor, creates a new <code>StringComparator</code> object.
 78  
                  * 
 79  
                  * @param         stringCase         Indicates whether case sensitivity is considered or not in the comparison.
 80  
                  */
 81  
                 public function StringComparator(stringCase:StringCase)
 82  1
                 {
 83  1
                         this.stringCase = stringCase;
 84  1
                 }
 85  
 
 86  
                 /**
 87  
                  * Performs the comparison between the two arguments.
 88  
                  * 
 89  
                  * @param         o1         The first <code>String</code> object to be compared.
 90  
                  * @param         o2         The second <code>String</code> object to be compared.
 91  
                  * @throws         ArgumentError         if any of the arguments is <code>null</code>.
 92  
                  * @return         A negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second.
 93  
                  */
 94  
                 public function compare(o1:*, o2:*): int
 95  
                 {
 96  1
                         if (o1 == null || o2 == null) throw new ArgumentError("Both arguments must not be 'null'.");
 97  
                         
 98  1
                         o1 = String(o1);
 99  1
                         o2 = String(o2);
 100  
                         
 101  1
                         if (_stringCase == StringCase.INSENSITIVE)
 102  
                         {
 103  1
                                 o1 = (o1 as String).toLowerCase();
 104  1
                                 o2 = (o2 as String).toLowerCase();
 105  
                         }
 106  
                         
 107  1
                         if (o1 == o2)
 108  
                         {
 109  1
                                 return 0;
 110  
                         }
 111  1
                         else if ((o1 as String).length > (o2 as String).length)
 112  
                         {
 113  1
                                 return 1;
 114  
                         }
 115  1
                         else if ((o1 as String).length < (o2 as String).length)
 116  
                         {
 117  1
                                 return -1;
 118  
                         }
 119  
                         else
 120  
                         {
 121  1
                                 var lc:int = (o1 as String).localeCompare(o2);
 122  
                                 
 123  1
                                 if (lc < 0)
 124  
                                 {
 125  1
                                         return 1;
 126  
                                 }
 127  
                                 else
 128  
                                 {
 129  1
                                         return -1;
 130  
                                 }
 131  
                         }
 132  
                 }
 133  
                 
 134  
                 /**
 135  
                  * Returns the string representation of this object.
 136  
                  * 
 137  
                  * @return         the string representation of the this object.
 138  
                  */
 139  
                 public function toString():String
 140  
                 {
 141  1
                         return "[StringComparator: stringCase = " + stringCase + "]";
 142  
                 }
 143  
 
 144  
         }
 145  
 
 146  
 }