github-mirrors/elasticsearch
1
0
Fork 0
mirror of https://github.com/elastic/elasticsearch.git synced 2025-04-24 23:27:25 -04:00
Code Issues Projects Releases Packages Wiki Activity

Fix module and package names for stable plugin api (#89772)

Browse source 
the convention for packages and module names is:
org.elasticsearch.plugin[.analysis].api

module-info.java and package-info.java were using incorrect names
and not following the convention
relates #88980
This commit is contained in:
Przemyslaw Gomulka 2022-09-05 10:13:20 +02:00 • committed by GitHub
parent 0302d2db2d
commit 2b6d4e97df
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 5 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

2
libs/plugin-analysis-api/src/main/java/module-info.java
View file

@ -6,7 +6,7 @@
* Side Public License, v 1. * Side Public License, v 1.
*/ */
module org.elasticsearch.analysis.plugin.api { module org.elasticsearch.plugin.analysis.api {
requires org.apache.lucene.core; requires org.apache.lucene.core;
requires org.elasticsearch.plugin.api; requires org.elasticsearch.plugin.api;

2
libs/plugin-api/src/main/java/org/elasticsearch/plugin/api/NamedComponent.java
View file

@ -20,7 +20,7 @@ import java.lang.annotation.Target;
@Target({ ElementType.TYPE }) @Target({ ElementType.TYPE })
public @interface NamedComponent { public @interface NamedComponent {
/** /**
* A name used for registration and lookup * The name used for registration and lookup
* @return a name * @return a name
*/ */
String name(); String name();

6
libs/plugin-api/src/main/java/org/elasticsearch/plugin/api/package-info.java
View file

@ -12,12 +12,12 @@
* <ul> * <ul>
* <li> The root package is org.elasticsearch.plugin</li> * <li> The root package is org.elasticsearch.plugin</li>
* <li> Specialised API jars have their name following the root package. * <li> Specialised API jars have their name following the root package.
* i.e. org.elasticsearch.analysis * i.e. org.elasticsearch.plugin.analysis
* </li> * </li>
* <li> Interfaces and annotations used by plugin developers are in `api` package * <li> Interfaces and annotations used by plugin developers are in `api` package
* i.e org.elasticsearch.analysis.api or org.elasticsearch.api * i.e org.elasticsearch.plugin.analysis.api or org.elasticsearch.plugin.api
* <li> packages which are not meant to be used by plugin developers should not be subpackages of api * <li> packages which are not meant to be used by plugin developers should not be subpackages of api
* i.e org.elasticsearch.analysis.internal * i.e org.elasticsearch.plugin.analysis.internal
* </li> * </li>
* </ul> * </ul>
*/ */