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
  17 using System;
  18
  19 namespace Lucene.Net.Analysis
  20 {
  21
  22         /// <summary>A TokenFilter is a TokenStream whose input is another token stream.
  23         /// <p>
  24         /// This is an abstract class.
  25         /// </summary>
  26
  27         public abstract class TokenFilter : TokenStream
  28         {
  29                 /// <summary>The source of tokens for this filter. </summary>
  30                 protected internal TokenStream input;
  31
  32                 /// <summary>Call TokenFilter(TokenStream) instead.</summary>
  33                 /// <deprecated>
  34                 /// </deprecated>
  35                 protected internal TokenFilter()
  36                 {
  37                 }
  38
  39                 /// <summary>Construct a token stream filtering the given input. </summary>
  40                 protected internal TokenFilter(TokenStream input)
  41                 {
  42                         this.input = input;
  43                 }
  44
  45                 /// <summary>Close the input TokenStream. </summary>
  46                 public override void  Close()
  47                 {
  48                         input.Close();
  49                 }
  50         }
  51 }