mcs/tools/monkeydoc/Lucene.Net/Lucene.Net/Analysis/Tokenattributes/FlagsAttribute.cs

   1 /*
   2  * Licensed to the Apache Software Foundation (ASF) under one or more
   3  * contributor license agreements.  See the NOTICE file distributed with
   4  * this work for additional information regarding copyright ownership.
   5  * The ASF licenses this file to You under the Apache License, Version 2.0
   6  * (the "License"); you may not use this file except in compliance with
   7  * the License.  You may obtain a copy of the License at
   8  *
   9  * http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  */
  17
  18 using System;
  19
  20 using Tokenizer = Mono.Lucene.Net.Analysis.Tokenizer;
  21 using Attribute = Mono.Lucene.Net.Util.Attribute;
  22
  23 namespace Mono.Lucene.Net.Analysis.Tokenattributes
  24 {
  25
  26         /// <summary> This attribute can be used to pass different flags down the {@link Tokenizer} chain,
  27         /// eg from one TokenFilter to another one.
  28         /// </summary>
  29         public interface FlagsAttribute:Attribute
  30         {
  31                 /// <summary> EXPERIMENTAL:  While we think this is here to stay, we may want to change it to be a long.
  32                 /// <p/>
  33                 ///
  34                 /// Get the bitset for any bits that have been set.  This is completely distinct from {@link TypeAttribute#Type()}, although they do share similar purposes.
  35                 /// The flags can be used to encode information about the token for use by other {@link Mono.Lucene.Net.Analysis.TokenFilter}s.
  36                 ///
  37                 ///
  38                 /// </summary>
  39                 /// <returns> The bits
  40                 /// </returns>
  41                 int GetFlags();
  42
  43                 /// <seealso cref="GetFlags()">
  44                 /// </seealso>
  45                 void  SetFlags(int flags);
  46         }
  47 }