lucene-java-3.4.0/lucene/src/test-framework/org/apache/lucene/store/_TestHelper.java

   1 package org.apache.lucene.store;
   2
   3 /**
   4  * Licensed to the Apache Software Foundation (ASF) under one or more
   5  * contributor license agreements.  See the NOTICE file distributed with
   6  * this work for additional information regarding copyright ownership.
   7  * The ASF licenses this file to You under the Apache License, Version 2.0
   8  * (the "License"); you may not use this file except in compliance with
   9  * the License.  You may obtain a copy of the License at
  10  *
  11  *     http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  */
  19
  20 import java.io.IOException;
  21
  22 import org.apache.lucene.store.SimpleFSDirectory.SimpleFSIndexInput;
  23
  24 /** This class provides access to package-level features defined in the
  25  *  store package. It is used for testing only.
  26  */
  27 public class _TestHelper {
  28
  29     /** Returns true if the instance of the provided input stream is actually
  30      *  an SimpleFSIndexInput.
  31      */
  32     public static boolean isSimpleFSIndexInput(IndexInput is) {
  33         return is instanceof SimpleFSIndexInput;
  34     }
  35
  36     /** Returns true if the provided input stream is an SimpleFSIndexInput and
  37      *  is a clone, that is it does not own its underlying file descriptor.
  38      */
  39     public static boolean isSimpleFSIndexInputClone(IndexInput is) {
  40         if (isSimpleFSIndexInput(is)) {
  41             return ((SimpleFSIndexInput) is).isClone;
  42         } else {
  43             return false;
  44         }
  45     }
  46
  47     /** Given an instance of SimpleFSDirectory.SimpleFSIndexInput, this method returns
  48      *  true if the underlying file descriptor is valid, and false otherwise.
  49      *  This can be used to determine if the OS file has been closed.
  50      *  The descriptor becomes invalid when the non-clone instance of the
  51      *  SimpleFSIndexInput that owns this descriptor is closed. However, the
  52      *  descriptor may possibly become invalid in other ways as well.
  53      */
  54     public static boolean isSimpleFSIndexInputOpen(IndexInput is)
  55     throws IOException
  56     {
  57         if (isSimpleFSIndexInput(is)) {
  58             SimpleFSIndexInput fis = (SimpleFSIndexInput) is;
  59             return fis.isFDValid();
  60         } else {
  61             return false;
  62         }
  63     }
  64
  65 }