Lucene.Net  3.0.3
Lucene.Net is a port of the Lucene search engine library, written in C# and targeted at .NET runtime users.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Properties Pages
HunspellWord.cs
Go to the documentation of this file.
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 using System.Linq;
20 
21 namespace Lucene.Net.Analysis.Hunspell {
22  public class HunspellWord {
23  private readonly Char[] _flags;
24 
25  /// <summary>
26  /// Creates a new HunspellWord with no associated flags.
27  /// </summary>
28  public HunspellWord() : this(new Char[0]) {
29  }
30 
31  /// <summary>
32  /// Constructs a new HunspellWord with the given flags.
33  /// </summary>
34  /// <param name="flags">Flags to associate with the word.</param>
35  public HunspellWord(Char[] flags) {
36  if (flags == null)
37  throw new ArgumentNullException("flags");
38 
39  _flags = flags;
40  }
41 
42  /// <summary>
43  /// Checks whether the word has the given flag associated with it.
44  /// </summary>
45  /// <param name="flag">Flag to check whether it is associated with the word.</param>
46  /// <returns><c>true</c> if the flag is associated, <c>false</c> otherwise</returns>
47  public Boolean HasFlag(Char flag) {
48  return _flags.Contains(flag);
49  }
50  }
51 }