From 56f85884fe099529b0a8ed7bb6f7eac5161e45e4 Mon Sep 17 00:00:00 2001 From: Tomoko Uchida Date: Wed, 28 Aug 2019 17:59:53 +0900 Subject: [PATCH] LUCENE-8957: Update examples in CustomAnalyzar Javadocs --- lucene/CHANGES.txt | 2 +- .../lucene/analysis/custom/CustomAnalyzer.java | 12 +++++------- 2 files changed, 6 insertions(+), 8 deletions(-) diff --git a/lucene/CHANGES.txt b/lucene/CHANGES.txt index 08ee2342354..7dbde885e48 100644 --- a/lucene/CHANGES.txt +++ b/lucene/CHANGES.txt @@ -76,7 +76,7 @@ Bug Fixes Other -* LUCENE-8778 LUCENE-8911: Define analyzer SPI names as static final fields and document the names in Javadocs. +* LUCENE-8778 LUCENE-8911 LUCENE-8957: Define analyzer SPI names as static final fields and document the names in Javadocs. (Tomoko Uchida, Uwe Schindler) ======================= Lucene 8.2.0 ======================= diff --git a/lucene/analysis/common/src/java/org/apache/lucene/analysis/custom/CustomAnalyzer.java b/lucene/analysis/common/src/java/org/apache/lucene/analysis/custom/CustomAnalyzer.java index 5a8ae9f83e6..8e5e966da03 100644 --- a/lucene/analysis/common/src/java/org/apache/lucene/analysis/custom/CustomAnalyzer.java +++ b/lucene/analysis/common/src/java/org/apache/lucene/analysis/custom/CustomAnalyzer.java @@ -53,23 +53,21 @@ import static org.apache.lucene.analysis.util.AnalysisSPILoader.newFactoryClassI * A general-purpose Analyzer that can be created with a builder-style API. * Under the hood it uses the factory classes {@link TokenizerFactory}, * {@link TokenFilterFactory}, and {@link CharFilterFactory}. - *

You can create an instance of this Analyzer using the builder: + *

You can create an instance of this Analyzer using the builder by passing the SPI names (as defined by {@link java.util.ServiceLoader} interface) to it: * 

  * Analyzer ana = CustomAnalyzer.builder(Paths.get("/path/to/config/dir"))
- *   .withTokenizer(StandardTokenizerFactory.class)
- *   .addTokenFilter(StandardFilterFactory.class)
- *   .addTokenFilter(LowerCaseFilterFactory.class)
- *   .addTokenFilter(StopFilterFactory.class, "ignoreCase", "false", "words", "stopwords.txt", "format", "wordset")
+ *   .withTokenizer(StandardTokenizerFactory.NAME)
+ *   .addTokenFilter(LowerCaseFilterFactory.NAME)
+ *   .addTokenFilter(StopFilterFactory.NAME, "ignoreCase", "false", "words", "stopwords.txt", "format", "wordset")
  *   .build();
  *
* The parameters passed to components are also used by Apache Solr and are documented * on their corresponding factory classes. Refer to documentation of subclasses * of {@link TokenizerFactory}, {@link TokenFilterFactory}, and {@link CharFilterFactory}. - *

You can also use the SPI names (as defined by {@link java.util.ServiceLoader} interface): + *

This is the same as the above: * 

  * Analyzer ana = CustomAnalyzer.builder(Paths.get("/path/to/config/dir"))
  *   .withTokenizer("standard")
- *   .addTokenFilter("standard")
  *   .addTokenFilter("lowercase")
  *   .addTokenFilter("stop", "ignoreCase", "false", "words", "stopwords.txt", "format", "wordset")
  *   .build();