Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add explicit notes to APIs that are not required to be present in CDI Lite #580

Merged
merged 1 commit into from
Dec 8, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
6 changes: 4 additions & 2 deletions api/src/main/java/jakarta/decorator/Decorator.java
Original file line number Diff line number Diff line change
Expand Up @@ -41,9 +41,11 @@
* Decorators of a stateful session bean must comply with the rules for instance passivation and conversational state defined by
* the EJB specification.
* </p>
*
*
* <p>CDI Lite implementations are not required to provide support for decorators.</p>
*
* @see Delegate &#064;Delegate identifies the delegate injection point of a decorator.
*
*
* @author Gavin King
* @author Pete Muir
*/
Expand Down
4 changes: 3 additions & 1 deletion api/src/main/java/jakarta/decorator/Delegate.java
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,9 @@
* ...
* }
* </pre>
*
*
* <p>CDI Lite implementations are not required to provide support for decorators.</p>
*
* @see Decorator &#064;Decorator specifies that a class is a decorator.
*
* @author Gavin King
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,8 @@
* conversation and throw an exception of type <code>BusyConversationException</code> from the restore view phase of the JSF
* lifecycle.
* </p>
*
* <p>CDI Lite implementations are not required to provide support for conversations.</p>
*
* @see ConversationScoped
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,8 @@
* The conversation timeout is a hint to the container that a conversation should not be destroyed if it has been active within
* the last given interval in milliseconds.
* </p>
*
* <p>CDI Lite implementations are not required to provide support for conversations.</p>
*
* @see ConversationScoped &#064;ConversationScoped
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,8 @@
* Servlet request, in order to conserve resources.</li>
* </ul>
*
* <p>CDI Lite implementations are not required to provide support for conversations.</p>
*
* @see Conversation
* @see NonexistentConversationException
* @see BusyConversationException
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,8 @@
* If the propagated conversation cannot be restored, the container must associate the request with a new transient conversation
* and throw an exception of type <code>NonexistentConversationException</code>.
* </p>
*
* <p>CDI Lite implementations are not required to provide support for conversations.</p>
*
* @see ConversationScoped
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,8 @@
* with qualifier <code>@Destroyed(SessionScoped.class)</code> when the session context is destroyed. The event payload is
* the <code>HttpSession</code>
*
* <p>CDI Lite implementations are not required to provide support for the session scope.</p>
*
* @author Gavin King
* @author Pete Muir
* @author Antoine Sabot-Durand
Expand Down
2 changes: 2 additions & 0 deletions api/src/main/java/jakarta/enterprise/inject/Decorated.java
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,8 @@
* }
* }
* </pre>
*
* <p>CDI Lite implementations are not required to provide support for decorators.</p>
*
* @author Pete Muir
* @since 1.1
Expand Down
2 changes: 2 additions & 0 deletions api/src/main/java/jakarta/enterprise/inject/Specializes.java
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,8 @@
* <p>
* If a bean is specialized by any enabled bean, the first bean is disabled.
* </p>
*
* <p>CDI Lite implementations are not required to provide support for specialization.</p>
*
* @author Gavin King
* @author Pete Muir
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,8 @@
* If no qualifier is passed to {@link #select} method, the <code>@Default</code> qualifier is assumed.
* </p>
*
* <p>CDI Lite implementations are not required to provide support for CDI in Java SE.</p>
*
* @author Antoine Sabot-Durand
* @author John D. Ament
* @author Graeme Rocher
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,8 @@
* SeContainer container = container.initialize();
* </pre>
*
* <p>CDI Lite implementations are not required to provide support for CDI in Java SE.</p>
*
* @author Antoine Sabot-Durand
* @author Martin Kouba
* @author John D. Ament
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,8 @@
* If any observer method of the {@code AfterBeanDiscovery} event throws an exception, the exception is treated as a definition
* error by the container.
* </p>
*
* <p>CDI Lite implementations are not required to provide support for Portable Extensions.</p>
*
* @author David Allen
* @author Antoine Sabot-Durand
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,9 @@
* <p>
* No requests will be processed by the deployment until all observers of this event return.
* </p>
*
*
* <p>CDI Lite implementations are not required to provide support for Portable Extensions.</p>
*
* @author David Allen
*/
public interface AfterDeploymentValidation {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,8 @@
* Changes made to these lists after the invocation of the last observer method of the {@code AfterTypeDiscovery} are ignored.
* </p>
*
* <p>CDI Lite implementations are not required to provide support for Portable Extensions.</p>
*
* @author Pete Muir
* @author Antoine Sabot-Durand
* @since 1.1
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@

/**
* <p>
* {@link BeanContainer} is a superclass of {@link BeanManager} containing capabilities that are portable across
* {@code BeanContainer} is a superclass of {@link BeanManager} containing capabilities that are portable across
* all CDI environments.
* </p>
*
Expand All @@ -33,7 +33,7 @@
*
* <pre>
* &#064;Inject
* BeanContainer manager;
* BeanContainer container;
* </pre>
*
* @author Matej Novotny
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,8 @@
* </p>
*
* <p>
* In CDI Lite environment, attempting to obtain a {@link BeanManager} or invoking methods on it results in non-portable behavior.
* In CDI Lite environment, applications may obtain a {@code BeanManager}, but invoking methods that are not inherited
* from {@link BeanContainer} results in non-portable behavior.
* </p>
*
* <p>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,9 @@
* This event type is thrown by the container before the bean discovery process begins. If any observer method of the
* {@code BeforeBeanDiscovery} event throws an exception, the exception is treated as a definition error by the container.
* </p>
*
*
* <p>CDI Lite implementations are not required to provide support for Portable Extensions.</p>
*
* @author Pete Muir
* @author David Allen
* @author Antoine Sabot-Durand
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,9 @@
* The type of the final event the container fires after it has finished processing requests and destroyed all contexts. If any
* observer method of the {@code BeforeShutdown} event throws an exception, the exception is ignored by the container.
* </p>
*
*
* <p>CDI Lite implementations are not required to provide support for Portable Extensions.</p>
*
* @author David Allen
*/
public interface BeforeShutdown {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,8 @@
* given priority value for entire application.
* </p>
*
* <p>CDI Lite implementations are not required to provide support for decorators.</p>
*
* @author Gavin King
* @author Pete Muir
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,8 @@
* Service providers are made available for injection as beans with the qualifier {@link Default
* &#064;Default}.
* </p>
*
* <p>CDI Lite implementations are not required to provide support for Portable Extensions.</p>
*
* @author Gavin King
* @author Pete Muir
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@
* Provides operations for performing {@linkplain jakarta.enterprise.inject dependency injection} and lifecycle callbacks on an
* instance of a type.
* </p>
*
* <p>CDI Lite implementations are not required to provide support for {@code InjectionTarget}.</p>
*
* @see jakarta.annotation.PostConstruct
* @see jakarta.annotation.PreDestroy
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,8 @@
* }
* });
* </pre>
*
* <p>CDI Lite implementations are not required to provide support for {@code InjectionTargetFactory}.</p>
*
* @author Pete Muir
* @author Antoine Sabot-Durand
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,8 @@
* Instances of this class are neither reusable nor suitable for sharing between threads.
* </p>
*
* <p>CDI Lite implementations are not required to provide support for {@code InterceptionFactory}.</p>
*
* @author Antoine Sabot-Durand
* @since 2.0
* @param <T> type for which the wrapper is created
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@
/**
* Indicates that a custom implementation of {@link Bean} or
* {@link Contextual} is passivation capable.
*
* <p>CDI Lite implementations are not required to provide support for passivation.</p>
*
* @author Gavin King
* @author David Allen
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,9 @@
* If any observer method of a {@code ProcessAnnotatedType} event throws an exception, the exception is treated as a definition
* error by the container.
* </p>
*
*
* <p>CDI Lite implementations are not required to provide support for Portable Extensions.</p>
*
* @author David Allen
* @author Antoine Sabot-Durand
* @see AnnotatedType
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,9 @@
* If any observer method of a {@code ProcessBean} event throws an exception, the exception is treated as a definition error by
* the container.
* </p>
*
*
* <p>CDI Lite implementations are not required to provide support for Portable Extensions.</p>
*
* @see Bean
* @author David Allen
* @param <X> The class of the bean
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,9 @@
* If any observer method of a {@code ProcessBeanAttributes} event throws an exception, the exception is treated as a definition
* error by the container.
* </p>
*
*
* <p>CDI Lite implementations are not required to provide support for Portable Extensions.</p>
*
* @author Pete Muir
* @author Antoine Sabot-Durand
* @param <T> The class of the bean
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,9 @@
* If any observer method of a {@code ProcessInjectionPoint} event throws an exception, the exception is treated as a definition
* error by the container.
* </p>
*
*
* <p>CDI Lite implementations are not required to provide support for Portable Extensions.</p>
*
* @see InjectionPoint
* @author Pete Muir
* @author Antoine Sabot-Durand
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,9 @@
* If any observer method of a {@code ProcessInjectionTarget} event throws an exception, the exception is treated as a
* definition error by the container.
* </p>
*
*
* <p>CDI Lite implementations are not required to provide support for Portable Extensions.</p>
*
* @see InjectionTarget
* @author David Allen
* @param <X> The managed bean class, session bean class or Java EE component class supporting injection
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,9 @@
* If any observer method of a {@code ProcessManagedBean} event throws an exception, the exception is treated as a definition
* error by the container.
* </p>
*
*
* <p>CDI Lite implementations are not required to provide support for Portable Extensions.</p>
*
* @author David Allen
* @param <X> The class of the bean
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,8 @@
* error by the container.
* </p>
*
* <p>CDI Lite implementations are not required to provide support for Portable Extensions.</p>
*
* @see ObserverMethod
* @author Gavin King
* @author David Allen
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,9 @@
* If any observer method of a {@code ProcessProducer} event throws an exception, the exception is treated as a definition error
* by the container.
* </p>
*
*
* <p>CDI Lite implementations are not required to provide support for Portable Extensions.</p>
*
* @see Producer
* @author David Allen
* @param <T> The bean class of the bean that declares the producer method or field
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,9 @@
* If any observer method of a {@code ProcessProducerField} event throws an exception, the exception is treated as a definition
* error by the container.
* </p>
*
*
* <p>CDI Lite implementations are not required to provide support for Portable Extensions.</p>
*
* @author David Allen
* @param <T> The type of the producer field
* @param <X> The class of the bean declaring the producer field
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,9 @@
* If any observer method of a {@code ProcessProducerMethod} event throws an exception, the exception is treated as a definition
* error by the container.
* </p>
*
*
* <p>CDI Lite implementations are not required to provide support for Portable Extensions.</p>
*
* @author David Allen
* @param <T> The return type of the producer method
* @param <X> The class of the bean declaring the producer method
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,8 @@
* allows you access to the {@link Bean}, which in turn allows you to instantiate an instance, which, for interface-view EJBs
* will not be an instance of X.
* </p>
*
* <p>CDI Lite implementations are not required to provide support for Portable Extensions.</p>
*
* @author David Allen
* @param <X> session bean type
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,9 @@
* If any observer method of a {@code ProcessSyntheticAnnotatedType} event throws an exception, the exception is treated as a
* definition error by the container.
* </p>
*
*
* <p>CDI Lite implementations are not required to provide support for Portable Extensions.</p>
*
* @author David Allen
* @author Pete Muir
* @see AnnotatedType
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,9 @@
* If any observer method of a {@code ProcessSyntheticBean} event throws an exception, the exception is treated as a definition
* error by the container.
* </p>
*
*
* <p>CDI Lite implementations are not required to provide support for Portable Extensions.</p>
*
* @author Martin Kouba
* @param <X> The class of the bean
* @since 2.0
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,8 @@
* error by the container.
* </p>
*
* <p>CDI Lite implementations are not required to provide support for Portable Extensions.</p>
*
* @see ObserverMethod
* @author Martin Kouba
* @param <T> The type of the event being observed
Expand Down
2 changes: 2 additions & 0 deletions api/src/main/java/jakarta/enterprise/inject/spi/Producer.java
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,8 @@
* <p>
* Provides a generic operation for producing an instance of a type.
* </p>
*
* <p>CDI Lite implementations are not required to provide support for {@code Producer}.</p>
*
* @author Pete Muir
* @author David Allen
Expand Down