pylucene 3.5.0-3
[pylucene.git] / lucene-java-3.5.0 / lucene / contrib / remote / src / java / org / apache / lucene / search / RMIRemoteSearchable.java
diff --git a/lucene-java-3.5.0/lucene/contrib/remote/src/java/org/apache/lucene/search/RMIRemoteSearchable.java b/lucene-java-3.5.0/lucene/contrib/remote/src/java/org/apache/lucene/search/RMIRemoteSearchable.java
new file mode 100644 (file)
index 0000000..b1eafb0
--- /dev/null
@@ -0,0 +1,48 @@
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.apache.lucene.search;
+
+import java.rmi.Remote;
+
+/**
+ * Marker interface to enable subclasses of {@link org.apache.lucene.search.Searchable} to be used via
+ * Java RMI. Classes implementing this interface can be used as a RMI -
+ * "remote object".
+ * <p>
+ * {@link RMIRemoteSearchable} extends {@link org.apache.lucene.search.Searchable} and can transparently
+ * be used as a such.
+ * <p>
+ * Example usage:
+ * 
+ * <pre>
+ *   RMIRemoteSearchable remoteObject = ...;
+ *   String remoteObjectName = ...;
+ *   Naming.rebind (remoteObjectName, remoteObject);
+ *   Searchable luceneSearchable = (Searchable) Naming.lookup (remoteObjectName);
+ * </pre>
+ * 
+ * </p>
+ * </p>
+ *
+ * @deprecated This package (all of contrib/remote) will be
+ * removed in 4.0.
+ */
+@Deprecated
+public interface RMIRemoteSearchable extends Searchable, Remote {
+
+}