Guava CharMatcher

1. Remove Special Characters from a String

Let’s start by removing all special characters from a String.

In the following example, we remove all characters that aren’t digit or letter using retainFrom():

@Test
public void whenRemoveSpecialCharacters_thenRemoved(){
    String input = "H*el.lo,}12";
    CharMatcher matcher = CharMatcher.javaLetterOrDigit();
    String result = matcher.retainFrom(input);

    assertEquals("Hello12", result);
}

2. Remove Non ASCII Characters From String

We can also use CharMatcher to remove non ASCII characters from a String as in the following example:

@Test
public void whenRemoveNonASCIIChars_thenRemoved() {
    String input = "あhello₤";

    String result = CharMatcher.ascii().retainFrom(input);
    assertEquals("hello", result);

    result = CharMatcher.inRange('0', 'z').retainFrom(input);
    assertEquals("hello", result);
}

3. Remove Characters Not in the Charset

Now – let’s see how to remove Characters that don’t belong to a given Charset. In the following example – we’ll remove characters that don’t belong to the “cp437” Charset:

@Test
public void whenRemoveCharsNotInCharset_thenRemoved() {
    Charset charset = Charset.forName("cp437");
    CharsetEncoder encoder = charset.newEncoder();

    Predicate<Character> inRange = new Predicate<Character>() {
        @Override
        public boolean apply(Character c) {
            return encoder.canEncode(c);
        }
    };

    String result = CharMatcher.forPredicate(inRange)
                               .retainFrom("helloは");
    assertEquals("hello", result);
}

Note: We used CharsetEncoder to create a Predicate that check if the given Character can be encoded to the given Charset.

4. Validate String

Next – let’s see how to validate a String using CharMatcher.

We can use matchesAllOf() to check if all characters match a condition. And we can make use of matchesNoneOf() to check if a condition doesn’t apply on any of the String characters.

In the following example, we check if our String is lowercase, contains at least one ‘e‘ character and doesn’t contain any digits:

@Test
public void whenValidateString_thenValid(){
    String input = "hello";

    boolean result = CharMatcher.javaLowerCase().matchesAllOf(input);
    assertTrue(result);

    result = CharMatcher.is('e').matchesAnyOf(input);
    assertTrue(result);

    result = CharMatcher.javaDigit().matchesNoneOf(input);
    assertTrue(result);
}

5. Trim String

Now – let’s see how trim a String using CharMatcher.

In the following example, we use trimLeading()trimTrailing and trimFrom() to trim our String:

@Test
public void whenTrimString_thenTrimmed() {
    String input = "---hello,,,";

    String result = CharMatcher.is('-').trimLeadingFrom(input);
    assertEquals("hello,,,", result);

    result = CharMatcher.is(',').trimTrailingFrom(input);
    assertEquals("---hello", result);

    result = CharMatcher.anyOf("-,").trimFrom(input);
    assertEquals("hello", result);
}

6. Collapse a String

Next – let’s see how to collapse a String using CharMatcher.

In the following example, we use collapseFrom() to replace consecutive spaces with ‘‘:

@Test
public void whenCollapseFromString_thenCollapsed() {
    String input = "       hel    lo      ";

    String result = CharMatcher.is(' ').collapseFrom(input, '-');
    assertEquals("-hel-lo-", result);

    result = CharMatcher.is(' ').trimAndCollapseFrom(input, '-');
    assertEquals("hel-lo", result);
}

7. Replace from String

We can use CharMatcher to replace specific characters from a String as in the following example:

@Test
public void whenReplaceFromString_thenReplaced() {
    String input = "apple-banana.";

    String result = CharMatcher.anyOf("-.").replaceFrom(input, '!');
    assertEquals("apple!banana!", result);

    result = CharMatcher.is('-').replaceFrom(input, " and ");
    assertEquals("apple and banana.", result);
}

8. Count Character Occurrences

Finally – let’s see how to count the occurrences of characters using CharMatcher.

In the following example, we count the commas and characters between ‘a‘:’h‘:

@Test
public void whenCountCharInString_thenCorrect() {
    String input = "a, c, z, 1, 2";

    int result = CharMatcher.is(',').countIn(input);
    assertEquals(4, result);

    result = CharMatcher.inRange('a', 'h').countIn(input);
    assertEquals(2, result);
}

9. Conclusion

In this article we illustrated some of the more useful APIs and real-world usage examples of using Guava for Strings.

The full source code is available over on GitHub.

Related posts:

Using Spring ResponseEntity to Manipulate the HTTP Response
Spring Data Java 8 Support
Introduction to Using Thymeleaf in Spring
Netflix Archaius with Various Database Configurations
Giới thiệu luồng vào ra (I/O) trong Java
Hướng dẫn Java Design Pattern – Prototype
Tránh lỗi NullPointerException trong Java như thế nào?
Immutable ArrayList in Java
Spring Data Reactive Repositories with MongoDB
Returning Custom Status Codes from Spring Controllers
Java Program to Implement Euler Circuit Problem
Guide to the Synchronized Keyword in Java
Rest Web service: Filter và Interceptor với Jersey 2.x (P1)
Java Program to Implement Range Tree
Java Program to Implement HashTable API
Java Program to Implement the Program Used in grep/egrep/fgrep
Java Program to Check Whether Graph is DAG
Java Program to subtract two large numbers using Linked Lists
Spring Boot - Cloud Configuration Client
Java Program to Implement Sparse Array
Tránh lỗi ConcurrentModificationException trong Java như thế nào?
Validations for Enum Types
Java Program to Implement Max-Flow Min-Cut Theorem
Error Handling for REST with Spring
Java Program to Find Location of a Point Placed in Three Dimensions Using K-D Trees
New in Spring Security OAuth2 – Verify Claims
Spring Boot: Customize Whitelabel Error Page
Java Program to Implement Slicker Algorithm that avoids Triangulation to Find Area of a Polygon
JUnit 5 @Test Annotation
Spring Boot - CORS Support
Iterating over Enum Values in Java
Java Program to Generate a Graph for a Given Fixed Degree Sequence