lucene-java-3.5.0/lucene/src/java/org/apache/lucene/analysis/tokenattributes/FlagsAttributeImpl.java

   1 package org.apache.lucene.analysis.tokenattributes;
   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.io.Serializable;
  21
  22 import org.apache.lucene.util.AttributeImpl;
  23
  24 /**
  25  * This attribute can be used to pass different flags down the tokenizer chain,
  26  * eg from one TokenFilter to another one.
  27  * @lucene.experimental While we think this is here to stay, we may want to change it to be a long.
  28  */
  29 public class FlagsAttributeImpl extends AttributeImpl implements FlagsAttribute, Cloneable, Serializable {
  30   private int flags = 0;
  31
  32   /**
  33    * <p/>
  34    *
  35    * Get the bitset for any bits that have been set.  This is completely distinct from {@link TypeAttribute#type()}, although they do share similar purposes.
  36    * The flags can be used to encode information about the token for use by other {@link org.apache.lucene.analysis.TokenFilter}s.
  37    *
  38    *
  39    * @return The bits
  40    */
  41   public int getFlags() {
  42     return flags;
  43   }
  44
  45   /**
  46    * @see #getFlags()
  47    */
  48   public void setFlags(int flags) {
  49     this.flags = flags;
  50   }
  51
  52   @Override
  53   public void clear() {
  54     flags = 0;
  55   }
  56
  57   @Override
  58   public boolean equals(Object other) {
  59     if (this == other) {
  60       return true;
  61     }
  62
  63     if (other instanceof FlagsAttributeImpl) {
  64       return ((FlagsAttributeImpl) other).flags == flags;
  65     }
  66
  67     return false;
  68   }
  69
  70   @Override
  71   public int hashCode() {
  72     return flags;
  73   }
  74
  75   @Override
  76   public void copyTo(AttributeImpl target) {
  77     FlagsAttribute t = (FlagsAttribute) target;
  78     t.setFlags(flags);
  79   }
  80 }