View Javadoc
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.text;
18  
19  /**
20   * A predicate for selecting code points. Implementations of this interface must
21   * be thread safe.
22   * 
23   * @since 1.0
24   */
25  public interface CharacterPredicate {
26      
27      /**
28       * Tests the code point with this predicate.
29       * 
30       * @param codePoint
31       *            the code point to test
32       * @return {@code true} if the code point matches the predicate,
33       *         {@code false} otherwise
34       * @since 1.0
35       */
36      boolean test(int codePoint);
37  }