Make private elements needed by CDI package-private

Vampire · Vampire · commit d4e050d3391a · 2022-03-09T02:41:53.000+01:00
diff --git a/config/pmd/pmd.xml b/config/pmd/pmd.xml
@@ -67,6 +67,23 @@
         <exclude name="UselessParentheses"/>
     </rule>
     <rule ref="category/java/codestyle.xml/ClassNamingConventions"/>
+    <rule ref="category/java/codestyle.xml/DefaultPackage">
+        <properties>
+            <property name="violationSuppressXPath">
+                <value>
+                    .[
+                        ((MethodDeclaration/@MethodName = 'ensureInitializationAtStartup') and descendant::FormalParameter[
+                            Annotation[typeIsExactly('javax.enterprise.event.Observes')]
+                                and Annotation[typeIsExactly('javax.enterprise.context.Initialized')]])
+                        or (Annotation[typeIsExactly('javax.enterprise.inject.Produces')]
+                            or Annotation[typeIsExactly('javax.inject.Inject')]
+                            or Annotation[typeIsExactly('javax.annotation.PostConstruct')]
+                            or Annotation[typeIsExactly('javax.annotation.PreDestroy')])
+                    ]
+                </value>
+            </property>
+        </properties>
+    </rule>
     <rule ref="category/java/codestyle.xml/EmptyMethodInAbstractClassShouldBeAbstract">
         <properties>
             <property name="violationSuppressXPath">
diff --git a/config/spotbugs/spotbugs-exclude.xml b/config/spotbugs/spotbugs-exclude.xml
@@ -32,36 +32,6 @@
         </Or>
     </Match>
 
-    <!-- work-around for https://github.com/spotbugs/spotbugs/issues/947 -->
-    <Match>
-        <Or>
-            <And>
-                <Class name="net.kautler.command.LoggerProducer"/>
-                <Method name="getLogger" params="javax.enterprise.inject.spi.InjectionPoint" returns="org.apache.logging.log4j.Logger"/>
-            </And>
-            <And>
-                <Class name="net.kautler.command.api.CommandHandler"/>
-                <Method name="ensureInitializationAtStartup" params="java.lang.Object" returns="void"/>
-            </And>
-            <And>
-                <Or>
-                    <Class name="net.kautler.command.handler.CommandHandlerJavacord"/>
-                    <Class name="net.kautler.command.handler.CommandHandlerJda"/>
-                </Or>
-                <Or>
-                    <Method name="setAvailableRestrictions" params="javax.enterprise.inject.Instance" returns="void"/>
-                    <Method name="setCommands" params="javax.enterprise.inject.Instance" returns="void"/>
-                    <Method name="setCommandContextTransformers" params="javax.enterprise.inject.Instance" returns="void"/>
-                </Or>
-            </And>
-            <And>
-                <Class name="net.kautler.command.parameter.parser.TypedParameterParser"/>
-                <Method name="setCommandHandlers" params="javax.enterprise.inject.Instance" returns="void"/>
-            </And>
-        </Or>
-        <Bug pattern="UPM_UNCALLED_PRIVATE_METHOD"/>
-    </Match>
-
     <Match>
         <Class name="net.kautler.command.parameter.parser.BaseParameterParser"/>
         <Method name="parse" params="net.kautler.command.api.CommandContext, java.util.function.BiFunction" returns="net.kautler.command.api.parameter.Parameters"/>
@@ -175,4 +145,11 @@
             <Bug pattern="RV_RETURN_VALUE_IGNORED_NO_SIDE_EFFECT"/>
         </Or>
     </Match>
+
+    <!-- the field gets set in an @Inject setter, so should never be null at usage time -->
+    <Match>
+        <Class name="net.kautler.command.parameter.parser.TypedParameterParser"/>
+        <Field name="parameterConverterTypeLiteralsByMessageType"/>
+        <Bug pattern="UWF_FIELD_NOT_INITIALIZED_IN_CONSTRUCTOR"/>
+    </Match>
 </FindBugsFilter>
diff --git a/examples/simplePingBotJavacord/src/main/java/net/kautler/command/example/ping/JavacordProducer.java b/examples/simplePingBotJavacord/src/main/java/net/kautler/command/example/ping/JavacordProducer.java
@@ -29,15 +29,15 @@
 @ApplicationScoped
 class JavacordProducer {
     @Inject
-    private Logger logger;
+    Logger logger;
 
     @Inject
     @Named
-    private String discordToken;
+    String discordToken;
 
     @Produces
     @ApplicationScoped
-    private DiscordApi produceDiscordApi() {
+    DiscordApi produceDiscordApi() {
         return new DiscordApiBuilder()
                 .setToken(discordToken)
                 .login()
diff --git a/examples/simplePingBotJavacord/src/main/java/net/kautler/command/example/ping/LoggerProducer.java b/examples/simplePingBotJavacord/src/main/java/net/kautler/command/example/ping/LoggerProducer.java
@@ -26,7 +26,7 @@
 @ApplicationScoped
 class LoggerProducer {
     @Produces
-    private Logger getLogger(InjectionPoint injectionPoint) {
+    Logger getLogger(InjectionPoint injectionPoint) {
         return LogManager.getLogger(injectionPoint.getMember().getDeclaringClass());
     }
 }
diff --git a/examples/simplePingBotJavacord/src/main/java/net/kautler/command/example/ping/PingBot.java b/examples/simplePingBotJavacord/src/main/java/net/kautler/command/example/ping/PingBot.java
@@ -28,7 +28,7 @@
 public class PingBot {
     @Produces
     @Named
-    private static String discordToken;
+    static String discordToken;
 
     public static void main(String[] args) {
         if (args.length != 1) {
diff --git a/examples/simplePingBotJavacord/src/main/java/net/kautler/command/example/ping/PingCommand.java b/examples/simplePingBotJavacord/src/main/java/net/kautler/command/example/ping/PingCommand.java
@@ -27,7 +27,7 @@
 @ApplicationScoped
 class PingCommand implements Command<Message> {
     @Inject
-    private Logger logger;
+    Logger logger;
 
     @Override
     public void execute(CommandContext<? extends Message> commandContext) {
diff --git a/examples/simplePingBotJda/src/main/java/net/kautler/command/example/ping/JdaProducer.java b/examples/simplePingBotJda/src/main/java/net/kautler/command/example/ping/JdaProducer.java
@@ -30,15 +30,15 @@
 @ApplicationScoped
 class JdaProducer {
     @Inject
-    private Logger logger;
+    Logger logger;
 
     @Inject
     @Named
-    private String discordToken;
+    String discordToken;
 
     @Produces
     @ApplicationScoped
-    private JDA produceJda() {
+    JDA produceJda() {
         try {
             return JDABuilder
                     .createLight(discordToken)
diff --git a/examples/simplePingBotJda/src/main/java/net/kautler/command/example/ping/LoggerProducer.java b/examples/simplePingBotJda/src/main/java/net/kautler/command/example/ping/LoggerProducer.java
@@ -26,7 +26,7 @@
 @ApplicationScoped
 class LoggerProducer {
     @Produces
-    private Logger getLogger(InjectionPoint injectionPoint) {
+    Logger getLogger(InjectionPoint injectionPoint) {
         return LogManager.getLogger(injectionPoint.getMember().getDeclaringClass());
     }
 }
diff --git a/examples/simplePingBotJda/src/main/java/net/kautler/command/example/ping/PingBot.java b/examples/simplePingBotJda/src/main/java/net/kautler/command/example/ping/PingBot.java
@@ -28,7 +28,7 @@
 public class PingBot {
     @Produces
     @Named
-    private static String discordToken;
+    static String discordToken;
 
     public static void main(String[] args) {
         if (args.length != 1) {
diff --git a/examples/simplePingBotJda/src/main/java/net/kautler/command/example/ping/PingCommand.java b/examples/simplePingBotJda/src/main/java/net/kautler/command/example/ping/PingCommand.java
@@ -27,7 +27,7 @@
 @ApplicationScoped
 class PingCommand implements Command<Message> {
     @Inject
-    private Logger logger;
+    Logger logger;
 
     @Override
     public void execute(CommandContext<? extends Message> commandContext) {
diff --git a/readme/README_template.md b/readme/README_template.md
@@ -131,15 +131,15 @@ _**Example:**_
 @ApplicationScoped
 class JavacordProducer {
     @Inject
-    private Logger logger;
+    Logger logger;
 
     @Inject
     @Named
-    private String discordToken;
+    String discordToken;
 
     @Produces
     @ApplicationScoped
-    private DiscordApi produceDiscordApi() {
+    DiscordApi produceDiscordApi() {
         return new DiscordApiBuilder()
                 .setToken(discordToken)
                 .login()
@@ -172,15 +172,15 @@ _**Example:**_
 @ApplicationScoped
 class JdaProducer {
     @Inject
-    private Logger logger;
+    Logger logger;
 
     @Inject
     @Named
-    private String discordToken;
+    String discordToken;
 
     @Produces
     @ApplicationScoped
-    private JDA produceJda() {
+    JDA produceJda() {
         try {
             return JDABuilder
                     .createLight(discordToken)
@@ -292,7 +292,7 @@ class MyFancyServer extends ServerJavacord {
     }
 
     @Inject
-    private MyFancyServer(@Named("myFancyServerId") long myFancyServerId) {
+    MyFancyServer(@Named("myFancyServerId") long myFancyServerId) {
         super(myFancyServerId);
     }
 }
@@ -388,7 +388,7 @@ _**Examples:**_
 @Usage("<text...>")
 class PingCommand implements Command<Message> {
     @Inject
-    private ParameterParser parameterParser;
+    ParameterParser parameterParser;
 
     @Override
     public void execute(CommandContext<? extends Message> commandContext) {
@@ -416,7 +416,7 @@ class PingCommand implements Command<Message> {
 class DoCommand implements Command<Message> {
     @Inject
     @Typed
-    private ParameterParser parameterParser;
+    ParameterParser parameterParser;
 
     @Override
     public void execute(CommandContext<? extends Message> commandContext) {
@@ -657,7 +657,7 @@ _**Example:**_
 ```java
 @ApplicationScoped
 class EventObserver {
-    private void commandNotFound(@ObservesAsync CommandNotFoundEventJavacord commandNotFoundEvent) {
+    void commandNotFound(@ObservesAsync CommandNotFoundEventJavacord commandNotFoundEvent) {
         commandNotFoundEvent.getMessage()
                 .getChannel()
                 .sendMessage(format(
@@ -679,7 +679,7 @@ _**Example:**_
 ```java
 @ApplicationScoped
 class EventObserver {
-    private void commandNotAllowed(@ObservesAsync CommandNotAllowedEventJavacord commandNotAllowedEvent) {
+    void commandNotAllowed(@ObservesAsync CommandNotAllowedEventJavacord commandNotAllowedEvent) {
         commandNotAllowedEvent.getMessage()
                 .getChannel()
                 .sendMessage(format(
diff --git a/src/integTestCommon/groovy/net/kautler/command/integ/test/spock/AddBeansExtension.groovy b/src/integTestCommon/groovy/net/kautler/command/integ/test/spock/AddBeansExtension.groovy
@@ -1,5 +1,5 @@
 /*
- * Copyright 2019 Björn Kautler
+ * Copyright 2019-2022 Björn Kautler
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -28,7 +28,7 @@ class AddBeansExtension implements Extension {
         this.beans = beans
     }
 
-    private void addBeans(@Observes BeforeBeanDiscovery beforeBeanDiscovery) {
+    void addBeans(@Observes BeforeBeanDiscovery beforeBeanDiscovery) {
         beans.each {
             beforeBeanDiscovery
                     .addAnnotatedType(it, "${it.name}_manuallyRegistered")
diff --git a/src/integTestCommon/groovy/net/kautler/command/integ/test/spock/VetoBeansExtension.groovy b/src/integTestCommon/groovy/net/kautler/command/integ/test/spock/VetoBeansExtension.groovy
@@ -1,5 +1,5 @@
 /*
- * Copyright 2020 Björn Kautler
+ * Copyright 2020-2022 Björn Kautler
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -27,7 +27,7 @@ class VetoBeansExtension implements Extension {
         this.beans = beans
     }
 
-    private void vetoBean(@Observes ProcessAnnotatedType processAnnotatedType) {
+    void vetoBean(@Observes ProcessAnnotatedType processAnnotatedType) {
         if (processAnnotatedType.annotatedType.javaClass in beans) {
             processAnnotatedType.veto()
         }
diff --git a/src/javacordIntegTest/groovy/net/kautler/command/integ/test/javacord/spock/JavacordExtension.groovy b/src/javacordIntegTest/groovy/net/kautler/command/integ/test/javacord/spock/JavacordExtension.groovy
@@ -1,5 +1,5 @@
 /*
- * Copyright 2019-2020 Björn Kautler
+ * Copyright 2019-2022 Björn Kautler
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -38,7 +38,7 @@ import static org.javacord.api.entity.permission.PermissionType.ADMINISTRATOR
 class JavacordExtension implements IGlobalExtension {
     @Produces
     @ApplicationScoped
-    private static DiscordApi botDiscordApi
+    static DiscordApi botDiscordApi
 
     private static Server serverAsBot
 
diff --git a/src/jdaIntegTest/groovy/net/kautler/command/integ/test/jda/spock/JdaExtension.groovy b/src/jdaIntegTest/groovy/net/kautler/command/integ/test/jda/spock/JdaExtension.groovy
@@ -1,5 +1,5 @@
 /*
- * Copyright 2019-2020 Björn Kautler
+ * Copyright 2019-2022 Björn Kautler
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -40,7 +40,7 @@ import static net.dv8tion.jda.api.Permission.ALL_PERMISSIONS
 class JdaExtension implements IGlobalExtension {
     @Produces
     @ApplicationScoped
-    private static JDA botJda
+    static JDA botJda
 
     private static Guild guildAsBot
 
diff --git a/src/main/java/net/kautler/command/LoggerProducer.java b/src/main/java/net/kautler/command/LoggerProducer.java
@@ -36,7 +36,7 @@ class LoggerProducer {
      */
     @Produces
     @Internal
-    private Logger getLogger(InjectionPoint injectionPoint) {
+    Logger getLogger(InjectionPoint injectionPoint) {
         return LogManager.getLogger(injectionPoint.getMember().getDeclaringClass());
     }
 }
diff --git a/src/main/java/net/kautler/command/api/CommandHandler.java b/src/main/java/net/kautler/command/api/CommandHandler.java
@@ -84,7 +84,7 @@ public abstract class CommandHandler<M> {
      */
     @Inject
     @Internal
-    private Logger logger;
+    Logger logger;
 
     /**
      * The command context transformers that were provided.
@@ -126,7 +126,7 @@ public abstract class CommandHandler<M> {
      *
      * @param event the event that was fired due to the application scope being initialized
      */
-    private void ensureInitializationAtStartup(@Observes @Initialized(ApplicationScoped.class) Object event) {
+    void ensureInitializationAtStartup(@Observes @Initialized(ApplicationScoped.class) Object event) {
         // just ensure initialization at startup
     }
 
@@ -138,7 +138,7 @@ private void ensureInitializationAtStartup(@Observes @Initialized(ApplicationSco
      *
      * <pre>{@code
      * }&#64;{@code Inject
-     * private void setCommandContextTransformers(
+     * void setCommandContextTransformers(
      *         }&#64;{@code Any Instance<CommandContextTransformer<? super Message>> commandContextTransformers) {
      *     doSetCommandContextTransformers(commandContextTransformers);
      * }
@@ -159,7 +159,7 @@ protected void doSetCommandContextTransformers(
      *
      * <pre>{@code
      * }&#64;{@code Inject
-     * private void setAvailableRestrictions(Instance<Restriction<? super Message>> availableRestrictions) {
+     * void setAvailableRestrictions(Instance<Restriction<? super Message>> availableRestrictions) {
      *     doSetAvailableRestrictions(availableRestrictions);
      * }
      * }</pre>
@@ -188,7 +188,7 @@ protected void doSetAvailableRestrictions(Instance<Restriction<? super M>> avail
      *
      * <pre>{@code
      * }&#64;{@code Inject
-     * private void setCommands(Instance<Command<? super Message>> commands) {
+     * void setCommands(Instance<Command<? super Message>> commands) {
      *     doSetCommands(commands);
      * }
      * }</pre>
@@ -238,7 +238,7 @@ protected void doSetCommands(Instance<Command<? super M>> commands) {
      * Shuts down the executor service used for asynchronous command execution if one was used actually.
      */
     @PreDestroy
-    private void shutdownExecutorService() {
+    void shutdownExecutorService() {
         if (executorService.isSet()) {
             executorService.get().shutdown();
         }
diff --git a/src/main/java/net/kautler/command/api/restriction/AllOf.java b/src/main/java/net/kautler/command/api/restriction/AllOf.java
@@ -38,7 +38,7 @@
  *     }
  *
  *     }&#64;{@code Inject
- *     private RoleAAndRoleB(RoleA roleA, RoleB roleB) {
+ *     RoleAAndRoleB(RoleA roleA, RoleB roleB) {
  *         super(roleA, roleB);
  *     }
  * }}{@code
diff --git a/src/main/java/net/kautler/command/api/restriction/AnyOf.java b/src/main/java/net/kautler/command/api/restriction/AnyOf.java
@@ -38,7 +38,7 @@
  *     }
  *
  *     }&#64;{@code Inject
- *     private RoleAOrRoleB(RoleA roleA, RoleB roleB) {
+ *     RoleAOrRoleB(RoleA roleA, RoleB roleB) {
  *         super(roleA, roleB);
  *     }
  * }}{@code
diff --git a/src/main/java/net/kautler/command/api/restriction/NoneOf.java b/src/main/java/net/kautler/command/api/restriction/NoneOf.java
diff --git a/src/main/java/net/kautler/command/handler/CommandHandlerJavacord.java b/src/main/java/net/kautler/command/handler/CommandHandlerJavacord.java
diff --git a/src/main/java/net/kautler/command/handler/CommandHandlerJda.java b/src/main/java/net/kautler/command/handler/CommandHandlerJda.java
diff --git a/src/main/java/net/kautler/command/parameter/converter/javacord/UserMentionConverterJavacord.java b/src/main/java/net/kautler/command/parameter/converter/javacord/UserMentionConverterJavacord.java
diff --git a/src/main/java/net/kautler/command/parameter/parser/BaseParameterParser.java b/src/main/java/net/kautler/command/parameter/parser/BaseParameterParser.java
diff --git a/src/main/java/net/kautler/command/parameter/parser/TypedParameterParser.java b/src/main/java/net/kautler/command/parameter/parser/TypedParameterParser.java

Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,7 @@`
`26`	`26`	`@ApplicationScoped`
`27`	`27`	`class LoggerProducer {`
`28`	`28`	`@Produces`
`29`		`- private Logger getLogger(InjectionPoint injectionPoint) {`
	`29`	`+ Logger getLogger(InjectionPoint injectionPoint) {`
`30`	`30`	`return LogManager.getLogger(injectionPoint.getMember().getDeclaringClass());`
`31`	`31`	`}`
`32`	`32`	`}`