You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@logging.apache.org by ma...@apache.org on 2020/03/22 17:40:05 UTC
[logging-log4j2] 05/06: Rename scope annotations to use Scoped
suffix
This is an automated email from the ASF dual-hosted git repository.
mattsicker pushed a commit to branch mean-bean-machine
in repository https://gitbox.apache.org/repos/asf/logging-log4j2.git
commit a3d78053a818a3b7b5efb92471fec2df47eac6ac
Author: Matt Sicker <bo...@gmail.com>
AuthorDate: Sun Mar 22 12:25:41 2020 -0500
Rename scope annotations to use Scoped suffix
This will make them more consistent as additional scopes are added such as @ConfigurationScoped, @RequestScoped, etc.
Signed-off-by: Matt Sicker <bo...@gmail.com>
---
.../log4j/plugins/api/{Dependent.java => DependentScoped.java} | 2 +-
.../java/org/apache/logging/log4j/plugins/api/Produces.java | 4 +++-
.../log4j/plugins/api/{Singleton.java => SingletonScoped.java} | 2 +-
.../log4j/plugins/defaults/bean/DefaultBeanManager.java | 10 +++++-----
.../log4j/plugins/defaults/bean/DependentScopeContext.java | 4 ++--
.../log4j/plugins/defaults/model/DefaultElementManager.java | 4 ++--
.../org/apache/logging/log4j/plugins/spi/model/Variable.java | 4 ++--
.../log4j/plugins/defaults/bean/DefaultBeanManagerTest.java | 10 +++++-----
8 files changed, 21 insertions(+), 19 deletions(-)
diff --git a/log4j-plugins/src/main/java/org/apache/logging/log4j/plugins/api/Dependent.java b/log4j-plugins/src/main/java/org/apache/logging/log4j/plugins/api/DependentScoped.java
similarity index 97%
rename from log4j-plugins/src/main/java/org/apache/logging/log4j/plugins/api/Dependent.java
rename to log4j-plugins/src/main/java/org/apache/logging/log4j/plugins/api/DependentScoped.java
index 57f2a58..da8e77e 100644
--- a/log4j-plugins/src/main/java/org/apache/logging/log4j/plugins/api/Dependent.java
+++ b/log4j-plugins/src/main/java/org/apache/logging/log4j/plugins/api/DependentScoped.java
@@ -34,5 +34,5 @@ import java.lang.annotation.RetentionPolicy;
@Documented
@Inherited
@ScopeType
-public @interface Dependent {
+public @interface DependentScoped {
}
diff --git a/log4j-plugins/src/main/java/org/apache/logging/log4j/plugins/api/Produces.java b/log4j-plugins/src/main/java/org/apache/logging/log4j/plugins/api/Produces.java
index 213ba26..5c46c56 100644
--- a/log4j-plugins/src/main/java/org/apache/logging/log4j/plugins/api/Produces.java
+++ b/log4j-plugins/src/main/java/org/apache/logging/log4j/plugins/api/Produces.java
@@ -23,7 +23,9 @@ import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
-@Target({ElementType.METHOD, ElementType.FIELD, ElementType.TYPE_USE})
+// https://docs.jboss.org/cdi/api/2.0/javax/enterprise/inject/Produces.html
+// https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/context/annotation/Bean.html
+@Target({ElementType.METHOD, ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Produces {
diff --git a/log4j-plugins/src/main/java/org/apache/logging/log4j/plugins/api/Singleton.java b/log4j-plugins/src/main/java/org/apache/logging/log4j/plugins/api/SingletonScoped.java
similarity index 96%
rename from log4j-plugins/src/main/java/org/apache/logging/log4j/plugins/api/Singleton.java
rename to log4j-plugins/src/main/java/org/apache/logging/log4j/plugins/api/SingletonScoped.java
index 6daa25d..750bc69 100644
--- a/log4j-plugins/src/main/java/org/apache/logging/log4j/plugins/api/Singleton.java
+++ b/log4j-plugins/src/main/java/org/apache/logging/log4j/plugins/api/SingletonScoped.java
@@ -27,5 +27,5 @@ import java.lang.annotation.RetentionPolicy;
@Documented
@Inherited
@ScopeType
-public @interface Singleton {
+public @interface SingletonScoped {
}
diff --git a/log4j-plugins/src/main/java/org/apache/logging/log4j/plugins/defaults/bean/DefaultBeanManager.java b/log4j-plugins/src/main/java/org/apache/logging/log4j/plugins/defaults/bean/DefaultBeanManager.java
index 5c98bf1..46afdbf 100644
--- a/log4j-plugins/src/main/java/org/apache/logging/log4j/plugins/defaults/bean/DefaultBeanManager.java
+++ b/log4j-plugins/src/main/java/org/apache/logging/log4j/plugins/defaults/bean/DefaultBeanManager.java
@@ -17,11 +17,11 @@
package org.apache.logging.log4j.plugins.defaults.bean;
-import org.apache.logging.log4j.plugins.api.Dependent;
+import org.apache.logging.log4j.plugins.api.DependentScoped;
import org.apache.logging.log4j.plugins.api.Disposes;
import org.apache.logging.log4j.plugins.api.Produces;
import org.apache.logging.log4j.plugins.api.Provider;
-import org.apache.logging.log4j.plugins.api.Singleton;
+import org.apache.logging.log4j.plugins.api.SingletonScoped;
import org.apache.logging.log4j.plugins.defaults.model.DefaultElementManager;
import org.apache.logging.log4j.plugins.spi.AmbiguousBeanException;
import org.apache.logging.log4j.plugins.spi.DefinitionException;
@@ -86,8 +86,8 @@ public class DefaultBeanManager implements BeanManager {
public DefaultBeanManager(final ElementManager elementManager) {
this.elementManager = elementManager;
// TODO: need a better way to register scope contexts
- scopes.put(Dependent.class, new DependentScopeContext());
- scopes.put(Singleton.class, new DefaultScopeContext(Singleton.class));
+ scopes.put(DependentScoped.class, new DependentScopeContext());
+ scopes.put(SingletonScoped.class, new DefaultScopeContext(SingletonScoped.class));
}
@Override
@@ -245,7 +245,7 @@ public class DefaultBeanManager implements BeanManager {
final Bean<?> bean = point.getBean()
.orElseThrow(() -> new DefinitionException("Cannot inject " + point + " into a non-bean"));
if (!bean.isDependentScoped()) {
- throw new DefinitionException("Injection points can only be @Dependent scoped; got: " + point);
+ throw new DefinitionException("Injection points can only be @DependentScoped scoped; got: " + point);
}
}
if (rawType.equals(Bean.class)) {
diff --git a/log4j-plugins/src/main/java/org/apache/logging/log4j/plugins/defaults/bean/DependentScopeContext.java b/log4j-plugins/src/main/java/org/apache/logging/log4j/plugins/defaults/bean/DependentScopeContext.java
index b8c8208..09b4a7a 100644
--- a/log4j-plugins/src/main/java/org/apache/logging/log4j/plugins/defaults/bean/DependentScopeContext.java
+++ b/log4j-plugins/src/main/java/org/apache/logging/log4j/plugins/defaults/bean/DependentScopeContext.java
@@ -17,7 +17,7 @@
package org.apache.logging.log4j.plugins.defaults.bean;
-import org.apache.logging.log4j.plugins.api.Dependent;
+import org.apache.logging.log4j.plugins.api.DependentScoped;
import org.apache.logging.log4j.plugins.spi.bean.Bean;
import org.apache.logging.log4j.plugins.spi.bean.InitializationContext;
import org.apache.logging.log4j.plugins.spi.bean.ScopeContext;
@@ -28,7 +28,7 @@ import java.util.Optional;
class DependentScopeContext implements ScopeContext {
@Override
public Class<? extends Annotation> getScopeType() {
- return Dependent.class;
+ return DependentScoped.class;
}
@Override
diff --git a/log4j-plugins/src/main/java/org/apache/logging/log4j/plugins/defaults/model/DefaultElementManager.java b/log4j-plugins/src/main/java/org/apache/logging/log4j/plugins/defaults/model/DefaultElementManager.java
index b690d59..9fed171 100644
--- a/log4j-plugins/src/main/java/org/apache/logging/log4j/plugins/defaults/model/DefaultElementManager.java
+++ b/log4j-plugins/src/main/java/org/apache/logging/log4j/plugins/defaults/model/DefaultElementManager.java
@@ -19,7 +19,7 @@ package org.apache.logging.log4j.plugins.defaults.model;
import org.apache.logging.log4j.plugins.api.AnnotationAlias;
import org.apache.logging.log4j.plugins.api.Default;
-import org.apache.logging.log4j.plugins.api.Dependent;
+import org.apache.logging.log4j.plugins.api.DependentScoped;
import org.apache.logging.log4j.plugins.api.Ignore;
import org.apache.logging.log4j.plugins.api.Named;
import org.apache.logging.log4j.plugins.api.QualifierType;
@@ -138,7 +138,7 @@ public class DefaultElementManager implements ElementManager {
private Class<? extends Annotation> getScopeType(final MetaElement element) {
final Collection<Class<? extends Annotation>> scopeTypes = filterScopeTypes(element.getAnnotations());
- return scopeTypes.isEmpty() ? Dependent.class : scopeTypes.iterator().next();
+ return scopeTypes.isEmpty() ? DependentScoped.class : scopeTypes.iterator().next();
}
private Collection<Class<? extends Annotation>> filterScopeTypes(final Collection<MetaAnnotation> annotations) {
diff --git a/log4j-plugins/src/main/java/org/apache/logging/log4j/plugins/spi/model/Variable.java b/log4j-plugins/src/main/java/org/apache/logging/log4j/plugins/spi/model/Variable.java
index 2396158..31b379a 100644
--- a/log4j-plugins/src/main/java/org/apache/logging/log4j/plugins/spi/model/Variable.java
+++ b/log4j-plugins/src/main/java/org/apache/logging/log4j/plugins/spi/model/Variable.java
@@ -17,7 +17,7 @@
package org.apache.logging.log4j.plugins.spi.model;
-import org.apache.logging.log4j.plugins.api.Dependent;
+import org.apache.logging.log4j.plugins.api.DependentScoped;
import org.apache.logging.log4j.plugins.util.TypeUtil;
import java.lang.annotation.Annotation;
@@ -43,6 +43,6 @@ public interface Variable {
Class<? extends Annotation> getScopeType();
default boolean isDependentScoped() {
- return getScopeType() == Dependent.class;
+ return getScopeType() == DependentScoped.class;
}
}
diff --git a/log4j-plugins/src/test/java/org/apache/logging/log4j/plugins/defaults/bean/DefaultBeanManagerTest.java b/log4j-plugins/src/test/java/org/apache/logging/log4j/plugins/defaults/bean/DefaultBeanManagerTest.java
index 9b35cba..e679643 100644
--- a/log4j-plugins/src/test/java/org/apache/logging/log4j/plugins/defaults/bean/DefaultBeanManagerTest.java
+++ b/log4j-plugins/src/test/java/org/apache/logging/log4j/plugins/defaults/bean/DefaultBeanManagerTest.java
@@ -24,7 +24,7 @@ import org.apache.logging.log4j.plugins.api.PostConstruct;
import org.apache.logging.log4j.plugins.api.Produces;
import org.apache.logging.log4j.plugins.api.Provider;
import org.apache.logging.log4j.plugins.api.QualifierType;
-import org.apache.logging.log4j.plugins.api.Singleton;
+import org.apache.logging.log4j.plugins.api.SingletonScoped;
import org.apache.logging.log4j.plugins.test.BeanJUnit4Runner;
import org.apache.logging.log4j.plugins.test.WithBeans;
import org.junit.Test;
@@ -46,11 +46,11 @@ public class DefaultBeanManagerTest {
}
@Produces
- @Singleton
+ @SingletonScoped
public String globalString = "global string value";
@Produces
- @Singleton
+ @SingletonScoped
@Run
public String testString() {
return "test string value";
@@ -130,7 +130,7 @@ public class DefaultBeanManagerTest {
assertNotSame(first, second);
}
- @Singleton
+ @SingletonScoped
public static class SingletonInjection {
}
@@ -222,7 +222,7 @@ public class DefaultBeanManagerTest {
assertTrue(instance.isPresent());
}
- @Singleton
+ @SingletonScoped
public static class IdGenerator {
private final AtomicInteger current = new AtomicInteger();