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.TokenStream;
21 import org.apache.lucene.util.Attribute;
24 * This attribute can be used to mark a token as a keyword. Keyword aware
25 * {@link TokenStream}s can decide to modify a token based on the return value
26 * of {@link #isKeyword()} if the token is modified. Stemming filters for
27 * instance can use this attribute to conditionally skip a term if
28 * {@link #isKeyword()} returns <code>true</code>.
30 public interface KeywordAttribute extends Attribute {
33 * Returns <code>true</code> iff the current token is a keyword, otherwise
36 * @return <code>true</code> iff the current token is a keyword, otherwise
39 public boolean isKeyword();
42 * Marks the current token as keyword iff set to <code>true</code>.
45 * <code>true</code> iff the current token is a keyword, otherwise
48 public void setKeyword(boolean isKeyword);