1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
package Torello.Java;

import java.util.TreeSet;

/**
 * Class String-Character provides an exhaustive-combinatoric suite of methods that extend the
 * basic Java <CODE>String</CODE> methods <CODE>equals, contains, startsWith</CODE> and
 * <CODE>endsWith</CODE>, using Java {@code char} primitives as the comparator element.
 * 
 * <BR /><BR /><EMBED CLASS="external-html" DATA-FILE-ID="STRCH">
 */
@Torello.HTML.Tools.JavaDoc.StaticFunctional
public class StrCh
{
    private StrCh() { }


    // ********************************************************************************************
    // ********************************************************************************************
    // CONTAINS
    // ********************************************************************************************
    // ********************************************************************************************


    /**
     * <EMBED CLASS=defs DATA-DESC='contains at least one' DATA-CI='is'>
     * <EMBED CLASS='external-html' DATA-FILE-ID=STRCHDESC>
     * @param srcStr Any non-null instance of {@code java.lang.String}
     * @param compareChar The {@code char's} used in the comparison against {@code 'srcStr'}
     * @return <EMBED CLASS='external-html' DATA-FILE-ID=STRCHRET>
     * @see #CONTAINS_NAND_OR(boolean, byte, String, char[])
     */
    public static boolean containsOR(String srcStr, char... compareChar)
    { return CONTAINS_NAND_OR(false, OR, srcStr, compareChar); }

    /**
     * <EMBED CLASS=defs DATA-DESC='contains every one' DATA-CI='is'>
     * <EMBED CLASS='external-html' DATA-FILE-ID=STRCHDESC>
     * @param srcStr Any non-null instance of {@code java.lang.String}
     * @param compareChar The {@code char's} used in the comparison against {@code 'srcStr'}
     * @return <EMBED CLASS='external-html' DATA-FILE-ID=STRCHRET>
     * @see #CONTAINS_XOR_AND(boolean, byte, String, char[])
     */
    public static boolean containsAND(String srcStr, char... compareChar)
    { return CONTAINS_XOR_AND(false, AND, srcStr, compareChar); }

    /**
     * <EMBED CLASS=defs DATA-DESC='contains exactly one' DATA-CI='is'>
     * <EMBED CLASS='external-html' DATA-FILE-ID=STRCHDESC>
     * @param srcStr Any non-null instance of {@code java.lang.String}
     * @param compareChar The {@code char's} used in the comparison against {@code 'srcStr'}
     * @return <EMBED CLASS='external-html' DATA-FILE-ID=STRCHRET>
     * <EMBED CLASS='external-html' DATA-FILE-ID=STRCHXORNOTE>
     * @see #CONTAINS_XOR_AND(boolean, byte, String, char[])
     */
    public static boolean containsXOR(String srcStr, char... compareChar)
    { return CONTAINS_XOR_AND(false, XOR, srcStr, compareChar); }

    /**
     * <EMBED CLASS=defs DATA-DESC='does not contain any' DATA-CI='is'>
     * <EMBED CLASS='external-html' DATA-FILE-ID=STRCHDESC>
     * @param srcStr Any non-null instance of {@code java.lang.String}
     * @param compareChar The {@code char's} used in the comparison against {@code 'srcStr'}
     * @return <EMBED CLASS='external-html' DATA-FILE-ID=STRCHRET>
     * @see #CONTAINS_NAND_OR(boolean, byte, String, char[])
     */
    public static boolean containsNAND(String srcStr, char... compareChar)
    { return CONTAINS_NAND_OR(false, NAND, srcStr, compareChar); }

    /**
     * <EMBED CLASS=defs DATA-DESC='contains at least one' DATA-CI='is not'>
     * <EMBED CLASS='external-html' DATA-FILE-ID=STRCHDESC>
     * @param srcStr Any non-null instance of {@code java.lang.String}
     * @param compareChar The {@code char's} used in the comparison against {@code 'srcStr'}
     * @return <EMBED CLASS='external-html' DATA-FILE-ID=STRCHRET>
     * @see #CONTAINS_NAND_OR(boolean, byte, String, char[])
     */
    public static boolean containsOR_CI(String srcStr, char... compareChar)
    { return CONTAINS_NAND_OR(true, OR, srcStr, compareChar); }

    /**
     * <EMBED CLASS=defs DATA-DESC='contains every one' DATA-CI='is not'>
     * <EMBED CLASS='external-html' DATA-FILE-ID=STRCHDESC>
     * @param srcStr Any non-null instance of {@code java.lang.String}
     * @param compareChar The {@code char's} used in the comparison against {@code 'srcStr'}
     * @return <EMBED CLASS='external-html' DATA-FILE-ID=STRCHRET>
     * @see #CONTAINS_XOR_AND(boolean, byte, String, char[])
     */
    public static boolean containsAND_CI(String srcStr, char... compareChar)
    { return CONTAINS_XOR_AND(true, AND, srcStr, compareChar); }

    /**
     * <EMBED CLASS=defs DATA-DESC='contains exactly one' DATA-CI='is not'>
     * <EMBED CLASS='external-html' DATA-FILE-ID=STRCHDESC>
     * @param srcStr Any non-null instance of {@code java.lang.String}
     * @param compareChar The {@code char's} used in the comparison against {@code 'srcStr'}
     * @return <EMBED CLASS='external-html' DATA-FILE-ID=STRCHRET>
     * <EMBED CLASS='external-html' DATA-FILE-ID=STRCHXORNOTE>
     * @see #CONTAINS_XOR_AND(boolean, byte, String, char[])
     */
    public static boolean containsXOR_CI(String srcStr, char... compareChar)
    { return CONTAINS_XOR_AND(true, XOR, srcStr, compareChar); }

    /**
     * <EMBED CLASS=defs DATA-DESC='does not contain any' DATA-CI='is not'>
     * <EMBED CLASS='external-html' DATA-FILE-ID=STRCHDESC>
     * @param srcStr Any non-null instance of {@code java.lang.String}
     * @param compareChar The {@code char's} used in the comparison against {@code 'srcStr'}
     * @return <EMBED CLASS='external-html' DATA-FILE-ID=STRCHRET>
     * @see #CONTAINS_NAND_OR(boolean, byte, String, char[])
     */
    public static boolean containsNAND_CI(String srcStr, char... compareChar)
    { return CONTAINS_NAND_OR(true, NAND, srcStr, compareChar); }


    // ********************************************************************************************
    // ********************************************************************************************
    // STARTS-WITH, ENDS-WITH
    // ********************************************************************************************
    // ********************************************************************************************


    /**
     * <EMBED CLASS=defs DATA-DESC='ends with at least one' DATA-CI='is'>
     * <EMBED CLASS='external-html' DATA-FILE-ID=STRCHDESC>
     * @param srcStr Any non-null instance of {@code java.lang.String}
     * @param compareChar The {@code char's} used in the comparison against {@code 'srcStr'}
     * @return <EMBED CLASS='external-html' DATA-FILE-ID=STRCHRET>
     */
    public static boolean endsWithOR(String srcStr, char... compareChar)
    {
        char c = srcStr.charAt(srcStr.length() - 1);
        for (char c2 : compareChar) if (c2 == c) return true;
        return false;
    }

    /**
     * <EMBED CLASS=defs DATA-DESC='does not end with any' DATA-CI='is'>
     * <EMBED CLASS='external-html' DATA-FILE-ID=STRCHDESC>
     * @param srcStr Any non-null instance of {@code java.lang.String}
     * @param compareChar The {@code char's} used in the comparison against {@code 'srcStr'}
     * @return <EMBED CLASS='external-html' DATA-FILE-ID=STRCHRET>
     */
    public static boolean endsWithNAND(String srcStr, char... compareChar)
    {
        char c = srcStr.charAt(srcStr.length() - 1);
        for (char c2 : compareChar) if (c2 == c) return false;
        return true;
    }

    /**
     * <EMBED CLASS=defs DATA-DESC='starts with at least one' DATA-CI='is'>
     * <EMBED CLASS='external-html' DATA-FILE-ID=STRCHDESC>
     * @param srcStr Any non-null instance of {@code java.lang.String}
     * @param compareChar The {@code char's} used in the comparison against {@code 'srcStr'}
     * @return <EMBED CLASS='external-html' DATA-FILE-ID=STRCHRET>
     */
    public static boolean startsWithOR(String srcStr, char... compareChar)
    {
        char c = srcStr.charAt(0);
        for (char c2 : compareChar) if (c2 == c) return true;
        return false;
    }

    /**
     * <EMBED CLASS=defs DATA-DESC='does not start with any' DATA-CI='is'>
     * <EMBED CLASS='external-html' DATA-FILE-ID=STRCHDESC>
     * @param srcStr Any non-null instance of {@code java.lang.String}
     * @param compareChar The {@code char's} used in the comparison against {@code 'srcStr'}
     * @return <EMBED CLASS='external-html' DATA-FILE-ID=STRCHRET>
     */
    public static boolean startsWithNAND(String srcStr, char... compareChar)
    {
        char c = srcStr.charAt(0);
        for (char c2 : compareChar) if (c2 == c) return false;
        return true;
    }


    // ********************************************************************************************
    // ********************************************************************************************
    // STARTS-WITH, ENDS-WITH - CASE INSENSITIVE
    // ********************************************************************************************
    // ********************************************************************************************


    /**
     * <EMBED CLASS=defs DATA-DESC='ends with at least one' DATA-CI='is not'>
     * <EMBED CLASS='external-html' DATA-FILE-ID=STRCHDESC>
     * @param srcStr Any non-null instance of {@code java.lang.String}
     * @param compareChar The {@code char's} used in the comparison against {@code 'srcStr'}
     * @return <EMBED CLASS='external-html' DATA-FILE-ID=STRCHRET>
     */
    public static boolean endsWithOR_CI(String srcStr, char... compareChar)
    {
        char c = Character.toLowerCase(srcStr.charAt(srcStr.length() - 1));
        for (char c2 : compareChar) if (Character.toLowerCase(c2) == c) return true;
        return false;
    }

    /**
     * <EMBED CLASS=defs DATA-DESC='does not end with any' DATA-CI='is not'>
     * <EMBED CLASS='external-html' DATA-FILE-ID=STRCHDESC>
     * @param srcStr Any non-null instance of {@code java.lang.String}
     * @param compareChar The {@code char's} used in the comparison against {@code 'srcStr'}
     * @return <EMBED CLASS='external-html' DATA-FILE-ID=STRCHRET>
     */
    public static boolean endsWithNAND_CI(String srcStr, char... compareChar)
    {
        char c = Character.toLowerCase(srcStr.charAt(srcStr.length() - 1));
        for (char c2 : compareChar) if (Character.toLowerCase(c2) == c) return false;
        return true;
    }

    /**
     * <EMBED CLASS=defs DATA-DESC='starts at least one' DATA-CI='is not'>
     * <EMBED CLASS='external-html' DATA-FILE-ID=STRCHDESC>
     * @param srcStr Any non-null instance of {@code java.lang.String}
     * @param compareChar The {@code char's} used in the comparison against {@code 'srcStr'}
     * @return <EMBED CLASS='external-html' DATA-FILE-ID=STRCHRET>
     */
    public static boolean startsWithOR_CI(String srcStr, char... compareChar)
    {
        char c = Character.toLowerCase(srcStr.charAt(0));
        for (char c2 : compareChar) if (Character.toLowerCase(c2) == c) return true;
        return false;
    }

    /**
     * <EMBED CLASS=defs DATA-DESC='does not start with any' DATA-CI='is not'>
     * <EMBED CLASS='external-html' DATA-FILE-ID=STRCHDESC>
     * @param srcStr Any non-null instance of {@code java.lang.String}
     * @param compareChar The {@code char's} used in the comparison against {@code 'srcStr'}
     * @return <EMBED CLASS='external-html' DATA-FILE-ID=STRCHRET>
     */
    public static boolean startsWithNAND_CI(String srcStr, char ... compareChar)
    {
        char c = Character.toLowerCase(srcStr.charAt(0));
        for (char c2 : compareChar) if (Character.toLowerCase(c2) == c) return false;
        return true;
    }


    // ********************************************************************************************
    // ********************************************************************************************
    // Single char-primitive methods
    // ********************************************************************************************
    // ********************************************************************************************


    /**
     * Checks whether or not {@code 'srcStr'} <B STYLE='color: red;'>starts-with</B>
     * {@code 'compareChar'}.
     * 
     * <BR /><BR />This method <B STYLE='color: red;'>** is not**</B> case-sensitive.
     * 
     * @param srcStr Any non-null instance of {@code java.lang.String}
     * @param compareChar The {@code char} used in the comparison against {@code 'srcStr'}
     * @return {@code TRUE} if {@code 'srcStr'} begins with {@code 'compareChar'}, ignoring case.
     */
    public static boolean startsWithIgnoreCase(String srcStr, char compareChar)
    { return Character.toLowerCase(srcStr.charAt(0)) == Character.toLowerCase(compareChar); }

    /**
     * Checks whether or not {@code 'srcStr'} <B STYLE='color: red;'>ends-with</B>
     * {@code 'compareChar'}.
     * 
     * <BR /><BR />This method <B STYLE='color: red;'>** is not**</B> case-sensitive.
     * 
     * @param srcStr Any non-null instance of {@code java.lang.String}
     * @param compareChar The {@code char} used in the comparison against {@code 'srcStr'}
     * @return {@code TRUE} if {@code 'srcStr'} ends with {@code 'compareChar'}, ignoring case.
     */
    public static boolean endsWithIgnoreCase(String srcStr, char compareChar)
    {
        return Character.toLowerCase(srcStr.charAt(srcStr.length() - 1)) == 
            Character.toLowerCase(compareChar); 
    }

    /**
     * Checks whether or not {@code 'srcStr'} <B STYLE='color: red;'>contains</B>
     * {@code 'compareChar'}.
     * 
     * <BR /><BR />This method <B STYLE='color: red;'>** is not**</B> case-sensitive.
     * 
     * @param srcStr Any non-null instance of {@code java.lang.String}
     * @param compareChar The {@code char} used in the comparison against {@code 'srcStr'}
     * @return {@code TRUE} if {@code 'srcStr'} begins with {@code 'compareChar'}, ignoring case.
     */
    public static boolean containsIgnoreCase(String srcStr, char compareChar)
    {
        compareChar = Character.toLowerCase(compareChar);

        int len = srcStr.length();

        for (int i=0; i < len; i++)
            if (Character.toLowerCase(srcStr.charAt(i)) == compareChar)
                return true;

        return false;
    }


    // ********************************************************************************************
    // ********************************************************************************************
    // PROTECTED CONTAINS HELPER
    // ********************************************************************************************
    // ********************************************************************************************


    /**
     * Signifies that an {@code 'AND'} operation is required, but only for methods that implement
     * one of the {@code 'contains'} variants.
     */
    protected static final byte AND = 0;

    /**
     * Signifies that an {@code 'AND'} operation is required, but only for methods that implement
     * one of the {@code 'contains'} variants.
     */
    protected static final byte OR = 1;

    /**
     * Signifies that an {@code 'AND'} operation is required, but only for methods that implement
     * one of the {@code 'contains'} variants.
     */
    protected static final byte NAND = 2;

    /**
     * Signifies that an {@code 'AND'} operation is required, but only for methods that implement
     * one of the {@code 'contains'} variants.
     */
    protected static final byte XOR = 3;

    /**
     * A protected helper method for <B>{@code NAND}</B> and <B>{@code OR}</B> 'contains' methods.
     * 
     * <BR /><BR /><B STYLE='color: red;'>NOTE:</B> Does not error check the value passed to
     * {@code 'booleanOperation'}.
     * 
     * @param ignoreCase Whether the comparisons performed should ignore case.
     * @param booleanOperation Accepts only {@link StrCh#NAND} and {@link StrCh#OR}.
     * @param srcStr Any non-null instance of {@code java.lang.String}
     * @param compareChar The {@code char} used in the comparison against {@code 'srcStr'}
     */
    protected static boolean CONTAINS_NAND_OR
        (boolean ignoreCase, byte booleanOperation, String srcStr, char[] compareChar)
    {
        if (ignoreCase)
        {
            char[] temp = new char[compareChar.length];

            for (int i=0; i < compareChar.length; i++)
                temp[i] = Character.toLowerCase(compareChar[i]);

            compareChar = temp;
        }

        int len = srcStr.length();

        for (int i=0; i < len; i++)
        {
            char c = ignoreCase ? Character.toLowerCase(srcStr.charAt(i)) : srcStr.charAt(i);

            for (char c2 : compareChar)

                if (c2 == c)

                    switch(booleanOperation)
                    {
                        case NAND:  return false;
                        case OR:    return true;
                    }
        }

        switch (booleanOperation)
        {
            case NAND:  return true;
            case OR:    return false;
        }

        throw new UnreachableError();
    }

    /**
     * A protected helper method for <B>{@code XOR}</B> and <B>{@code AND}</B> 'contains' methods.
     * 
     * <BR /><BR /><B STYLE='color: red;'>NOTE:</B> Does not error check the value passed to
     * {@code 'booleanOperation'}.
     * 
     * @param ignoreCase Whether the comparisons performed should ignore case.
     * @param booleanOperation Accepts only {@link StrCh#XOR} and {@link StrCh#AND}.
     * @param srcStr Any non-null instance of {@code java.lang.String}
     * @param compareChar The {@code char} used in the comparison against {@code 'srcStr'}
     */
    protected static boolean CONTAINS_XOR_AND
        (boolean ignoreCase, byte booleanOperation, String srcStr, char[] compareChar)
    {
        int count = 0;

        // There is a TreeSet so that multiple instances of the same character ARE NOT CHECKED.
        // Once a character has been found, it is more efficient to stop testing for it at all.

        TreeSet<Character> ts = new TreeSet<>();

        // When building the TreeSet of characters to check, if 'ignoreCase' has been requested,
        // then doing the case-conversion before entering the loop is more efficient.

        if (ignoreCase) for (char c : compareChar) ts.add(Character.toLowerCase(c));
        else            for (char c : compareChar) ts.add(c);

        // Iterate each character in the passed 'srcStr'
        int len = srcStr.length();

        for (int i=0; i < len; i++)
        {
            char c = ignoreCase ? Character.toLowerCase(srcStr.charAt(i)) : srcStr.charAt(i);

            // Iterate each of the remaining compare-characters in the TreeSet.  These characters
            // are removed when matches are found.

            INNER:
            for (char c2 : ts)

                if (c2 == c)
                {
                    ts.remove(c2);

                    switch (booleanOperation)
                    {
                        case AND: if (--count == 0) return true; else break INNER;
                        case XOR: if (++count > 1)  return false; else break INNER;
                    }
                }
        }

        switch (booleanOperation)
        {
            // If the count had reached zero, then true would ALREADY have been returned.
            case AND: return false;

            // Whether or not a match has been found is all that is left to check.
            case XOR: return count == 1;
        }

        throw new UnreachableError();
    }
}