From 2f159c40597e42269c996593f6ced15a423e644f Mon Sep 17 00:00:00 2001 From: Uwe Schindler Date: Wed, 1 Feb 2012 10:57:28 +0000 Subject: [PATCH] LUCENE-3735: Fix javadocs, sorry! git-svn-id: https://svn.apache.org/repos/asf/lucene/dev/trunk@1239056 13f79535-47bb-0310-9956-ffa450edef68 --- .../org/apache/lucene/index/IndexWriter.java | 2 +- .../lucene/index/PayloadProcessorProvider.java | 18 +++++++++--------- 2 files changed, 10 insertions(+), 10 deletions(-) diff --git a/lucene/src/java/org/apache/lucene/index/IndexWriter.java b/lucene/src/java/org/apache/lucene/index/IndexWriter.java index f0c9c9540a7..197bb66f42e 100644 --- a/lucene/src/java/org/apache/lucene/index/IndexWriter.java +++ b/lucene/src/java/org/apache/lucene/index/IndexWriter.java @@ -4035,7 +4035,7 @@ public class IndexWriter implements Closeable, TwoPhaseCommit { * is merged, not only external ones that are given through * {@link #addIndexes}. If you want only the payloads of the external segments * to be processed, you can return null whenever a - * {@link DirPayloadProcessor} is requested for the {@link Directory} of the + * {@link PayloadProcessorProvider.ReaderPayloadProcessor} is requested for the {@link Directory} of the * {@link IndexWriter}. *

* The default is null which means payloads are processed diff --git a/lucene/src/java/org/apache/lucene/index/PayloadProcessorProvider.java b/lucene/src/java/org/apache/lucene/index/PayloadProcessorProvider.java index 9d9ea5a3f2c..d87cff2a66c 100644 --- a/lucene/src/java/org/apache/lucene/index/PayloadProcessorProvider.java +++ b/lucene/src/java/org/apache/lucene/index/PayloadProcessorProvider.java @@ -23,20 +23,20 @@ import org.apache.lucene.store.Directory; import org.apache.lucene.util.BytesRef; /** - * Provides a {@link DirPayloadProcessor} to be used for a {@link Directory}. - * This allows using different {@link DirPayloadProcessor}s for different - * directories, for e.g. to perform different processing of payloads of + * Provides a {@link ReaderPayloadProcessor} to be used for a {@link Directory}. + * This allows using different {@link ReaderPayloadProcessor}s for different + * source {@link AtomicReader}, for e.g. to perform different processing of payloads of * different directories. *

* NOTE: to avoid processing payloads of certain directories, you can - * return null in {@link #getDirProcessor}. + * return null in {@link #getReaderProcessor}. *

- * NOTE: it is possible that the same {@link DirPayloadProcessor} will be + * NOTE: it is possible that the same {@link ReaderPayloadProcessor} will be * requested for the same {@link Directory} concurrently. Therefore, to avoid * concurrency issues you should return different instances for different - * threads. Usually, if your {@link DirPayloadProcessor} does not maintain state + * threads. Usually, if your {@link ReaderPayloadProcessor} does not maintain state * this is not a problem. The merge code ensures that the - * {@link DirPayloadProcessor} instance you return will be accessed by one + * {@link ReaderPayloadProcessor} instance you return will be accessed by one * thread to obtain the {@link PayloadProcessor}s for different terms. * * @lucene.experimental @@ -48,7 +48,7 @@ public abstract class PayloadProcessorProvider { * processing the payloads of different terms differently. If you intent to * process all your payloads the same way, then you can ignore the given term. *

- * NOTE: if you protect your {@link DirPayloadProcessor} from + * NOTE: if you protect your {@link ReaderPayloadProcessor} from * concurrency issues, then you shouldn't worry about any such issues when * {@link PayloadProcessor}s are requested for different terms. */ @@ -72,7 +72,7 @@ public abstract class PayloadProcessorProvider { } /** - * Returns a {@link DirPayloadProcessor} for the given {@link Directory}, + * Returns a {@link ReaderPayloadProcessor} for the given {@link Directory}, * through which {@link PayloadProcessor}s can be obtained for each * {@link Term}, or null if none should be used. */