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  
18  package org.apache.commons.text.similarity;
19  
20  import java.util.Objects;
21  
22  /**
23   * Scores the similarity between two {@link CharSequence}s.
24   */
25  final class SimilarityCharacterInput implements SimilarityInput<Character> {
26  
27      /**
28       * Source.
29       */
30      private final CharSequence cs;
31  
32      SimilarityCharacterInput(final CharSequence cs) {
33          if (cs == null) {
34              throw new IllegalArgumentException("CharSequence");
35          }
36          this.cs = cs;
37      }
38  
39      @Override
40      public Character at(final int index) {
41          // Character.valueOf caches character <= 127.
42          return Character.valueOf(cs.charAt(index));
43      }
44  
45      @Override
46      public boolean equals(final Object obj) {
47          if (this == obj) {
48              return true;
49          }
50          if (obj == null) {
51              return false;
52          }
53          if (getClass() != obj.getClass()) {
54              return false;
55          }
56          final SimilarityCharacterInput other = (SimilarityCharacterInput) obj;
57          return Objects.equals(cs, other.cs);
58      }
59  
60      @Override
61      public int hashCode() {
62          return Objects.hash(cs);
63      }
64  
65      @Override
66      public int length() {
67          return cs.length();
68      }
69  
70      @Override
71      public String toString() {
72          return cs.toString();
73      }
74  }