View Javadoc
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  
21  import java.util.Objects;
22  import java.util.regex.Pattern;
23  
24  /**
25   * A {@link ClassNameMatcher} that uses regular expressions.
26   * <p>
27   * This object is immutable and thread-safe.
28   * </p>
29   */
30  final class RegexpClassNameMatcher implements ClassNameMatcher {
31  
32      private final Pattern pattern; // Class is thread-safe
33  
34      /**
35       * Constructs an object based on the specified pattern.
36       *
37       * @param pattern a pattern for evaluating acceptable class names
38       * @throws NullPointerException if {@code pattern} is null
39       */
40      public RegexpClassNameMatcher(final Pattern pattern) {
41          this.pattern = Objects.requireNonNull(pattern, "pattern");
42      }
43  
44      /**
45       * Constructs an object based on the specified regular expression.
46       *
47       * @param regex a regular expression for evaluating acceptable class names
48       */
49      public RegexpClassNameMatcher(final String regex) {
50          this(Pattern.compile(regex));
51      }
52  
53      @Override
54      public boolean matches(final String className) {
55          return pattern.matcher(className).matches();
56      }
57  }