Skip to content

Commit

Permalink
Merge pull request #39 from arjantijms/master
Browse files Browse the repository at this point in the history
Fix poms and javadoc
  • Loading branch information
arjantijms committed Jul 12, 2019
2 parents 4e3cf36 + c59a3a8 commit 5ad60bd
Show file tree
Hide file tree
Showing 12 changed files with 44 additions and 58 deletions.
34 changes: 18 additions & 16 deletions api/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -20,14 +20,13 @@
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd"> <modelVersion>4.0.0</modelVersion>

<parent>
<groupId>org.eclipse.ee4j</groupId>
<artifactId>project</artifactId>
<version>1.0.5</version>
<groupId>org.eclipse.ee4j.interceptor-api</groupId>
<artifactId>interceptor-api-parent</artifactId>
<version>1.2.4-SNAPSHOT</version>
</parent>

<groupId>jakarta.interceptor</groupId>
<artifactId>jakarta.interceptor-api</artifactId>
<version>1.2.4-SNAPSHOT</version>

<name>${extension.name} API</name>
<description>Eclipse Interceptors</description>
Expand Down Expand Up @@ -84,6 +83,19 @@
<url>https://github.com/eclipse-ee4j/interceptor-api</url>
<tag>HEAD</tag>
</scm>

<dependencies>
<dependency>
<groupId>jakarta.annotation</groupId>
<artifactId>jakarta.annotation-api</artifactId>
<version>1.3.4</version>
</dependency>
<dependency>
<groupId>jakarta.ejb</groupId>
<artifactId>jakarta.ejb-api</artifactId>
<version>3.2.4</version>
</dependency>
</dependencies>

<build>
<resources>
Expand Down Expand Up @@ -136,6 +148,7 @@
</execution>
</executions>
</plugin>

<plugin>
<groupId>org.apache.felix</groupId>
<artifactId>maven-bundle-plugin</artifactId>
Expand Down Expand Up @@ -204,6 +217,7 @@
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<configuration>
<source>1.7</source>
<bottom>
<![CDATA[Copyright &#169; 1996-2013,
<a href="http://www.oracle.com">Oracle</a>
Expand Down Expand Up @@ -285,16 +299,4 @@
</pluginManagement>
</build>

<dependencies>
<dependency>
<groupId>jakarta.annotation</groupId>
<artifactId>jakarta.annotation-api</artifactId>
<version>1.3.4</version>
</dependency>
<dependency>
<groupId>jakarta.ejb</groupId>
<artifactId>jakarta.ejb-api</artifactId>
<version>3.2.4</version>
</dependency>
</dependencies>
</project>
15 changes: 7 additions & 8 deletions api/src/main/java/javax/interceptor/AroundConstruct.java
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,10 @@
import java.lang.annotation.Target;

/**
* <p>
* Designates an interceptor method that receives a callback when the target class constructor is invoked.
* </p>
*
* <p>
* The method to which the <tt>AroundConstruct</tt> annotation is applied must have one of the following signatures.
* The method to which the <code>AroundConstruct</code> annotation is applied must have one of the following signatures.
* </p>
*
* <pre>
Expand All @@ -41,26 +40,26 @@
* </p>
*
* <p>
* An <tt>AroundConstruct</tt> interceptor method may be only declared in an interceptor class or superclass of an
* An <code>AroundConstruct</code> interceptor method may be only declared in an interceptor class or superclass of an
* interceptor class.
* </p>
*
* <p>
* An interceptor class must not declare more than one <tt>AroundConstruct</tt> method.
* An interceptor class must not declare more than one <code>AroundConstruct</code> method.
* </p>
*
* <p>
* The target instance is created and its constructor injection is performed, if applicable, when the last interceptor
* method in the <tt>AroundConstruct</tt> interceptor chain invokes the
* method in the <code>AroundConstruct</code> interceptor chain invokes the
* {@link javax.interceptor.InvocationContext#proceed()} method.
*
* <p>
* An <tt>AroundConstruct</tt> interceptor method should exercise caution accessing the instance whose constructor it
* An <code>AroundConstruct</code> interceptor method should exercise caution accessing the instance whose constructor it
* interposes on.
* </p>
*
* <p>
* <tt>AroundConstruct</tt> methods may throw any exceptions that are allowed by the throws clause of the constructor on
* <code>AroundConstruct</code> methods may throw any exceptions that are allowed by the throws clause of the constructor on
* which they are interposing.
* </p>
*
Expand Down
12 changes: 5 additions & 7 deletions api/src/main/java/javax/interceptor/AroundInvoke.java
Original file line number Diff line number Diff line change
Expand Up @@ -23,37 +23,35 @@
import java.lang.annotation.Target;

/**
* <p>
* Defines an interceptor method that interposes on business methods. The method must take a single parameter of type
* {@link javax.interceptor.InvocationContext} and have a return type {@link java.lang.Object}. The method must not be
* declared as abstract, final, or static.
* </p>
*
* <pre>
* &#064;AroundInvoke
* public Object intercept(InvocationContext ctx) throws Exception { ... }
* </pre>
*
* <p>
* <tt>AroundInvoke</tt> methods may be declared in interceptor classes, in the superclasses of interceptor classes, in
* <code>AroundInvoke</code> methods may be declared in interceptor classes, in the superclasses of interceptor classes, in
* the target class, and/or in superclasses of the target class.
* </p>
*
* <p>
* A given class must not declare more than one <tt>AroundInvoke</tt> method.
* A given class must not declare more than one <code>AroundInvoke</code> method.
* </p>
*
* <p>
* An <tt>AroundInvoke</tt> method can invoke any component or resource that the method it is intercepting can invoke.
* An <code>AroundInvoke</code> method can invoke any component or resource that the method it is intercepting can invoke.
* </p>
*
* <p>
* In general, <tt>AroundInvoke</tt> method invocations occur within the same transaction and security context as the
* In general, <code>AroundInvoke</code> method invocations occur within the same transaction and security context as the
* method on which they are interposing.
* </p>
*
* <p>
* <tt>AroundInvoke</tt> methods may throw any exceptions that are allowed by the throws clause of the method on which
* <code>AroundInvoke</code> methods may throw any exceptions that are allowed by the throws clause of the method on which
* they are interposing. They may catch and suppress exceptions and recover by calling
* {@link javax.interceptor.InvocationContext#proceed()}.
* </p>
Expand Down
14 changes: 6 additions & 8 deletions api/src/main/java/javax/interceptor/AroundTimeout.java
Original file line number Diff line number Diff line change
Expand Up @@ -23,43 +23,41 @@
import java.lang.annotation.Target;

/**
* <p>
* Defines an interceptor method that interposes on timeout methods. The method must take a single parameter of type
* {@link javax.interceptor.InvocationContext} and have a return type {@link java.lang.Object}. The method must not be
* declared as abstract, final, or static.
* </p>
*
* <pre>
* &#064;AroundTimeout
* public Object interceptTimeout(InvocationContext ctx) throws Exception { ... }
* </pre>
*
* <p>
* <tt>AroundTimeout</tt> methods may be declared in interceptor classes, in the superclasses of interceptor classes, in
* <code>AroundTimeout</code> methods may be declared in interceptor classes, in the superclasses of interceptor classes, in
* the target class, and/or in superclasses of the target class.
* </p>
*
* <p>
* A given class must not declare more than one <tt>AroundTimeout</tt> method.
* A given class must not declare more than one <code>AroundTimeout</code> method.
* </p>
*
* <p>
* An <tt>AroundTimeout</tt> method can invoke any component or resource that its corresponding timeout method can
* An <code>AroundTimeout</code> method can invoke any component or resource that its corresponding timeout method can
* invoke.
* </p>
*
* <p>
* {@link javax.interceptor.InvocationContext#getTimer()} allows any <tt>AroundTimeout</tt> method to retrieve the timer
* {@link javax.interceptor.InvocationContext#getTimer()} allows any <code>AroundTimeout</code> method to retrieve the timer
* object associated with the timeout.
* </p>
*
* <p>
* In general, <tt>AroundTimeout</tt> method invocations occur within the same transaction and security context as the
* In general, <code>AroundTimeout</code> method invocations occur within the same transaction and security context as the
* timeout method on which they are interposing.
* </p>
*
* <p>
* <tt>AroundTimeout</tt> methods may throw any exceptions that are allowed by the throws clause of the timeout method
* <code>AroundTimeout</code> methods may throw any exceptions that are allowed by the throws clause of the timeout method
* on which they are interposing. They may catch and suppress exceptions and recover by calling
* {@link javax.interceptor.InvocationContext#proceed()}.
* </p>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,8 @@
import java.lang.annotation.Target;

/**
* <p>
* Used to exclude class-level interceptors for the lifecycle callback method, business method, timeout method, or
* constructor to which it is applied.
* </p>
*
* <p>
* Excludes interceptors defined by means of the {@link javax.interceptor.Interceptors} annotation. Use of this
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,8 @@
import java.lang.annotation.Target;

/**
* <p>
* Used to exclude default interceptors for a target class or for a lifecycle callback method, business method, timeout
* method, or constructor of a target class.
* </p>
*
* <pre>
* &#064;ExcludeDefaultInterceptors
Expand Down
2 changes: 0 additions & 2 deletions api/src/main/java/javax/interceptor/Interceptor.java
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,7 @@
import java.lang.annotation.Target;

/**
* <p>
* Specifies that a class is an interceptor.
* </p>
*
* <pre>
* &#064;Validated &#064;Interceptor
Expand Down
2 changes: 0 additions & 2 deletions api/src/main/java/javax/interceptor/InterceptorBinding.java
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,7 @@
import java.lang.annotation.Target;

/**
* <p>
* Specifies that an annotation type is an interceptor binding type.
* </p>
*
* <pre>
* &#064;Inherited
Expand Down
6 changes: 2 additions & 4 deletions api/src/main/java/javax/interceptor/Interceptors.java
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,7 @@
import java.lang.annotation.Target;

/**
* <p>
* Declares an ordered list of interceptors for a target class, or for a method or a constructor of a target class.
* </p>
*
* <pre>
* &#064;Interceptors(ValidationInterceptor.class)
Expand All @@ -41,11 +39,11 @@
*
* <p>
* Only business method interception or timeout method interception may be specified by a method-level
* <tt>Interceptors</tt> declaration.
* <code>Interceptors</code> declaration.
* </p>
*
* <p>
* Constructor interception may be specified by a constructor-level <tt>Interceptors</tt> declaration.
* Constructor interception may be specified by a constructor-level <code>Interceptors</code> declaration.
* </p>
*
* @see javax.interceptor.ExcludeClassInterceptors
Expand Down
4 changes: 1 addition & 3 deletions api/src/main/java/javax/interceptor/InvocationContext.java
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,8 @@
import java.util.Map;

/**
* <p>
* Exposes contextual information about the intercepted invocation and operations that enable interceptor methods to
* control the behavior of the invocation chain.
* </p>
*
* <pre>
*
Expand Down Expand Up @@ -53,7 +51,7 @@ public interface InvocationContext {

/**
* Returns the target instance. For {@link AroundConstruct} lifecycle callback interceptor methods, the
* <tt>getTarget</tt> method returns <code>null</code> if called before the {@link #proceed} method.
* <code>getTarget</code> method returns <code>null</code> if called before the {@link #proceed} method.
*
* @return the target instance
*/
Expand Down
4 changes: 2 additions & 2 deletions api/src/main/java/javax/interceptor/package.html
Original file line number Diff line number Diff line change
Expand Up @@ -68,8 +68,8 @@ <h3>Interceptor methods</h3>

<p>An interceptor method may be defined using annotations or,
optionally, by means of a deployment descriptor. Interceptor methods
may not be declared <tt>abstract</tt>, <tt>static</tt>, or
<tt>final</tt>.</p>
may not be declared <code>abstract</code>, <code>static</code>, or
<code>final</code>.</p>

<p>An interceptor class or target class may have multiple interceptor methods. However,
an interceptor class or target class may have no more than one interceptor method of a
Expand Down
5 changes: 3 additions & 2 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,10 @@

<groupId>org.eclipse.ee4j.interceptor-api</groupId>
<artifactId>interceptor-api-parent</artifactId>
<packaging>pom</packaging>
<version>1.2.4-SNAPSHOT</version>
<name>${extension.name} API</name>
<packaging>pom</packaging>

<name>${extension.name} API - Parent</name>
<description>Eclipse Interceptors</description>
<url>https://github.com/eclipse-ee4j/interceptor-api</url>

Expand Down

0 comments on commit 5ad60bd

Please sign in to comment.