Merge branch 'feature/alias_for_annotations' into develop

Author: tobiasstamann

README.md

@@ -90,7 +90,7 @@ To create multiple service locators in the same package use @SpiServiceLocators:
 ## How to register a service implementation
 Just add a Service annotation to your service implementation:
 
-	@Service(value = ExampleSpiInterface.class, id = "YOUR_OPTIONAL_SERVICE_ID", description = "OPTIONAL DESCRIPTION", priority = 0)
+	@SpiService(value = ExampleSpiInterface.class, id = "YOUR_OPTIONAL_SERVICE_ID", description = "OPTIONAL DESCRIPTION", priority = 0)
 	public class ExampleSpiService implements ExampleSpiInterface {
 	    @Override
             public String doSomething() {
@@ -107,9 +107,9 @@ All other annotation attributes are optional.
 
 It's also possible to implement more than one SPI in a class by using the Services annotation:
 
-	@Services({
-	    @Service(value = ExampleSpiInterface1.class, id = "YOUR_OPTIONAL_SERVICE_ID", description = "OPTIONAL DESCRIPTION", priority = 0),
-	    @Service(value = ExampleSpiInterface2.class)
+	@SpiServices({
+	    @SpiService(value = ExampleSpiInterface1.class, id = "YOUR_OPTIONAL_SERVICE_ID", description = "OPTIONAL DESCRIPTION", priority = 0),
+	    @SpiService(value = ExampleSpiInterface2.class)
 	})
 	public class ExampleSpiService implements ExampleSpiInterface1, ExampeSpiInterface2 {
 	    @Override

api/pom.xml

@@ -7,7 +7,7 @@
     <parent>
         <groupId>io.toolisticon.spiap</groupId>
         <artifactId>spiap-parent</artifactId>
-        <version>0.9.1-SNAPSHOT</version>
+        <version>0.9.1-alias_for_annotations-SNAPSHOT</version>
     </parent>
 
     <name>spiap-api</name>

api/src/main/java/io/toolisticon/spiap/api/SpiService.java

@@ -0,0 +1,37 @@
+package io.toolisticon.spiap.api;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+/**
+ * Marks an implementation of one or more SPI.
+ */
+@Retention(RetentionPolicy.RUNTIME)
+@Target(value = {ElementType.TYPE})
+public @interface SpiService {
+
+    /**
+     * The SPI interface implemented by the annotated class.
+     */
+    Class<?> value();
+
+    /**
+     * This optional attribute is used to declare an identifier for this implementation.
+     * If not set, the full qualified class name of the service implementation will be used as id.
+     */
+    String id() default "";
+
+    /**
+     * This optional attribute is used to add a short description about the implementing class.
+     */
+    String description() default "";
+
+    /**
+     * This optional attribute defines the order of the service implementations returned by the generated service allocator.
+     * Lower value are defining a higher priority. Defaults to 0.
+     */
+    int priority() default 0;
+
+}

api/src/main/java/io/toolisticon/spiap/api/SpiServices.java

@@ -0,0 +1,16 @@
+package io.toolisticon.spiap.api;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+
+/**
+ * Binder for supporting several spis in a single class.
+ */
+@Retention(RetentionPolicy.RUNTIME)
+@Target(value = {ElementType.TYPE})
+public @interface SpiServices {
+    SpiService[] value();
+}

example/api/pom.xml

@@ -8,7 +8,7 @@
     <parent>
         <groupId>io.toolisticon.spiap</groupId>
         <artifactId>example-parent</artifactId>
-        <version>0.9.1-SNAPSHOT</version>
+        <version>0.9.1-alias_for_annotations-SNAPSHOT</version>
     </parent>
 
     <name>example-api</name>
@@ -18,7 +18,7 @@
 
         <dependency>
             <groupId>io.toolisticon.spiap</groupId>
-            <artifactId>spiap-api</artifactId>
+            <artifactId>spiap-legacy-api</artifactId>
             <scope>provided</scope>
         </dependency>
 

example/pom.xml

@@ -7,7 +7,7 @@
     <parent>
         <groupId>io.toolisticon.spiap</groupId>
         <artifactId>spiap-parent</artifactId>
-        <version>0.9.1-SNAPSHOT</version>
+        <version>0.9.1-alias_for_annotations-SNAPSHOT</version>
     </parent>
 
     <name>example-parent</name>

example/service/pom.xml

@@ -8,7 +8,7 @@
     <parent>
         <groupId>io.toolisticon.spiap</groupId>
         <artifactId>example-parent</artifactId>
-        <version>0.9.1-SNAPSHOT</version>
+        <version>0.9.1-alias_for_annotations-SNAPSHOT</version>
     </parent>
 
     <name>example-service</name>
@@ -17,7 +17,7 @@
 
         <dependency>
             <groupId>io.toolisticon.spiap</groupId>
-            <artifactId>spiap-api</artifactId>
+            <artifactId>spiap-legacy-api</artifactId>
         </dependency>
 
         <dependency>

example/service/src/main/java/io/toolisticon/example/spiapexample/service/AdditionDecimalOperationImpl.java

@@ -2,11 +2,12 @@
 
 import io.toolisticon.example.spiapexample.api.DecimalCalculationOperation;
 import io.toolisticon.spiap.api.Service;
+import io.toolisticon.spiap.api.SpiService;
 
 /**
  * Implements the addition decimal operation
  */
-@Service(value = DecimalCalculationOperation.class, id = "ADDITION", description = "Does the addition operation on two int values", priority = -10)
+@SpiService(value = DecimalCalculationOperation.class, id = "ADDITION", description = "Does the addition operation on two int values", priority = -10)
 public class AdditionDecimalOperationImpl implements DecimalCalculationOperation {
 
     @Override

example/service/src/main/java/io/toolisticon/example/spiapexample/service/DivisionDecimalOperationImpl.java

@@ -2,14 +2,15 @@
 
 import io.toolisticon.example.spiapexample.api.DecimalCalculationOperation;
 import io.toolisticon.spiap.api.Service;
+import io.toolisticon.spiap.api.SpiService;
 
 
 /**
  * Implements the division decimal operation.
  * 
  * It's ok not to set the id. The full qualified class name will be used as fallback value for id.
  */
-@Service(DecimalCalculationOperation.class)
+@SpiService(DecimalCalculationOperation.class)
 public class DivisionDecimalOperationImpl implements DecimalCalculationOperation {
 
     @Override

example/service/src/main/java/io/toolisticon/example/spiapexample/service/HelloWorldSpiService.java

@@ -5,9 +5,10 @@
 
 /**
  * Example about how to use the {@link Service} annotation.
+ * This class is kept to use {@link Service} to test backward compatibility.
  */
 
-@Service(HelloWorldSpiInterface.class)
+@Service(value = HelloWorldSpiInterface.class, description = "Hi again")
 public class HelloWorldSpiService implements HelloWorldSpiInterface {
     @Override
     public String doSomething() {