RegexpClassNameMatcher.java

  1. /*
  2.  * Licensed to the Apache Software Foundation (ASF) under one
  3.  * or more contributor license agreements.  See the NOTICE file
  4.  * distributed with this work for additional information
  5.  * regarding copyright ownership.  The ASF licenses this file
  6.  * to you under the Apache License, Version 2.0 (the
  7.  * "License"); you may not use this file except in compliance
  8.  * with the License.  You may obtain a copy of the License at
  9.  *
  10.  *   http://www.apache.org/licenses/LICENSE-2.0
  11.  *
  12.  * Unless required by applicable law or agreed to in writing,
  13.  * software distributed under the License is distributed on an
  14.  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
  15.  * KIND, either express or implied.  See the License for the
  16.  * specific language governing permissions and limitations
  17.  * under the License.
  18.  */
  19. package org.apache.commons.io.serialization;

  20. import java.util.Objects;
  21. import java.util.regex.Pattern;

  22. /**
  23.  * A {@link ClassNameMatcher} that uses regular expressions.
  24.  * <p>
  25.  * This object is immutable and thread-safe.
  26.  * </p>
  27.  */
  28. final class RegexpClassNameMatcher implements ClassNameMatcher {

  29.     private final Pattern pattern; // Class is thread-safe

  30.     /**
  31.      * Constructs an object based on the specified pattern.
  32.      *
  33.      * @param pattern a pattern for evaluating acceptable class names
  34.      * @throws NullPointerException if {@code pattern} is null
  35.      */
  36.     public RegexpClassNameMatcher(final Pattern pattern) {
  37.         this.pattern = Objects.requireNonNull(pattern, "pattern");
  38.     }

  39.     /**
  40.      * Constructs an object based on the specified regular expression.
  41.      *
  42.      * @param regex a regular expression for evaluating acceptable class names
  43.      */
  44.     public RegexpClassNameMatcher(final String regex) {
  45.         this(Pattern.compile(regex));
  46.     }

  47.     @Override
  48.     public boolean matches(final String className) {
  49.         return pattern.matcher(className).matches();
  50.     }
  51. }