1 package org.apache.lucene.analysis.tokenattributes;
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
11 * http://www.apache.org/licenses/LICENSE-2.0
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.
20 import org.apache.lucene.analysis.Tokenizer;
21 import org.apache.lucene.util.Attribute;
24 * This attribute can be used to pass different flags down the {@link Tokenizer} chain,
25 * eg from one TokenFilter to another one.
26 * @lucene.experimental While we think this is here to stay, we may want to change it to be a long.
28 public interface FlagsAttribute extends Attribute {
32 * Get the bitset for any bits that have been set. This is completely distinct from {@link TypeAttribute#type()}, although they do share similar purposes.
33 * The flags can be used to encode information about the token for use by other {@link org.apache.lucene.analysis.TokenFilter}s.
38 public int getFlags();
43 public void setFlags(int flags);