[LUCENE-6958] Improve CustomAnalyzer to also allow to specify factory directly (for compile-time safety)

• Type: Improvement
• Status: Closed
• Priority: Major
• Resolution: Fixed
• Affects Version/s: 5.4
• Fix Version/s: 5.5, 6.0
• Component/s: modules/analysis
• Lucene Fields: New
• Assignee: Uwe Schindler
• Reporter: Uwe Schindler
• Created: 04/Jan/16 15:30
• Updated: 28/Aug/22 14:47
• Resolved: 05/Jan/16 09:46

Description

Currently CustomAnalyzer only allows to specify the SPI names of factories. As the fluent builder pattern is mostly used inside Java code, it is better for type safety to optionally also specify the factory class directly (using compile-time safe patterns like .withTokenizer(WhitespaceTokenizerFactory.class)). With the string names, you get the error only at runtime. Of course this does not help with wrong, spelled parameter names, but it also has the side effect that you can click on the class name in your code to get javadocs with the parameter names.

This issue will add this functionality and update the docs/example.

Thanks to shaie for suggesting this!

Issue Links

• causes: LUCENE-8566 Deprecate methods in CustomAnalyzer.Builder which take factory classes
• requires: LUCENE-6961 Improve Exception handling in AnalysisFactory/SPI loader