Coverage Report - org.apache.commons.lang3.CharSetUtils
 
Classes in this File Line Coverage Branch Coverage Complexity
CharSetUtils
100%
53/53
97%
47/48
5
 
 1  
 /*
 2  
  * Licensed to the Apache Software Foundation (ASF) under one or more
 3  
  * contributor license agreements.  See the NOTICE file distributed with
 4  
  * this work for additional information regarding copyright ownership.
 5  
  * The ASF licenses this file to You under the Apache License, Version 2.0
 6  
  * (the "License"); you may not use this file except in compliance with
 7  
  * the License.  You may obtain a copy of the License at
 8  
  * 
 9  
  *      http://www.apache.org/licenses/LICENSE-2.0
 10  
  * 
 11  
  * Unless required by applicable law or agreed to in writing, software
 12  
  * distributed under the License is distributed on an "AS IS" BASIS,
 13  
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 14  
  * See the License for the specific language governing permissions and
 15  
  * limitations under the License.
 16  
  */
 17  
 package org.apache.commons.lang3;
 18  
 
 19  
 /**
 20  
  * <p>Operations on {@code CharSet} instances.</p>
 21  
  *
 22  
  * <p>This class handles {@code null} input gracefully.
 23  
  * An exception will not be thrown for a {@code null} input.
 24  
  * Each method documents its behaviour in more detail.</p>
 25  
  * 
 26  
  * <p>#ThreadSafe#</p>
 27  
  * @see CharSet
 28  
  * @since 1.0
 29  
  * @version $Id: CharSetUtils.java 1552679 2013-12-20 14:08:03Z britter $
 30  
  */
 31  
 public class CharSetUtils {
 32  
 
 33  
     /**
 34  
      * <p>CharSetUtils instances should NOT be constructed in standard programming.
 35  
      * Instead, the class should be used as {@code CharSetUtils.evaluateSet(null);}.</p>
 36  
      *
 37  
      * <p>This constructor is public to permit tools that require a JavaBean instance
 38  
      * to operate.</p>
 39  
      */
 40  
     public CharSetUtils() {
 41  1
       super();
 42  1
     }
 43  
 
 44  
     // Squeeze
 45  
     //-----------------------------------------------------------------------
 46  
     /**
 47  
      * <p>Squeezes any repetitions of a character that is mentioned in the
 48  
      * supplied set.</p>
 49  
      *
 50  
      * <pre>
 51  
      * CharSetUtils.squeeze(null, *)        = null
 52  
      * CharSetUtils.squeeze("", *)          = ""
 53  
      * CharSetUtils.squeeze(*, null)        = *
 54  
      * CharSetUtils.squeeze(*, "")          = *
 55  
      * CharSetUtils.squeeze("hello", "k-p") = "helo"
 56  
      * CharSetUtils.squeeze("hello", "a-e") = "hello"
 57  
      * </pre>
 58  
      *
 59  
      * @see CharSet#getInstance(java.lang.String...) for set-syntax.
 60  
      * @param str  the string to squeeze, may be null
 61  
      * @param set  the character set to use for manipulation, may be null
 62  
      * @return the modified String, {@code null} if null string input
 63  
      */
 64  
     public static String squeeze(final String str, final String... set) {
 65  27
         if (StringUtils.isEmpty(str) || deepEmpty(set)) {
 66  18
             return str;
 67  
         }
 68  9
         final CharSet chars = CharSet.getInstance(set);
 69  9
         final StringBuilder buffer = new StringBuilder(str.length());
 70  9
         final char[] chrs = str.toCharArray();
 71  9
         final int sz = chrs.length;
 72  9
         char lastChar = ' ';
 73  9
         char ch = ' ';
 74  62
         for (int i = 0; i < sz; i++) {
 75  53
             ch = chrs[i];
 76  
             // Compare with contains() last for performance.
 77  53
             if (ch == lastChar && i != 0 && chars.contains(ch)) {
 78  12
                 continue;
 79  
             }
 80  41
             buffer.append(ch);
 81  41
             lastChar = ch;
 82  
         }
 83  9
         return buffer.toString();
 84  
     }
 85  
 
 86  
     // ContainsAny
 87  
     //-----------------------------------------------------------------------
 88  
     /**
 89  
      * <p>Takes an argument in set-syntax, see evaluateSet,
 90  
      * and identifies whether any of the characters are present in the specified string.</p>
 91  
      *
 92  
      * <pre>
 93  
      * CharSetUtils.containsAny(null, *)        = false
 94  
      * CharSetUtils.containsAny("", *)          = false
 95  
      * CharSetUtils.containsAny(*, null)        = false
 96  
      * CharSetUtils.containsAny(*, "")          = false
 97  
      * CharSetUtils.containsAny("hello", "k-p") = true
 98  
      * CharSetUtils.containsAny("hello", "a-d") = false
 99  
      * </pre>
 100  
      *
 101  
      * @see CharSet#getInstance(java.lang.String...) for set-syntax.
 102  
      * @param str  String to look for characters in, may be null
 103  
      * @param set  String[] set of characters to identify, may be null
 104  
      * @return whether or not the characters in the set are in the primary string
 105  
      * @since 3.2
 106  
      */
 107  
     public static boolean containsAny(final String str, final String... set) {
 108  26
         if (StringUtils.isEmpty(str) || deepEmpty(set)) {
 109  19
             return false;
 110  
         }
 111  7
         final CharSet chars = CharSet.getInstance(set);
 112  17
         for (final char c : str.toCharArray()) {
 113  16
             if (chars.contains(c)) {
 114  6
                 return true;
 115  
             }
 116  
         }
 117  1
         return false;
 118  
     }
 119  
 
 120  
     // Count
 121  
     //-----------------------------------------------------------------------
 122  
     /**
 123  
      * <p>Takes an argument in set-syntax, see evaluateSet,
 124  
      * and returns the number of characters present in the specified string.</p>
 125  
      *
 126  
      * <pre>
 127  
      * CharSetUtils.count(null, *)        = 0
 128  
      * CharSetUtils.count("", *)          = 0
 129  
      * CharSetUtils.count(*, null)        = 0
 130  
      * CharSetUtils.count(*, "")          = 0
 131  
      * CharSetUtils.count("hello", "k-p") = 3
 132  
      * CharSetUtils.count("hello", "a-e") = 1
 133  
      * </pre>
 134  
      *
 135  
      * @see CharSet#getInstance(java.lang.String...) for set-syntax.
 136  
      * @param str  String to count characters in, may be null
 137  
      * @param set  String[] set of characters to count, may be null
 138  
      * @return the character count, zero if null string input
 139  
      */
 140  
     public static int count(final String str, final String... set) {
 141  26
         if (StringUtils.isEmpty(str) || deepEmpty(set)) {
 142  19
             return 0;
 143  
         }
 144  7
         final CharSet chars = CharSet.getInstance(set);
 145  7
         int count = 0;
 146  42
         for (final char c : str.toCharArray()) {
 147  35
             if (chars.contains(c)) {
 148  15
                 count++;
 149  
             }
 150  
         }
 151  7
         return count;
 152  
     }
 153  
 
 154  
     // Keep
 155  
     //-----------------------------------------------------------------------
 156  
     /**
 157  
      * <p>Takes an argument in set-syntax, see evaluateSet,
 158  
      * and keeps any of characters present in the specified string.</p>
 159  
      *
 160  
      * <pre>
 161  
      * CharSetUtils.keep(null, *)        = null
 162  
      * CharSetUtils.keep("", *)          = ""
 163  
      * CharSetUtils.keep(*, null)        = ""
 164  
      * CharSetUtils.keep(*, "")          = ""
 165  
      * CharSetUtils.keep("hello", "hl")  = "hll"
 166  
      * CharSetUtils.keep("hello", "le")  = "ell"
 167  
      * </pre>
 168  
      *
 169  
      * @see CharSet#getInstance(java.lang.String...) for set-syntax.
 170  
      * @param str  String to keep characters from, may be null
 171  
      * @param set  String[] set of characters to keep, may be null
 172  
      * @return the modified String, {@code null} if null string input
 173  
      * @since 2.0
 174  
      */
 175  
     public static String keep(final String str, final String... set) {
 176  29
         if (str == null) {
 177  6
             return null;
 178  
         }
 179  23
         if (str.isEmpty() || deepEmpty(set)) {
 180  12
             return StringUtils.EMPTY;
 181  
         }
 182  11
         return modify(str, set, true);
 183  
     }
 184  
 
 185  
     // Delete
 186  
     //-----------------------------------------------------------------------
 187  
     /**
 188  
      * <p>Takes an argument in set-syntax, see evaluateSet,
 189  
      * and deletes any of characters present in the specified string.</p>
 190  
      *
 191  
      * <pre>
 192  
      * CharSetUtils.delete(null, *)        = null
 193  
      * CharSetUtils.delete("", *)          = ""
 194  
      * CharSetUtils.delete(*, null)        = *
 195  
      * CharSetUtils.delete(*, "")          = *
 196  
      * CharSetUtils.delete("hello", "hl")  = "eo"
 197  
      * CharSetUtils.delete("hello", "le")  = "ho"
 198  
      * </pre>
 199  
      *
 200  
      * @see CharSet#getInstance(java.lang.String...) for set-syntax.
 201  
      * @param str  String to delete characters from, may be null
 202  
      * @param set  String[] set of characters to delete, may be null
 203  
      * @return the modified String, {@code null} if null string input
 204  
      */
 205  
     public static String delete(final String str, final String... set) {
 206  29
         if (StringUtils.isEmpty(str) || deepEmpty(set)) {
 207  20
             return str;
 208  
         }
 209  9
         return modify(str, set, false);
 210  
     }
 211  
 
 212  
     //-----------------------------------------------------------------------
 213  
     /**
 214  
      * Implementation of delete and keep
 215  
      *
 216  
      * @param str String to modify characters within
 217  
      * @param set String[] set of characters to modify
 218  
      * @param expect whether to evaluate on match, or non-match
 219  
      * @return the modified String, not null
 220  
      */
 221  
     private static String modify(final String str, final String[] set, final boolean expect) {
 222  20
         final CharSet chars = CharSet.getInstance(set);
 223  20
         final StringBuilder buffer = new StringBuilder(str.length());
 224  20
         final char[] chrs = str.toCharArray();
 225  20
         final int sz = chrs.length;
 226  118
         for(int i=0; i<sz; i++) {
 227  98
             if(chars.contains(chrs[i]) == expect) {
 228  55
                 buffer.append(chrs[i]);
 229  
             }
 230  
         }
 231  20
         return buffer.toString();
 232  
     }
 233  
 
 234  
     /** 
 235  
      * Determines whether or not all the Strings in an array are 
 236  
      * empty or not.
 237  
      *
 238  
      * @param strings String[] whose elements are being checked for emptiness
 239  
      * @return whether or not the String is empty
 240  
      */
 241  
     private static boolean deepEmpty(final String[] strings) {
 242  72
         if (strings != null) {
 243  86
             for (final String s : strings) {
 244  62
                 if (StringUtils.isNotEmpty(s)) {
 245  43
                     return false;
 246  
                 }
 247  
             }
 248  
         }
 249  29
         return true;
 250  
     }
 251  
 }