lucene-java-3.5.0/lucene/contrib/analyzers/common/src/java/org/apache/lucene/analysis/hunspell/HunspellWord.java

   1 package org.apache.lucene.analysis.hunspell;
   2
   3 /**
   4  * Licensed to the Apache Software Foundation (ASF) under one or more
   5  * contributor license agreements.  See the NOTICE file distributed with
   6  * this work for additional information regarding copyright ownership.
   7  * The ASF licenses this file to You under the Apache License, Version 2.0
   8  * (the "License"); you may not use this file except in compliance with
   9  * the License.  You may obtain a copy of the License at
  10  *
  11  *     http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  */
  19
  20 import java.util.Arrays;
  21
  22 public class HunspellWord {
  23
  24   private final char flags[]; // sorted, can we represent more concisely?
  25
  26   /**
  27    * Creates a new HunspellWord with no associated flags
  28    */
  29   public HunspellWord() {
  30     flags = null;
  31   }
  32
  33   /**
  34    * Constructs a new HunspellWord with the given flags
  35    *
  36    * @param flags Flags to associate with the word
  37    */
  38   public HunspellWord(char[] flags) {
  39     this.flags = flags;
  40   }
  41
  42   /**
  43    * Checks whether the word has the given flag associated with it
  44    *
  45    * @param flag Flag to check whether it is associated with the word
  46    * @return {@code true} if the flag is associated, {@code false} otherwise
  47    */
  48   public boolean hasFlag(char flag) {
  49     return flags != null && Arrays.binarySearch(flags, flag) >= 0;
  50   }
  51
  52   /**
  53    * Returns the flags associated with the word
  54    *
  55    * @return Flags asssociated with the word
  56    */
  57   public char[] getFlags() {
  58     return flags;
  59   }
  60 }