Skip to content

Commit

Permalink
Update specs and javadoc for Jakarta names (#404)
Browse files Browse the repository at this point in the history
* Swtich to Jakarta EE parent pom (#398)

* New structure to test releases on CI (#401)

* New structure for release testing

Signed-off-by: Scott M Stark <starksm64@gmail.com>

* A structure to test release staging

Signed-off-by: Scott M Stark <starksm64@gmail.com>

* New structure for release testing

Signed-off-by: Scott M Stark <starksm64@gmail.com>

* Fix changes lost with merge

Signed-off-by: Scott M Stark <starksm64@gmail.com>

* Add -Xdoclint:none to avoid current javadoc errors

Signed-off-by: Scott M Stark <starksm64@gmail.com>

* Fix the javadoc errors

Signed-off-by: Scott M Stark <starksm64@gmail.com>

* Update el version to 3.0.3 and interceptor version to 1.2.5 to match the Jakarta EE 8 staging releases

Signed-off-by: starksm64 <starksm64@gmail.com>

* Update to use Jakarta EE names

Signed-off-by: starksm64 <starksm64@gmail.com>

* Update to use Jakarta names

Signed-off-by: starksm64 <starksm64@gmail.com>
  • Loading branch information
starksm64 committed Jul 28, 2019
1 parent 5f1c920 commit 065db7f
Show file tree
Hide file tree
Showing 39 changed files with 380 additions and 378 deletions.
4 changes: 2 additions & 2 deletions api/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -132,8 +132,8 @@

<properties>
<atinject.api.version>1.0</atinject.api.version>
<uel.api.version>3.0.2</uel.api.version>
<interceptor.api.version>1.2.3</interceptor.api.version>
<uel.api.version>3.0.3</uel.api.version>
<interceptor.api.version>1.2.5</interceptor.api.version>
<maven.compiler.source>1.8</maven.compiler.source>
<maven.compiler.target>1.8</maven.compiler.target>
<maven-bundle-plugin.version>2.5.4</maven-bundle-plugin.version>
Expand Down
4 changes: 2 additions & 2 deletions api/src/main/java/javax/decorator/Decorator.java
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,9 @@
* </pre>
*
* <p>
* Decorators of a session bean must comply with the bean provider programming restrictions defined by the EJB specification.
* Decorators of a session bean must comply with the bean provider programming restrictions defined by the Jakarta Enterprise Bean specification.
* Decorators of a stateful session bean must comply with the rules for instance passivation and conversational state defined by
* the EJB specification.
* the Jakarta Enterprise Bean specification.
* </p>
*
* @see javax.decorator.Delegate &#064;Delegate identifies the delegate injection point of a decorator.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,17 +47,18 @@
* <li>during the <tt>service()</tt> method of any servlet in the web application, during the <tt>doFilter()</tt> method of any
* servlet filter and when the container calls any <tt>ServletContextListener</tt>, <tt>HttpSessionListener</tt>,
* <tt>AsyncListener</tt> or <tt>ServletRequestListener</tt>,</li>
* <li>during any Java EE web service invocation,</li>
* <li>during any remote method invocation of any EJB, during any asynchronous method invocation of any EJB, during any call to
* an EJB timeout method and during message delivery to any EJB message-driven bean,</li>
* <li>during any Jakarta EE web service invocation,</li>
* <li>during any remote method invocation of any Jakarta Enterprise Bean, during any asynchronous method invocation of any Jakarta Enterprise Bean, during any call to
* an Jakarta Enterprise Bean timeout method and during message delivery to any Jakarta Enterprise Bean message-driven bean,</li>
* <li>when the disposer method or <tt>@PreDestroy</tt> callback of any bean with any normal scope other than
* <tt>@ApplicationScoped</tt> is called, and</li>
* <li>during <tt>@PostConstruct</tt> callback of any bean.</li>
* </ul>
*
* <p>
* The application context is shared between all servlet requests, web service invocations, EJB remote method invocations, EJB
* asynchronous method invocations, EJB timeouts and message deliveries to message-driven beans that execute within the same
* The application context is shared between all servlet requests, web service invocations, Jakarta Enterprise Bean
* remote method invocations, Jakarta Enterprise Bean
* asynchronous method invocations, Jakarta Enterprise BeanJakarta Enterprise Bean timeouts and message deliveries to message-driven beans that execute within the same
* application.
* </p>
* <p>
Expand Down
6 changes: 3 additions & 3 deletions api/src/main/java/javax/enterprise/context/Dependent.java
Original file line number Diff line number Diff line change
Expand Up @@ -71,22 +71,22 @@
* </p>
*
* <p>
* Many instances of beans with scope <tt>@Dependent</tt> belong to some other bean or Java EE component class instance and are
* Many instances of beans with scope <tt>@Dependent</tt> belong to some other bean or Jakarta EE component class instance and are
* called dependent objects.
* </p>
*
* <ul>
* <li>Instances of decorators and interceptors are dependent objects of the bean instance they decorate.</li>
* <li>An instance of a bean with scope <tt>@Dependent</tt> injected into a field, bean constructor or initializer method is a
* dependent object of the bean or Java EE component class instance into which it was injected.</li>
* dependent object of the bean or Jakarta EE component class instance into which it was injected.</li>
* <li>An instance of a bean with scope <tt>@Dependent</tt> injected into a producer method is a dependent object of the
* producer method bean instance that is being produced.</li>
* <li>An instance of a bean with scope <tt>@Dependent</tt> obtained by direct invocation of an
* {@link javax.enterprise.inject.Instance} is a dependent object of the instance of {@link javax.enterprise.inject.Instance}.</li>
* </ul>
*
* <p>
* When the container destroys an instance of a bean or of any Java EE component class supporting injection, the container
* When the container destroys an instance of a bean or of any Jakarta EE component class supporting injection, the container
* destroys all its dependent objects, after the <tt>@PreDestroy</tt> callback completes and after the servlet
* <tt>destroy()</tt> method is called.
* </p>
Expand Down
8 changes: 4 additions & 4 deletions api/src/main/java/javax/enterprise/context/RequestScoped.java
Original file line number Diff line number Diff line change
Expand Up @@ -46,9 +46,9 @@
* <ul>
* <li>during the <tt>service()</tt> method of any servlet in the web application, during the <tt>doFilter()</tt> method of any
* servlet filter and when the container calls any <tt>ServletRequestListener</tt> or <tt>AsyncListener</tt>,</li>
* <li>during any Java EE web service invocation,</li>
* <li>during any remote method invocation of any EJB, during any asynchronous method invocation of any EJB, during any call to
* an EJB timeout method and during message delivery to any EJB message-driven bean, and</li>
* <li>during any Jakarta EE web service invocation,</li>
* <li>during any remote method invocation of any Jakarta Enterprise Bean, during any asynchronous method invocation of any Jakarta Enterprise Bean, during any call to
* an Jakarta Enterprise Bean timeout method and during message delivery to any Jakarta Enterprise Bean message-driven bean, and</li>
* <li>during <tt>@PostConstruct</tt> callback of any bean.</li>
* </ul>
*
Expand All @@ -60,7 +60,7 @@
* <li>at the end of the servlet request, after the <tt>service()</tt> method, all <tt>doFilter()</tt> methods, and all
* <tt>requestDestroyed()</tt> and <tt>onComplete()</tt> notifications return,</li>
* <li>after the web service invocation completes,</li>
* <li>after the EJB remote method invocation, asynchronous method invocation, timeout or message delivery completes if it
* <li>after the Jakarta Enterprise Bean remote method invocation, asynchronous method invocation, timeout or message delivery completes if it
* did not already exist when the invocation occurred, or</li>
* <li>after the <tt>@PostConstruct</tt> callback completes, if it did not already exist when the <tt>@PostConstruct</tt>
* callback occurred.</li>
Expand Down
6 changes: 3 additions & 3 deletions api/src/main/java/javax/enterprise/context/package-info.java
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@
* <p>The container provides an implementation of the <tt>Context</tt>
* interface for each of the built-in scopes. The built-in request,
* session, and application contexts support servlet, web service
* and EJB invocations. The built-in conversation context supports
* and Jakarta Enterprise Bean invocations. The built-in conversation context supports
* JSF requests.</p>
*
* <p>For other kinds of invocations, a portable extension may define a
Expand All @@ -53,10 +53,10 @@
* the built-in conversation scope.</p>
*
* <p>The context associated with a built-in scope propagates across
* local, synchronous Java method calls, including invocation of EJB
* local, synchronous Java method calls, including invocation of Jakarta Enterprise Bean
* local business methods. The context does not propagate across remote
* method invocations or to asynchronous processes such as JMS message
* listeners or EJB timer service timeouts.</p>
* listeners or Jakarta Enterprise Bean timer service timeouts.</p>
*
* <h3>Normal scopes and pseudo-scopes</h3>
*
Expand Down
2 changes: 1 addition & 1 deletion api/src/main/java/javax/enterprise/event/Observes.java
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@
* <p>
* An observer method is a non-abstract method of a managed bean class or session bean class (or of an extension). An observer
* method may be either static or non-static. If the bean is a session bean, the observer method must be either a business
* method of the EJB or a static method of the bean class.
* method of the Jakarta Enterprise Bean or a static method of the bean class.
* </p>
*
* <p>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
* <p>
* An observer method is a non-abstract method of a managed bean class or session bean class (or of an extension). An observer
* method may be either static or non-static. If the bean is a session bean, the observer method must be either a business
* method of the EJB or a static method of the bean class.
* method of the Jakarta Enterprise Bean or a static method of the bean class.
* </p>
*
* <p>
Expand Down
2 changes: 1 addition & 1 deletion api/src/main/java/javax/enterprise/inject/Disposes.java
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@
*
* <p>
* A disposer method must be a non-abstract method of a managed bean class or session bean class. A disposer method may be
* either static or non-static. If the bean is a session bean, the disposer method must be a business method of the EJB or a
* either static or non-static. If the bean is a session bean, the disposer method must be a business method of the Jakarta Enterprise Bean or a
* static method of the bean class.
* </p>
*
Expand Down
2 changes: 1 addition & 1 deletion api/src/main/java/javax/enterprise/inject/Produces.java
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
*
* <p>
* A producer method must be a non-abstract method of a managed bean class or session bean class. A producer method may be
* either static or non-static. If the bean is a session bean, the producer method must be either a business method of the EJB
* either static or non-static. If the bean is a session bean, the producer method must be either a business method of the Jakarta Enterprise Bean
* or a static method of the bean class.
* </p>
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ public abstract class SeContainerInitializer {
* Each call returns a new instance
*
* @return a new SeContainerInitializer instance.
* @throws IllegalStateException if called in a Java EE container
* @throws IllegalStateException if called in a Jakarta EE container
*/
public static SeContainerInitializer newInstance() {
return findSeContainerInitializer();
Expand Down
12 changes: 6 additions & 6 deletions api/src/main/java/javax/enterprise/inject/spi/BeanManager.java
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@
* </pre>
*
* <p>
* Java EE components may obtain an instance of <tt>BeanManager</tt> from {@linkplain javax.naming JNDI} by looking up the name
* Jakarta EE components may obtain an instance of <tt>BeanManager</tt> from {@linkplain javax.naming JNDI} by looking up the name
* {@code java:comp/BeanManager}.
* </p>
*
Expand Down Expand Up @@ -136,7 +136,7 @@ public interface BeanManager {

/**
* Return the set of beans which have the given required type and qualifiers and are available for injection in the module
* or library containing the class into which the <tt>BeanManager</tt> was injected or the Java EE component from whose JNDI
* or library containing the class into which the <tt>BeanManager</tt> was injected or the Jakarta EE component from whose JNDI
* environment namespace the <tt>BeanManager</tt> was obtained, according to the rules of typesafe resolution. If no
* qualifiers are given, the {@linkplain javax.enterprise.inject.Default default qualifier} is assumed.
* <br>
Expand All @@ -156,7 +156,7 @@ public interface BeanManager {

/**
* Return the set of beans which have the given EL name and are available for injection in the module or library containing
* the class into which the <tt>BeanManager</tt> was injected or the Java EE component from whose JNDI environment namespace
* the class into which the <tt>BeanManager</tt> was injected or the Jakarta EE component from whose JNDI environment namespace
* the <tt>BeanManager</tt> was obtained, according to the rules of EL name resolution.
* <br>
* Note that when called during invocation of an {@link AfterBeanDiscovery} event observer,
Expand Down Expand Up @@ -256,7 +256,7 @@ public interface BeanManager {

/**
* Return an ordered list of {@linkplain Decorator decorators} for a set of bean types and a set of qualifiers and which are
* enabled in the module or library containing the class into which the <tt>BeanManager</tt> was injected or the Java EE
* enabled in the module or library containing the class into which the <tt>BeanManager</tt> was injected or the Jakarta EE
* component from whose JNDI environment namespace the <tt>BeanManager</tt> was obtained.
*
* <br>
Expand All @@ -277,7 +277,7 @@ public interface BeanManager {
/**
* Return an ordered list of enabled {@linkplain Interceptor interceptors} for a set of interceptor bindings and a type of
* interception and which are enabled in the module or library containing the class into which the <tt>BeanManager</tt> was
* injected or the Java EE component from whose JNDI environment namespace the <tt>BeanManager</tt> was obtained.
* injected or the Jakarta EE component from whose JNDI environment namespace the <tt>BeanManager</tt> was obtained.
*
* <br>
* Note that when called during invocation of an {@link AfterBeanDiscovery} event observer,
Expand Down Expand Up @@ -642,7 +642,7 @@ public <T> Bean<T> createBean(BeanAttributes<T> attributes, Class<T> beanClass,
* Obtains an {@link Instance} object to access to beans instances.
*
* The returned <tt>Instance</tt> object can only access instances of beans that are available for injection in the module
* or library containing the class into which the <tt>BeanManager</tt> was injected or the Java EE component from whose JNDI
* or library containing the class into which the <tt>BeanManager</tt> was injected or the Jakarta EE component from whose JNDI
* environment namespace the <tt>BeanManager</tt> was obtained, according to the rules of typesafe resolution.
*
* Note that when called during invocation of an {@link AfterBeanDiscovery} event observer,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ public interface InjectionTarget<T> extends Producer<T> {

/**
* <p>
* Performs dependency injection upon the given object. Performs Java EE component environment injection, sets the value of
* Performs dependency injection upon the given object. Performs Jakarta EE component environment injection, sets the value of
* all injected fields, and calls all initializer methods.
* </p>
*
Expand All @@ -56,7 +56,7 @@ public interface InjectionTarget<T> extends Producer<T> {

/**
* <p>
* Calls the {@link javax.annotation.PreDestroy} callback, if it exists, according to the semantics required by the Java EE
* Calls the {@link javax.annotation.PreDestroy} callback, if it exists, according to the semantics required by the Jakarta EE
* platform specification.
* </p>
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@

/**
* <p>
* Identifies the kind of lifecycle callback, EJB timeout method or business method interception.
* Identifies the kind of lifecycle callback, Jakarta Enterprise Bean timeout method or business method interception.
* </p>
*
* @author Gavin King
Expand Down Expand Up @@ -54,12 +54,12 @@ public enum InterceptionType {
PRE_DESTROY,

/**
* Intercepts bean passivation, only called for EJBs
* Intercepts bean passivation, only called for Jakarta Enterprise Beans
*/
PRE_PASSIVATE,

/**
* Intercepts bean activation, only called for EJBs
* Intercepts bean activation, only called for Jakarta Enterprise Beans
*/
POST_ACTIVATE
}
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,9 @@

/**
* <p>
* The container fires an event of this type for every injection point of every Java EE component class supporting injection
* The container fires an event of this type for every injection point of every Jakarta EE component class supporting injection
* that may be instantiated by the container at runtime, including every managed bean declared using
* {@code javax.annotation.ManagedBean}, EJB session or message-driven bean, enabled bean, enabled interceptor or enabled
* {@code javax.annotation.ManagedBean}, Jakarta Enterprise Bean session or message-driven bean, enabled bean, enabled interceptor or enabled
* decorator.
* </p>
* <p>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,14 +18,14 @@

/**
* <p>
* The container fires an event of this type for every Java EE component class supporting injection that may be instantiated by
* the container at runtime, including every managed bean declared using {@code javax.annotation.ManagedBean}, EJB session or
* The container fires an event of this type for every Jakarta EE component class supporting injection that may be instantiated by
* the container at runtime, including every managed bean declared using {@code javax.annotation.ManagedBean}, Jakarta Enterprise Bean session or
* message-driven bean, enabled bean, enabled interceptor or enabled decorator.
* </p>
* <p>
* Any observer of this event is permitted to wrap and/or replace the {@link javax.enterprise.inject.spi.InjectionTarget}. The
* container must use the final value of this property, after all observers have been called, whenever it performs injection
* upon the managed bean, session bean or other Java EE component class supporting injection.
* upon the managed bean, session bean or other Jakarta EE component class supporting injection.
* </p>
* <p>
* For example, this observer decorates the {@code InjectionTarget} for all servlets.
Expand All @@ -43,12 +43,12 @@
*
* @see InjectionTarget
* @author David Allen
* @param <X> The managed bean class, session bean class or Java EE component class supporting injection
* @param <X> The managed bean class, session bean class or Jakarta EE component class supporting injection
*/
public interface ProcessInjectionTarget<X> {
/**
* Returns the {@link javax.enterprise.inject.spi.AnnotatedType} representing the managed bean class, session bean class or
* other Java EE component class supporting injection.
* other Jakarta EE component class supporting injection.
*
* @return the {@link javax.enterprise.inject.spi.AnnotatedType} of the bean with an injection target
* @throws IllegalStateException if called outside of the observer method invocation
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
*
* <p>
* Note that the type parameter of the super-interface of {@link ProcessSessionBean} is {@link Object} as {@link ProcessBean}
* allows you access to the {@link Bean}, which in turn allows you to instantiate an instance, which, for interface-view EJBs
* allows you access to the {@link Bean}, which in turn allows you to instantiate an instance, which, for interface-view Jakarta Enterprise Beans
* will not be an instance of X.
* </p>
*
Expand All @@ -39,9 +39,9 @@
*/
public interface ProcessSessionBean<X> extends ProcessManagedBean<Object> {
/**
* Returns the EJB name of the session bean.
* Returns the Jakarta Enterprise Bean name of the session bean.
*
* @return the name of the EJB
* @return the name of the Jakarta Enterprise Bean
* @throws IllegalStateException if called outside of the observer method invocation
*/
public String getEjbName();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
package javax.enterprise.inject.spi;

/**
* Identifies the kind of EJB session bean.
* Identifies the kind of Jakarta Enterprise Bean session bean.
*
* @author Gavin King
*
Expand Down
Loading

0 comments on commit 065db7f

Please sign in to comment.