lucene-java-3.5.0/lucene/src/java/org/apache/lucene/analysis/TokenFilter.java

   1 package org.apache.lucene.analysis;
   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.IOException;
  21
  22 /** A TokenFilter is a TokenStream whose input is another TokenStream.
  23   <p>
  24   This is an abstract class; subclasses must override {@link #incrementToken()}.
  25   @see TokenStream
  26   */
  27 public abstract class TokenFilter extends TokenStream {
  28   /** The source of tokens for this filter. */
  29   protected final TokenStream input;
  30
  31   /** Construct a token stream filtering the given input. */
  32   protected TokenFilter(TokenStream input) {
  33     super(input);
  34     this.input = input;
  35   }
  36
  37   /** Performs end-of-stream operations, if any, and calls then <code>end()</code> on the
  38    * input TokenStream.<p/>
  39    * <b>NOTE:</b> Be sure to call <code>super.end()</code> first when overriding this method.*/
  40   @Override
  41   public void end() throws IOException {
  42     input.end();
  43   }
  44
  45   /** Close the input TokenStream. */
  46   @Override
  47   public void close() throws IOException {
  48     input.close();
  49   }
  50
  51   /** Reset the filter as well as the input TokenStream. */
  52   @Override
  53   public void reset() throws IOException {
  54     input.reset();
  55   }
  56 }