beagled/Lucene.Net/Analysis/TokenFilter.cs

   1 /*
   2  * Copyright 2004 The Apache Software Foundation
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16 using System;
  17 namespace Lucene.Net.Analysis
  18 {
  19
  20         /// <summary>A TokenFilter is a TokenStream whose input is another token stream.
  21         /// <p>
  22         /// This is an abstract class.
  23         /// </summary>
  24
  25         public abstract class TokenFilter : TokenStream
  26         {
  27                 /// <summary>The source of tokens for this filter. </summary>
  28                 protected internal TokenStream input;
  29
  30                 /// <summary>Call TokenFilter(TokenStream) instead.</summary>
  31                 /// <deprecated>
  32                 /// </deprecated>
  33                 protected internal TokenFilter()
  34                 {
  35                 }
  36
  37                 /// <summary>Construct a token stream filtering the given input. </summary>
  38                 protected internal TokenFilter(TokenStream input)
  39                 {
  40                         this.input = input;
  41                 }
  42
  43                 /// <summary>Close the input TokenStream. </summary>
  44                 public override void  Close()
  45                 {
  46                         input.Close();
  47                 }
  48         }
  49 }