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
FSLockFactory.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.IO;
20 
21 namespace Lucene.Net.Store
22 {
23 
24  /// <summary> Base class for file system based locking implementation.</summary>
25 
26  public abstract class FSLockFactory:LockFactory
27  {
28 
29  /// <summary> Directory for the lock files.</summary>
30  protected internal System.IO.DirectoryInfo internalLockDir = null;
31 
32  /// <summary> Gets the lock directory.
33  /// <para>Subclasses can use this to set the lock directory.
34  /// This method can be only called
35  /// once to initialize the lock directory. It is used by <see cref="FSDirectory" />
36  /// to set the lock directory to itsself.
37  /// Subclasses can also use this method to set the directory
38  /// in the constructor.
39  /// </para>
40  /// </summary>
41  public virtual DirectoryInfo LockDir
42  {
43  get { return internalLockDir; }
44  protected internal set
45  {
46  if (this.internalLockDir != null)
47  throw new System.SystemException("You can set the lock directory for this factory only once.");
48  this.internalLockDir = value;
49  }
50  }
51  }
52 }