diff --git a/cdi/4.1/_index.md b/cdi/4.1/_index.md index b625457d45..e1ab5c154a 100644 --- a/cdi/4.1/_index.md +++ b/cdi/4.1/_index.md @@ -1,6 +1,6 @@ --- -title: "Jakarta Contexts and Dependency Injection 4.1 (Under development)" -date: 2023-11-30 +title: "Jakarta Contexts and Dependency Injection 4.1" +date: 2024-02-29 summary: "Release for Jakarta EE 11" --- @@ -35,29 +35,31 @@ and refactors features that are not client facing into the subinterface. ### Minimum Java SE Version -**Java SE 21 or higher** +**Java SE 11 or higher** # Details * [Jakarta Contexts Dependency Injection 4.1 Release Record](https://projects.eclipse.org/projects/ee4j.cdi/releases/4.1) -* [Jakarta Contexts Dependency Injection 4.1-M1 Specification Document](./jakarta-cdi-spec-4.1-M1.pdf) (PDF) -* [Jakarta Contexts Dependency Injection 4.1-M1 Specification Document](./jakarta-cdi-spec-4.1-M1.html) (HTML) -* [Jakarta Contexts Dependency Injection 4.1-M1 Javadoc](./apidocs) -* [Jakarta Contexts Dependency Injection 4.1-M1 TCK](https://www.eclipse.org/downloads/download.php?file=/ee4j/cdi/4.1/cdi-tck-4.1.0-M1-dist.zip) +* [Jakarta Contexts Dependency Injection 4.1 Specification Document](./jakarta-cdi-spec-4.1.pdf) (PDF) +* [Jakarta Contexts Dependency Injection 4.1 Specification Document](./jakarta-cdi-spec-4.1.html) (HTML) +* [Jakarta Contexts Dependency Injection 4.1 Javadoc](./apidocs) +* [Jakarta Contexts Dependency Injection 4.1.0 TCK](https://www.eclipse.org/downloads/download.php?file=/ee4j/cdi/4.1/cdi-tck-4.1.0-dist.zip) ([sig](https://download.eclipse.org/jakartaee/cdi/4.1/TBD.zip.sig), [sha](https://download.eclipse.org/jakartaee/cdi/4.1/TBD.zip.sha256), [pub](https://raw.githubusercontent.com/jakartaee/specification-committee/master/jakartaee-spec-committee.pub)) * Maven coordinates - * [jakarta.enterprise:jakarta.enterprise.cdi-api:4.1.0-M1](https://search.maven.org/artifact/jakarta.enterprise/jakarta.enterprise.cdi-api/4.1.0-M1/jar) + * [jakarta.enterprise:jakarta.enterprise.cdi-api:4.1.0](https://search.maven.org/artifact/jakarta.enterprise/jakarta.enterprise.cdi-api/4.1.0/jar) + * [jakarta.enterprise:jakarta.enterprise.lang-model:4.1.0](https://search.maven.org/artifact/jakarta.enterprise/jakarta.enterprise.lang-model/4.1.0/jar) + * [jakarta.enterprise:jakarta.enterprise.cdi-el-api:4.1.0](https://search.maven.org/artifact/jakarta.enterprise/jakarta.enterprise.cdi-el-api/4.1.0/jar) * Schemas - * [XML Schema for the CDI 4.0 beans.xml deployment](https://jakarta.ee/xml/ns/jakartaee/beans_4_0.xsd) - * No changes currently planed for the schema + * [XML Schema for the CDI 4.1 beans.xml deployment](https://jakarta.ee/xml/ns/jakartaee/beans_4_1.xsd) + * The only change in the schema is the version number. The schema is backward compatible with CDI 4.0. # Compatible Implementations -* [Weld 6.0.0](https://weld.cdi-spec.org/download/) TBD +* [Weld 6.0.0.Beta1](https://weld.cdi-spec.org/download/) # Ballots diff --git a/cdi/4.1/apidocs/allclasses-index.html b/cdi/4.1/apidocs/allclasses-index.html index 78c63823c9..b467fd9354 100644 --- a/cdi/4.1/apidocs/allclasses-index.html +++ b/cdi/4.1/apidocs/allclasses-index.html @@ -1,346 +1,245 @@ - - -All Classes (Jakarta Contexts and Dependency Injection API) + +All Classes and Interfaces (Jakarta Contexts and Dependency Injection API) + + + + - - + - - - - - + + - - -
+
+ +
-

All Classes

-
-
- +
+ +
+
Supports inline instantiation of the Vetoed annotation.
+
+ +
+
The void pseudo-type.
+
+ +
+
A wildcard type.
+
+ +
+
+ WithAnnotations may be applied to any portable extension observer method with an event parameter type of + ProcessAnnotatedType to filter the events delivered.
+
+
+
- - - -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

- diff --git a/cdi/4.1/apidocs/allclasses.html b/cdi/4.1/apidocs/allclasses.html deleted file mode 100644 index d568f6ba7e..0000000000 --- a/cdi/4.1/apidocs/allclasses.html +++ /dev/null @@ -1,210 +0,0 @@ - - - - - -All Classes (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - -
-

All Classes

-
- -
-
- - diff --git a/cdi/4.1/apidocs/allpackages-index.html b/cdi/4.1/apidocs/allpackages-index.html index b255e76a1c..f4180bb859 100644 --- a/cdi/4.1/apidocs/allpackages-index.html +++ b/cdi/4.1/apidocs/allpackages-index.html @@ -1,233 +1,131 @@ - - + All Packages (Jakarta Contexts and Dependency Injection API) + + + + - - + - - - - - + + - - -
+
+ +

All Packages

-
- +
- - - -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

- diff --git a/cdi/4.1/apidocs/constant-values.html b/cdi/4.1/apidocs/constant-values.html index 192d06b40d..63de09f3b3 100644 --- a/cdi/4.1/apidocs/constant-values.html +++ b/cdi/4.1/apidocs/constant-values.html @@ -1,205 +1,110 @@ - - + Constant Field Values (Jakarta Contexts and Dependency Injection API) + + + + - - + - - - - - + + - - -
+
+ +

Constant Field Values

-
+
+

Contents

-
+
+

jakarta.enterprise.*

+
- - - -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

- diff --git a/cdi/4.1/apidocs/copy.svg b/cdi/4.1/apidocs/copy.svg new file mode 100644 index 0000000000..7c46ab15fe --- /dev/null +++ b/cdi/4.1/apidocs/copy.svg @@ -0,0 +1,33 @@ + + + + + + + + diff --git a/cdi/4.1/apidocs/deprecated-list.html b/cdi/4.1/apidocs/deprecated-list.html index 7670f26aab..8364946722 100644 --- a/cdi/4.1/apidocs/deprecated-list.html +++ b/cdi/4.1/apidocs/deprecated-list.html @@ -1,214 +1,121 @@ - - + Deprecated List (Jakarta Contexts and Dependency Injection API) + + + + - - + - - - - - + + - - -
+
+ +

Deprecated API

+

Contents

-
- - - -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

- diff --git a/cdi/4.1/apidocs/element-list b/cdi/4.1/apidocs/element-list index 34e34b85f4..be4946ea35 100644 --- a/cdi/4.1/apidocs/element-list +++ b/cdi/4.1/apidocs/element-list @@ -1,4 +1,3 @@ -module:jakarta.cdi jakarta.decorator jakarta.enterprise.context jakarta.enterprise.context.control @@ -10,5 +9,9 @@ jakarta.enterprise.inject.literal jakarta.enterprise.inject.se jakarta.enterprise.inject.spi jakarta.enterprise.inject.spi.configurator +jakarta.enterprise.inject.spi.el jakarta.enterprise.invoke +jakarta.enterprise.lang.model +jakarta.enterprise.lang.model.declarations +jakarta.enterprise.lang.model.types jakarta.enterprise.util diff --git a/cdi/4.1/apidocs/help-doc.html b/cdi/4.1/apidocs/help-doc.html index 8f52157ca1..d39d78194c 100644 --- a/cdi/4.1/apidocs/help-doc.html +++ b/cdi/4.1/apidocs/help-doc.html @@ -1,142 +1,132 @@ - - + API Help (Jakarta Contexts and Dependency Injection API) + + + + - - + - - - - - + + - - -
+
+ +
-
-

How This API Document Is Organized

-
This API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows.
-
-
-
    -
  • -
    -

    Overview

    -

    The Overview page is the front page of this API document and provides a list of all modules with a summary for each. This page can also contain an overall description of the set of modules.

    -
    +

    JavaDoc Help

    +
      +
    • Navigation: +
    • -
    • -
      -

      Module

      -

      Each module has a page that contains a list of its packages, dependencies on other modules, and services, with a summary for each. These page may contain three categories:

      -
    • -
    • -
      -

      Package

      -

      Each package has a page that contains a list of its classes and interfaces, with a summary for each. These pages may contain six categories:

      -
        +
      +
      +
      +

      Navigation

      +Starting from the Overview page, you can browse the documentation using the links in each page, and in the navigation bar at the top of each page. The Index and Search box allow you to navigate to specific declarations and summary pages, including: All Packages, All Classes and Interfaces + +
      +
      +
      +

      Kinds of Pages

      +The following sections describe the different kinds of pages in this collection. +
      +

      Overview

      +

      The Overview page is the front page of this API document and provides a list of all packages with a summary for each. This page can also contain an overall description of the set of packages.

      +
      +
      +

      Package

      +

      Each package has a page that contains a list of its classes and interfaces, with a summary for each. These pages may contain the following categories:

      +
      • Interfaces
      • Classes
      • -
      • Enums
      • -
      • Exceptions
      • -
      • Errors
      • -
      • Annotation Types
      • +
      • Enum Classes
      • +
      • Exception Classes
      • +
      • Annotation Interfaces
      -
    • -
    • -
      -

      Class or Interface

      -

      Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:

      -
        +
        +

        Class or Interface

        +

        Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a declaration and description, member summary tables, and detailed member descriptions. Entries in each of these sections are omitted if they are empty or not applicable.

        +
        • Class Inheritance Diagram
        • Direct Subclasses
        • All Known Subinterfaces
        • @@ -145,152 +135,76 @@

          Class or Interface

        • Class or Interface Description

        -
          +
          • Nested Class Summary
          • +
          • Enum Constant Summary
          • Field Summary
          • Property Summary
          • Constructor Summary
          • Method Summary
          • -
          -
          -
            -
          • Field Detail
          • -
          • Property Detail
          • -
          • Constructor Detail
          • -
          • Method Detail
          • -
          -

          Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.

          -
        - -
      • -
        -

        Annotation Type

        -

        Each annotation type has its own separate page with the following sections:

        -
          -
        • Annotation Type Declaration
        • -
        • Annotation Type Description
        • Required Element Summary
        • Optional Element Summary
        • -
        • Element Detail
        -
        -
      • -
      • -
        -

        Enum

        -

        Each enum has its own separate page with the following sections:

        -
          -
        • Enum Declaration
        • -
        • Enum Description
        • -
        • Enum Constant Summary
        • -
        • Enum Constant Detail
        • +
          +
            +
          • Enum Constant Details
          • +
          • Field Details
          • +
          • Property Details
          • +
          • Constructor Details
          • +
          • Method Details
          • +
          • Element Details
          +

          Note: Annotation interfaces have required and optional elements, but not methods. Only enum classes have enum constants. The components of a record class are displayed as part of the declaration of the record class. Properties are a feature of JavaFX.

          +

          The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.

        -
      • -
      • -
        -

        Use

        -

        Each documented package, class and interface has its own Use page. This page describes what packages, classes, methods, constructors and fields use any part of the given class or package. Given a class or interface A, its "Use" page includes subclasses of A, fields declared as A, methods that return A, and methods and constructors with parameters of type A. You can access this page by first going to the package, class or interface, then clicking on the "Use" link in the navigation bar.

        +
        +

        Other Files

        +

        Packages and modules may contain pages with additional information related to the declarations nearby.

        -
      • -
      • -
        -

        Tree (Class Hierarchy)

        +
        +

        Use

        +

        Each documented package, class and interface has its own Use page. This page describes what packages, classes, methods, constructors and fields use any part of the given class or package. Given a class or interface A, its Use page includes subclasses of A, fields declared as A, methods that return A, and methods and constructors with parameters of type A. You can access this page by first going to the package, class or interface, then clicking on the USE link in the navigation bar.

        +
        +
        +

        Tree (Class Hierarchy)

        There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. Classes are organized by inheritance structure starting with java.lang.Object. Interfaces do not inherit from java.lang.Object.

        -
          -
        • When viewing the Overview page, clicking on "Tree" displays the hierarchy for all packages.
        • -
        • When viewing a particular package, class or interface page, clicking on "Tree" displays the hierarchy for only that package.
        • +
            +
          • When viewing the Overview page, clicking on TREE displays the hierarchy for all packages.
          • +
          • When viewing a particular package, class or interface page, clicking on TREE displays the hierarchy for only that package.
        -
      • -
      • -
        -

        Deprecated API

        -

        The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.

        +
        +

        Deprecated API

        +

        The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to shortcomings, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.

        -
      • -
      • -
        -

        Index

        -

        The Index contains an alphabetic index of all classes, interfaces, constructors, methods, and fields, as well as lists of all packages and all classes.

        +
        +

        Constant Field Values

        +

        The Constant Field Values page lists the static final fields and their values.

        -
      • -
      • -
        -

        All Classes

        -

        The All Classes link shows all classes and interfaces except non-static nested types.

        +
        +

        Serialized Form

        +

        Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to those who implement rather than use the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See Also" section of the class description.

        -
      • -
      • -
        -

        Serialized Form

        -

        Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description.

        +
        +

        All Packages

        +

        The All Packages page contains an alphabetic index of all packages contained in the documentation.

        -
      • -
      • -
        -

        Constant Field Values

        -

        The Constant Field Values page lists the static final fields and their values.

        +
        +

        All Classes and Interfaces

        +

        The All Classes and Interfaces page contains an alphabetic index of all classes and interfaces contained in the documentation, including annotation interfaces, enum classes, and record classes.

        -
      • -
      • -
        -

        Search

        -

        You can search for definitions of modules, packages, types, fields, methods and other terms defined in the API, using some or all of the name. "Camel-case" abbreviations are supported: for example, "InpStr" will find "InputStream" and "InputStreamReader".

        +
        +

        Index

        +

        The Index contains an alphabetic index of all classes, interfaces, constructors, methods, and fields in the documentation, as well as summary pages such as All Packages, All Classes and Interfaces.

        -
      • -
      +

-This help file applies to API documentation generated by the standard doclet.
- +This help file applies to API documentation generated by the standard doclet.
- - - -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

- diff --git a/cdi/4.1/apidocs/index-all.html b/cdi/4.1/apidocs/index-all.html index 518820b3d1..d333dff01f 100644 --- a/cdi/4.1/apidocs/index-all.html +++ b/cdi/4.1/apidocs/index-all.html @@ -1,769 +1,939 @@ - - + Index (Jakarta Contexts and Dependency Injection API) + + + + - - + - - - - - + + - - -
+
+ +
-
A B C D E F G H I J L M N O P Q R S T U V W 
All Classes All Packages - - -

A

-
-
accept(EventContext<T>) - Method in interface jakarta.enterprise.inject.spi.configurator.ObserverMethodConfigurator.EventConsumer
+
+

Index

+
+A B C D E F G H I J K L M N O P Q R S T U V W 
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form +

A

+
+
accept(EventContext<T>) - Method in interface jakarta.enterprise.inject.spi.configurator.ObserverMethodConfigurator.EventConsumer
 
-
activate() - Method in interface jakarta.enterprise.context.control.RequestContextController
+
accessor() - Method in interface jakarta.enterprise.lang.model.declarations.RecordComponentInfo
+
+
Returns the accessor method corresponding to this record component.
+
+
activate() - Method in interface jakarta.enterprise.context.control.RequestContextController
Activates a RequestContext for the current thread if one is not already active.
-
ActivateRequestContext - Annotation Type in jakarta.enterprise.context.control
+
ActivateRequestContext - Annotation Interface in jakarta.enterprise.context.control
The container provides a built in interceptor that may be used to annotate classes and methods to indicate that a request context should be activated when this method is invoked.
-
add(Annotation) - Method in interface jakarta.enterprise.inject.spi.configurator.AnnotatedConstructorConfigurator
+
add(Annotation) - Method in interface jakarta.enterprise.inject.spi.configurator.AnnotatedConstructorConfigurator
Add an annotation to the constructor.
-
add(Annotation) - Method in interface jakarta.enterprise.inject.spi.configurator.AnnotatedFieldConfigurator
+
add(Annotation) - Method in interface jakarta.enterprise.inject.spi.configurator.AnnotatedFieldConfigurator
Add an annotation to the field.
-
add(Annotation) - Method in interface jakarta.enterprise.inject.spi.configurator.AnnotatedMethodConfigurator
+
add(Annotation) - Method in interface jakarta.enterprise.inject.spi.configurator.AnnotatedMethodConfigurator
Add an annotation to the method.
-
add(Annotation) - Method in interface jakarta.enterprise.inject.spi.configurator.AnnotatedParameterConfigurator
+
add(Annotation) - Method in interface jakarta.enterprise.inject.spi.configurator.AnnotatedParameterConfigurator
Add an annotation to the parameter.
-
add(Annotation) - Method in interface jakarta.enterprise.inject.spi.configurator.AnnotatedTypeConfigurator
+
add(Annotation) - Method in interface jakarta.enterprise.inject.spi.configurator.AnnotatedTypeConfigurator
Add an annotation to the type.
-
add(String) - Method in interface jakarta.enterprise.inject.build.compatible.spi.ScannedClasses
+
add(String) - Method in interface jakarta.enterprise.inject.build.compatible.spi.ScannedClasses
Adds a class with given name to the set of types discovered during type discovery.
-
addAnnotatedType(AnnotatedType<?>, String) - Method in interface jakarta.enterprise.inject.spi.AfterTypeDiscovery
+
addAnnotatedType(AnnotatedType<?>, String) - Method in interface jakarta.enterprise.inject.spi.AfterTypeDiscovery
- Adds a given AnnotatedType to the set of types which will be scanned during bean - discovery.
+ Adds a given AnnotatedType to the set of types which will be scanned during bean discovery.
-
addAnnotatedType(AnnotatedType<?>, String) - Method in interface jakarta.enterprise.inject.spi.BeforeBeanDiscovery
+
addAnnotatedType(AnnotatedType<?>, String) - Method in interface jakarta.enterprise.inject.spi.BeforeBeanDiscovery
- Adds a given AnnotatedType to the set of types which will be scanned during bean - discovery.
+ Adds a given AnnotatedType to the set of types which will be scanned during bean discovery.
-
addAnnotatedType(Class<T>, String) - Method in interface jakarta.enterprise.inject.spi.AfterTypeDiscovery
+
addAnnotatedType(Class<T>, String) - Method in interface jakarta.enterprise.inject.spi.AfterTypeDiscovery
- Obtains a new AnnotatedTypeConfigurator to configure a new AnnotatedType and - add it to the set of types which will be scanned during bean discovery at the end of the observer invocation.
+ Obtains a new AnnotatedTypeConfigurator to configure a new AnnotatedType and add it to the set of types + which will be scanned during bean discovery at the end of the observer invocation.
-
addAnnotatedType(Class<T>, String) - Method in interface jakarta.enterprise.inject.spi.BeforeBeanDiscovery
+
addAnnotatedType(Class<T>, String) - Method in interface jakarta.enterprise.inject.spi.BeforeBeanDiscovery
- Obtains a new AnnotatedTypeConfigurator to configure a new AnnotatedType and + Obtains a new AnnotatedTypeConfigurator to configure a new AnnotatedType and add it to the set of types which will be scanned during bean discovery at the end of the observer invocation
-
addAnnotation(AnnotationInfo) - Method in interface jakarta.enterprise.inject.build.compatible.spi.ClassConfig
+
addAnnotation(AnnotationInfo) - Method in interface jakarta.enterprise.inject.build.compatible.spi.ClassConfig
Adds given annotation to this class.
-
addAnnotation(AnnotationInfo) - Method in interface jakarta.enterprise.inject.build.compatible.spi.DeclarationConfig
+
addAnnotation(AnnotationInfo) - Method in interface jakarta.enterprise.inject.build.compatible.spi.DeclarationConfig
Adds given annotation to this declaration.
-
addAnnotation(AnnotationInfo) - Method in interface jakarta.enterprise.inject.build.compatible.spi.FieldConfig
+
addAnnotation(AnnotationInfo) - Method in interface jakarta.enterprise.inject.build.compatible.spi.FieldConfig
Adds given annotation to this field.
-
addAnnotation(AnnotationInfo) - Method in interface jakarta.enterprise.inject.build.compatible.spi.MethodConfig
+
addAnnotation(AnnotationInfo) - Method in interface jakarta.enterprise.inject.build.compatible.spi.MethodConfig
Adds given annotation to this method.
-
addAnnotation(AnnotationInfo) - Method in interface jakarta.enterprise.inject.build.compatible.spi.ParameterConfig
+
addAnnotation(AnnotationInfo) - Method in interface jakarta.enterprise.inject.build.compatible.spi.ParameterConfig
Adds given annotation to this method parameter.
-
addAnnotation(Annotation) - Method in interface jakarta.enterprise.inject.build.compatible.spi.ClassConfig
+
addAnnotation(Annotation) - Method in interface jakarta.enterprise.inject.build.compatible.spi.ClassConfig
Adds given annotation to this class.
-
addAnnotation(Annotation) - Method in interface jakarta.enterprise.inject.build.compatible.spi.DeclarationConfig
+
addAnnotation(Annotation) - Method in interface jakarta.enterprise.inject.build.compatible.spi.DeclarationConfig
Adds given annotation to this declaration.
-
addAnnotation(Annotation) - Method in interface jakarta.enterprise.inject.build.compatible.spi.FieldConfig
+
addAnnotation(Annotation) - Method in interface jakarta.enterprise.inject.build.compatible.spi.FieldConfig
Adds given annotation to this field.
-
addAnnotation(Annotation) - Method in interface jakarta.enterprise.inject.build.compatible.spi.MethodConfig
+
addAnnotation(Annotation) - Method in interface jakarta.enterprise.inject.build.compatible.spi.MethodConfig
Adds given annotation to this method.
-
addAnnotation(Annotation) - Method in interface jakarta.enterprise.inject.build.compatible.spi.ParameterConfig
+
addAnnotation(Annotation) - Method in interface jakarta.enterprise.inject.build.compatible.spi.ParameterConfig
Adds given annotation to this method parameter.
-
addAnnotation(Class<? extends Annotation>) - Method in interface jakarta.enterprise.inject.build.compatible.spi.ClassConfig
+
addAnnotation(Class<? extends Annotation>) - Method in interface jakarta.enterprise.inject.build.compatible.spi.ClassConfig
Adds a marker annotation of given type to this class.
-
addAnnotation(Class<? extends Annotation>) - Method in interface jakarta.enterprise.inject.build.compatible.spi.DeclarationConfig
+
addAnnotation(Class<? extends Annotation>) - Method in interface jakarta.enterprise.inject.build.compatible.spi.DeclarationConfig
Adds a marker annotation of given type to this declaration.
-
addAnnotation(Class<? extends Annotation>) - Method in interface jakarta.enterprise.inject.build.compatible.spi.FieldConfig
+
addAnnotation(Class<? extends Annotation>) - Method in interface jakarta.enterprise.inject.build.compatible.spi.FieldConfig
Adds a marker annotation of given type to this field.
-
addAnnotation(Class<? extends Annotation>) - Method in interface jakarta.enterprise.inject.build.compatible.spi.MethodConfig
+
addAnnotation(Class<? extends Annotation>) - Method in interface jakarta.enterprise.inject.build.compatible.spi.MethodConfig
Adds a marker annotation of given type to this method.
-
addAnnotation(Class<? extends Annotation>) - Method in interface jakarta.enterprise.inject.build.compatible.spi.ParameterConfig
+
addAnnotation(Class<? extends Annotation>) - Method in interface jakarta.enterprise.inject.build.compatible.spi.ParameterConfig
Adds a marker annotation of given type to this method parameter.
-
addBean() - Method in interface jakarta.enterprise.inject.spi.AfterBeanDiscovery
+
addBean() - Method in interface jakarta.enterprise.inject.spi.AfterBeanDiscovery
-
Obtains a new BeanConfigurator to configure a new Bean and add it at the end of the observer invocation.
+
Obtains a new BeanConfigurator to configure a new Bean and add it at the end of the observer invocation.
-
addBean(Bean<?>) - Method in interface jakarta.enterprise.inject.spi.AfterBeanDiscovery
+
addBean(Bean<?>) - Method in interface jakarta.enterprise.inject.spi.AfterBeanDiscovery
-
Fires an event of type ProcessBean containing the given - Bean and then registers the Bean with the +
Fires an event of type ProcessBean containing the given + Bean and then registers the Bean with the container, thereby making a bean which is not an interceptor nor a decorator available for injection into other beans.
-
addBean(Class<T>) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticComponents
+
addBean(Class<T>) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticComponents
-
Creates a SyntheticBeanBuilder that allows configuring a new synthetic bean +
Creates a SyntheticBeanBuilder that allows configuring a new synthetic bean of given implementationClass.
-
addBeanClasses(Class<?>...) - Method in class jakarta.enterprise.inject.se.SeContainerInitializer
+
addBeanClasses(Class<?>...) - Method in class jakarta.enterprise.inject.se.SeContainerInitializer
Add provided bean classes to the synthetic bean archive.
-
addContext(Context) - Method in interface jakarta.enterprise.inject.spi.AfterBeanDiscovery
+
addContext(Context) - Method in interface jakarta.enterprise.inject.spi.AfterBeanDiscovery
-
Registers a custom Context object with the container.
+
Registers a custom Context object with the container.
-
addContext(Class<? extends Annotation>, boolean, Class<? extends AlterableContext>) - Method in interface jakarta.enterprise.inject.build.compatible.spi.MetaAnnotations
+
addContext(Class<? extends Annotation>, boolean, Class<? extends AlterableContext>) - Method in interface jakarta.enterprise.inject.build.compatible.spi.MetaAnnotations
Registers custom context for given scopeAnnotation and given contextClass.
-
addContext(Class<? extends Annotation>, Class<? extends AlterableContext>) - Method in interface jakarta.enterprise.inject.build.compatible.spi.MetaAnnotations
+
addContext(Class<? extends Annotation>, Class<? extends AlterableContext>) - Method in interface jakarta.enterprise.inject.build.compatible.spi.MetaAnnotations
Registers custom context for given scopeAnnotation and given contextClass.
-
addDefinitionError(Throwable) - Method in interface jakarta.enterprise.inject.spi.AfterBeanDiscovery
+
addDefinitionError(Throwable) - Method in interface jakarta.enterprise.inject.spi.AfterBeanDiscovery
Registers a definition error with the container, causing the container to abort deployment after all observers have been notified.
-
addDefinitionError(Throwable) - Method in interface jakarta.enterprise.inject.spi.ProcessBean
+
addDefinitionError(Throwable) - Method in interface jakarta.enterprise.inject.spi.ProcessBean
Registers a definition error with the container, causing the container to abort deployment after bean discovery is complete.
-
addDefinitionError(Throwable) - Method in interface jakarta.enterprise.inject.spi.ProcessBeanAttributes
+
addDefinitionError(Throwable) - Method in interface jakarta.enterprise.inject.spi.ProcessBeanAttributes
Registers a definition error with the container, causing the container to abort deployment after bean discovery is complete.
-
addDefinitionError(Throwable) - Method in interface jakarta.enterprise.inject.spi.ProcessInjectionPoint
+
addDefinitionError(Throwable) - Method in interface jakarta.enterprise.inject.spi.ProcessInjectionPoint
Registers a definition error with the container, causing the container to abort deployment after bean discovery is complete.
-
addDefinitionError(Throwable) - Method in interface jakarta.enterprise.inject.spi.ProcessInjectionTarget
+
addDefinitionError(Throwable) - Method in interface jakarta.enterprise.inject.spi.ProcessInjectionTarget
Registers a definition error with the container, causing the container to abort deployment after bean discovery is complete.
-
addDefinitionError(Throwable) - Method in interface jakarta.enterprise.inject.spi.ProcessObserverMethod
+
addDefinitionError(Throwable) - Method in interface jakarta.enterprise.inject.spi.ProcessObserverMethod
Registers a definition error with the container, causing the container to abort deployment after bean discovery is complete.
-
addDefinitionError(Throwable) - Method in interface jakarta.enterprise.inject.spi.ProcessProducer
+
addDefinitionError(Throwable) - Method in interface jakarta.enterprise.inject.spi.ProcessProducer
Registers a definition error with the container, causing the container to abort deployment after bean discovery is complete.
-
addDeploymentProblem(Throwable) - Method in interface jakarta.enterprise.inject.spi.AfterDeploymentValidation
+
addDeploymentProblem(Throwable) - Method in interface jakarta.enterprise.inject.spi.AfterDeploymentValidation
Registers a deployment problem with the container, causing the container to abort deployment after all observers have been notified.
-
addExtensions(Extension...) - Method in class jakarta.enterprise.inject.se.SeContainerInitializer
+
addExtensions(Extension...) - Method in class jakarta.enterprise.inject.se.SeContainerInitializer
Add extensions to the set of extensions.
-
addExtensions(Class<? extends Extension>...) - Method in class jakarta.enterprise.inject.se.SeContainerInitializer
+
addExtensions(Class<? extends Extension>...) - Method in class jakarta.enterprise.inject.se.SeContainerInitializer
Add extensions to the set of extensions.
-
addInjectionPoint(InjectionPoint) - Method in interface jakarta.enterprise.inject.spi.configurator.BeanConfigurator
+
addInjectionPoint(InjectionPoint) - Method in interface jakarta.enterprise.inject.spi.configurator.BeanConfigurator
Add an InjectionPoint to the configured bean
-
addInjectionPoints(InjectionPoint...) - Method in interface jakarta.enterprise.inject.spi.configurator.BeanConfigurator
+
addInjectionPoints(InjectionPoint...) - Method in interface jakarta.enterprise.inject.spi.configurator.BeanConfigurator
Add InjectionPoints to the configured bean
-
addInjectionPoints(Set<InjectionPoint>) - Method in interface jakarta.enterprise.inject.spi.configurator.BeanConfigurator
+
addInjectionPoints(Set<InjectionPoint>) - Method in interface jakarta.enterprise.inject.spi.configurator.BeanConfigurator
Add InjectionPoints to the configured bean
-
addInterceptorBinding(AnnotatedType<? extends Annotation>) - Method in interface jakarta.enterprise.inject.spi.BeforeBeanDiscovery
+
addInterceptorBinding(AnnotatedType<? extends Annotation>) - Method in interface jakarta.enterprise.inject.spi.BeforeBeanDiscovery
- Declares an annotation type as an interceptor binding type.
+ Declares an annotation type as an interceptor binding type.
-
addInterceptorBinding(Class<? extends Annotation>) - Method in interface jakarta.enterprise.inject.build.compatible.spi.MetaAnnotations
+
addInterceptorBinding(Class<? extends Annotation>) - Method in interface jakarta.enterprise.inject.build.compatible.spi.MetaAnnotations
Registers annotation as an interceptor binding annotation.
-
addInterceptorBinding(Class<? extends Annotation>, Annotation...) - Method in interface jakarta.enterprise.inject.spi.BeforeBeanDiscovery
+
addInterceptorBinding(Class<? extends Annotation>, Annotation...) - Method in interface jakarta.enterprise.inject.spi.BeforeBeanDiscovery
- Declares an annotation type as an interceptor binding type, and specifies its meta-annotations.
+ Declares an annotation type as an interceptor binding type, and specifies its meta-annotations.
-
addObserver(Type) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticComponents
+
addObserver(Type) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticComponents
-
Creates a SyntheticObserverBuilder that allows configuring a new synthetic observer +
Creates a SyntheticObserverBuilder that allows configuring a new synthetic observer for given eventType.
-
addObserver(Class<T>) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticComponents
+
addObserver(Class<T>) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticComponents
-
Creates a SyntheticObserverBuilder that allows configuring a new synthetic observer +
Creates a SyntheticObserverBuilder that allows configuring a new synthetic observer for given eventType.
-
addObserverMethod() - Method in interface jakarta.enterprise.inject.spi.AfterBeanDiscovery
+
addObserverMethod() - Method in interface jakarta.enterprise.inject.spi.AfterBeanDiscovery
-
obtains a new ObserverMethodConfigurator to configure a new ObserverMethod and add it at the end of the observer invocation.
+
obtains a new ObserverMethodConfigurator to configure a new ObserverMethod and add it at the end of the + observer invocation.
-
addObserverMethod(ObserverMethod<?>) - Method in interface jakarta.enterprise.inject.spi.AfterBeanDiscovery
+
addObserverMethod(ObserverMethod<?>) - Method in interface jakarta.enterprise.inject.spi.AfterBeanDiscovery
-
Fires an event of type ProcessObserverMethod containing the given - ObserverMethod and then registers the - ObserverMethod with the container, thereby making it available for event +
Fires an event of type ProcessObserverMethod containing the given + ObserverMethod and then registers the + ObserverMethod with the container, thereby making it available for event notifications.
-
addPackages(boolean, Class<?>...) - Method in class jakarta.enterprise.inject.se.SeContainerInitializer
+
addPackages(boolean, Class<?>...) - Method in class jakarta.enterprise.inject.se.SeContainerInitializer
-
Packages of the specified classes will be scanned and found classes will be added to the set of bean classes for the synthetic bean archive.*
+
Packages of the specified classes will be scanned and found classes will be added to the set of bean classes for the + synthetic bean archive.*
-
addPackages(boolean, Package...) - Method in class jakarta.enterprise.inject.se.SeContainerInitializer
+
addPackages(boolean, Package...) - Method in class jakarta.enterprise.inject.se.SeContainerInitializer
All classes from the specified packages will be added to the set of bean classes for the synthetic bean archive.
-
addPackages(Class<?>...) - Method in class jakarta.enterprise.inject.se.SeContainerInitializer
+
addPackages(Class<?>...) - Method in class jakarta.enterprise.inject.se.SeContainerInitializer
-
All classes from the packages of the specified classes will be added to the set of bean classes for the synthetic bean archive.
+
All classes from the packages of the specified classes will be added to the set of bean classes for the synthetic bean + archive.
-
addPackages(Package...) - Method in class jakarta.enterprise.inject.se.SeContainerInitializer
+
addPackages(Package...) - Method in class jakarta.enterprise.inject.se.SeContainerInitializer
All classes from the specified packages will be added to the set of bean classes for the synthetic bean archive.
-
addProperty(String, Object) - Method in class jakarta.enterprise.inject.se.SeContainerInitializer
+
addProperty(String, Object) - Method in class jakarta.enterprise.inject.se.SeContainerInitializer
Add a configuration property to the container
-
addQualifier(AnnotatedType<? extends Annotation>) - Method in interface jakarta.enterprise.inject.spi.BeforeBeanDiscovery
+
addQualifier(AnnotatedType<? extends Annotation>) - Method in interface jakarta.enterprise.inject.spi.BeforeBeanDiscovery
Declares an annotation type as a Qualifier qualifier type.
-
addQualifier(Annotation) - Method in interface jakarta.enterprise.inject.spi.configurator.BeanAttributesConfigurator
+
addQualifier(Annotation) - Method in interface jakarta.enterprise.inject.spi.configurator.BeanAttributesConfigurator
Add a qualifier to the configured bean
-
addQualifier(Annotation) - Method in interface jakarta.enterprise.inject.spi.configurator.BeanConfigurator
+
addQualifier(Annotation) - Method in interface jakarta.enterprise.inject.spi.configurator.BeanConfigurator
Add a qualifier to the configured bean
-
addQualifier(Annotation) - Method in interface jakarta.enterprise.inject.spi.configurator.InjectionPointConfigurator
+
addQualifier(Annotation) - Method in interface jakarta.enterprise.inject.spi.configurator.InjectionPointConfigurator
Add the qualifier to the InjectionPoint to build
-
addQualifier(Annotation) - Method in interface jakarta.enterprise.inject.spi.configurator.ObserverMethodConfigurator
+
addQualifier(Annotation) - Method in interface jakarta.enterprise.inject.spi.configurator.ObserverMethodConfigurator
Add the qualifier to the observed event
-
addQualifier(Class<? extends Annotation>) - Method in interface jakarta.enterprise.inject.build.compatible.spi.MetaAnnotations
+
addQualifier(Class<? extends Annotation>) - Method in interface jakarta.enterprise.inject.build.compatible.spi.MetaAnnotations
Registers annotation as a qualifier annotation.
-
addQualifier(Class<? extends Annotation>) - Method in interface jakarta.enterprise.inject.spi.BeforeBeanDiscovery
+
addQualifier(Class<? extends Annotation>) - Method in interface jakarta.enterprise.inject.spi.BeforeBeanDiscovery
Declares an annotation type as a Qualifier qualifier type.
-
addQualifiers(Annotation...) - Method in interface jakarta.enterprise.inject.spi.configurator.BeanAttributesConfigurator
+
addQualifiers(Annotation...) - Method in interface jakarta.enterprise.inject.spi.configurator.BeanAttributesConfigurator
Add qualifiers to the bean.
-
addQualifiers(Annotation...) - Method in interface jakarta.enterprise.inject.spi.configurator.BeanConfigurator
+
addQualifiers(Annotation...) - Method in interface jakarta.enterprise.inject.spi.configurator.BeanConfigurator
Add qualifiers to the bean.
-
addQualifiers(Annotation...) - Method in interface jakarta.enterprise.inject.spi.configurator.InjectionPointConfigurator
+
addQualifiers(Annotation...) - Method in interface jakarta.enterprise.inject.spi.configurator.InjectionPointConfigurator
Add all the qualifiers to the InjectionPoint to build
-
addQualifiers(Annotation...) - Method in interface jakarta.enterprise.inject.spi.configurator.ObserverMethodConfigurator
+
addQualifiers(Annotation...) - Method in interface jakarta.enterprise.inject.spi.configurator.ObserverMethodConfigurator
Add all the qualifiers to the Observed event
-
addQualifiers(Set<Annotation>) - Method in interface jakarta.enterprise.inject.spi.configurator.BeanAttributesConfigurator
+
addQualifiers(Set<Annotation>) - Method in interface jakarta.enterprise.inject.spi.configurator.BeanAttributesConfigurator
Add qualifiers to the bean.
-
addQualifiers(Set<Annotation>) - Method in interface jakarta.enterprise.inject.spi.configurator.BeanConfigurator
+
addQualifiers(Set<Annotation>) - Method in interface jakarta.enterprise.inject.spi.configurator.BeanConfigurator
Add qualifiers to the bean.
-
addQualifiers(Set<Annotation>) - Method in interface jakarta.enterprise.inject.spi.configurator.InjectionPointConfigurator
+
addQualifiers(Set<Annotation>) - Method in interface jakarta.enterprise.inject.spi.configurator.InjectionPointConfigurator
Add all the qualifiers to the InjectionPoint to build
-
addQualifiers(Set<Annotation>) - Method in interface jakarta.enterprise.inject.spi.configurator.ObserverMethodConfigurator
+
addQualifiers(Set<Annotation>) - Method in interface jakarta.enterprise.inject.spi.configurator.ObserverMethodConfigurator
Add all the qualifiers to the Observed event
-
addScope(Class<? extends Annotation>, boolean, boolean) - Method in interface jakarta.enterprise.inject.spi.BeforeBeanDiscovery
+
addScope(Class<? extends Annotation>, boolean, boolean) - Method in interface jakarta.enterprise.inject.spi.BeforeBeanDiscovery
- Declares an annotation type as a scope type.
+ Declares an annotation type as a scope type.
-
addStereotype(Class<? extends Annotation>) - Method in interface jakarta.enterprise.inject.build.compatible.spi.MetaAnnotations
+
addStereotype(Class<? extends Annotation>) - Method in interface jakarta.enterprise.inject.build.compatible.spi.MetaAnnotations
Registers annotation as a stereotype annotation.
-
addStereotype(Class<? extends Annotation>) - Method in interface jakarta.enterprise.inject.spi.configurator.BeanAttributesConfigurator
+
addStereotype(Class<? extends Annotation>) - Method in interface jakarta.enterprise.inject.spi.configurator.BeanAttributesConfigurator
Add a stereotype to the configured bean
-
addStereotype(Class<? extends Annotation>) - Method in interface jakarta.enterprise.inject.spi.configurator.BeanConfigurator
+
addStereotype(Class<? extends Annotation>) - Method in interface jakarta.enterprise.inject.spi.configurator.BeanConfigurator
Add a stereotype to the configured bean
-
addStereotype(Class<? extends Annotation>, Annotation...) - Method in interface jakarta.enterprise.inject.spi.BeforeBeanDiscovery
+
addStereotype(Class<? extends Annotation>, Annotation...) - Method in interface jakarta.enterprise.inject.spi.BeforeBeanDiscovery
- Declares an annotation type as a stereotype, and specifies its + Declares an annotation type as a stereotype, and specifies its meta-annotations.
-
addStereotypes(Set<Class<? extends Annotation>>) - Method in interface jakarta.enterprise.inject.spi.configurator.BeanAttributesConfigurator
+
addStereotypes(Set<Class<? extends Annotation>>) - Method in interface jakarta.enterprise.inject.spi.configurator.BeanAttributesConfigurator
Add stereotypes to the configured bean
-
addStereotypes(Set<Class<? extends Annotation>>) - Method in interface jakarta.enterprise.inject.spi.configurator.BeanConfigurator
+
addStereotypes(Set<Class<? extends Annotation>>) - Method in interface jakarta.enterprise.inject.spi.configurator.BeanConfigurator
Add stereotypes to the configured bean
-
addTransitiveTypeClosure(Type) - Method in interface jakarta.enterprise.inject.spi.configurator.BeanAttributesConfigurator
+
addTransitiveTypeClosure(Type) - Method in interface jakarta.enterprise.inject.spi.configurator.BeanAttributesConfigurator
Adds an unrestricted set of bean types for the given type as if it represented a bean class of a managed bean.
-
addTransitiveTypeClosure(Type) - Method in interface jakarta.enterprise.inject.spi.configurator.BeanConfigurator
+
addTransitiveTypeClosure(Type) - Method in interface jakarta.enterprise.inject.spi.configurator.BeanConfigurator
Adds an unrestricted set of bean types for the given type as if it represented a bean class of a managed bean.
-
addType(TypeLiteral<?>) - Method in interface jakarta.enterprise.inject.spi.configurator.BeanAttributesConfigurator
+
addType(TypeLiteral<?>) - Method in interface jakarta.enterprise.inject.spi.configurator.BeanAttributesConfigurator
Add a type to the bean types
-
addType(TypeLiteral<?>) - Method in interface jakarta.enterprise.inject.spi.configurator.BeanConfigurator
+
addType(TypeLiteral<?>) - Method in interface jakarta.enterprise.inject.spi.configurator.BeanConfigurator
Add a type to the bean types
-
addType(Type) - Method in interface jakarta.enterprise.inject.spi.configurator.BeanAttributesConfigurator
+
addType(Type) - Method in interface jakarta.enterprise.inject.spi.configurator.BeanAttributesConfigurator
Add a type to the bean types
-
addType(Type) - Method in interface jakarta.enterprise.inject.spi.configurator.BeanConfigurator
+
addType(Type) - Method in interface jakarta.enterprise.inject.spi.configurator.BeanConfigurator
Add a type to the bean types
-
addTypes(Type...) - Method in interface jakarta.enterprise.inject.spi.configurator.BeanAttributesConfigurator
+
addTypes(Type...) - Method in interface jakarta.enterprise.inject.spi.configurator.BeanAttributesConfigurator
Add types to the bean types
-
addTypes(Type...) - Method in interface jakarta.enterprise.inject.spi.configurator.BeanConfigurator
+
addTypes(Type...) - Method in interface jakarta.enterprise.inject.spi.configurator.BeanConfigurator
Add types to the bean types
-
addTypes(Set<Type>) - Method in interface jakarta.enterprise.inject.spi.configurator.BeanAttributesConfigurator
+
addTypes(Set<Type>) - Method in interface jakarta.enterprise.inject.spi.configurator.BeanAttributesConfigurator
Add types to the bean types
-
addTypes(Set<Type>) - Method in interface jakarta.enterprise.inject.spi.configurator.BeanConfigurator
+
addTypes(Set<Type>) - Method in interface jakarta.enterprise.inject.spi.configurator.BeanConfigurator
Add types to the bean types
-
AFTER_COMPLETION - jakarta.enterprise.event.TransactionPhase
+
AFTER_COMPLETION - Enum constant in enum class jakarta.enterprise.event.TransactionPhase
Identifies an after completion observer method, called during the after completion phase of the transaction.
-
AFTER_FAILURE - jakarta.enterprise.event.TransactionPhase
+
AFTER_FAILURE - Enum constant in enum class jakarta.enterprise.event.TransactionPhase
Identifies an after failure observer method, called during the after completion phase of the transaction, only when the transaction fails.
-
AFTER_SUCCESS - jakarta.enterprise.event.TransactionPhase
+
AFTER_SUCCESS - Enum constant in enum class jakarta.enterprise.event.TransactionPhase
Identifies an after success observer method, called during the after completion phase of the transaction, only when the transaction completes successfully.
-
AfterBeanDiscovery - Interface in jakarta.enterprise.inject.spi
+
AfterBeanDiscovery - Interface in jakarta.enterprise.inject.spi
The event type of the second event fired by the container when it has fully completed the bean discovery process, validated - that there are no definition errors relating to the discovered beans, and registered Bean - and ObserverMethod objects for the discovered beans, but before detecting deployment + that there are no definition errors relating to the discovered beans, and registered Bean + and ObserverMethod objects for the discovered beans, but before detecting deployment problems.
-
AfterDeploymentValidation - Interface in jakarta.enterprise.inject.spi
+
AfterDeploymentValidation - Interface in jakarta.enterprise.inject.spi
The event type of the third event fired by the container after it has validated that there are no deployment problems and before creating contexts or processing requests.
-
AfterTypeDiscovery - Interface in jakarta.enterprise.inject.spi
+
AfterTypeDiscovery - Interface in jakarta.enterprise.inject.spi
This event type is thrown by the container after type discovery is complete.
-
AlterableContext - Interface in jakarta.enterprise.context.spi
+
AlterableContext - Interface in jakarta.enterprise.context.spi
Provides an operation for obtaining and destroying contextual instances with a particular scope of any contextual type.
-
alternative(boolean) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticBeanBuilder
+
Alternate metadata sources - Search tag in package jakarta.enterprise.inject.spi
+
Section
+
alternative(boolean) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticBeanBuilder
Marks this synthetic bean as an alternative if desired.
-
alternative(boolean) - Method in interface jakarta.enterprise.inject.spi.configurator.BeanAttributesConfigurator
+
alternative(boolean) - Method in interface jakarta.enterprise.inject.spi.configurator.BeanAttributesConfigurator
Change the alternative status of the configured bean.
-
alternative(boolean) - Method in interface jakarta.enterprise.inject.spi.configurator.BeanConfigurator
+
alternative(boolean) - Method in interface jakarta.enterprise.inject.spi.configurator.BeanConfigurator
Change the alternative status of the configured bean.
-
Alternative - Annotation Type in jakarta.enterprise.inject
+
Alternative - Annotation Interface in jakarta.enterprise.inject
Specifies that a bean is an alternative.
-
Alternative.Literal - Class in jakarta.enterprise.inject
+
Alternative.Literal - Class in jakarta.enterprise.inject
-
Supports inline instantiation of the Alternative annotation.
+
Supports inline instantiation of the Alternative annotation.
-
ALWAYS - jakarta.enterprise.event.Reception
+
ALWAYS - Enum constant in enum class jakarta.enterprise.event.Reception
Specifies that an observer method always receives event notifications.
-
AmbiguousResolutionException - Exception in jakarta.enterprise.inject
+
AmbiguousResolutionException - Exception Class in jakarta.enterprise.inject
Indicates that multiple beans match a certain combination of required type and required qualifiers and are eligible for injection into a certain class.
-
AmbiguousResolutionException() - Constructor for exception jakarta.enterprise.inject.AmbiguousResolutionException
-
 
-
AmbiguousResolutionException(String) - Constructor for exception jakarta.enterprise.inject.AmbiguousResolutionException
-
 
-
AmbiguousResolutionException(String, Throwable) - Constructor for exception jakarta.enterprise.inject.AmbiguousResolutionException
-
 
-
AmbiguousResolutionException(Throwable) - Constructor for exception jakarta.enterprise.inject.AmbiguousResolutionException
-
 
-
Annotated - Interface in jakarta.enterprise.inject.spi
+
AmbiguousResolutionException() - Constructor for exception class jakarta.enterprise.inject.AmbiguousResolutionException
+
+
Creates the exception with no detail message or cause.
+
+
AmbiguousResolutionException(String) - Constructor for exception class jakarta.enterprise.inject.AmbiguousResolutionException
+
+
Creates the exception with given detail message.
+
+
AmbiguousResolutionException(String, Throwable) - Constructor for exception class jakarta.enterprise.inject.AmbiguousResolutionException
+
+
Creates the exception with given detail message and cause.
+
+
AmbiguousResolutionException(Throwable) - Constructor for exception class jakarta.enterprise.inject.AmbiguousResolutionException
+
+
Creates the exception with given cause.
+
+
Annotated - Interface in jakarta.enterprise.inject.spi
Represents a Java program element that can be annotated.
-
AnnotatedCallable<X> - Interface in jakarta.enterprise.inject.spi
+
AnnotatedCallable<X> - Interface in jakarta.enterprise.inject.spi
Represents a callable member of a Java type.
-
AnnotatedConstructor<X> - Interface in jakarta.enterprise.inject.spi
+
AnnotatedConstructor<X> - Interface in jakarta.enterprise.inject.spi
Represents a constructor of a Java class.
-
AnnotatedConstructorConfigurator<T> - Interface in jakarta.enterprise.inject.spi.configurator
+
AnnotatedConstructorConfigurator<T> - Interface in jakarta.enterprise.inject.spi.configurator
-
This interface is part of the AnnotatedTypeConfigurator SPI and helps defining an AnnotatedConstructor
+
This interface is part of the AnnotatedTypeConfigurator SPI and helps defining an AnnotatedConstructor
-
AnnotatedField<X> - Interface in jakarta.enterprise.inject.spi
+
AnnotatedField<X> - Interface in jakarta.enterprise.inject.spi
Represents a field of a Java class.
-
AnnotatedFieldConfigurator<T> - Interface in jakarta.enterprise.inject.spi.configurator
+
AnnotatedFieldConfigurator<T> - Interface in jakarta.enterprise.inject.spi.configurator
-
This interface is part of the AnnotatedTypeConfigurator SPI and helps defining an AnnotatedField
+
This interface is part of the AnnotatedTypeConfigurator SPI and helps defining an AnnotatedField
-
AnnotatedMember<X> - Interface in jakarta.enterprise.inject.spi
+
AnnotatedMember<X> - Interface in jakarta.enterprise.inject.spi
Represents a member of a Java type.
-
AnnotatedMethod<X> - Interface in jakarta.enterprise.inject.spi
+
AnnotatedMethod<X> - Interface in jakarta.enterprise.inject.spi
Represents a method of a Java type.
-
AnnotatedMethodConfigurator<T> - Interface in jakarta.enterprise.inject.spi.configurator
+
AnnotatedMethodConfigurator<T> - Interface in jakarta.enterprise.inject.spi.configurator
-
This interface is part of the AnnotatedTypeConfigurator SPI and helps defining an AnnotatedMethod
+
This interface is part of the AnnotatedTypeConfigurator SPI and helps defining an AnnotatedMethod
-
AnnotatedParameter<X> - Interface in jakarta.enterprise.inject.spi
+
AnnotatedParameter<X> - Interface in jakarta.enterprise.inject.spi
Represents a parameter of a method or constructor.
-
AnnotatedParameterConfigurator<T> - Interface in jakarta.enterprise.inject.spi.configurator
+
AnnotatedParameterConfigurator<T> - Interface in jakarta.enterprise.inject.spi.configurator
-
This interface is part of the AnnotatedTypeConfigurator SPI and helps defining an AnnotatedParameter
+
This interface is part of the AnnotatedTypeConfigurator SPI and helps defining an AnnotatedParameter
-
AnnotatedType<X> - Interface in jakarta.enterprise.inject.spi
+
AnnotatedType<X> - Interface in jakarta.enterprise.inject.spi
Represents a Java class or interface.
-
AnnotatedTypeConfigurator<T> - Interface in jakarta.enterprise.inject.spi.configurator
+
AnnotatedTypeConfigurator<T> - Interface in jakarta.enterprise.inject.spi.configurator
- This API is a helper to configure a new AnnotatedType instance.
+ This API is a helper to configure a new AnnotatedType instance.
-
annotation() - Method in interface jakarta.enterprise.inject.build.compatible.spi.ScopeInfo
+
annotation() - Method in interface jakarta.enterprise.inject.build.compatible.spi.ScopeInfo
Returns the declaration of this scope annotation.
-
AnnotationBuilder - Interface in jakarta.enterprise.inject.build.compatible.spi
+
annotation(Class<T>) - Method in interface jakarta.enterprise.lang.model.AnnotationTarget
+
+
Returns an annotation of given type, if it is present on this annotation target.
+
+
AnnotationBuilder - Interface in jakarta.enterprise.inject.build.compatible.spi
Builder for annotations of given type.
-
annotationBuilderFactory() - Method in interface jakarta.enterprise.inject.build.compatible.spi.BuildServices
+
annotationBuilderFactory() - Method in interface jakarta.enterprise.inject.build.compatible.spi.BuildServices
 
-
AnnotationBuilderFactory - Interface in jakarta.enterprise.inject.build.compatible.spi
+
AnnotationBuilderFactory - Interface in jakarta.enterprise.inject.build.compatible.spi
-
Supports instantiating AnnotationBuilder.
+
Supports instantiating AnnotationBuilder.
-
AnnotationLiteral<T extends java.lang.annotation.Annotation> - Class in jakarta.enterprise.util
+
AnnotationInfo - Interface in jakarta.enterprise.lang.model
+
+
An annotation instance, typically obtained from an AnnotationTarget.
+
+
AnnotationLiteral<T> - Class in jakarta.enterprise.util
Supports inline instantiation of annotation type instances.
-
AnnotationLiteral() - Constructor for class jakarta.enterprise.util.AnnotationLiteral
-
 
-
annotationType() - Method in class jakarta.enterprise.util.AnnotationLiteral
+
AnnotationLiteral() - Constructor for class jakarta.enterprise.util.AnnotationLiteral
+
+
The literal constructor, only for subclasses.
+
+
AnnotationMember - Interface in jakarta.enterprise.lang.model
+
+
The value of an annotation member.
+
+
AnnotationMember.Kind - Enum Class in jakarta.enterprise.lang.model
+
+
The kind of the annotation member value.
+
+
annotations() - Method in interface jakarta.enterprise.lang.model.AnnotationTarget
+
+
Returns a collection of all annotations present on this annotation target.
+
+
annotations(Predicate<AnnotationInfo>) - Method in interface jakarta.enterprise.lang.model.AnnotationTarget
+
+
Returns a collection of all annotations present on this annotation target that match given predicate.
+
+
AnnotationTarget - Interface in jakarta.enterprise.lang.model
+
+
An annotation target is anything that can be annotated.
+
+
annotationType() - Method in class jakarta.enterprise.util.AnnotationLiteral
 
-
Any - Annotation Type in jakarta.enterprise.inject
+
Any - Annotation Interface in jakarta.enterprise.inject
The built-in qualifier type.
-
Any.Literal - Class in jakarta.enterprise.inject
+
Any.Literal - Class in jakarta.enterprise.inject
-
Supports inline instantiation of the Any qualifier.
+
Supports inline instantiation of the Any qualifier.
-
APPLICATION - Static variable in class jakarta.enterprise.context.BeforeDestroyed.Literal
-
 
-
APPLICATION - Static variable in class jakarta.enterprise.context.Destroyed.Literal
-
 
-
APPLICATION - Static variable in class jakarta.enterprise.context.Initialized.Literal
-
 
-
ApplicationScoped - Annotation Type in jakarta.enterprise.context
+
APPLICATION - Static variable in class jakarta.enterprise.context.BeforeDestroyed.Literal
+
+
Default BeforeDestroyed literal for the ApplicationScoped scope
+
+
APPLICATION - Static variable in class jakarta.enterprise.context.Destroyed.Literal
+
+
Default Destroyed literal for the ApplicationScoped scope
+
+
APPLICATION - Static variable in class jakarta.enterprise.context.Initialized.Literal
+
+
Default Initialized literal for the ApplicationScoped scope
+
+
ApplicationScoped - Annotation Interface in jakarta.enterprise.context
Specifies that a bean is application scoped.
-
ApplicationScoped.Literal - Class in jakarta.enterprise.context
+
ApplicationScoped.Literal - Class in jakarta.enterprise.context
-
Supports inline instantiation of the ApplicationScoped annotation.
+
Supports inline instantiation of the ApplicationScoped annotation.
-
areInterceptorBindingsEquivalent(Annotation, Annotation) - Method in interface jakarta.enterprise.inject.spi.BeanManager
+
areInterceptorBindingsEquivalent(Annotation, Annotation) - Method in interface jakarta.enterprise.inject.spi.BeanManager
Determine if two interceptor bindings are considered equivalent for the purposes of typesafe resolution, taking into - account any members annotated with Nonbinding.
+ account any members annotated with Nonbinding.
-
areQualifiersEquivalent(Annotation, Annotation) - Method in interface jakarta.enterprise.inject.spi.BeanManager
+
areQualifiersEquivalent(Annotation, Annotation) - Method in interface jakarta.enterprise.inject.spi.BeanManager
Determine if two qualifiers are considered equivalent for the purposes of typesafe resolution, taking into account any - members annotated with Nonbinding.
+ members annotated with Nonbinding.
-
AROUND_CONSTRUCT - jakarta.enterprise.inject.spi.InterceptionType
+
AROUND_CONSTRUCT - Enum constant in enum class jakarta.enterprise.inject.spi.InterceptionType
Intercepts a constructor invocation
-
AROUND_INVOKE - jakarta.enterprise.inject.spi.InterceptionType
+
AROUND_INVOKE - Enum constant in enum class jakarta.enterprise.inject.spi.InterceptionType
Intercepts method invocation
-
AROUND_TIMEOUT - jakarta.enterprise.inject.spi.InterceptionType
+
AROUND_TIMEOUT - Enum constant in enum class jakarta.enterprise.inject.spi.InterceptionType
Intercepts a timeout
-
asInterceptor() - Method in interface jakarta.enterprise.inject.build.compatible.spi.BeanInfo
+
ARRAY - Enum constant in enum class jakarta.enterprise.lang.model.AnnotationMember.Kind
+
+
An array value.
+
+
ARRAY - Enum constant in enum class jakarta.enterprise.lang.model.types.Type.Kind
+
+
An array type, e.g.
+
+
ArrayType - Interface in jakarta.enterprise.lang.model.types
+
+
An array type is created from a component type.
+
+
asArray() - Method in interface jakarta.enterprise.lang.model.AnnotationMember
+
+
Returns this array value as an immutable List of AnnotationMembers.
+
+
asArray() - Method in interface jakarta.enterprise.lang.model.types.ArrayType
+
 
+
asArray() - Method in interface jakarta.enterprise.lang.model.types.Type
+
+
Returns this type as an array type.
+
+
asBoolean() - Method in interface jakarta.enterprise.lang.model.AnnotationMember
+
+
Returns this value as a boolean.
+
+
asByte() - Method in interface jakarta.enterprise.lang.model.AnnotationMember
+
+
Returns this value as a byte.
+
+
asChar() - Method in interface jakarta.enterprise.lang.model.AnnotationMember
+
+
Returns this value as a char.
+
+
asClass() - Method in interface jakarta.enterprise.lang.model.declarations.ClassInfo
+
 
+
asClass() - Method in interface jakarta.enterprise.lang.model.declarations.DeclarationInfo
+
+
Returns this declaration as a class.
+
+
asClass() - Method in interface jakarta.enterprise.lang.model.types.ClassType
+
 
+
asClass() - Method in interface jakarta.enterprise.lang.model.types.Type
+
+
Returns this type as a class type.
+
+
asDeclaration() - Method in interface jakarta.enterprise.lang.model.AnnotationTarget
+
+
Returns this annotation target as a declaration.
+
+
asDeclaration() - Method in interface jakarta.enterprise.lang.model.declarations.DeclarationInfo
+
 
+
asDeclaration() - Method in interface jakarta.enterprise.lang.model.types.Type
+
 
+
asDouble() - Method in interface jakarta.enterprise.lang.model.AnnotationMember
+
+
Returns this value as a double.
+
+
asEnum(Class<E>) - Method in interface jakarta.enterprise.lang.model.AnnotationMember
+
+
Returns this enum value as an instance of the enum type.
+
+
asEnumClass() - Method in interface jakarta.enterprise.lang.model.AnnotationMember
+
+
Returns the type of this enum value.
+
+
asEnumConstant() - Method in interface jakarta.enterprise.lang.model.AnnotationMember
+
+
Returns the name of this enum value.
+
+
asField() - Method in interface jakarta.enterprise.lang.model.declarations.DeclarationInfo
+
+
Returns this declaration as a field.
+
+
asField() - Method in interface jakarta.enterprise.lang.model.declarations.FieldInfo
+
 
+
asFloat() - Method in interface jakarta.enterprise.lang.model.AnnotationMember
+
+
Returns this value as a float.
+
+
asInt() - Method in interface jakarta.enterprise.lang.model.AnnotationMember
+
+
Returns this value as an int.
+
+
asInterceptor() - Method in interface jakarta.enterprise.inject.build.compatible.spi.BeanInfo
+
+
Returns this bean as an interceptor.
+
+
asInterceptor() - Method in interface jakarta.enterprise.inject.build.compatible.spi.InterceptorInfo
+
 
+
asLong() - Method in interface jakarta.enterprise.lang.model.AnnotationMember
+
+
Returns this value as a long.
+
+
asMethod() - Method in interface jakarta.enterprise.lang.model.declarations.DeclarationInfo
+
+
Returns this declaration as a method.
+
+
asMethod() - Method in interface jakarta.enterprise.lang.model.declarations.MethodInfo
+
 
+
asNestedAnnotation() - Method in interface jakarta.enterprise.lang.model.AnnotationMember
+
+
Returns this nested annotation value as an AnnotationInfo.
+
+
asPackage() - Method in interface jakarta.enterprise.lang.model.declarations.DeclarationInfo
+
+
Returns this declaration as a package.
+
+
asPackage() - Method in interface jakarta.enterprise.lang.model.declarations.PackageInfo
+
 
+
asParameter() - Method in interface jakarta.enterprise.lang.model.declarations.DeclarationInfo
+
+
Returns this declaration as a method parameter.
+
+
asParameter() - Method in interface jakarta.enterprise.lang.model.declarations.ParameterInfo
+
 
+
asParameterizedType() - Method in interface jakarta.enterprise.lang.model.types.ParameterizedType
+
 
+
asParameterizedType() - Method in interface jakarta.enterprise.lang.model.types.Type
+
+
Returns this type as a parameterized type.
+
+
asPrimitive() - Method in interface jakarta.enterprise.lang.model.types.PrimitiveType
+
 
+
asPrimitive() - Method in interface jakarta.enterprise.lang.model.types.Type
+
+
Returns this type as a primitive type.
+
+
asRecordComponent() - Method in interface jakarta.enterprise.lang.model.declarations.DeclarationInfo
+
+
Returns this declaration as a record component.
+
+
asRecordComponent() - Method in interface jakarta.enterprise.lang.model.declarations.RecordComponentInfo
+
 
+
asShort() - Method in interface jakarta.enterprise.lang.model.AnnotationMember
+
+
Returns this value as a short.
+
+
asString() - Method in interface jakarta.enterprise.lang.model.AnnotationMember
+
+
Returns this value as a String.
+
+
asType() - Method in interface jakarta.enterprise.lang.model.AnnotationMember
+
+
Returns this class value as a Type.
+
+
asType() - Method in interface jakarta.enterprise.lang.model.AnnotationTarget
+
+
Returns this annotation target as a type.
+
+
asType() - Method in interface jakarta.enterprise.lang.model.declarations.DeclarationInfo
+
 
+
asType() - Method in interface jakarta.enterprise.lang.model.types.Type
+
 
+
asTypeVariable() - Method in interface jakarta.enterprise.lang.model.types.Type
+
+
Returns this type as a type variable.
+
+
asTypeVariable() - Method in interface jakarta.enterprise.lang.model.types.TypeVariable
+
 
+
asVoid() - Method in interface jakarta.enterprise.lang.model.types.Type
+
+
Returns this type as the void pseudo-type.
+
+
asVoid() - Method in interface jakarta.enterprise.lang.model.types.VoidType
+
 
+
asWildcardType() - Method in interface jakarta.enterprise.lang.model.types.Type
-
Returns this bean as an interceptor.
+
Returns this type as a wildcard type.
-
asInterceptor() - Method in interface jakarta.enterprise.inject.build.compatible.spi.InterceptorInfo
+
asWildcardType() - Method in interface jakarta.enterprise.lang.model.types.WildcardType
 
-
async(boolean) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticObserverBuilder
+
async(boolean) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticObserverBuilder
Marks this synthetic observer as asynchronous if desired.
-
async(boolean) - Method in interface jakarta.enterprise.inject.spi.configurator.ObserverMethodConfigurator
+
async(boolean) - Method in interface jakarta.enterprise.inject.spi.configurator.ObserverMethodConfigurator
Allows modification of the asynchronous status of the observer to build.
- - - -

B

-
-
bean() - Method in interface jakarta.enterprise.inject.build.compatible.spi.ObserverInfo
+

B

+
+
bean() - Method in interface jakarta.enterprise.inject.build.compatible.spi.ObserverInfo
-
Returns the bean that declares this observer method.
+
Returns the bean that declares this observer method.
-
Bean<T> - Interface in jakarta.enterprise.inject.spi
+
Bean<T> - Interface in jakarta.enterprise.inject.spi
- Represents an enabled bean.
+ Represents an enabled bean.
-
BeanAttributes<T> - Interface in jakarta.enterprise.inject.spi
+
BeanAttributes<T> - Interface in jakarta.enterprise.inject.spi
The BeanAttributes interface exposes the basic attributes of a bean.
-
BeanAttributesConfigurator<T> - Interface in jakarta.enterprise.inject.spi.configurator
+
BeanAttributesConfigurator<T> - Interface in jakarta.enterprise.inject.spi.configurator
-
This API is an helper to configure a new BeanAttributes instance.
+
This API is an helper to configure a new BeanAttributes instance.
-
beanClass(Class<?>) - Method in interface jakarta.enterprise.inject.spi.configurator.BeanConfigurator
+
beanClass(Class<?>) - Method in interface jakarta.enterprise.inject.spi.configurator.BeanConfigurator
Set the class of the configured Bean.
-
beanClass(Class<?>) - Method in interface jakarta.enterprise.inject.spi.configurator.ObserverMethodConfigurator
+
beanClass(Class<?>) - Method in interface jakarta.enterprise.inject.spi.configurator.ObserverMethodConfigurator
Set the class of the Bean containing this observer.
-
BeanConfigurator<T> - Interface in jakarta.enterprise.inject.spi.configurator
+
BeanConfigurator<T> - Interface in jakarta.enterprise.inject.spi.configurator
-
This API is an helper to configure a new Bean instance.
+
This API is an helper to configure a new Bean instance.
-
BeanContainer - Interface in jakarta.enterprise.inject.spi
+
BeanContainer - Interface in jakarta.enterprise.inject.spi
- BeanContainer is a superclass of BeanManager containing capabilities that are portable across + BeanContainer is a superclass of BeanManager containing capabilities that are portable across all CDI environments.
-
BeanInfo - Interface in jakarta.enterprise.inject.build.compatible.spi
+
BeanInfo - Interface in jakarta.enterprise.inject.build.compatible.spi
Beans are: @@ -777,1975 +947,2613 @@

B

Managed beans are also known as class-based beans, while beans defined by producer methods and producer fields are together also known as producer-based beans.
-
BeanManager - Interface in jakarta.enterprise.inject.spi
+
BeanManager - Interface in jakarta.enterprise.inject.spi
Allows a portable extension to interact directly with the container.
-
BEFORE_COMPLETION - jakarta.enterprise.event.TransactionPhase
+
BEFORE_COMPLETION - Enum constant in enum class jakarta.enterprise.event.TransactionPhase
Identifies a before completion observer method, called during the before completion phase of the transaction.
-
BeforeBeanDiscovery - Interface in jakarta.enterprise.inject.spi
+
BeforeBeanDiscovery - Interface in jakarta.enterprise.inject.spi
This event type is thrown by the container before the bean discovery process begins.
-
BeforeDestroyed - Annotation Type in jakarta.enterprise.context
+
BeforeDestroyed - Annotation Interface in jakarta.enterprise.context
An event with this qualifier is fired when a context is about to be destroyed, i.e.
-
BeforeDestroyed.Literal - Class in jakarta.enterprise.context
+
BeforeDestroyed.Literal - Class in jakarta.enterprise.context
-
Supports inline instantiation of the BeforeDestroyed qualifier.
+
Supports inline instantiation of the BeforeDestroyed qualifier.
-
BeforeShutdown - Interface in jakarta.enterprise.inject.spi
+
BeforeShutdown - Interface in jakarta.enterprise.inject.spi
The type of the final event the container fires after it has finished processing requests and destroyed all contexts.
-
begin() - Method in interface jakarta.enterprise.context.Conversation
+
begin() - Method in interface jakarta.enterprise.context.Conversation
Mark the current transient conversation long-running.
-
begin(String) - Method in interface jakarta.enterprise.context.Conversation
+
begin(String) - Method in interface jakarta.enterprise.context.Conversation
Mark the current transient conversation long-running, with a specified identifier.
-
build() - Method in interface jakarta.enterprise.event.NotificationOptions.Builder
-
 
-
build() - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
+
BOOLEAN - Enum constant in enum class jakarta.enterprise.lang.model.AnnotationMember.Kind
+
+
A primitive boolean value.
+
+
BOOLEAN - Enum constant in enum class jakarta.enterprise.lang.model.types.PrimitiveType.PrimitiveKind
+
+
The boolean primitive type
+
+
bounds() - Method in interface jakarta.enterprise.lang.model.types.TypeVariable
-
Returns an AnnotationInfo that includes all annotation members defined by previous method calls +
Returns the bounds declared for this type variable.
+
+
build() - Method in interface jakarta.enterprise.event.NotificationOptions.Builder
+
+
Build the notification options
+
+
build() - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
+
+
Returns an AnnotationInfo that includes all annotation members defined by previous method calls on this builder.
-
build() - Method in interface jakarta.enterprise.invoke.InvokerBuilder
+
build() - Method in interface jakarta.enterprise.invoke.InvokerBuilder
-
Returns the built Invoker or some represention of it.
+
Returns the built Invoker or some representation of it.
-
BuildCompatibleExtension - Interface in jakarta.enterprise.inject.build.compatible.spi
+
BuildCompatibleExtension - Interface in jakarta.enterprise.inject.build.compatible.spi
-
Build compatible extensions are service providers for this interface, as defined in ServiceLoader.
+
Build compatible extensions are service providers for this interface, as defined in ServiceLoader.
-
builder() - Static method in interface jakarta.enterprise.event.NotificationOptions
+
builder() - Static method in interface jakarta.enterprise.event.NotificationOptions
 
-
BuildServices - Interface in jakarta.enterprise.inject.build.compatible.spi
+
BuildServices - Interface in jakarta.enterprise.inject.build.compatible.spi
-
Service provider interface for various services needed by BuildCompatibleExtension implementations.
+
Service provider interface for various services needed by BuildCompatibleExtension implementations.
-
BuildServicesResolver - Class in jakarta.enterprise.inject.build.compatible.spi
+
BuildServicesResolver - Class in jakarta.enterprise.inject.build.compatible.spi
-
An internal helper to resolve BuildServices implementations.
+
An internal helper to resolve BuildServices implementations.
-
BuildServicesResolver() - Constructor for class jakarta.enterprise.inject.build.compatible.spi.BuildServicesResolver
+
BuildServicesResolver() - Constructor for class jakarta.enterprise.inject.build.compatible.spi.BuildServicesResolver
 
-
BusyConversationException - Exception in jakarta.enterprise.context
+
Built-in scopes - Search tag in package jakarta.enterprise.context
+
Section
+
BusyConversationException - Exception Class in jakarta.enterprise.context
Indicates that the container has rejected a request because a concurrent request is associated with the same conversation context.
-
BusyConversationException() - Constructor for exception jakarta.enterprise.context.BusyConversationException
-
 
-
BusyConversationException(String) - Constructor for exception jakarta.enterprise.context.BusyConversationException
-
 
-
BusyConversationException(String, Throwable) - Constructor for exception jakarta.enterprise.context.BusyConversationException
-
 
-
BusyConversationException(Throwable) - Constructor for exception jakarta.enterprise.context.BusyConversationException
-
 
+
BusyConversationException() - Constructor for exception class jakarta.enterprise.context.BusyConversationException
+
+
Creates the exception with no detail message or cause.
+
+
BusyConversationException(String) - Constructor for exception class jakarta.enterprise.context.BusyConversationException
+
+
Creates the exception with given detail message.
+
+
BusyConversationException(String, Throwable) - Constructor for exception class jakarta.enterprise.context.BusyConversationException
+
+
Creates the exception with given detail message and cause.
+
+
BusyConversationException(Throwable) - Constructor for exception class jakarta.enterprise.context.BusyConversationException
+
+
Creates the exception with given cause.
+
+
BYTE - Enum constant in enum class jakarta.enterprise.lang.model.AnnotationMember.Kind
+
+
A primitive byte value.
+
+
BYTE - Enum constant in enum class jakarta.enterprise.lang.model.types.PrimitiveType.PrimitiveKind
+
+
The byte primitive type
+
- - - -

C

-
-
CDI<T> - Class in jakarta.enterprise.inject.spi
+

C

+
+
CDI<T> - Class in jakarta.enterprise.inject.spi
Provides access to the current container.
-
CDI() - Constructor for class jakarta.enterprise.inject.spi.CDI
+
CDI() - Constructor for class jakarta.enterprise.inject.spi.CDI
 
-
CDIProvider - Interface in jakarta.enterprise.inject.spi
+
CDIProvider - Interface in jakarta.enterprise.inject.spi
Interface implemented by a CDI provider to provide access to the current container
-
ClassConfig - Interface in jakarta.enterprise.inject.build.compatible.spi
+
CHAR - Enum constant in enum class jakarta.enterprise.lang.model.AnnotationMember.Kind
+
+
A primitive char value.
+
+
CHAR - Enum constant in enum class jakarta.enterprise.lang.model.types.PrimitiveType.PrimitiveKind
+
+
The char primitive type
+
+
CLASS - Enum constant in enum class jakarta.enterprise.lang.model.AnnotationMember.Kind
+
+
A Class value.
+
+
CLASS - Enum constant in enum class jakarta.enterprise.lang.model.declarations.DeclarationInfo.Kind
+
+
Class, interface, enum, annotation, or record
+
+
CLASS - Enum constant in enum class jakarta.enterprise.lang.model.types.Type.Kind
+
+
A class type, e.g.
+
+
ClassConfig - Interface in jakarta.enterprise.inject.build.compatible.spi
Allows adding annotations to and removing annotations from a class.
-
close() - Method in interface jakarta.enterprise.inject.Instance.Handle
+
ClassInfo - Interface in jakarta.enterprise.lang.model.declarations
+
+
A class.
+
+
ClassType - Interface in jakarta.enterprise.lang.model.types
- +
A class type, including interface types, enum types, annotation types and record types.
-
close() - Method in interface jakarta.enterprise.inject.se.SeContainer
+
close() - Method in interface jakarta.enterprise.inject.Instance.Handle
+
+ +
+
close() - Method in interface jakarta.enterprise.inject.se.SeContainer
Shuts down this SeContainer instance when it is no longer in scope.
-
configure() - Method in interface jakarta.enterprise.inject.spi.InjectionTargetFactory
+
componentType() - Method in interface jakarta.enterprise.lang.model.types.ArrayType
+
+
Returns the component type of this array type, as defined by The Java™ Language Specification.
+
+
configure() - Method in interface jakarta.enterprise.inject.spi.InjectionTargetFactory
-
Returns an AnnotatedTypeConfigurator to to configure the AnnotatedType used to create the InjectionTarget.
+
Returns an AnnotatedTypeConfigurator to to configure the AnnotatedType used to create the + InjectionTarget.
-
configure() - Method in interface jakarta.enterprise.inject.spi.InterceptionFactory
+
configure() - Method in interface jakarta.enterprise.inject.spi.InterceptionFactory
-
Returns an AnnotatedTypeConfigurator initialized with the AnnotatedType created either for the class - passed to BeanManager.createInterceptionFactory(CreationalContext, Class) or derived from the - InterceptionFactory parameter injection point.
+
Returns an AnnotatedTypeConfigurator initialized with the AnnotatedType created either for the class + passed to BeanManager.createInterceptionFactory(CreationalContext, Class) or derived from the + InterceptionFactory parameter injection point.
-
configureAnnotatedType() - Method in interface jakarta.enterprise.inject.spi.ProcessAnnotatedType
+
configureAnnotatedType() - Method in interface jakarta.enterprise.inject.spi.ProcessAnnotatedType
-
Returns an AnnotatedTypeConfigurator initialized with the AnnotatedType processed by this event +
Returns an AnnotatedTypeConfigurator initialized with the AnnotatedType processed by this event to configure a new AnnotatedType that will replace the original one at the end of the observer invocation.
-
configureBeanAttributes() - Method in interface jakarta.enterprise.inject.spi.ProcessBeanAttributes
+
configureBeanAttributes() - Method in interface jakarta.enterprise.inject.spi.ProcessBeanAttributes
-
returns a BeanAttributesConfigurator initialized with the BeanAttributes processed by this event +
returns a BeanAttributesConfigurator initialized with the BeanAttributes processed by this event to configure a new BeanAttributes that will replace the original one at the end of the observer invocation.
-
configuredProvider - Static variable in class jakarta.enterprise.inject.spi.CDI
-
 
-
configureInjectionPoint() - Method in interface jakarta.enterprise.inject.spi.ProcessInjectionPoint
+
configuredProvider - Static variable in class jakarta.enterprise.inject.spi.CDI
+
+
CDIProvider set by user or retrieved by service loader
+
+
configureInjectionPoint() - Method in interface jakarta.enterprise.inject.spi.ProcessInjectionPoint
-
Returns an InjectionPointConfigurator initialized with the InjectionPoint processed by this event +
Returns an InjectionPointConfigurator initialized with the InjectionPoint processed by this event to configure a new InjectionPoint that will replace the original one at the end of the observer invocation.
-
configureInterceptorBinding(Class<T>) - Method in interface jakarta.enterprise.inject.spi.BeforeBeanDiscovery
+
configureInterceptorBinding(Class<T>) - Method in interface jakarta.enterprise.inject.spi.BeforeBeanDiscovery
- Obtains a new AnnotatedTypeConfigurator to configure a new AnnotatedType - and declares it as an interceptor binding type.
+ Obtains a new AnnotatedTypeConfigurator to configure a new AnnotatedType + and declares it as an interceptor binding type.
-
configureObserverMethod() - Method in interface jakarta.enterprise.inject.spi.ProcessObserverMethod
+
configureObserverMethod() - Method in interface jakarta.enterprise.inject.spi.ProcessObserverMethod
-
Returns a ObserverMethodConfigurator initialized with the ObserverMethod processed by this event, +
Returns a ObserverMethodConfigurator initialized with the ObserverMethod processed by this event, to configure a new ObserverMethod that will replace the original one at the end of the observer invocation.
-
configureProducer() - Method in interface jakarta.enterprise.inject.spi.ProcessProducer
+
configureProducer() - Method in interface jakarta.enterprise.inject.spi.ProcessProducer
-
Returns a ProducerConfigurator initialized with the Producer processed by this event, to configure a new - Producer that will replace the original one at the end of the observer invocation.
+
Returns a ProducerConfigurator initialized with the Producer processed by this event, to configure a new + Producer that will replace the original one at the end of the observer invocation.
-
configureQualifier(Class<T>) - Method in interface jakarta.enterprise.inject.spi.BeforeBeanDiscovery
+
configureQualifier(Class<T>) - Method in interface jakarta.enterprise.inject.spi.BeforeBeanDiscovery
- Obtains a new AnnotatedTypeConfigurator to configure a new AnnotatedType + Obtains a new AnnotatedTypeConfigurator to configure a new AnnotatedType and declares it as a Qualifier qualifier type.
-
constructors() - Method in interface jakarta.enterprise.inject.build.compatible.spi.ClassConfig
+
constructors() - Method in interface jakarta.enterprise.inject.build.compatible.spi.ClassConfig
-
Returns a collection of MethodConfig objects for each constructor of this class, - as defined by ClassInfo.constructors.
+
Returns a collection of MethodConfig objects for each constructor of this class, + as defined by ClassInfo.constructors.
-
constructors() - Method in interface jakarta.enterprise.inject.spi.configurator.AnnotatedTypeConfigurator
+
constructors() - Method in interface jakarta.enterprise.inject.spi.configurator.AnnotatedTypeConfigurator
 
-
Context - Interface in jakarta.enterprise.context.spi
+
constructors() - Method in interface jakarta.enterprise.lang.model.declarations.ClassInfo
+
+
Returns a collection of constructors declared or implicitly declared + in this class.
+
+
Container lifecycle events - Search tag in package jakarta.enterprise.inject.spi
+
Section
+
Context - Interface in jakarta.enterprise.context.spi
Provides an operation for obtaining contextual instances with a particular scope of any contextual type.
-
ContextException - Exception in jakarta.enterprise.context
+
ContextException - Exception Class in jakarta.enterprise.context
Indicates a problem relating to context management.
-
ContextException() - Constructor for exception jakarta.enterprise.context.ContextException
-
 
-
ContextException(String) - Constructor for exception jakarta.enterprise.context.ContextException
-
 
-
ContextException(String, Throwable) - Constructor for exception jakarta.enterprise.context.ContextException
-
 
-
ContextException(Throwable) - Constructor for exception jakarta.enterprise.context.ContextException
-
 
-
ContextNotActiveException - Exception in jakarta.enterprise.context
+
ContextException() - Constructor for exception class jakarta.enterprise.context.ContextException
+
+
Creates the exception with no detail message or cause.
+
+
ContextException(String) - Constructor for exception class jakarta.enterprise.context.ContextException
+
+
Creates the exception with given detail message.
+
+
ContextException(String, Throwable) - Constructor for exception class jakarta.enterprise.context.ContextException
+
+
Creates the exception with given detail message and cause.
+
+
ContextException(Throwable) - Constructor for exception class jakarta.enterprise.context.ContextException
+
+
Creates the exception with given cause.
+
+
ContextNotActiveException - Exception Class in jakarta.enterprise.context
Indicates that a context is not active.
-
ContextNotActiveException() - Constructor for exception jakarta.enterprise.context.ContextNotActiveException
-
 
-
ContextNotActiveException(String) - Constructor for exception jakarta.enterprise.context.ContextNotActiveException
-
 
-
ContextNotActiveException(String, Throwable) - Constructor for exception jakarta.enterprise.context.ContextNotActiveException
-
 
-
ContextNotActiveException(Throwable) - Constructor for exception jakarta.enterprise.context.ContextNotActiveException
-
 
-
Contextual<T> - Interface in jakarta.enterprise.context.spi
+
ContextNotActiveException() - Constructor for exception class jakarta.enterprise.context.ContextNotActiveException
+
+
Creates the exception with no detail message or cause.
+
+
ContextNotActiveException(String) - Constructor for exception class jakarta.enterprise.context.ContextNotActiveException
+
+
Creates the exception with given detail message.
+
+
ContextNotActiveException(String, Throwable) - Constructor for exception class jakarta.enterprise.context.ContextNotActiveException
+
+
Creates the exception with given detail message and cause.
+
+
ContextNotActiveException(Throwable) - Constructor for exception class jakarta.enterprise.context.ContextNotActiveException
+
+
Creates the exception with given cause.
+
+
Contextual<T> - Interface in jakarta.enterprise.context.spi
Defines operations to create and destroy contextual instances of a certain type.
-
Conversation - Interface in jakarta.enterprise.context
+
Contextual and injected reference validity - Search tag in package jakarta.enterprise.context
+
Section
+
Conversation - Interface in jakarta.enterprise.context
- Allows the application to manage the conversation context by marking + Allows the application to manage the conversation context by marking the current conversation as transient or long-running, specifying a conversation identifier, or setting the conversation timeout.
-
CONVERSATION - Static variable in class jakarta.enterprise.context.BeforeDestroyed.Literal
-
 
-
CONVERSATION - Static variable in class jakarta.enterprise.context.Destroyed.Literal
-
 
-
CONVERSATION - Static variable in class jakarta.enterprise.context.Initialized.Literal
-
 
-
ConversationScoped - Annotation Type in jakarta.enterprise.context
+
CONVERSATION - Static variable in class jakarta.enterprise.context.BeforeDestroyed.Literal
+
+
Default BeforeDestroyed literal for the ConversationScoped scope
+
+
CONVERSATION - Static variable in class jakarta.enterprise.context.Destroyed.Literal
+
+
Default Destroyed literal for the ConversationScoped scope
+
+
CONVERSATION - Static variable in class jakarta.enterprise.context.Initialized.Literal
+
+
Default Initialized literal for the ConversationScoped scope
+
+
ConversationScoped - Annotation Interface in jakarta.enterprise.context
Specifies that a bean is conversation scoped.
-
ConversationScoped.Literal - Class in jakarta.enterprise.context
+
ConversationScoped.Literal - Class in jakarta.enterprise.context
-
Supports inline instantiation of the ConversationScoped annotation.
+
Supports inline instantiation of the ConversationScoped annotation.
-
create(CreationalContext<T>) - Method in interface jakarta.enterprise.context.spi.Contextual
+
create(CreationalContext<T>) - Method in interface jakarta.enterprise.context.spi.Contextual
Create a new instance of the contextual type.
-
create(Instance<Object>, Parameters) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticBeanCreator
+
create(Instance<Object>, Parameters) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticBeanCreator
Creates an instance of the synthetic bean.
-
create(ClassInfo) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilderFactory
+
create(ClassInfo) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilderFactory
-
Returns a new AnnotationBuilder for given annotation type.
+
Returns a new AnnotationBuilder for given annotation type.
-
create(Class<? extends Annotation>) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilderFactory
+
create(Class<? extends Annotation>) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilderFactory
-
Returns a new AnnotationBuilder for given annotation type.
+
Returns a new AnnotationBuilder for given annotation type.
-
createAnnotatedType(Class<T>) - Method in interface jakarta.enterprise.inject.spi.BeanManager
+
createAnnotatedType(Class<T>) - Method in interface jakarta.enterprise.inject.spi.BeanManager
-
Obtain an AnnotatedType that may be used to read the annotations of the given class or interface.
+
Obtain an AnnotatedType that may be used to read the annotations of the given class or interface.
-
createBean(BeanAttributes<T>, Class<T>, InjectionTargetFactory<T>) - Method in interface jakarta.enterprise.inject.spi.BeanManager
+
createBean(BeanAttributes<T>, Class<T>, InjectionTargetFactory<T>) - Method in interface jakarta.enterprise.inject.spi.BeanManager
- Obtains a Bean for the given BeanAttributes, bean class and InjectionTarget.
+ Obtains a Bean for the given BeanAttributes, bean class and InjectionTarget.
-
createBean(BeanAttributes<T>, Class<X>, ProducerFactory<X>) - Method in interface jakarta.enterprise.inject.spi.BeanManager
+
createBean(BeanAttributes<T>, Class<X>, ProducerFactory<X>) - Method in interface jakarta.enterprise.inject.spi.BeanManager
- Obtains a Bean for the given BeanAttributes, bean class and Producer.
+ Obtains a Bean for the given BeanAttributes, bean class and Producer.
-
createBeanAttributes(AnnotatedMember<?>) - Method in interface jakarta.enterprise.inject.spi.BeanManager
+
createBeanAttributes(AnnotatedMember<?>) - Method in interface jakarta.enterprise.inject.spi.BeanManager
-
Obtains a BeanAttributes for the given AnnotatedType.
+
Obtains a BeanAttributes for the given AnnotatedType.
-
createBeanAttributes(AnnotatedType<T>) - Method in interface jakarta.enterprise.inject.spi.BeanManager
+
createBeanAttributes(AnnotatedType<T>) - Method in interface jakarta.enterprise.inject.spi.BeanManager
-
Obtains a BeanAttributes for the given AnnotatedType.
+
Obtains a BeanAttributes for the given AnnotatedType.
-
createCreationalContext(Contextual<T>) - Method in interface jakarta.enterprise.inject.spi.BeanContainer
+
createCreationalContext(Contextual<T>) - Method in interface jakarta.enterprise.inject.spi.BeanContainer
-
Obtain an instance of a CreationalContext for the given - contextual type, or for a non-contextual object.
+
Obtain an instance of a CreationalContext for the given + contextual type, or for a non-contextual object.
-
createInjectionPoint(AnnotatedField<?>) - Method in interface jakarta.enterprise.inject.spi.BeanManager
+
createInjectionPoint(AnnotatedField<?>) - Method in interface jakarta.enterprise.inject.spi.BeanManager
-
Obtains a container provided implementation of InjectionPoint for the given AnnotatedField.
+
Obtains a container provided implementation of InjectionPoint for the given AnnotatedField.
-
createInjectionPoint(AnnotatedParameter<?>) - Method in interface jakarta.enterprise.inject.spi.BeanManager
+
createInjectionPoint(AnnotatedParameter<?>) - Method in interface jakarta.enterprise.inject.spi.BeanManager
-
Obtains a container provided implementation of InjectionPoint for the given AnnotatedParameter.
+
Obtains a container provided implementation of InjectionPoint for the given AnnotatedParameter.
-
createInjectionTarget(Bean<T>) - Method in interface jakarta.enterprise.inject.spi.InjectionTargetFactory
+
createInjectionTarget(Bean<T>) - Method in interface jakarta.enterprise.inject.spi.InjectionTargetFactory
Create a new injection target for a bean.
-
createInstance() - Method in interface jakarta.enterprise.inject.spi.BeanContainer
+
createInstance() - Method in interface jakarta.enterprise.inject.spi.BeanContainer
-
Obtains an Instance object to access to beans instances.
+
Obtains an Instance object to access to beans instances.
-
createInterceptedInstance(T) - Method in interface jakarta.enterprise.inject.spi.InterceptionFactory
+
createInterceptedInstance(T) - Method in interface jakarta.enterprise.inject.spi.InterceptionFactory
Returns a wrapper instance whose method invocations are intercepted by method interceptors and forwarded to a provided instance.
-
createInterceptionFactory(CreationalContext<T>, Class<T>) - Method in interface jakarta.enterprise.inject.spi.BeanManager
+
createInterceptionFactory(CreationalContext<T>, Class<T>) - Method in interface jakarta.enterprise.inject.spi.BeanManager
-
Create an InterceptionFactory for the given CreationalContext and type.
+
Create an InterceptionFactory for the given CreationalContext and type.
-
createInvoker(AnnotatedMethod<? super X>) - Method in interface jakarta.enterprise.inject.spi.ProcessManagedBean
+
createInvoker(BeanInfo, MethodInfo) - Method in interface jakarta.enterprise.inject.build.compatible.spi.InvokerFactory
-
Returns a new InvokerBuilder for given method.
+
Returns a new InvokerBuilder for given method of given bean.
-
createInvoker(MethodInfo) - Method in interface jakarta.enterprise.inject.build.compatible.spi.BeanInfo
+
createInvoker(AnnotatedMethod<? super X>) - Method in interface jakarta.enterprise.inject.spi.ProcessManagedBean
-
Returns a new InvokerBuilder for given method.
+
Returns a new InvokerBuilder for given method.
-
createProducer(Bean<T>) - Method in interface jakarta.enterprise.inject.spi.ProducerFactory
+
createProducer(Bean<T>) - Method in interface jakarta.enterprise.inject.spi.ProducerFactory
Create a new producer for a bean.
-
createWith(Class<? extends SyntheticBeanCreator<T>>) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticBeanBuilder
+
createWith(Class<? extends SyntheticBeanCreator<T>>) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticBeanBuilder
-
Sets the class of the synthetic bean creation function.
+
Sets the class of the synthetic bean creation function.
-
createWith(Function<CreationalContext<U>, U>) - Method in interface jakarta.enterprise.inject.spi.configurator.BeanConfigurator
+
createWith(Function<CreationalContext<U>, U>) - Method in interface jakarta.enterprise.inject.spi.configurator.BeanConfigurator
Set a callback to create a bean instance.
-
CreationalContext<T> - Interface in jakarta.enterprise.context.spi
+
CreationalContext<T> - Interface in jakarta.enterprise.context.spi
- Provides operations that are used by the Contextual implementation during instance + Provides operations that are used by the Contextual implementation during instance creation and destruction.
-
CreationException - Exception in jakarta.enterprise.inject
+
CreationException - Exception Class in jakarta.enterprise.inject
Indicates that a checked exception was thrown during creation of a bean.
-
CreationException() - Constructor for exception jakarta.enterprise.inject.CreationException
-
 
-
CreationException(String) - Constructor for exception jakarta.enterprise.inject.CreationException
-
 
-
CreationException(String, Throwable) - Constructor for exception jakarta.enterprise.inject.CreationException
-
 
-
CreationException(Throwable) - Constructor for exception jakarta.enterprise.inject.CreationException
-
 
-
current() - Static method in class jakarta.enterprise.inject.spi.CDI
+
CreationException() - Constructor for exception class jakarta.enterprise.inject.CreationException
+
+
Creates the exception with no detail message or cause.
+
+
CreationException(String) - Constructor for exception class jakarta.enterprise.inject.CreationException
+
+
Creates the exception with given detail message.
+
+
CreationException(String, Throwable) - Constructor for exception class jakarta.enterprise.inject.CreationException
+
+
Creates the exception with given detail message and cause.
+
+
CreationException(Throwable) - Constructor for exception class jakarta.enterprise.inject.CreationException
+
+
Creates the exception with given cause.
+
+
current() - Static method in class jakarta.enterprise.inject.spi.CDI
Get the CDI instance that provides access to the current container.
- - - -

D

-
-
deactivate() - Method in interface jakarta.enterprise.context.control.RequestContextController
+

D

+
+
deactivate() - Method in interface jakarta.enterprise.context.control.RequestContextController
Deactivates the current Request Context if it was activated by this context controller.
-
declaration() - Method in interface jakarta.enterprise.inject.build.compatible.spi.InjectionPointInfo
+
declaration() - Method in interface jakarta.enterprise.inject.build.compatible.spi.InjectionPointInfo
Returns the declaration of this injection point.
-
DeclarationConfig - Interface in jakarta.enterprise.inject.build.compatible.spi
+
declaration() - Method in interface jakarta.enterprise.lang.model.AnnotationInfo
+
+
Returns the declaration of this annotation's type.
+
+
declaration() - Method in interface jakarta.enterprise.lang.model.types.ClassType
+
+
Returns the declaration of this class type.
+
+
declaration() - Method in interface jakarta.enterprise.lang.model.types.ParameterizedType
+
+
Returns the declaration of the generic class + that was parameterized with a list of type arguments to form this parameterized type.
+
+
DeclarationConfig - Interface in jakarta.enterprise.inject.build.compatible.spi
Allows adding annotations to and removing annotations from a declaration.
-
declaringClass() - Method in interface jakarta.enterprise.inject.build.compatible.spi.BeanInfo
+
DeclarationInfo - Interface in jakarta.enterprise.lang.model.declarations
+
+
A declaration is an element of a program source code.
+
+
DeclarationInfo.Kind - Enum Class in jakarta.enterprise.lang.model.declarations
+
+
The declaration kind: package, class, method, parameter, field, record component.
+
+
declaringClass() - Method in interface jakarta.enterprise.inject.build.compatible.spi.BeanInfo
Returns the class that declares this bean.
-
declaringClass() - Method in interface jakarta.enterprise.inject.build.compatible.spi.ObserverInfo
+
declaringClass() - Method in interface jakarta.enterprise.inject.build.compatible.spi.ObserverInfo
-
Returns the class that declares this observer.
+
Returns the class that declares this observer.
-
declaringClass(ClassInfo) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticObserverBuilder
+
declaringClass() - Method in interface jakarta.enterprise.lang.model.declarations.FieldInfo
+
+
Returns the class that declares this field.
+
+
declaringClass() - Method in interface jakarta.enterprise.lang.model.declarations.MethodInfo
+
+
Returns the class that declares this method.
+
+
declaringClass(ClassInfo) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticObserverBuilder
Sets the bean class that "declares" this synthetic observer.
-
declaringClass(Class<?>) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticObserverBuilder
+
declaringClass(Class<?>) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticObserverBuilder
Sets the bean class that "declares" this synthetic observer.
-
Decorated - Annotation Type in jakarta.enterprise.inject
+
declaringMethod() - Method in interface jakarta.enterprise.lang.model.declarations.ParameterInfo
+
+
Returns the method that declares this parameter.
+
+
declaringRecord() - Method in interface jakarta.enterprise.lang.model.declarations.RecordComponentInfo
+
+
Returns the record that declares this component.
+
+
Decorated - Annotation Interface in jakarta.enterprise.inject
A decorator may inject metadata about the bean it is decorating
-
Decorator<T> - Interface in jakarta.enterprise.inject.spi
+
Decorated types - Search tag in package jakarta.decorator
+
Section
+
Decorator<T> - Interface in jakarta.enterprise.inject.spi
- Represents an enabled decorator.
+ Represents an enabled decorator.
-
Decorator - Annotation Type in jakarta.decorator
+
Decorator - Annotation Interface in jakarta.decorator
Specifies that a class is a decorator.
-
Default - Annotation Type in jakarta.enterprise.inject
+
Default - Annotation Interface in jakarta.enterprise.inject
The default qualifier type.
-
DEFAULT_CDI_PROVIDER_PRIORITY - Static variable in interface jakarta.enterprise.inject.spi.CDIProvider
-
 
-
DEFAULT_PRIORITY - Static variable in interface jakarta.enterprise.inject.spi.ObserverMethod
-
 
-
Default.Literal - Class in jakarta.enterprise.inject
+
DEFAULT_CDI_PROVIDER_PRIORITY - Static variable in interface jakarta.enterprise.inject.spi.CDIProvider
+
+
The default value for CDIProvider.getPriority()
+
+
DEFAULT_PRIORITY - Static variable in interface jakarta.enterprise.inject.spi.ObserverMethod
-
Supports inline instantiation of the Default qualifier.
+
The default observer priority
-
defaultScope() - Method in interface jakarta.enterprise.inject.build.compatible.spi.StereotypeInfo
+
Default.Literal - Class in jakarta.enterprise.inject
-
Returns the default scope defined by this stereotype.
+
Supports inline instantiation of the Default qualifier.
-
DefinitionException - Exception in jakarta.enterprise.inject.spi
+
defaultScope() - Method in interface jakarta.enterprise.inject.build.compatible.spi.StereotypeInfo
+
+
Returns the default scope defined by this stereotype.
+
+
DefinitionException - Exception Class in jakarta.enterprise.inject.spi
Thrown when a definition error occurs.
-
DefinitionException(String) - Constructor for exception jakarta.enterprise.inject.spi.DefinitionException
-
 
-
DefinitionException(String, Throwable) - Constructor for exception jakarta.enterprise.inject.spi.DefinitionException
-
 
-
DefinitionException(Throwable) - Constructor for exception jakarta.enterprise.inject.spi.DefinitionException
-
 
-
delegate(boolean) - Method in interface jakarta.enterprise.inject.spi.configurator.InjectionPointConfigurator
+
DefinitionException(String) - Constructor for exception class jakarta.enterprise.inject.spi.DefinitionException
+
+
Creates the exception with given detail message.
+
+
DefinitionException(String, Throwable) - Constructor for exception class jakarta.enterprise.inject.spi.DefinitionException
+
+
Creates the exception with given detail message and cause.
+
+
DefinitionException(Throwable) - Constructor for exception class jakarta.enterprise.inject.spi.DefinitionException
+
+
Creates the exception with given cause.
+
+
delegate(boolean) - Method in interface jakarta.enterprise.inject.spi.configurator.InjectionPointConfigurator
Change the delegate status of the built InjectionPoint.
-
Delegate - Annotation Type in jakarta.decorator
+
Delegate - Annotation Interface in jakarta.decorator
Identifies the delegate injection point of a decorator.
-
Dependent - Annotation Type in jakarta.enterprise.context
+
Delegate injection points - Search tag in package jakarta.decorator
+
Section
+
Dependent - Annotation Interface in jakarta.enterprise.context
Specifies that a bean belongs to the dependent pseudo-scope.
-
Dependent.Literal - Class in jakarta.enterprise.context
+
Dependent.Literal - Class in jakarta.enterprise.context
-
Supports inline instantiation of the Dependent annotation.
+
Supports inline instantiation of the Dependent annotation.
-
DeploymentException - Exception in jakarta.enterprise.inject.spi
+
DeploymentException - Exception Class in jakarta.enterprise.inject.spi
Thrown when a deployment problem occurs.
-
DeploymentException(String) - Constructor for exception jakarta.enterprise.inject.spi.DeploymentException
-
 
-
DeploymentException(String, Throwable) - Constructor for exception jakarta.enterprise.inject.spi.DeploymentException
-
 
-
DeploymentException(Throwable) - Constructor for exception jakarta.enterprise.inject.spi.DeploymentException
-
 
-
destroy() - Method in interface jakarta.enterprise.inject.Instance.Handle
+
DeploymentException(String) - Constructor for exception class jakarta.enterprise.inject.spi.DeploymentException
+
+
Creates the exception with given detail message.
+
+
DeploymentException(String, Throwable) - Constructor for exception class jakarta.enterprise.inject.spi.DeploymentException
+
+
Creates the exception with given detail message and cause.
+
+
DeploymentException(Throwable) - Constructor for exception class jakarta.enterprise.inject.spi.DeploymentException
+
+
Creates the exception with given cause.
+
+
destroy() - Method in interface jakarta.enterprise.inject.Instance.Handle
Destroy the contextual instance.
-
destroy(Contextual<?>) - Method in interface jakarta.enterprise.context.spi.AlterableContext
+
destroy(Contextual<?>) - Method in interface jakarta.enterprise.context.spi.AlterableContext
Destroy the existing contextual instance.
-
destroy(T) - Method in interface jakarta.enterprise.inject.Instance
+
destroy(T) - Method in interface jakarta.enterprise.inject.Instance
When called, the container destroys the instance if the active context object for the scope type of the bean supports destroying bean instances.
-
destroy(T, CreationalContext<T>) - Method in interface jakarta.enterprise.context.spi.Contextual
+
destroy(T, CreationalContext<T>) - Method in interface jakarta.enterprise.context.spi.Contextual
Destroy an instance of the contextual type.
-
Destroyed - Annotation Type in jakarta.enterprise.context
+
Destroyed - Annotation Interface in jakarta.enterprise.context
An event with this qualifier is fired when a context is destroyed, i.e.
-
Destroyed.Literal - Class in jakarta.enterprise.context
+
Destroyed.Literal - Class in jakarta.enterprise.context
-
Supports inline instantiation of the Destroyed qualifier.
+
Supports inline instantiation of the Destroyed qualifier.
-
destroyWith(BiConsumer<T, CreationalContext<T>>) - Method in interface jakarta.enterprise.inject.spi.configurator.BeanConfigurator
+
destroyWith(BiConsumer<T, CreationalContext<T>>) - Method in interface jakarta.enterprise.inject.spi.configurator.BeanConfigurator
Set a callback to destroy a bean instance.
-
disableDiscovery() - Method in class jakarta.enterprise.inject.se.SeContainerInitializer
+
disableDiscovery() - Method in class jakarta.enterprise.inject.se.SeContainerInitializer
By default, the discovery is enabled.
-
discoveredProviders - Static variable in class jakarta.enterprise.inject.spi.CDI
-
 
-
Discovery - Annotation Type in jakarta.enterprise.inject.build.compatible.spi
+
discoveredProviders - Static variable in class jakarta.enterprise.inject.spi.CDI
+
+
The set of discovered CDIProviders
+
+
Discovery - Annotation Interface in jakarta.enterprise.inject.build.compatible.spi
-
1st phase of build compatible extension execution.
+
1st phase of build compatible extension execution.
-
dispose() - Method in class jakarta.enterprise.inject.spi.Unmanaged.UnmanagedInstance
+
dispose() - Method in class jakarta.enterprise.inject.spi.Unmanaged.UnmanagedInstance
Dispose of the instance, doing any necessary cleanup
-
dispose(T) - Method in interface jakarta.enterprise.inject.spi.Producer
+
dispose(T) - Method in interface jakarta.enterprise.inject.spi.Producer
Destroys the instance.
-
dispose(T, Instance<Object>, Parameters) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticBeanDisposer
+
dispose(T, Instance<Object>, Parameters) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticBeanDisposer
Destroys an instance of the synthetic bean.
-
disposedParameter() - Method in interface jakarta.enterprise.inject.build.compatible.spi.DisposerInfo
+
disposedParameter() - Method in interface jakarta.enterprise.inject.build.compatible.spi.DisposerInfo
-
Returns the declaration of the disposed parameter of this disposer method.
+
Returns the declaration of the disposed parameter of this disposer method.
-
disposer() - Method in interface jakarta.enterprise.inject.build.compatible.spi.BeanInfo
+
disposer() - Method in interface jakarta.enterprise.inject.build.compatible.spi.BeanInfo
-
Returns the disposer method of this producer-based bean.
+
Returns the disposer method of this producer-based bean.
-
DisposerInfo - Interface in jakarta.enterprise.inject.build.compatible.spi
+
DisposerInfo - Interface in jakarta.enterprise.inject.build.compatible.spi
Disposer methods may exist for producer-based beans.
-
disposerMethod() - Method in interface jakarta.enterprise.inject.build.compatible.spi.DisposerInfo
+
disposerMethod() - Method in interface jakarta.enterprise.inject.build.compatible.spi.DisposerInfo
-
Returns the declaration of this disposer method.
+
Returns the declaration of this disposer method.
-
Disposes - Annotation Type in jakarta.enterprise.inject
+
Disposes - Annotation Interface in jakarta.enterprise.inject
Identifies the disposed parameter of a disposer method.
-
disposeWith(Class<? extends SyntheticBeanDisposer<T>>) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticBeanBuilder
+
disposeWith(Class<? extends SyntheticBeanDisposer<T>>) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticBeanBuilder
-
Sets the class of the synthetic bean destruction function.
+
Sets the class of the synthetic bean destruction function.
-
disposeWith(BiConsumer<T, Instance<Object>>) - Method in interface jakarta.enterprise.inject.spi.configurator.BeanConfigurator
+
disposeWith(BiConsumer<T, Instance<Object>>) - Method in interface jakarta.enterprise.inject.spi.configurator.BeanConfigurator
Set a callback to destroy a bean instance.
-
disposeWith(Consumer<T>) - Method in interface jakarta.enterprise.inject.spi.configurator.ProducerConfigurator
+
disposeWith(Consumer<T>) - Method in interface jakarta.enterprise.inject.spi.configurator.ProducerConfigurator
Set a callback to destroy the produced instance.
-
during() - Method in annotation type jakarta.enterprise.event.Observes
+
DOUBLE - Enum constant in enum class jakarta.enterprise.lang.model.AnnotationMember.Kind
+
+
A primitive double value.
+
+
DOUBLE - Enum constant in enum class jakarta.enterprise.lang.model.types.PrimitiveType.PrimitiveKind
+
+
The double primitive type
+
+
during() - Element in annotation interface jakarta.enterprise.event.Observes
+ Specifies at what time the observer method is notified.
- - - -

E

-
-
enableDecorators(Class<?>...) - Method in class jakarta.enterprise.inject.se.SeContainerInitializer
+

E

+
+
ELAwareBeanManager - Interface in jakarta.enterprise.inject.spi.el
+
+
A BeanManager that allows integrators to obtain Unified EL objects that are + integrated with the CDI container as described in the Jakarta EE Platform specification.
+
+
Enabled decorators - Search tag in package jakarta.decorator
+
Section
+
enableDecorators(Class<?>...) - Method in class jakarta.enterprise.inject.se.SeContainerInitializer
Add decorator classes to the list of enabled decorators for the synthetic bean archive.
-
enableInterceptors(Class<?>...) - Method in class jakarta.enterprise.inject.se.SeContainerInitializer
+
enableInterceptors(Class<?>...) - Method in class jakarta.enterprise.inject.se.SeContainerInitializer
Add interceptor classes to the list of enabled interceptors for the synthetic bean archive.
-
end() - Method in interface jakarta.enterprise.context.Conversation
+
end() - Method in interface jakarta.enterprise.context.Conversation
Marks the current long-running conversation transient.
-
Enhancement - Annotation Type in jakarta.enterprise.inject.build.compatible.spi
+
Enhancement - Annotation Interface in jakarta.enterprise.inject.build.compatible.spi
-
2nd phase of build compatible extension execution.
+
2nd phase of build compatible extension execution.
-
equals(Object) - Method in class jakarta.enterprise.util.AnnotationLiteral
+
ENUM - Enum constant in enum class jakarta.enterprise.lang.model.AnnotationMember.Kind
+
+
An Enum value.
+
+
equals(Object) - Method in class jakarta.enterprise.util.AnnotationLiteral
 
-
equals(Object) - Method in class jakarta.enterprise.util.TypeLiteral
+
equals(Object) - Method in class jakarta.enterprise.util.TypeLiteral
 
-
error(Exception) - Method in interface jakarta.enterprise.inject.build.compatible.spi.Messages
+
error(Exception) - Method in interface jakarta.enterprise.inject.build.compatible.spi.Messages
Add a generic error that is represented by an exception.
-
error(String) - Method in interface jakarta.enterprise.inject.build.compatible.spi.Messages
+
error(String) - Method in interface jakarta.enterprise.inject.build.compatible.spi.Messages
Add a generic error that is not related to any particular element, or that information is not known.
-
error(String, BeanInfo) - Method in interface jakarta.enterprise.inject.build.compatible.spi.Messages
+
error(String, BeanInfo) - Method in interface jakarta.enterprise.inject.build.compatible.spi.Messages
-
Add an error which is related to given BeanInfo.
+
Add an error which is related to given BeanInfo.
-
error(String, ObserverInfo) - Method in interface jakarta.enterprise.inject.build.compatible.spi.Messages
+
error(String, ObserverInfo) - Method in interface jakarta.enterprise.inject.build.compatible.spi.Messages
-
Add an error which is related to given ObserverInfo.
+
Add an error which is related to given ObserverInfo.
-
error(String, AnnotationTarget) - Method in interface jakarta.enterprise.inject.build.compatible.spi.Messages
+
error(String, AnnotationTarget) - Method in interface jakarta.enterprise.inject.build.compatible.spi.Messages
-
Add an error which is related to given AnnotationTarget (which is most likely - a DeclarationInfo).
+
Add an error which is related to given AnnotationTarget (which is most likely + a DeclarationInfo).
-
Event<T> - Interface in jakarta.enterprise.event
+
Event<T> - Interface in jakarta.enterprise.event
Allows the application to fire events of a particular type.
-
EventContext<T> - Interface in jakarta.enterprise.inject.spi
+
EventContext<T> - Interface in jakarta.enterprise.inject.spi
Represents a context of a fired event.
-
EventMetadata - Interface in jakarta.enterprise.inject.spi
+
EventMetadata - Interface in jakarta.enterprise.inject.spi
Provides access to metadata about an observed event payload.
-
eventParameter() - Method in interface jakarta.enterprise.inject.build.compatible.spi.ObserverInfo
+
Event objects and event types - Search tag in package jakarta.enterprise.event
+
Section
+
eventParameter() - Method in interface jakarta.enterprise.inject.build.compatible.spi.ObserverInfo
-
Returns the event parameter of this observer method.
+
Returns the event parameter of this observer method.
-
eventType() - Method in interface jakarta.enterprise.inject.build.compatible.spi.ObserverInfo
+
Event qualifiers - Search tag in package jakarta.enterprise.event
+
Section
+
eventType() - Method in interface jakarta.enterprise.inject.build.compatible.spi.ObserverInfo
Returns the observed event type of this observer.
-
Extension - Interface in jakarta.enterprise.inject.spi
+
Extension - Interface in jakarta.enterprise.inject.spi
Service interface implemented by extensions.
- - - -

F

-
-
FieldConfig - Interface in jakarta.enterprise.inject.build.compatible.spi
+

F

+
+
field() - Method in interface jakarta.enterprise.lang.model.declarations.RecordComponentInfo
+
+
Returns the field corresponding to this record component.
+
+
FIELD - Enum constant in enum class jakarta.enterprise.lang.model.declarations.DeclarationInfo.Kind
+
+
Field
+
+
FieldConfig - Interface in jakarta.enterprise.inject.build.compatible.spi
Allows adding annotations to and removing annotations from a field.
-
fields() - Method in interface jakarta.enterprise.inject.build.compatible.spi.ClassConfig
+
FieldInfo - Interface in jakarta.enterprise.lang.model.declarations
+
+
A field, declared in some class.
+
+
fields() - Method in interface jakarta.enterprise.inject.build.compatible.spi.ClassConfig
-
Returns a collection of FieldConfig objects for each field of this class, - as defined by ClassInfo.fields.
+
Returns a collection of FieldConfig objects for each field of this class, + as defined by ClassInfo.fields.
-
fields() - Method in interface jakarta.enterprise.inject.spi.configurator.AnnotatedTypeConfigurator
+
fields() - Method in interface jakarta.enterprise.inject.spi.configurator.AnnotatedTypeConfigurator
 
-
filterConstructors(Predicate<AnnotatedConstructor<T>>) - Method in interface jakarta.enterprise.inject.spi.configurator.AnnotatedTypeConfigurator
+
fields() - Method in interface jakarta.enterprise.lang.model.declarations.ClassInfo
+
+
Returns a collection of fields declared or implicitly declared + in this class and all its superclasses up to and excluding java.lang.Object, + as well as all direct and indirect superinterfaces.
+
+
filterConstructors(Predicate<AnnotatedConstructor<T>>) - Method in interface jakarta.enterprise.inject.spi.configurator.AnnotatedTypeConfigurator
 
-
filterFields(Predicate<AnnotatedField<? super T>>) - Method in interface jakarta.enterprise.inject.spi.configurator.AnnotatedTypeConfigurator
+
filterFields(Predicate<AnnotatedField<? super T>>) - Method in interface jakarta.enterprise.inject.spi.configurator.AnnotatedTypeConfigurator
 
-
filterMethods(Predicate<AnnotatedMethod<? super T>>) - Method in interface jakarta.enterprise.inject.spi.configurator.AnnotatedTypeConfigurator
+
filterMethods(Predicate<AnnotatedMethod<? super T>>) - Method in interface jakarta.enterprise.inject.spi.configurator.AnnotatedTypeConfigurator
 
-
filterParams(Predicate<AnnotatedParameter<T>>) - Method in interface jakarta.enterprise.inject.spi.configurator.AnnotatedConstructorConfigurator
+
filterParams(Predicate<AnnotatedParameter<T>>) - Method in interface jakarta.enterprise.inject.spi.configurator.AnnotatedConstructorConfigurator
 
-
filterParams(Predicate<AnnotatedParameter<T>>) - Method in interface jakarta.enterprise.inject.spi.configurator.AnnotatedMethodConfigurator
+
filterParams(Predicate<AnnotatedParameter<T>>) - Method in interface jakarta.enterprise.inject.spi.configurator.AnnotatedMethodConfigurator
 
-
fire(T) - Method in interface jakarta.enterprise.event.Event
+
fire(T) - Method in interface jakarta.enterprise.event.Event
Fires an event with the specified qualifiers and notifies observers.
-
fireAsync(U) - Method in interface jakarta.enterprise.event.Event
+
fireAsync(U) - Method in interface jakarta.enterprise.event.Event
Fires an event asynchronously with the specified qualifiers and notifies asynchronous observers.
-
fireAsync(U, NotificationOptions) - Method in interface jakarta.enterprise.event.Event
+
fireAsync(U, NotificationOptions) - Method in interface jakarta.enterprise.event.Event
Fires an event asynchronously with the specified qualifiers and notifies asynchronous observers.
+
FLOAT - Enum constant in enum class jakarta.enterprise.lang.model.AnnotationMember.Kind
+
+
A primitive float value.
+
+
FLOAT - Enum constant in enum class jakarta.enterprise.lang.model.types.PrimitiveType.PrimitiveKind
+
+
The float primitive type
+
- - - -

G

-
-
get() - Method in interface jakarta.enterprise.inject.Instance.Handle
+

G

+
+
genericClass() - Method in interface jakarta.enterprise.lang.model.types.ParameterizedType
+
+
Returns the type of the generic class that was parameterized with a list + of type arguments to form this parameterized type.
+
+
get() - Method in interface jakarta.enterprise.inject.Instance.Handle
The contextual reference is obtained lazily, i.e.
-
get() - Method in class jakarta.enterprise.inject.spi.Unmanaged.UnmanagedInstance
+
get() - Method in class jakarta.enterprise.inject.spi.Unmanaged.UnmanagedInstance
Get the instance
-
get(Contextual<T>) - Method in interface jakarta.enterprise.context.spi.Context
+
get(Contextual<T>) - Method in interface jakarta.enterprise.context.spi.Context
Return an existing instance of a certain contextual type or a null value.
-
get(Contextual<T>, CreationalContext<T>) - Method in interface jakarta.enterprise.context.spi.Context
+
get(Contextual<T>, CreationalContext<T>) - Method in interface jakarta.enterprise.context.spi.Context
Return an existing instance of certain contextual type or create a new instance by calling - Contextual.create(CreationalContext) and return the new instance.
+ Contextual.create(CreationalContext) and return the new instance.
-
get(String) - Method in interface jakarta.enterprise.event.NotificationOptions
+
get(String) - Method in interface jakarta.enterprise.event.NotificationOptions
 
-
get(String, Class<T>) - Method in interface jakarta.enterprise.inject.build.compatible.spi.Parameters
+
get(String, Class<T>) - Method in interface jakarta.enterprise.inject.build.compatible.spi.Parameters
Returns the value of a parameter with given key.
-
get(String, Class<T>, T) - Method in interface jakarta.enterprise.inject.build.compatible.spi.Parameters
+
get(String, Class<T>, T) - Method in interface jakarta.enterprise.inject.build.compatible.spi.Parameters
Returns the value of a parameter with given key.
-
getAlternatives() - Method in interface jakarta.enterprise.inject.spi.AfterTypeDiscovery
+
getAlternatives() - Method in interface jakarta.enterprise.inject.spi.AfterTypeDiscovery
 
-
getAnnotated() - Method in interface jakarta.enterprise.inject.spi.configurator.AnnotatedConstructorConfigurator
+
getAnnotated() - Method in interface jakarta.enterprise.inject.spi.configurator.AnnotatedConstructorConfigurator
 
-
getAnnotated() - Method in interface jakarta.enterprise.inject.spi.configurator.AnnotatedFieldConfigurator
+
getAnnotated() - Method in interface jakarta.enterprise.inject.spi.configurator.AnnotatedFieldConfigurator
 
-
getAnnotated() - Method in interface jakarta.enterprise.inject.spi.configurator.AnnotatedMethodConfigurator
+
getAnnotated() - Method in interface jakarta.enterprise.inject.spi.configurator.AnnotatedMethodConfigurator
 
-
getAnnotated() - Method in interface jakarta.enterprise.inject.spi.configurator.AnnotatedParameterConfigurator
+
getAnnotated() - Method in interface jakarta.enterprise.inject.spi.configurator.AnnotatedParameterConfigurator
 
-
getAnnotated() - Method in interface jakarta.enterprise.inject.spi.configurator.AnnotatedTypeConfigurator
+
getAnnotated() - Method in interface jakarta.enterprise.inject.spi.configurator.AnnotatedTypeConfigurator
 
-
getAnnotated() - Method in interface jakarta.enterprise.inject.spi.InjectionPoint
+
getAnnotated() - Method in interface jakarta.enterprise.inject.spi.InjectionPoint
-
Obtain an instance of AnnotatedField or - AnnotatedParameter, depending upon whether the injection point is an injected field +
Obtain an instance of AnnotatedField or + AnnotatedParameter, depending upon whether the injection point is an injected field or a constructor/method parameter.
-
getAnnotated() - Method in interface jakarta.enterprise.inject.spi.ProcessBean
+
getAnnotated() - Method in interface jakarta.enterprise.inject.spi.ProcessBean
-
Returns the AnnotatedType representing the bean class, the - AnnotatedMethod representing the producer method, or the - AnnotatedField representing the producer field.
+
Returns the AnnotatedType representing the bean class, the + AnnotatedMethod representing the producer method, or the + AnnotatedField representing the producer field.
-
getAnnotated() - Method in interface jakarta.enterprise.inject.spi.ProcessBeanAttributes
+
getAnnotated() - Method in interface jakarta.enterprise.inject.spi.ProcessBeanAttributes
 
-
getAnnotatedBeanClass() - Method in interface jakarta.enterprise.inject.spi.ProcessManagedBean
+
getAnnotatedBeanClass() - Method in interface jakarta.enterprise.inject.spi.ProcessManagedBean
-
Returns the AnnotatedType representing the bean class.
+
Returns the AnnotatedType representing the bean class.
-
getAnnotatedDisposedParameter() - Method in interface jakarta.enterprise.inject.spi.ProcessProducerField
+
getAnnotatedDisposedParameter() - Method in interface jakarta.enterprise.inject.spi.ProcessProducerField
-
Returns the AnnotatedParameter for any matching injection point of the same type as +
Returns the AnnotatedParameter for any matching injection point of the same type as the producer field return type found on a disposal method.
-
getAnnotatedDisposedParameter() - Method in interface jakarta.enterprise.inject.spi.ProcessProducerMethod
+
getAnnotatedDisposedParameter() - Method in interface jakarta.enterprise.inject.spi.ProcessProducerMethod
-
Returns the AnnotatedParameter for any matching injection point of the same type as +
Returns the AnnotatedParameter for any matching injection point of the same type as the producer method return type found on a disposal method.
-
getAnnotatedMember() - Method in interface jakarta.enterprise.inject.spi.ProcessProducer
+
getAnnotatedMember() - Method in interface jakarta.enterprise.inject.spi.ProcessProducer
-
Returns the AnnotatedField representing the producer field or the - AnnotatedMethod representing the producer method.
+
Returns the AnnotatedField representing the producer field or the + AnnotatedMethod representing the producer method.
-
getAnnotatedMethod() - Method in interface jakarta.enterprise.inject.spi.ProcessObserverMethod
+
getAnnotatedMethod() - Method in interface jakarta.enterprise.inject.spi.ProcessObserverMethod
-
The AnnotatedMethod representing the observer method.
+
The AnnotatedMethod representing the observer method.
-
getAnnotatedProducerField() - Method in interface jakarta.enterprise.inject.spi.ProcessProducerField
+
getAnnotatedProducerField() - Method in interface jakarta.enterprise.inject.spi.ProcessProducerField
-
Returns the AnnotatedField representing the producer field.
+
Returns the AnnotatedField representing the producer field.
-
getAnnotatedProducerMethod() - Method in interface jakarta.enterprise.inject.spi.ProcessProducerMethod
+
getAnnotatedProducerMethod() - Method in interface jakarta.enterprise.inject.spi.ProcessProducerMethod
-
Returns the AnnotatedMethod representing the producer method.
+
Returns the AnnotatedMethod representing the producer method.
-
getAnnotatedType() - Method in interface jakarta.enterprise.inject.spi.ProcessAnnotatedType
+
getAnnotatedType() - Method in interface jakarta.enterprise.inject.spi.ProcessAnnotatedType
-
Returns the AnnotatedType object that will be used by the container to read the +
Returns the AnnotatedType object that will be used by the container to read the declared annotations.
-
getAnnotatedType() - Method in interface jakarta.enterprise.inject.spi.ProcessInjectionTarget
+
getAnnotatedType() - Method in interface jakarta.enterprise.inject.spi.ProcessInjectionTarget
-
Returns the AnnotatedType representing the managed bean class, session bean class or +
Returns the AnnotatedType representing the managed bean class, session bean class or other Java EE component class supporting injection.
-
getAnnotatedType(Class<T>, String) - Method in interface jakarta.enterprise.inject.spi.AfterBeanDiscovery
+
getAnnotatedType(Class<T>, String) - Method in interface jakarta.enterprise.inject.spi.AfterBeanDiscovery
-
Obtain the AnnotatedType that may be used to read the annotations of the given class or interface as defined +
Obtain the AnnotatedType that may be used to read the annotations of the given class or interface as defined during container initialization.
-
getAnnotatedTypes(Class<T>) - Method in interface jakarta.enterprise.inject.spi.AfterBeanDiscovery
+
getAnnotatedTypes(Class<T>) - Method in interface jakarta.enterprise.inject.spi.AfterBeanDiscovery
-
Obtain the AnnotatedTypes that may be used to read the annotations of the given class or interface as defined +
Obtain the AnnotatedTypes that may be used to read the annotations of the given class or interface as defined during container initialization.
-
getAnnotation(Class<T>) - Method in interface jakarta.enterprise.inject.spi.Annotated
+
getAnnotation(Class<T>) - Method in interface jakarta.enterprise.inject.spi.Annotated
Get program element annotation of a certain annotation type.
-
getAnnotations() - Method in interface jakarta.enterprise.inject.spi.Annotated
+
getAnnotations() - Method in interface jakarta.enterprise.inject.spi.Annotated
Get all annotations of the program element.
-
getAnnotations(Class<T>) - Method in interface jakarta.enterprise.inject.spi.Annotated
+
getAnnotations(Class<T>) - Method in interface jakarta.enterprise.inject.spi.Annotated
Get program element annotations of a certain annotation type.
-
getAnnotations(Class<T>) - Method in interface jakarta.enterprise.inject.spi.AnnotatedConstructor
+
getAnnotations(Class<T>) - Method in interface jakarta.enterprise.inject.spi.AnnotatedConstructor
 
-
getAnnotations(Class<T>) - Method in interface jakarta.enterprise.inject.spi.AnnotatedField
+
getAnnotations(Class<T>) - Method in interface jakarta.enterprise.inject.spi.AnnotatedField
 
-
getAnnotations(Class<T>) - Method in interface jakarta.enterprise.inject.spi.AnnotatedMethod
+
getAnnotations(Class<T>) - Method in interface jakarta.enterprise.inject.spi.AnnotatedMethod
 
-
getAnnotations(Class<T>) - Method in interface jakarta.enterprise.inject.spi.AnnotatedParameter
+
getAnnotations(Class<T>) - Method in interface jakarta.enterprise.inject.spi.AnnotatedParameter
 
-
getAnnotations(Class<T>) - Method in interface jakarta.enterprise.inject.spi.AnnotatedType
+
getAnnotations(Class<T>) - Method in interface jakarta.enterprise.inject.spi.AnnotatedType
 
-
getBaseType() - Method in interface jakarta.enterprise.inject.spi.Annotated
+
getBaseType() - Method in interface jakarta.enterprise.inject.spi.Annotated
Get the type of the annotated program element.
-
getBean() - Method in interface jakarta.enterprise.inject.Instance.Handle
+
getBean() - Method in interface jakarta.enterprise.inject.Instance.Handle
 
-
getBean() - Method in interface jakarta.enterprise.inject.spi.InjectionPoint
+
getBean() - Method in interface jakarta.enterprise.inject.spi.InjectionPoint
-
Get the Bean object representing the bean that defines the injection point.
+
Get the Bean object representing the bean that defines the injection point.
-
getBean() - Method in interface jakarta.enterprise.inject.spi.ProcessBean
+
getBean() - Method in interface jakarta.enterprise.inject.spi.ProcessBean
-
Returns the Bean object that is about to be registered.
+
Returns the Bean object that is about to be registered.
-
getBeanAttributes() - Method in interface jakarta.enterprise.inject.spi.ProcessBeanAttributes
+
getBeanAttributes() - Method in interface jakarta.enterprise.inject.spi.ProcessBeanAttributes
 
-
getBeanClass() - Method in interface jakarta.enterprise.inject.spi.Bean
+
getBeanClass() - Method in interface jakarta.enterprise.inject.spi.Bean
-
The bean class of the managed bean or session bean or of the bean that declares the producer method or +
The bean class of the managed bean or session bean or of the bean that declares the producer method or field.
-
getBeanClass() - Method in interface jakarta.enterprise.inject.spi.ObserverMethod
+
getBeanClass() - Method in interface jakarta.enterprise.inject.spi.ObserverMethod
- Obtains the class of the type that declares the observer method.
+ Obtains the class of the type that declares the observer method.
-
getBeanContainer() - Method in interface jakarta.enterprise.inject.se.SeContainer
+
getBeanContainer() - Method in interface jakarta.enterprise.inject.se.SeContainer
-
Get the CDI BeanContainer for this container.
+
Get the CDI BeanContainer for this container.
-
getBeanContainer() - Method in class jakarta.enterprise.inject.spi.CDI
+
getBeanContainer() - Method in class jakarta.enterprise.inject.spi.CDI
-
Get the CDI BeanContainer for the current context.
+
Get the CDI BeanContainer for the current context.
-
getBeanManager() - Method in interface jakarta.enterprise.inject.se.SeContainer
+
getBeanManager() - Method in interface jakarta.enterprise.inject.se.SeContainer
Get the CDI BeanManager for this container
-
getBeanManager() - Method in class jakarta.enterprise.inject.spi.CDI
+
getBeanManager() - Method in class jakarta.enterprise.inject.spi.CDI
Get the CDI BeanManager for the current context
-
getBeans(Type, Annotation...) - Method in interface jakarta.enterprise.inject.spi.BeanContainer
+
getBeans(Type, Annotation...) - Method in interface jakarta.enterprise.inject.spi.BeanContainer
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 BeanManager/BeanContainer was injected or, in the Jakarta EE environment, the Jakarta EE component from whose JNDI environment namespace the BeanManager/BeanContainer was obtained, according to the rules of typesafe resolution.
-
getBeans(String) - Method in interface jakarta.enterprise.inject.spi.BeanContainer
+
getBeans(String) - Method in interface jakarta.enterprise.inject.spi.BeanContainer
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 BeanManager/BeanContainer was injected or, in the Jakarta EE environment, the Jakarta EE component from whose JNDI environment namespace the BeanManager/BeanContainer was obtained, according to the rules of EL name resolution.
-
getCDI() - Method in interface jakarta.enterprise.inject.spi.CDIProvider
+
getCDI() - Method in interface jakarta.enterprise.inject.spi.CDIProvider
Provides access to the current container
-
getConstructors() - Method in interface jakarta.enterprise.inject.spi.AnnotatedType
+
getConstructors() - Method in interface jakarta.enterprise.inject.spi.AnnotatedType
- Get the constructors of the type.
+ Get the constructors of the type.
-
getContext(Class<? extends Annotation>) - Method in interface jakarta.enterprise.inject.spi.BeanContainer
+
getContext(Class<? extends Annotation>) - Method in interface jakarta.enterprise.inject.spi.BeanContainer
-
Obtains an active context object for the given - scope .
+
Obtains an active context object for the given + scope .
-
getContexts(Class<? extends Annotation>) - Method in interface jakarta.enterprise.inject.spi.BeanContainer
+
getContexts(Class<? extends Annotation>) - Method in interface jakarta.enterprise.inject.spi.BeanContainer
-
Obtains all context objects, active and inactive, for the given - scope.
+
Obtains all context objects, active and inactive, for the given + scope.
-
getDeclaringBean() - Method in interface jakarta.enterprise.inject.spi.ObserverMethod
+
getDeclaringBean() - Method in interface jakarta.enterprise.inject.spi.ObserverMethod
- Obtains the bean that declares the observer method.
+ Obtains the bean that declares the observer method.
-
getDeclaringCallable() - Method in interface jakarta.enterprise.inject.spi.AnnotatedParameter
+
getDeclaringCallable() - Method in interface jakarta.enterprise.inject.spi.AnnotatedParameter
- Get the declaring method or constructor.
+ Get the declaring method or constructor.
-
getDeclaringType() - Method in interface jakarta.enterprise.inject.spi.AnnotatedMember
+
getDeclaringType() - Method in interface jakarta.enterprise.inject.spi.AnnotatedMember
- Get the type which defines this member.
+ Get the type which defines this member.
-
getDecoratedTypes() - Method in interface jakarta.enterprise.inject.spi.Decorator
+
getDecoratedTypes() - Method in interface jakarta.enterprise.inject.spi.Decorator
- Obtains the decorated types.
+ Obtains the decorated types.
-
getDecorators() - Method in interface jakarta.enterprise.inject.spi.AfterTypeDiscovery
+
getDecorators() - Method in interface jakarta.enterprise.inject.spi.AfterTypeDiscovery
 
-
getDelegateQualifiers() - Method in interface jakarta.enterprise.inject.spi.Decorator
+
getDelegateQualifiers() - Method in interface jakarta.enterprise.inject.spi.Decorator
-
getDelegateType() - Method in interface jakarta.enterprise.inject.spi.Decorator
+
getDelegateType() - Method in interface jakarta.enterprise.inject.spi.Decorator
- Obtains the type of the delegate injection point.
+ Obtains the type of the delegate injection point.
-
getEjbName() - Method in interface jakarta.enterprise.inject.spi.ProcessSessionBean
+
getEjbName() - Method in interface jakarta.enterprise.inject.spi.ProcessSessionBean
Returns the EJB name of the session bean.
-
getELResolver() - Method in interface jakarta.enterprise.inject.spi.BeanManager
+
getELResolver() - Method in interface jakarta.enterprise.inject.spi.BeanManager
-
Deprecated, for removal: This API element is subject to removal in a future version. -
use ELAwareBeanManager, this method will be removed in CDI 5.0
+
Deprecated, for removal: This API element is subject to removal in a future version. +
use ELAwareBeanManager, this method will be removed in CDI 5.0
-
getEvent() - Method in interface jakarta.enterprise.inject.spi.BeanContainer
+
getELResolver() - Method in interface jakarta.enterprise.inject.spi.el.ELAwareBeanManager
+
+
Returns a ELResolver that resolves beans by EL name.
+
+
getEvent() - Method in interface jakarta.enterprise.inject.spi.BeanContainer
-
Returns an instance of Event with specified type java.lang.Object and specified qualifier @Default - It allows typesafe synchronous or asynchronous event firing without injection of Event built-in bean requirement.
+
Returns an instance of Event with specified type java.lang.Object and specified qualifier + @Default + It allows typesafe synchronous or asynchronous event firing without injection of Event built-in bean requirement.
-
getEvent() - Method in interface jakarta.enterprise.inject.spi.EventContext
+
getEvent() - Method in interface jakarta.enterprise.inject.spi.EventContext
 
-
getExecutor() - Method in interface jakarta.enterprise.event.NotificationOptions
+
getExecutor() - Method in interface jakarta.enterprise.event.NotificationOptions
 
-
getExtension(Class<T>) - Method in interface jakarta.enterprise.inject.spi.BeanManager
+
getExtension(Class<T>) - Method in interface jakarta.enterprise.inject.spi.BeanManager
Obtains the container's instance of an Extension class declared in META-INF/services.
-
getFields() - Method in interface jakarta.enterprise.inject.spi.AnnotatedType
+
getFields() - Method in interface jakarta.enterprise.inject.spi.AnnotatedType
- Get the fields of the type.
+ Get the fields of the type.
-
getHandle() - Method in interface jakarta.enterprise.inject.Instance
+
getHandle() - Method in interface jakarta.enterprise.inject.Instance
-
Obtains an initialized contextual reference handle for a bean that has the required type and qualifiers and is - eligible for injection.
+
Obtains an initialized contextual reference handle for a bean that has the required type and qualifiers and is eligible + for injection.
-
getId() - Method in interface jakarta.enterprise.context.Conversation
+
getId() - Method in interface jakarta.enterprise.context.Conversation
Get the identifier of the current long-running conversation.
-
getId() - Method in interface jakarta.enterprise.inject.spi.PassivationCapable
+
getId() - Method in interface jakarta.enterprise.inject.spi.PassivationCapable
-
A string that uniquely identifies the instance of Bean or - Contextual.
+
A string that uniquely identifies the instance of Bean or + Contextual.
-
getInjectableReference(InjectionPoint, CreationalContext<?>) - Method in interface jakarta.enterprise.inject.spi.BeanManager
+
getInjectableReference(InjectionPoint, CreationalContext<?>) - Method in interface jakarta.enterprise.inject.spi.BeanManager
- Obtains an injectable reference for a certain injection point.
+ Obtains an injectable reference for a certain injection point.
-
getInjectionPoint() - Method in interface jakarta.enterprise.inject.spi.EventMetadata
+
getInjectionPoint() - Method in interface jakarta.enterprise.inject.spi.EventMetadata
-
Get the InjectionPoint representing the injected Event instance which fired the event
+
Get the InjectionPoint representing the injected Event instance which fired the event
-
getInjectionPoint() - Method in interface jakarta.enterprise.inject.spi.ProcessInjectionPoint
+
getInjectionPoint() - Method in interface jakarta.enterprise.inject.spi.ProcessInjectionPoint
 
-
getInjectionPoints() - Method in interface jakarta.enterprise.inject.spi.Bean
+
getInjectionPoints() - Method in interface jakarta.enterprise.inject.spi.Bean
-
Obtains the InjectionPoint objects representing injection points of the bean, that +
Obtains the InjectionPoint objects representing injection points of the bean, that will be validated by the container at initialization time.
-
getInjectionPoints() - Method in interface jakarta.enterprise.inject.spi.Producer
+
getInjectionPoints() - Method in interface jakarta.enterprise.inject.spi.Producer
Returns the set of all InjectionPoints.
-
getInjectionTarget() - Method in interface jakarta.enterprise.inject.spi.ProcessInjectionTarget
+
getInjectionTarget() - Method in interface jakarta.enterprise.inject.spi.ProcessInjectionTarget
-
Returns the InjectionTarget object that will be used by the container to perform +
Returns the InjectionTarget object that will be used by the container to perform injection.
-
getInjectionTargetFactory(AnnotatedType<T>) - Method in interface jakarta.enterprise.inject.spi.BeanManager
+
getInjectionTargetFactory(AnnotatedType<T>) - Method in interface jakarta.enterprise.inject.spi.BeanManager
- An implementation of InjectionTargetFactory that provides container created InjectionTarget instances.
+ An implementation of InjectionTargetFactory that provides container created InjectionTarget instances.
-
getInterceptorBindingDefinition(Class<? extends Annotation>) - Method in interface jakarta.enterprise.inject.spi.BeanManager
+
getInterceptorBindingDefinition(Class<? extends Annotation>) - Method in interface jakarta.enterprise.inject.spi.BeanManager
Obtains the set of meta-annotations for a certain interceptor binding type .
-
getInterceptorBindingHashCode(Annotation) - Method in interface jakarta.enterprise.inject.spi.BeanManager
+
getInterceptorBindingHashCode(Annotation) - Method in interface jakarta.enterprise.inject.spi.BeanManager
Determine the hash code of an interceptor binding, using the JDK algorithm for determining an annotation hash code, - ignoring any members annotated with Nonbinding.
+ ignoring any members annotated with Nonbinding.
-
getInterceptorBindings() - Method in interface jakarta.enterprise.inject.spi.Interceptor
+
getInterceptorBindings() - Method in interface jakarta.enterprise.inject.spi.Interceptor
Obtains the interceptor bindings of the interceptor.
-
getInterceptors() - Method in interface jakarta.enterprise.inject.spi.AfterTypeDiscovery
+
getInterceptors() - Method in interface jakarta.enterprise.inject.spi.AfterTypeDiscovery
 
-
getJavaClass() - Method in interface jakarta.enterprise.inject.spi.AnnotatedType
+
getJavaClass() - Method in interface jakarta.enterprise.inject.spi.AnnotatedType
- Get the underlying Class.
+ Get the underlying Class.
-
getJavaMember() - Method in interface jakarta.enterprise.inject.spi.AnnotatedConstructor
+
getJavaMember() - Method in interface jakarta.enterprise.inject.spi.AnnotatedConstructor
- Get the underlying Constructor.
+ Get the underlying Constructor.
-
getJavaMember() - Method in interface jakarta.enterprise.inject.spi.AnnotatedField
+
getJavaMember() - Method in interface jakarta.enterprise.inject.spi.AnnotatedField
- Get the underlying Field.
+ Get the underlying Field.
-
getJavaMember() - Method in interface jakarta.enterprise.inject.spi.AnnotatedMember
+
getJavaMember() - Method in interface jakarta.enterprise.inject.spi.AnnotatedMember
- Get the underlying Member.
+ Get the underlying Member.
-
getJavaMember() - Method in interface jakarta.enterprise.inject.spi.AnnotatedMethod
+
getJavaMember() - Method in interface jakarta.enterprise.inject.spi.AnnotatedMethod
- Get the underlying Method.
+ Get the underlying Method.
-
getJavaParameter() - Method in interface jakarta.enterprise.inject.spi.AnnotatedParameter
+
getJavaParameter() - Method in interface jakarta.enterprise.inject.spi.AnnotatedParameter
-
Get the underlying Parameter.
+
Get the underlying Parameter.
-
getMember() - Method in interface jakarta.enterprise.inject.spi.InjectionPoint
+
getMember() - Method in interface jakarta.enterprise.inject.spi.InjectionPoint
-
Get the Field object in the case of field injection, the Method - object in the case of method parameter injection or the Constructor object in the case of +
Get the Field object in the case of field injection, the Method + object in the case of method parameter injection or the Constructor object in the case of constructor parameter injection.
-
getMetadata() - Method in interface jakarta.enterprise.inject.spi.EventContext
+
getMetadata() - Method in interface jakarta.enterprise.inject.spi.EventContext
 
-
getMethods() - Method in interface jakarta.enterprise.inject.spi.AnnotatedType
+
getMethods() - Method in interface jakarta.enterprise.inject.spi.AnnotatedType
- Get the methods of the type.
+ Get the methods of the type.
-
getName() - Method in interface jakarta.enterprise.inject.spi.BeanAttributes
+
getName() - Method in interface jakarta.enterprise.inject.spi.BeanAttributes
-
Obtains the EL name of a bean, if it has one.
+
Obtains the EL name of a bean, if it has one.
-
getObservedQualifiers() - Method in interface jakarta.enterprise.inject.spi.ObserverMethod
+
getObservedQualifiers() - Method in interface jakarta.enterprise.inject.spi.ObserverMethod
-
Obtains the set of observed event qualifiers.
+
Obtains the set of observed event qualifiers.
-
getObservedType() - Method in interface jakarta.enterprise.inject.spi.ObserverMethod
+
getObservedType() - Method in interface jakarta.enterprise.inject.spi.ObserverMethod
-
Obtains the observed event type.
+
Obtains the observed event type.
-
getObserverMethod() - Method in interface jakarta.enterprise.inject.spi.ProcessObserverMethod
+
getObserverMethod() - Method in interface jakarta.enterprise.inject.spi.ProcessObserverMethod
-
The ObserverMethod object that will be used by the container to invoke the observer +
The ObserverMethod object that will be used by the container to invoke the observer when a matching event is fired.
-
getParameters() - Method in interface jakarta.enterprise.inject.spi.AnnotatedCallable
+
getParameters() - Method in interface jakarta.enterprise.inject.spi.AnnotatedCallable
Get the parameters of the callable member.
-
getPassivationCapableBean(String) - Method in interface jakarta.enterprise.inject.spi.BeanManager
+
getPassivationCapableBean(String) - Method in interface jakarta.enterprise.inject.spi.BeanManager
-
Returns the PassivationCapable bean with the given identifier.
+
Returns the PassivationCapable bean with the given identifier.
-
getPosition() - Method in interface jakarta.enterprise.inject.spi.AnnotatedParameter
+
getPosition() - Method in interface jakarta.enterprise.inject.spi.AnnotatedParameter
Get the position of the parameter in the method or constructor argument list.
-
getPriority() - Method in interface jakarta.enterprise.inject.spi.CDIProvider
+
getPriority() - Method in interface jakarta.enterprise.inject.spi.CDIProvider
 
-
getPriority() - Method in interface jakarta.enterprise.inject.spi.ObserverMethod
+
getPriority() - Method in interface jakarta.enterprise.inject.spi.ObserverMethod
The priority that will be used by the container to determine the notification order in which event observer methods are invoked.
-
getPriority() - Method in interface jakarta.enterprise.inject.spi.Prioritized
+
getPriority() - Method in interface jakarta.enterprise.inject.spi.Prioritized
Returns the priority for this SPI element.
-
getProducer() - Method in interface jakarta.enterprise.inject.spi.ProcessProducer
+
getProducer() - Method in interface jakarta.enterprise.inject.spi.ProcessProducer
-
Returns the Producer object that will be used by the container to call the producer +
Returns the Producer object that will be used by the container to call the producer method or read the producer field.
-
getProducerFactory(AnnotatedField<? super X>, Bean<X>) - Method in interface jakarta.enterprise.inject.spi.BeanManager
+
getProducerFactory(AnnotatedField<? super X>, Bean<X>) - Method in interface jakarta.enterprise.inject.spi.BeanManager
- An implementation of ProducerFactory that provides container created Producer instances for the given + An implementation of ProducerFactory that provides container created Producer instances for the given field.
-
getProducerFactory(AnnotatedMethod<? super X>, Bean<X>) - Method in interface jakarta.enterprise.inject.spi.BeanManager
+
getProducerFactory(AnnotatedMethod<? super X>, Bean<X>) - Method in interface jakarta.enterprise.inject.spi.BeanManager
- An implementation of ProducerFactory that provides container created Producer instances for the given + An implementation of ProducerFactory that provides container created Producer instances for the given method.
-
getQualifierHashCode(Annotation) - Method in interface jakarta.enterprise.inject.spi.BeanManager
+
getQualifierHashCode(Annotation) - Method in interface jakarta.enterprise.inject.spi.BeanManager
Determine the hash code of a qualifier, using the JDK algorithm for determining an annotation hash code, ignoring any - members annotated with Nonbinding.
+ members annotated with Nonbinding.
-
getQualifiers() - Method in interface jakarta.enterprise.inject.spi.BeanAttributes
+
getQualifiers() - Method in interface jakarta.enterprise.inject.spi.BeanAttributes
Obtains the qualifiers of the bean.
-
getQualifiers() - Method in interface jakarta.enterprise.inject.spi.EventMetadata
+
getQualifiers() - Method in interface jakarta.enterprise.inject.spi.EventMetadata
 
-
getQualifiers() - Method in interface jakarta.enterprise.inject.spi.InjectionPoint
+
getQualifiers() - Method in interface jakarta.enterprise.inject.spi.InjectionPoint
Get the required qualifiers of the injection point.
-
getRawType() - Method in class jakarta.enterprise.util.TypeLiteral
+
getRawType() - Method in class jakarta.enterprise.util.TypeLiteral
 
-
getReception() - Method in interface jakarta.enterprise.inject.spi.ObserverMethod
+
getReception() - Method in interface jakarta.enterprise.inject.spi.ObserverMethod
-
Obtains the specified Reception for the observer method.
+
Obtains the specified Reception for the observer method.
-
getReference(Bean<?>, Type, CreationalContext<?>) - Method in interface jakarta.enterprise.inject.spi.BeanContainer
+
getReference(Bean<?>, Type, CreationalContext<?>) - Method in interface jakarta.enterprise.inject.spi.BeanContainer
- Obtains a contextual reference for a certain bean and a certain bean type of the bean.
+ Obtains a contextual reference for a certain bean and a certain bean type of the bean.
-
getScope() - Method in interface jakarta.enterprise.context.spi.Context
+
getScope() - Method in interface jakarta.enterprise.context.spi.Context
Get the scope type of the context object.
-
getScope() - Method in interface jakarta.enterprise.inject.spi.BeanAttributes
+
getScope() - Method in interface jakarta.enterprise.inject.spi.BeanAttributes
-
Obtains the scope of the bean.
+
Obtains the scope of the bean.
-
getSessionBeanType() - Method in interface jakarta.enterprise.inject.spi.ProcessSessionBean
+
getSessionBeanType() - Method in interface jakarta.enterprise.inject.spi.ProcessSessionBean
-
Returns a SessionBeanType representing the kind of session bean.
+
Returns a SessionBeanType representing the kind of session bean.
-
getSource() - Method in interface jakarta.enterprise.inject.spi.ProcessSyntheticAnnotatedType
+
getSource() - Method in interface jakarta.enterprise.inject.spi.ProcessSyntheticAnnotatedType
-
Get the extension instance which added the AnnotatedType for which this event is being fired.
+
Get the extension instance which added the AnnotatedType for which this event is being fired.
-
getSource() - Method in interface jakarta.enterprise.inject.spi.ProcessSyntheticBean
+
getSource() - Method in interface jakarta.enterprise.inject.spi.ProcessSyntheticBean
-
Get the extension instance which added the Bean for which this event is being fired.
+
Get the extension instance which added the Bean for which this event is being fired.
-
getSource() - Method in interface jakarta.enterprise.inject.spi.ProcessSyntheticObserverMethod
+
getSource() - Method in interface jakarta.enterprise.inject.spi.ProcessSyntheticObserverMethod
-
Get the extension instance which added the ObserverMethod for which this event is being fired.
+
Get the extension instance which added the ObserverMethod for which this event is being fired.
-
getStereotypeDefinition(Class<? extends Annotation>) - Method in interface jakarta.enterprise.inject.spi.BeanManager
+
getStereotypeDefinition(Class<? extends Annotation>) - Method in interface jakarta.enterprise.inject.spi.BeanManager
-
Obtains meta-annotations for a certain stereotype.
+
Obtains meta-annotations for a certain stereotype.
-
getStereotypes() - Method in interface jakarta.enterprise.inject.spi.BeanAttributes
+
getStereotypes() - Method in interface jakarta.enterprise.inject.spi.BeanAttributes
-
Obtains the stereotypes of the bean.
+
Obtains the stereotypes of the bean.
-
getTimeout() - Method in interface jakarta.enterprise.context.Conversation
+
getTimeout() - Method in interface jakarta.enterprise.context.Conversation
Get the timeout of the current conversation.
-
getTransactionPhase() - Method in interface jakarta.enterprise.inject.spi.ObserverMethod
+
getTransactionPhase() - Method in interface jakarta.enterprise.inject.spi.ObserverMethod
-
Obtains the specified TransactionPhase for the observer method.
+
Obtains the specified TransactionPhase for the observer method.
-
getType() - Method in interface jakarta.enterprise.inject.spi.EventMetadata
+
getType() - Method in interface jakarta.enterprise.inject.spi.EventMetadata
Get the type representing runtime class of the event object with type variables resolved.
-
getType() - Method in interface jakarta.enterprise.inject.spi.InjectionPoint
+
getType() - Method in interface jakarta.enterprise.inject.spi.InjectionPoint
Get the required type of injection point.
-
getType() - Method in class jakarta.enterprise.util.TypeLiteral
+
getType() - Method in class jakarta.enterprise.util.TypeLiteral
 
-
getTypeClosure() - Method in interface jakarta.enterprise.inject.spi.Annotated
+
getTypeClosure() - Method in interface jakarta.enterprise.inject.spi.Annotated
Get all types to which the base type should be considered assignable.
-
getTypes() - Method in interface jakarta.enterprise.inject.spi.BeanAttributes
+
getTypes() - Method in interface jakarta.enterprise.inject.spi.BeanAttributes
-
Obtains the bean types of the bean.
+
Obtains the bean types of the bean.
- - - -

H

-
-
handles() - Method in interface jakarta.enterprise.inject.Instance
-
-
Allows iterating over contextual reference handles for all beans that have the required type and required qualifiers and are eligible - for injection.
+

H

+
+
handles() - Method in interface jakarta.enterprise.inject.Instance
+
+
Allows iterating over contextual reference handles for all beans that have the required type and required qualifiers and + are eligible for injection.
-
handlesStream() - Method in interface jakarta.enterprise.inject.Instance
+
handlesStream() - Method in interface jakarta.enterprise.inject.Instance
-
Returns stream of Instance.Handle objects.
+
Returns stream of Instance.Handle objects.
-
hashCode() - Method in class jakarta.enterprise.util.AnnotationLiteral
+
hasAnnotation(Class<? extends Annotation>) - Method in interface jakarta.enterprise.lang.model.AnnotationTarget
+
+
Returns whether an annotation of given type is present on this annotation target.
+
+
hasAnnotation(Predicate<AnnotationInfo>) - Method in interface jakarta.enterprise.lang.model.AnnotationTarget
+
+
Returns whether given predicate matches any annotation present on this annotation target.
+
+
hashCode() - Method in class jakarta.enterprise.util.AnnotationLiteral
 
-
hashCode() - Method in class jakarta.enterprise.util.TypeLiteral
+
hashCode() - Method in class jakarta.enterprise.util.TypeLiteral
 
+
hasMember(String) - Method in interface jakarta.enterprise.lang.model.AnnotationInfo
+
+
Returns whether this annotation has a member with given name.
+
+
hasValue() - Method in interface jakarta.enterprise.lang.model.AnnotationInfo
+
+
Returns whether this annotation has the value member.
+
- - - -

I

-
-
id(String) - Method in interface jakarta.enterprise.inject.spi.configurator.BeanConfigurator
+

I

+
+
id(String) - Method in interface jakarta.enterprise.inject.spi.configurator.BeanConfigurator
-
Make the configured bean implements PassivationCapable and its Id for passivation.
+
Make the configured bean implements PassivationCapable and its Id for passivation.
-
IF_EXISTS - jakarta.enterprise.event.Reception
+
IF_EXISTS - Enum constant in enum class jakarta.enterprise.event.Reception
Specifies that an observer method is only called if the current instance of the bean declaring the observer method already exists.
-
ignoreFinalMethods() - Method in interface jakarta.enterprise.inject.spi.InterceptionFactory
+
ignoreFinalMethods() - Method in interface jakarta.enterprise.inject.spi.InterceptionFactory
Instructs the container to ignore all non-static, final methods with public, protected or default visibility declared by any class in the type hierarchy of the intercepted instance during invocation of - InterceptionFactory.createInterceptedInstance(Object).
+ InterceptionFactory.createInterceptedInstance(Object).
-
ignoreFinalMethods() - Method in interface jakarta.enterprise.inject.spi.ProcessBeanAttributes
+
ignoreFinalMethods() - Method in interface jakarta.enterprise.inject.spi.ProcessBeanAttributes
-
Instructs the container to ignore all non-static, final methods with public, protected or default visibility +
+ Instructs the container to ignore all non-static, final methods with public, protected or default visibility declared on any bean type of the specific bean during validation of injection points that require proxyable bean type.
-
IllegalProductException - Exception in jakarta.enterprise.inject
+
IllegalProductException - Exception Class in jakarta.enterprise.inject
Indicates that a producer method returned a null value or a producer field contained a null value, and the scope of the - producer method or field was not Dependent.
+ producer method or field was not Dependent.
-
IllegalProductException() - Constructor for exception jakarta.enterprise.inject.IllegalProductException
-
 
-
IllegalProductException(String) - Constructor for exception jakarta.enterprise.inject.IllegalProductException
-
 
-
IllegalProductException(String, Throwable) - Constructor for exception jakarta.enterprise.inject.IllegalProductException
-
 
-
IllegalProductException(Throwable) - Constructor for exception jakarta.enterprise.inject.IllegalProductException
-
 
-
IN_PROGRESS - jakarta.enterprise.event.TransactionPhase
+
IllegalProductException() - Constructor for exception class jakarta.enterprise.inject.IllegalProductException
+
+
Creates the exception with no detail message or cause.
+
+
IllegalProductException(String) - Constructor for exception class jakarta.enterprise.inject.IllegalProductException
+
+
Creates the exception with given detail message.
+
+
IllegalProductException(String, Throwable) - Constructor for exception class jakarta.enterprise.inject.IllegalProductException
+
+
Creates the exception with given detail message and cause.
+
+
IllegalProductException(Throwable) - Constructor for exception class jakarta.enterprise.inject.IllegalProductException
+
+
Creates the exception with given cause.
+
+
IN_PROGRESS - Enum constant in enum class jakarta.enterprise.event.TransactionPhase
Identifies a regular observer method, called when the event is fired.
-
info() - Method in interface jakarta.enterprise.inject.build.compatible.spi.ClassConfig
+
info() - Method in interface jakarta.enterprise.inject.build.compatible.spi.ClassConfig
-
Returns the ClassInfo corresponding to this transformed class.
+
Returns the ClassInfo corresponding to this transformed class.
-
info() - Method in interface jakarta.enterprise.inject.build.compatible.spi.DeclarationConfig
+
info() - Method in interface jakarta.enterprise.inject.build.compatible.spi.DeclarationConfig
-
Returns the DeclarationInfo corresponding to this transformed declaration.
+
Returns the DeclarationInfo corresponding to this transformed declaration.
-
info() - Method in interface jakarta.enterprise.inject.build.compatible.spi.FieldConfig
+
info() - Method in interface jakarta.enterprise.inject.build.compatible.spi.FieldConfig
-
Returns the FieldInfo corresponding to this transformed field.
+
Returns the FieldInfo corresponding to this transformed field.
-
info() - Method in interface jakarta.enterprise.inject.build.compatible.spi.MethodConfig
+
info() - Method in interface jakarta.enterprise.inject.build.compatible.spi.MethodConfig
-
Returns the MethodInfo corresponding to this transformed method.
+
Returns the MethodInfo corresponding to this transformed method.
-
info() - Method in interface jakarta.enterprise.inject.build.compatible.spi.ParameterConfig
+
info() - Method in interface jakarta.enterprise.inject.build.compatible.spi.ParameterConfig
-
Returns the ParameterInfo corresponding to this transformed method parameter.
+
Returns the ParameterInfo corresponding to this transformed method parameter.
-
info(String) - Method in interface jakarta.enterprise.inject.build.compatible.spi.Messages
+
info(String) - Method in interface jakarta.enterprise.inject.build.compatible.spi.Messages
Add a generic information message that is not related to any particular element, or that information is not known.
-
info(String, BeanInfo) - Method in interface jakarta.enterprise.inject.build.compatible.spi.Messages
+
info(String, BeanInfo) - Method in interface jakarta.enterprise.inject.build.compatible.spi.Messages
-
Add an information message which is related to given BeanInfo.
+
Add an information message which is related to given BeanInfo.
-
info(String, ObserverInfo) - Method in interface jakarta.enterprise.inject.build.compatible.spi.Messages
+
info(String, ObserverInfo) - Method in interface jakarta.enterprise.inject.build.compatible.spi.Messages
-
Add an information message which is related to given ObserverInfo.
+
Add an information message which is related to given ObserverInfo.
-
info(String, AnnotationTarget) - Method in interface jakarta.enterprise.inject.build.compatible.spi.Messages
+
info(String, AnnotationTarget) - Method in interface jakarta.enterprise.inject.build.compatible.spi.Messages
-
Add an information message which is related to given AnnotationTarget (which is most likely - a DeclarationInfo).
+
Add an information message which is related to given AnnotationTarget (which is most likely + a DeclarationInfo).
-
initialize() - Method in class jakarta.enterprise.inject.se.SeContainerInitializer
+
initialize() - Method in class jakarta.enterprise.inject.se.SeContainerInitializer
Initializes a CDI SeContainerInitializer.
-
Initialized - Annotation Type in jakarta.enterprise.context
+
Initialized - Annotation Interface in jakarta.enterprise.context
An event with this qualifier is fired when a context is initialized, i.e.
-
Initialized.Literal - Class in jakarta.enterprise.context
+
Initialized.Literal - Class in jakarta.enterprise.context
-
Supports inline instantiation of the Initialized qualifier.
+
Supports inline instantiation of the Initialized qualifier.
-
inject() - Method in class jakarta.enterprise.inject.spi.Unmanaged.UnmanagedInstance
+
inject() - Method in class jakarta.enterprise.inject.spi.Unmanaged.UnmanagedInstance
Inject the instance
-
inject(T, CreationalContext<T>) - Method in interface jakarta.enterprise.inject.spi.InjectionTarget
+
inject(T, CreationalContext<T>) - Method in interface jakarta.enterprise.inject.spi.InjectionTarget
Performs dependency injection upon the given object.
-
InjectionException - Exception in jakarta.enterprise.inject
+
InjectionException - Exception Class in jakarta.enterprise.inject
Indicates a problem relating to dependency injection.
-
InjectionException() - Constructor for exception jakarta.enterprise.inject.InjectionException
-
 
-
InjectionException(String) - Constructor for exception jakarta.enterprise.inject.InjectionException
-
 
-
InjectionException(String, Throwable) - Constructor for exception jakarta.enterprise.inject.InjectionException
-
 
-
InjectionException(Throwable) - Constructor for exception jakarta.enterprise.inject.InjectionException
-
 
-
InjectionPoint - Interface in jakarta.enterprise.inject.spi
+
InjectionException() - Constructor for exception class jakarta.enterprise.inject.InjectionException
+
+
Creates the exception with no detail message or cause.
+
+
InjectionException(String) - Constructor for exception class jakarta.enterprise.inject.InjectionException
+
+
Creates the exception with given detail message.
+
+
InjectionException(String, Throwable) - Constructor for exception class jakarta.enterprise.inject.InjectionException
+
+
Creates the exception with given detail message and cause.
+
+
InjectionException(Throwable) - Constructor for exception class jakarta.enterprise.inject.InjectionException
+
+
Creates the exception with given cause.
+
+
InjectionPoint - Interface in jakarta.enterprise.inject.spi
Provides access to metadata about an injection point.
-
InjectionPointConfigurator - Interface in jakarta.enterprise.inject.spi.configurator
+
InjectionPointConfigurator - Interface in jakarta.enterprise.inject.spi.configurator
-
This API is an helper to configure an existing InjectionPoint instance.
+
This API is an helper to configure an existing InjectionPoint instance.
-
InjectionPointInfo - Interface in jakarta.enterprise.inject.build.compatible.spi
+
InjectionPointInfo - Interface in jakarta.enterprise.inject.build.compatible.spi
An injection point defined on some bean.
-
injectionPoints() - Method in interface jakarta.enterprise.inject.build.compatible.spi.BeanInfo
+
injectionPoints() - Method in interface jakarta.enterprise.inject.build.compatible.spi.BeanInfo
-
Returns a collection of this bean's injection points.
+
Returns a collection of this bean's injection points.
-
injectionPoints(InjectionPoint...) - Method in interface jakarta.enterprise.inject.spi.configurator.BeanConfigurator
+
injectionPoints(InjectionPoint...) - Method in interface jakarta.enterprise.inject.spi.configurator.BeanConfigurator
Replace InjectionPoints for the configured bean
-
injectionPoints(Set<InjectionPoint>) - Method in interface jakarta.enterprise.inject.spi.configurator.BeanConfigurator
+
injectionPoints(Set<InjectionPoint>) - Method in interface jakarta.enterprise.inject.spi.configurator.BeanConfigurator
Replace InjectionPoints for the configured bean
-
InjectionTarget<T> - Interface in jakarta.enterprise.inject.spi
+
InjectionTarget<T> - Interface in jakarta.enterprise.inject.spi
- Provides operations for performing dependency injection and lifecycle callbacks on an + Provides operations for performing dependency injection and lifecycle callbacks on an instance of a type.
-
InjectionTargetFactory<T> - Interface in jakarta.enterprise.inject.spi
+
InjectionTargetFactory<T> - Interface in jakarta.enterprise.inject.spi
- An InjectionTargetFactory can create an InjectionTarget for a given bean.
+ An InjectionTargetFactory can create an InjectionTarget for a given bean.
-
InjectLiteral - Class in jakarta.enterprise.inject.literal
+
InjectLiteral - Class in jakarta.enterprise.inject.literal
Supports inline instantiation of the Inject annotation.
-
InjectLiteral() - Constructor for class jakarta.enterprise.inject.literal.InjectLiteral
+
InjectLiteral() - Constructor for class jakarta.enterprise.inject.literal.InjectLiteral
 
-
Instance<T> - Interface in jakarta.enterprise.inject
+
Instance<T> - Interface in jakarta.enterprise.inject
Allows the application to dynamically obtain instances of beans with a specified combination of required type and qualifiers.
-
INSTANCE - Static variable in class jakarta.enterprise.context.ApplicationScoped.Literal
-
 
-
INSTANCE - Static variable in class jakarta.enterprise.context.ConversationScoped.Literal
-
 
-
INSTANCE - Static variable in class jakarta.enterprise.context.Dependent.Literal
-
 
-
INSTANCE - Static variable in class jakarta.enterprise.context.RequestScoped.Literal
-
 
-
INSTANCE - Static variable in class jakarta.enterprise.context.SessionScoped.Literal
-
 
-
INSTANCE - Static variable in class jakarta.enterprise.inject.Alternative.Literal
-
 
-
INSTANCE - Static variable in class jakarta.enterprise.inject.Any.Literal
-
 
-
INSTANCE - Static variable in class jakarta.enterprise.inject.Default.Literal
-
 
-
INSTANCE - Static variable in class jakarta.enterprise.inject.literal.InjectLiteral
-
 
-
INSTANCE - Static variable in class jakarta.enterprise.inject.literal.NamedLiteral
-
 
-
INSTANCE - Static variable in class jakarta.enterprise.inject.literal.QualifierLiteral
-
 
-
INSTANCE - Static variable in class jakarta.enterprise.inject.literal.SingletonLiteral
-
 
-
INSTANCE - Static variable in class jakarta.enterprise.inject.Specializes.Literal
-
 
-
INSTANCE - Static variable in class jakarta.enterprise.inject.TransientReference.Literal
-
 
-
INSTANCE - Static variable in class jakarta.enterprise.inject.Typed.Literal
-
 
-
INSTANCE - Static variable in class jakarta.enterprise.inject.Vetoed.Literal
-
 
-
INSTANCE - Static variable in class jakarta.enterprise.util.Nonbinding.Literal
-
 
-
Instance.Handle<T> - Interface in jakarta.enterprise.inject
+
INSTANCE - Static variable in class jakarta.enterprise.context.ApplicationScoped.Literal
+
+
Default ApplicationScoped literal
+
+
INSTANCE - Static variable in class jakarta.enterprise.context.ConversationScoped.Literal
+
+
Default ConversationScoped literal
+
+
INSTANCE - Static variable in class jakarta.enterprise.context.Dependent.Literal
+
+
Default Dependent literal
+
+
INSTANCE - Static variable in class jakarta.enterprise.context.RequestScoped.Literal
+
+
Default RequestScoped literal
+
+
INSTANCE - Static variable in class jakarta.enterprise.context.SessionScoped.Literal
+
+
Default SessionScoped literal
+
+
INSTANCE - Static variable in class jakarta.enterprise.inject.Alternative.Literal
+
+
Default Alternative literal
+
+
INSTANCE - Static variable in class jakarta.enterprise.inject.Any.Literal
+
+
Default Any literal
+
+
INSTANCE - Static variable in class jakarta.enterprise.inject.Default.Literal
+
+
The default Default literal
+
+
INSTANCE - Static variable in class jakarta.enterprise.inject.literal.InjectLiteral
+
+
Default Inject literal
+
+
INSTANCE - Static variable in class jakarta.enterprise.inject.literal.NamedLiteral
+
+
Default Named literal
+
+
INSTANCE - Static variable in class jakarta.enterprise.inject.literal.QualifierLiteral
+
+
Default Qualifier literal
+
+
INSTANCE - Static variable in class jakarta.enterprise.inject.literal.SingletonLiteral
+
+
Default Singleton literal
+
+
INSTANCE - Static variable in class jakarta.enterprise.inject.Specializes.Literal
+
+
Default Specializes literal
+
+
INSTANCE - Static variable in class jakarta.enterprise.inject.TransientReference.Literal
+
+
Default TransientReference literal
+
+
INSTANCE - Static variable in class jakarta.enterprise.inject.Typed.Literal
+
+
Default Typed literal
+
+
INSTANCE - Static variable in class jakarta.enterprise.inject.Vetoed.Literal
+
+
Default Vetoed literal
+
+
INSTANCE - Static variable in class jakarta.enterprise.util.Nonbinding.Literal
+
+
Default Nonbinding literal
+
+
Instance.Handle<T> - Interface in jakarta.enterprise.inject
This interface represents a contextual reference handle.
-
intercept(InterceptionType, T, InvocationContext) - Method in interface jakarta.enterprise.inject.spi.Interceptor
+
INT - Enum constant in enum class jakarta.enterprise.lang.model.AnnotationMember.Kind
+
+
A primitive int value.
+
+
INT - Enum constant in enum class jakarta.enterprise.lang.model.types.PrimitiveType.PrimitiveKind
+
+
The int primitive type
+
+
intercept(InterceptionType, T, InvocationContext) - Method in interface jakarta.enterprise.inject.spi.Interceptor
- Invokes the specified kind of lifecycle callback or method invocation interception upon the + Invokes the specified kind of lifecycle callback or method invocation interception upon the given interceptor instance.
-
Intercepted - Annotation Type in jakarta.enterprise.inject
+
Intercepted - Annotation Interface in jakarta.enterprise.inject
An interceptor may inject metadata about the bean it is intercepting.
-
InterceptionFactory<T> - Interface in jakarta.enterprise.inject.spi
+
InterceptionFactory<T> - Interface in jakarta.enterprise.inject.spi
-
InterceptionFactory allows to create a wrapper instance whose method invocations are intercepted by method +
InterceptionFactory allows to create a wrapper instance whose method invocations are intercepted by method interceptors and forwarded to a provided instance.
-
InterceptionType - Enum in jakarta.enterprise.inject.spi
+
InterceptionType - Enum Class in jakarta.enterprise.inject.spi
Identifies the kind of lifecycle callback, EJB timeout method or business method interception.
-
Interceptor<T> - Interface in jakarta.enterprise.inject.spi
+
Interceptor<T> - Interface in jakarta.enterprise.inject.spi
Represents an enabled interceptor.
-
interceptorBindings() - Method in interface jakarta.enterprise.inject.build.compatible.spi.InterceptorInfo
+
interceptorBindings() - Method in interface jakarta.enterprise.inject.build.compatible.spi.InterceptorInfo
Returns the set of interceptor binding annotations declared on this interceptor.
-
interceptorBindings() - Method in interface jakarta.enterprise.inject.build.compatible.spi.StereotypeInfo
+
interceptorBindings() - Method in interface jakarta.enterprise.inject.build.compatible.spi.StereotypeInfo
-
Returns the set of interceptor binding annotations defined by this stereotype.
+
Returns the set of interceptor binding annotations defined by this stereotype.
-
InterceptorInfo - Interface in jakarta.enterprise.inject.build.compatible.spi
+
InterceptorInfo - Interface in jakarta.enterprise.inject.build.compatible.spi
Interceptors are managed beans annotated @Interceptor.
-
intercepts(InterceptionType) - Method in interface jakarta.enterprise.inject.build.compatible.spi.InterceptorInfo
+
intercepts(InterceptionType) - Method in interface jakarta.enterprise.inject.build.compatible.spi.InterceptorInfo
Returns whether this interceptor declares an interceptor method for given - interception type.
+ interception type.
-
intercepts(InterceptionType) - Method in interface jakarta.enterprise.inject.spi.Interceptor
+
intercepts(InterceptionType) - Method in interface jakarta.enterprise.inject.spi.Interceptor
-
invoke(T, Object[]) - Method in interface jakarta.enterprise.invoke.Invoker
+
Interfaces representing enabled beans - Search tag in package jakarta.enterprise.inject.spi
+
Section
+
invoke(T, Object[]) - Method in interface jakarta.enterprise.invoke.Invoker
-
Invokes the target method of this invoker on given instance, passing given - arguments.
+
Invokes the target method on the given instance of the target bean, passing + given arguments.
-
Invoker<T,​R> - Interface in jakarta.enterprise.invoke
+
Invoker<T,R> - Interface in jakarta.enterprise.invoke
-
Allows indirectly invoking a method that belongs to a managed bean (the target method).
+
An invoker allows indirect invocation of its target method on an instance of its target + bean.
-
InvokerBuilder<T> - Interface in jakarta.enterprise.invoke
+
InvokerBuilder<T> - Interface in jakarta.enterprise.invoke
-
Builder of Invokers that allows configuring input lookups, input and output - transformations, and invoker wrapping.
+
Builder of Invokers.
-
InvokerInfo - Interface in jakarta.enterprise.inject.build.compatible.spi
+
InvokerFactory - Interface in jakarta.enterprise.inject.build.compatible.spi
-
Opaque token that stands in for an invoker registered using BeanInfo.createInvoker(MethodInfo).
+
Factory for InvokerBuilders.
-
isActive() - Method in interface jakarta.enterprise.context.spi.Context
+
InvokerInfo - Interface in jakarta.enterprise.inject.build.compatible.spi
+
+
Opaque token that stands in for an invoker registered using InvokerFactory.createInvoker(BeanInfo, MethodInfo) + and InvokerBuilder.build().
+
+
isAbstract() - Method in interface jakarta.enterprise.lang.model.declarations.ClassInfo
+
+
Returns whether this class is abstract.
+
+
isAbstract() - Method in interface jakarta.enterprise.lang.model.declarations.MethodInfo
+
+
Returns whether this method is abstract.
+
+
isActive() - Method in interface jakarta.enterprise.context.spi.Context
Determines if the context object is active.
-
isAlternative() - Method in interface jakarta.enterprise.inject.build.compatible.spi.BeanInfo
+
isAlternative() - Method in interface jakarta.enterprise.inject.build.compatible.spi.BeanInfo
-
Returns whether this bean is an alternative.
+
Returns whether this bean is an alternative.
-
isAlternative() - Method in interface jakarta.enterprise.inject.build.compatible.spi.StereotypeInfo
+
isAlternative() - Method in interface jakarta.enterprise.inject.build.compatible.spi.StereotypeInfo
-
Returns whether this stereotype is meta-annotated @Alternative.
+
Returns whether this stereotype is meta-annotated @Alternative.
-
isAlternative() - Method in interface jakarta.enterprise.inject.spi.BeanAttributes
+
isAlternative() - Method in interface jakarta.enterprise.inject.spi.BeanAttributes
-
Determines if the bean is an alternative.
+
Determines if the bean is an alternative.
-
isAmbiguous() - Method in interface jakarta.enterprise.inject.Instance
+
isAmbiguous() - Method in interface jakarta.enterprise.inject.Instance
Determines if there is more than one bean that matches the required type and qualifiers and is eligible for injection into the class into which the parent Instance was injected.
-
isAnnotationPresent(Class<? extends Annotation>) - Method in interface jakarta.enterprise.inject.spi.Annotated
+
isAnnotation() - Method in interface jakarta.enterprise.lang.model.declarations.ClassInfo
+
+
Returns whether this class is an annotation.
+
+
isAnnotationPresent(Class<? extends Annotation>) - Method in interface jakarta.enterprise.inject.spi.Annotated
Determine if the program element has an annotation of a certain annotation type.
-
isAsync() - Method in interface jakarta.enterprise.inject.build.compatible.spi.ObserverInfo
+
isArray() - Method in interface jakarta.enterprise.lang.model.AnnotationMember
+
 
+
isArray() - Method in interface jakarta.enterprise.lang.model.types.Type
+
+
Returns whether this type is an array type.
+
+
isAsync() - Method in interface jakarta.enterprise.inject.build.compatible.spi.ObserverInfo
Returns whether this observer is asynchronous.
-
isAsync() - Method in interface jakarta.enterprise.inject.spi.ObserverMethod
+
isAsync() - Method in interface jakarta.enterprise.inject.spi.ObserverMethod
Determines if this observer method is asynchronous
-
isClassBean() - Method in interface jakarta.enterprise.inject.build.compatible.spi.BeanInfo
+
isBoolean() - Method in interface jakarta.enterprise.lang.model.AnnotationMember
+
 
+
isBoolean() - Method in interface jakarta.enterprise.lang.model.types.PrimitiveType
+
+
Returns whether this primitive type is boolean.
+
+
isByte() - Method in interface jakarta.enterprise.lang.model.AnnotationMember
+
 
+
isByte() - Method in interface jakarta.enterprise.lang.model.types.PrimitiveType
+
+
Returns whether this primitive type is byte.
+
+
isChar() - Method in interface jakarta.enterprise.lang.model.AnnotationMember
+
 
+
isChar() - Method in interface jakarta.enterprise.lang.model.types.PrimitiveType
+
+
Returns whether this primitive type is char.
+
+
isClass() - Method in interface jakarta.enterprise.lang.model.AnnotationMember
+
 
+
isClass() - Method in interface jakarta.enterprise.lang.model.declarations.DeclarationInfo
+
+
Returns whether this declaration is a class.
+
+
isClass() - Method in interface jakarta.enterprise.lang.model.types.Type
+
+
Returns whether this type is a class type.
+
+
isClassBean() - Method in interface jakarta.enterprise.inject.build.compatible.spi.BeanInfo
Returns whether this bean is a managed bean, also known as class-based bean.
-
isDelegate() - Method in interface jakarta.enterprise.inject.spi.InjectionPoint
+
isConstructor() - Method in interface jakarta.enterprise.lang.model.declarations.MethodInfo
+
+
Returns whether this method is, in fact, a constructor.
+
+
isDeclaration() - Method in interface jakarta.enterprise.lang.model.AnnotationTarget
+
+
Returns whether this annotation target is a declaration.
+
+
isDeclaration() - Method in interface jakarta.enterprise.lang.model.declarations.DeclarationInfo
+
 
+
isDeclaration() - Method in interface jakarta.enterprise.lang.model.types.Type
+
 
+
isDelegate() - Method in interface jakarta.enterprise.inject.spi.InjectionPoint
Determines if the injection point is a decorator delegate injection point.
-
isInterceptor() - Method in interface jakarta.enterprise.inject.build.compatible.spi.BeanInfo
+
isDouble() - Method in interface jakarta.enterprise.lang.model.AnnotationMember
+
 
+
isDouble() - Method in interface jakarta.enterprise.lang.model.types.PrimitiveType
+
+
Returns whether this primitive type is double.
+
+
isEnum() - Method in interface jakarta.enterprise.lang.model.AnnotationMember
+
 
+
isEnum() - Method in interface jakarta.enterprise.lang.model.declarations.ClassInfo
+
+
Returns whether this class is an enum.
+
+
isField() - Method in interface jakarta.enterprise.lang.model.declarations.DeclarationInfo
+
+
Returns whether this declaration is a field.
+
+
isFinal() - Method in interface jakarta.enterprise.lang.model.declarations.ClassInfo
+
+
Returns whether this class is final.
+
+
isFinal() - Method in interface jakarta.enterprise.lang.model.declarations.FieldInfo
+
+
Returns whether this field is final.
+
+
isFinal() - Method in interface jakarta.enterprise.lang.model.declarations.MethodInfo
+
+
Returns whether this method is final.
+
+
isFloat() - Method in interface jakarta.enterprise.lang.model.AnnotationMember
+
 
+
isFloat() - Method in interface jakarta.enterprise.lang.model.types.PrimitiveType
+
+
Returns whether this primitive type is float.
+
+
isInt() - Method in interface jakarta.enterprise.lang.model.AnnotationMember
+
 
+
isInt() - Method in interface jakarta.enterprise.lang.model.types.PrimitiveType
+
+
Returns whether this primitive type is int.
+
+
isInterceptor() - Method in interface jakarta.enterprise.inject.build.compatible.spi.BeanInfo
Returns whether this bean is an interceptor.
-
isInterceptor() - Method in interface jakarta.enterprise.inject.build.compatible.spi.InterceptorInfo
+
isInterceptor() - Method in interface jakarta.enterprise.inject.build.compatible.spi.InterceptorInfo
 
-
isInterceptorBinding(Class<? extends Annotation>) - Method in interface jakarta.enterprise.inject.spi.BeanContainer
+
isInterceptorBinding(Class<? extends Annotation>) - Method in interface jakarta.enterprise.inject.spi.BeanContainer
Test the given annotation type to determine if it is an interceptor binding type .
-
isNamed() - Method in interface jakarta.enterprise.inject.build.compatible.spi.StereotypeInfo
+
isInterface() - Method in interface jakarta.enterprise.lang.model.declarations.ClassInfo
+
+
Returns whether this class is an interface.
+
+
isLong() - Method in interface jakarta.enterprise.lang.model.AnnotationMember
+
 
+
isLong() - Method in interface jakarta.enterprise.lang.model.types.PrimitiveType
+
+
Returns whether this primitive type is long.
+
+
isMatchingBean(Set<Type>, Set<Annotation>, Type, Set<Annotation>) - Method in interface jakarta.enterprise.inject.spi.BeanContainer
+
+
Returns true if a bean with given bean types and qualifiers would be assignable + to an injection point with given required type and required qualifiers, false otherwise.
+
+
isMatchingEvent(Type, Set<Annotation>, Type, Set<Annotation>) - Method in interface jakarta.enterprise.inject.spi.BeanContainer
+
+
Returns true if an event with given specified type and specified qualifiers would + match an observer method with given observed event type and observed event qualifiers, + false otherwise.
+
+
isMethod() - Method in interface jakarta.enterprise.lang.model.declarations.DeclarationInfo
+
+
Returns whether this declaration is a method.
+
+
isNamed() - Method in interface jakarta.enterprise.inject.build.compatible.spi.StereotypeInfo
Returns whether this stereotype is meta-annotated @Named.
-
isNormal() - Method in interface jakarta.enterprise.inject.build.compatible.spi.ScopeInfo
+
isNestedAnnotation() - Method in interface jakarta.enterprise.lang.model.AnnotationMember
+
 
+
isNormal() - Method in interface jakarta.enterprise.inject.build.compatible.spi.ScopeInfo
Returns whether this scope type is normal.
-
isNormalScope(Class<? extends Annotation>) - Method in interface jakarta.enterprise.inject.spi.BeanContainer
+
isNormalScope(Class<? extends Annotation>) - Method in interface jakarta.enterprise.inject.spi.BeanContainer
+
+
Test the given annotation type to determine if it is a normal scope type.
+
+
isPackage() - Method in interface jakarta.enterprise.lang.model.declarations.DeclarationInfo
+
+
Returns whether this declaration is a package.
+
+
isParameter() - Method in interface jakarta.enterprise.lang.model.declarations.DeclarationInfo
-
Test the given annotation type to determine if it is a normal scope type.
+
Returns whether this declaration is a method parameter.
-
isPassivatingScope(Class<? extends Annotation>) - Method in interface jakarta.enterprise.inject.spi.BeanManager
+
isParameterizedType() - Method in interface jakarta.enterprise.lang.model.types.Type
-
Test the given annotation type to determine if it is a passivating scope type.
+
Returns whether this type is a parameterized type.
-
isProducerField() - Method in interface jakarta.enterprise.inject.build.compatible.spi.BeanInfo
+
isPassivatingScope(Class<? extends Annotation>) - Method in interface jakarta.enterprise.inject.spi.BeanManager
+
+
Test the given annotation type to determine if it is a passivating scope type.
+
+
isPlainClass() - Method in interface jakarta.enterprise.lang.model.declarations.ClassInfo
+
+
Returns whether this class is a plain class.
+
+
isPrimitive() - Method in interface jakarta.enterprise.lang.model.types.Type
+
+
Returns whether this type is a primitive type.
+
+
isProducerField() - Method in interface jakarta.enterprise.inject.build.compatible.spi.BeanInfo
Returns whether this bean is defined by a producer field.
-
isProducerMethod() - Method in interface jakarta.enterprise.inject.build.compatible.spi.BeanInfo
+
isProducerMethod() - Method in interface jakarta.enterprise.inject.build.compatible.spi.BeanInfo
Returns whether this bean is defined by a producer method.
-
isQualifier(Class<? extends Annotation>) - Method in interface jakarta.enterprise.inject.spi.BeanContainer
+
isQualifier(Class<? extends Annotation>) - Method in interface jakarta.enterprise.inject.spi.BeanContainer
Test the given annotation type to determine if it is a qualifier type.
-
isResolvable() - Method in interface jakarta.enterprise.inject.Instance
+
isRecord() - Method in interface jakarta.enterprise.lang.model.declarations.ClassInfo
+
+
Returns whether this class is a record.
+
+
isRecordComponent() - Method in interface jakarta.enterprise.lang.model.declarations.DeclarationInfo
+
+
Returns whether this declaration is a record component.
+
+
isRepeatable() - Method in interface jakarta.enterprise.lang.model.AnnotationInfo
+
+
Returns whether this annotation is repeatable.
+
+
isResolvable() - Method in interface jakarta.enterprise.inject.Instance
- Determines if there is exactly one bean that matches the required type and qualifiers and is eligible for injection - into the class into which the parent Instance was injected.
+ Determines if there is exactly one bean that matches the required type and qualifiers and is eligible for injection into + the class into which the parent Instance was injected.
-
isRunning() - Method in interface jakarta.enterprise.inject.se.SeContainer
+
isRunning() - Method in interface jakarta.enterprise.inject.se.SeContainer
Check if the container is running or was shut down
-
isScope(Class<? extends Annotation>) - Method in interface jakarta.enterprise.inject.spi.BeanContainer
+
isScope(Class<? extends Annotation>) - Method in interface jakarta.enterprise.inject.spi.BeanContainer
-
Test the given annotation type to determine if it is a scope type.
+
Test the given annotation type to determine if it is a scope type.
-
isStatic() - Method in interface jakarta.enterprise.inject.spi.AnnotatedMember
+
isShort() - Method in interface jakarta.enterprise.lang.model.AnnotationMember
+
 
+
isShort() - Method in interface jakarta.enterprise.lang.model.types.PrimitiveType
+
+
Returns whether this primitive type is short.
+
+
isStatic() - Method in interface jakarta.enterprise.inject.spi.AnnotatedMember
Determines if the member is static.
-
isStereotype(Class<? extends Annotation>) - Method in interface jakarta.enterprise.inject.spi.BeanContainer
+
isStatic() - Method in interface jakarta.enterprise.lang.model.declarations.FieldInfo
+
+
Returns whether this field is static.
+
+
isStatic() - Method in interface jakarta.enterprise.lang.model.declarations.MethodInfo
+
+
Returns whether this method is static.
+
+
isStereotype(Class<? extends Annotation>) - Method in interface jakarta.enterprise.inject.spi.BeanContainer
-
Test the given annotation type to determine if it is a stereotype.
+
Test the given annotation type to determine if it is a stereotype.
-
isSynthetic() - Method in interface jakarta.enterprise.inject.build.compatible.spi.BeanInfo
+
isString() - Method in interface jakarta.enterprise.lang.model.AnnotationMember
+
 
+
isSynthetic() - Method in interface jakarta.enterprise.inject.build.compatible.spi.BeanInfo
Returns whether this bean is synthetic.
-
isSynthetic() - Method in interface jakarta.enterprise.inject.build.compatible.spi.ObserverInfo
+
isSynthetic() - Method in interface jakarta.enterprise.inject.build.compatible.spi.ObserverInfo
Returns whether this observer is synthetic.
-
isTransient() - Method in interface jakarta.enterprise.context.Conversation
+
isTransient() - Method in interface jakarta.enterprise.context.Conversation
Determine if the conversation is marked transient or long-running.
-
isTransient() - Method in interface jakarta.enterprise.inject.spi.InjectionPoint
+
isTransient() - Method in interface jakarta.enterprise.inject.spi.InjectionPoint
Determines if the injection is a transient field.
-
isUnsatisfied() - Method in interface jakarta.enterprise.inject.Instance
+
isType() - Method in interface jakarta.enterprise.lang.model.AnnotationTarget
+
+
Returns whether this annotation target is a type.
+
+
isType() - Method in interface jakarta.enterprise.lang.model.declarations.DeclarationInfo
+
 
+
isType() - Method in interface jakarta.enterprise.lang.model.types.Type
+
 
+
isTypeVariable() - Method in interface jakarta.enterprise.lang.model.types.Type
+
+
Returns whether this type is a type variable.
+
+
isUnsatisfied() - Method in interface jakarta.enterprise.inject.Instance
Determines if there is no bean that matches the required type and qualifiers and is eligible for injection into the class into which the parent Instance was injected.
+
isVoid() - Method in interface jakarta.enterprise.lang.model.types.Type
+
+
Returns whether this type is the void pseudo-type.
+
+
isWildcardType() - Method in interface jakarta.enterprise.lang.model.types.Type
+
+
Returns whether this type is a wildcard type.
+
- - - -

J

-
-
jakarta.cdi - module jakarta.cdi
-
 
-
jakarta.decorator - package jakarta.decorator
+

J

+
+
jakarta.decorator - package jakarta.decorator
-
Annotations relating to decorators.
+
+ Annotations relating to decorators.
-
jakarta.enterprise.context - package jakarta.enterprise.context
+
jakarta.enterprise.context - package jakarta.enterprise.context
-
Annotations and interfaces relating to scopes and contexts.
+
+ Annotations and interfaces relating to scopes and contexts.
-
jakarta.enterprise.context.control - package jakarta.enterprise.context.control
+
jakarta.enterprise.context.control - package jakarta.enterprise.context.control
 
-
jakarta.enterprise.context.spi - package jakarta.enterprise.context.spi
+
jakarta.enterprise.context.spi - package jakarta.enterprise.context.spi
-
The custom context SPI.
+
+ The custom context SPI.
-
jakarta.enterprise.event - package jakarta.enterprise.event
+
jakarta.enterprise.event - package jakarta.enterprise.event
-
Annotations and interfaces relating to events.
+
+ Annotations and interfaces relating to events.
-
jakarta.enterprise.inject - package jakarta.enterprise.inject
+
jakarta.enterprise.inject - package jakarta.enterprise.inject
 
-
jakarta.enterprise.inject.build.compatible.spi - package jakarta.enterprise.inject.build.compatible.spi
+
jakarta.enterprise.inject.build.compatible.spi - package jakarta.enterprise.inject.build.compatible.spi
-
The build compatible extension SPI.
+
+ The build compatible extension SPI.
-
jakarta.enterprise.inject.literal - package jakarta.enterprise.inject.literal
+
jakarta.enterprise.inject.literal - package jakarta.enterprise.inject.literal
 
-
jakarta.enterprise.inject.se - package jakarta.enterprise.inject.se
+
jakarta.enterprise.inject.se - package jakarta.enterprise.inject.se
 
-
jakarta.enterprise.inject.spi - package jakarta.enterprise.inject.spi
+
jakarta.enterprise.inject.spi - package jakarta.enterprise.inject.spi
-
The portable extension integration SPI.
+
+ The portable extension integration SPI.
-
jakarta.enterprise.inject.spi.configurator - package jakarta.enterprise.inject.spi.configurator
+
jakarta.enterprise.inject.spi.configurator - package jakarta.enterprise.inject.spi.configurator
 
-
jakarta.enterprise.invoke - package jakarta.enterprise.invoke
+
jakarta.enterprise.inject.spi.el - package jakarta.enterprise.inject.spi.el
 
-
jakarta.enterprise.util - package jakarta.enterprise.util
+
jakarta.enterprise.invoke - package jakarta.enterprise.invoke
+
 
+
jakarta.enterprise.lang.model - package jakarta.enterprise.lang.model
+
+
The core interfaces of the language model that represent + annotations and + annotation targets.
+
+
jakarta.enterprise.lang.model.declarations - package jakarta.enterprise.lang.model.declarations
+
+
Interfaces that represent declarations.
+
+
jakarta.enterprise.lang.model.types - package jakarta.enterprise.lang.model.types
+
+
Interfaces that represent types.
+
+
jakarta.enterprise.util - package jakarta.enterprise.util
Contains shared, general-purpose helper classes and annotations.
- - - -

L

-
-
Literal() - Constructor for class jakarta.enterprise.context.ApplicationScoped.Literal
+

K

+
+
kind() - Method in interface jakarta.enterprise.lang.model.AnnotationMember
+
+
Returns the kind of this annotation member value.
+
+
kind() - Method in interface jakarta.enterprise.lang.model.declarations.ClassInfo
+
 
+
kind() - Method in interface jakarta.enterprise.lang.model.declarations.DeclarationInfo
+
+
Returns the kind of this declaration.
+
+
kind() - Method in interface jakarta.enterprise.lang.model.declarations.FieldInfo
+
 
+
kind() - Method in interface jakarta.enterprise.lang.model.declarations.MethodInfo
+
 
+
kind() - Method in interface jakarta.enterprise.lang.model.declarations.PackageInfo
+
 
+
kind() - Method in interface jakarta.enterprise.lang.model.declarations.ParameterInfo
+
 
+
kind() - Method in interface jakarta.enterprise.lang.model.declarations.RecordComponentInfo
+
 
+
kind() - Method in interface jakarta.enterprise.lang.model.types.ArrayType
+
 
+
kind() - Method in interface jakarta.enterprise.lang.model.types.ClassType
+
 
+
kind() - Method in interface jakarta.enterprise.lang.model.types.ParameterizedType
+
 
+
kind() - Method in interface jakarta.enterprise.lang.model.types.PrimitiveType
+
 
+
kind() - Method in interface jakarta.enterprise.lang.model.types.Type
+
+
Returns the kind of this type.
+
+
kind() - Method in interface jakarta.enterprise.lang.model.types.TypeVariable
+
 
+
kind() - Method in interface jakarta.enterprise.lang.model.types.VoidType
+
 
+
kind() - Method in interface jakarta.enterprise.lang.model.types.WildcardType
+
 
+
+

L

+
+
Literal() - Constructor for class jakarta.enterprise.context.ApplicationScoped.Literal
 
-
Literal() - Constructor for class jakarta.enterprise.context.ConversationScoped.Literal
+
Literal() - Constructor for class jakarta.enterprise.context.ConversationScoped.Literal
 
-
Literal() - Constructor for class jakarta.enterprise.context.Dependent.Literal
+
Literal() - Constructor for class jakarta.enterprise.context.Dependent.Literal
 
-
Literal() - Constructor for class jakarta.enterprise.context.RequestScoped.Literal
+
Literal() - Constructor for class jakarta.enterprise.context.RequestScoped.Literal
 
-
Literal() - Constructor for class jakarta.enterprise.context.SessionScoped.Literal
+
Literal() - Constructor for class jakarta.enterprise.context.SessionScoped.Literal
 
-
Literal() - Constructor for class jakarta.enterprise.inject.Alternative.Literal
+
Literal() - Constructor for class jakarta.enterprise.inject.Alternative.Literal
 
-
Literal() - Constructor for class jakarta.enterprise.inject.Any.Literal
+
Literal() - Constructor for class jakarta.enterprise.inject.Any.Literal
 
-
Literal() - Constructor for class jakarta.enterprise.inject.Default.Literal
+
Literal() - Constructor for class jakarta.enterprise.inject.Default.Literal
 
-
Literal() - Constructor for class jakarta.enterprise.inject.Specializes.Literal
+
Literal() - Constructor for class jakarta.enterprise.inject.Specializes.Literal
 
-
Literal() - Constructor for class jakarta.enterprise.inject.TransientReference.Literal
+
Literal() - Constructor for class jakarta.enterprise.inject.TransientReference.Literal
 
-
Literal() - Constructor for class jakarta.enterprise.inject.Vetoed.Literal
+
Literal() - Constructor for class jakarta.enterprise.inject.Vetoed.Literal
 
-
Literal() - Constructor for class jakarta.enterprise.util.Nonbinding.Literal
+
Literal() - Constructor for class jakarta.enterprise.util.Nonbinding.Literal
 
+
LONG - Enum constant in enum class jakarta.enterprise.lang.model.AnnotationMember.Kind
+
+
A primitive long value.
+
+
LONG - Enum constant in enum class jakarta.enterprise.lang.model.types.PrimitiveType.PrimitiveKind
+
+
The long primitive type
+
+
Lookups - Search tag in interface jakarta.enterprise.invoke.InvokerBuilder
+
Section
+
lowerBound() - Method in interface jakarta.enterprise.lang.model.types.WildcardType
+
+
Returns the lower bound of this wildcard type.
+
- - - -

M

-
-
member(String, boolean) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
+

M

+
+
member(String) - Method in interface jakarta.enterprise.lang.model.AnnotationInfo
+
+
Returns the value of this annotation's member with given name.
+
+
member(String, boolean) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
Adds a boolean-valued annotation member with given name.
-
member(String, boolean[]) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
+
member(String, boolean[]) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
Adds a boolean array-valued annotation member with given name.
-
member(String, byte) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
+
member(String, byte) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
Adds a byte-valued annotation member with given name.
-
member(String, byte[]) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
+
member(String, byte[]) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
Adds a byte array-valued annotation member with given name.
-
member(String, char) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
+
member(String, char) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
Adds a char-valued annotation member with given name.
-
member(String, char[]) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
+
member(String, char[]) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
Adds a char array-valued annotation member with given name.
-
member(String, double) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
+
member(String, double) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
Adds a double-valued annotation member with given name.
-
member(String, double[]) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
+
member(String, double[]) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
Adds a double array-valued annotation member with given name.
-
member(String, float) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
+
member(String, float) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
Adds a float-valued annotation member with given name.
-
member(String, float[]) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
+
member(String, float[]) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
Adds a float array-valued annotation member with given name.
-
member(String, int) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
+
member(String, int) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
Adds an int-valued annotation member with given name.
-
member(String, int[]) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
+
member(String, int[]) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
Adds an int array-valued annotation member with given name.
-
member(String, long) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
+
member(String, long) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
Adds a long-valued annotation member with given name.
-
member(String, long[]) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
+
member(String, long[]) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
Adds a long array-valued annotation member with given name.
-
member(String, short) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
+
member(String, short) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
Adds a short-valued annotation member with given name.
-
member(String, short[]) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
+
member(String, short[]) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
Adds a short array-valued annotation member with given name.
-
member(String, AnnotationInfo) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
+
member(String, AnnotationInfo) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
Adds an annotation-valued annotation member with given name.
-
member(String, AnnotationInfo[]) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
+
member(String, AnnotationInfo[]) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
Adds an annotation array-valued annotation member with given name.
-
member(String, AnnotationMember) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
+
member(String, AnnotationMember) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
Adds an annotation member with given name, whose value is given value.
-
member(String, ClassInfo) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
+
member(String, ClassInfo) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
Adds a class-valued annotation member with given name.
-
member(String, ClassInfo[]) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
+
member(String, ClassInfo[]) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
Adds a class array-valued annotation member with given name.
-
member(String, ClassInfo, String) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
+
member(String, ClassInfo, String) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
Adds an enum-valued annotation member with given name.
-
member(String, ClassInfo, String[]) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
+
member(String, ClassInfo, String[]) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
Adds an enum array-valued annotation member with given name.
-
member(String, Type) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
+
member(String, Type) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
Adds a class-valued annotation member with given name.
-
member(String, Type[]) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
+
member(String, Type[]) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
Adds a class array-valued annotation member with given name.
-
member(String, Annotation) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
+
member(String, Annotation) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
Adds an annotation-valued annotation member with given name.
-
member(String, Annotation[]) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
+
member(String, Annotation[]) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
Adds an annotation array-valued annotation member with given name.
-
member(String, Class<?>) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
+
member(String, Class<?>) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
Adds a class-valued annotation member with given name.
-
member(String, Class<?>[]) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
+
member(String, Class<?>[]) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
Adds a class array-valued annotation member with given name.
-
member(String, Class<? extends Enum<?>>, String) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
+
member(String, Class<? extends Enum<?>>, String) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
Adds an enum-valued annotation member with given name.
-
member(String, Class<? extends Enum<?>>, String[]) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
+
member(String, Class<? extends Enum<?>>, String[]) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
Adds an enum array-valued annotation member with given name.
-
member(String, Enum<?>) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
+
member(String, Enum<?>) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
Adds an enum-valued annotation member with given name.
-
member(String, Enum<?>[]) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
+
member(String, Enum<?>[]) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
Adds an enum array-valued annotation member with given name.
-
member(String, String) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
+
member(String, String) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
Adds a String-valued annotation member with given name.
-
member(String, String[]) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
+
member(String, String[]) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
Adds a String array-valued annotation member with given name.
-
Messages - Interface in jakarta.enterprise.inject.build.compatible.spi
+
members() - Method in interface jakarta.enterprise.lang.model.AnnotationInfo
+
+
Returns all members of this annotation as a map, where the key is the member name + and the value is the member value.
+
+
Messages - Interface in jakarta.enterprise.inject.build.compatible.spi
-
Allows logging and producing errors during build compatible extension +
Allows logging and producing errors during build compatible extension execution.
-
MetaAnnotations - Interface in jakarta.enterprise.inject.build.compatible.spi
+
MetaAnnotations - Interface in jakarta.enterprise.inject.build.compatible.spi
Allows registering custom CDI meta-annotations: qualifiers, interceptor bindings, stereotypes, and scopes.
-
MethodConfig - Interface in jakarta.enterprise.inject.build.compatible.spi
+
METHOD - Enum constant in enum class jakarta.enterprise.lang.model.declarations.DeclarationInfo.Kind
+
+
Method or constructor
+
+
MethodConfig - Interface in jakarta.enterprise.inject.build.compatible.spi
+
+
Allows adding annotations to and removing annotations from a method.
+
+
MethodInfo - Interface in jakarta.enterprise.lang.model.declarations
+
+
A method or a constructor, declared in some class.
+
+
methods() - Method in interface jakarta.enterprise.inject.build.compatible.spi.ClassConfig
+
+
Returns a collection of MethodConfig objects for each method of this class, + as defined by ClassInfo.methods.
+
+
methods() - Method in interface jakarta.enterprise.inject.spi.configurator.AnnotatedTypeConfigurator
+
 
+
methods() - Method in interface jakarta.enterprise.lang.model.declarations.ClassInfo
+
+
Returns a collection of methods declared or implicitly declared + in this class and all its superclasses up to and excluding java.lang.Object, + as well as all direct and indirect superinterfaces.
+
+
Model - Annotation Interface in jakarta.enterprise.inject
+
+
+ The built-in stereotype intended for use with beans that define the model layer of an MVC web application architecture such + as JSF.
+
+
modifiers() - Method in interface jakarta.enterprise.lang.model.declarations.ClassInfo
+
+
Returns the modifiers of this class as an int.
+
+
modifiers() - Method in interface jakarta.enterprise.lang.model.declarations.FieldInfo
+
+
Returns the modifiers of this field as an int.
+
+
modifiers() - Method in interface jakarta.enterprise.lang.model.declarations.MethodInfo
+
+
Returns the modifiers of this method as an int.
+
+
+

N

+
+
name() - Method in interface jakarta.enterprise.inject.build.compatible.spi.BeanInfo
+
+
Returns the bean name of this bean.
+
+
name() - Method in interface jakarta.enterprise.inject.build.compatible.spi.ScopeInfo
+
+
Binary name of this scope annotation, as defined by The Java™ Language Specification; + in other words, the scope annotation name as returned by Class.getName().
+
+
name() - Method in interface jakarta.enterprise.lang.model.AnnotationInfo
+
+
Binary name of this annotation's type, as defined by The Java™ Language Specification; + in other words, the annotation type name as returned by Class.getName().
+
+
name() - Method in interface jakarta.enterprise.lang.model.declarations.ClassInfo
+
+
Returns the binary name of this class, as defined by The Java™ Language Specification; + in other words, the class name as returned by Class.getName().
+
+
name() - Method in interface jakarta.enterprise.lang.model.declarations.FieldInfo
+
+
Returns the name of this field.
+
+
name() - Method in interface jakarta.enterprise.lang.model.declarations.MethodInfo
+
+
Returns the name of this method.
+
+
name() - Method in interface jakarta.enterprise.lang.model.declarations.PackageInfo
+
+
Returns the fully qualified name of this package, as defined by The Java™ Language Specification; + in other words, the package name as returned by Package.getName().
+
+
name() - Method in interface jakarta.enterprise.lang.model.declarations.ParameterInfo
-
Allows adding annotations to and removing annotations from a method.
+
Returns the name of this parameter, if it is known.
-
methods() - Method in interface jakarta.enterprise.inject.build.compatible.spi.ClassConfig
+
name() - Method in interface jakarta.enterprise.lang.model.declarations.RecordComponentInfo
-
Returns a collection of MethodConfig objects for each method of this class, - as defined by ClassInfo.methods.
+
Returns the name of this record component.
-
methods() - Method in interface jakarta.enterprise.inject.spi.configurator.AnnotatedTypeConfigurator
-
 
-
Model - Annotation Type in jakarta.enterprise.inject
+
name() - Method in interface jakarta.enterprise.lang.model.types.PrimitiveType
-
- The built-in stereotype intended for use with beans that define the model layer of an MVC web application architecture such - as JSF.
+
Returns the name of this primitive type.
-
- - - -

N

-
-
name() - Method in interface jakarta.enterprise.inject.build.compatible.spi.BeanInfo
+
name() - Method in interface jakarta.enterprise.lang.model.types.TypeVariable
-
Returns the bean name of this bean.
+
Returns the name of this type variable.
-
name() - Method in interface jakarta.enterprise.inject.build.compatible.spi.ScopeInfo
+
name() - Method in interface jakarta.enterprise.lang.model.types.VoidType
-
Binary name of this scope annotation, as defined by The Java™ Language Specification; - in other words, the scope annotation name as returned by Class.getName().
+
Returns the name of the void pseudo-type, that is, the string void.
-
name(String) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticBeanBuilder
+
name(String) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticBeanBuilder
Sets the bean name of this synthetic bean.
-
name(String) - Method in interface jakarta.enterprise.inject.spi.configurator.BeanAttributesConfigurator
+
name(String) - Method in interface jakarta.enterprise.inject.spi.configurator.BeanAttributesConfigurator
Set the name of the configured bean
-
name(String) - Method in interface jakarta.enterprise.inject.spi.configurator.BeanConfigurator
+
name(String) - Method in interface jakarta.enterprise.inject.spi.configurator.BeanConfigurator
Set the name of the configured bean
-
NamedLiteral - Class in jakarta.enterprise.inject.literal
+
NamedLiteral - Class in jakarta.enterprise.inject.literal
Supports inline instantiation of the Named qualifier.
-
newInstance() - Static method in class jakarta.enterprise.inject.se.SeContainerInitializer
+
NESTED_ANNOTATION - Enum constant in enum class jakarta.enterprise.lang.model.AnnotationMember.Kind
+
+
A nested Annotation value.
+
+
newInstance() - Static method in class jakarta.enterprise.inject.se.SeContainerInitializer
-
Returns an instance of SeContainerInitializer +
Returns an instance of SeContainerInitializer Each call returns a new instance
-
newInstance() - Method in class jakarta.enterprise.inject.spi.Unmanaged
+
newInstance() - Method in class jakarta.enterprise.inject.spi.Unmanaged
Instantiate a new UnmanagedInstance
-
Nonbinding - Annotation Type in jakarta.enterprise.util
+
Nonbinding - Annotation Interface in jakarta.enterprise.util
Excludes a member of an annotation type (such as a qualifier type or - interceptor binding type) from consideration when the container compares two annotation - instances.
+ interceptor binding type) from consideration when the container compares + two annotation instances.
-
Nonbinding.Literal - Class in jakarta.enterprise.util
+
Nonbinding.Literal - Class in jakarta.enterprise.util
-
Supports inline instantiation of the Nonbinding annotation.
+
Supports inline instantiation of the Nonbinding annotation.
-
NonexistentConversationException - Exception in jakarta.enterprise.context
+
NonexistentConversationException - Exception Class in jakarta.enterprise.context
Indicates that the conversation context could not be restored.
-
NonexistentConversationException() - Constructor for exception jakarta.enterprise.context.NonexistentConversationException
-
 
-
NonexistentConversationException(String) - Constructor for exception jakarta.enterprise.context.NonexistentConversationException
-
 
-
NonexistentConversationException(String, Throwable) - Constructor for exception jakarta.enterprise.context.NonexistentConversationException
-
 
-
NonexistentConversationException(Throwable) - Constructor for exception jakarta.enterprise.context.NonexistentConversationException
-
 
-
NormalScope - Annotation Type in jakarta.enterprise.context
+
NonexistentConversationException() - Constructor for exception class jakarta.enterprise.context.NonexistentConversationException
+
+
Creates the exception with no detail message or cause.
+
+
NonexistentConversationException(String) - Constructor for exception class jakarta.enterprise.context.NonexistentConversationException
+
+
Creates the exception with given detail message.
+
+
NonexistentConversationException(String, Throwable) - Constructor for exception class jakarta.enterprise.context.NonexistentConversationException
+
+
Creates the exception with given detail message and cause.
+
+
NonexistentConversationException(Throwable) - Constructor for exception class jakarta.enterprise.context.NonexistentConversationException
+
+
Creates the exception with given cause.
+
+
NormalScope - Annotation Interface in jakarta.enterprise.context
Specifies that an annotation type is a normal scope type.
-
NotificationOptions - Interface in jakarta.enterprise.event
+
Normal scopes and pseudo-scopes - Search tag in package jakarta.enterprise.context
+
Section
+
NotificationOptions - Interface in jakarta.enterprise.event
Notification options are used to configure observer notification.
-
NotificationOptions.Builder - Interface in jakarta.enterprise.event
+
NotificationOptions.Builder - Interface in jakarta.enterprise.event
Notification options builder.
-
notify(EventContext<T>) - Method in interface jakarta.enterprise.inject.spi.ObserverMethod
+
notify(EventContext<T>) - Method in interface jakarta.enterprise.inject.spi.ObserverMethod
Calls the observer method, passing the given event context.
-
notify(T) - Method in interface jakarta.enterprise.inject.spi.ObserverMethod
+
notify(T) - Method in interface jakarta.enterprise.inject.spi.ObserverMethod
Calls the observer method, passing the given event object.
-
notifyObserver() - Method in annotation type jakarta.enterprise.event.Observes
+
notifyObserver() - Element in annotation interface jakarta.enterprise.event.Observes
+ Specifies under what conditions the observer method is notified.
-
notifyObserver() - Method in annotation type jakarta.enterprise.event.ObservesAsync
+
notifyObserver() - Element in annotation interface jakarta.enterprise.event.ObservesAsync
+ Specifies under what conditions the observer method is notified.
-
notifyWith(ObserverMethodConfigurator.EventConsumer<T>) - Method in interface jakarta.enterprise.inject.spi.configurator.ObserverMethodConfigurator
+
notifyWith(ObserverMethodConfigurator.EventConsumer<T>) - Method in interface jakarta.enterprise.inject.spi.configurator.ObserverMethodConfigurator
Define an operation that accepts a context of a fired event.
- - - -

O

-
-
observe(EventContext<T>, Parameters) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticObserver
+

O

+
+
observe(EventContext<T>, Parameters) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticObserver
Consumes an event.
-
observedType(Type) - Method in interface jakarta.enterprise.inject.spi.configurator.ObserverMethodConfigurator
+
observedType(Type) - Method in interface jakarta.enterprise.inject.spi.configurator.ObserverMethodConfigurator
Set the type of the observed event
-
ObserverException - Exception in jakarta.enterprise.event
+
ObserverException - Exception Class in jakarta.enterprise.event
Indicates that a checked exception was thrown by an observer method during event notification.
-
ObserverException() - Constructor for exception jakarta.enterprise.event.ObserverException
-
 
-
ObserverException(String) - Constructor for exception jakarta.enterprise.event.ObserverException
-
 
-
ObserverException(String, Throwable) - Constructor for exception jakarta.enterprise.event.ObserverException
-
 
-
ObserverException(Throwable) - Constructor for exception jakarta.enterprise.event.ObserverException
-
 
-
ObserverInfo - Interface in jakarta.enterprise.inject.build.compatible.spi
+
ObserverException() - Constructor for exception class jakarta.enterprise.event.ObserverException
+
+
Creates the exception with no detail message or cause.
+
+
ObserverException(String) - Constructor for exception class jakarta.enterprise.event.ObserverException
+
+
Creates the exception with given detail message.
+
+
ObserverException(String, Throwable) - Constructor for exception class jakarta.enterprise.event.ObserverException
+
+
Creates the exception with given detail message and cause.
+
+
ObserverException(Throwable) - Constructor for exception class jakarta.enterprise.event.ObserverException
+
+
Creates the exception with given cause.
+
+
ObserverInfo - Interface in jakarta.enterprise.inject.build.compatible.spi
Observers are: @@ -2756,1582 +3564,1786 @@

O

Observer methods directly correspond to a method declaration in program source code.
-
observerMethod() - Method in interface jakarta.enterprise.inject.build.compatible.spi.ObserverInfo
+
observerMethod() - Method in interface jakarta.enterprise.inject.build.compatible.spi.ObserverInfo
-
Returns the declaration of this observer method.
+
Returns the declaration of this observer method.
-
ObserverMethod<T> - Interface in jakarta.enterprise.inject.spi
+
ObserverMethod<T> - Interface in jakarta.enterprise.inject.spi
-
ObserverMethodConfigurator<T> - Interface in jakarta.enterprise.inject.spi.configurator
+
ObserverMethodConfigurator<T> - Interface in jakarta.enterprise.inject.spi.configurator
+ An ObserverMethodConfigurator can configure an ObserverMethod.
-
ObserverMethodConfigurator.EventConsumer<T> - Interface in jakarta.enterprise.inject.spi.configurator
+
ObserverMethodConfigurator.EventConsumer<T> - Interface in jakarta.enterprise.inject.spi.configurator
Represents an operation that accepts a context of a fired event.
-
Observes - Annotation Type in jakarta.enterprise.event
+
Observer methods - Search tag in package jakarta.enterprise.event
+
Section
+
Observes - Annotation Interface in jakarta.enterprise.event
Identifies the event parameter of an observer method.
-
ObservesAsync - Annotation Type in jakarta.enterprise.event
+
ObservesAsync - Annotation Interface in jakarta.enterprise.event
Identifies the event parameter of an asynchronous observer method.
-
observeWith(Class<? extends SyntheticObserver<T>>) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticObserverBuilder
+
observeWith(Class<? extends SyntheticObserver<T>>) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticObserverBuilder
-
Sets the class of the synthetic observer event notification function.
+
Sets the class of the synthetic observer event notification function.
-
of(ClassInfo) - Static method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
+
of(ClassInfo) - Static method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
-
Returns a new AnnotationBuilder that builds an annotation of given type.
+
Returns a new AnnotationBuilder that builds an annotation of given type.
-
of(Class<?>) - Method in interface jakarta.enterprise.inject.build.compatible.spi.Types
+
of(Class<?>) - Method in interface jakarta.enterprise.inject.build.compatible.spi.Types
Returns a type from given class literal.
-
of(Class<?>[]) - Static method in class jakarta.enterprise.inject.Typed.Literal
-
 
-
of(Class<? extends Annotation>) - Static method in class jakarta.enterprise.context.BeforeDestroyed.Literal
-
 
-
of(Class<? extends Annotation>) - Static method in class jakarta.enterprise.context.Destroyed.Literal
-
 
-
of(Class<? extends Annotation>) - Static method in class jakarta.enterprise.context.Initialized.Literal
-
 
-
of(Class<? extends Annotation>) - Static method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
+
of(Class<?>[]) - Static method in class jakarta.enterprise.inject.Typed.Literal
-
Returns a new AnnotationBuilder that builds an annotation of given type.
+
Obtain the Typed literal for the provided bean types
-
of(String) - Static method in class jakarta.enterprise.inject.literal.NamedLiteral
-
 
-
of(String, Object) - Static method in interface jakarta.enterprise.event.NotificationOptions
+
of(Class<? extends Annotation>) - Static method in class jakarta.enterprise.context.BeforeDestroyed.Literal
+
+
Obtain the literal for the provided scope annotation
+
+
of(Class<? extends Annotation>) - Static method in class jakarta.enterprise.context.Destroyed.Literal
+
+
Obtain the literal of the provided scope annotation
+
+
of(Class<? extends Annotation>) - Static method in class jakarta.enterprise.context.Initialized.Literal
+
+
Obtain the literal of the provided scope annotation
+
+
of(Class<? extends Annotation>) - Static method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
+
+
Returns a new AnnotationBuilder that builds an annotation of given type.
+
+
of(String) - Static method in class jakarta.enterprise.inject.literal.NamedLiteral
+
+
Create a new NamedLiteral for the given name value
+
+
of(String, Object) - Static method in interface jakarta.enterprise.event.NotificationOptions
 
-
ofArray(Type, int) - Method in interface jakarta.enterprise.inject.build.compatible.spi.Types
+
ofArray(Type, int) - Method in interface jakarta.enterprise.inject.build.compatible.spi.Types
-
Returns an ArrayType for the given element type and number of dimensions.
+
Returns an ArrayType for the given element type and number of dimensions.
-
ofClass(ClassInfo) - Method in interface jakarta.enterprise.inject.build.compatible.spi.Types
+
ofClass(ClassInfo) - Method in interface jakarta.enterprise.inject.build.compatible.spi.Types
-
Returns a ClassType for the given class declaration.
+
Returns a ClassType for the given class declaration.
-
ofClass(String) - Method in interface jakarta.enterprise.inject.build.compatible.spi.Types
+
ofClass(String) - Method in interface jakarta.enterprise.inject.build.compatible.spi.Types
-
Returns a ClassType for the given binary name, as defined by The Java™ Language Specification; - in other words, the class name as returned by Class.getName().
+
Returns a ClassType for the given binary name, as defined by The Java™ Language Specification; + in other words, the class name as returned by Class.getName().
-
ofExecutor(Executor) - Static method in interface jakarta.enterprise.event.NotificationOptions
+
ofExecutor(Executor) - Static method in interface jakarta.enterprise.event.NotificationOptions
 
-
ofPrimitive(PrimitiveType.PrimitiveKind) - Method in interface jakarta.enterprise.inject.build.compatible.spi.Types
+
ofPrimitive(PrimitiveType.PrimitiveKind) - Method in interface jakarta.enterprise.inject.build.compatible.spi.Types
-
Returns a PrimitiveType for the given kind of primitive type.
+
Returns a PrimitiveType for the given kind of primitive type.
-
ofVoid() - Method in interface jakarta.enterprise.inject.build.compatible.spi.Types
+
ofVoid() - Method in interface jakarta.enterprise.inject.build.compatible.spi.Types
-
Returns a VoidType, representing the void pseudo-type.
+
Returns a VoidType, representing the void pseudo-type.
- - - -

P

-
-
ParameterConfig - Interface in jakarta.enterprise.inject.build.compatible.spi
+

P

+
+
PACKAGE - Enum constant in enum class jakarta.enterprise.lang.model.declarations.DeclarationInfo.Kind
+
+
Package
+
+
packageInfo() - Method in interface jakarta.enterprise.lang.model.declarations.ClassInfo
+
+
Returns the package this class is part of.
+
+
PackageInfo - Interface in jakarta.enterprise.lang.model.declarations
+
+
A package, possibly annotated in package-info.java.
+
+
PARAMETER - Enum constant in enum class jakarta.enterprise.lang.model.declarations.DeclarationInfo.Kind
+
+
Method parameter or constructor parameter
+
+
ParameterConfig - Interface in jakarta.enterprise.inject.build.compatible.spi
Allows adding annotations to and removing annotations from a method parameter.
-
parameterized(ClassType, Type...) - Method in interface jakarta.enterprise.inject.build.compatible.spi.Types
+
ParameterInfo - Interface in jakarta.enterprise.lang.model.declarations
+
+
A method parameter or a constructor parameter, declared in some method + or constructor.
+
+
parameterized(ClassType, Type...) - Method in interface jakarta.enterprise.inject.build.compatible.spi.Types
+
+
Returns a ParameterizedType for the given generic type and type arguments.
+
+
parameterized(Class<?>, Type...) - Method in interface jakarta.enterprise.inject.build.compatible.spi.Types
+
+
Returns a ParameterizedType for the given generic type and type arguments.
+
+
parameterized(Class<?>, Class<?>...) - Method in interface jakarta.enterprise.inject.build.compatible.spi.Types
-
Returns a ParameterizedType for the given generic type and type arguments.
+
Returns a ParameterizedType for the given generic type and type arguments.
-
parameterized(Class<?>, Type...) - Method in interface jakarta.enterprise.inject.build.compatible.spi.Types
+
PARAMETERIZED_TYPE - Enum constant in enum class jakarta.enterprise.lang.model.types.Type.Kind
-
Returns a ParameterizedType for the given generic type and type arguments.
+
A parameterized type, e.g.
-
parameterized(Class<?>, Class<?>...) - Method in interface jakarta.enterprise.inject.build.compatible.spi.Types
+
ParameterizedType - Interface in jakarta.enterprise.lang.model.types
-
Returns a ParameterizedType for the given generic type and type arguments.
+
A parameterized type.
-
parameters() - Method in interface jakarta.enterprise.inject.build.compatible.spi.MethodConfig
+
parameters() - Method in interface jakarta.enterprise.inject.build.compatible.spi.MethodConfig
-
Returns a list of ParameterConfig objects for each parameter of this method.
+
Returns a list of ParameterConfig objects for each parameter of this method.
-
Parameters - Interface in jakarta.enterprise.inject.build.compatible.spi
+
parameters() - Method in interface jakarta.enterprise.lang.model.declarations.MethodInfo
+
+
Returns a list of parameters declared or implicitly declared on this method.
+
+
Parameters - Interface in jakarta.enterprise.inject.build.compatible.spi
A String-keyed parameter map.
-
params() - Method in interface jakarta.enterprise.inject.spi.configurator.AnnotatedConstructorConfigurator
+
params() - Method in interface jakarta.enterprise.inject.spi.configurator.AnnotatedConstructorConfigurator
 
-
params() - Method in interface jakarta.enterprise.inject.spi.configurator.AnnotatedMethodConfigurator
+
params() - Method in interface jakarta.enterprise.inject.spi.configurator.AnnotatedMethodConfigurator
 
-
passivating() - Method in annotation type jakarta.enterprise.context.NormalScope
+
passivating() - Element in annotation interface jakarta.enterprise.context.NormalScope
Determines whether the normal scope type is a passivating scope.
-
PassivationCapable - Interface in jakarta.enterprise.inject.spi
+
PassivationCapable - Interface in jakarta.enterprise.inject.spi
-
Indicates that a custom implementation of Bean or - Contextual is passivation capable.
+
Indicates that a custom implementation of Bean or + Contextual is passivation capable.
-
POST_ACTIVATE - jakarta.enterprise.inject.spi.InterceptionType
+
POST_ACTIVATE - Enum constant in enum class jakarta.enterprise.inject.spi.InterceptionType
Intercepts bean activation, only called for EJBs
-
POST_CONSTRUCT - jakarta.enterprise.inject.spi.InterceptionType
+
POST_CONSTRUCT - Enum constant in enum class jakarta.enterprise.inject.spi.InterceptionType
Intercepts bean construction
-
postConstruct() - Method in class jakarta.enterprise.inject.spi.Unmanaged.UnmanagedInstance
+
postConstruct() - Method in class jakarta.enterprise.inject.spi.Unmanaged.UnmanagedInstance
Call the @PostConstruct callback
-
postConstruct(T) - Method in interface jakarta.enterprise.inject.spi.InjectionTarget
+
postConstruct(T) - Method in interface jakarta.enterprise.inject.spi.InjectionTarget
- Calls the PostConstruct callback, if it exists, according to the semantics required by the Java - EE platform specification.
+ Calls the PostConstruct callback, if it exists, according to the semantics required by the + Java EE platform specification.
-
PRE_DESTROY - jakarta.enterprise.inject.spi.InterceptionType
+
PRE_DESTROY - Enum constant in enum class jakarta.enterprise.inject.spi.InterceptionType
Intercepts bean destruction
-
PRE_PASSIVATE - jakarta.enterprise.inject.spi.InterceptionType
+
PRE_PASSIVATE - Enum constant in enum class jakarta.enterprise.inject.spi.InterceptionType
Intercepts bean passivation, only called for EJBs
-
preDestroy() - Method in class jakarta.enterprise.inject.spi.Unmanaged.UnmanagedInstance
+
preDestroy() - Method in class jakarta.enterprise.inject.spi.Unmanaged.UnmanagedInstance
Call the @PreDestroy callback
-
preDestroy(T) - Method in interface jakarta.enterprise.inject.spi.InjectionTarget
+
preDestroy(T) - Method in interface jakarta.enterprise.inject.spi.InjectionTarget
- Calls the PreDestroy callback, if it exists, according to the semantics required by the Java EE - platform specification.
+ Calls the PreDestroy callback, if it exists, according to the semantics required by the Java + EE platform specification. +
+
PRIMITIVE - Enum constant in enum class jakarta.enterprise.lang.model.types.Type.Kind
+
+
A primitive type, e.g.
+
+
primitiveKind() - Method in interface jakarta.enterprise.lang.model.types.PrimitiveType
+
+
Returns the kind of this primitive type.
-
Prioritized - Interface in jakarta.enterprise.inject.spi
+
PrimitiveType - Interface in jakarta.enterprise.lang.model.types
+
+
Primitive types are: + + + boolean + byte + short + int + long + float + double + char +
+
+
PrimitiveType.PrimitiveKind - Enum Class in jakarta.enterprise.lang.model.types
+
+
The primitive type kind: boolean, byte, short, int, long, float, double, char
+
+
Prioritized - Interface in jakarta.enterprise.inject.spi
This interface allows some SPI implementation to change their priority programmatically.
-
priority() - Method in interface jakarta.enterprise.inject.build.compatible.spi.BeanInfo
+
priority() - Method in interface jakarta.enterprise.inject.build.compatible.spi.BeanInfo
Returns the priority declared on this bean, or null if this bean does not declare a priority.
-
priority() - Method in interface jakarta.enterprise.inject.build.compatible.spi.ObserverInfo
+
priority() - Method in interface jakarta.enterprise.inject.build.compatible.spi.ObserverInfo
Returns the priority of this observer.
-
priority() - Method in interface jakarta.enterprise.inject.build.compatible.spi.StereotypeInfo
+
priority() - Method in interface jakarta.enterprise.inject.build.compatible.spi.StereotypeInfo
Returns the priority value this stereotype declares using the @Priority meta-annotation.
-
priority(int) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticBeanBuilder
+
priority(int) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticBeanBuilder
Sets a priority of this synthetic bean.
-
priority(int) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticObserverBuilder
+
priority(int) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticObserverBuilder
Sets a priority of this synthetic observer.
-
priority(int) - Method in interface jakarta.enterprise.inject.spi.configurator.BeanConfigurator
+
priority(int) - Method in interface jakarta.enterprise.inject.spi.configurator.BeanConfigurator
Set the priority of the configured bean.
-
priority(int) - Method in interface jakarta.enterprise.inject.spi.configurator.ObserverMethodConfigurator
+
priority(int) - Method in interface jakarta.enterprise.inject.spi.configurator.ObserverMethodConfigurator
Set the priority for the observer to build
-
ProcessAnnotatedType<X> - Interface in jakarta.enterprise.inject.spi
+
ProcessAnnotatedType<X> - Interface in jakarta.enterprise.inject.spi
The container fires an event of this type for each Java class or interface it discovers in a bean archive, before it reads the declared annotations.
-
ProcessBean<X> - Interface in jakarta.enterprise.inject.spi
+
ProcessBean<X> - Interface in jakarta.enterprise.inject.spi
The container fires an event of this type for each enabled bean, interceptor or decorator deployed in a bean archive, before - registering the Bean object.
+ registering the Bean object.
-
ProcessBeanAttributes<T> - Interface in jakarta.enterprise.inject.spi
+
ProcessBeanAttributes<T> - Interface in jakarta.enterprise.inject.spi
The container fires an event of this type for each enabled bean, interceptor or decorator deployed in a bean archive before - registering the Bean object.
+ registering the Bean object.
-
ProcessInjectionPoint<T,​X> - Interface in jakarta.enterprise.inject.spi
+
ProcessInjectionPoint<T,X> - Interface in jakarta.enterprise.inject.spi
The container fires an event of this type for every injection point of every Java EE component class supporting injection - that may be instantiated by the container at runtime, including every managed bean declared using - jakarta.annotation.ManagedBean, EJB session or message-driven bean, enabled bean, enabled interceptor or enabled - decorator.
+ that may be instantiated by the container at runtime, including every EJB session or message-driven bean, enabled + bean, enabled interceptor or enabled decorator.
-
ProcessInjectionTarget<X> - Interface in jakarta.enterprise.inject.spi
+
ProcessInjectionTarget<X> - Interface in jakarta.enterprise.inject.spi
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 jakarta.annotation.ManagedBean, EJB session or - message-driven bean, enabled bean, enabled interceptor or enabled decorator.
+ the container at runtime, including EJB session or message-driven bean, enabled bean, enabled interceptor or + enabled decorator.
-
ProcessManagedBean<X> - Interface in jakarta.enterprise.inject.spi
+
ProcessManagedBean<X> - Interface in jakarta.enterprise.inject.spi
The container fires an event of this type for each enabled managed bean, before registering the - Bean object.
+ Bean object.
-
ProcessObserverMethod<T,​X> - Interface in jakarta.enterprise.inject.spi
+
ProcessObserverMethod<T,X> - Interface in jakarta.enterprise.inject.spi
- The container fires an event of this type for each observer method of each - enabled bean, before registering the ObserverMethod object.
+ The container fires an event of this type for each observer method of each + enabled bean, before registering the ObserverMethod object.
-
ProcessProducer<T,​X> - Interface in jakarta.enterprise.inject.spi
+
ProcessProducer<T,X> - Interface in jakarta.enterprise.inject.spi
- The container fires an event of this type for each producer method or field of + The container fires an event of this type for each producer method or field of each enabled bean, including resources.
-
ProcessProducerField<T,​X> - Interface in jakarta.enterprise.inject.spi
+
ProcessProducerField<T,X> - Interface in jakarta.enterprise.inject.spi
The container fires an event of this type for each enabled producer field, before registering the - Bean object.
+ Bean object.
-
ProcessProducerMethod<T,​X> - Interface in jakarta.enterprise.inject.spi
+
ProcessProducerMethod<T,X> - Interface in jakarta.enterprise.inject.spi
The container fires an event of this type for each enabled producer method, before registering the - Bean object.
+ Bean object.
-
ProcessSessionBean<X> - Interface in jakarta.enterprise.inject.spi
+
ProcessSessionBean<X> - Interface in jakarta.enterprise.inject.spi
The container fires an event of this type for each enabled session bean, before registering the - Bean object.
+ Bean object.
-
ProcessSyntheticAnnotatedType<X> - Interface in jakarta.enterprise.inject.spi
+
ProcessSyntheticAnnotatedType<X> - Interface in jakarta.enterprise.inject.spi
The container fires an event of this type for each Java class or interface added by - BeforeBeanDiscovery.addAnnotatedType(AnnotatedType, String) or - AfterTypeDiscovery.addAnnotatedType(AnnotatedType, String)
+ BeforeBeanDiscovery.addAnnotatedType(AnnotatedType, String) or + AfterTypeDiscovery.addAnnotatedType(AnnotatedType, String)
-
ProcessSyntheticBean<X> - Interface in jakarta.enterprise.inject.spi
+
ProcessSyntheticBean<X> - Interface in jakarta.enterprise.inject.spi
The container fires an event of this type for each custom bean implementation added through - AfterBeanDiscovery.addBean() or AfterBeanDiscovery.addBean(Bean), before registering the - Bean object.
+ AfterBeanDiscovery.addBean() or AfterBeanDiscovery.addBean(Bean), before registering the + Bean object.
-
ProcessSyntheticObserverMethod<T,​X> - Interface in jakarta.enterprise.inject.spi
+
ProcessSyntheticObserverMethod<T,X> - Interface in jakarta.enterprise.inject.spi
- The container fires an event of this type for each custom implementation of ObserverMethod added through - AfterBeanDiscovery.addObserverMethod(ObserverMethod) or AfterBeanDiscovery.addObserverMethod(), before - registering the ObserverMethod object.
+ The container fires an event of this type for each custom implementation of ObserverMethod added through + AfterBeanDiscovery.addObserverMethod(ObserverMethod) or AfterBeanDiscovery.addObserverMethod(), before + registering the ObserverMethod object.
-
produce() - Method in class jakarta.enterprise.inject.spi.Unmanaged.UnmanagedInstance
+
produce() - Method in class jakarta.enterprise.inject.spi.Unmanaged.UnmanagedInstance
Create the instance
-
produce(CreationalContext<T>) - Method in interface jakarta.enterprise.inject.spi.Producer
+
produce(CreationalContext<T>) - Method in interface jakarta.enterprise.inject.spi.Producer
Causes an instance to be produced via the Producer.
-
Producer<T> - Interface in jakarta.enterprise.inject.spi
+
Producer<T> - Interface in jakarta.enterprise.inject.spi
Provides a generic operation for producing an instance of a type.
-
ProducerConfigurator<T> - Interface in jakarta.enterprise.inject.spi.configurator
+
Producer and InjectionTarget - Search tag in package jakarta.enterprise.inject.spi
+
Section
+
ProducerConfigurator<T> - Interface in jakarta.enterprise.inject.spi.configurator
- A ProducerConfigurator can configure a Producer.
+ A ProducerConfigurator can configure a Producer.
-
ProducerFactory<X> - Interface in jakarta.enterprise.inject.spi
+
ProducerFactory<X> - Interface in jakarta.enterprise.inject.spi
- An ProducerFactory can create an Producer for a given bean.
+ An ProducerFactory can create an Producer for a given bean.
-
producerField() - Method in interface jakarta.enterprise.inject.build.compatible.spi.BeanInfo
+
producerField() - Method in interface jakarta.enterprise.inject.build.compatible.spi.BeanInfo
-
Returns the producer field that defines this bean.
+
Returns the producer field that defines this bean.
-
producerMethod() - Method in interface jakarta.enterprise.inject.build.compatible.spi.BeanInfo
+
producerMethod() - Method in interface jakarta.enterprise.inject.build.compatible.spi.BeanInfo
-
Returns the producer method that defines this bean.
+
Returns the producer method that defines this bean.
-
Produces - Annotation Type in jakarta.enterprise.inject
+
Produces - Annotation Interface in jakarta.enterprise.inject
Identifies a producer method or field.
-
produceWith(Function<CreationalContext<U>, U>) - Method in interface jakarta.enterprise.inject.spi.configurator.ProducerConfigurator
+
produceWith(Function<CreationalContext<U>, U>) - Method in interface jakarta.enterprise.inject.spi.configurator.ProducerConfigurator
Set a callback to produce a new instance.
-
produceWith(Function<Instance<Object>, U>) - Method in interface jakarta.enterprise.inject.spi.configurator.BeanConfigurator
+
produceWith(Function<Instance<Object>, U>) - Method in interface jakarta.enterprise.inject.spi.configurator.BeanConfigurator
Set a callback to create a bean instance.
-
push(T) - Method in interface jakarta.enterprise.context.spi.CreationalContext
+
push(T) - Method in interface jakarta.enterprise.context.spi.CreationalContext
Registers an incompletely initialized contextual instance the with the container.
- - - -

Q

-
-
qualifier(AnnotationInfo) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticBeanBuilder
+

Q

+
+
qualifier(AnnotationInfo) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticBeanBuilder
Adds given annotation to the set of qualifiers of this synthetic bean.
-
qualifier(AnnotationInfo) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticObserverBuilder
+
qualifier(AnnotationInfo) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticObserverBuilder
Adds given annotation to the set of qualifiers of this synthetic observer.
-
qualifier(Annotation) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticBeanBuilder
+
qualifier(Annotation) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticBeanBuilder
Adds given annotation to the set of qualifiers of this synthetic bean.
-
qualifier(Annotation) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticObserverBuilder
+
qualifier(Annotation) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticObserverBuilder
Adds given annotation to the set of qualifiers of this synthetic observer.
-
qualifier(Class<? extends Annotation>) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticBeanBuilder
+
qualifier(Class<? extends Annotation>) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticBeanBuilder
Adds a marker annotation of given type to the set of qualifiers of this synthetic bean.
-
qualifier(Class<? extends Annotation>) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticObserverBuilder
+
qualifier(Class<? extends Annotation>) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticObserverBuilder
Adds a marker annotation of given type to the set of qualifiers of this synthetic observer.
-
QualifierLiteral - Class in jakarta.enterprise.inject.literal
+
QualifierLiteral - Class in jakarta.enterprise.inject.literal
Supports inline instantiation of the Qualifier annotation.
-
QualifierLiteral() - Constructor for class jakarta.enterprise.inject.literal.QualifierLiteral
+
QualifierLiteral() - Constructor for class jakarta.enterprise.inject.literal.QualifierLiteral
 
-
qualifiers() - Method in interface jakarta.enterprise.inject.build.compatible.spi.BeanInfo
+
qualifiers() - Method in interface jakarta.enterprise.inject.build.compatible.spi.BeanInfo
-
Returns a collection of this bean's qualifiers, represented as AnnotationInfo.
+
Returns a collection of this bean's qualifiers, represented as AnnotationInfo.
-
qualifiers() - Method in interface jakarta.enterprise.inject.build.compatible.spi.InjectionPointInfo
+
qualifiers() - Method in interface jakarta.enterprise.inject.build.compatible.spi.InjectionPointInfo
-
Returns a collection of qualifiers declared on this injection point, represented as AnnotationInfo.
+
Returns a collection of qualifiers declared on this injection point, represented as AnnotationInfo.
-
qualifiers() - Method in interface jakarta.enterprise.inject.build.compatible.spi.ObserverInfo
+
qualifiers() - Method in interface jakarta.enterprise.inject.build.compatible.spi.ObserverInfo
-
Returns a collection of observed event qualifiers, represented as AnnotationInfo.
+
Returns a collection of observed event qualifiers, represented as AnnotationInfo.
-
qualifiers(Annotation...) - Method in interface jakarta.enterprise.inject.spi.configurator.BeanAttributesConfigurator
+
qualifiers(Annotation...) - Method in interface jakarta.enterprise.inject.spi.configurator.BeanAttributesConfigurator
Replace all qualifiers.
-
qualifiers(Annotation...) - Method in interface jakarta.enterprise.inject.spi.configurator.BeanConfigurator
+
qualifiers(Annotation...) - Method in interface jakarta.enterprise.inject.spi.configurator.BeanConfigurator
Replace all qualifiers.
-
qualifiers(Annotation...) - Method in interface jakarta.enterprise.inject.spi.configurator.InjectionPointConfigurator
+
qualifiers(Annotation...) - Method in interface jakarta.enterprise.inject.spi.configurator.InjectionPointConfigurator
Replace all qualifiers.
-
qualifiers(Annotation...) - Method in interface jakarta.enterprise.inject.spi.configurator.ObserverMethodConfigurator
+
qualifiers(Annotation...) - Method in interface jakarta.enterprise.inject.spi.configurator.ObserverMethodConfigurator
Replace all qualifiers on the Observed event.
-
qualifiers(Set<Annotation>) - Method in interface jakarta.enterprise.inject.spi.configurator.BeanAttributesConfigurator
+
qualifiers(Set<Annotation>) - Method in interface jakarta.enterprise.inject.spi.configurator.BeanAttributesConfigurator
Replace all qualifiers.
-
qualifiers(Set<Annotation>) - Method in interface jakarta.enterprise.inject.spi.configurator.BeanConfigurator
+
qualifiers(Set<Annotation>) - Method in interface jakarta.enterprise.inject.spi.configurator.BeanConfigurator
Replace all qualifiers.
-
qualifiers(Set<Annotation>) - Method in interface jakarta.enterprise.inject.spi.configurator.InjectionPointConfigurator
+
qualifiers(Set<Annotation>) - Method in interface jakarta.enterprise.inject.spi.configurator.InjectionPointConfigurator
Replace all qualifiers.
-
qualifiers(Set<Annotation>) - Method in interface jakarta.enterprise.inject.spi.configurator.ObserverMethodConfigurator
+
qualifiers(Set<Annotation>) - Method in interface jakarta.enterprise.inject.spi.configurator.ObserverMethodConfigurator
Replace all qualifiers on the Observed event.
- - - -

R

-
-
read(AnnotatedMethod<?>) - Method in interface jakarta.enterprise.inject.spi.configurator.ObserverMethodConfigurator
+

R

+
+
read(AnnotatedMethod<?>) - Method in interface jakarta.enterprise.inject.spi.configurator.ObserverMethodConfigurator
-
Read observer meta data from a existing AnnotatedMethod
+
Read observer meta data from a existing AnnotatedMethod
-
read(AnnotatedType<U>) - Method in interface jakarta.enterprise.inject.spi.configurator.BeanConfigurator
+
read(AnnotatedType<U>) - Method in interface jakarta.enterprise.inject.spi.configurator.BeanConfigurator
Read the information from the given annotated type.
-
read(BeanAttributes<?>) - Method in interface jakarta.enterprise.inject.spi.configurator.BeanConfigurator
+
read(BeanAttributes<?>) - Method in interface jakarta.enterprise.inject.spi.configurator.BeanConfigurator
Read the information from the given bean attributes.
-
read(ObserverMethod<T>) - Method in interface jakarta.enterprise.inject.spi.configurator.ObserverMethodConfigurator
+
read(ObserverMethod<T>) - Method in interface jakarta.enterprise.inject.spi.configurator.ObserverMethodConfigurator
Read observer meta data from a existing ObserverMethod
-
read(Method) - Method in interface jakarta.enterprise.inject.spi.configurator.ObserverMethodConfigurator
+
read(Method) - Method in interface jakarta.enterprise.inject.spi.configurator.ObserverMethodConfigurator
+
+
Read observer meta data from a existing Method
+
+
receiverType() - Method in interface jakarta.enterprise.lang.model.declarations.MethodInfo
-
Read observer meta data from a existing Method
+
Returns the type of the receiver parameter declared by this method.
-
reception() - Method in interface jakarta.enterprise.inject.build.compatible.spi.ObserverInfo
+
reception() - Method in interface jakarta.enterprise.inject.build.compatible.spi.ObserverInfo
-
Returns the reception type of this observer.
+
Returns the reception type of this observer.
-
reception(Reception) - Method in interface jakarta.enterprise.inject.spi.configurator.ObserverMethodConfigurator
+
reception(Reception) - Method in interface jakarta.enterprise.inject.spi.configurator.ObserverMethodConfigurator
-
Set the Reception mode for the observer to build
+
Set the Reception mode for the observer to build
-
Reception - Enum in jakarta.enterprise.event
+
Reception - Enum Class in jakarta.enterprise.event
- Distinguishes conditional observer methods from observer methods which are + Distinguishes conditional observer methods from observer methods which are always notified.
-
Registration - Annotation Type in jakarta.enterprise.inject.build.compatible.spi
+
RECORD_COMPONENT - Enum constant in enum class jakarta.enterprise.lang.model.declarations.DeclarationInfo.Kind
-
3rd phase of build compatible extension execution.
+
Record component
-
release() - Method in interface jakarta.enterprise.context.spi.CreationalContext
+
RecordComponentInfo - Interface in jakarta.enterprise.lang.model.declarations
+
+
A record component, declared in some record.
+
+
recordComponents() - Method in interface jakarta.enterprise.lang.model.declarations.ClassInfo
+
+
Returns a collection of record components declared in this class.
+
+
Registration - Annotation Interface in jakarta.enterprise.inject.build.compatible.spi
+
+
3rd phase of build compatible extension execution.
+
+
release() - Method in interface jakarta.enterprise.context.spi.CreationalContext
Destroys all dependent objects of the instance which is being destroyed, by passing each dependent object to - Contextual.destroy(Object, CreationalContext) .
+ Contextual.destroy(Object, CreationalContext) .
-
remove(Predicate<Annotation>) - Method in interface jakarta.enterprise.inject.spi.configurator.AnnotatedConstructorConfigurator
+
remove(Predicate<Annotation>) - Method in interface jakarta.enterprise.inject.spi.configurator.AnnotatedConstructorConfigurator
Remove annotations that match the specified predicate.
-
remove(Predicate<Annotation>) - Method in interface jakarta.enterprise.inject.spi.configurator.AnnotatedFieldConfigurator
+
remove(Predicate<Annotation>) - Method in interface jakarta.enterprise.inject.spi.configurator.AnnotatedFieldConfigurator
Remove annotations that match the specified predicate.
-
remove(Predicate<Annotation>) - Method in interface jakarta.enterprise.inject.spi.configurator.AnnotatedMethodConfigurator
+
remove(Predicate<Annotation>) - Method in interface jakarta.enterprise.inject.spi.configurator.AnnotatedMethodConfigurator
Remove annotations that match the specified predicate.
-
remove(Predicate<Annotation>) - Method in interface jakarta.enterprise.inject.spi.configurator.AnnotatedParameterConfigurator
+
remove(Predicate<Annotation>) - Method in interface jakarta.enterprise.inject.spi.configurator.AnnotatedParameterConfigurator
Remove annotations that match the specified predicate.
-
remove(Predicate<Annotation>) - Method in interface jakarta.enterprise.inject.spi.configurator.AnnotatedTypeConfigurator
+
remove(Predicate<Annotation>) - Method in interface jakarta.enterprise.inject.spi.configurator.AnnotatedTypeConfigurator
Remove annotations that match the specified predicate.
-
removeAll() - Method in interface jakarta.enterprise.inject.spi.configurator.AnnotatedConstructorConfigurator
+
removeAll() - Method in interface jakarta.enterprise.inject.spi.configurator.AnnotatedConstructorConfigurator
Remove all the annotations.
-
removeAll() - Method in interface jakarta.enterprise.inject.spi.configurator.AnnotatedFieldConfigurator
+
removeAll() - Method in interface jakarta.enterprise.inject.spi.configurator.AnnotatedFieldConfigurator
Remove all the annotations.
-
removeAll() - Method in interface jakarta.enterprise.inject.spi.configurator.AnnotatedMethodConfigurator
+
removeAll() - Method in interface jakarta.enterprise.inject.spi.configurator.AnnotatedMethodConfigurator
Remove all the annotations.
-
removeAll() - Method in interface jakarta.enterprise.inject.spi.configurator.AnnotatedParameterConfigurator
+
removeAll() - Method in interface jakarta.enterprise.inject.spi.configurator.AnnotatedParameterConfigurator
Remove all the annotations.
-
removeAll() - Method in interface jakarta.enterprise.inject.spi.configurator.AnnotatedTypeConfigurator
+
removeAll() - Method in interface jakarta.enterprise.inject.spi.configurator.AnnotatedTypeConfigurator
Remove all the annotations.
-
removeAllAnnotations() - Method in interface jakarta.enterprise.inject.build.compatible.spi.ClassConfig
+
removeAllAnnotations() - Method in interface jakarta.enterprise.inject.build.compatible.spi.ClassConfig
Removes all annotations from this class.
-
removeAllAnnotations() - Method in interface jakarta.enterprise.inject.build.compatible.spi.DeclarationConfig
+
removeAllAnnotations() - Method in interface jakarta.enterprise.inject.build.compatible.spi.DeclarationConfig
Removes all annotations from this declaration.
-
removeAllAnnotations() - Method in interface jakarta.enterprise.inject.build.compatible.spi.FieldConfig
+
removeAllAnnotations() - Method in interface jakarta.enterprise.inject.build.compatible.spi.FieldConfig
Removes all annotations from this field.
-
removeAllAnnotations() - Method in interface jakarta.enterprise.inject.build.compatible.spi.MethodConfig
+
removeAllAnnotations() - Method in interface jakarta.enterprise.inject.build.compatible.spi.MethodConfig
Removes all annotations from this method.
-
removeAllAnnotations() - Method in interface jakarta.enterprise.inject.build.compatible.spi.ParameterConfig
+
removeAllAnnotations() - Method in interface jakarta.enterprise.inject.build.compatible.spi.ParameterConfig
Removes all annotations from this method parameter.
-
removeAnnotation(Predicate<AnnotationInfo>) - Method in interface jakarta.enterprise.inject.build.compatible.spi.ClassConfig
+
removeAnnotation(Predicate<AnnotationInfo>) - Method in interface jakarta.enterprise.inject.build.compatible.spi.ClassConfig
Removes all annotations matching given predicate from this class.
-
removeAnnotation(Predicate<AnnotationInfo>) - Method in interface jakarta.enterprise.inject.build.compatible.spi.DeclarationConfig
+
removeAnnotation(Predicate<AnnotationInfo>) - Method in interface jakarta.enterprise.inject.build.compatible.spi.DeclarationConfig
Removes all annotations matching given predicate from this declaration.
-
removeAnnotation(Predicate<AnnotationInfo>) - Method in interface jakarta.enterprise.inject.build.compatible.spi.FieldConfig
+
removeAnnotation(Predicate<AnnotationInfo>) - Method in interface jakarta.enterprise.inject.build.compatible.spi.FieldConfig
Removes all annotations matching given predicate from this field.
-
removeAnnotation(Predicate<AnnotationInfo>) - Method in interface jakarta.enterprise.inject.build.compatible.spi.MethodConfig
+
removeAnnotation(Predicate<AnnotationInfo>) - Method in interface jakarta.enterprise.inject.build.compatible.spi.MethodConfig
Removes all annotations matching given predicate from this method.
-
removeAnnotation(Predicate<AnnotationInfo>) - Method in interface jakarta.enterprise.inject.build.compatible.spi.ParameterConfig
+
removeAnnotation(Predicate<AnnotationInfo>) - Method in interface jakarta.enterprise.inject.build.compatible.spi.ParameterConfig
Removes all annotations matching given predicate from this method parameter.
-
REQUEST - Static variable in class jakarta.enterprise.context.BeforeDestroyed.Literal
-
 
-
REQUEST - Static variable in class jakarta.enterprise.context.Destroyed.Literal
-
 
-
REQUEST - Static variable in class jakarta.enterprise.context.Initialized.Literal
-
 
-
RequestContextController - Interface in jakarta.enterprise.context.control
+
repeatableAnnotation(Class<T>) - Method in interface jakarta.enterprise.lang.model.AnnotationTarget
+
+
Returns a collection of annotations of given repeatable + annotationType that are present on this annotation target.
+
+
REQUEST - Static variable in class jakarta.enterprise.context.BeforeDestroyed.Literal
+
+
Default BeforeDestroyed literal for the RequestScoped scope
+
+
REQUEST - Static variable in class jakarta.enterprise.context.Destroyed.Literal
+
+
Default Destroyed literal for the RequestScoped scope
+
+
REQUEST - Static variable in class jakarta.enterprise.context.Initialized.Literal
+
+
Default Initialized literal for the RequestScoped scope
+
+
RequestContextController - Interface in jakarta.enterprise.context.control
The CDI container provides a built in instance of RequestContextController that is dependent scoped for the purposes of activating and deactivating.
-
RequestScoped - Annotation Type in jakarta.enterprise.context
+
RequestScoped - Annotation Interface in jakarta.enterprise.context
Specifies that a bean is request scoped.
-
RequestScoped.Literal - Class in jakarta.enterprise.context
+
RequestScoped.Literal - Class in jakarta.enterprise.context
-
Supports inline instantiation of the RequestScoped annotation.
+
Supports inline instantiation of the RequestScoped annotation.
-
ResolutionException - Exception in jakarta.enterprise.inject
+
ResolutionException - Exception Class in jakarta.enterprise.inject
Indicates a problem relating to typesafe resolution.
-
ResolutionException() - Constructor for exception jakarta.enterprise.inject.ResolutionException
-
 
-
ResolutionException(String) - Constructor for exception jakarta.enterprise.inject.ResolutionException
-
 
-
ResolutionException(String, Throwable) - Constructor for exception jakarta.enterprise.inject.ResolutionException
-
 
-
ResolutionException(Throwable) - Constructor for exception jakarta.enterprise.inject.ResolutionException
-
 
-
resolve(Set<Bean<? extends X>>) - Method in interface jakarta.enterprise.inject.spi.BeanContainer
+
ResolutionException() - Constructor for exception class jakarta.enterprise.inject.ResolutionException
+
+
Creates the exception with no detail message or cause.
+
+
ResolutionException(String) - Constructor for exception class jakarta.enterprise.inject.ResolutionException
+
+
Creates the exception with given detail message.
+
+
ResolutionException(String, Throwable) - Constructor for exception class jakarta.enterprise.inject.ResolutionException
+
+
Creates the exception with given detail message and cause.
+
+
ResolutionException(Throwable) - Constructor for exception class jakarta.enterprise.inject.ResolutionException
+
+
Creates the exception with given cause.
+
+
resolve(Set<Bean<? extends X>>) - Method in interface jakarta.enterprise.inject.spi.BeanContainer
-
Apply the ambiguous dependency resolution rules to a set of beans.
+
Apply the ambiguous dependency resolution rules to a set of beans.
-
resolveDecorators(Set<Type>, Annotation...) - Method in interface jakarta.enterprise.inject.spi.BeanManager
+
resolveDecorators(Set<Type>, Annotation...) - Method in interface jakarta.enterprise.inject.spi.BeanManager
-
Return an ordered list of decorators for a set of bean types and a set of qualifiers and which are +
Return an ordered list of 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 BeanManager was injected or the Java EE component from whose JNDI environment namespace the BeanManager was obtained.
-
resolveInterceptors(InterceptionType, Annotation...) - Method in interface jakarta.enterprise.inject.spi.BeanContainer
+
resolveInterceptors(InterceptionType, Annotation...) - Method in interface jakarta.enterprise.inject.spi.BeanContainer
-
Return an ordered list of enabled interceptors for a set of interceptor bindings and a type of +
Return an ordered list of enabled 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 BeanManager/BeanContainer was injected or, in the Jakarta EE environment, the Jakarta EE component from whose JNDI environment namespace the BeanManager/BeanContainer was obtained.
-
resolveObserverMethods(T, Annotation...) - Method in interface jakarta.enterprise.inject.spi.BeanContainer
+
resolveObserverMethods(T, Annotation...) - Method in interface jakarta.enterprise.inject.spi.BeanContainer
+
+
Return an ordered set of observer methods for an event.
+
+
returnType() - Method in interface jakarta.enterprise.lang.model.declarations.MethodInfo
-
Return an ordered set of observer methods for an event.
+
Returns the return type of this method.
- - - -

S

-
-
ScannedClasses - Interface in jakarta.enterprise.inject.build.compatible.spi
+

S

+
+
ScannedClasses - Interface in jakarta.enterprise.inject.build.compatible.spi
Allows adding additional classes to the set of types discovered during type discovery.
-
scope() - Method in interface jakarta.enterprise.inject.build.compatible.spi.BeanInfo
+
scope() - Method in interface jakarta.enterprise.inject.build.compatible.spi.BeanInfo
-
Returns the scope of this bean.
+
Returns the scope of this bean.
-
scope(Class<? extends Annotation>) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticBeanBuilder
+
scope(Class<? extends Annotation>) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticBeanBuilder
Sets the scope of this synthetic bean to given scope type.
-
scope(Class<? extends Annotation>) - Method in interface jakarta.enterprise.inject.spi.configurator.BeanAttributesConfigurator
+
scope(Class<? extends Annotation>) - Method in interface jakarta.enterprise.inject.spi.configurator.BeanAttributesConfigurator
Replace Bean scope
-
scope(Class<? extends Annotation>) - Method in interface jakarta.enterprise.inject.spi.configurator.BeanConfigurator
+
scope(Class<? extends Annotation>) - Method in interface jakarta.enterprise.inject.spi.configurator.BeanConfigurator
Replace Bean scope
-
ScopeInfo - Interface in jakarta.enterprise.inject.build.compatible.spi
+
ScopeInfo - Interface in jakarta.enterprise.inject.build.compatible.spi
A scope of a bean.
-
SeContainer - Interface in jakarta.enterprise.inject.se
+
SeContainer - Interface in jakarta.enterprise.inject.se
Provides access to the current container in Java SE.
-
SeContainerInitializer - Class in jakarta.enterprise.inject.se
+
SeContainerInitializer - Class in jakarta.enterprise.inject.se
A CDI container initializer for Java SE.
-
SeContainerInitializer() - Constructor for class jakarta.enterprise.inject.se.SeContainerInitializer
+
SeContainerInitializer() - Constructor for class jakarta.enterprise.inject.se.SeContainerInitializer
 
-
select(TypeLiteral<U>, Annotation...) - Method in interface jakarta.enterprise.event.Event
+
select(TypeLiteral<U>, Annotation...) - Method in interface jakarta.enterprise.event.Event
Obtains a child Event for the given required type and additional required qualifiers.
-
select(TypeLiteral<U>, Annotation...) - Method in interface jakarta.enterprise.inject.Instance
+
select(TypeLiteral<U>, Annotation...) - Method in interface jakarta.enterprise.inject.Instance
Obtains a child Instance for the given required type and additional required qualifiers.
-
select(Annotation...) - Method in interface jakarta.enterprise.event.Event
+
select(Annotation...) - Method in interface jakarta.enterprise.event.Event
Obtains a child Event for the given additional required qualifiers.
-
select(Annotation...) - Method in interface jakarta.enterprise.inject.Instance
+
select(Annotation...) - Method in interface jakarta.enterprise.inject.Instance
Obtains a child Instance for the given additional required qualifiers.
-
select(Class<U>, Annotation...) - Method in interface jakarta.enterprise.event.Event
+
select(Class<U>, Annotation...) - Method in interface jakarta.enterprise.event.Event
Obtains a child Event for the given required type and additional required qualifiers.
-
select(Class<U>, Annotation...) - Method in interface jakarta.enterprise.inject.Instance
+
select(Class<U>, Annotation...) - Method in interface jakarta.enterprise.inject.Instance
Obtains a child Instance for the given required type and additional required qualifiers.
-
selectAlternatives(Class<?>...) - Method in class jakarta.enterprise.inject.se.SeContainerInitializer
+
selectAlternatives(Class<?>...) - Method in class jakarta.enterprise.inject.se.SeContainerInitializer
Add alternatives classes to the list of selected alternatives for the synthetic bean archive.
-
selectAlternativeStereotypes(Class<? extends Annotation>...) - Method in class jakarta.enterprise.inject.se.SeContainerInitializer
+
selectAlternativeStereotypes(Class<? extends Annotation>...) - Method in class jakarta.enterprise.inject.se.SeContainerInitializer
Add alternative stereotype classes to the list of selected alternative stereotypes for the synthetic bean archive.
-
SESSION - Static variable in class jakarta.enterprise.context.BeforeDestroyed.Literal
-
 
-
SESSION - Static variable in class jakarta.enterprise.context.Destroyed.Literal
-
 
-
SESSION - Static variable in class jakarta.enterprise.context.Initialized.Literal
-
 
-
SessionBeanType - Enum in jakarta.enterprise.inject.spi
-
-
Identifies the kind of EJB session bean.
-
-
SessionScoped - Annotation Type in jakarta.enterprise.context
+
SESSION - Static variable in class jakarta.enterprise.context.BeforeDestroyed.Literal
-
- Specifies that a bean is session scoped.
+
Default BeforeDestroyed literal for the SessionScoped scope
-
SessionScoped.Literal - Class in jakarta.enterprise.context
+
SESSION - Static variable in class jakarta.enterprise.context.Destroyed.Literal
-
Supports inline instantiation of the SessionScoped annotation.
+
Default Destroyed literal for the SessionScoped scope
-
set(String, Object) - Method in interface jakarta.enterprise.event.NotificationOptions.Builder
-
 
-
setAnnotatedType(AnnotatedType<X>) - Method in interface jakarta.enterprise.inject.spi.ProcessAnnotatedType
+
SESSION - Static variable in class jakarta.enterprise.context.Initialized.Literal
-
Replaces the AnnotatedType.
+
Default Initialized literal for the SessionScoped scope
-
setArgumentLookup(int) - Method in interface jakarta.enterprise.invoke.InvokerBuilder
+
SessionBeanType - Enum Class in jakarta.enterprise.inject.spi
-
Enables lookup of the argument on given position.
+
Identifies the kind of EJB session bean.
-
setArgumentTransformer(int, Class<?>, String) - Method in interface jakarta.enterprise.invoke.InvokerBuilder
+
SessionScoped - Annotation Interface in jakarta.enterprise.context
-
Configures an input transformer for the argument on given position.
+
+ Specifies that a bean is session scoped.
-
setBeanAttributes(BeanAttributes<T>) - Method in interface jakarta.enterprise.inject.spi.ProcessBeanAttributes
+
SessionScoped.Literal - Class in jakarta.enterprise.context
-
Replaces the BeanAttributes.
+
Supports inline instantiation of the SessionScoped annotation.
-
setBuildServices(BuildServices) - Static method in class jakarta.enterprise.inject.build.compatible.spi.BuildServicesResolver
+
set(String, Object) - Method in interface jakarta.enterprise.event.NotificationOptions.Builder
-
This method should not be used by applications.
+
Set an option value
-
setCDIProvider(CDIProvider) - Static method in class jakarta.enterprise.inject.spi.CDI
+
setAnnotatedType(AnnotatedType<X>) - Method in interface jakarta.enterprise.inject.spi.ProcessAnnotatedType
-
- Set the CDIProvider to use.
+
Replaces the AnnotatedType.
-
setClassLoader(ClassLoader) - Method in class jakarta.enterprise.inject.se.SeContainerInitializer
+
setBeanAttributes(BeanAttributes<T>) - Method in interface jakarta.enterprise.inject.spi.ProcessBeanAttributes
-
Set a ClassLoader.
+
Replaces the BeanAttributes.
-
setExceptionTransformer(Class<?>, String) - Method in interface jakarta.enterprise.invoke.InvokerBuilder
+
setBuildServices(BuildServices) - Static method in class jakarta.enterprise.inject.build.compatible.spi.BuildServicesResolver
-
Configures an output transformer for the thrown exception.
+
This method should not be used by applications.
-
setExecutor(Executor) - Method in interface jakarta.enterprise.event.NotificationOptions.Builder
-
 
-
setInjectionPoint(InjectionPoint) - Method in interface jakarta.enterprise.inject.spi.ProcessInjectionPoint
+
setCDIProvider(CDIProvider) - Static method in class jakarta.enterprise.inject.spi.CDI
-
Replaces the InjectionPoint.
+
+ Set the CDIProvider to use.
-
setInjectionTarget(InjectionTarget<X>) - Method in interface jakarta.enterprise.inject.spi.ProcessInjectionTarget
+
setClassLoader(ClassLoader) - Method in class jakarta.enterprise.inject.se.SeContainerInitializer
-
Replaces the InjectionTarget which performs injection for this target.
+
-
setInstanceLookup() - Method in interface jakarta.enterprise.invoke.InvokerBuilder
+
setExecutor(Executor) - Method in interface jakarta.enterprise.event.NotificationOptions.Builder
-
Enables lookup of the target instance.
+
Set the notification executor
-
setInstanceTransformer(Class<?>, String) - Method in interface jakarta.enterprise.invoke.InvokerBuilder
+
setInjectionPoint(InjectionPoint) - Method in interface jakarta.enterprise.inject.spi.ProcessInjectionPoint
-
Configures an input transformer for the target instance.
+
Replaces the InjectionPoint.
-
setInvocationWrapper(Class<?>, String) - Method in interface jakarta.enterprise.invoke.InvokerBuilder
+
setInjectionTarget(InjectionTarget<X>) - Method in interface jakarta.enterprise.inject.spi.ProcessInjectionTarget
-
Configures an invoker wrapper.
+
Replaces the InjectionTarget which performs injection for this target.
-
setObserverMethod(ObserverMethod<T>) - Method in interface jakarta.enterprise.inject.spi.ProcessObserverMethod
+
setObserverMethod(ObserverMethod<T>) - Method in interface jakarta.enterprise.inject.spi.ProcessObserverMethod
-
Replaces the ObserverMethod.
+
Replaces the ObserverMethod.
-
setProducer(Producer<X>) - Method in interface jakarta.enterprise.inject.spi.ProcessProducer
+
setProducer(Producer<X>) - Method in interface jakarta.enterprise.inject.spi.ProcessProducer
-
Replaces the Producer object that will be used by the container to call the producer +
Replaces the Producer object that will be used by the container to call the producer method or read the producer field.
-
setProperties(Map<String, Object>) - Method in class jakarta.enterprise.inject.se.SeContainerInitializer
+
setProperties(Map<String, Object>) - Method in class jakarta.enterprise.inject.se.SeContainerInitializer
Set all the configuration properties.
-
setReturnValueTransformer(Class<?>, String) - Method in interface jakarta.enterprise.invoke.InvokerBuilder
-
-
Configures an output transformer for the return value.
-
-
setTimeout(long) - Method in interface jakarta.enterprise.context.Conversation
+
setTimeout(long) - Method in interface jakarta.enterprise.context.Conversation
Set the timeout of the current conversation.
-
Shutdown - Class in jakarta.enterprise.event
+
SHORT - Enum constant in enum class jakarta.enterprise.lang.model.AnnotationMember.Kind
+
+
A primitive short value.
+
+
SHORT - Enum constant in enum class jakarta.enterprise.lang.model.types.PrimitiveType.PrimitiveKind
+
+
The short primitive type
+
+
Shutdown - Class in jakarta.enterprise.event
- A CDI event with payload of type Shutdown and qualifier Any is + A CDI event with payload of type Shutdown and qualifier Any is synchronously fired by CDI container during application shutdown.
-
Shutdown() - Constructor for class jakarta.enterprise.event.Shutdown
+
Shutdown() - Constructor for class jakarta.enterprise.event.Shutdown
 
-
SINGLETON - jakarta.enterprise.inject.spi.SessionBeanType
+
simpleName() - Method in interface jakarta.enterprise.lang.model.declarations.ClassInfo
+
+
Returns the simple name of this class, as defined by The Java™ Language Specification; + in other words, the class name as returned by Class.getSimpleName().
+
+
SINGLETON - Enum constant in enum class jakarta.enterprise.inject.spi.SessionBeanType
A singleton (jakarta.ejb.Singleton) session bean
-
SingletonLiteral - Class in jakarta.enterprise.inject.literal
+
SingletonLiteral - Class in jakarta.enterprise.inject.literal
Supports inline instantiation of the Singleton annotation.
-
SingletonLiteral() - Constructor for class jakarta.enterprise.inject.literal.SingletonLiteral
+
SingletonLiteral() - Constructor for class jakarta.enterprise.inject.literal.SingletonLiteral
 
-
SkipIfPortableExtensionPresent - Annotation Type in jakarta.enterprise.inject.build.compatible.spi
+
SkipIfPortableExtensionPresent - Annotation Interface in jakarta.enterprise.inject.build.compatible.spi
-
If a build compatible extension is annotated +
If a build compatible extension is annotated @SkipIfPortableExtensionPresent, it is ignored when the CDI container can execute portable extensions and determines that a portable extension - of given class is present.
+ of given class is present.
-
Specializes - Annotation Type in jakarta.enterprise.inject
+
Specializes - Annotation Interface in jakarta.enterprise.inject
Indicates that a bean directly specializes another bean.
-
Specializes.Literal - Class in jakarta.enterprise.inject
+
Specializes.Literal - Class in jakarta.enterprise.inject
-
Supports inline instantiation of the Specializes annotation.
+
Supports inline instantiation of the Specializes annotation.
-
Startup - Class in jakarta.enterprise.event
+
Startup - Class in jakarta.enterprise.event
- A CDI event with payload of type Startup and qualifier Any is + A CDI event with payload of type Startup and qualifier Any is synchronously fired by CDI container during application initialization.
-
Startup() - Constructor for class jakarta.enterprise.event.Startup
+
Startup() - Constructor for class jakarta.enterprise.event.Startup
 
-
STATEFUL - jakarta.enterprise.inject.spi.SessionBeanType
+
STATEFUL - Enum constant in enum class jakarta.enterprise.inject.spi.SessionBeanType
A stateful (jakarta.ejb.Stateful) session bean
-
STATELESS - jakarta.enterprise.inject.spi.SessionBeanType
+
STATELESS - Enum constant in enum class jakarta.enterprise.inject.spi.SessionBeanType
A stateless (jakarta.ejb.Stateless) session bean
-
stereotype(ClassInfo) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticBeanBuilder
+
stereotype(ClassInfo) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticBeanBuilder
Adds stereotypeAnnotation to the set of stereotypes of this synthetic bean.
-
stereotype(Class<? extends Annotation>) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticBeanBuilder
+
stereotype(Class<? extends Annotation>) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticBeanBuilder
Adds stereotypeAnnotation to the set of stereotypes of this synthetic bean.
-
Stereotype - Annotation Type in jakarta.enterprise.inject
+
Stereotype - Annotation Interface in jakarta.enterprise.inject
Specifies that an annotation type is a stereotype.
-
StereotypeInfo - Interface in jakarta.enterprise.inject.build.compatible.spi
+
StereotypeInfo - Interface in jakarta.enterprise.inject.build.compatible.spi
A stereotype.
-
stereotypes() - Method in interface jakarta.enterprise.inject.build.compatible.spi.BeanInfo
+
stereotypes() - Method in interface jakarta.enterprise.inject.build.compatible.spi.BeanInfo
-
Returns a collection of this bean's stereotypes.
+
Returns a collection of this bean's stereotypes.
-
stereotypes(Set<Class<? extends Annotation>>) - Method in interface jakarta.enterprise.inject.spi.configurator.BeanAttributesConfigurator
+
stereotypes(Set<Class<? extends Annotation>>) - Method in interface jakarta.enterprise.inject.spi.configurator.BeanAttributesConfigurator
Replace stereotypes on the configured bean
-
stereotypes(Set<Class<? extends Annotation>>) - Method in interface jakarta.enterprise.inject.spi.configurator.BeanConfigurator
+
stereotypes(Set<Class<? extends Annotation>>) - Method in interface jakarta.enterprise.inject.spi.configurator.BeanConfigurator
Replace stereotypes on the configured bean
-
stream() - Method in interface jakarta.enterprise.inject.Instance
+
stream() - Method in interface jakarta.enterprise.inject.Instance
When called, provides back a Stream of the beans available in this Instance.
-
Synthesis - Annotation Type in jakarta.enterprise.inject.build.compatible.spi
+
STRING - Enum constant in enum class jakarta.enterprise.lang.model.AnnotationMember.Kind
+
+
A String value.
+
+
superClass() - Method in interface jakarta.enterprise.lang.model.declarations.ClassInfo
+
+
Returns the direct superclass type of this class.
+
+
superClassDeclaration() - Method in interface jakarta.enterprise.lang.model.declarations.ClassInfo
+
+
Returns the direct superclass of this class.
+
+
superInterfaces() - Method in interface jakarta.enterprise.lang.model.declarations.ClassInfo
+
+
Returns a list of direct superinterface types of this class.
+
+
superInterfacesDeclarations() - Method in interface jakarta.enterprise.lang.model.declarations.ClassInfo
+
+
Returns a list of direct superinterfaces of this class.
+
+
Synthesis - Annotation Interface in jakarta.enterprise.inject.build.compatible.spi
-
4th phase of build compatible extension execution.
+
4th phase of build compatible extension execution.
-
SyntheticBeanBuilder<T> - Interface in jakarta.enterprise.inject.build.compatible.spi
+
SyntheticBeanBuilder<T> - Interface in jakarta.enterprise.inject.build.compatible.spi
Builder for synthetic beans.
-
SyntheticBeanCreator<T> - Interface in jakarta.enterprise.inject.build.compatible.spi
+
SyntheticBeanCreator<T> - Interface in jakarta.enterprise.inject.build.compatible.spi
-
Creation function for a synthetic bean defined by SyntheticBeanBuilder.
+
Creation function for a synthetic bean defined by SyntheticBeanBuilder.
-
SyntheticBeanDisposer<T> - Interface in jakarta.enterprise.inject.build.compatible.spi
+
SyntheticBeanDisposer<T> - Interface in jakarta.enterprise.inject.build.compatible.spi
-
Destruction function for a synthetic bean defined by SyntheticBeanBuilder.
+
Destruction function for a synthetic bean defined by SyntheticBeanBuilder.
-
SyntheticComponents - Interface in jakarta.enterprise.inject.build.compatible.spi
+
SyntheticComponents - Interface in jakarta.enterprise.inject.build.compatible.spi
Allows registering synthetic beans and observers.
-
SyntheticObserver<T> - Interface in jakarta.enterprise.inject.build.compatible.spi
+
SyntheticObserver<T> - Interface in jakarta.enterprise.inject.build.compatible.spi
-
The event notification function for a synthetic observer defined by SyntheticObserverBuilder.
+
The event notification function for a synthetic observer defined by SyntheticObserverBuilder.
-
SyntheticObserverBuilder<T> - Interface in jakarta.enterprise.inject.build.compatible.spi
+
SyntheticObserverBuilder<T> - Interface in jakarta.enterprise.inject.build.compatible.spi
Builder for synthetic observers.
- - - -

T

-
-
toString() - Method in class jakarta.enterprise.util.AnnotationLiteral
+

T

+
+
The BeanManager object - Search tag in package jakarta.enterprise.inject.spi
+
Section
+
throwsTypes() - Method in interface jakarta.enterprise.lang.model.declarations.MethodInfo
+
+
Returns a list of exception types that are declared to be thrown by this method.
+
+
toString() - Method in class jakarta.enterprise.util.AnnotationLiteral
 
-
toString() - Method in class jakarta.enterprise.util.TypeLiteral
+
toString() - Method in class jakarta.enterprise.util.TypeLiteral
 
-
transactionPhase() - Method in interface jakarta.enterprise.inject.build.compatible.spi.ObserverInfo
+
transactionPhase() - Method in interface jakarta.enterprise.inject.build.compatible.spi.ObserverInfo
-
Returns the transaction phase of this transactional observer.
+
Returns the transaction phase of this transactional observer.
-
transactionPhase(TransactionPhase) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticObserverBuilder
+
transactionPhase(TransactionPhase) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticObserverBuilder
-
Sets the TransactionPhase during which this synthetic observer should be notified.
+
Sets the TransactionPhase during which this synthetic observer should be notified.
-
transactionPhase(TransactionPhase) - Method in interface jakarta.enterprise.inject.spi.configurator.ObserverMethodConfigurator
+
transactionPhase(TransactionPhase) - Method in interface jakarta.enterprise.inject.spi.configurator.ObserverMethodConfigurator
-
Set the TransactionPhase for the observer to build
+
Set the TransactionPhase for the observer to build
-
TransactionPhase - Enum in jakarta.enterprise.event
+
TransactionPhase - Enum Class in jakarta.enterprise.event
- Distinguishes the various kinds of transactional observer methods from regular + Distinguishes the various kinds of transactional observer methods from regular observer methods which are notified immediately.
-
transientField(boolean) - Method in interface jakarta.enterprise.inject.spi.configurator.InjectionPointConfigurator
+
transientField(boolean) - Method in interface jakarta.enterprise.inject.spi.configurator.InjectionPointConfigurator
Change the transient status of the built InjectionPoint.
-
TransientReference - Annotation Type in jakarta.enterprise.inject
+
TransientReference - Annotation Interface in jakarta.enterprise.inject
- If a parameter annotated with @TransientReference resolves to a dependent scoped bean, then the bean will be + If a parameter annotated with @TransientReference resolves to a dependent scoped bean, then the bean will + be destroyed after the invocation completes.
-
TransientReference.Literal - Class in jakarta.enterprise.inject
+
TransientReference.Literal - Class in jakarta.enterprise.inject
+
+
Supports inline instantiation of the TransientReference annotation.
+
+
type() - Method in interface jakarta.enterprise.inject.build.compatible.spi.InjectionPointInfo
+
+
Returns the type of this injection point.
+
+
type() - Method in interface jakarta.enterprise.lang.model.declarations.FieldInfo
+
+
Returns the type of this field.
+
+
type() - Method in interface jakarta.enterprise.lang.model.declarations.ParameterInfo
-
Supports inline instantiation of the TransientReference annotation.
+
Returns the type of this parameter.
-
type() - Method in interface jakarta.enterprise.inject.build.compatible.spi.InjectionPointInfo
+
type() - Method in interface jakarta.enterprise.lang.model.declarations.RecordComponentInfo
-
Returns the type of this injection point.
+
Returns the type of this record component.
-
type(ClassInfo) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticBeanBuilder
+
type(ClassInfo) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticBeanBuilder
Adds type to the set of bean types of this synthetic bean.
-
type(Type) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticBeanBuilder
+
type(Type) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticBeanBuilder
Adds type to the set of bean types of this synthetic bean.
-
type(Class<?>) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticBeanBuilder
+
type(Class<?>) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticBeanBuilder
Adds type to the set of bean types of this synthetic bean.
-
type(Type) - Method in interface jakarta.enterprise.inject.spi.configurator.InjectionPointConfigurator
+
type(Type) - Method in interface jakarta.enterprise.inject.spi.configurator.InjectionPointConfigurator
-
Set the required Type (that will be used during typesafe resolution) +
Set the required Type (that will be used during typesafe resolution) of the InjectionPoint to build.
-
Typed - Annotation Type in jakarta.enterprise.inject
+
Type - Interface in jakarta.enterprise.lang.model.types
+
+
A type is used in a program source code, but does not have to be declared anywhere.
+
+
TYPE_VARIABLE - Enum constant in enum class jakarta.enterprise.lang.model.types.Type.Kind
+
+
A type variable, e.g.
+
+
Type.Kind - Enum Class in jakarta.enterprise.lang.model.types
+
+
The type kind: void, primitive, class, array, parameterized type, type variable, wildcard type
+
+
typeArguments() - Method in interface jakarta.enterprise.lang.model.types.ParameterizedType
+
+
Returns the list of type arguments that were applied to a generic class to form this parameterized type.
+
+
Typed - Annotation Interface in jakarta.enterprise.inject
Restricts the bean types of a bean.
-
Typed.Literal - Class in jakarta.enterprise.inject
+
Typed.Literal - Class in jakarta.enterprise.inject
-
Supports inline instantiation of the Typed annotation.
+
Supports inline instantiation of the Typed annotation.
-
TypeLiteral<T> - Class in jakarta.enterprise.util
+
TypeLiteral<T> - Class in jakarta.enterprise.util
Supports inline instantiation of objects that represent parameterized types with actual type parameters.
-
TypeLiteral() - Constructor for class jakarta.enterprise.util.TypeLiteral
-
 
-
types() - Method in interface jakarta.enterprise.inject.build.compatible.spi.BeanInfo
+
TypeLiteral() - Constructor for class jakarta.enterprise.util.TypeLiteral
+
+
The literal constructor, only for subclasses.
+
+
typeParameters() - Method in interface jakarta.enterprise.lang.model.declarations.ClassInfo
-
Returns a collection of all types of this bean.
+
Returns a list of type parameters declared on this class.
-
types() - Method in annotation type jakarta.enterprise.inject.build.compatible.spi.Enhancement
+
typeParameters() - Method in interface jakarta.enterprise.lang.model.declarations.MethodInfo
+
+
Returns a list of type parameters declared on this method.
+
+
types() - Method in interface jakarta.enterprise.inject.build.compatible.spi.BeanInfo
+
+
Returns a collection of all types of this bean.
+
+
types() - Element in annotation interface jakarta.enterprise.inject.build.compatible.spi.Enhancement
Defines the set of expected types.
-
types() - Method in annotation type jakarta.enterprise.inject.build.compatible.spi.Registration
+
types() - Element in annotation interface jakarta.enterprise.inject.build.compatible.spi.Registration
Defines the set of expected types.
-
types(Type...) - Method in interface jakarta.enterprise.inject.spi.configurator.BeanAttributesConfigurator
+
types(Type...) - Method in interface jakarta.enterprise.inject.spi.configurator.BeanAttributesConfigurator
Replace bean types
-
types(Type...) - Method in interface jakarta.enterprise.inject.spi.configurator.BeanConfigurator
+
types(Type...) - Method in interface jakarta.enterprise.inject.spi.configurator.BeanConfigurator
Replace bean types
-
types(Set<Type>) - Method in interface jakarta.enterprise.inject.spi.configurator.BeanAttributesConfigurator
+
types(Set<Type>) - Method in interface jakarta.enterprise.inject.spi.configurator.BeanAttributesConfigurator
Replace bean types
-
types(Set<Type>) - Method in interface jakarta.enterprise.inject.spi.configurator.BeanConfigurator
+
types(Set<Type>) - Method in interface jakarta.enterprise.inject.spi.configurator.BeanConfigurator
Replace bean types
-
Types - Interface in jakarta.enterprise.inject.build.compatible.spi
+
Types - Interface in jakarta.enterprise.inject.build.compatible.spi
-
Factory for types.
+
Factory for types.
+
+
TypeVariable - Interface in jakarta.enterprise.lang.model.types
+
+
Type variables represent type parameters declared on generic classes or methods.
- - - -

U

-
-
Unmanaged<T> - Class in jakarta.enterprise.inject.spi
+

U

+
+
Unmanaged<T> - Class in jakarta.enterprise.inject.spi
Helper class for injecting and calling lifecycle callbacks unmanaged instances for use by framework and library integrators.
-
Unmanaged(BeanManager, Class<T>) - Constructor for class jakarta.enterprise.inject.spi.Unmanaged
+
Unmanaged(BeanManager, Class<T>) - Constructor for class jakarta.enterprise.inject.spi.Unmanaged
Create an injector for the given class
-
Unmanaged(Class<T>) - Constructor for class jakarta.enterprise.inject.spi.Unmanaged
+
Unmanaged(Class<T>) - Constructor for class jakarta.enterprise.inject.spi.Unmanaged
Create an injector for the given class, using the current bean manager
-
Unmanaged.UnmanagedInstance<T> - Class in jakarta.enterprise.inject.spi
+
Unmanaged.UnmanagedInstance<T> - Class in jakarta.enterprise.inject.spi
Represents a non-contextual instance.
-
UnproxyableResolutionException - Exception in jakarta.enterprise.inject
+
UnproxyableResolutionException - Exception Class in jakarta.enterprise.inject
Indicates that a contextual reference for a bean with a normal scope and a certain bean type cannot be obtained because the bean type cannot be proxied by the container.
-
UnproxyableResolutionException() - Constructor for exception jakarta.enterprise.inject.UnproxyableResolutionException
-
 
-
UnproxyableResolutionException(String) - Constructor for exception jakarta.enterprise.inject.UnproxyableResolutionException
-
 
-
UnproxyableResolutionException(String, Throwable) - Constructor for exception jakarta.enterprise.inject.UnproxyableResolutionException
-
 
-
UnproxyableResolutionException(Throwable) - Constructor for exception jakarta.enterprise.inject.UnproxyableResolutionException
-
 
-
UnsatisfiedResolutionException - Exception in jakarta.enterprise.inject
+
UnproxyableResolutionException() - Constructor for exception class jakarta.enterprise.inject.UnproxyableResolutionException
+
+
Creates the exception with no detail message or cause.
+
+
UnproxyableResolutionException(String) - Constructor for exception class jakarta.enterprise.inject.UnproxyableResolutionException
+
+
Creates the exception with given detail message.
+
+
UnproxyableResolutionException(String, Throwable) - Constructor for exception class jakarta.enterprise.inject.UnproxyableResolutionException
+
+
Creates the exception with given detail message and cause.
+
+
UnproxyableResolutionException(Throwable) - Constructor for exception class jakarta.enterprise.inject.UnproxyableResolutionException
+
+
Creates the exception with given cause.
+
+
UnsatisfiedResolutionException - Exception Class in jakarta.enterprise.inject
Indicates that no bean matches a certain combination of required type and required qualifiers and is eligible for injection into a certain class.
-
UnsatisfiedResolutionException() - Constructor for exception jakarta.enterprise.inject.UnsatisfiedResolutionException
-
 
-
UnsatisfiedResolutionException(String) - Constructor for exception jakarta.enterprise.inject.UnsatisfiedResolutionException
-
 
-
UnsatisfiedResolutionException(String, Throwable) - Constructor for exception jakarta.enterprise.inject.UnsatisfiedResolutionException
-
 
-
UnsatisfiedResolutionException(Throwable) - Constructor for exception jakarta.enterprise.inject.UnsatisfiedResolutionException
-
 
+
UnsatisfiedResolutionException() - Constructor for exception class jakarta.enterprise.inject.UnsatisfiedResolutionException
+
+
Creates the exception with no detail message or cause.
+
+
UnsatisfiedResolutionException(String) - Constructor for exception class jakarta.enterprise.inject.UnsatisfiedResolutionException
+
+
Creates the exception with given detail message.
+
+
UnsatisfiedResolutionException(String, Throwable) - Constructor for exception class jakarta.enterprise.inject.UnsatisfiedResolutionException
+
+
Creates the exception with given detail message and cause.
+
+
UnsatisfiedResolutionException(Throwable) - Constructor for exception class jakarta.enterprise.inject.UnsatisfiedResolutionException
+
+
Creates the exception with given cause.
+
+
upperBound() - Method in interface jakarta.enterprise.lang.model.types.WildcardType
+
+
Returns the upper bound of this wildcard type.
+
- - - -

V

-
-
validate(InjectionPoint) - Method in interface jakarta.enterprise.inject.spi.BeanManager
+

V

+
+
validate(InjectionPoint) - Method in interface jakarta.enterprise.inject.spi.BeanManager
-
Validate a certain injection point.
+
Validate a certain injection point.
-
Validation - Annotation Type in jakarta.enterprise.inject.build.compatible.spi
+
Validation - Annotation Interface in jakarta.enterprise.inject.build.compatible.spi
-
5th phase of build compatible extension execution.
+
5th phase of build compatible extension execution.
-
value() - Method in class jakarta.enterprise.context.BeforeDestroyed.Literal
+
value() - Method in class jakarta.enterprise.context.BeforeDestroyed.Literal
 
-
value() - Method in annotation type jakarta.enterprise.context.BeforeDestroyed
+
value() - Element in annotation interface jakarta.enterprise.context.BeforeDestroyed
The scope for which to observe destruction
-
value() - Method in class jakarta.enterprise.context.Destroyed.Literal
+
value() - Method in class jakarta.enterprise.context.Destroyed.Literal
 
-
value() - Method in annotation type jakarta.enterprise.context.Destroyed
+
value() - Element in annotation interface jakarta.enterprise.context.Destroyed
The scope for which to observe destruction
-
value() - Method in class jakarta.enterprise.context.Initialized.Literal
+
value() - Method in class jakarta.enterprise.context.Initialized.Literal
 
-
value() - Method in annotation type jakarta.enterprise.context.Initialized
+
value() - Element in annotation interface jakarta.enterprise.context.Initialized
The scope for which to observe initialization
-
value() - Method in annotation type jakarta.enterprise.inject.build.compatible.spi.SkipIfPortableExtensionPresent
+
value() - Element in annotation interface jakarta.enterprise.inject.build.compatible.spi.SkipIfPortableExtensionPresent
-
A class implementing Extension that is expected to mirror the functionality of the annotated +
A class implementing Extension that is expected to mirror the functionality of the annotated build compatible extension.
-
value() - Method in class jakarta.enterprise.inject.literal.NamedLiteral
+
value() - Method in class jakarta.enterprise.inject.literal.NamedLiteral
 
-
value() - Method in annotation type jakarta.enterprise.inject.spi.WithAnnotations
-
 
-
value() - Method in class jakarta.enterprise.inject.Typed.Literal
+
value() - Element in annotation interface jakarta.enterprise.inject.spi.WithAnnotations
+
+
The annotation types that must be present on the AnnotatedType + for the ProcessAnnotatedType observer to be notified.
+
+
value() - Method in class jakarta.enterprise.inject.Typed.Literal
 
-
value() - Method in annotation type jakarta.enterprise.inject.Typed
+
value() - Element in annotation interface jakarta.enterprise.inject.Typed
Selects the bean types of the bean.
-
value(boolean) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
+
value() - Method in interface jakarta.enterprise.lang.model.AnnotationInfo
+
+
Returns the value of this annotation's value member.
+
+
value(boolean) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
Adds a boolean-valued annotation member called value.
-
value(boolean[]) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
+
value(boolean[]) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
Adds a boolean array-valued annotation member called value.
-
value(byte) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
+
value(byte) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
Adds a byte-valued annotation member called value.
-
value(byte[]) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
+
value(byte[]) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
Adds a byte array-valued annotation member called value.
-
value(char) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
+
value(char) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
Adds a char-valued annotation member called value.
-
value(char[]) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
+
value(char[]) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
Adds a char array-valued annotation member called value.
-
value(double) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
+
value(double) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
Adds a double-valued annotation member called value.
-
value(double[]) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
+
value(double[]) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
Adds a double array-valued annotation member called value.
-
value(float) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
+
value(float) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
Adds a float-valued annotation member called value.
-
value(float[]) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
+
value(float[]) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
Adds a float array-valued annotation member called value.
-
value(int) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
+
value(int) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
Adds an int-valued annotation member called value.
-
value(int[]) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
+
value(int[]) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
Adds an int array-valued annotation member called value.
-
value(long) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
+
value(long) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
Adds a long-valued annotation member called value.
-
value(long[]) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
+
value(long[]) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
Adds a long array-valued annotation member called value.
-
value(short) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
+
value(short) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
Adds a short-valued annotation member called value.
-
value(short[]) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
+
value(short[]) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
Adds a short array-valued annotation member called value.
-
value(AnnotationInfo) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
+
value(AnnotationInfo) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
Adds an annotation-valued annotation member called value.
-
value(AnnotationInfo[]) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
+
value(AnnotationInfo[]) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
Adds an annotation array-valued annotation member called value.
-
value(AnnotationMember) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
+
value(AnnotationMember) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
Adds an annotation member called value, whose value is given value.
-
value(ClassInfo) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
+
value(ClassInfo) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
Adds a class-valued annotation member called value.
-
value(ClassInfo[]) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
+
value(ClassInfo[]) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
Adds a class array-valued annotation member called value.
-
value(ClassInfo, String) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
+
value(ClassInfo, String) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
Adds an enum-valued annotation member called value.
-
value(ClassInfo, String[]) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
+
value(ClassInfo, String[]) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
Adds an enum array-valued annotation member called value.
-
value(Type) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
+
value(Type) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
Adds a class-valued annotation member called value.
-
value(Type[]) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
+
value(Type[]) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
Adds a class array-valued annotation member called value.
-
value(Annotation) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
+
value(Annotation) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
Adds an annotation-valued annotation member called value.
-
value(Annotation[]) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
+
value(Annotation[]) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
Adds an annotation array-valued annotation member called value.
-
value(Class<?>) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
+
value(Class<?>) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
Adds a class-valued annotation member called value.
-
value(Class<?>[]) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
+
value(Class<?>[]) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
Adds a class array-valued annotation member called value.
-
value(Class<? extends Enum<?>>, String) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
+
value(Class<? extends Enum<?>>, String) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
Adds an enum-valued annotation member called value.
-
value(Class<? extends Enum<?>>, String[]) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
+
value(Class<? extends Enum<?>>, String[]) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
Adds an enum array-valued annotation member called value.
-
value(Enum<?>) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
+
value(Enum<?>) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
Adds an enum-valued annotation member called value.
-
value(Enum<?>[]) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
+
value(Enum<?>[]) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
Adds an enum array-valued annotation member called value.
-
value(String) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
+
value(String) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
Adds a String-valued annotation member called value.
-
value(String[]) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
+
value(String[]) - Method in interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder
Adds a String array-valued annotation member called value.
-
valueOf(String) - Static method in enum jakarta.enterprise.event.Reception
+
VALUE - Static variable in interface jakarta.enterprise.lang.model.AnnotationMember
+
+
Name of the commonly used value() annotation member.
+
+
valueOf(String) - Static method in enum class jakarta.enterprise.event.Reception
+
+
Returns the enum constant of this class with the specified name.
+
+
valueOf(String) - Static method in enum class jakarta.enterprise.event.TransactionPhase
+
+
Returns the enum constant of this class with the specified name.
+
+
valueOf(String) - Static method in enum class jakarta.enterprise.inject.spi.InterceptionType
+
+
Returns the enum constant of this class with the specified name.
+
+
valueOf(String) - Static method in enum class jakarta.enterprise.inject.spi.SessionBeanType
+
+
Returns the enum constant of this class with the specified name.
+
+
valueOf(String) - Static method in enum class jakarta.enterprise.lang.model.AnnotationMember.Kind
+
+
Returns the enum constant of this class with the specified name.
+
+
valueOf(String) - Static method in enum class jakarta.enterprise.lang.model.declarations.DeclarationInfo.Kind
+
+
Returns the enum constant of this class with the specified name.
+
+
valueOf(String) - Static method in enum class jakarta.enterprise.lang.model.types.PrimitiveType.PrimitiveKind
+
+
Returns the enum constant of this class with the specified name.
+
+
valueOf(String) - Static method in enum class jakarta.enterprise.lang.model.types.Type.Kind
+
+
Returns the enum constant of this class with the specified name.
+
+
values() - Static method in enum class jakarta.enterprise.event.Reception
-
Returns the enum constant of this type with the specified name.
+
Returns an array containing the constants of this enum class, in +the order they are declared.
-
valueOf(String) - Static method in enum jakarta.enterprise.event.TransactionPhase
+
values() - Static method in enum class jakarta.enterprise.event.TransactionPhase
-
Returns the enum constant of this type with the specified name.
+
Returns an array containing the constants of this enum class, in +the order they are declared.
-
valueOf(String) - Static method in enum jakarta.enterprise.inject.spi.InterceptionType
+
values() - Static method in enum class jakarta.enterprise.inject.spi.InterceptionType
-
Returns the enum constant of this type with the specified name.
+
Returns an array containing the constants of this enum class, in +the order they are declared.
-
valueOf(String) - Static method in enum jakarta.enterprise.inject.spi.SessionBeanType
+
values() - Static method in enum class jakarta.enterprise.inject.spi.SessionBeanType
-
Returns the enum constant of this type with the specified name.
+
Returns an array containing the constants of this enum class, in +the order they are declared.
-
values() - Static method in enum jakarta.enterprise.event.Reception
+
values() - Static method in enum class jakarta.enterprise.lang.model.AnnotationMember.Kind
-
Returns an array containing the constants of this enum type, in +
Returns an array containing the constants of this enum class, in the order they are declared.
-
values() - Static method in enum jakarta.enterprise.event.TransactionPhase
+
values() - Static method in enum class jakarta.enterprise.lang.model.declarations.DeclarationInfo.Kind
-
Returns an array containing the constants of this enum type, in +
Returns an array containing the constants of this enum class, in the order they are declared.
-
values() - Static method in enum jakarta.enterprise.inject.spi.InterceptionType
+
values() - Static method in enum class jakarta.enterprise.lang.model.types.PrimitiveType.PrimitiveKind
-
Returns an array containing the constants of this enum type, in +
Returns an array containing the constants of this enum class, in the order they are declared.
-
values() - Static method in enum jakarta.enterprise.inject.spi.SessionBeanType
+
values() - Static method in enum class jakarta.enterprise.lang.model.types.Type.Kind
-
Returns an array containing the constants of this enum type, in +
Returns an array containing the constants of this enum class, in the order they are declared.
-
veto() - Method in interface jakarta.enterprise.inject.spi.ProcessAnnotatedType
+
veto() - Method in interface jakarta.enterprise.inject.spi.ProcessAnnotatedType
Forces the container to ignore this type.
-
veto() - Method in interface jakarta.enterprise.inject.spi.ProcessBeanAttributes
+
veto() - Method in interface jakarta.enterprise.inject.spi.ProcessBeanAttributes
Forces the container to ignore the bean.
-
veto() - Method in interface jakarta.enterprise.inject.spi.ProcessObserverMethod
+
veto() - Method in interface jakarta.enterprise.inject.spi.ProcessObserverMethod
Forces the container to ignore the observer method.
-
Vetoed - Annotation Type in jakarta.enterprise.inject
+
Vetoed - Annotation Interface in jakarta.enterprise.inject
Veto the processing of the class.
-
Vetoed.Literal - Class in jakarta.enterprise.inject
+
Vetoed.Literal - Class in jakarta.enterprise.inject
+
+
Supports inline instantiation of the Vetoed annotation.
+
+
VOID - Enum constant in enum class jakarta.enterprise.lang.model.types.Type.Kind
+
+
The void pseudo-type, e.g.
+
+
VoidType - Interface in jakarta.enterprise.lang.model.types
-
Supports inline instantiation of the Vetoed annotation.
+
The void pseudo-type.
- - - -

W

-
-
warn(String) - Method in interface jakarta.enterprise.inject.build.compatible.spi.Messages
+

W

+
+
warn(String) - Method in interface jakarta.enterprise.inject.build.compatible.spi.Messages
Add a generic warning that is not related to any particular element, or that information is not known.
-
warn(String, BeanInfo) - Method in interface jakarta.enterprise.inject.build.compatible.spi.Messages
+
warn(String, BeanInfo) - Method in interface jakarta.enterprise.inject.build.compatible.spi.Messages
+
+
Add a warning which is related to given BeanInfo.
+
+
warn(String, ObserverInfo) - Method in interface jakarta.enterprise.inject.build.compatible.spi.Messages
+
+
Add a warning which is related to given ObserverInfo.
+
+
warn(String, AnnotationTarget) - Method in interface jakarta.enterprise.inject.build.compatible.spi.Messages
-
Add a warning which is related to given BeanInfo.
+
Add a warning which is related to given AnnotationTarget (which is most likely + a DeclarationInfo).
-
warn(String, ObserverInfo) - Method in interface jakarta.enterprise.inject.build.compatible.spi.Messages
+
WILDCARD_TYPE - Enum constant in enum class jakarta.enterprise.lang.model.types.Type.Kind
-
Add a warning which is related to given ObserverInfo.
+
A wildcard type, e.g.
-
warn(String, AnnotationTarget) - Method in interface jakarta.enterprise.inject.build.compatible.spi.Messages
+
WildcardType - Interface in jakarta.enterprise.lang.model.types
-
Add a warning which is related to given AnnotationTarget (which is most likely - a DeclarationInfo).
+
A wildcard type.
-
wildcardUnbounded() - Method in interface jakarta.enterprise.inject.build.compatible.spi.Types
+
wildcardUnbounded() - Method in interface jakarta.enterprise.inject.build.compatible.spi.Types
-
Returns a WildcardType that represents an equivalent of ?.
+
Returns a WildcardType that represents an equivalent of ?.
-
wildcardWithLowerBound(Type) - Method in interface jakarta.enterprise.inject.build.compatible.spi.Types
+
wildcardWithLowerBound(Type) - Method in interface jakarta.enterprise.inject.build.compatible.spi.Types
-
Returns a WildcardType that represents an equivalent of ? super lowerBound.
+
Returns a WildcardType that represents an equivalent of ? super lowerBound.
-
wildcardWithUpperBound(Type) - Method in interface jakarta.enterprise.inject.build.compatible.spi.Types
+
wildcardWithUpperBound(Type) - Method in interface jakarta.enterprise.inject.build.compatible.spi.Types
-
Returns a WildcardType that represents an equivalent of ? extends upperBound.
+
Returns a WildcardType that represents an equivalent of ? extends upperBound.
-
withAnnotations() - Method in annotation type jakarta.enterprise.inject.build.compatible.spi.Enhancement
+
withAnnotations() - Element in annotation interface jakarta.enterprise.inject.build.compatible.spi.Enhancement
-
Narrows down the set of expected types, defined by types - and withSubtypes, to types that use any of given annotations.
+
Narrows down the set of expected types, defined by types + and withSubtypes, to types that use any of given annotations.
-
WithAnnotations - Annotation Type in jakarta.enterprise.inject.spi
+
WithAnnotations - Annotation Interface in jakarta.enterprise.inject.spi
- WithAnnotations may be applied to any portable extension observer method with an event parameter type of - ProcessAnnotatedType to filter the events delivered.
+ WithAnnotations may be applied to any portable extension observer method with an event parameter type of + ProcessAnnotatedType to filter the events delivered. +
+
withArgumentLookup(int) - Method in interface jakarta.enterprise.invoke.InvokerBuilder
+
+
Enables lookup of the argument on given position.
+
+
withInstanceLookup() - Method in interface jakarta.enterprise.invoke.InvokerBuilder
+
+
Enables lookup of the target bean instance.
-
withParam(String, boolean) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticBeanBuilder
+
withParam(String, boolean) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticBeanBuilder
Adds a boolean-valued parameter to the parameter map.
-
withParam(String, boolean) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticObserverBuilder
+
withParam(String, boolean) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticObserverBuilder
Adds a boolean-valued parameter to the parameter map.
-
withParam(String, boolean[]) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticBeanBuilder
+
withParam(String, boolean[]) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticBeanBuilder
Adds a boolean array-valued parameter to the parameter map.
-
withParam(String, boolean[]) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticObserverBuilder
+
withParam(String, boolean[]) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticObserverBuilder
Adds a boolean array-valued parameter to the parameter map.
-
withParam(String, double) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticBeanBuilder
+
withParam(String, double) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticBeanBuilder
Adds a double-valued parameter to the parameter map.
-
withParam(String, double) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticObserverBuilder
+
withParam(String, double) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticObserverBuilder
Adds a double-valued parameter to the parameter map.
-
withParam(String, double[]) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticBeanBuilder
+
withParam(String, double[]) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticBeanBuilder
Adds a double array-valued parameter to the parameter map.
-
withParam(String, double[]) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticObserverBuilder
+
withParam(String, double[]) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticObserverBuilder
Adds a double array-valued parameter to the parameter map.
-
withParam(String, int) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticBeanBuilder
+
withParam(String, int) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticBeanBuilder
Adds an int-valued parameter to the parameter map.
-
withParam(String, int) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticObserverBuilder
+
withParam(String, int) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticObserverBuilder
Adds an int-valued parameter to the parameter map.
-
withParam(String, int[]) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticBeanBuilder
+
withParam(String, int[]) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticBeanBuilder
Adds an int array-valued parameter to the parameter map.
-
withParam(String, int[]) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticObserverBuilder
+
withParam(String, int[]) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticObserverBuilder
Adds an int array-valued parameter to the parameter map.
-
withParam(String, long) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticBeanBuilder
+
withParam(String, long) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticBeanBuilder
Adds a long-valued parameter to the parameter map.
-
withParam(String, long) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticObserverBuilder
+
withParam(String, long) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticObserverBuilder
Adds a long-valued parameter to the parameter map.
-
withParam(String, long[]) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticBeanBuilder
+
withParam(String, long[]) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticBeanBuilder
Adds a long array-valued parameter to the parameter map.
-
withParam(String, long[]) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticObserverBuilder
+
withParam(String, long[]) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticObserverBuilder
Adds a long array-valued parameter to the parameter map.
-
withParam(String, InvokerInfo) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticBeanBuilder
+
withParam(String, InvokerInfo) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticBeanBuilder
Adds an invoker-valued parameter to the parameter map.
-
withParam(String, InvokerInfo) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticObserverBuilder
+
withParam(String, InvokerInfo) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticObserverBuilder
Adds an invoker-valued parameter to the parameter map.
-
withParam(String, InvokerInfo[]) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticBeanBuilder
+
withParam(String, InvokerInfo[]) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticBeanBuilder
Adds an invoker array-valued parameter to the parameter map.
-
withParam(String, InvokerInfo[]) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticObserverBuilder
+
withParam(String, InvokerInfo[]) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticObserverBuilder
Adds an invoker array-valued parameter to the parameter map.
-
withParam(String, AnnotationInfo) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticBeanBuilder
+
withParam(String, AnnotationInfo) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticBeanBuilder
Adds an annotation-valued parameter to the parameter map.
-
withParam(String, AnnotationInfo) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticObserverBuilder
+
withParam(String, AnnotationInfo) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticObserverBuilder
Adds an annotation-valued parameter to the parameter map.
-
withParam(String, AnnotationInfo[]) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticBeanBuilder
+
withParam(String, AnnotationInfo[]) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticBeanBuilder
Adds an annotation array-valued parameter to the parameter map.
-
withParam(String, AnnotationInfo[]) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticObserverBuilder
+
withParam(String, AnnotationInfo[]) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticObserverBuilder
Adds an annotation array-valued parameter to the parameter map.
-
withParam(String, ClassInfo) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticBeanBuilder
+
withParam(String, ClassInfo) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticBeanBuilder
Adds a Class-valued parameter to the parameter map.
-
withParam(String, ClassInfo) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticObserverBuilder
+
withParam(String, ClassInfo) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticObserverBuilder
Adds a Class-valued parameter to the parameter map.
-
withParam(String, ClassInfo[]) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticBeanBuilder
+
withParam(String, ClassInfo[]) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticBeanBuilder
Adds a Class array-valued parameter to the parameter map.
-
withParam(String, ClassInfo[]) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticObserverBuilder
+
withParam(String, ClassInfo[]) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticObserverBuilder
Adds a Class array-valued parameter to the parameter map.
-
withParam(String, Annotation) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticBeanBuilder
+
withParam(String, Annotation) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticBeanBuilder
Adds an annotation-valued parameter to the parameter map.
-
withParam(String, Annotation) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticObserverBuilder
+
withParam(String, Annotation) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticObserverBuilder
Adds an annotation-valued parameter to the parameter map.
-
withParam(String, Annotation[]) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticBeanBuilder
+
withParam(String, Annotation[]) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticBeanBuilder
Adds an annotation array-valued parameter to the parameter map.
-
withParam(String, Annotation[]) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticObserverBuilder
+
withParam(String, Annotation[]) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticObserverBuilder
Adds an annotation array-valued parameter to the parameter map.
-
withParam(String, Class<?>) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticBeanBuilder
+
withParam(String, Class<?>) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticBeanBuilder
Adds a Class-valued parameter to the parameter map.
-
withParam(String, Class<?>) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticObserverBuilder
+
withParam(String, Class<?>) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticObserverBuilder
Adds a Class-valued parameter to the parameter map.
-
withParam(String, Class<?>[]) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticBeanBuilder
+
withParam(String, Class<?>[]) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticBeanBuilder
Adds a Class array-valued parameter to the parameter map.
-
withParam(String, Class<?>[]) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticObserverBuilder
+
withParam(String, Class<?>[]) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticObserverBuilder
Adds a Class array-valued parameter to the parameter map.
-
withParam(String, Enum<?>) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticBeanBuilder
+
withParam(String, Enum<?>) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticBeanBuilder
Adds an enum-valued parameter to the parameter map.
-
withParam(String, Enum<?>) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticObserverBuilder
+
withParam(String, Enum<?>) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticObserverBuilder
Adds an enum-valued parameter to the parameter map.
-
withParam(String, Enum<?>[]) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticBeanBuilder
+
withParam(String, Enum<?>[]) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticBeanBuilder
Adds an enum array-valued parameter to the parameter map.
-
withParam(String, Enum<?>[]) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticObserverBuilder
+
withParam(String, Enum<?>[]) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticObserverBuilder
Adds an enum array-valued parameter to the parameter map.
-
withParam(String, String) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticBeanBuilder
+
withParam(String, String) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticBeanBuilder
Adds a String-valued parameter to the parameter map.
-
withParam(String, String) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticObserverBuilder
+
withParam(String, String) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticObserverBuilder
Adds a String-valued parameter to the parameter map.
-
withParam(String, String[]) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticBeanBuilder
+
withParam(String, String[]) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticBeanBuilder
Adds a String array-valued parameter to the parameter map.
-
withParam(String, String[]) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticObserverBuilder
+
withParam(String, String[]) - Method in interface jakarta.enterprise.inject.build.compatible.spi.SyntheticObserverBuilder
Adds a String array-valued parameter to the parameter map.
-
withSubtypes() - Method in annotation type jakarta.enterprise.inject.build.compatible.spi.Enhancement
+
withSubtypes() - Element in annotation interface jakarta.enterprise.inject.build.compatible.spi.Enhancement
If true, the set of expected types includes all direct and - indirect subtypes of given types.
+ indirect subtypes of given types.
-
wrapExpressionFactory(ExpressionFactory) - Method in interface jakarta.enterprise.inject.spi.BeanManager
+
wrapExpressionFactory(ExpressionFactory) - Method in interface jakarta.enterprise.inject.spi.BeanManager
-
Deprecated, for removal: This API element is subject to removal in a future version. -
use ELAwareBeanManager, this method will be removed in CDI 5.0
+
Deprecated, for removal: This API element is subject to removal in a future version. +
use ELAwareBeanManager, this method will be removed in CDI 5.0
+
wrapExpressionFactory(ExpressionFactory) - Method in interface jakarta.enterprise.inject.spi.el.ELAwareBeanManager
+
+
Returns a wrapper ExpressionFactory that delegates MethodExpression and + ValueExpression creation to the given ExpressionFactory.
+
-A B C D E F G H I J L M N O P Q R S T U V W 
All Classes All Packages - +A B C D E F G H I J K L M N O P Q R S T U V W 
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form - - - -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

- diff --git a/cdi/4.1/apidocs/index.html b/cdi/4.1/apidocs/index.html index 4280620bce..a6cb18df31 100644 --- a/cdi/4.1/apidocs/index.html +++ b/cdi/4.1/apidocs/index.html @@ -1,105 +1,59 @@ - - + Overview (Jakarta Contexts and Dependency Injection API) + + + + - - + - - - - - + + - - -
+
+ +

Jakarta Contexts and Dependency Injection API

-
-
Version: 4.1.0-M1, 2023-11-30T18:10:05Z +
Version: 4.1.0, 2024-03-08T20:20:18Z

Contexts and Dependency Injection (CDI) defines a set of complementary services that help improve the structure of application @@ -113,109 +67,119 @@

Jakarta Contexts and Dependency Injection API

CDI allows objects to be bound to lifecycle contexts, to be injected, to be associated with interceptors and decorators, and to interact in a loosely coupled fashion by - firing and - observing events. - Various kinds of objects are + firing and + observing events. + Various kinds of objects are injectable, including EJB 3 session beans, managed beans, - producer methods and + producer methods and Jakarta EE resources. We refer to these objects in general terms as beans and to instances of beans that are bound to contexts as contextual instances.

+
+
Packages
+
+
Package
+
Description
+ +
+
+ Annotations relating to decorators.
+
+ +
+
+ Annotations and interfaces relating to scopes and contexts.
+
+ +
 
+ +
+
+ The custom context SPI.
+
+ +
+
+ Annotations and interfaces relating to events.
+
+ +
 
+ +
+
+ The build compatible extension SPI.
+
+ +
 
+ +
 
+ +
+
+ The portable extension integration SPI.
+
+ +
 
+ +
 
+ +
 
+ +
+
The core interfaces of the language model that represent + annotations and + annotation targets.
+
+ +
+
Interfaces that represent declarations.
+
+ +
+
Interfaces that represent types.
+
+ +
+
Contains shared, general-purpose helper classes and annotations.
+
-
- - - - - - - - - - - - -
Modules 
ModuleDescription
jakarta.cdi 
- - - -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

- diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/decorator/Decorator.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/decorator/Decorator.html deleted file mode 100644 index 13bcc0a85e..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/decorator/Decorator.html +++ /dev/null @@ -1,218 +0,0 @@ - - - - - -Decorator (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Annotation Type Decorator

-
-
-
-
    -
  • -
    -
    @Target(TYPE)
    -@Retention(RUNTIME)
    -@Documented
    -@Stereotype
    -public @interface Decorator
    -

    - Specifies that a class is a decorator. May be applied to a managed bean class. -

    - -
    - @Decorator 
    - class TimestampLogger implements Logger { ... }
    - 
    - -

    - Decorators of a session bean must comply with the bean provider programming restrictions defined by the EJB specification. - Decorators of a stateful session bean must comply with the rules for instance passivation and conversational state defined by - the EJB specification. -

    - -

    CDI Lite implementations are not required to provide support for decorators.

    -
    -
    Author:
    -
    Gavin King, Pete Muir
    -
    See Also:
    -
    Delegate identifies the delegate injection point of a decorator.
    -
    -
  • -
-
-
-
- -
- -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

-
- - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/decorator/Delegate.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/decorator/Delegate.html deleted file mode 100644 index c07bf7d15b..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/decorator/Delegate.html +++ /dev/null @@ -1,252 +0,0 @@ - - - - - -Delegate (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Annotation Type Delegate

-
-
-
-
    -
  • -
    -
    @Target({FIELD,PARAMETER})
    -@Retention(RUNTIME)
    -@Documented
    -public @interface Delegate
    -

    - Identifies the delegate injection point of a decorator. May be applied to a field, bean constructor parameter or initializer - method parameter of a decorator bean class. -

    - -
    - @Decorator 
    - class TimestampLogger implements Logger { 
    -    @Inject @Delegate @Any Logger logger; 
    -    ... 
    - }
    - 
    - -
    - @Decorator 
    - class TimestampLogger implements Logger { 
    -    private Logger logger;
    -    
    -    @Inject
    -    public TimestampLogger(@Delegate @Debug Logger logger) { 
    -       this.logger=logger; 
    -    } 
    -    ... 
    - }
    - 
    - -

    - A decorator must have exactly one delegate injection point. The delegate injection point must be an injected field, - initializer method parameter or bean constructor method parameter. -

    - -

    - The container injects a delegate object to the delegate injection point. The delegate object implements the delegate type and - delegates method invocations along the decorator stack. When the container calls a decorator during business method - interception, the decorator may invoke any method of the delegate object. If a decorator invokes the delegate object at any - other time, the invoked method throws an IllegalStateException. -

    - -
    - @Decorator 
    - class TimestampLogger implements Logger { 
    -    @Inject @Delegate @Any Logger logger; 
    -    
    -    void log(String message) {
    -       logger.log( timestamp() + ": " + message );
    -    }
    -    ...
    - }
    - 
    - -

    CDI Lite implementations are not required to provide support for decorators.

    -
    -
    Author:
    -
    Gavin King, Pete Muir
    -
    See Also:
    -
    Decorator specifies that a class is a decorator.
    -
    -
  • -
-
-
-
- -
- -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

-
- - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/decorator/class-use/Decorator.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/decorator/class-use/Decorator.html deleted file mode 100644 index 05c3118fdf..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/decorator/class-use/Decorator.html +++ /dev/null @@ -1,153 +0,0 @@ - - - - - -Uses of Class jakarta.decorator.Decorator (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Class
jakarta.decorator.Decorator

-
-
No usage of jakarta.decorator.Decorator
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/decorator/class-use/Delegate.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/decorator/class-use/Delegate.html deleted file mode 100644 index 20f389f190..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/decorator/class-use/Delegate.html +++ /dev/null @@ -1,153 +0,0 @@ - - - - - -Uses of Class jakarta.decorator.Delegate (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Class
jakarta.decorator.Delegate

-
-
No usage of jakarta.decorator.Delegate
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/decorator/package-summary.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/decorator/package-summary.html deleted file mode 100644 index 04bf64bd2b..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/decorator/package-summary.html +++ /dev/null @@ -1,262 +0,0 @@ - - - - - -jakarta.decorator (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-
Module jakarta.cdi
-

Package jakarta.decorator

-
-
-
- - -

Annotations relating to decorators.

- -

A decorator implements one or more bean types and - intercepts business method invocations of - beans which - implement those bean types. These bean types are called - decorated types.

- -

A decorator is a managed bean annotated @Decorator.

- -

Decorators are superficially similar to interceptors, - but because they directly implement operations with business - semantics, they are able to implement business logic and, - conversely, unable to implement the cross-cutting concerns - for which interceptors are optimized. Decorators are called - after interceptors.

- -

Decorated types

- -

The set of decorated types of a decorator includes all - bean types of the managed bean that are Java interfaces, - except for Serializable. The decorator bean - class and its superclasses are not decorated types of the - decorator. The decorator class may be abstract.

- -

A decorator intercepts every method:

-
    -
  • declared by a decorated type of the decorator
  • -
  • that is implemented by the bean class of the decorator.
  • -
- -

A decorator may be an abstract class, and is not required to - implement every method of every decorated type.

- -

Delegate injection points

- -

All decorators have a - delegate injection point. - A delegate injection point is an injection point of the bean - class annotated @Delegate.

- -

The type of the delegate injection point must implement or - extend every decorated type. A decorator is not required to - implement the type of the delegate injection point.

- -

Enabled decorators

- -

By default, a bean archive has no enabled decorators. A - decorator must be explicitly enabled by listing its bean class - under the <decorators> element of the - beans.xml file of the bean archive. The order of the - decorator declarations determines the decorator ordering. - Decorators which occur earlier in the list are called first.

- -

A decorator is bound to a bean if:

- -
    -
  • The bean is eligible for injection - to the delegate injection point of the decorator.
  • -
  • The decorator is enabled in the bean archive of the bean.
  • -
- -

If a managed bean class is declared final, it may not have - decorators. If a managed bean has a non-static, non-private, - final method, it may not have any decorator which implements - that method.

- -

A decorator instance is a - dependent object - of the object it decorates.

-
-
See Also:
-
jakarta.enterprise.inject, -Decorator, -Delegate
-
-
-
    -
  • - - - - - - - - - - - - - - - - -
    Annotation Types Summary 
    Annotation TypeDescription
    Decorator -
    - Specifies that a class is a decorator.
    -
    Delegate -
    - Identifies the delegate injection point of a decorator.
    -
    -
  • -
-
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/decorator/package-tree.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/decorator/package-tree.html deleted file mode 100644 index aeb9e7dfed..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/decorator/package-tree.html +++ /dev/null @@ -1,165 +0,0 @@ - - - - - -jakarta.decorator Class Hierarchy (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Hierarchy For Package jakarta.decorator

-Package Hierarchies: - -
-
-
-

Annotation Type Hierarchy

-
    -
  • jakarta.decorator.Decorator (implements java.lang.annotation.Annotation)
  • -
  • jakarta.decorator.Delegate (implements java.lang.annotation.Annotation)
  • -
-
-
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/decorator/package-use.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/decorator/package-use.html deleted file mode 100644 index dc335ab53a..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/decorator/package-use.html +++ /dev/null @@ -1,153 +0,0 @@ - - - - - -Uses of Package jakarta.decorator (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Package
jakarta.decorator

-
-
No usage of jakarta.decorator
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/ApplicationScoped.Literal.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/ApplicationScoped.Literal.html deleted file mode 100644 index 72cf994533..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/ApplicationScoped.Literal.html +++ /dev/null @@ -1,370 +0,0 @@ - - - - - -ApplicationScoped.Literal (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Class ApplicationScoped.Literal

-
-
- -
- -
-
- -
-
- -
-
-
- - - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/ApplicationScoped.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/ApplicationScoped.html deleted file mode 100644 index 4643edbe13..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/ApplicationScoped.html +++ /dev/null @@ -1,245 +0,0 @@ - - - - - -ApplicationScoped (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Annotation Type ApplicationScoped

-
-
-
-
    -
  • -
    -
    @Target({TYPE,METHOD,FIELD})
    -@Retention(RUNTIME)
    -@Documented
    -@NormalScope
    -@Inherited
    -public @interface ApplicationScoped
    -

    - Specifies that a bean is application scoped. -

    -

    - While ApplicationScoped must be associated with the built-in application context required by the specification, - third-party extensions are - allowed to also associate it with their own context. Behavior described below is only related to the built-in application context. -

    - -

    - The application scope is active: -

    - -
      -
    • during the service() method of any servlet in the web application, during the doFilter() method of any - servlet filter and when the container calls any ServletContextListener, HttpSessionListener, - AsyncListener or ServletRequestListener,
    • -
    • during any Java EE web service invocation,
    • -
    • 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,
    • -
    • when the disposer method or @PreDestroy callback of any bean with any normal scope other than - @ApplicationScoped is called, and
    • -
    • during @PostConstruct callback of any bean.
    • -
    - -

    - 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 - application. -

    -

    - The application context is destroyed when the application is shut down. -

    - -

    - An event with qualifier @Initialized(ApplicationScoped.class) is fired when the application context is initialized - and an event with qualifier @Destroyed(ApplicationScoped.class) when the application context is destroyed. - The event payload is: -

    - -
      -
    • the ServletContext if the application is a web application deployed to a Servlet container, or
    • -
    • any java.lang.Object for other types of application.
    • -
    -
    -
    Author:
    -
    Gavin King, Pete Muir, Antoine Sabot-Durand
    -
    -
  • -
-
-
-
- -
- -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

-
- - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/BeforeDestroyed.Literal.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/BeforeDestroyed.Literal.html deleted file mode 100644 index b363093cb5..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/BeforeDestroyed.Literal.html +++ /dev/null @@ -1,420 +0,0 @@ - - - - - -BeforeDestroyed.Literal (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Class BeforeDestroyed.Literal

-
-
- -
- -
-
- -
-
- -
-
-
- - - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/BeforeDestroyed.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/BeforeDestroyed.html deleted file mode 100644 index 01031c15aa..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/BeforeDestroyed.html +++ /dev/null @@ -1,267 +0,0 @@ - - - - - -BeforeDestroyed (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Annotation Type BeforeDestroyed

-
-
-
-
    -
  • -
    -
    @Qualifier
    -@Target({TYPE,METHOD,PARAMETER,FIELD})
    -@Retention(RUNTIME)
    -@Documented
    -public @interface BeforeDestroyed
    -
    An event with this qualifier is fired when a context is about to be destroyed, i.e. before the actual destruction.
    -
    -
    Since:
    -
    2.0
    -
    Author:
    -
    Pete Muir, Martin Kouba
    -
    See Also:
    -
    Initialized, -Destroyed
    -
    -
  • -
-
-
-
    -
  • - -
    -
      -
    • - - -

      Required Element Summary

      - - - - - - - - - - - - -
      Required Elements 
      Modifier and TypeRequired ElementDescription
      java.lang.Class<? extends java.lang.annotation.Annotation>value -
      The scope for which to observe destruction
      -
      -
    • -
    -
    -
  • -
-
-
-
    -
  • - -
    -
      -
    • - - -

      Element Detail

      - - - -
        -
      • -

        value

        -
        java.lang.Class<? extends java.lang.annotation.Annotation> value
        -
        The scope for which to observe destruction
        -
        -
        Returns:
        -
        the scope type class
        -
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- - - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/BusyConversationException.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/BusyConversationException.html deleted file mode 100644 index c3c7d4939e..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/BusyConversationException.html +++ /dev/null @@ -1,366 +0,0 @@ - - - - - -BusyConversationException (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Class BusyConversationException

-
-
-
    -
  • java.lang.Object
  • -
  • - -
  • -
-
-
    -
  • -
    -
    All Implemented Interfaces:
    -
    java.io.Serializable
    -
    -
    -
    public class BusyConversationException
    -extends ContextException
    -

    - Indicates that the container has rejected a request because a concurrent request is associated with the same conversation - context. -

    - -

    - The container ensures that a long-running conversation may be associated with at most one request at a time, by blocking or - rejecting concurrent requests. If the container rejects a request, it must associate the request with a new transient - conversation and throw an exception of type BusyConversationException from the restore view phase of the JSF - lifecycle. -

    - -

    CDI Lite implementations are not required to provide support for conversations.

    -
    -
    Author:
    -
    Pete Muir, Gavin King
    -
    See Also:
    -
    ConversationScoped, -Serialized Form
    -
    -
  • -
-
-
-
    -
  • - -
    - -
    - -
    -
      -
    • - - -

      Method Summary

      -
        -
      • - - -

        Methods inherited from class java.lang.Throwable

        -addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
      • -
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

        -clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
      • -
      -
    • -
    -
    -
  • -
-
-
-
    -
  • - -
    -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        BusyConversationException

        -
        public BusyConversationException()
        -
      • -
      - - - -
        -
      • -

        BusyConversationException

        -
        public BusyConversationException​(java.lang.String message)
        -
      • -
      - - - -
        -
      • -

        BusyConversationException

        -
        public BusyConversationException​(java.lang.Throwable cause)
        -
      • -
      - - - -
        -
      • -

        BusyConversationException

        -
        public BusyConversationException​(java.lang.String message,
        -                                 java.lang.Throwable cause)
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- - - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/ContextException.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/ContextException.html deleted file mode 100644 index cd2248bdc2..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/ContextException.html +++ /dev/null @@ -1,354 +0,0 @@ - - - - - -ContextException (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Class ContextException

-
-
-
    -
  • java.lang.Object
  • -
  • -
      -
    • java.lang.Throwable
    • -
    • -
        -
      • java.lang.Exception
      • -
      • -
          -
        • java.lang.RuntimeException
        • -
        • -
            -
          • jakarta.enterprise.context.ContextException
          • -
          -
        • -
        -
      • -
      -
    • -
    -
  • -
-
- -
-
-
    -
  • - -
    - -
    - -
    -
      -
    • - - -

      Method Summary

      -
        -
      • - - -

        Methods inherited from class java.lang.Throwable

        -addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
      • -
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

        -clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
      • -
      -
    • -
    -
    -
  • -
-
-
-
    -
  • - -
    -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        ContextException

        -
        public ContextException()
        -
      • -
      - - - -
        -
      • -

        ContextException

        -
        public ContextException​(java.lang.String message)
        -
      • -
      - - - -
        -
      • -

        ContextException

        -
        public ContextException​(java.lang.Throwable cause)
        -
      • -
      - - - -
        -
      • -

        ContextException

        -
        public ContextException​(java.lang.String message,
        -                        java.lang.Throwable cause)
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- - - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/ContextNotActiveException.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/ContextNotActiveException.html deleted file mode 100644 index 3151e35530..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/ContextNotActiveException.html +++ /dev/null @@ -1,356 +0,0 @@ - - - - - -ContextNotActiveException (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Class ContextNotActiveException

-
-
-
    -
  • java.lang.Object
  • -
  • - -
  • -
-
-
    -
  • -
    -
    All Implemented Interfaces:
    -
    java.io.Serializable
    -
    -
    -
    public class ContextNotActiveException
    -extends ContextException
    -

    - Indicates that a context is not active. -

    -
    -
    Author:
    -
    Pete Muir, Shane Bryzak, Gavin King
    -
    See Also:
    -
    Context, -Serialized Form
    -
    -
  • -
-
-
-
    -
  • - -
    - -
    - -
    -
      -
    • - - -

      Method Summary

      -
        -
      • - - -

        Methods inherited from class java.lang.Throwable

        -addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
      • -
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

        -clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
      • -
      -
    • -
    -
    -
  • -
-
-
-
    -
  • - -
    -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        ContextNotActiveException

        -
        public ContextNotActiveException()
        -
      • -
      - - - -
        -
      • -

        ContextNotActiveException

        -
        public ContextNotActiveException​(java.lang.String message)
        -
      • -
      - - - -
        -
      • -

        ContextNotActiveException

        -
        public ContextNotActiveException​(java.lang.Throwable cause)
        -
      • -
      - - - -
        -
      • -

        ContextNotActiveException

        -
        public ContextNotActiveException​(java.lang.String message,
        -                                 java.lang.Throwable cause)
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- - - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/Conversation.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/Conversation.html deleted file mode 100644 index 7e98482581..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/Conversation.html +++ /dev/null @@ -1,441 +0,0 @@ - - - - - -Conversation (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Interface Conversation

-
-
-
-
    -
  • -
    -
    public interface Conversation
    -

    - Allows the application to manage the conversation context by marking - the current conversation as transient or long-running, specifying a conversation identifier, or setting the conversation - timeout. -

    - -

    - An instance may be injected: -

    - -
    - @Inject
    - Conversation conversation;
    - 
    - -

    - 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. -

    - -

    CDI Lite implementations are not required to provide support for conversations.

    -
    -
    Author:
    -
    Pete Muir, Gavin King
    -
    See Also:
    -
    ConversationScoped
    -
    -
  • -
-
-
-
    -
  • - -
    -
      -
    • - - -

      Method Summary

      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      All Methods Instance Methods Abstract Methods 
      Modifier and TypeMethodDescription
      voidbegin() -
      - Mark the current transient conversation long-running.
      -
      voidbegin​(java.lang.String id) -
      - Mark the current transient conversation long-running, with a specified identifier.
      -
      voidend() -
      - Marks the current long-running conversation transient.
      -
      java.lang.StringgetId() -
      - Get the identifier of the current long-running conversation.
      -
      longgetTimeout() -
      - Get the timeout of the current conversation.
      -
      booleanisTransient() -
      - Determine if the conversation is marked transient or long-running.
      -
      voidsetTimeout​(long milliseconds) -
      - Set the timeout of the current conversation.
      -
      -
    • -
    -
    -
  • -
-
-
-
    -
  • - -
    -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        begin

        -
        void begin()
        -

        - Mark the current transient conversation long-running. A conversation identifier is generated by the container. -

        -
        -
        Throws:
        -
        java.lang.IllegalStateException - if the current conversation is already marked long-running.
        -
        -
      • -
      - - - -
        -
      • -

        begin

        -
        void begin​(java.lang.String id)
        -

        - Mark the current transient conversation long-running, with a specified identifier. -

        -
        -
        Parameters:
        -
        id - conversation id
        -
        Throws:
        -
        java.lang.IllegalStateException - if the current conversation is already marked long-running.
        -
        java.lang.IllegalArgumentException - if a conversation with the specified identifier already exists.
        -
        -
      • -
      - - - -
        -
      • -

        end

        -
        void end()
        -

        - Marks the current long-running conversation transient. -

        -
        -
        Throws:
        -
        java.lang.IllegalStateException - if the current conversation is already marked transient.
        -
        -
      • -
      - - - -
        -
      • -

        getId

        -
        java.lang.String getId()
        -

        - Get the identifier of the current long-running conversation. -

        -
        -
        Returns:
        -
        the identifier of the current long-running conversation, or a null value if the current conversation is - transient.
        -
        -
      • -
      - - - -
        -
      • -

        getTimeout

        -
        long getTimeout()
        -

        - Get the timeout of the current conversation. -

        -
        -
        Returns:
        -
        the current timeout in milliseconds.
        -
        -
      • -
      - - - -
        -
      • -

        setTimeout

        -
        void setTimeout​(long milliseconds)
        -

        - Set the timeout of the current conversation. -

        -
        -
        Parameters:
        -
        milliseconds - the new timeout in milliseconds.
        -
        -
      • -
      - - - -
        -
      • -

        isTransient

        -
        boolean isTransient()
        -

        - Determine if the conversation is marked transient or long-running. -

        -
        -
        Returns:
        -
        true if the conversation is marked transient, or falseif it is marked long-running.
        -
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- -
- -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

-
- - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/ConversationScoped.Literal.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/ConversationScoped.Literal.html deleted file mode 100644 index 98cd893fa9..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/ConversationScoped.Literal.html +++ /dev/null @@ -1,370 +0,0 @@ - - - - - -ConversationScoped.Literal (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Class ConversationScoped.Literal

-
-
- -
- -
-
- -
-
- -
-
-
- - - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/ConversationScoped.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/ConversationScoped.html deleted file mode 100644 index c59b9719de..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/ConversationScoped.html +++ /dev/null @@ -1,302 +0,0 @@ - - - - - -ConversationScoped (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Annotation Type ConversationScoped

-
-
-
-
    -
  • -
    -
    @Target({TYPE,METHOD,FIELD})
    -@Retention(RUNTIME)
    -@Documented
    -@NormalScope(passivating=true)
    -@Inherited
    -public @interface ConversationScoped
    -

    - Specifies that a bean is conversation scoped. -

    -

    - While ConversationScoped must be associated with the built-in conversation context required by the specification, - third-party extensions are - allowed to also associate it with their own context. Behavior described below is only related to the built-in conversation context. -

    -

    - The conversation scope is active: -

    -
      -
    • during all Servlet requests.
    • -
    -

    - An event with qualifier @Initialized(ConversationScoped.class) is fired when the conversation context is initialized - and an event with qualifier @Destroyed(ConversationScoped.class) is fired when the conversation is destroyed. - The event payload is: -

    -
      -
    • the conversation id if the conversation context is destroyed and is not associated with a current Servlet request, or
    • -
    • the ServletRequest if the application is a web application deployed to a Servlet container, or
    • -
    • any java.lang.Object for other types of application.
    • -
    - -

    - The conversation context provides access to state associated with a particular conversation. Every Servlet request - has an associated conversation. This association is managed automatically by the container according to the following rules: -

    - -
      -
    • Any Servlet request has exactly one associated conversation.
    • -
    • The container provides a filter with the name "CDI Conversation Filter", which may be mapped in web.xml, - allowing the user alter when the conversation is associated with the servlet request. If this filter is not mapped in any - web.xml in the application, the conversation associated with a Servlet request is determined at the beginning of the - request before calling any service() method of any servlet in the web application, calling the doFilter() - method of any servlet filter in the web application and before the container calls any ServletRequestListener or - AsyncListener in the web application.
    • -
    - - -

    - Any conversation is in one of two states: transient or long-running. -

    - -
      -
    • By default, a conversation is transient
    • -
    • A transient conversation may be marked long-running by calling Conversation.begin()
    • -
    • A long-running conversation may be marked transient by calling Conversation.end()
    • -
    - -

    - All long-running conversations have a string-valued unique identifier, which may be set by the application when the - conversation is marked long-running, or generated by the container. -

    - -

    - If the conversation associated with the current Servlet request is in the transient state at the end of a Servlet - request, it is destroyed, and the conversation context is also destroyed. -

    - -

    - If the conversation associated with the current Servlet request is in the long-running state at the end of a Servlet - request, it is not destroyed. The long-running conversation associated with a request may be propagated to any Servlet - request via use of a request parameter named cid containing the unique identifier of the conversation. In this - case, the application must manage this request parameter. -

    - -

    - If the current Servlet request is a JSF request, and the conversation is in long-running state, it is propagated - according to the following rules: -

    - -
      -
    • The long-running conversation context associated with a request that renders a JSF view is automatically propagated to - any faces request (JSF form submission) that originates from that rendered page.
    • -
    • The long-running conversation context associated with a request that results in a JSF redirect (a redirect resulting from - a navigation rule or JSF NavigationHandler) is automatically propagated to the resulting non-faces request, and to any other - subsequent request to the same URL. This is accomplished via use of a request parameter named cid containing the - unique identifier of the conversation.
    • -
    - -

    - When no conversation is propagated to a Servlet request, or if a request parameter named conversationPropagation has - the value none the request is associated with a new transient conversation. - All long-running conversations are scoped to a particular HTTP servlet session and may not cross session boundaries. - In the following cases, a propagated long-running conversation cannot be restored and re-associated with the request: -

    - -
      -
    • When the HTTP servlet session is invalidated, all long-running conversation contexts created during the current session - are destroyed, after the servlet service() method completes.
    • -
    • The container is permitted to arbitrarily destroy any long-running conversation that is associated with no current - Servlet request, in order to conserve resources.
    • -
    - -

    CDI Lite implementations are not required to provide support for conversations.

    -
    -
    Author:
    -
    Gavin King, Pete Muir, Antoine Sabot-Durand
    -
    See Also:
    -
    Conversation, -NonexistentConversationException, -BusyConversationException
    -
    -
  • -
-
-
-
- -
- -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

-
- - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/Dependent.Literal.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/Dependent.Literal.html deleted file mode 100644 index ea5e09c890..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/Dependent.Literal.html +++ /dev/null @@ -1,370 +0,0 @@ - - - - - -Dependent.Literal (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Class Dependent.Literal

-
-
- -
-
    -
  • -
    -
    All Implemented Interfaces:
    -
    java.lang.annotation.Annotation
    -
    -
    -
    Enclosing class:
    -
    Dependent
    -
    -
    -
    public static final class Dependent.Literal
    -extends AnnotationLiteral<Dependent>
    -implements Dependent
    -
    Supports inline instantiation of the Dependent annotation.
    -
    -
    Since:
    -
    2.0
    -
    Author:
    -
    Martin Kouba
    -
    See Also:
    -
    Serialized Form
    -
    -
  • -
-
-
-
    -
  • - -
    - -
    - -
    - -
    - -
    -
      -
    • - - -

      Constructor Summary

      - - - - - - - - - - -
      Constructors 
      ConstructorDescription
      Literal() 
      -
    • -
    -
    - -
    -
      -
    • - - -

      Method Summary

      - -
        -
      • - - -

        Methods inherited from class java.lang.Object

        -clone, finalize, getClass, notify, notifyAll, wait, wait, wait
      • -
      -
        -
      • - - -

        Methods inherited from interface java.lang.annotation.Annotation

        -annotationType, equals, hashCode, toString
      • -
      -
    • -
    -
    -
  • -
-
-
-
    -
  • - -
    - -
    - -
    -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        Literal

        -
        public Literal()
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- - - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/Dependent.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/Dependent.html deleted file mode 100644 index 1c49b0df88..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/Dependent.html +++ /dev/null @@ -1,258 +0,0 @@ - - - - - -Dependent (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Annotation Type Dependent

-
-
-
-
    -
  • -
    -
    @Target({METHOD,TYPE,FIELD})
    -@Retention(RUNTIME)
    -@Documented
    -@Scope
    -@Inherited
    -public @interface Dependent
    -

    - Specifies that a bean belongs to the dependent pseudo-scope. -

    - -

    - Beans declared with scope @Dependent behave differently to beans with other built-in scope types. When a bean is - declared to have scope @Dependent: -

    - -
      -
    • No injected instance of the bean is ever shared between multiple injection points.
    • -
    • Any instance of the bean injected into an object that is being created by the container is bound to the lifecycle of the - newly created object.
    • -
    • When a Unified EL expression in a JSF or JSP page that refers to the bean by its EL name is evaluated, at most one - instance of the bean is instantiated. This instance exists to service just a single evaluation of the EL expression. It is - reused if the bean EL name appears multiple times in the EL expression, but is never reused when the EL expression is - evaluated again, or when another EL expression is evaluated.
    • -
    • Any instance of the bean that receives a producer method, producer field, disposer method or observer method invocation - exists to service that invocation only.
    • -
    • Any instance of the bean injected into method parameters of a disposer method or observer method exists to service the - method invocation only.
    • -
    - -

    - Every invocation of the Context.get(Contextual, CreationalContext) operation of the - context object for the @Dependent scope returns a new instance of the given bean. -

    - -

    - Every invocation of the Context.get(Contextual) operation of the context object for the - @Dependent scope returns a null value. -

    - -

    - The @Dependent scope is always active. -

    - -

    - Many instances of beans with scope @Dependent belong to some other bean or Java EE component class instance and are - called dependent objects. -

    - -
      -
    • Instances of decorators and interceptors are dependent objects of the bean instance they decorate.
    • -
    • An instance of a bean with scope @Dependent 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.
    • -
    • An instance of a bean with scope @Dependent injected into a producer method is a dependent object of the - producer method bean instance that is being produced.
    • -
    • An instance of a bean with scope @Dependent obtained by direct invocation of an - Instance is a dependent object of the instance of Instance.
    • -
    - -

    - When the container destroys an instance of a bean or of any Java EE component class supporting injection, the container - destroys all its dependent objects, after the @PreDestroy callback completes and after the servlet - destroy() method is called. -

    -
    -
    Author:
    -
    Gavin King, Pete Muir
    -
    -
  • -
-
-
-
- -
- -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

-
- - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/Destroyed.Literal.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/Destroyed.Literal.html deleted file mode 100644 index 58977603ad..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/Destroyed.Literal.html +++ /dev/null @@ -1,422 +0,0 @@ - - - - - -Destroyed.Literal (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Class Destroyed.Literal

-
-
- -
- -
-
- -
-
-
    -
  • - -
    - -
    - -
    -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        of

        -
        public static Destroyed.Literal of​(java.lang.Class<? extends java.lang.annotation.Annotation> value)
        -
      • -
      - - - -
        -
      • -

        value

        -
        public java.lang.Class<? extends java.lang.annotation.Annotation> value()
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- - - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/Destroyed.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/Destroyed.html deleted file mode 100644 index 3eb6cbcf11..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/Destroyed.html +++ /dev/null @@ -1,267 +0,0 @@ - - - - - -Destroyed (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Annotation Type Destroyed

-
-
-
-
    -
  • -
    -
    @Qualifier
    -@Target({TYPE,METHOD,PARAMETER,FIELD})
    -@Retention(RUNTIME)
    -@Documented
    -public @interface Destroyed
    -
    An event with this qualifier is fired when a context is destroyed, i.e. after the actual destruction.
    -
    -
    Since:
    -
    1.1
    -
    Author:
    -
    Pete Muir
    -
    See Also:
    -
    Initialized, -BeforeDestroyed
    -
    -
  • -
-
-
-
    -
  • - -
    -
      -
    • - - -

      Required Element Summary

      - - - - - - - - - - - - -
      Required Elements 
      Modifier and TypeRequired ElementDescription
      java.lang.Class<? extends java.lang.annotation.Annotation>value -
      The scope for which to observe destruction
      -
      -
    • -
    -
    -
  • -
-
-
-
    -
  • - -
    -
      -
    • - - -

      Element Detail

      - - - -
        -
      • -

        value

        -
        java.lang.Class<? extends java.lang.annotation.Annotation> value
        -
        The scope for which to observe destruction
        -
        -
        Returns:
        -
        the scope type class
        -
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- - - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/Initialized.Literal.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/Initialized.Literal.html deleted file mode 100644 index 31bdccb9ab..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/Initialized.Literal.html +++ /dev/null @@ -1,422 +0,0 @@ - - - - - -Initialized.Literal (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Class Initialized.Literal

-
-
- -
- -
-
- -
-
- -
-
-
- - - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/Initialized.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/Initialized.html deleted file mode 100644 index 4131ecf19f..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/Initialized.html +++ /dev/null @@ -1,267 +0,0 @@ - - - - - -Initialized (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Annotation Type Initialized

-
-
-
-
    -
  • -
    -
    @Qualifier
    -@Target({TYPE,METHOD,PARAMETER,FIELD})
    -@Retention(RUNTIME)
    -@Documented
    -public @interface Initialized
    -
    An event with this qualifier is fired when a context is initialized, i.e. ready for use.
    -
    -
    Since:
    -
    1.1
    -
    Author:
    -
    Pete Muir
    -
    See Also:
    -
    BeforeDestroyed, -Destroyed
    -
    -
  • -
-
-
-
    -
  • - -
    -
      -
    • - - -

      Required Element Summary

      - - - - - - - - - - - - -
      Required Elements 
      Modifier and TypeRequired ElementDescription
      java.lang.Class<? extends java.lang.annotation.Annotation>value -
      The scope for which to observe initialization
      -
      -
    • -
    -
    -
  • -
-
-
-
    -
  • - -
    -
      -
    • - - -

      Element Detail

      - - - -
        -
      • -

        value

        -
        java.lang.Class<? extends java.lang.annotation.Annotation> value
        -
        The scope for which to observe initialization
        -
        -
        Returns:
        -
        the scope type class
        -
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- - - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/NonexistentConversationException.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/NonexistentConversationException.html deleted file mode 100644 index 0bcf478e09..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/NonexistentConversationException.html +++ /dev/null @@ -1,363 +0,0 @@ - - - - - -NonexistentConversationException (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Class NonexistentConversationException

-
-
-
    -
  • java.lang.Object
  • -
  • - -
  • -
-
-
    -
  • -
    -
    All Implemented Interfaces:
    -
    java.io.Serializable
    -
    -
    -
    public class NonexistentConversationException
    -extends ContextException
    -

    - Indicates that the conversation context could not be restored. -

    - -

    - If the propagated conversation cannot be restored, the container must associate the request with a new transient conversation - and throw an exception of type NonexistentConversationException. -

    - -

    CDI Lite implementations are not required to provide support for conversations.

    -
    -
    Author:
    -
    Pete Muir, Gavin King
    -
    See Also:
    -
    ConversationScoped, -Serialized Form
    -
    -
  • -
-
-
-
    -
  • - -
    - -
    - -
    -
      -
    • - - -

      Method Summary

      -
        -
      • - - -

        Methods inherited from class java.lang.Throwable

        -addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
      • -
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

        -clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
      • -
      -
    • -
    -
    -
  • -
-
-
-
    -
  • - -
    -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        NonexistentConversationException

        -
        public NonexistentConversationException()
        -
      • -
      - - - -
        -
      • -

        NonexistentConversationException

        -
        public NonexistentConversationException​(java.lang.String message)
        -
      • -
      - - - -
        -
      • -

        NonexistentConversationException

        -
        public NonexistentConversationException​(java.lang.Throwable cause)
        -
      • -
      - - - -
        -
      • -

        NonexistentConversationException

        -
        public NonexistentConversationException​(java.lang.String message,
        -                                        java.lang.Throwable cause)
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- - - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/NormalScope.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/NormalScope.html deleted file mode 100644 index 2635aaf2b4..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/NormalScope.html +++ /dev/null @@ -1,277 +0,0 @@ - - - - - -NormalScope (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Annotation Type NormalScope

-
-
-
-
    -
  • -
    -
    @Target(ANNOTATION_TYPE)
    -@Retention(RUNTIME)
    -@Documented
    -public @interface NormalScope
    -

    - Specifies that an annotation type is a normal scope type. -

    -
    -
    Author:
    -
    Gavin King, Pete Muir
    -
    See Also:
    -
    Scope is used to declare pseudo-scopes.
    -
    -
  • -
-
-
-
    -
  • - -
    -
      -
    • - - -

      Optional Element Summary

      - - - - - - - - - - - - -
      Optional Elements 
      Modifier and TypeOptional ElementDescription
      booleanpassivating -
      - Determines whether the normal scope type is a passivating scope.
      -
      -
    • -
    -
    -
  • -
-
-
-
    -
  • - -
    -
      -
    • - - -

      Element Detail

      - - - -
        -
      • -

        passivating

        -
        boolean passivating
        -

        - Determines whether the normal scope type is a passivating scope. -

        - -

        - A bean is called passivation capable if the container is able to temporarily transfer the state of any idle instance to - secondary storage. A passivating scope requires that beans with the scope are passivation capable. -

        -
        -
        Returns:
        -
        true if the scope type is a passivating scope type
        -
        -
        -
        Default:
        -
        false
        -
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- - - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/RequestScoped.Literal.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/RequestScoped.Literal.html deleted file mode 100644 index 10e5621c91..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/RequestScoped.Literal.html +++ /dev/null @@ -1,370 +0,0 @@ - - - - - -RequestScoped.Literal (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Class RequestScoped.Literal

-
-
- -
- -
-
-
    -
  • - -
    - -
    - -
    - -
    - -
    -
      -
    • - - -

      Constructor Summary

      - - - - - - - - - - -
      Constructors 
      ConstructorDescription
      Literal() 
      -
    • -
    -
    - -
    -
      -
    • - - -

      Method Summary

      - -
        -
      • - - -

        Methods inherited from class java.lang.Object

        -clone, finalize, getClass, notify, notifyAll, wait, wait, wait
      • -
      -
        -
      • - - -

        Methods inherited from interface java.lang.annotation.Annotation

        -annotationType, equals, hashCode, toString
      • -
      -
    • -
    -
    -
  • -
-
-
-
    -
  • - -
    - -
    - -
    -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        Literal

        -
        public Literal()
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- - - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/RequestScoped.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/RequestScoped.html deleted file mode 100644 index cf706729e9..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/RequestScoped.html +++ /dev/null @@ -1,248 +0,0 @@ - - - - - -RequestScoped (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Annotation Type RequestScoped

-
-
-
-
    -
  • -
    -
    @Target({TYPE,METHOD,FIELD})
    -@Retention(RUNTIME)
    -@Documented
    -@NormalScope
    -@Inherited
    -public @interface RequestScoped
    -

    - Specifies that a bean is request scoped. -

    -

    - While RequestScoped must be associated with the built-in request context required by the specification, - third-party extensions are - allowed to also associate it with their own context. Behavior described below is only related to the built-in request context. -

    - -

    - The request scope is active: -

    - -
      -
    • during the service() method of any servlet in the web application, during the doFilter() method of any - servlet filter and when the container calls any ServletRequestListener or AsyncListener,
    • -
    • during any Java EE web service invocation,
    • -
    • 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
    • -
    • during @PostConstruct callback of any bean.
    • -
    - -

    - The request context is destroyed: -

    - -
      -
    • at the end of the servlet request, after the service() method, all doFilter() methods, and all - requestDestroyed() and onComplete() notifications return,
    • -
    • after the web service invocation completes,
    • -
    • after the EJB remote method invocation, asynchronous method invocation, timeout or message delivery completes if it - did not already exist when the invocation occurred, or
    • -
    • after the @PostConstruct callback completes, if it did not already exist when the @PostConstruct - callback occurred.
    • -
    - -

    - An event with qualifier @Initialized(RequestScoped.class) is fired when the request context is initialized and an - event - with qualifier @Destroyed(RequestScoped.class) when the request context is destroyed. The event payload is: -

    - -
      -
    • the ServletRequest if the context is initialized or destroyed due to a servlet request, or
    • -
    • the ServletRequest if the context is initialized or destroyed due to a web service invocation, or
    • -
    • any java.lang.Object for other types of request.
    • -
    -
    -
    Author:
    -
    Gavin King, Pete Muir, Antoine Sabot-Durand
    -
    -
  • -
-
-
-
- -
- -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

-
- - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/SessionScoped.Literal.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/SessionScoped.Literal.html deleted file mode 100644 index b14f8b3f02..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/SessionScoped.Literal.html +++ /dev/null @@ -1,370 +0,0 @@ - - - - - -SessionScoped.Literal (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Class SessionScoped.Literal

-
-
- -
- -
-
-
    -
  • - -
    - -
    - -
    - -
    - -
    -
      -
    • - - -

      Constructor Summary

      - - - - - - - - - - -
      Constructors 
      ConstructorDescription
      Literal() 
      -
    • -
    -
    - -
    -
      -
    • - - -

      Method Summary

      - -
        -
      • - - -

        Methods inherited from class java.lang.Object

        -clone, finalize, getClass, notify, notifyAll, wait, wait, wait
      • -
      -
        -
      • - - -

        Methods inherited from interface java.lang.annotation.Annotation

        -annotationType, equals, hashCode, toString
      • -
      -
    • -
    -
    -
  • -
-
-
-
    -
  • - -
    - -
    - -
    -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        Literal

        -
        public Literal()
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- - - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/SessionScoped.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/SessionScoped.html deleted file mode 100644 index 4a4c76bf83..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/SessionScoped.html +++ /dev/null @@ -1,241 +0,0 @@ - - - - - -SessionScoped (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Annotation Type SessionScoped

-
-
-
-
    -
  • -
    -
    @Target({TYPE,METHOD,FIELD})
    -@Retention(RUNTIME)
    -@Documented
    -@NormalScope(passivating=true)
    -@Inherited
    -public @interface SessionScoped
    -

    - Specifies that a bean is session scoped. -

    -

    - While SessionScoped must be associated with the built-in session context required by the specification, - third-party extensions are - allowed to also associate it with their own context. Behavior described below is only related to the built-in session context. -

    -

    - The session scope is active: -

    - -
      -
    • during the service() method of any servlet in the web application, -
    • during the doFilter() method of any servlet filter, and
    • -
    • when the container calls any HttpSessionListener, AsyncListener or - ServletRequestListener.
    • -
    - -

    - The session context is shared between all servlet requests that occur in the same HTTP session. -

    -

    - The session context is destroyed: -

    - -
      -
    • when the HTTPSession times out, after all HttpSessionListeners have been called, or
    • -
    • at the very end of - any request in which invalidate() was called, after all filters and ServletRequestListeners have been - called.
    • -
    - -

    - An event with qualifier @Initialized(SessionScoped.class) is fired when the session context is initialized and an - event - with qualifier @Destroyed(SessionScoped.class) when the session context is destroyed. The event payload is - the HttpSession - -

    CDI Lite implementations are not required to provide support for the session scope.

    -
    -
    Author:
    -
    Gavin King, Pete Muir, Antoine Sabot-Durand
    -
    -
  • -
-
-
-
- -
- -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

-
- - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/class-use/ApplicationScoped.Literal.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/class-use/ApplicationScoped.Literal.html deleted file mode 100644 index 6ee5262fbd..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/class-use/ApplicationScoped.Literal.html +++ /dev/null @@ -1,199 +0,0 @@ - - - - - -Uses of Class jakarta.enterprise.context.ApplicationScoped.Literal (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Class
jakarta.enterprise.context.ApplicationScoped.Literal

-
-
- -
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/class-use/ApplicationScoped.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/class-use/ApplicationScoped.html deleted file mode 100644 index fab808ee65..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/class-use/ApplicationScoped.html +++ /dev/null @@ -1,153 +0,0 @@ - - - - - -Uses of Class jakarta.enterprise.context.ApplicationScoped (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Class
jakarta.enterprise.context.ApplicationScoped

-
-
No usage of jakarta.enterprise.context.ApplicationScoped
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/class-use/BeforeDestroyed.Literal.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/class-use/BeforeDestroyed.Literal.html deleted file mode 100644 index 9ffbbd688d..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/class-use/BeforeDestroyed.Literal.html +++ /dev/null @@ -1,229 +0,0 @@ - - - - - -Uses of Class jakarta.enterprise.context.BeforeDestroyed.Literal (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Class
jakarta.enterprise.context.BeforeDestroyed.Literal

-
-
- -
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/class-use/BeforeDestroyed.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/class-use/BeforeDestroyed.html deleted file mode 100644 index bfe0c82648..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/class-use/BeforeDestroyed.html +++ /dev/null @@ -1,153 +0,0 @@ - - - - - -Uses of Class jakarta.enterprise.context.BeforeDestroyed (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Class
jakarta.enterprise.context.BeforeDestroyed

-
-
No usage of jakarta.enterprise.context.BeforeDestroyed
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/class-use/BusyConversationException.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/class-use/BusyConversationException.html deleted file mode 100644 index 7ab1d0db7d..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/class-use/BusyConversationException.html +++ /dev/null @@ -1,153 +0,0 @@ - - - - - -Uses of Class jakarta.enterprise.context.BusyConversationException (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Class
jakarta.enterprise.context.BusyConversationException

-
-
No usage of jakarta.enterprise.context.BusyConversationException
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/class-use/ContextException.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/class-use/ContextException.html deleted file mode 100644 index 4520ac7426..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/class-use/ContextException.html +++ /dev/null @@ -1,219 +0,0 @@ - - - - - -Uses of Class jakarta.enterprise.context.ContextException (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Class
jakarta.enterprise.context.ContextException

-
-
- -
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/class-use/ContextNotActiveException.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/class-use/ContextNotActiveException.html deleted file mode 100644 index 024abbf8f9..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/class-use/ContextNotActiveException.html +++ /dev/null @@ -1,199 +0,0 @@ - - - - - -Uses of Class jakarta.enterprise.context.ContextNotActiveException (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Class
jakarta.enterprise.context.ContextNotActiveException

-
-
- -
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/class-use/Conversation.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/class-use/Conversation.html deleted file mode 100644 index 039582a860..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/class-use/Conversation.html +++ /dev/null @@ -1,153 +0,0 @@ - - - - - -Uses of Interface jakarta.enterprise.context.Conversation (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Interface
jakarta.enterprise.context.Conversation

-
-
No usage of jakarta.enterprise.context.Conversation
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/class-use/ConversationScoped.Literal.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/class-use/ConversationScoped.Literal.html deleted file mode 100644 index 0570de2c66..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/class-use/ConversationScoped.Literal.html +++ /dev/null @@ -1,199 +0,0 @@ - - - - - -Uses of Class jakarta.enterprise.context.ConversationScoped.Literal (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Class
jakarta.enterprise.context.ConversationScoped.Literal

-
-
- -
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/class-use/ConversationScoped.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/class-use/ConversationScoped.html deleted file mode 100644 index 8fecf2a58e..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/class-use/ConversationScoped.html +++ /dev/null @@ -1,153 +0,0 @@ - - - - - -Uses of Class jakarta.enterprise.context.ConversationScoped (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Class
jakarta.enterprise.context.ConversationScoped

-
-
No usage of jakarta.enterprise.context.ConversationScoped
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/class-use/Dependent.Literal.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/class-use/Dependent.Literal.html deleted file mode 100644 index be8787d2f6..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/class-use/Dependent.Literal.html +++ /dev/null @@ -1,199 +0,0 @@ - - - - - -Uses of Class jakarta.enterprise.context.Dependent.Literal (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Class
jakarta.enterprise.context.Dependent.Literal

-
-
- -
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/class-use/Dependent.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/class-use/Dependent.html deleted file mode 100644 index b63e0462c5..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/class-use/Dependent.html +++ /dev/null @@ -1,153 +0,0 @@ - - - - - -Uses of Class jakarta.enterprise.context.Dependent (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Class
jakarta.enterprise.context.Dependent

-
-
No usage of jakarta.enterprise.context.Dependent
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/class-use/Destroyed.Literal.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/class-use/Destroyed.Literal.html deleted file mode 100644 index c3f2502dd7..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/class-use/Destroyed.Literal.html +++ /dev/null @@ -1,229 +0,0 @@ - - - - - -Uses of Class jakarta.enterprise.context.Destroyed.Literal (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Class
jakarta.enterprise.context.Destroyed.Literal

-
-
- -
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/class-use/Destroyed.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/class-use/Destroyed.html deleted file mode 100644 index ee9c5bcb3b..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/class-use/Destroyed.html +++ /dev/null @@ -1,153 +0,0 @@ - - - - - -Uses of Class jakarta.enterprise.context.Destroyed (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Class
jakarta.enterprise.context.Destroyed

-
-
No usage of jakarta.enterprise.context.Destroyed
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/class-use/Initialized.Literal.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/class-use/Initialized.Literal.html deleted file mode 100644 index 32fb00eaf5..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/class-use/Initialized.Literal.html +++ /dev/null @@ -1,229 +0,0 @@ - - - - - -Uses of Class jakarta.enterprise.context.Initialized.Literal (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Class
jakarta.enterprise.context.Initialized.Literal

-
-
- -
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/class-use/Initialized.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/class-use/Initialized.html deleted file mode 100644 index ecf1520ec8..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/class-use/Initialized.html +++ /dev/null @@ -1,153 +0,0 @@ - - - - - -Uses of Class jakarta.enterprise.context.Initialized (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Class
jakarta.enterprise.context.Initialized

-
-
No usage of jakarta.enterprise.context.Initialized
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/class-use/NonexistentConversationException.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/class-use/NonexistentConversationException.html deleted file mode 100644 index 914e6ab153..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/class-use/NonexistentConversationException.html +++ /dev/null @@ -1,153 +0,0 @@ - - - - - -Uses of Class jakarta.enterprise.context.NonexistentConversationException (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Class
jakarta.enterprise.context.NonexistentConversationException

-
-
No usage of jakarta.enterprise.context.NonexistentConversationException
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/class-use/NormalScope.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/class-use/NormalScope.html deleted file mode 100644 index 5070f31e43..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/class-use/NormalScope.html +++ /dev/null @@ -1,226 +0,0 @@ - - - - - -Uses of Class jakarta.enterprise.context.NormalScope (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Class
jakarta.enterprise.context.NormalScope

-
-
- -
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/class-use/RequestScoped.Literal.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/class-use/RequestScoped.Literal.html deleted file mode 100644 index d2ddbdfb3e..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/class-use/RequestScoped.Literal.html +++ /dev/null @@ -1,199 +0,0 @@ - - - - - -Uses of Class jakarta.enterprise.context.RequestScoped.Literal (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Class
jakarta.enterprise.context.RequestScoped.Literal

-
-
- -
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/class-use/RequestScoped.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/class-use/RequestScoped.html deleted file mode 100644 index f31e8f67b6..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/class-use/RequestScoped.html +++ /dev/null @@ -1,201 +0,0 @@ - - - - - -Uses of Class jakarta.enterprise.context.RequestScoped (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Class
jakarta.enterprise.context.RequestScoped

-
-
- -
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/class-use/SessionScoped.Literal.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/class-use/SessionScoped.Literal.html deleted file mode 100644 index b49e92dbe3..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/class-use/SessionScoped.Literal.html +++ /dev/null @@ -1,199 +0,0 @@ - - - - - -Uses of Class jakarta.enterprise.context.SessionScoped.Literal (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Class
jakarta.enterprise.context.SessionScoped.Literal

-
-
- -
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/class-use/SessionScoped.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/class-use/SessionScoped.html deleted file mode 100644 index 4249b9abc5..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/class-use/SessionScoped.html +++ /dev/null @@ -1,153 +0,0 @@ - - - - - -Uses of Class jakarta.enterprise.context.SessionScoped (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Class
jakarta.enterprise.context.SessionScoped

-
-
No usage of jakarta.enterprise.context.SessionScoped
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/control/ActivateRequestContext.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/control/ActivateRequestContext.html deleted file mode 100644 index fbe3695e87..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/control/ActivateRequestContext.html +++ /dev/null @@ -1,208 +0,0 @@ - - - - - -ActivateRequestContext (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Annotation Type ActivateRequestContext

-
-
-
-
    -
  • -
    -
    @InterceptorBinding
    -@Target({METHOD,TYPE})
    -@Retention(RUNTIME)
    -@Documented
    -public @interface ActivateRequestContext
    -
    The container provides a built in interceptor that may be used to annotate classes and methods to indicate - that a request context should be activated when this method is invoked. - - The request context will be activated before the method is called, and deactivated when the method invocation is - complete (regardless of any exceptions being thrown). If the context is already active, it is ignored, neither - activated nor deactivated.
    -
    -
    Since:
    -
    2.0
    -
    Author:
    -
    John D. Ament
    -
    -
  • -
-
-
-
- -
- -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

-
- - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/control/RequestContextController.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/control/RequestContextController.html deleted file mode 100644 index 63689bb730..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/control/RequestContextController.html +++ /dev/null @@ -1,316 +0,0 @@ - - - - - -RequestContextController (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Interface RequestContextController

-
-
-
-
    -
  • -
    -
    public interface RequestContextController
    -
    The CDI container provides a built in instance of RequestContextController that is dependent scoped for the purposes - of activating and deactivating. For example: - -
    -    @Inject
    -    private RequestContextController requestContextController;
    -
    -    public void doRequest(String body) {
    -       // activate request context
    -       requestContextController.activate();
    -
    -       // do work in a request context.
    -
    -       // deactivate the request context
    -       requestContextController.deactivate();
    -    }
    - 
    - - Once the request context has been deactivated, you may activate it once again, creating a brand new request context. - The activated request context is bound to the current thread, any injection points targeting a request scoped bean - will be satisfied with the same request scoped objects.
    -
    -
    Since:
    -
    2.0
    -
    Author:
    -
    John D. Ament
    -
    -
  • -
-
-
-
    -
  • - -
    -
      -
    • - - -

      Method Summary

      - - - - - - - - - - - - - - - - - -
      All Methods Instance Methods Abstract Methods 
      Modifier and TypeMethodDescription
      booleanactivate() -
      Activates a RequestContext for the current thread if one is not already active.
      -
      voiddeactivate() -
      Deactivates the current Request Context if it was activated by this context controller.
      -
      -
    • -
    -
    -
  • -
-
-
-
    -
  • - -
    -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        activate

        -
        boolean activate()
        -
        Activates a RequestContext for the current thread if one is not already active.
        -
        -
        Returns:
        -
        true if the context was activated by this invocation, false if not.
        -
        -
      • -
      - - - -
        -
      • -

        deactivate

        -
        void deactivate()
        -         throws ContextNotActiveException
        -
        Deactivates the current Request Context if it was activated by this context controller. If the context is active - but was not activated by this controller, then it may not be deactivated by this controller, - meaning this method will do nothing. - - If the context is not active, a ContextNotActiveException is thrown.
        -
        -
        Throws:
        -
        ContextNotActiveException - if the context is not active
        -
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- -
- -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

-
- - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/control/class-use/ActivateRequestContext.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/control/class-use/ActivateRequestContext.html deleted file mode 100644 index 18204ddd4f..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/control/class-use/ActivateRequestContext.html +++ /dev/null @@ -1,153 +0,0 @@ - - - - - -Uses of Class jakarta.enterprise.context.control.ActivateRequestContext (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Class
jakarta.enterprise.context.control.ActivateRequestContext

-
-
No usage of jakarta.enterprise.context.control.ActivateRequestContext
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/control/class-use/RequestContextController.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/control/class-use/RequestContextController.html deleted file mode 100644 index de8370551f..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/control/class-use/RequestContextController.html +++ /dev/null @@ -1,153 +0,0 @@ - - - - - -Uses of Interface jakarta.enterprise.context.control.RequestContextController (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Interface
jakarta.enterprise.context.control.RequestContextController

-
-
No usage of jakarta.enterprise.context.control.RequestContextController
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/control/package-summary.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/control/package-summary.html deleted file mode 100644 index e979c9d937..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/control/package-summary.html +++ /dev/null @@ -1,193 +0,0 @@ - - - - - -jakarta.enterprise.context.control (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-
Module jakarta.cdi
-

Package jakarta.enterprise.context.control

-
-
-
    -
  • - - - - - - - - - - - - -
    Interface Summary 
    InterfaceDescription
    RequestContextController -
    The CDI container provides a built in instance of RequestContextController that is dependent scoped for the purposes - of activating and deactivating.
    -
    -
  • -
  • - - - - - - - - - - - - -
    Annotation Types Summary 
    Annotation TypeDescription
    ActivateRequestContext -
    The container provides a built in interceptor that may be used to annotate classes and methods to indicate - that a request context should be activated when this method is invoked.
    -
    -
  • -
-
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/control/package-tree.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/control/package-tree.html deleted file mode 100644 index 372c0e7082..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/control/package-tree.html +++ /dev/null @@ -1,170 +0,0 @@ - - - - - -jakarta.enterprise.context.control Class Hierarchy (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Hierarchy For Package jakarta.enterprise.context.control

-Package Hierarchies: - -
-
-
-

Interface Hierarchy

- -
-
-

Annotation Type Hierarchy

- -
-
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/control/package-use.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/control/package-use.html deleted file mode 100644 index 63bf16624b..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/control/package-use.html +++ /dev/null @@ -1,153 +0,0 @@ - - - - - -Uses of Package jakarta.enterprise.context.control (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Package
jakarta.enterprise.context.control

-
-
No usage of jakarta.enterprise.context.control
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/package-summary.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/package-summary.html deleted file mode 100644 index 753e0d3474..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/package-summary.html +++ /dev/null @@ -1,460 +0,0 @@ - - - - - -jakarta.enterprise.context (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-
Module jakarta.cdi
-

Package jakarta.enterprise.context

-
-
-
- - -

Annotations and interfaces relating to scopes and contexts.

- -

A scope type is a Java annotation annotated - @Scope or - @NormalScope. - The scope of a bean determines the lifecycle and visibility of - its instances. In particular, the scope determines:

- -
    -
  • When a new instance of the bean is created
  • -
  • When an existing instance of the bean is destroyed
  • -
  • Which injected references refer to any instance of the - bean
  • -
- -

Built-in scopes

- -

The following built-in scopes are provided: - @Dependent, - @RequestScoped, - @ConversationScoped, - @SessionScoped, - @ApplicationScoped, - @Singleton.

- -

The container provides an implementation of the Context - 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 - JSF requests.

- -

For other kinds of invocations, a portable extension may define a - custom context object - for any or all of the built-in scopes. For example, a third-party web - application framework might provide a conversation context object for - the built-in conversation scope.

- -

The context associated with a built-in scope propagates across - local, synchronous Java method calls, including invocation of EJB - 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.

- -

Normal scopes and pseudo-scopes

- -

Most scopes are normal scopes. Normal scopes are declared - using @NormalScope. - If a bean has a normal scope, every client executing in a certain - thread sees the same contextual instance of the bean. This instance is - called the current instance of the bean. The operation - Context.get(Contextual) of the - context object for a normal scope type always returns the current - instance of the given bean.

- -

Any scope that is not a normal scope is called a pseudo-scope. - Pseudo-scopes are declared using @Scope. - The concept of a current instance is not well-defined in the case of - a pseudo-scope. Different clients executing in the same thread may - see different instances of the bean. In the extreme case of the - @Dependent pseudo-scope, - every client has its own private instance of the bean.

- -

All built-in scopes are normal scopes, except for the - @Dependent and - @Singleton pseudo-scopes.

- -

Contextual and injected reference validity

- -

A reference to a bean obtained from the container via programmatic lookup is called a - contextual reference. A contextual reference for a bean with a normal - scope refers to the current instance of the bean. A contextual - reference for a bean are valid only for a certain period of time. The - application should not invoke a method of an invalid reference.

- -

The validity of a contextual reference for a bean depends upon - whether the scope of the bean is a normal scope or a pseudo-scope:

- -
    -
  • Any reference to a bean with a normal scope is valid as long as - the application maintains a hard reference to it. However, it may - only be invoked when the context associated with the normal scope is - active. If it is invoked when the context is inactive, a - ContextNotActiveException is thrown - by the container.
  • -
  • Any reference to a bean with a pseudo-scope is valid until the - bean instance to which it refers is destroyed. It may be invoked - even if the context associated with the pseudo-scope is not active. - If the application invokes a method of a reference to an instance - that has already been destroyed, the behavior is undefined.
  • -
- -

A reference to a bean obtained from the container via dependency injection is a special kind of - contextual reference, called an injected reference. Additional - restrictions apply to the validity of an injected reference:

- -
    -
  • A reference to a bean injected into a field, bean constructor or - initializer method is only valid until the object into which it was - injected is destroyed.
  • -
  • A reference to a bean injected into a producer method is only - valid until the producer method bean instance that is being produced - is destroyed.
  • -
  • A reference to a bean injected into a disposer method or observer - method is only valid until the invocation of the method completes.
  • -
-
-
See Also:
-
jakarta.enterprise.inject
-
-
- -
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/package-tree.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/package-tree.html deleted file mode 100644 index e4e2b28a6f..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/package-tree.html +++ /dev/null @@ -1,218 +0,0 @@ - - - - - -jakarta.enterprise.context Class Hierarchy (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Hierarchy For Package jakarta.enterprise.context

-Package Hierarchies: - -
-
-
-

Class Hierarchy

- -
-
-

Interface Hierarchy

- -
-
-

Annotation Type Hierarchy

-
    -
  • jakarta.enterprise.context.ApplicationScoped (implements java.lang.annotation.Annotation)
  • -
  • jakarta.enterprise.context.BeforeDestroyed (implements java.lang.annotation.Annotation)
  • -
  • jakarta.enterprise.context.ConversationScoped (implements java.lang.annotation.Annotation)
  • -
  • jakarta.enterprise.context.Dependent (implements java.lang.annotation.Annotation)
  • -
  • jakarta.enterprise.context.Destroyed (implements java.lang.annotation.Annotation)
  • -
  • jakarta.enterprise.context.Initialized (implements java.lang.annotation.Annotation)
  • -
  • jakarta.enterprise.context.NormalScope (implements java.lang.annotation.Annotation)
  • -
  • jakarta.enterprise.context.RequestScoped (implements java.lang.annotation.Annotation)
  • -
  • jakarta.enterprise.context.SessionScoped (implements java.lang.annotation.Annotation)
  • -
-
-
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/package-use.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/package-use.html deleted file mode 100644 index a905ad9278..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/package-use.html +++ /dev/null @@ -1,296 +0,0 @@ - - - - - -Uses of Package jakarta.enterprise.context (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Package
jakarta.enterprise.context

-
-
- -
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/spi/AlterableContext.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/spi/AlterableContext.html deleted file mode 100644 index b95ba8563e..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/spi/AlterableContext.html +++ /dev/null @@ -1,310 +0,0 @@ - - - - - -AlterableContext (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Interface AlterableContext

-
-
-
-
    -
  • -
    -
    All Superinterfaces:
    -
    Context
    -
    -
    -
    public interface AlterableContext
    -extends Context
    -

    - Provides an operation for obtaining and destroying contextual instances with a particular scope of any contextual type. Any - instance of Context is called a context object. -

    - -

    - AlterableContext was introduced in CDI 1.1 to allow bean instances to be destroyed by the application. Extensions - should implement AlterableContext instead of Context. -

    - -

    - The context object is responsible for creating and destroying contextual instances by calling operations of - Contextual. In particular, the context object is responsible for destroying any - contextual instance it creates by passing the instance to - Contextual.destroy(Object, CreationalContext) . A destroyed instance must not - subsequently be returned by get(). The context object must pass the same instance of - CreationalContext to Contextual.destroy() that it passed to - Contextual.create() when it created the instance. -

    - -

    - A custom context object may be registered with the container using - AfterBeanDiscovery.addContext(Context). -

    -
    -
    Since:
    -
    1.1
    -
    Author:
    -
    Pete Muir
    -
    -
  • -
-
-
- -
-
-
    -
  • - -
    -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        destroy

        -
        void destroy​(Contextual<?> contextual)
        -

        - Destroy the existing contextual instance. If there is no existing instance, no action is taken. -

        -
        -
        Parameters:
        -
        contextual - the contextual type
        -
        Throws:
        -
        ContextNotActiveException - if the context is not active
        -
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- -
- -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

-
- - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/spi/Context.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/spi/Context.html deleted file mode 100644 index be06ff216f..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/spi/Context.html +++ /dev/null @@ -1,375 +0,0 @@ - - - - - -Context (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Interface Context

-
-
-
-
    -
  • -
    -
    All Known Subinterfaces:
    -
    AlterableContext
    -
    -
    -
    public interface Context
    -

    - Provides an operation for obtaining contextual instances with a particular scope of any contextual type. Any instance of - Context is called a context object. -

    - -

    - AlterableContext was introduced in CDI 1.1 to allow bean instances to be destroyed by the application. Extensions - should implement AlterableContext instead of Context. -

    - -

    - The context object is responsible for creating and destroying contextual instances by calling operations of - Contextual. In particular, the context object is responsible for destroying any - contextual instance it creates by passing the instance to - Contextual.destroy(Object, CreationalContext) . A destroyed instance must not - subsequently be returned by get(). The context object must pass the same instance of - CreationalContext to Contextual.destroy() that it passed to - Contextual.create() when it created the instance. -

    - -

    - A custom context object may be registered with the container using - AfterBeanDiscovery.addContext(Context). -

    -
    -
    Author:
    -
    Gavin King, Pete Muir
    -
    -
  • -
-
-
-
    -
  • - -
    -
      -
    • - - -

      Method Summary

      - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      All Methods Instance Methods Abstract Methods 
      Modifier and TypeMethodDescription
      <T> Tget​(Contextual<T> contextual) -
      Return an existing instance of a certain contextual type or a null value.
      -
      <T> Tget​(Contextual<T> contextual, - CreationalContext<T> creationalContext) -
      Return an existing instance of certain contextual type or create a new instance by calling - Contextual.create(CreationalContext) and return the new instance.
      -
      java.lang.Class<? extends java.lang.annotation.Annotation>getScope() -
      Get the scope type of the context object.
      -
      booleanisActive() -
      Determines if the context object is active.
      -
      -
    • -
    -
    -
  • -
-
-
-
    -
  • - -
    -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        getScope

        -
        java.lang.Class<? extends java.lang.annotation.Annotation> getScope()
        -
        Get the scope type of the context object.
        -
        -
        Returns:
        -
        the scope
        -
        -
      • -
      - - - -
        -
      • -

        get

        -
        <T> T get​(Contextual<T> contextual,
        -          CreationalContext<T> creationalContext)
        -
        Return an existing instance of certain contextual type or create a new instance by calling - Contextual.create(CreationalContext) and return the new instance.
        -
        -
        Type Parameters:
        -
        T - the type of contextual type
        -
        Parameters:
        -
        contextual - the contextual type
        -
        creationalContext - the context in which the new instance will be created
        -
        Returns:
        -
        the contextual instance
        -
        Throws:
        -
        ContextNotActiveException - if the context is not active
        -
        -
      • -
      - - - -
        -
      • -

        get

        -
        <T> T get​(Contextual<T> contextual)
        -
        Return an existing instance of a certain contextual type or a null value.
        -
        -
        Type Parameters:
        -
        T - the type of the contextual type
        -
        Parameters:
        -
        contextual - the contextual type
        -
        Returns:
        -
        the contextual instance, or a null value
        -
        Throws:
        -
        ContextNotActiveException - if the context is not active
        -
        -
      • -
      - - - -
        -
      • -

        isActive

        -
        boolean isActive()
        -
        Determines if the context object is active.
        -
        -
        Returns:
        -
        true if the context is active, or false otherwise.
        -
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- -
- -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

-
- - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/spi/Contextual.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/spi/Contextual.html deleted file mode 100644 index 9fce412935..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/spi/Contextual.html +++ /dev/null @@ -1,317 +0,0 @@ - - - - - -Contextual (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Interface Contextual<T>

-
-
-
-
    -
  • -
    -
    Type Parameters:
    -
    T - type of the instance
    -
    -
    -
    All Known Subinterfaces:
    -
    Bean<T>, Decorator<T>, Interceptor<T>
    -
    -
    -
    public interface Contextual<T>
    -

    - Defines operations to create and destroy contextual instances of a certain type. Any implementation of Contextual is - called a contextual type. In particular, all beans are contextual types. -

    -
    -
    Author:
    -
    Gavin King, Nicklas Karlsson, Pete Muir
    -
    See Also:
    -
    Bean
    -
    -
  • -
-
-
- -
-
-
    -
  • - -
    -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        create

        -
        T create​(CreationalContext<T> creationalContext)
        -
        Create a new instance of the contextual type. Instances should use the given - CreationalContext when obtaining contextual references to inject, in order to ensure - that any dependent objects are associated with the contextual instance that is being created. An implementation may call - CreationalContext.push(Object) between instantiation and injection to help the - container minimize the use of client proxy objects.
        -
        -
        Parameters:
        -
        creationalContext - the context in which this instance is being created
        -
        Returns:
        -
        the contextual instance
        -
        Throws:
        -
        CreationException - if a checked exception occurs while creating the instance
        -
        -
      • -
      - - - - - -
        -
      • -

        destroy

        -
        void destroy​(T instance,
        -             CreationalContext<T> creationalContext)
        -
        Destroy an instance of the contextual type. Implementations should call - CreationalContext.release() to allow the container to destroy dependent objects of - the contextual instance.
        -
        -
        Parameters:
        -
        instance - the contextual instance to destroy
        -
        creationalContext - the context in which this instance was created
        -
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- -
- -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

-
- - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/spi/CreationalContext.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/spi/CreationalContext.html deleted file mode 100644 index 91da700872..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/spi/CreationalContext.html +++ /dev/null @@ -1,298 +0,0 @@ - - - - - -CreationalContext (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Interface CreationalContext<T>

-
-
-
-
    -
  • -
    -
    Type Parameters:
    -
    T - type of the instances on which this CreationalContext operates
    -
    -
    -
    public interface CreationalContext<T>
    -

    - Provides operations that are used by the Contextual implementation during instance - creation and destruction. -

    -
    -
    Author:
    -
    Gavin King, Pete Muir
    -
    -
  • -
-
-
- -
-
-
    -
  • - -
    -
      -
    • - - -

      Method Detail

      - - - - - -
        -
      • -

        push

        -
        void push​(T incompleteInstance)
        -
        Registers an incompletely initialized contextual instance the with the container. A contextual instance is considered - incompletely initialized until it is returned by - Contextual.create(CreationalContext) .
        -
        -
        Parameters:
        -
        incompleteInstance - the incompletely initialized instance
        -
        -
      • -
      - - - - -
    • -
    -
    -
  • -
-
-
-
- -
- -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

-
- - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/spi/class-use/AlterableContext.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/spi/class-use/AlterableContext.html deleted file mode 100644 index 7e6258e74c..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/spi/class-use/AlterableContext.html +++ /dev/null @@ -1,153 +0,0 @@ - - - - - -Uses of Interface jakarta.enterprise.context.spi.AlterableContext (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Interface
jakarta.enterprise.context.spi.AlterableContext

-
-
No usage of jakarta.enterprise.context.spi.AlterableContext
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/spi/class-use/Context.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/spi/class-use/Context.html deleted file mode 100644 index 7bf3962e10..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/spi/class-use/Context.html +++ /dev/null @@ -1,268 +0,0 @@ - - - - - -Uses of Interface jakarta.enterprise.context.spi.Context (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Interface
jakarta.enterprise.context.spi.Context

-
-
- -
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/spi/class-use/Contextual.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/spi/class-use/Contextual.html deleted file mode 100644 index 3639e74485..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/spi/class-use/Contextual.html +++ /dev/null @@ -1,283 +0,0 @@ - - - - - -Uses of Interface jakarta.enterprise.context.spi.Contextual (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Interface
jakarta.enterprise.context.spi.Contextual

-
-
- -
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/spi/class-use/CreationalContext.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/spi/class-use/CreationalContext.html deleted file mode 100644 index 81ea570c0b..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/spi/class-use/CreationalContext.html +++ /dev/null @@ -1,345 +0,0 @@ - - - - - -Uses of Interface jakarta.enterprise.context.spi.CreationalContext (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Interface
jakarta.enterprise.context.spi.CreationalContext

-
-
- -
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/spi/package-summary.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/spi/package-summary.html deleted file mode 100644 index b8621f1cdf..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/spi/package-summary.html +++ /dev/null @@ -1,217 +0,0 @@ - - - - - -jakarta.enterprise.context.spi (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-
Module jakarta.cdi
-

Package jakarta.enterprise.context.spi

-
-
-
- - -

The custom context SPI.

- -

Associated with every - scope type is a - context object. - The context object implements the semantics of the scope type.

- -

The context implementation collaborates with the container via - the Context and - Contextual - interfaces to create and destroy contextual instances.

-
-
See Also:
-
jakarta.enterprise.context, -jakarta.enterprise.inject.spi
-
-
-
    -
  • - - - - - - - - - - - - - - - - - - - - - - - - -
    Interface Summary 
    InterfaceDescription
    AlterableContext -
    - Provides an operation for obtaining and destroying contextual instances with a particular scope of any contextual type.
    -
    Context -
    - Provides an operation for obtaining contextual instances with a particular scope of any contextual type.
    -
    Contextual<T> -
    - Defines operations to create and destroy contextual instances of a certain type.
    -
    CreationalContext<T> -
    - Provides operations that are used by the Contextual implementation during instance - creation and destruction.
    -
    -
  • -
-
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/spi/package-tree.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/spi/package-tree.html deleted file mode 100644 index c38c90d3c9..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/spi/package-tree.html +++ /dev/null @@ -1,170 +0,0 @@ - - - - - -jakarta.enterprise.context.spi Class Hierarchy (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Hierarchy For Package jakarta.enterprise.context.spi

-Package Hierarchies: - -
-
-
-

Interface Hierarchy

- -
-
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/spi/package-use.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/spi/package-use.html deleted file mode 100644 index eae7867242..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/context/spi/package-use.html +++ /dev/null @@ -1,274 +0,0 @@ - - - - - -Uses of Package jakarta.enterprise.context.spi (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Package
jakarta.enterprise.context.spi

-
-
- -
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/event/Event.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/event/Event.html deleted file mode 100644 index cc258d18ea..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/event/Event.html +++ /dev/null @@ -1,517 +0,0 @@ - - - - - -Event (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Interface Event<T>

-
-
-
-
    -
  • -
    -
    Type Parameters:
    -
    T - the type of the event object
    -
    -
    -
    public interface Event<T>
    -

    - Allows the application to fire events of a particular type. -

    - -

    - Beans fire events via an instance of the Event interface, which may be injected: -

    - -
    - @Inject
    - @Any
    - Event<LoggedInEvent> loggedInEvent;
    - 
    - -

    - The fire() method accepts an event object: -

    - -
    - public void login() { 
    -    ...
    -    loggedInEvent.fire( new LoggedInEvent(user) );
    - }
    - 
    - -

    - Any combination of qualifiers may be specified at the injection point: -

    - -
    - @Inject
    - @Admin
    - Event<LoggedInEvent> adminLoggedInEvent;
    - 
    - -

    - Or, the @Any qualifier may be used, allowing the application to specify qualifiers - dynamically: -

    - -
    - @Inject
    - @Any
    - Event<LoggedInEvent> loggedInEvent;
    - 
    - -

    - For an injected Event: -

    - -
      -
    • the specified type is the type parameter specified at the injection point, and
    • -
    • the specified qualifiers are the qualifiers specified at the injection point.
    • -
    - -

    - Events may also be fired asynchronously with fireAsync(Object) and fireAsync(Object, NotificationOptions) methods -

    -
    -
    Author:
    -
    Gavin King, Pete Muir, David Allen, Antoine Sabot-Durand
    -
    -
  • -
-
-
-
    -
  • - -
    -
      -
    • - - -

      Method Summary

      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      All Methods Instance Methods Abstract Methods 
      Modifier and TypeMethodDescription
      voidfire​(T event) -
      - Fires an event with the specified qualifiers and notifies observers.
      -
      <U extends T>
      java.util.concurrent.CompletionStage<U>
      fireAsync​(U event) -
      - Fires an event asynchronously with the specified qualifiers and notifies asynchronous observers.
      -
      <U extends T>
      java.util.concurrent.CompletionStage<U>
      fireAsync​(U event, - NotificationOptions options) -
      - Fires an event asynchronously with the specified qualifiers and notifies asynchronous observers.
      -
      <U extends T>
      Event<U>
      select​(TypeLiteral<U> subtype, - java.lang.annotation.Annotation... qualifiers) -
      - Obtains a child Event for the given required type and additional required qualifiers.
      -
      Event<T>select​(java.lang.annotation.Annotation... qualifiers) -
      - Obtains a child Event for the given additional required qualifiers.
      -
      <U extends T>
      Event<U>
      select​(java.lang.Class<U> subtype, - java.lang.annotation.Annotation... qualifiers) -
      - Obtains a child Event for the given required type and additional required qualifiers.
      -
      -
    • -
    -
    -
  • -
-
-
-
    -
  • - -
    -
      -
    • - - -

      Method Detail

      - - - - - -
        -
      • -

        fire

        -
        void fire​(T event)
        -

        - Fires an event with the specified qualifiers and notifies observers. -

        -
        -
        Parameters:
        -
        event - the event object
        -
        Throws:
        -
        java.lang.IllegalArgumentException - if the runtime type of the event object contains a type variable
        -
        ObserverException - if a notified observer throws a checked exception, it will be wrapped and rethrown as an - (unchecked) ObserverException
        -
        -
      • -
      - - - - - -
        -
      • -

        fireAsync

        -
        <U extends T> java.util.concurrent.CompletionStage<U> fireAsync​(U event)
        -

        - Fires an event asynchronously with the specified qualifiers and notifies asynchronous observers. -

        -
        -
        Type Parameters:
        -
        U - event type
        -
        Parameters:
        -
        event - the event object
        -
        Returns:
        -
        a CompletionStage allowing further pipeline composition on the asynchronous operation. - Default asynchronous execution facility is container specific. - If any observer notified by this event throws an exception - then the resulting CompletionStage is completed exceptionally with CompletionException - that wraps all the exceptions raised by observers as suppressed exception. - If no exception is thrown by observers then the resulting CompletionStage is completed normally with the event payload.
        -
        Throws:
        -
        java.lang.IllegalArgumentException - if the runtime type of the event object contains a type variable
        -
        Since:
        -
        2.0
        -
        -
      • -
      - - - - - -
        -
      • -

        fireAsync

        -
        <U extends T> java.util.concurrent.CompletionStage<U> fireAsync​(U event,
        -                                                                NotificationOptions options)
        -

        - Fires an event asynchronously with the specified qualifiers and notifies asynchronous observers. - A custom Executor will be used to make asynchronous calls -

        -
        -
        Type Parameters:
        -
        U - event type
        -
        Parameters:
        -
        event - the event object
        -
        options - the notification options
        -
        Returns:
        -
        a CompletionStage allowing further pipeline composition on the asynchronous operation. - Default asynchronous execution facility is container specific. - If any observer notified by this event throws an exception - then the resulting CompletionStage is completed exceptionally with CompletionException - that wraps all the exceptions raised by observers as suppressed exception. - If no exception is thrown by observers then the resulting CompletionStage is completed normally with the event payload.
        -
        Throws:
        -
        java.lang.IllegalArgumentException - if the runtime type of the event object contains a type variable
        -
        Since:
        -
        2.0
        -
        -
      • -
      - - - -
        -
      • -

        select

        -
        Event<T> select​(java.lang.annotation.Annotation... qualifiers)
        -

        - Obtains a child Event for the given additional required qualifiers. -

        -
        -
        Parameters:
        -
        qualifiers - the additional specified qualifiers
        -
        Returns:
        -
        the child Event
        -
        Throws:
        -
        java.lang.IllegalArgumentException - if passed two instances of the same non repeating qualifier type, or an instance of an annotation that - is not a qualifier type
        -
        -
      • -
      - - - -
        -
      • -

        select

        -
        <U extends TEvent<U> select​(java.lang.Class<U> subtype,
        -                              java.lang.annotation.Annotation... qualifiers)
        -

        - Obtains a child Event for the given required type and additional required qualifiers. -

        -
        -
        Type Parameters:
        -
        U - the specified type
        -
        Parameters:
        -
        subtype - a Class representing the specified type
        -
        qualifiers - the additional specified qualifiers
        -
        Returns:
        -
        the child Event
        -
        Throws:
        -
        java.lang.IllegalArgumentException - if passed two instances of the same non repeating qualifier type, or an instance of an annotation that - is not a qualifier type
        -
        -
      • -
      - - - -
        -
      • -

        select

        -
        <U extends TEvent<U> select​(TypeLiteral<U> subtype,
        -                              java.lang.annotation.Annotation... qualifiers)
        -

        - Obtains a child Event for the given required type and additional required qualifiers. -

        -
        -
        Type Parameters:
        -
        U - the specified type
        -
        Parameters:
        -
        subtype - a TypeLiteral representing the specified type
        -
        qualifiers - the additional specified qualifiers
        -
        Returns:
        -
        the child Event
        -
        Throws:
        -
        java.lang.IllegalArgumentException - if passed two instances of the same non repeating qualifier type, or an instance of an annotation that - is not a qualifier type
        -
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- -
- -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

-
- - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/event/NotificationOptions.Builder.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/event/NotificationOptions.Builder.html deleted file mode 100644 index 0176788d7b..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/event/NotificationOptions.Builder.html +++ /dev/null @@ -1,297 +0,0 @@ - - - - - -NotificationOptions.Builder (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Interface NotificationOptions.Builder

-
-
-
-
    -
  • -
    -
    Enclosing interface:
    -
    NotificationOptions
    -
    -
    -
    public static interface NotificationOptions.Builder
    -
    Notification options builder.
    -
    -
    Since:
    -
    2.0
    -
    Author:
    -
    Martin Kouba
    -
    -
  • -
-
-
- -
-
- -
-
-
- -
- -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

-
- - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/event/NotificationOptions.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/event/NotificationOptions.html deleted file mode 100644 index a0a72e3250..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/event/NotificationOptions.html +++ /dev/null @@ -1,375 +0,0 @@ - - - - - -NotificationOptions (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Interface NotificationOptions

-
-
-
- -
-
- -
-
-
    -
  • - -
    -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        getExecutor

        -
        java.util.concurrent.Executor getExecutor()
        -
        -
        Returns:
        -
        the executor used to execute an asynchronous event
        -
        -
      • -
      - - - -
        -
      • -

        get

        -
        java.lang.Object get​(java.lang.String optionName)
        -
        -
        Parameters:
        -
        optionName - name of the option to get value of
        -
        Returns:
        -
        the value of an option or null if no option for the given name exists
        -
        -
      • -
      - - - -
        -
      • -

        ofExecutor

        -
        static NotificationOptions ofExecutor​(java.util.concurrent.Executor executor)
        -
        -
        Parameters:
        -
        executor - a specific Executor to handle observer notification
        -
        Returns:
        -
        an immutable holder of an executor
        -
        -
      • -
      - - - -
        -
      • -

        of

        -
        static NotificationOptions of​(java.lang.String optionName,
        -                              java.lang.Object optionValue)
        -
        -
        Parameters:
        -
        optionName - name of the option to set
        -
        optionValue - value for the option
        -
        Returns:
        -
        an immutable holder of a single option
        -
        -
      • -
      - - - - -
    • -
    -
    -
  • -
-
-
-
- - - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/event/ObserverException.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/event/ObserverException.html deleted file mode 100644 index 11ac20db0e..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/event/ObserverException.html +++ /dev/null @@ -1,350 +0,0 @@ - - - - - -ObserverException (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Class ObserverException

-
-
-
    -
  • java.lang.Object
  • -
  • -
      -
    • java.lang.Throwable
    • -
    • -
        -
      • java.lang.Exception
      • -
      • -
          -
        • java.lang.RuntimeException
        • -
        • -
            -
          • jakarta.enterprise.event.ObserverException
          • -
          -
        • -
        -
      • -
      -
    • -
    -
  • -
-
-
    -
  • -
    -
    All Implemented Interfaces:
    -
    java.io.Serializable
    -
    -
    -
    public class ObserverException
    -extends java.lang.RuntimeException
    -

    - Indicates that a checked exception was thrown by an observer method during event notification. -

    -
    -
    Author:
    -
    Pete Muir, Gavin King
    -
    See Also:
    -
    Serialized Form
    -
    -
  • -
-
-
-
    -
  • - -
    - -
    - -
    -
      -
    • - - -

      Method Summary

      -
        -
      • - - -

        Methods inherited from class java.lang.Throwable

        -addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
      • -
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

        -clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
      • -
      -
    • -
    -
    -
  • -
-
-
-
    -
  • - -
    -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        ObserverException

        -
        public ObserverException()
        -
      • -
      - - - -
        -
      • -

        ObserverException

        -
        public ObserverException​(java.lang.String message)
        -
      • -
      - - - -
        -
      • -

        ObserverException

        -
        public ObserverException​(java.lang.Throwable cause)
        -
      • -
      - - - -
        -
      • -

        ObserverException

        -
        public ObserverException​(java.lang.String message,
        -                         java.lang.Throwable cause)
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- - - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/event/Observes.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/event/Observes.html deleted file mode 100644 index e41b767c4e..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/event/Observes.html +++ /dev/null @@ -1,358 +0,0 @@ - - - - - -Observes (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Annotation Type Observes

-
-
-
-
    -
  • -
    -
    @Target(PARAMETER)
    -@Retention(RUNTIME)
    -@Documented
    -public @interface Observes
    -

    - Identifies the event parameter of an observer method. May be applied to a parameter of a method of a bean class or - extension. -

    - -
    - public void afterLogin(@Observes LoggedInEvent event) { ... }
    - 
    - -

    - 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. -

    - -

    - Each observer method must have exactly one event parameter, of the same type as the event type it observes. Event qualifiers - may be declared by annotating the event parameter. When searching for observer methods for an event, the container considers - the type and qualifiers of the event parameter. -

    - -

    - If the event parameter does not explicitly declare any qualifier, the observer method observes events with no qualifier. -

    - -

    - The event parameter type may contain a type variable or wildcard. -

    - -

    - In addition to the event parameter, observer methods may declare additional parameters, which may declare qualifiers. These - additional parameters are injection points. -

    - -
    - public void afterLogin(@Observes LoggedInEvent event, @Manager User user, Logger log) { ... }
    - 
    - -

    - A bean (or extension) may declare multiple observer methods. -

    - -

    - Observer methods are inherited by bean subclasses. -

    - -

    - Interceptors and decorators may not declare observer methods. -

    -
    -
    Author:
    -
    Gavin King, Pete Muir, David Allen
    -
    -
  • -
-
-
- -
-
-
    -
  • - -
    -
      -
    • - - -

      Element Detail

      - - - -
        -
      • -

        notifyObserver

        -
        Reception notifyObserver
        -

        - Specifies under what conditions the observer method is notified. -

        - -

        - By default, the observer method is notified even if no instance of the bean that defines the observer method already - exists in the current context. -

        -
        -
        Returns:
        -
        conditional observer type
        -
        -
        -
        Default:
        -
        jakarta.enterprise.event.Reception.ALWAYS
        -
        -
      • -
      -
    • -
    -
    -
    - -
    -
  • -
-
-
-
- - - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/event/ObservesAsync.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/event/ObservesAsync.html deleted file mode 100644 index ad9b31a2bb..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/event/ObservesAsync.html +++ /dev/null @@ -1,320 +0,0 @@ - - - - - -ObservesAsync (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Annotation Type ObservesAsync

-
-
-
-
    -
  • -
    -
    @Target(PARAMETER)
    -@Retention(RUNTIME)
    -@Documented
    -public @interface ObservesAsync
    -

    - Identifies the event parameter of an asynchronous observer method. May be applied to a parameter of a method of a bean class -

    - -
    - public void afterLogin(@ObservesAsync LoggedInEvent event) { ... }
    - 
    - -

    - 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. -

    - -

    - Each observer method must have exactly one event parameter, of the same type as the event type it observes. Event qualifiers - may be declared by annotating the event parameter. When searching for observer methods for an event, the container considers - the type and qualifiers of the event parameter. -

    - -

    - If the event parameter does not explicitly declare any qualifier, the observer method observes events with no qualifier. -

    - -

    - The event parameter type may contain a type variable or wildcard. -

    - -

    - In addition to the event parameter, observer methods may declare additional parameters, which may declare qualifiers. These - additional parameters are injection points. -

    - -
    - public void afterLogin(@ObservesAsync LoggedInEvent event, @Manager User user, Logger log) { ... }
    - 
    - -

    - A bean (or extension) may declare multiple observer methods. -

    - -

    - Observer methods are inherited by bean subclasses. -

    - -

    - Interceptors and decorators may not declare observer methods. -

    -
    -
    Author:
    -
    Gavin King, Pete Muir, David Allen
    -
    -
  • -
-
-
- -
-
-
    -
  • - -
    -
      -
    • - - -

      Element Detail

      - - - -
        -
      • -

        notifyObserver

        -
        Reception notifyObserver
        -

        - Specifies under what conditions the observer method is notified. -

        - -

        - By default, the observer method is notified even if no instance of the bean that defines the observer method already - exists in the current context. -

        -
        -
        Returns:
        -
        conditional observer type
        -
        -
        -
        Default:
        -
        jakarta.enterprise.event.Reception.ALWAYS
        -
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- - - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/event/Reception.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/event/Reception.html deleted file mode 100644 index cad38904d2..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/event/Reception.html +++ /dev/null @@ -1,416 +0,0 @@ - - - - - -Reception (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Enum Reception

-
-
-
    -
  • java.lang.Object
  • -
  • -
      -
    • java.lang.Enum<Reception>
    • -
    • -
        -
      • jakarta.enterprise.event.Reception
      • -
      -
    • -
    -
  • -
-
-
    -
  • -
    -
    All Implemented Interfaces:
    -
    java.io.Serializable, java.lang.Comparable<Reception>
    -
    -
    -
    public enum Reception
    -extends java.lang.Enum<Reception>
    -

    - Distinguishes conditional observer methods from observer methods which are - always notified. -

    - -

    - A conditional observer method is an observer method which is notified of an event only if an instance of the bean that - defines the observer method already exists in the current context. -

    - -

    - Beans with scope @Dependent may not have conditional observer methods. -

    -
    -
    Author:
    -
    Gavin King, Dan Allen, David Allen
    -
    -
  • -
-
-
-
    -
  • - -
    -
      -
    • - - -

      Enum Constant Summary

      - - - - - - - - - - - - - - -
      Enum Constants 
      Enum ConstantDescription
      ALWAYS -
      Specifies that an observer method always receives event notifications.
      -
      IF_EXISTS -
      - Specifies that an observer method is only called if the current instance of the bean declaring the observer method - already exists.
      -
      -
    • -
    -
    - -
    -
      -
    • - - -

      Method Summary

      - - - - - - - - - - - - - - - - - -
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethodDescription
      static ReceptionvalueOf​(java.lang.String name) -
      Returns the enum constant of this type with the specified name.
      -
      static Reception[]values() -
      Returns an array containing the constants of this enum type, in -the order they are declared.
      -
      -
        -
      • - - -

        Methods inherited from class java.lang.Enum

        -clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
      • -
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

        -getClass, notify, notifyAll, wait, wait, wait
      • -
      -
    • -
    -
    -
  • -
-
-
-
    -
  • - -
    -
      -
    • - - -

      Enum Constant Detail

      - - - -
        -
      • -

        IF_EXISTS

        -
        public static final Reception IF_EXISTS
        -

        - Specifies that an observer method is only called if the current instance of the bean declaring the observer method - already exists. -

        -

        - If there is no active context for the scope to which the bean declaring this observer method belongs, then the observer - method is not called. -

        -
      • -
      - - - -
        -
      • -

        ALWAYS

        -
        public static final Reception ALWAYS
        -
        Specifies that an observer method always receives event notifications.
        -
      • -
      -
    • -
    -
    - -
    -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        values

        -
        public static Reception[] values()
        -
        Returns an array containing the constants of this enum type, in -the order they are declared. This method may be used to iterate -over the constants as follows: -
        -for (Reception c : Reception.values())
        -    System.out.println(c);
        -
        -
        -
        Returns:
        -
        an array containing the constants of this enum type, in the order they are declared
        -
        -
      • -
      - - - -
        -
      • -

        valueOf

        -
        public static Reception valueOf​(java.lang.String name)
        -
        Returns the enum constant of this type with the specified name. -The string must match exactly an identifier used to declare an -enum constant in this type. (Extraneous whitespace characters are -not permitted.)
        -
        -
        Parameters:
        -
        name - the name of the enum constant to be returned.
        -
        Returns:
        -
        the enum constant with the specified name
        -
        Throws:
        -
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        -
        java.lang.NullPointerException - if the argument is null
        -
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- - - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/event/Shutdown.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/event/Shutdown.html deleted file mode 100644 index d376e60075..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/event/Shutdown.html +++ /dev/null @@ -1,295 +0,0 @@ - - - - - -Shutdown (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Class Shutdown

-
-
-
    -
  • java.lang.Object
  • -
  • -
      -
    • jakarta.enterprise.event.Shutdown
    • -
    -
  • -
-
-
    -
  • -
    -
    public class Shutdown
    -extends java.lang.Object
    -

    - A CDI event with payload of type Shutdown and qualifier Any is - synchronously fired by CDI container during application shutdown. - Applications must never manually fire any events with Shutdown as payload. -

    - -

    - Implementations have to fire this event during CDI container shutdown, but not later than the event with qualifier - @BeforeDestroyed(ApplicationScoped.class). -

    - -

    - This event can be observed by integrators and libraries to perform any kind of pre-shutdown operation as well as by - users as a reliable entry point for when the CDI container is about to shut down. -

    - -

    - Observers are encouraged to specify @Priority to determine ordering with lower priority numbers being - recommended for user applications and higher numbers for platform/framework/library integration. -

    - See also Interceptor.Priority
    -
  • -
-
-
-
    -
  • - -
    -
      -
    • - - -

      Constructor Summary

      - - - - - - - - - - -
      Constructors 
      ConstructorDescription
      Shutdown() 
      -
    • -
    -
    - -
    -
      -
    • - - -

      Method Summary

      -
        -
      • - - -

        Methods inherited from class java.lang.Object

        -clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
      • -
      -
    • -
    -
    -
  • -
-
-
-
    -
  • - -
    -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        Shutdown

        -
        public Shutdown()
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- - - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/event/Startup.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/event/Startup.html deleted file mode 100644 index f69fdcf295..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/event/Startup.html +++ /dev/null @@ -1,295 +0,0 @@ - - - - - -Startup (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Class Startup

-
-
-
    -
  • java.lang.Object
  • -
  • -
      -
    • jakarta.enterprise.event.Startup
    • -
    -
  • -
-
-
    -
  • -
    -
    public class Startup
    -extends java.lang.Object
    -

    - A CDI event with payload of type Startup and qualifier Any is - synchronously fired by CDI container during application initialization. - Applications must never manually fire any events with Startup as payload. -

    - -

    - Implementations have to fire this event after the event with qualifier @Initialized(ApplicationScope.class) - but before processing requests. -

    - -

    - This event can be observed by integrators and libraries to perform any kind of early initialization as well as by - users as a reliable entry point for when the CDI container is ready. -

    - -

    - Observers are encouraged to specify @Priority to determine ordering with lower priority numbers being - recommended for platform/framework/library integration and higher numbers for user applications. -

    - See also Interceptor.Priority
    -
  • -
-
-
-
    -
  • - -
    -
      -
    • - - -

      Constructor Summary

      - - - - - - - - - - -
      Constructors 
      ConstructorDescription
      Startup() 
      -
    • -
    -
    - -
    -
      -
    • - - -

      Method Summary

      -
        -
      • - - -

        Methods inherited from class java.lang.Object

        -clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
      • -
      -
    • -
    -
    -
  • -
-
-
-
    -
  • - -
    -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        Startup

        -
        public Startup()
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- - - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/event/TransactionPhase.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/event/TransactionPhase.html deleted file mode 100644 index b9eaa9b59b..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/event/TransactionPhase.html +++ /dev/null @@ -1,489 +0,0 @@ - - - - - -TransactionPhase (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Enum TransactionPhase

-
-
-
    -
  • java.lang.Object
  • -
  • -
      -
    • java.lang.Enum<TransactionPhase>
    • -
    • -
        -
      • jakarta.enterprise.event.TransactionPhase
      • -
      -
    • -
    -
  • -
-
-
    -
  • -
    -
    All Implemented Interfaces:
    -
    java.io.Serializable, java.lang.Comparable<TransactionPhase>
    -
    -
    -
    public enum TransactionPhase
    -extends java.lang.Enum<TransactionPhase>
    -

    - Distinguishes the various kinds of transactional observer methods from regular - observer methods which are notified immediately. -

    -

    - Transactional observer methods are observer methods which receive event notifications during the before or after completion - phase of the transaction in which the event was fired. If no transaction is in progress when the event is fired, they are - notified at the same time as other observers. - If the transaction is in progress, but jakarta.transaction.Synchronization callback cannot be registered due to the transaction being already - marked for rollback or in state where jakarta.transaction.Synchronization callbacks cannot be registered, the BEFORE_COMPLETION, - AFTER_COMPLETION and AFTER_FAILURE observer methods are notified at the same time as other observers, - but AFTER_SUCCESS observer methods get skipped. -

    -
    -
    Author:
    -
    Pete Muir, Gavin King
    -
    -
  • -
-
-
-
    -
  • - -
    -
      -
    • - - -

      Enum Constant Summary

      - - - - - - - - - - - - - - - - - - - - - - - - - - -
      Enum Constants 
      Enum ConstantDescription
      AFTER_COMPLETION -
      - Identifies an after completion observer method, called during the after completion phase of the transaction.
      -
      AFTER_FAILURE -
      - Identifies an after failure observer method, called during the after completion phase of the transaction, only when the - transaction fails.
      -
      AFTER_SUCCESS -
      - Identifies an after success observer method, called during the after completion phase of the transaction, only when the - transaction completes successfully.
      -
      BEFORE_COMPLETION -
      - Identifies a before completion observer method, called during the before completion phase of the transaction.
      -
      IN_PROGRESS -
      - Identifies a regular observer method, called when the event is fired.
      -
      -
    • -
    -
    - -
    -
      -
    • - - -

      Method Summary

      - - - - - - - - - - - - - - - - - -
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethodDescription
      static TransactionPhasevalueOf​(java.lang.String name) -
      Returns the enum constant of this type with the specified name.
      -
      static TransactionPhase[]values() -
      Returns an array containing the constants of this enum type, in -the order they are declared.
      -
      -
        -
      • - - -

        Methods inherited from class java.lang.Enum

        -clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
      • -
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

        -getClass, notify, notifyAll, wait, wait, wait
      • -
      -
    • -
    -
    -
  • -
-
-
-
    -
  • - -
    -
      -
    • - - -

      Enum Constant Detail

      - - - -
        -
      • -

        IN_PROGRESS

        -
        public static final TransactionPhase IN_PROGRESS
        -

        - Identifies a regular observer method, called when the event is fired. -

        -
      • -
      - - - -
        -
      • -

        BEFORE_COMPLETION

        -
        public static final TransactionPhase BEFORE_COMPLETION
        -

        - Identifies a before completion observer method, called during the before completion phase of the transaction. -

        -

        - Transactional observer will be notified if there is no transaction in progress, or the transaction is in progress, - but jakarta.transaction.Synchronization callback cannot be registered due to the transaction being already - marked for rollback or in state where jakarta.transaction.Synchronization callbacks cannot be registered. -

        -
      • -
      - - - -
        -
      • -

        AFTER_COMPLETION

        -
        public static final TransactionPhase AFTER_COMPLETION
        -

        - Identifies an after completion observer method, called during the after completion phase of the transaction. -

        -

        - Transactional observer will be notified if there is no transaction in progress, or the transaction is in progress, - but jakarta.transaction.Synchronization callback cannot be registered due to the transaction being already - marked for rollback or in state where jakarta.transaction.Synchronization callbacks cannot be registered. -

        -
      • -
      - - - -
        -
      • -

        AFTER_FAILURE

        -
        public static final TransactionPhase AFTER_FAILURE
        -

        - Identifies an after failure observer method, called during the after completion phase of the transaction, only when the - transaction fails. -

        -

        - Transactional observer will be notified will also get invoked if there is no transaction in progress, or the transaction is in progress, - but jakarta.transaction.Synchronization callback cannot be registered due to the transaction being already - marked for rollback or in state where jakarta.transaction.Synchronization callbacks cannot be registered. -

        -
      • -
      - - - -
        -
      • -

        AFTER_SUCCESS

        -
        public static final TransactionPhase AFTER_SUCCESS
        -

        - Identifies an after success observer method, called during the after completion phase of the transaction, only when the - transaction completes successfully. -

        -
      • -
      -
    • -
    -
    - -
    -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        values

        -
        public static TransactionPhase[] values()
        -
        Returns an array containing the constants of this enum type, in -the order they are declared. This method may be used to iterate -over the constants as follows: -
        -for (TransactionPhase c : TransactionPhase.values())
        -    System.out.println(c);
        -
        -
        -
        Returns:
        -
        an array containing the constants of this enum type, in the order they are declared
        -
        -
      • -
      - - - -
        -
      • -

        valueOf

        -
        public static TransactionPhase valueOf​(java.lang.String name)
        -
        Returns the enum constant of this type with the specified name. -The string must match exactly an identifier used to declare an -enum constant in this type. (Extraneous whitespace characters are -not permitted.)
        -
        -
        Parameters:
        -
        name - the name of the enum constant to be returned.
        -
        Returns:
        -
        the enum constant with the specified name
        -
        Throws:
        -
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        -
        java.lang.NullPointerException - if the argument is null
        -
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- - - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/event/class-use/Event.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/event/class-use/Event.html deleted file mode 100644 index 7a9dab2a7f..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/event/class-use/Event.html +++ /dev/null @@ -1,251 +0,0 @@ - - - - - -Uses of Interface jakarta.enterprise.event.Event (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Interface
jakarta.enterprise.event.Event

-
-
-
    -
  • - - - - - - - - - - - - - - - - -
    Packages that use Event 
    PackageDescription
    jakarta.enterprise.event -
    Annotations and interfaces relating to events.
    -
    jakarta.enterprise.inject.spi -
    The portable extension integration SPI.
    -
    -
  • -
  • -
      -
    • -
      - - -

      Uses of Event in jakarta.enterprise.event

      - - - - - - - - - - - - - - - - - - - - - - - - -
      Methods in jakarta.enterprise.event that return Event 
      Modifier and TypeMethodDescription
      <U extends T>
      Event<U>
      Event.select​(TypeLiteral<U> subtype, - java.lang.annotation.Annotation... qualifiers) -
      - Obtains a child Event for the given required type and additional required qualifiers.
      -
      Event<T>Event.select​(java.lang.annotation.Annotation... qualifiers) -
      - Obtains a child Event for the given additional required qualifiers.
      -
      <U extends T>
      Event<U>
      Event.select​(java.lang.Class<U> subtype, - java.lang.annotation.Annotation... qualifiers) -
      - Obtains a child Event for the given required type and additional required qualifiers.
      -
      -
      -
    • -
    • -
      - - -

      Uses of Event in jakarta.enterprise.inject.spi

      - - - - - - - - - - - - - - -
      Methods in jakarta.enterprise.inject.spi that return Event 
      Modifier and TypeMethodDescription
      Event<java.lang.Object>BeanContainer.getEvent() -
      Returns an instance of Event with specified type java.lang.Object and specified qualifier @Default - It allows typesafe synchronous or asynchronous event firing without injection of Event built-in bean requirement.
      -
      -
      -
    • -
    -
  • -
-
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/event/class-use/NotificationOptions.Builder.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/event/class-use/NotificationOptions.Builder.html deleted file mode 100644 index bd7680531f..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/event/class-use/NotificationOptions.Builder.html +++ /dev/null @@ -1,210 +0,0 @@ - - - - - -Uses of Interface jakarta.enterprise.event.NotificationOptions.Builder (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Interface
jakarta.enterprise.event.NotificationOptions.Builder

-
-
- -
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/event/class-use/NotificationOptions.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/event/class-use/NotificationOptions.html deleted file mode 100644 index e452b739f9..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/event/class-use/NotificationOptions.html +++ /dev/null @@ -1,229 +0,0 @@ - - - - - -Uses of Interface jakarta.enterprise.event.NotificationOptions (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Interface
jakarta.enterprise.event.NotificationOptions

-
-
- -
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/event/class-use/ObserverException.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/event/class-use/ObserverException.html deleted file mode 100644 index 6f73b895fd..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/event/class-use/ObserverException.html +++ /dev/null @@ -1,153 +0,0 @@ - - - - - -Uses of Class jakarta.enterprise.event.ObserverException (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Class
jakarta.enterprise.event.ObserverException

-
-
No usage of jakarta.enterprise.event.ObserverException
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/event/class-use/Observes.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/event/class-use/Observes.html deleted file mode 100644 index 4defe8ecd0..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/event/class-use/Observes.html +++ /dev/null @@ -1,153 +0,0 @@ - - - - - -Uses of Class jakarta.enterprise.event.Observes (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Class
jakarta.enterprise.event.Observes

-
-
No usage of jakarta.enterprise.event.Observes
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/event/class-use/ObservesAsync.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/event/class-use/ObservesAsync.html deleted file mode 100644 index b1b69e14c8..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/event/class-use/ObservesAsync.html +++ /dev/null @@ -1,153 +0,0 @@ - - - - - -Uses of Class jakarta.enterprise.event.ObservesAsync (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Class
jakarta.enterprise.event.ObservesAsync

-
-
No usage of jakarta.enterprise.event.ObservesAsync
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/event/class-use/Reception.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/event/class-use/Reception.html deleted file mode 100644 index 931b3262d8..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/event/class-use/Reception.html +++ /dev/null @@ -1,313 +0,0 @@ - - - - - -Uses of Class jakarta.enterprise.event.Reception (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Class
jakarta.enterprise.event.Reception

-
-
- -
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/event/class-use/Shutdown.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/event/class-use/Shutdown.html deleted file mode 100644 index bcea2e8c31..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/event/class-use/Shutdown.html +++ /dev/null @@ -1,153 +0,0 @@ - - - - - -Uses of Class jakarta.enterprise.event.Shutdown (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Class
jakarta.enterprise.event.Shutdown

-
-
No usage of jakarta.enterprise.event.Shutdown
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/event/class-use/Startup.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/event/class-use/Startup.html deleted file mode 100644 index 815abf9dc1..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/event/class-use/Startup.html +++ /dev/null @@ -1,153 +0,0 @@ - - - - - -Uses of Class jakarta.enterprise.event.Startup (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Class
jakarta.enterprise.event.Startup

-
-
No usage of jakarta.enterprise.event.Startup
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/event/class-use/TransactionPhase.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/event/class-use/TransactionPhase.html deleted file mode 100644 index fe62b7daee..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/event/class-use/TransactionPhase.html +++ /dev/null @@ -1,322 +0,0 @@ - - - - - -Uses of Class jakarta.enterprise.event.TransactionPhase (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Class
jakarta.enterprise.event.TransactionPhase

-
-
- -
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/event/package-summary.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/event/package-summary.html deleted file mode 100644 index 9b6551773c..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/event/package-summary.html +++ /dev/null @@ -1,387 +0,0 @@ - - - - - -jakarta.enterprise.event (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-
Module jakarta.cdi
-

Package jakarta.enterprise.event

-
-
-
- - -

Annotations and interfaces relating to events.

- -

Beans may produce and - consume events. Events allows beans to interact in a completely - decoupled fashion, with no compile-time dependency between the - interacting beans. Most importantly, it allows stateful beans - in one architectural tier of the application to synchronize - their internal state with state changes that occur in a - different tier.

- -

Events may be fired synchronously or asynchronously.

- -

An event comprises:

- -
    -
  • A Java object, called the event object
  • -
  • A (possibly empty) set of instances of qualifier types, called - the event qualifiers
  • -
- -

The Event interface is used to - fire events.

- -

Event objects and event types

- -

The event object acts as a payload, to propagate state from - producer to consumer. An event object is an instance of a concrete - Java class with no type variables.

- -

The event types of the event include all superclasses and - interfaces of the runtime class of the event object. An event type - may not contain a type variable.

- -

Event qualifiers

- -

The event qualifiers act as topic selectors, allowing the consumer - to narrow the set of events it observes. An event qualifier may be an - instance of any qualifier type.

- -

Observer methods

- -

An observer method - allows the application to receive and respond synchronously to event notifications. - And an async observer method - allows the application to receive and respond asynchronously to event notifications. - they both act as event consumers, observing events of a specific type, with a - specific set of qualifiers. Any Java type may be observed by an - observer method.

- -

An observer method is a method of a bean class or - extension with a - parameter annotated @Observes - or @ObservesAsync.

- -

An observer method will be notified of an event if:

- -
    -
  • the event object is assignable to the type observed by the observer - method,
  • -
  • the observer method has all the event qualifiers of the event, and
  • -
  • either the event is not a - container lifecycle event, or - the observer method belongs to an - extension. -
- -

If a synchronous observer method is a - transactional - observer method and there is a JTA transaction in progress when the - event is fired, the observer method is notified during the appropriate - transaction completion phase. Otherwise, the observer is notified when - the event is fired.

- -

The order in which observer methods are called depends on the value of - the @Priority applied to the observer.

-

If no priority is defined on a observer, its priority is jakarta.interceptor.Interceptor.Priority.APPLICATION+500.

-

If two observer have the same priority their relative order is undefined.

- -

Observer methods may throw exceptions:

- -
    -
  • If the observer method is a - transactional - observer method, any exception is caught and logged by the container.
  • -
  • If the observer method is asynchronous, any exception is caught by the container and added as a suppressed exception - to a CompletionException that could be handle by the application
  • -
  • Otherwise, the exception aborts processing of the event. - No other observer methods of that event will be called. The - exception is rethrown. If the exception is a checked exception, - it is wrapped and rethrown as an (unchecked) - ObserverException.
  • -
-
-
See Also:
-
jakarta.enterprise.inject, -Observes, -Event, -Qualifier
-
-
-
    -
  • - - - - - - - - - - - - - - - - - - - - -
    Interface Summary 
    InterfaceDescription
    Event<T> -
    - Allows the application to fire events of a particular type.
    -
    NotificationOptions -
    Notification options are used to configure observer notification.
    -
    NotificationOptions.Builder -
    Notification options builder.
    -
    -
  • -
  • - - - - - - - - - - - - - - - - -
    Class Summary 
    ClassDescription
    Shutdown -
    - A CDI event with payload of type Shutdown and qualifier Any is - synchronously fired by CDI container during application shutdown.
    -
    Startup -
    - A CDI event with payload of type Startup and qualifier Any is - synchronously fired by CDI container during application initialization.
    -
    -
  • -
  • - - - - - - - - - - - - - - - - -
    Enum Summary 
    EnumDescription
    Reception -
    - Distinguishes conditional observer methods from observer methods which are - always notified.
    -
    TransactionPhase -
    - Distinguishes the various kinds of transactional observer methods from regular - observer methods which are notified immediately.
    -
    -
  • -
  • - - - - - - - - - - - - -
    Exception Summary 
    ExceptionDescription
    ObserverException -
    - Indicates that a checked exception was thrown by an observer method during event notification.
    -
    -
  • -
  • - - - - - - - - - - - - - - - - -
    Annotation Types Summary 
    Annotation TypeDescription
    Observes -
    - Identifies the event parameter of an observer method.
    -
    ObservesAsync -
    - Identifies the event parameter of an asynchronous observer method.
    -
    -
  • -
-
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/event/package-tree.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/event/package-tree.html deleted file mode 100644 index 91fb8b4e65..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/event/package-tree.html +++ /dev/null @@ -1,212 +0,0 @@ - - - - - -jakarta.enterprise.event Class Hierarchy (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Hierarchy For Package jakarta.enterprise.event

-Package Hierarchies: - -
-
-
-

Class Hierarchy

-
    -
  • java.lang.Object -
      -
    • jakarta.enterprise.event.Shutdown
    • -
    • jakarta.enterprise.event.Startup
    • -
    • java.lang.Throwable (implements java.io.Serializable) -
        -
      • java.lang.Exception - -
      • -
      -
    • -
    -
  • -
-
-
-

Interface Hierarchy

- -
-
-

Annotation Type Hierarchy

-
    -
  • jakarta.enterprise.event.Observes (implements java.lang.annotation.Annotation)
  • -
  • jakarta.enterprise.event.ObservesAsync (implements java.lang.annotation.Annotation)
  • -
-
-
-

Enum Hierarchy

-
    -
  • java.lang.Object -
      -
    • java.lang.Enum<E> (implements java.lang.Comparable<T>, java.io.Serializable) - -
    • -
    -
  • -
-
-
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/event/package-use.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/event/package-use.html deleted file mode 100644 index 9e2b3ff061..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/event/package-use.html +++ /dev/null @@ -1,331 +0,0 @@ - - - - - -Uses of Package jakarta.enterprise.event (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Package
jakarta.enterprise.event

-
-
- -
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/Alternative.Literal.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/Alternative.Literal.html deleted file mode 100644 index bf07e65275..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/Alternative.Literal.html +++ /dev/null @@ -1,370 +0,0 @@ - - - - - -Alternative.Literal (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Class Alternative.Literal

-
-
- -
- -
-
-
    -
  • - -
    - -
    - -
    - -
    - -
    -
      -
    • - - -

      Constructor Summary

      - - - - - - - - - - -
      Constructors 
      ConstructorDescription
      Literal() 
      -
    • -
    -
    - -
    -
      -
    • - - -

      Method Summary

      - -
        -
      • - - -

        Methods inherited from class java.lang.Object

        -clone, finalize, getClass, notify, notifyAll, wait, wait, wait
      • -
      -
        -
      • - - -

        Methods inherited from interface java.lang.annotation.Annotation

        -annotationType, equals, hashCode, toString
      • -
      -
    • -
    -
    -
  • -
-
-
-
    -
  • - -
    - -
    - -
    -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        Literal

        -
        public Literal()
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- - - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/Alternative.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/Alternative.html deleted file mode 100644 index db18d255a0..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/Alternative.html +++ /dev/null @@ -1,227 +0,0 @@ - - - - - -Alternative (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Annotation Type Alternative

-
-
-
-
    -
  • -
    -
    @Target({TYPE,METHOD,FIELD})
    -@Retention(RUNTIME)
    -@Documented
    -public @interface Alternative
    -

    - Specifies that a bean is an alternative. May be applied to a bean class, producer method or field or - stereotype. -

    - -
    - @Alternative
    - public class MockOrder extends Order { ... }
    - 
    - -

    - An alternative is not available for injection, lookup or EL resolution to classes or JSP/JSF pages in a module unless the - module is a bean archive and the alternative is explicitly selected in that bean archive. An alternative is never - available for injection, lookup or EL resolution in a module that is not a bean archive. -

    - -

    - By default, a bean archive has no selected alternatives. An alternative must be explicitly declared using the - <alternatives> element of the beans.xml file of the bean archive. The <alternatives> - element contains a list of bean classes and stereotypes. An alternative is selected for the bean archive if either: -

    - -
      -
    • the alternative is a managed bean or session bean and the bean class of the bean is listed,
    • -
    • the alternative is a producer method, field or resource, and the bean class that declares the method or field is listed, - or
    • -
    • any @Alternative stereotype of the alternative is listed.
    • -
    -
    -
    Author:
    -
    Gavin King, Pete Muir
    -
    -
  • -
-
-
-
- -
- -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

-
- - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/AmbiguousResolutionException.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/AmbiguousResolutionException.html deleted file mode 100644 index bad957354c..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/AmbiguousResolutionException.html +++ /dev/null @@ -1,361 +0,0 @@ - - - - - -AmbiguousResolutionException (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Class AmbiguousResolutionException

-
-
- -
-
    -
  • -
    -
    All Implemented Interfaces:
    -
    java.io.Serializable
    -
    -
    -
    public class AmbiguousResolutionException
    -extends ResolutionException
    -

    - Indicates that multiple beans match a certain combination of required type and required qualifiers and are eligible for - injection into a certain class. -

    -
    -
    Author:
    -
    Pete Muir, Gavin King
    -
    See Also:
    -
    Serialized Form
    -
    -
  • -
-
-
-
    -
  • - -
    - -
    - -
    -
      -
    • - - -

      Method Summary

      -
        -
      • - - -

        Methods inherited from class java.lang.Throwable

        -addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
      • -
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

        -clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
      • -
      -
    • -
    -
    -
  • -
-
-
-
    -
  • - -
    -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        AmbiguousResolutionException

        -
        public AmbiguousResolutionException()
        -
      • -
      - - - -
        -
      • -

        AmbiguousResolutionException

        -
        public AmbiguousResolutionException​(java.lang.String message,
        -                                    java.lang.Throwable throwable)
        -
      • -
      - - - -
        -
      • -

        AmbiguousResolutionException

        -
        public AmbiguousResolutionException​(java.lang.String message)
        -
      • -
      - - - -
        -
      • -

        AmbiguousResolutionException

        -
        public AmbiguousResolutionException​(java.lang.Throwable throwable)
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- - - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/Any.Literal.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/Any.Literal.html deleted file mode 100644 index 34b608a6f1..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/Any.Literal.html +++ /dev/null @@ -1,372 +0,0 @@ - - - - - -Any.Literal (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Class Any.Literal

-
-
- -
-
    -
  • -
    -
    All Implemented Interfaces:
    -
    java.lang.annotation.Annotation
    -
    -
    -
    Enclosing class:
    -
    Any
    -
    -
    -
    public static final class Any.Literal
    -extends AnnotationLiteral<Any>
    -implements Any
    -
    Supports inline instantiation of the Any qualifier.
    -
    -
    Since:
    -
    2.0
    -
    Author:
    -
    Martin Kouba
    -
    See Also:
    -
    Instance, -Event, -Serialized Form
    -
    -
  • -
-
-
-
    -
  • - -
    -
      -
    • - - -

      Nested Class Summary

      -
        -
      • - - -

        Nested classes/interfaces inherited from class jakarta.enterprise.inject.Any

        -Any.Literal
      • -
      -
    • -
    -
    - -
    -
      -
    • - - -

      Field Summary

      - - - - - - - - - - - - -
      Fields 
      Modifier and TypeFieldDescription
      static Any.LiteralINSTANCE 
      -
    • -
    -
    - -
    -
      -
    • - - -

      Constructor Summary

      - - - - - - - - - - -
      Constructors 
      ConstructorDescription
      Literal() 
      -
    • -
    -
    - -
    -
      -
    • - - -

      Method Summary

      - -
        -
      • - - -

        Methods inherited from class java.lang.Object

        -clone, finalize, getClass, notify, notifyAll, wait, wait, wait
      • -
      -
        -
      • - - -

        Methods inherited from interface java.lang.annotation.Annotation

        -annotationType, equals, hashCode, toString
      • -
      -
    • -
    -
    -
  • -
-
-
-
    -
  • - -
    - -
    - -
    -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        Literal

        -
        public Literal()
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- - - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/Any.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/Any.html deleted file mode 100644 index 65868e8d78..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/Any.html +++ /dev/null @@ -1,234 +0,0 @@ - - - - - -Any (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Annotation Type Any

-
-
-
-
    -
  • -
    -
    @Qualifier
    -@Retention(RUNTIME)
    -@Target({TYPE,METHOD,FIELD,PARAMETER})
    -@Documented
    -public @interface Any
    -

    - The built-in qualifier type. -

    - -

    - Every bean has the qualifier @Any, even if it does not explicitly declare this qualifier. -

    - -

    - Every event has the qualifier @Any, even if it was raised without explicitly declaration of this qualifier. -

    - -

    - The @Any qualifier allows an injection point to refer to all beans or all events of a certain bean type. -

    - -
    - @Inject
    - @Any
    - Instance<PaymentProcessor> anyPaymentProcessor;
    - 
    - -
    - @Inject
    - @Any
    - Event<User> anyUserEvent;
    - 
    - -
    - @Inject
    - @Delegate
    - @Any
    - Logger logger;
    - 
    -
    -
    Author:
    -
    Gavin King, David Allen
    -
    -
  • -
-
-
-
- -
- -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

-
- - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/CreationException.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/CreationException.html deleted file mode 100644 index 098c91e456..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/CreationException.html +++ /dev/null @@ -1,355 +0,0 @@ - - - - - -CreationException (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Class CreationException

-
-
-
    -
  • java.lang.Object
  • -
  • - -
  • -
-
-
    -
  • -
    -
    All Implemented Interfaces:
    -
    java.io.Serializable
    -
    -
    -
    public class CreationException
    -extends InjectionException
    -

    - Indicates that a checked exception was thrown during creation of a bean. -

    -
    -
    Author:
    -
    Pete Muir, Gavin King
    -
    See Also:
    -
    Serialized Form
    -
    -
  • -
-
-
-
    -
  • - -
    - -
    - -
    -
      -
    • - - -

      Method Summary

      -
        -
      • - - -

        Methods inherited from class java.lang.Throwable

        -addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
      • -
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

        -clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
      • -
      -
    • -
    -
    -
  • -
-
-
-
    -
  • - -
    -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        CreationException

        -
        public CreationException()
        -
      • -
      - - - -
        -
      • -

        CreationException

        -
        public CreationException​(java.lang.String message)
        -
      • -
      - - - -
        -
      • -

        CreationException

        -
        public CreationException​(java.lang.Throwable cause)
        -
      • -
      - - - -
        -
      • -

        CreationException

        -
        public CreationException​(java.lang.String message,
        -                         java.lang.Throwable cause)
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- - - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/Decorated.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/Decorated.html deleted file mode 100644 index ac972a18c6..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/Decorated.html +++ /dev/null @@ -1,225 +0,0 @@ - - - - - -Decorated (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Annotation Type Decorated

-
-
-
-
    -
  • -
    -
    @Target({PARAMETER,FIELD})
    -@Retention(RUNTIME)
    -@Documented
    -@Qualifier
    -public @interface Decorated
    -

    - A decorator may inject metadata about the bean it is decorating -

    - -
    - @Decorator
    - class TimestampLogger implements Logger {
    -     @Inject
    -     @Delegate
    -     @Any
    -     Logger logger;
    - 
    -     @Inject
    -     @Decorated
    -     Bean<Logger> bean;
    - 
    -     void log(String message) {
    -       ...
    -    }
    - }
    - 
    - -

    CDI Lite implementations are not required to provide support for decorators.

    -
    -
    Since:
    -
    1.1
    -
    Author:
    -
    Pete Muir
    -
    -
  • -
-
-
-
- -
- -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

-
- - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/Default.Literal.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/Default.Literal.html deleted file mode 100644 index 121892dc30..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/Default.Literal.html +++ /dev/null @@ -1,372 +0,0 @@ - - - - - -Default.Literal (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Class Default.Literal

-
-
- -
- -
-
-
    -
  • - -
    - -
    - -
    - -
    - -
    -
      -
    • - - -

      Constructor Summary

      - - - - - - - - - - -
      Constructors 
      ConstructorDescription
      Literal() 
      -
    • -
    -
    - -
    -
      -
    • - - -

      Method Summary

      - -
        -
      • - - -

        Methods inherited from class java.lang.Object

        -clone, finalize, getClass, notify, notifyAll, wait, wait, wait
      • -
      -
        -
      • - - -

        Methods inherited from interface java.lang.annotation.Annotation

        -annotationType, equals, hashCode, toString
      • -
      -
    • -
    -
    -
  • -
-
-
-
    -
  • - -
    - -
    - -
    -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        Literal

        -
        public Literal()
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- - - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/Default.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/Default.html deleted file mode 100644 index 6a2fa05e16..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/Default.html +++ /dev/null @@ -1,250 +0,0 @@ - - - - - -Default (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Annotation Type Default

-
-
-
-
    -
  • -
    -
    @Target({TYPE,METHOD,PARAMETER,FIELD})
    -@Retention(RUNTIME)
    -@Documented
    -@Qualifier
    -public @interface Default
    -

    - The default qualifier type. -

    - -

    - If a bean does not explicitly declare a qualifier other than @Named, the bean has the - qualifier @Default. -

    - -

    - If an injection point declares no qualifier, the injection point has exactly one qualifier, the default qualifier - @Default. -

    - -

    - The following are equivalent: -

    - -
    - @ConversationScoped
    - public class Order {
    -
    -     private Product product;
    -     private User customer;
    -
    -     @Inject
    -     public void init(@Selected Product product, User customer) {
    -         this.product = product;
    -         this.customer = customer;
    -     }
    -
    - }
    - 
    - -
    - @Default
    - @ConversationScoped
    - public class Order {
    -
    -     private Product product;
    -     private User customer;
    -
    -     @Inject
    -     public void init(@Selected Product product, @Default User customer) {
    -         this.product = product;
    -         this.customer = customer;
    -     }
    -
    - }
    - 
    -
    -
    Author:
    -
    Pete Muir, Gavin King
    -
    -
  • -
-
-
-
- -
- -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

-
- - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/Disposes.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/Disposes.html deleted file mode 100644 index 586e2b709b..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/Disposes.html +++ /dev/null @@ -1,281 +0,0 @@ - - - - - -Disposes (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Annotation Type Disposes

-
-
-
-
    -
  • -
    -
    @Target(PARAMETER)
    -@Retention(RUNTIME)
    -@Documented
    -public @interface Disposes
    -

    - Identifies the disposed parameter of a disposer method. May be applied to a parameter of a method of a bean class. -

    - -
    - public class UserDatabaseEntityManager {
    - 
    -     @Produces
    -     @ConversationScoped
    -     @UserDatabase
    -     public EntityManager create(EntityManagerFactory emf) {
    -         return emf.createEntityManager();
    -     }
    - 
    -     public void close(@Disposes @UserDatabase EntityManager em) {
    -         em.close();
    -     }
    - 
    - }
    - 
    - -
    - public class Resources {
    - 
    -     @PersistenceContext
    -     @Produces
    -     @UserDatabase
    -     private EntityManager em;
    - 
    -     public void close(@Disposes @UserDatabase EntityManager em) {
    -         em.close();
    -     }
    - 
    - }
    - 
    - -

    - A disposer method allows the application to perform customized cleanup of an object returned by a - producer method or producer field. -

    - -

    - 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 - static method of the bean class. -

    - -

    - A bean may declare multiple disposer methods. -

    - -

    - Each disposer method must have exactly one disposed parameter, of the same type as the corresponding producer method or - producer field return type. When searching for disposer methods for a producer method or producer field, the container - considers the type and qualifiers of the disposed parameter. If a disposed parameter resolves to a producer method or - producer field declared by the same bean class, the container must call this method when destroying any instance returned by - that producer method or producer field. -

    - -

    - In addition to the disposed parameter, a disposer method may declare additional parameters, which may also specify - qualifiers. These additional parameters are injection points. -

    - -
    - public void close(@Disposes @UserDatabase EntityManager em, Logger log) { ... }
    - 
    - -

    - A disposer method may resolve to multiple producer methods or producer fields declared by the bean class, in which case the - container must call it when destroying any instance returned by any of these producer methods or producer fields. -

    - -

    - Disposer methods are not inherited by bean subclasses. -

    - -

    - Interceptors and decorators may not declare disposer methods. -

    -
    -
    Author:
    -
    Gavin King, Pete Muir
    -
    See Also:
    -
    Produces
    -
    -
  • -
-
-
-
- -
- -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

-
- - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/IllegalProductException.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/IllegalProductException.html deleted file mode 100644 index 106d17e1bb..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/IllegalProductException.html +++ /dev/null @@ -1,354 +0,0 @@ - - - - - -IllegalProductException (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Class IllegalProductException

-
-
-
    -
  • java.lang.Object
  • -
  • - -
  • -
-
-
    -
  • -
    -
    All Implemented Interfaces:
    -
    java.io.Serializable
    -
    -
    -
    public class IllegalProductException
    -extends InjectionException
    -

    - Indicates that a producer method returned a null value or a producer field contained a null value, and the scope of the - producer method or field was not Dependent. -

    -
    -
    See Also:
    -
    Serialized Form
    -
    -
  • -
-
-
-
    -
  • - -
    - -
    - -
    -
      -
    • - - -

      Method Summary

      -
        -
      • - - -

        Methods inherited from class java.lang.Throwable

        -addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
      • -
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

        -clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
      • -
      -
    • -
    -
    -
  • -
-
-
-
    -
  • - -
    -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        IllegalProductException

        -
        public IllegalProductException()
        -
      • -
      - - - -
        -
      • -

        IllegalProductException

        -
        public IllegalProductException​(java.lang.String message,
        -                               java.lang.Throwable cause)
        -
      • -
      - - - -
        -
      • -

        IllegalProductException

        -
        public IllegalProductException​(java.lang.String message)
        -
      • -
      - - - -
        -
      • -

        IllegalProductException

        -
        public IllegalProductException​(java.lang.Throwable cause)
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- - - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/InjectionException.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/InjectionException.html deleted file mode 100644 index 50c8bee0e6..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/InjectionException.html +++ /dev/null @@ -1,352 +0,0 @@ - - - - - -InjectionException (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Class InjectionException

-
-
-
    -
  • java.lang.Object
  • -
  • -
      -
    • java.lang.Throwable
    • -
    • -
        -
      • java.lang.Exception
      • -
      • -
          -
        • java.lang.RuntimeException
        • -
        • -
            -
          • jakarta.enterprise.inject.InjectionException
          • -
          -
        • -
        -
      • -
      -
    • -
    -
  • -
-
- -
-
-
    -
  • - -
    - -
    - -
    -
      -
    • - - -

      Method Summary

      -
        -
      • - - -

        Methods inherited from class java.lang.Throwable

        -addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
      • -
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

        -clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
      • -
      -
    • -
    -
    -
  • -
-
-
-
    -
  • - -
    -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        InjectionException

        -
        public InjectionException()
        -
      • -
      - - - -
        -
      • -

        InjectionException

        -
        public InjectionException​(java.lang.String message,
        -                          java.lang.Throwable throwable)
        -
      • -
      - - - -
        -
      • -

        InjectionException

        -
        public InjectionException​(java.lang.String message)
        -
      • -
      - - - -
        -
      • -

        InjectionException

        -
        public InjectionException​(java.lang.Throwable throwable)
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- - - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/Instance.Handle.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/Instance.Handle.html deleted file mode 100644 index 5cc7ed0c0f..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/Instance.Handle.html +++ /dev/null @@ -1,358 +0,0 @@ - - - - - -Instance.Handle (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Interface Instance.Handle<T>

-
-
-
-
    -
  • -
    -
    Type Parameters:
    -
    T - the required bean type
    -
    -
    -
    All Superinterfaces:
    -
    java.lang.AutoCloseable
    -
    -
    -
    Enclosing interface:
    -
    Instance<T>
    -
    -
    -
    public static interface Instance.Handle<T>
    -extends java.lang.AutoCloseable
    -
    This interface represents a contextual reference handle. -

    - Allows to inspect the metadata of the relevant bean before resolving its contextual reference and also to destroy - the underlying contextual instance. -

    -
    -
    Author:
    -
    Matej Novotny
    -
    -
  • -
-
-
- -
-
-
    -
  • - -
    -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        get

        -
        T get()
        -
        The contextual reference is obtained lazily, i.e. when first needed.
        -
        -
        Returns:
        -
        the contextual reference
        -
        Throws:
        -
        java.lang.IllegalStateException - If the producing Instance does not exist
        -
        java.lang.IllegalStateException - If invoked on Instance.Handle that previously successfully destroyed its - underlying contextual reference
        -
        See Also:
        -
        Provider.get()
        -
        -
      • -
      - - - -
        -
      • -

        getBean

        -
        Bean<T> getBean()
        -
        -
        Returns:
        -
        the bean metadata
        -
        -
      • -
      - - - -
        -
      • -

        destroy

        -
        void destroy()
        -
        Destroy the contextual instance. - - It's a no-op if: -
          -
        • called multiple times
        • -
        • if the producing Instance does not exist
        • -
        • if the handle does not hold a contextual reference, i.e. get() was never called
        • -
        -
        -
        See Also:
        -
        Instance.destroy(Object)
        -
        -
      • -
      - - - -
        -
      • -

        close

        -
        void close()
        -
        Delegates to destroy().
        -
        -
        Specified by:
        -
        close in interface java.lang.AutoCloseable
        -
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- -
- -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

-
- - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/Instance.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/Instance.html deleted file mode 100644 index 3e89110113..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/Instance.html +++ /dev/null @@ -1,708 +0,0 @@ - - - - - -Instance (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Interface Instance<T>

-
-
-
-
    -
  • -
    -
    Type Parameters:
    -
    T - the required bean type
    -
    -
    -
    All Superinterfaces:
    -
    java.lang.Iterable<T>, jakarta.inject.Provider<T>
    -
    -
    -
    All Known Subinterfaces:
    -
    SeContainer
    -
    -
    -
    All Known Implementing Classes:
    -
    CDI
    -
    -
    -
    public interface Instance<T>
    -extends java.lang.Iterable<T>, jakarta.inject.Provider<T>
    -

    - Allows the application to dynamically obtain instances of beans with a specified combination of required type and qualifiers. -

    - -

    - In certain situations, injection is not the most convenient way to obtain a contextual reference. For example, it may not be - used when: -

    - -
      -
    • the bean type or qualifiers vary dynamically at runtime, or
    • -
    • depending upon the deployment, there may be no bean which satisfies the type and qualifiers, or
    • -
    • we would like to iterate over all beans of a certain type.
    • -
    - -

    - In these situations, an instance of the Instance may be injected: -

    - -
    - @Inject
    - Instance<PaymentProcessor> paymentProcessor;
    - 
    - -

    - Any combination of qualifiers may be specified at the injection point: -

    - -
    - @Inject
    - @PayBy(CHEQUE)
    - Instance<PaymentProcessor> chequePaymentProcessor;
    - 
    - -

    - Or, the @Any qualifier may be used, allowing the application to specify qualifiers - dynamically: -

    - -
    - @Inject
    - @Any
    - Instance<PaymentProcessor> anyPaymentProcessor;
    - 
    - -

    - For an injected Instance: -

    - -
      -
    • the required type is the type parameter specified at the injection point, and
    • -
    • the required qualifiers are the qualifiers specified at the injection point.
    • -
    - -

    - The inherited Provider.get() method returns a contextual references for the unique bean that matches the - required type and required qualifiers and is eligible for injection into the class into which the parent Instance - was injected, or throws an UnsatisfiedResolutionException or - AmbiguousResolutionException. -

    - -
    - PaymentProcessor pp = chequePaymentProcessor.get();
    - 
    - -

    - The inherited Iterable.iterator() method returns an iterator over contextual references for beans that - match the required type and required qualifiers and are eligible for injection into the class into which the parent - Instance was injected. -

    - -
    - for (PaymentProcessor pp : anyPaymentProcessor)
    -     pp.test();
    - 
    -
    -
    Author:
    -
    Gavin King, John Ament, Martin Kouba
    -
    See Also:
    -
    Provider.get(), -Iterable.iterator(), -AnnotationLiteral, -TypeLiteral
    -
    -
  • -
-
-
-
    -
  • - -
    -
      -
    • - - -

      Nested Class Summary

      - - - - - - - - - - - - -
      Nested Classes 
      Modifier and TypeInterfaceDescription
      static interface Instance.Handle<T> -
      This interface represents a contextual reference handle.
      -
      -
    • -
    -
    - -
    -
      -
    • - - -

      Method Summary

      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      All Methods Instance Methods Abstract Methods Default Methods 
      Modifier and TypeMethodDescription
      voiddestroy​(T instance) -
      - When called, the container destroys the instance if the active context object for the scope type of the bean supports - destroying bean instances.
      -
      Instance.Handle<T>getHandle() -
      Obtains an initialized contextual reference handle for a bean that has the required type and qualifiers and is - eligible for injection.
      -
      java.lang.Iterable<? extends Instance.Handle<T>>handles() -
      Allows iterating over contextual reference handles for all beans that have the required type and required qualifiers and are eligible - for injection.
      -
      default java.util.stream.Stream<? extends Instance.Handle<T>>handlesStream() -
      Returns stream of Instance.Handle objects.
      -
      booleanisAmbiguous() -
      - Determines if there is more than one bean that matches the required type and qualifiers and is eligible for injection - into the class into which the parent Instance was injected.
      -
      default booleanisResolvable() -
      - Determines if there is exactly one bean that matches the required type and qualifiers and is eligible for injection - into the class into which the parent Instance was injected.
      -
      booleanisUnsatisfied() -
      - Determines if there is no bean that matches the required type and qualifiers and is eligible for injection into the class - into which the parent Instance was injected.
      -
      <U extends T>
      Instance<U>
      select​(TypeLiteral<U> subtype, - java.lang.annotation.Annotation... qualifiers) -
      - Obtains a child Instance for the given required type and additional required qualifiers.
      -
      Instance<T>select​(java.lang.annotation.Annotation... qualifiers) -
      - Obtains a child Instance for the given additional required qualifiers.
      -
      <U extends T>
      Instance<U>
      select​(java.lang.Class<U> subtype, - java.lang.annotation.Annotation... qualifiers) -
      - Obtains a child Instance for the given required type and additional required qualifiers.
      -
      default java.util.stream.Stream<T>stream() -
      - When called, provides back a Stream of the beans available in this Instance.
      -
      -
        -
      • - - -

        Methods inherited from interface java.lang.Iterable

        -forEach, iterator, spliterator
      • -
      -
        -
      • - - -

        Methods inherited from interface jakarta.inject.Provider

        -get
      • -
      -
    • -
    -
    -
  • -
-
-
-
    -
  • - -
    -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        select

        -
        Instance<T> select​(java.lang.annotation.Annotation... qualifiers)
        -

        - Obtains a child Instance for the given additional required qualifiers. -

        -
        -
        Parameters:
        -
        qualifiers - the additional required qualifiers
        -
        Returns:
        -
        the child Instance
        -
        Throws:
        -
        java.lang.IllegalArgumentException - if passed two instances of the same non repeating qualifier type, or an instance of an annotation that - is not a qualifier type
        -
        java.lang.IllegalStateException - if the container is already shutdown
        -
        -
      • -
      - - - -
        -
      • -

        select

        -
        <U extends TInstance<U> select​(java.lang.Class<U> subtype,
        -                                 java.lang.annotation.Annotation... qualifiers)
        -

        - Obtains a child Instance for the given required type and additional required qualifiers. -

        -
        -
        Type Parameters:
        -
        U - the required type
        -
        Parameters:
        -
        subtype - a Class representing the required type
        -
        qualifiers - the additional required qualifiers
        -
        Returns:
        -
        the child Instance
        -
        Throws:
        -
        java.lang.IllegalArgumentException - if passed two instances of the same non repeating qualifier type, or an instance of an annotation that - is not a qualifier type
        -
        java.lang.IllegalStateException - if the container is already shutdown
        -
        -
      • -
      - - - -
        -
      • -

        select

        -
        <U extends TInstance<U> select​(TypeLiteral<U> subtype,
        -                                 java.lang.annotation.Annotation... qualifiers)
        -

        - Obtains a child Instance for the given required type and additional required qualifiers. -

        -
        -
        Type Parameters:
        -
        U - the required type
        -
        Parameters:
        -
        subtype - a TypeLiteral representing the required type
        -
        qualifiers - the additional required qualifiers
        -
        Returns:
        -
        the child Instance
        -
        Throws:
        -
        java.lang.IllegalArgumentException - if passed two instances of the same non repeating qualifier type, or an instance of an annotation that - is not a qualifier type
        -
        java.lang.IllegalStateException - if the container is already shutdown
        -
        -
      • -
      - - - -
        -
      • -

        stream

        -
        default java.util.stream.Stream<T> stream()
        -

        - When called, provides back a Stream of the beans available in this Instance. If no beans are found, it returns an empty - stream. -

        -
        -
        Returns:
        -
        a Stream representing the beans associated with this Instance object
        -
        Since:
        -
        2.0
        -
        -
      • -
      - - - -
        -
      • -

        isUnsatisfied

        -
        boolean isUnsatisfied()
        -

        - Determines if there is no bean that matches the required type and qualifiers and is eligible for injection into the class - into which the parent Instance was injected. -

        -
        -
        Returns:
        -
        true if there is no bean that matches the required type and qualifiers and is eligible for injection - into the class into which the parent Instance was injected, or false otherwise.
        -
        -
      • -
      - - - -
        -
      • -

        isAmbiguous

        -
        boolean isAmbiguous()
        -

        - Determines if there is more than one bean that matches the required type and qualifiers and is eligible for injection - into the class into which the parent Instance was injected. -

        -
        -
        Returns:
        -
        true if there is more than one bean that matches the required type and qualifiers and is eligible for - injection into the class into which the parent Instance was injected, or false otherwise.
        -
        -
      • -
      - - - -
        -
      • -

        isResolvable

        -
        default boolean isResolvable()
        -

        - Determines if there is exactly one bean that matches the required type and qualifiers and is eligible for injection - into the class into which the parent Instance was injected. -

        -
        -
        Returns:
        -
        true if there is exactly one bean that matches the required type and qualifiers and is eligible for - injection into the class into which the parent Instance was injected, or false otherwise.
        -
        Since:
        -
        2.0
        -
        -
      • -
      - - - - - -
        -
      • -

        destroy

        -
        void destroy​(T instance)
        -

        - When called, the container destroys the instance if the active context object for the scope type of the bean supports - destroying bean instances. All normal scoped built-in contexts support destroying bean instances. -

        - -

        - The instance passed should either be a dependent scoped bean instance obtained from the same Instance object, or - the client proxy for a normal scoped bean instance. -

        -
        -
        Parameters:
        -
        instance - the instance to destroy
        -
        Throws:
        -
        java.lang.UnsupportedOperationException - if the active context object for the scope type of the bean does not support - destroying bean instances
        -
        Since:
        -
        1.1
        -
        -
      • -
      - - - -
        -
      • -

        getHandle

        -
        Instance.Handle<T> getHandle()
        -
        Obtains an initialized contextual reference handle for a bean that has the required type and qualifiers and is - eligible for injection. Throws exceptions if there is no such bean or more than one. - -

        - The contextual reference is obtained lazily, i.e. when first needed. -

        -
        -
        Returns:
        -
        a new Instance.Handle instnace
        -
        Throws:
        -
        UnsatisfiedResolutionException - if there is no bean with given type and qualifiers
        -
        AmbiguousResolutionException - if there is more than one bean given type and qualifiers
        -
        -
      • -
      - - - -
        -
      • -

        handles

        -
        java.lang.Iterable<? extends Instance.Handle<T>> handles()
        -
        Allows iterating over contextual reference handles for all beans that have the required type and required qualifiers and are eligible - for injection. - -

        - Note that the returned Iterable is stateless. Therefore, each Iterable.iterator() produces a new set of handles. -

        -
        -
        Returns:
        -
        a new iterable
        -
        -
      • -
      - - - -
        -
      • -

        handlesStream

        -
        default java.util.stream.Stream<? extends Instance.Handle<T>> handlesStream()
        -
        Returns stream of Instance.Handle objects.
        -
        -
        Returns:
        -
        a new stream of contextual reference handles
        -
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- - - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/Intercepted.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/Intercepted.html deleted file mode 100644 index 1dadc24603..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/Intercepted.html +++ /dev/null @@ -1,217 +0,0 @@ - - - - - -Intercepted (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Annotation Type Intercepted

-
-
-
-
    -
  • -
    -
    @Target({PARAMETER,FIELD})
    -@Retention(RUNTIME)
    -@Documented
    -@Qualifier
    -public @interface Intercepted
    -

    - An interceptor may inject metadata about the bean it is intercepting. -

    - -
    - @Transactional @Interceptor
    - public class TransactionInterceptor {
    - 
    -    @Inject @Intercepted Bean<?> bean;
    - 
    -    @AroundInvoke 
    -    public Object manageTransaction(InvocationContext ctx) throws Exception { ... }
    - 
    - }
    - 
    -
    -
    Since:
    -
    1.1
    -
    Author:
    -
    Pete Muir
    -
    -
  • -
-
-
-
- -
- -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

-
- - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/Model.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/Model.html deleted file mode 100644 index f0650224cb..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/Model.html +++ /dev/null @@ -1,208 +0,0 @@ - - - - - -Model (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Annotation Type Model

-
-
-
-
    -
  • -
    -
    @Named
    -@RequestScoped
    -@Documented
    -@Stereotype
    -@Target({TYPE,METHOD,FIELD})
    -@Retention(RUNTIME)
    -public @interface Model
    -

    - The built-in stereotype intended for use with beans that define the model layer of an MVC web application architecture such - as JSF. -

    -
    -
    Author:
    -
    Gavin King
    -
    See Also:
    -
    Stereotype
    -
    -
  • -
-
-
-
- -
- -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

-
- - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/Produces.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/Produces.html deleted file mode 100644 index accb793332..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/Produces.html +++ /dev/null @@ -1,281 +0,0 @@ - - - - - -Produces (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Annotation Type Produces

-
-
-
-
    -
  • -
    -
    @Target({METHOD,FIELD})
    -@Retention(RUNTIME)
    -@Documented
    -public @interface Produces
    -

    - Identifies a producer method or field. May be applied to a method or field of a bean class. -

    - -

    - 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 - or a static method of the bean class. -

    - -
    - public class Shop {
    -    @Produces @ApplicationScoped 
    -    @Catalog @Named("catalog") 
    -    List<Product> getProducts() { ... }
    -    ...
    - }
    - 
    - -

    - A producer field must be a field of a managed bean class or session bean class. A producer field may be either static or - non-static. If the bean is a session bean, the producer field must be a static field of the bean class. -

    - -
    - public class Shop { 
    -    @Produces @ApplicationScoped 
    -    @Catalog @Named("catalog") 
    -    List<Product> products = ...;
    -    ...
    - }
    - 
    - -

    - If a producer method sometimes returns a null value, or if a producer field sometimes contains a null value when accessed, - then the producer method or field must have scope @Dependent. -

    - -

    - A producer method return type or producer field type may not be a type variable. -

    - -

    - If the producer method return type or producer field type is a parameterized type, it must specify an actual type parameter - or type variable for each type parameter. -

    - -

    - If the producer method return type or producer field type is a parameterized type with a type variable, it must have scope - @Dependent. -

    - -

    - A producer method may have any number of parameters. All producer method parameters are injection points. -

    - -
    - public class OrderFactory {
    - 
    -     @Produces
    -     @ConversationScoped
    -     public Order createCurrentOrder(Shop shop, @Selected Product product) {
    -         Order order = new Order(product, shop);
    -         return order;
    -     }
    - 
    - }
    - 
    - -

    - A bean may declare multiple producer methods or fields. -

    - -

    - Producer methods and fields are not inherited by bean subclasses. -

    - -

    - Interceptors and decorators may not declare producer methods or fields. -

    -
    -
    Author:
    -
    Gavin King, Pete Muir
    -
    See Also:
    -
    Disposes
    -
    -
  • -
-
-
-
- -
- -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

-
- - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/ResolutionException.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/ResolutionException.html deleted file mode 100644 index fc613878ea..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/ResolutionException.html +++ /dev/null @@ -1,357 +0,0 @@ - - - - - -ResolutionException (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Class ResolutionException

-
-
-
    -
  • java.lang.Object
  • -
  • - -
  • -
-
- -
-
-
    -
  • - -
    - -
    - -
    -
      -
    • - - -

      Method Summary

      -
        -
      • - - -

        Methods inherited from class java.lang.Throwable

        -addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
      • -
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

        -clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
      • -
      -
    • -
    -
    -
  • -
-
-
-
    -
  • - -
    -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        ResolutionException

        -
        public ResolutionException()
        -
      • -
      - - - -
        -
      • -

        ResolutionException

        -
        public ResolutionException​(java.lang.String message,
        -                           java.lang.Throwable cause)
        -
      • -
      - - - -
        -
      • -

        ResolutionException

        -
        public ResolutionException​(java.lang.String message)
        -
      • -
      - - - -
        -
      • -

        ResolutionException

        -
        public ResolutionException​(java.lang.Throwable cause)
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- - - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/Specializes.Literal.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/Specializes.Literal.html deleted file mode 100644 index de55d5803e..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/Specializes.Literal.html +++ /dev/null @@ -1,372 +0,0 @@ - - - - - -Specializes.Literal (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Class Specializes.Literal

-
-
- -
- -
-
-
    -
  • - -
    - -
    - -
    - -
    - -
    -
      -
    • - - -

      Constructor Summary

      - - - - - - - - - - -
      Constructors 
      ConstructorDescription
      Literal() 
      -
    • -
    -
    - -
    -
      -
    • - - -

      Method Summary

      - -
        -
      • - - -

        Methods inherited from class java.lang.Object

        -clone, finalize, getClass, notify, notifyAll, wait, wait, wait
      • -
      -
        -
      • - - -

        Methods inherited from interface java.lang.annotation.Annotation

        -annotationType, equals, hashCode, toString
      • -
      -
    • -
    -
    -
  • -
-
-
-
    -
  • - -
    - -
    - -
    -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        Literal

        -
        public Literal()
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- - - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/Specializes.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/Specializes.html deleted file mode 100644 index fe4d3187a3..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/Specializes.html +++ /dev/null @@ -1,233 +0,0 @@ - - - - - -Specializes (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Annotation Type Specializes

-
-
-
-
    -
  • -
    -
    @Target({TYPE,METHOD})
    -@Retention(RUNTIME)
    -@Documented
    -public @interface Specializes
    -

    - Indicates that a bean directly specializes another bean. May be applied to a bean class or producer method. -

    - -

    - If a bean directly specializes a second bean, it inherits: -

    - -
      -
    • all qualifiers of the second bean, and
    • -
    • the name, if any, of the second bean.
    • -
    - -

    - If the second bean has a name, the bean may not declare a name using @Named. Furthermore, the - bean must have all the bean types of the second bean. -

    - -
      -
    • If a bean class of a managed bean is annotated @Specializes , then the bean class must directly extend the - bean class of a second managed bean. Then the first managed bean directly specializes the second managed bean.
    • - -
    • If a bean class of a session bean is annotated @Specializes , then the bean class must directly extend the - bean class of a second session bean. Then the first session bean directly specializes the second session bean.
    • - -
    • If a producer method is annotated @Specializes, then it must be non-static and directly override another - producer method. Then the first producer method directly specializes the second producer method.
    • -
    - -

    - If a bean is specialized by any enabled bean, the first bean is disabled. -

    - -

    CDI Lite implementations are not required to provide support for specialization.

    -
    -
    Author:
    -
    Gavin King, Pete Muir
    -
    -
  • -
-
-
-
- -
- -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

-
- - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/Stereotype.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/Stereotype.html deleted file mode 100644 index b5fba13298..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/Stereotype.html +++ /dev/null @@ -1,315 +0,0 @@ - - - - - -Stereotype (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Annotation Type Stereotype

-
-
-
-
    -
  • -
    -
    @Retention(RUNTIME)
    -@Target(ANNOTATION_TYPE)
    -@Documented
    -public @interface Stereotype
    -

    - Specifies that an annotation type is a stereotype. -

    - -

    - In many systems, use of architectural patterns produces a set of recurring bean roles. A stereotype allows a framework - developer to identify such a role and declare some common metadata for beans with that role in a central place. -

    - -

    - A bean may declare zero, one or multiple stereotypes, by applying the stereotype annotation to the bean class or producer - method or field. -

    - -

    - A stereotype encapsulates any combination of: -

    - -
      -
    • a default scope, and
    • -
    • a set of interceptor bindings.
    • -
    - -

    - The default scope of a stereotype is defined by annotating the stereotype with a scope type. A stereotype may declare at most - one scope. If a bean explicitly declares a scope, any default scopes declared by its stereotypes are ignored. -

    - -
    - @RequestScoped
    - @Stereotype
    - @Target(TYPE)
    - @Retention(RUNTIME)
    - public @interface Action {
    - }
    - 
    - -

    - The interceptor bindings of a stereotype are defined by annotating the stereotype with the interceptor binding types. A - stereotype may declare zero, one or multiple interceptor bindings. An interceptor binding declared by a stereotype is - inherited by any bean that declares that stereotype. -

    - -
    - @RequestScoped
    - @Secure
    - @Transactional
    - @Stereotype
    - @Target(TYPE)
    - @Retention(RUNTIME)
    - public @interface Action {
    - }
    - 
    - -

    - A stereotype may also specify that: -

    - -
      -
    • all beans with the stereotype have defaulted bean EL names, or that
    • -
    • all beans with the stereotype are alternatives, or that
    • -
    • all beans with the stereotype have predefined @Priority.
    • -
    - -

    - A stereotype may declare an empty @Named annotation, which specifies that every bean with the - stereotype has a defaulted name when a name is not explicitly specified by the bean. -

    - -
    - @RequestScoped
    - @Named
    - @Secure
    - @Transactional
    - @Stereotype
    - @Target(TYPE)
    - @Retention(RUNTIME)
    - public @interface Action {
    - }
    - 
    - -

    - A stereotype may declare an @Alternative annotation, which specifies that - every bean with the stereotype is an alternative. -

    - -
    - @Alternative
    - @Stereotype
    - @Target(TYPE)
    - @Retention(RUNTIME)
    - public @interface Mock {
    - }
    - 
    - -

    - A stereotype may declare a @Priority annotation, which specifies that - every bean with the stereotype is enabled and has given priority. -

    - -
    - @Alternative
    - @Priority(1)
    - @Stereotype
    - @Target(TYPE)
    - @Retention(RUNTIME)
    - public @interface Mock {
    - }
    - 
    - -

    - A stereotype may declare other stereotypes. Stereotype declarations are transitive. A stereotype declared by a second - stereotype is inherited by all beans and other stereotypes that declare the second stereotype. -

    -
    -
    Author:
    -
    Pete Muir, Gavin King
    -
    See Also:
    -
    the built-in stereotype Model
    -
    -
  • -
-
-
-
- -
- -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

-
- - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/TransientReference.Literal.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/TransientReference.Literal.html deleted file mode 100644 index a3a3beb87c..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/TransientReference.Literal.html +++ /dev/null @@ -1,372 +0,0 @@ - - - - - -TransientReference.Literal (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Class TransientReference.Literal

-
-
- -
- -
-
- -
-
- -
-
-
- - - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/TransientReference.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/TransientReference.html deleted file mode 100644 index bc27b8cbd0..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/TransientReference.html +++ /dev/null @@ -1,216 +0,0 @@ - - - - - -TransientReference (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Annotation Type TransientReference

-
-
-
-
    -
  • -
    -
    @Target(PARAMETER)
    -@Retention(RUNTIME)
    -@Documented
    -public @interface TransientReference
    -

    - If a parameter annotated with @TransientReference resolves to a dependent scoped bean, then the bean will be - destroyed after the invocation completes. -

    - -
    - public class OrderManager {
    - 
    -     @Inject 
    -     public OrderManager(@TransientReference Order order) {
    -        ...
    -    
    -     }
    - }
    - 
    -
    -
    Since:
    -
    1.1
    -
    Author:
    -
    Pete Muir
    -
    -
  • -
-
-
-
- -
- -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

-
- - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/Typed.Literal.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/Typed.Literal.html deleted file mode 100644 index 7ad2340c68..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/Typed.Literal.html +++ /dev/null @@ -1,382 +0,0 @@ - - - - - -Typed.Literal (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Class Typed.Literal

-
-
- -
-
    -
  • -
    -
    All Implemented Interfaces:
    -
    java.lang.annotation.Annotation
    -
    -
    -
    Enclosing class:
    -
    Typed
    -
    -
    -
    public static final class Typed.Literal
    -extends AnnotationLiteral<Typed>
    -implements Typed
    -
    Supports inline instantiation of the Typed annotation.
    -
    -
    Since:
    -
    2.0
    -
    Author:
    -
    Martin Kouba
    -
    See Also:
    -
    Serialized Form
    -
    -
  • -
-
-
- -
-
-
    -
  • - -
    - -
    - -
    -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        of

        -
        public static Typed.Literal of​(java.lang.Class<?>[] value)
        -
      • -
      - - - -
        -
      • -

        value

        -
        public java.lang.Class<?>[] value()
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- - - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/Typed.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/Typed.html deleted file mode 100644 index 7502e8c140..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/Typed.html +++ /dev/null @@ -1,285 +0,0 @@ - - - - - -Typed (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Annotation Type Typed

-
-
-
-
    -
  • -
    -
    @Target({FIELD,METHOD,TYPE})
    -@Retention(RUNTIME)
    -@Documented
    -public @interface Typed
    -

    - Restricts the bean types of a bean. May be applied to a bean class or producer method or field. -

    - -
    - @Typed(Shop.class)
    - public class BookShop
    -       extends Business
    -       implements Shop<Book> {
    -    ...
    - }
    - 
    - -

    - When a @Typed annotation is specified, only the types whose classes are explicitly listed using the - value member, along with Object, are bean types of the bean. -

    -
    -
    Author:
    -
    Pete Muir, Gavin King
    -
    -
  • -
-
-
-
    -
  • - -
    -
      -
    • - - -

      Optional Element Summary

      - - - - - - - - - - - - -
      Optional Elements 
      Modifier and TypeOptional ElementDescription
      java.lang.Class<?>[]value -
      - Selects the bean types of the bean.
      -
      -
    • -
    -
    -
  • -
-
-
-
    -
  • - -
    -
      -
    • - - -

      Element Detail

      - - - -
        -
      • -

        value

        -
        java.lang.Class<?>[] value
        -

        - Selects the bean types of the bean. Every class must correspond to a type in the unrestricted set of bean types of a - bean. -

        -
        -
        Returns:
        -
        the classes corresponding to the bean types of the bean
        -
        -
        -
        Default:
        -
        {}
        -
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- - - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/UnproxyableResolutionException.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/UnproxyableResolutionException.html deleted file mode 100644 index dcfa35162f..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/UnproxyableResolutionException.html +++ /dev/null @@ -1,361 +0,0 @@ - - - - - -UnproxyableResolutionException (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Class UnproxyableResolutionException

-
-
- -
-
    -
  • -
    -
    All Implemented Interfaces:
    -
    java.io.Serializable
    -
    -
    -
    public class UnproxyableResolutionException
    -extends ResolutionException
    -

    - Indicates that a contextual reference for a bean with a normal scope and a certain bean type cannot be obtained because the - bean type cannot be proxied by the container. -

    -
    -
    Author:
    -
    Pete Muir, Gavin King
    -
    See Also:
    -
    Serialized Form
    -
    -
  • -
-
-
-
    -
  • - -
    - -
    - -
    -
      -
    • - - -

      Method Summary

      -
        -
      • - - -

        Methods inherited from class java.lang.Throwable

        -addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
      • -
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

        -clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
      • -
      -
    • -
    -
    -
  • -
-
-
-
    -
  • - -
    -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        UnproxyableResolutionException

        -
        public UnproxyableResolutionException()
        -
      • -
      - - - -
        -
      • -

        UnproxyableResolutionException

        -
        public UnproxyableResolutionException​(java.lang.String message,
        -                                      java.lang.Throwable throwable)
        -
      • -
      - - - -
        -
      • -

        UnproxyableResolutionException

        -
        public UnproxyableResolutionException​(java.lang.String message)
        -
      • -
      - - - -
        -
      • -

        UnproxyableResolutionException

        -
        public UnproxyableResolutionException​(java.lang.Throwable throwable)
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- - - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/UnsatisfiedResolutionException.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/UnsatisfiedResolutionException.html deleted file mode 100644 index c334cc0fa9..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/UnsatisfiedResolutionException.html +++ /dev/null @@ -1,361 +0,0 @@ - - - - - -UnsatisfiedResolutionException (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Class UnsatisfiedResolutionException

-
-
- -
-
    -
  • -
    -
    All Implemented Interfaces:
    -
    java.io.Serializable
    -
    -
    -
    public class UnsatisfiedResolutionException
    -extends ResolutionException
    -

    - Indicates that no bean matches a certain combination of required type and required qualifiers and is eligible for injection - into a certain class. -

    -
    -
    Author:
    -
    Pete Muir, Gavin King
    -
    See Also:
    -
    Serialized Form
    -
    -
  • -
-
-
-
    -
  • - -
    - -
    - -
    -
      -
    • - - -

      Method Summary

      -
        -
      • - - -

        Methods inherited from class java.lang.Throwable

        -addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
      • -
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

        -clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
      • -
      -
    • -
    -
    -
  • -
-
-
-
    -
  • - -
    -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        UnsatisfiedResolutionException

        -
        public UnsatisfiedResolutionException()
        -
      • -
      - - - -
        -
      • -

        UnsatisfiedResolutionException

        -
        public UnsatisfiedResolutionException​(java.lang.String message,
        -                                      java.lang.Throwable throwable)
        -
      • -
      - - - -
        -
      • -

        UnsatisfiedResolutionException

        -
        public UnsatisfiedResolutionException​(java.lang.String message)
        -
      • -
      - - - -
        -
      • -

        UnsatisfiedResolutionException

        -
        public UnsatisfiedResolutionException​(java.lang.Throwable throwable)
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- - - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/Vetoed.Literal.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/Vetoed.Literal.html deleted file mode 100644 index d65a10cf7d..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/Vetoed.Literal.html +++ /dev/null @@ -1,372 +0,0 @@ - - - - - -Vetoed.Literal (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Class Vetoed.Literal

-
-
- -
- -
-
-
    -
  • - -
    -
      -
    • - - -

      Nested Class Summary

      - -
    • -
    -
    - -
    - -
    - -
    -
      -
    • - - -

      Constructor Summary

      - - - - - - - - - - -
      Constructors 
      ConstructorDescription
      Literal() 
      -
    • -
    -
    - -
    -
      -
    • - - -

      Method Summary

      - -
        -
      • - - -

        Methods inherited from class java.lang.Object

        -clone, finalize, getClass, notify, notifyAll, wait, wait, wait
      • -
      -
        -
      • - - -

        Methods inherited from interface java.lang.annotation.Annotation

        -annotationType, equals, hashCode, toString
      • -
      -
    • -
    -
    -
  • -
-
-
-
    -
  • - -
    - -
    - -
    -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        Literal

        -
        public Literal()
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- - - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/Vetoed.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/Vetoed.html deleted file mode 100644 index f1c4e1ba73..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/Vetoed.html +++ /dev/null @@ -1,215 +0,0 @@ - - - - - -Vetoed (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Annotation Type Vetoed

-
-
-
-
    -
  • -
    -
    @Target({TYPE,PACKAGE})
    -@Retention(RUNTIME)
    -@Documented
    -public @interface Vetoed
    -

    - Veto the processing of the class. Any beans or observer methods defined by this class will not be installed. -

    - -

    - When placed on package, all beans in the package are prevented from being installed. If packages are split across jars, - non-portable behavior results. An application can prevent packages being split across jars by sealing the package. -

    - -

    - No container lifecycle events are fired for classes annotated Vetoed. -

    -
    -
    Since:
    -
    1.1
    -
    Author:
    -
    Stuart Douglas
    -
    See Also:
    -
    JAR File Specification
    -
    -
  • -
-
-
-
- -
- -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

-
- - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/AnnotationBuilder.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/AnnotationBuilder.html deleted file mode 100644 index dba79a1e80..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/AnnotationBuilder.html +++ /dev/null @@ -1,2120 +0,0 @@ - - - - - -AnnotationBuilder (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Interface AnnotationBuilder

-
-
-
-
    -
  • -
    -
    public interface AnnotationBuilder
    -
    Builder for annotations of given type. - Expected usage is: -
      -
    1. create the builder using of(Class) or of(ClassInfo);
    2. -
    3. use the value() and member() methods to define annotation members;
    4. -
    5. call build() to create an AnnotationInfo.
    6. -
    - One builder instance should not be used to create multiple annotations. -

    - Note that values of all members of given annotation type must be defined before - calling build(), except of annotation members that declare a default value. - If a value is not defined for an annotation member that does not have a default value, - build() will throw an exception. -

    - Defining values of members that do not exist on given annotation type is possible, - and such members will be retained in the resulting AnnotationInfo. However, - if that AnnotationInfo is later transformed to an instance of the annotation - type, the non-existing members will disappear.

    -
    -
    Since:
    -
    4.0
    -
    -
  • -
-
-
-
    -
  • - -
    -
      -
    • - - -

      Method Summary

      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      All Methods Static Methods Instance Methods Abstract Methods Default Methods 
      Modifier and TypeMethodDescription
      AnnotationInfobuild() -
      Returns an AnnotationInfo that includes all annotation members defined by previous method calls - on this builder.
      -
      AnnotationBuildermember​(java.lang.String name, - boolean value) -
      Adds a boolean-valued annotation member with given name.
      -
      AnnotationBuildermember​(java.lang.String name, - boolean[] values) -
      Adds a boolean array-valued annotation member with given name.
      -
      AnnotationBuildermember​(java.lang.String name, - byte value) -
      Adds a byte-valued annotation member with given name.
      -
      AnnotationBuildermember​(java.lang.String name, - byte[] values) -
      Adds a byte array-valued annotation member with given name.
      -
      AnnotationBuildermember​(java.lang.String name, - char value) -
      Adds a char-valued annotation member with given name.
      -
      AnnotationBuildermember​(java.lang.String name, - char[] values) -
      Adds a char array-valued annotation member with given name.
      -
      AnnotationBuildermember​(java.lang.String name, - double value) -
      Adds a double-valued annotation member with given name.
      -
      AnnotationBuildermember​(java.lang.String name, - double[] values) -
      Adds a double array-valued annotation member with given name.
      -
      AnnotationBuildermember​(java.lang.String name, - float value) -
      Adds a float-valued annotation member with given name.
      -
      AnnotationBuildermember​(java.lang.String name, - float[] values) -
      Adds a float array-valued annotation member with given name.
      -
      AnnotationBuildermember​(java.lang.String name, - int value) -
      Adds an int-valued annotation member with given name.
      -
      AnnotationBuildermember​(java.lang.String name, - int[] values) -
      Adds an int array-valued annotation member with given name.
      -
      AnnotationBuildermember​(java.lang.String name, - long value) -
      Adds a long-valued annotation member with given name.
      -
      AnnotationBuildermember​(java.lang.String name, - long[] values) -
      Adds a long array-valued annotation member with given name.
      -
      AnnotationBuildermember​(java.lang.String name, - short value) -
      Adds a short-valued annotation member with given name.
      -
      AnnotationBuildermember​(java.lang.String name, - short[] values) -
      Adds a short array-valued annotation member with given name.
      -
      AnnotationBuildermember​(java.lang.String name, - AnnotationInfo value) -
      Adds an annotation-valued annotation member with given name.
      -
      AnnotationBuildermember​(java.lang.String name, - AnnotationInfo[] values) -
      Adds an annotation array-valued annotation member with given name.
      -
      AnnotationBuildermember​(java.lang.String name, - AnnotationMember value) -
      Adds an annotation member with given name, whose value is given value.
      -
      AnnotationBuildermember​(java.lang.String name, - ClassInfo value) -
      Adds a class-valued annotation member with given name.
      -
      AnnotationBuildermember​(java.lang.String name, - ClassInfo[] values) -
      Adds a class array-valued annotation member with given name.
      -
      AnnotationBuildermember​(java.lang.String name, - ClassInfo enumType, - java.lang.String enumValue) -
      Adds an enum-valued annotation member with given name.
      -
      AnnotationBuildermember​(java.lang.String name, - ClassInfo enumType, - java.lang.String[] enumValues) -
      Adds an enum array-valued annotation member with given name.
      -
      AnnotationBuildermember​(java.lang.String name, - Type value) -
      Adds a class-valued annotation member with given name.
      -
      AnnotationBuildermember​(java.lang.String name, - Type[] values) -
      Adds a class array-valued annotation member with given name.
      -
      AnnotationBuildermember​(java.lang.String name, - java.lang.annotation.Annotation value) -
      Adds an annotation-valued annotation member with given name.
      -
      AnnotationBuildermember​(java.lang.String name, - java.lang.annotation.Annotation[] values) -
      Adds an annotation array-valued annotation member with given name.
      -
      AnnotationBuildermember​(java.lang.String name, - java.lang.Class<?> value) -
      Adds a class-valued annotation member with given name.
      -
      AnnotationBuildermember​(java.lang.String name, - java.lang.Class<?>[] values) -
      Adds a class array-valued annotation member with given name.
      -
      AnnotationBuildermember​(java.lang.String name, - java.lang.Class<? extends java.lang.Enum<?>> enumType, - java.lang.String enumValue) -
      Adds an enum-valued annotation member with given name.
      -
      AnnotationBuildermember​(java.lang.String name, - java.lang.Class<? extends java.lang.Enum<?>> enumType, - java.lang.String[] enumValues) -
      Adds an enum array-valued annotation member with given name.
      -
      AnnotationBuildermember​(java.lang.String name, - java.lang.Enum<?> value) -
      Adds an enum-valued annotation member with given name.
      -
      AnnotationBuildermember​(java.lang.String name, - java.lang.Enum<?>[] values) -
      Adds an enum array-valued annotation member with given name.
      -
      AnnotationBuildermember​(java.lang.String name, - java.lang.String value) -
      Adds a String-valued annotation member with given name.
      -
      AnnotationBuildermember​(java.lang.String name, - java.lang.String[] values) -
      Adds a String array-valued annotation member with given name.
      -
      static AnnotationBuilderof​(ClassInfo annotationType) -
      Returns a new AnnotationBuilder that builds an annotation of given type.
      -
      static AnnotationBuilderof​(java.lang.Class<? extends java.lang.annotation.Annotation> annotationType) -
      Returns a new AnnotationBuilder that builds an annotation of given type.
      -
      default AnnotationBuildervalue​(boolean value) -
      Adds a boolean-valued annotation member called value.
      -
      default AnnotationBuildervalue​(boolean[] values) -
      Adds a boolean array-valued annotation member called value.
      -
      default AnnotationBuildervalue​(byte value) -
      Adds a byte-valued annotation member called value.
      -
      default AnnotationBuildervalue​(byte[] values) -
      Adds a byte array-valued annotation member called value.
      -
      default AnnotationBuildervalue​(char value) -
      Adds a char-valued annotation member called value.
      -
      default AnnotationBuildervalue​(char[] values) -
      Adds a char array-valued annotation member called value.
      -
      default AnnotationBuildervalue​(double value) -
      Adds a double-valued annotation member called value.
      -
      default AnnotationBuildervalue​(double[] values) -
      Adds a double array-valued annotation member called value.
      -
      default AnnotationBuildervalue​(float value) -
      Adds a float-valued annotation member called value.
      -
      default AnnotationBuildervalue​(float[] values) -
      Adds a float array-valued annotation member called value.
      -
      default AnnotationBuildervalue​(int value) -
      Adds an int-valued annotation member called value.
      -
      default AnnotationBuildervalue​(int[] values) -
      Adds an int array-valued annotation member called value.
      -
      default AnnotationBuildervalue​(long value) -
      Adds a long-valued annotation member called value.
      -
      default AnnotationBuildervalue​(long[] values) -
      Adds a long array-valued annotation member called value.
      -
      default AnnotationBuildervalue​(short value) -
      Adds a short-valued annotation member called value.
      -
      default AnnotationBuildervalue​(short[] values) -
      Adds a short array-valued annotation member called value.
      -
      default AnnotationBuildervalue​(AnnotationInfo value) -
      Adds an annotation-valued annotation member called value.
      -
      default AnnotationBuildervalue​(AnnotationInfo[] values) -
      Adds an annotation array-valued annotation member called value.
      -
      default AnnotationBuildervalue​(AnnotationMember value) -
      Adds an annotation member called value, whose value is given value.
      -
      default AnnotationBuildervalue​(ClassInfo value) -
      Adds a class-valued annotation member called value.
      -
      default AnnotationBuildervalue​(ClassInfo[] values) -
      Adds a class array-valued annotation member called value.
      -
      default AnnotationBuildervalue​(ClassInfo enumType, - java.lang.String enumValue) -
      Adds an enum-valued annotation member called value.
      -
      default AnnotationBuildervalue​(ClassInfo enumType, - java.lang.String[] enumValues) -
      Adds an enum array-valued annotation member called value.
      -
      default AnnotationBuildervalue​(Type value) -
      Adds a class-valued annotation member called value.
      -
      default AnnotationBuildervalue​(Type[] values) -
      Adds a class array-valued annotation member called value.
      -
      default AnnotationBuildervalue​(java.lang.annotation.Annotation value) -
      Adds an annotation-valued annotation member called value.
      -
      default AnnotationBuildervalue​(java.lang.annotation.Annotation[] values) -
      Adds an annotation array-valued annotation member called value.
      -
      default AnnotationBuildervalue​(java.lang.Class<?> value) -
      Adds a class-valued annotation member called value.
      -
      default AnnotationBuildervalue​(java.lang.Class<?>[] values) -
      Adds a class array-valued annotation member called value.
      -
      default AnnotationBuildervalue​(java.lang.Class<? extends java.lang.Enum<?>> enumType, - java.lang.String enumValue) -
      Adds an enum-valued annotation member called value.
      -
      default AnnotationBuildervalue​(java.lang.Class<? extends java.lang.Enum<?>> enumType, - java.lang.String[] enumValues) -
      Adds an enum array-valued annotation member called value.
      -
      default AnnotationBuildervalue​(java.lang.Enum<?> value) -
      Adds an enum-valued annotation member called value.
      -
      default AnnotationBuildervalue​(java.lang.Enum<?>[] values) -
      Adds an enum array-valued annotation member called value.
      -
      default AnnotationBuildervalue​(java.lang.String value) -
      Adds a String-valued annotation member called value.
      -
      default AnnotationBuildervalue​(java.lang.String[] values) -
      Adds a String array-valued annotation member called value.
      -
      -
    • -
    -
    -
  • -
-
-
-
    -
  • - -
    -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        of

        -
        static AnnotationBuilder of​(java.lang.Class<? extends java.lang.annotation.Annotation> annotationType)
        -
        Returns a new AnnotationBuilder that builds an annotation of given type.
        -
        -
        Parameters:
        -
        annotationType - the annotation type, must not be null
        -
        Returns:
        -
        a new AnnotationBuilder, never null
        -
        -
      • -
      - - - -
        -
      • -

        of

        -
        static AnnotationBuilder of​(ClassInfo annotationType)
        -
        Returns a new AnnotationBuilder that builds an annotation of given type.
        -
        -
        Parameters:
        -
        annotationType - the annotation type, must not be null
        -
        Returns:
        -
        a new AnnotationBuilder
        -
        -
      • -
      - - - -
        -
      • -

        value

        -
        default AnnotationBuilder value​(AnnotationMember value)
        -
        Adds an annotation member called value, whose value is given value.
        -
        -
        Parameters:
        -
        value - value of the annotation member
        -
        Returns:
        -
        this AnnotationBuilder
        -
        -
      • -
      - - - -
        -
      • -

        value

        -
        default AnnotationBuilder value​(boolean value)
        -
        Adds a boolean-valued annotation member called value.
        -
        -
        Parameters:
        -
        value - the boolean value
        -
        Returns:
        -
        this AnnotationBuilder
        -
        -
      • -
      - - - -
        -
      • -

        value

        -
        default AnnotationBuilder value​(boolean[] values)
        -
        Adds a boolean array-valued annotation member called value.
        -
        -
        Parameters:
        -
        values - the boolean array, must not be null
        -
        Returns:
        -
        this AnnotationBuilder
        -
        -
      • -
      - - - -
        -
      • -

        value

        -
        default AnnotationBuilder value​(byte value)
        -
        Adds a byte-valued annotation member called value.
        -
        -
        Parameters:
        -
        value - the byte value
        -
        Returns:
        -
        this AnnotationBuilder
        -
        -
      • -
      - - - -
        -
      • -

        value

        -
        default AnnotationBuilder value​(byte[] values)
        -
        Adds a byte array-valued annotation member called value.
        -
        -
        Parameters:
        -
        values - the byte array, must not be null
        -
        Returns:
        -
        this AnnotationBuilder
        -
        -
      • -
      - - - -
        -
      • -

        value

        -
        default AnnotationBuilder value​(short value)
        -
        Adds a short-valued annotation member called value.
        -
        -
        Parameters:
        -
        value - the short value
        -
        Returns:
        -
        this AnnotationBuilder
        -
        -
      • -
      - - - -
        -
      • -

        value

        -
        default AnnotationBuilder value​(short[] values)
        -
        Adds a short array-valued annotation member called value.
        -
        -
        Parameters:
        -
        values - the short array, must not be null
        -
        Returns:
        -
        this AnnotationBuilder
        -
        -
      • -
      - - - -
        -
      • -

        value

        -
        default AnnotationBuilder value​(int value)
        -
        Adds an int-valued annotation member called value.
        -
        -
        Parameters:
        -
        value - the int value
        -
        Returns:
        -
        this AnnotationBuilder
        -
        -
      • -
      - - - -
        -
      • -

        value

        -
        default AnnotationBuilder value​(int[] values)
        -
        Adds an int array-valued annotation member called value.
        -
        -
        Parameters:
        -
        values - the int array, must not be null
        -
        Returns:
        -
        this AnnotationBuilder
        -
        -
      • -
      - - - -
        -
      • -

        value

        -
        default AnnotationBuilder value​(long value)
        -
        Adds a long-valued annotation member called value.
        -
        -
        Parameters:
        -
        value - the long value
        -
        Returns:
        -
        this AnnotationBuilder
        -
        -
      • -
      - - - -
        -
      • -

        value

        -
        default AnnotationBuilder value​(long[] values)
        -
        Adds a long array-valued annotation member called value.
        -
        -
        Parameters:
        -
        values - the long array, must not be null
        -
        Returns:
        -
        this AnnotationBuilder
        -
        -
      • -
      - - - -
        -
      • -

        value

        -
        default AnnotationBuilder value​(float value)
        -
        Adds a float-valued annotation member called value.
        -
        -
        Parameters:
        -
        value - the float value
        -
        Returns:
        -
        this AnnotationBuilder
        -
        -
      • -
      - - - -
        -
      • -

        value

        -
        default AnnotationBuilder value​(float[] values)
        -
        Adds a float array-valued annotation member called value.
        -
        -
        Parameters:
        -
        values - the float array, must not be null
        -
        Returns:
        -
        this AnnotationBuilder
        -
        -
      • -
      - - - -
        -
      • -

        value

        -
        default AnnotationBuilder value​(double value)
        -
        Adds a double-valued annotation member called value.
        -
        -
        Parameters:
        -
        value - the double value
        -
        Returns:
        -
        this AnnotationBuilder
        -
        -
      • -
      - - - -
        -
      • -

        value

        -
        default AnnotationBuilder value​(double[] values)
        -
        Adds a double array-valued annotation member called value.
        -
        -
        Parameters:
        -
        values - the double array, must not be null
        -
        Returns:
        -
        this AnnotationBuilder
        -
        -
      • -
      - - - -
        -
      • -

        value

        -
        default AnnotationBuilder value​(char value)
        -
        Adds a char-valued annotation member called value.
        -
        -
        Parameters:
        -
        value - the char value
        -
        Returns:
        -
        this AnnotationBuilder
        -
        -
      • -
      - - - -
        -
      • -

        value

        -
        default AnnotationBuilder value​(char[] values)
        -
        Adds a char array-valued annotation member called value.
        -
        -
        Parameters:
        -
        values - the char array, must not be null
        -
        Returns:
        -
        this AnnotationBuilder
        -
        -
      • -
      - - - -
        -
      • -

        value

        -
        default AnnotationBuilder value​(java.lang.String value)
        -
        Adds a String-valued annotation member called value.
        -
        -
        Parameters:
        -
        value - the String value, must not be null
        -
        Returns:
        -
        this AnnotationBuilder
        -
        -
      • -
      - - - -
        -
      • -

        value

        -
        default AnnotationBuilder value​(java.lang.String[] values)
        -
        Adds a String array-valued annotation member called value.
        -
        -
        Parameters:
        -
        values - the String array, must not be null or contain null
        -
        Returns:
        -
        this AnnotationBuilder
        -
        -
      • -
      - - - -
        -
      • -

        value

        -
        default AnnotationBuilder value​(java.lang.Enum<?> value)
        -
        Adds an enum-valued annotation member called value.
        -
        -
        Parameters:
        -
        value - the enum value, must not be null
        -
        Returns:
        -
        this AnnotationBuilder
        -
        -
      • -
      - - - -
        -
      • -

        value

        -
        default AnnotationBuilder value​(java.lang.Enum<?>[] values)
        -
        Adds an enum array-valued annotation member called value.
        -
        -
        Parameters:
        -
        values - the enum array, must not be null or contain null
        -
        Returns:
        -
        this AnnotationBuilder
        -
        -
      • -
      - - - -
        -
      • -

        value

        -
        default AnnotationBuilder value​(java.lang.Class<? extends java.lang.Enum<?>> enumType,
        -                                java.lang.String enumValue)
        -
        Adds an enum-valued annotation member called value.
        -
        -
        Parameters:
        -
        enumType - the enum type, must not be null
        -
        enumValue - name of the enum constant, must not be null
        -
        Returns:
        -
        this AnnotationBuilder
        -
        -
      • -
      - - - -
        -
      • -

        value

        -
        default AnnotationBuilder value​(java.lang.Class<? extends java.lang.Enum<?>> enumType,
        -                                java.lang.String[] enumValues)
        -
        Adds an enum array-valued annotation member called value.
        -
        -
        Parameters:
        -
        enumType - the enum type, must not be null
        -
        enumValues - names of the enum constants, must not be null or contain null
        -
        Returns:
        -
        this AnnotationBuilder
        -
        -
      • -
      - - - -
        -
      • -

        value

        -
        default AnnotationBuilder value​(ClassInfo enumType,
        -                                java.lang.String enumValue)
        -
        Adds an enum-valued annotation member called value.
        -
        -
        Parameters:
        -
        enumType - the enum type, must not be null
        -
        enumValue - name of the enum constant, must not be null
        -
        Returns:
        -
        this AnnotationBuilder
        -
        -
      • -
      - - - -
        -
      • -

        value

        -
        default AnnotationBuilder value​(ClassInfo enumType,
        -                                java.lang.String[] enumValues)
        -
        Adds an enum array-valued annotation member called value.
        -
        -
        Parameters:
        -
        enumType - the enum type, must not be null
        -
        enumValues - names of the enum constants, must not be null or contain null
        -
        Returns:
        -
        this AnnotationBuilder
        -
        -
      • -
      - - - -
        -
      • -

        value

        -
        default AnnotationBuilder value​(java.lang.Class<?> value)
        -
        Adds a class-valued annotation member called value.
        -
        -
        Parameters:
        -
        value - the class value, must not be null
        -
        Returns:
        -
        this AnnotationBuilder
        -
        -
      • -
      - - - -
        -
      • -

        value

        -
        default AnnotationBuilder value​(java.lang.Class<?>[] values)
        -
        Adds a class array-valued annotation member called value.
        -
        -
        Parameters:
        -
        values - the class array, must not be null or contain null
        -
        Returns:
        -
        this AnnotationBuilder
        -
        -
      • -
      - - - -
        -
      • -

        value

        -
        default AnnotationBuilder value​(ClassInfo value)
        -
        Adds a class-valued annotation member called value.
        -
        -
        Parameters:
        -
        value - the class value, must not be null
        -
        Returns:
        -
        this AnnotationBuilder
        -
        -
      • -
      - - - -
        -
      • -

        value

        -
        default AnnotationBuilder value​(ClassInfo[] values)
        -
        Adds a class array-valued annotation member called value.
        -
        -
        Parameters:
        -
        values - the class array, must not be null or contain null
        -
        Returns:
        -
        this AnnotationBuilder
        -
        -
      • -
      - - - -
        -
      • -

        value

        -
        default AnnotationBuilder value​(Type value)
        -
        Adds a class-valued annotation member called value. - The value parameter may only be: -
        -
        -
        Parameters:
        -
        value - the class value, must not be null
        -
        Returns:
        -
        this AnnotationBuilder
        -
        Throws:
        -
        java.lang.IllegalArgumentException - if given type is invalid, as described above
        -
        -
      • -
      - - - -
        -
      • -

        value

        -
        default AnnotationBuilder value​(Type[] values)
        -
        Adds a class array-valued annotation member called value. - The values parameter may only contain: -
        -
        -
        Parameters:
        -
        values - the class array, must not be null or contain null
        -
        Returns:
        -
        this AnnotationBuilder
        -
        Throws:
        -
        java.lang.IllegalArgumentException - if any given type is invalid, as described above
        -
        -
      • -
      - - - -
        -
      • -

        value

        -
        default AnnotationBuilder value​(AnnotationInfo value)
        -
        Adds an annotation-valued annotation member called value.
        -
        -
        Parameters:
        -
        value - the annotation value, must not be null
        -
        Returns:
        -
        this AnnotationBuilder
        -
        -
      • -
      - - - -
        -
      • -

        value

        -
        default AnnotationBuilder value​(AnnotationInfo[] values)
        -
        Adds an annotation array-valued annotation member called value.
        -
        -
        Parameters:
        -
        values - the annotation array, must not be null or contain null
        -
        Returns:
        -
        this AnnotationBuilder
        -
        -
      • -
      - - - -
        -
      • -

        value

        -
        default AnnotationBuilder value​(java.lang.annotation.Annotation value)
        -
        Adds an annotation-valued annotation member called value.
        -
        -
        Parameters:
        -
        value - the annotation value, must not be null
        -
        Returns:
        -
        this AnnotationBuilder
        -
        -
      • -
      - - - -
        -
      • -

        value

        -
        default AnnotationBuilder value​(java.lang.annotation.Annotation[] values)
        -
        Adds an annotation array-valued annotation member called value.
        -
        -
        Parameters:
        -
        values - the annotation array, must not be null or contain null
        -
        Returns:
        -
        this AnnotationBuilder
        -
        -
      • -
      - - - -
        -
      • -

        member

        -
        AnnotationBuilder member​(java.lang.String name,
        -                         AnnotationMember value)
        -
        Adds an annotation member with given name, whose value is given value.
        -
        -
        Parameters:
        -
        name - name of the annotation member, must not be null
        -
        value - value of the annotation member, must not be null
        -
        Returns:
        -
        this AnnotationBuilder
        -
        -
      • -
      - - - -
        -
      • -

        member

        -
        AnnotationBuilder member​(java.lang.String name,
        -                         boolean value)
        -
        Adds a boolean-valued annotation member with given name.
        -
        -
        Parameters:
        -
        name - the member name, must not be null
        -
        value - the boolean value
        -
        Returns:
        -
        this AnnotationBuilder
        -
        -
      • -
      - - - -
        -
      • -

        member

        -
        AnnotationBuilder member​(java.lang.String name,
        -                         boolean[] values)
        -
        Adds a boolean array-valued annotation member with given name.
        -
        -
        Parameters:
        -
        name - the member name, must not be null
        -
        values - the boolean array, must not be null
        -
        Returns:
        -
        this AnnotationBuilder
        -
        -
      • -
      - - - -
        -
      • -

        member

        -
        AnnotationBuilder member​(java.lang.String name,
        -                         byte value)
        -
        Adds a byte-valued annotation member with given name.
        -
        -
        Parameters:
        -
        name - the member name, must not be null
        -
        value - the byte value
        -
        Returns:
        -
        this AnnotationBuilder
        -
        -
      • -
      - - - -
        -
      • -

        member

        -
        AnnotationBuilder member​(java.lang.String name,
        -                         byte[] values)
        -
        Adds a byte array-valued annotation member with given name.
        -
        -
        Parameters:
        -
        name - the member name, must not be null
        -
        values - the byte array, must not be null
        -
        Returns:
        -
        this AnnotationBuilder
        -
        -
      • -
      - - - -
        -
      • -

        member

        -
        AnnotationBuilder member​(java.lang.String name,
        -                         short value)
        -
        Adds a short-valued annotation member with given name.
        -
        -
        Parameters:
        -
        name - the member name, must not be null
        -
        value - the short value
        -
        Returns:
        -
        this AnnotationBuilder
        -
        -
      • -
      - - - -
        -
      • -

        member

        -
        AnnotationBuilder member​(java.lang.String name,
        -                         short[] values)
        -
        Adds a short array-valued annotation member with given name.
        -
        -
        Parameters:
        -
        name - the member name, must not be null
        -
        values - the short array, must not be null
        -
        Returns:
        -
        this AnnotationBuilder
        -
        -
      • -
      - - - -
        -
      • -

        member

        -
        AnnotationBuilder member​(java.lang.String name,
        -                         int value)
        -
        Adds an int-valued annotation member with given name.
        -
        -
        Parameters:
        -
        name - the member name, must not be null
        -
        value - the int value
        -
        Returns:
        -
        this AnnotationBuilder
        -
        -
      • -
      - - - -
        -
      • -

        member

        -
        AnnotationBuilder member​(java.lang.String name,
        -                         int[] values)
        -
        Adds an int array-valued annotation member with given name.
        -
        -
        Parameters:
        -
        name - the member name, must not be null
        -
        values - the int array, must not be null
        -
        Returns:
        -
        this AnnotationBuilder
        -
        -
      • -
      - - - -
        -
      • -

        member

        -
        AnnotationBuilder member​(java.lang.String name,
        -                         long value)
        -
        Adds a long-valued annotation member with given name.
        -
        -
        Parameters:
        -
        name - the member name, must not be null
        -
        value - the long value
        -
        Returns:
        -
        this AnnotationBuilder
        -
        -
      • -
      - - - -
        -
      • -

        member

        -
        AnnotationBuilder member​(java.lang.String name,
        -                         long[] values)
        -
        Adds a long array-valued annotation member with given name.
        -
        -
        Parameters:
        -
        name - the member name, must not be null
        -
        values - the long array, must not be null
        -
        Returns:
        -
        this AnnotationBuilder
        -
        -
      • -
      - - - -
        -
      • -

        member

        -
        AnnotationBuilder member​(java.lang.String name,
        -                         float value)
        -
        Adds a float-valued annotation member with given name.
        -
        -
        Parameters:
        -
        name - the member name, must not be null
        -
        value - the float value
        -
        Returns:
        -
        this AnnotationBuilder
        -
        -
      • -
      - - - -
        -
      • -

        member

        -
        AnnotationBuilder member​(java.lang.String name,
        -                         float[] values)
        -
        Adds a float array-valued annotation member with given name.
        -
        -
        Parameters:
        -
        name - the member name, must not be null
        -
        values - the float array, must not be null
        -
        Returns:
        -
        this AnnotationBuilder
        -
        -
      • -
      - - - -
        -
      • -

        member

        -
        AnnotationBuilder member​(java.lang.String name,
        -                         double value)
        -
        Adds a double-valued annotation member with given name.
        -
        -
        Parameters:
        -
        name - the member name, must not be null
        -
        value - the double value
        -
        Returns:
        -
        this AnnotationBuilder
        -
        -
      • -
      - - - -
        -
      • -

        member

        -
        AnnotationBuilder member​(java.lang.String name,
        -                         double[] values)
        -
        Adds a double array-valued annotation member with given name.
        -
        -
        Parameters:
        -
        name - the member name, must not be null
        -
        values - the double array, must not be null
        -
        Returns:
        -
        this AnnotationBuilder
        -
        -
      • -
      - - - -
        -
      • -

        member

        -
        AnnotationBuilder member​(java.lang.String name,
        -                         char value)
        -
        Adds a char-valued annotation member with given name.
        -
        -
        Parameters:
        -
        name - the member name, must not be null
        -
        value - the char value
        -
        Returns:
        -
        this AnnotationBuilder
        -
        -
      • -
      - - - -
        -
      • -

        member

        -
        AnnotationBuilder member​(java.lang.String name,
        -                         char[] values)
        -
        Adds a char array-valued annotation member with given name.
        -
        -
        Parameters:
        -
        name - the member name, must not be null
        -
        values - the char array, must not be null
        -
        Returns:
        -
        this AnnotationBuilder
        -
        -
      • -
      - - - -
        -
      • -

        member

        -
        AnnotationBuilder member​(java.lang.String name,
        -                         java.lang.String value)
        -
        Adds a String-valued annotation member with given name.
        -
        -
        Parameters:
        -
        name - the member name, must not be null
        -
        value - the String value, must not be null
        -
        Returns:
        -
        this AnnotationBuilder
        -
        -
      • -
      - - - -
        -
      • -

        member

        -
        AnnotationBuilder member​(java.lang.String name,
        -                         java.lang.String[] values)
        -
        Adds a String array-valued annotation member with given name.
        -
        -
        Parameters:
        -
        name - the member name, must not be null
        -
        values - the String array, must not be null or contain null
        -
        Returns:
        -
        this AnnotationBuilder
        -
        -
      • -
      - - - -
        -
      • -

        member

        -
        AnnotationBuilder member​(java.lang.String name,
        -                         java.lang.Enum<?> value)
        -
        Adds an enum-valued annotation member with given name.
        -
        -
        Parameters:
        -
        name - the member name, must not be null
        -
        value - the enum value, must not be null
        -
        Returns:
        -
        this AnnotationBuilder
        -
        -
      • -
      - - - -
        -
      • -

        member

        -
        AnnotationBuilder member​(java.lang.String name,
        -                         java.lang.Enum<?>[] values)
        -
        Adds an enum array-valued annotation member with given name.
        -
        -
        Parameters:
        -
        name - the member name, must not be null
        -
        values - the enum array, must not be null or contain null
        -
        Returns:
        -
        this AnnotationBuilder
        -
        -
      • -
      - - - -
        -
      • -

        member

        -
        AnnotationBuilder member​(java.lang.String name,
        -                         java.lang.Class<? extends java.lang.Enum<?>> enumType,
        -                         java.lang.String enumValue)
        -
        Adds an enum-valued annotation member with given name.
        -
        -
        Parameters:
        -
        name - the member name, must not be null
        -
        enumType - the enum type, must not be null
        -
        enumValue - name of the enum constant, must not be null
        -
        Returns:
        -
        this AnnotationBuilder
        -
        -
      • -
      - - - -
        -
      • -

        member

        -
        AnnotationBuilder member​(java.lang.String name,
        -                         java.lang.Class<? extends java.lang.Enum<?>> enumType,
        -                         java.lang.String[] enumValues)
        -
        Adds an enum array-valued annotation member with given name.
        -
        -
        Parameters:
        -
        name - the member name, must not be null
        -
        enumType - the enum type, must not be null
        -
        enumValues - names of the enum constants, must not be null or contain null
        -
        Returns:
        -
        this AnnotationBuilder
        -
        -
      • -
      - - - -
        -
      • -

        member

        -
        AnnotationBuilder member​(java.lang.String name,
        -                         ClassInfo enumType,
        -                         java.lang.String enumValue)
        -
        Adds an enum-valued annotation member with given name.
        -
        -
        Parameters:
        -
        name - the member name, must not be null
        -
        enumType - the enum type, must not be null
        -
        enumValue - name of the enum constant, must not be null
        -
        Returns:
        -
        this AnnotationBuilder
        -
        -
      • -
      - - - -
        -
      • -

        member

        -
        AnnotationBuilder member​(java.lang.String name,
        -                         ClassInfo enumType,
        -                         java.lang.String[] enumValues)
        -
        Adds an enum array-valued annotation member with given name.
        -
        -
        Parameters:
        -
        name - the member name, must not be null
        -
        enumType - the enum type, must not be null
        -
        enumValues - names of the enum constants, must not be null or contain null
        -
        Returns:
        -
        this AnnotationBuilder
        -
        -
      • -
      - - - -
        -
      • -

        member

        -
        AnnotationBuilder member​(java.lang.String name,
        -                         java.lang.Class<?> value)
        -
        Adds a class-valued annotation member with given name.
        -
        -
        Parameters:
        -
        name - the member name, must not be null
        -
        value - the class value, must not be null
        -
        Returns:
        -
        this AnnotationBuilder
        -
        -
      • -
      - - - -
        -
      • -

        member

        -
        AnnotationBuilder member​(java.lang.String name,
        -                         java.lang.Class<?>[] values)
        -
        Adds a class array-valued annotation member with given name.
        -
        -
        Parameters:
        -
        name - the member name, must not be null
        -
        values - the class array, must not be null or contain null
        -
        Returns:
        -
        this AnnotationBuilder
        -
        -
      • -
      - - - -
        -
      • -

        member

        -
        AnnotationBuilder member​(java.lang.String name,
        -                         ClassInfo value)
        -
        Adds a class-valued annotation member with given name.
        -
        -
        Parameters:
        -
        name - the member name, must not be null
        -
        value - the class value, must not be null
        -
        Returns:
        -
        this AnnotationBuilder
        -
        -
      • -
      - - - -
        -
      • -

        member

        -
        AnnotationBuilder member​(java.lang.String name,
        -                         ClassInfo[] values)
        -
        Adds a class array-valued annotation member with given name.
        -
        -
        Parameters:
        -
        name - the member name, must not be null
        -
        values - the class array, must not be null or contain null
        -
        Returns:
        -
        this AnnotationBuilder
        -
        -
      • -
      - - - -
        -
      • -

        member

        -
        AnnotationBuilder member​(java.lang.String name,
        -                         Type value)
        -
        Adds a class-valued annotation member with given name. - The value parameter may only be: - - Any other value results in an exception.
        -
        -
        Parameters:
        -
        name - the member name, must not be null
        -
        value - the class value, must not be null
        -
        Returns:
        -
        this AnnotationBuilder
        -
        Throws:
        -
        java.lang.IllegalArgumentException - if given type is invalid, as described above
        -
        -
      • -
      - - - -
        -
      • -

        member

        -
        AnnotationBuilder member​(java.lang.String name,
        -                         Type[] values)
        -
        Adds a class array-valued annotation member with given name. - The values parameter may only include: -
        -
        -
        Parameters:
        -
        name - the member name, must not be null
        -
        values - the class array, must not be null or contain null
        -
        Returns:
        -
        this AnnotationBuilder
        -
        Throws:
        -
        java.lang.IllegalArgumentException - if any given type is invalid, as described above
        -
        -
      • -
      - - - -
        -
      • -

        member

        -
        AnnotationBuilder member​(java.lang.String name,
        -                         AnnotationInfo value)
        -
        Adds an annotation-valued annotation member with given name.
        -
        -
        Parameters:
        -
        name - the member name, must not be null
        -
        value - the annotation value, must not be null
        -
        Returns:
        -
        this AnnotationBuilder
        -
        -
      • -
      - - - -
        -
      • -

        member

        -
        AnnotationBuilder member​(java.lang.String name,
        -                         AnnotationInfo[] values)
        -
        Adds an annotation array-valued annotation member with given name.
        -
        -
        Parameters:
        -
        name - the member name, must not be null
        -
        values - the annotation array, must not be null or contain null
        -
        Returns:
        -
        this AnnotationBuilder
        -
        -
      • -
      - - - -
        -
      • -

        member

        -
        AnnotationBuilder member​(java.lang.String name,
        -                         java.lang.annotation.Annotation value)
        -
        Adds an annotation-valued annotation member with given name.
        -
        -
        Parameters:
        -
        name - the member name, must not be null
        -
        value - the annotation value, must not be null
        -
        Returns:
        -
        this AnnotationBuilder
        -
        -
      • -
      - - - -
        -
      • -

        member

        -
        AnnotationBuilder member​(java.lang.String name,
        -                         java.lang.annotation.Annotation[] values)
        -
        Adds an annotation array-valued annotation member with given name.
        -
        -
        Parameters:
        -
        name - the member name, must not be null
        -
        values - the annotation array, must not be null or contain null
        -
        Returns:
        -
        this AnnotationBuilder
        -
        -
      • -
      - - - -
        -
      • -

        build

        -
        AnnotationInfo build()
        -
        Returns an AnnotationInfo that includes all annotation members defined by previous method calls - on this builder. After build() is called, this builder instance should be discarded.
        -
        -
        Returns:
        -
        the built AnnotationInfo, never null
        -
        Throws:
        -
        java.lang.IllegalStateException - if a value of some annotation member was not set, and that member - does not declare a default value
        -
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- -
- -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

-
- - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/AnnotationBuilderFactory.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/AnnotationBuilderFactory.html deleted file mode 100644 index 844d37f6b6..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/AnnotationBuilderFactory.html +++ /dev/null @@ -1,294 +0,0 @@ - - - - - -AnnotationBuilderFactory (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Interface AnnotationBuilderFactory

-
-
-
-
    -
  • -
    -
    public interface AnnotationBuilderFactory
    -
    Supports instantiating AnnotationBuilder. - Should not be called directly by users; the static methods on AnnotationBuilder are preferred.
    -
    -
    Since:
    -
    4.0
    -
    -
  • -
-
-
- -
-
- -
-
-
- -
- -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

-
- - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/BeanInfo.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/BeanInfo.html deleted file mode 100644 index 2f8c8c57c7..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/BeanInfo.html +++ /dev/null @@ -1,693 +0,0 @@ - - - - - -BeanInfo (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Interface BeanInfo

-
-
-
-
    -
  • -
    -
    All Known Subinterfaces:
    -
    InterceptorInfo
    -
    -
    -
    public interface BeanInfo
    -
    Beans are: - -
      -
    • managed beans
    • -
    • beans defined by producer methods
    • -
    • beans defined by producer fields
    • -
    • synthetic beans
    • -
    - - Managed beans are also known as class-based beans, while beans defined by producer methods - and producer fields are together also known as producer-based beans. -

    - Class-based and producer-based beans directly correspond to a declaration in program source code. - Synthetic beans don't and are instead defined through other mechanisms, such as - extensions.

    -
    -
    Since:
    -
    4.0
    -
    -
  • -
-
-
- -
-
-
    -
  • - -
    -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        scope

        -
        ScopeInfo scope()
        -
        Returns the scope of this bean.
        -
        -
        Returns:
        -
        the scope of this bean, never null
        -
        -
      • -
      - - - -
        -
      • -

        types

        -
        java.util.Collection<Type> types()
        -
        Returns a collection of all types of this bean.
        -
        -
        Returns:
        -
        immutable collection of bean types, never null
        -
        -
      • -
      - - - -
        -
      • -

        qualifiers

        -
        java.util.Collection<AnnotationInfo> qualifiers()
        -
        Returns a collection of this bean's qualifiers, represented as AnnotationInfo.
        -
        -
        Returns:
        -
        immutable collection of qualifiers, never null
        -
        -
      • -
      - - - -
        -
      • -

        declaringClass

        -
        ClassInfo declaringClass()
        -
        Returns the class that declares this bean. - In case of a managed bean, also known as class-based bean, that is the bean class directly. - In case of a producer method or field, that is the class that declares the producer method or field. - Returns null if this bean is synthetic.
        -
        -
        Returns:
        -
        ClassInfo for the class that declares this bean, or null if this bean is synthetic
        -
        -
      • -
      - - - -
        -
      • -

        isClassBean

        -
        boolean isClassBean()
        -
        Returns whether this bean is a managed bean, also known as class-based bean.
        -
        -
        Returns:
        -
        whether this bean is a managed bean
        -
        -
      • -
      - - - -
        -
      • -

        isProducerMethod

        -
        boolean isProducerMethod()
        -
        Returns whether this bean is defined by a producer method.
        -
        -
        Returns:
        -
        whether this bean is defined by a producer method
        -
        -
      • -
      - - - -
        -
      • -

        isProducerField

        -
        boolean isProducerField()
        -
        Returns whether this bean is defined by a producer field.
        -
        -
        Returns:
        -
        whether this bean is defined by a producer field
        -
        -
      • -
      - - - -
        -
      • -

        isSynthetic

        -
        boolean isSynthetic()
        -
        Returns whether this bean is synthetic. In other words, whether this bean - does not correspond to a declaration in program source code and was created - through other means (e.g. using an extension).
        -
        -
        Returns:
        -
        whether this bean is synthetic
        -
        -
      • -
      - - - -
        -
      • -

        producerMethod

        -
        MethodInfo producerMethod()
        -
        Returns the producer method that defines this bean. - Returns null if this bean is not defined by a producer method.
        -
        -
        Returns:
        -
        producer method that defines this bean, or null if this bean is not defined by a producer method
        -
        -
      • -
      - - - -
        -
      • -

        producerField

        -
        FieldInfo producerField()
        -
        Returns the producer field that defines this bean. - Returns null if this bean is not defined by a producer field.
        -
        -
        Returns:
        -
        producer field that defines this bean, or null if this bean is not defined by a producer field
        -
        -
      • -
      - - - -
        -
      • -

        isAlternative

        -
        boolean isAlternative()
        -
        Returns whether this bean is an alternative.
        -
        -
        Returns:
        -
        whether this bean is an alternative
        -
        -
      • -
      - - - -
        -
      • -

        priority

        -
        java.lang.Integer priority()
        -
        Returns the priority declared on this bean, or null - if this bean does not declare a priority. Declaring a priority on an alternative bean makes it an enabled - alternative. Similarly, declaring a priority on an interceptor makes it an enabled interceptor.
        -
        -
        Returns:
        -
        the priority of this bean, or null if this bean does not declare a priority
        -
        -
      • -
      - - - -
        -
      • -

        name

        -
        java.lang.String name()
        -
        Returns the bean name of this bean. A bean name is usually defined - using the @Named annotation. - Returns null if the bean does not have a name.
        -
        -
        Returns:
        -
        the bean name, or null if the bean does not have a name
        -
        -
      • -
      - - - -
        -
      • -

        disposer

        -
        DisposerInfo disposer()
        -
        Returns the disposer method of this producer-based bean. - Returns null if this bean is not a defined by a producer method or a producer field, - or if this producer-based bean does not have a corresponding disposer method.
        -
        -
        Returns:
        -
        the disposer, or null if this bean does not have a disposer
        -
        -
      • -
      - - - -
        -
      • -

        stereotypes

        -
        java.util.Collection<StereotypeInfo> stereotypes()
        -
        Returns a collection of this bean's stereotypes.
        -
        -
        Returns:
        -
        immutable collection of stereotypes, never null
        -
        -
      • -
      - - - -
        -
      • -

        injectionPoints

        -
        java.util.Collection<InjectionPointInfo> injectionPoints()
        -
        Returns a collection of this bean's injection points.
        -
        -
        Returns:
        -
        immutable collection of injection points, never null
        -
        -
      • -
      - - - -
        -
      • -

        createInvoker

        -
        InvokerBuilder<InvokerInfo> createInvoker​(MethodInfo method)
        -
        Returns a new InvokerBuilder for given method. The builder eventually produces - an opaque representation of the invoker for the given method. -

        - The method must be declared on the bean class or inherited from a supertype - of the bean class of this bean, otherwise an exception is thrown. -

        - If an invoker may not be obtained for given method as described - in Invoker, an exception is thrown. -

        - If this method is called outside the @Registration phase, an exception is thrown.

        -
        -
        Parameters:
        -
        method - method of this bean, must not be null
        -
        Returns:
        -
        the invoker builder, never null
        -
        Since:
        -
        4.1
        -
        -
      • -
      - - - -
        -
      • -

        isInterceptor

        -
        default boolean isInterceptor()
        -
        Returns whether this bean is an interceptor.
        -
        -
        Returns:
        -
        whether this bean is an interceptor
        -
        -
      • -
      - - - -
        -
      • -

        asInterceptor

        -
        default InterceptorInfo asInterceptor()
        -
        Returns this bean as an interceptor.
        -
        -
        Returns:
        -
        this interceptor, never null
        -
        Throws:
        -
        java.lang.IllegalStateException - if isInterceptor() returns false
        -
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- -
- -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

-
- - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/BuildCompatibleExtension.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/BuildCompatibleExtension.html deleted file mode 100644 index 6889ec996f..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/BuildCompatibleExtension.html +++ /dev/null @@ -1,245 +0,0 @@ - - - - - -BuildCompatibleExtension (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Interface BuildCompatibleExtension

-
-
-
-
    -
  • -
    -
    public interface BuildCompatibleExtension
    -
    Build compatible extensions are service providers for this interface, as defined in ServiceLoader. - This means: they are classes that implement this interface, provide a META-INF/services file, - and satisfy all other service provider constraints. Additionally, build compatible extensions must not be beans - and must not be referred to by application code. -

    - Build compatible extensions may define arbitrary public, non-static, void-returning methods - without type parameters, annotated with one of the extension annotations. Such methods are called extension methods. -

    - Extension methods are executed in 5 phases, corresponding to 5 extension annotations: -

    -

    - Extension methods may declare arbitrary number of parameters. In each execution phase, different types - of parameters may be declared, as documented in the corresponding extension annotation. All the parameters - will be provided by the container when the extension method is invoked. If an extension method declares - a parameter of a type unsupported in the execution phase, the container treats it as a deployment problem. -

    - Extension methods may be assigned a priority using @Priority. - Extension methods with smaller priority values are invoked first. Extension methods without specified priority - have a default priority of Priority.APPLICATION + 500. - If two extension methods have equal priority, the ordering between them is undefined. Note that priority - only affects order of extension methods in a single phase. -

    - For each build compatible extension, the container creates a single instance. All extension methods - are invoked on the same instance. -

    - When extension methods are invoked, a CDI container does not have to be running, so calling CDI.current() - from an extension method, or attempting to access a running CDI container in any other way, results in - non-portable behavior. -

    - Build compatible extensions may be annotated @SkipIfPortableExtensionPresent - when they are supposed to be ignored in presence of a given portable extension. -

    - CDI implementations are not required to accept custom implementations of any jakarta.enterprise.lang.model, - jakarta.enterprise.invoke or jakarta.enterprise.inject.build.compatible.spi interface - on the API boundary of build compatible extensions. In other words, users may only use instances of these - interfaces that they previously obtained from the corresponding API. If not, non-portable behavior results. -

    - In build compatible extensions, implementations of AnnotationTarget - only return annotations with the runtime retention policy.

    -
    -
    Since:
    -
    4.0
    -
    -
  • -
-
-
-
- -
- -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

-
- - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/BuildServices.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/BuildServices.html deleted file mode 100644 index c3516368a5..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/BuildServices.html +++ /dev/null @@ -1,277 +0,0 @@ - - - - - -BuildServices (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Interface BuildServices

-
-
-
- -
-
- -
-
- -
-
-
- -
- -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

-
- - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/BuildServicesResolver.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/BuildServicesResolver.html deleted file mode 100644 index 972761c064..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/BuildServicesResolver.html +++ /dev/null @@ -1,330 +0,0 @@ - - - - - -BuildServicesResolver (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Class BuildServicesResolver

-
-
-
    -
  • java.lang.Object
  • -
  • -
      -
    • jakarta.enterprise.inject.build.compatible.spi.BuildServicesResolver
    • -
    -
  • -
-
-
    -
  • -
    -
    public final class BuildServicesResolver
    -extends java.lang.Object
    -
    An internal helper to resolve BuildServices implementations. - This class is public only for integrators and should not be used by applications.
    -
    -
    Since:
    -
    4.0
    -
    -
  • -
-
-
-
    -
  • - -
    - -
    - -
    -
      -
    • - - -

      Method Summary

      - - - - - - - - - - - - -
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethodDescription
      static voidsetBuildServices​(BuildServices instance) -
      This method should not be used by applications.
      -
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

        -clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
      • -
      -
    • -
    -
    -
  • -
-
-
-
    -
  • - -
    -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        BuildServicesResolver

        -
        public BuildServicesResolver()
        -
      • -
      -
    • -
    -
    - -
    -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        setBuildServices

        -
        public static void setBuildServices​(BuildServices instance)
        -
        This method should not be used by applications. It is only exposed for integrators - with complex classloading architectures, where service loader lookup doesn't work out of the box. - With this method, an integrator may manually provide an instance of BuildServices and - this class will no longer attempt to look it up using service loader.
        -
        -
        Parameters:
        -
        instance - a BuildServices instance that should be used, must not be null
        -
        Throws:
        -
        java.lang.IllegalArgumentException - if the provided argument is null
        -
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- - - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/ClassConfig.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/ClassConfig.html deleted file mode 100644 index 5c6868d038..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/ClassConfig.html +++ /dev/null @@ -1,474 +0,0 @@ - - - - - -ClassConfig (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Interface ClassConfig

-
-
-
-
    -
  • -
    -
    All Superinterfaces:
    -
    DeclarationConfig
    -
    -
    -
    public interface ClassConfig
    -extends DeclarationConfig
    -
    Allows adding annotations to and removing annotations from a class. - Note that the class is not physically altered, the modifications - are only seen by the CDI container.
    -
    -
    Since:
    -
    4.0
    -
    See Also:
    -
    Enhancement
    -
    -
  • -
-
-
- -
-
-
    -
  • - -
    -
      -
    • - - -

      Method Detail

      - - - - - - - -
        -
      • -

        addAnnotation

        -
        ClassConfig addAnnotation​(java.lang.Class<? extends java.lang.annotation.Annotation> annotationType)
        -
        Adds a marker annotation of given type to this class. - Does not allow configuring annotation members.
        -
        -
        Specified by:
        -
        addAnnotation in interface DeclarationConfig
        -
        Parameters:
        -
        annotationType - the annotation type, must not be null
        -
        Returns:
        -
        this configurator object, to allow fluent usage
        -
        -
      • -
      - - - -
        -
      • -

        addAnnotation

        -
        ClassConfig addAnnotation​(AnnotationInfo annotation)
        -
        Adds given annotation to this class. The AnnotationInfo can be obtained - from an annotation target, or constructed from scratch using AnnotationBuilder.
        -
        -
        Specified by:
        -
        addAnnotation in interface DeclarationConfig
        -
        Parameters:
        -
        annotation - the annotation to add to this class, must not be null
        -
        Returns:
        -
        this configurator object, to allow fluent usage
        -
        -
      • -
      - - - -
        -
      • -

        addAnnotation

        -
        ClassConfig addAnnotation​(java.lang.annotation.Annotation annotation)
        -
        Adds given annotation to this class. The annotation instance is typically - a subclass of AnnotationLiteral.
        -
        -
        Specified by:
        -
        addAnnotation in interface DeclarationConfig
        -
        Parameters:
        -
        annotation - the annotation to add to this class, must not be null
        -
        Returns:
        -
        this configurator object, to allow fluent usage
        -
        -
      • -
      - - - -
        -
      • -

        removeAnnotation

        -
        ClassConfig removeAnnotation​(java.util.function.Predicate<AnnotationInfo> predicate)
        -
        Removes all annotations matching given predicate from this class.
        -
        -
        Specified by:
        -
        removeAnnotation in interface DeclarationConfig
        -
        Parameters:
        -
        predicate - an annotation predicate, must not be null
        -
        Returns:
        -
        this configurator object, to allow fluent usage
        -
        -
      • -
      - - - -
        -
      • -

        removeAllAnnotations

        -
        ClassConfig removeAllAnnotations()
        -
        Removes all annotations from this class.
        -
        -
        Specified by:
        -
        removeAllAnnotations in interface DeclarationConfig
        -
        Returns:
        -
        this configurator object, to allow fluent usage
        -
        -
      • -
      - - - - - - - - - - - - -
    • -
    -
    -
  • -
-
-
-
- -
- -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

-
- - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/DeclarationConfig.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/DeclarationConfig.html deleted file mode 100644 index bb503b3f99..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/DeclarationConfig.html +++ /dev/null @@ -1,392 +0,0 @@ - - - - - -DeclarationConfig (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Interface DeclarationConfig

-
-
-
-
    -
  • -
    -
    All Known Subinterfaces:
    -
    ClassConfig, FieldConfig, MethodConfig, ParameterConfig
    -
    -
    -
    public interface DeclarationConfig
    -
    Allows adding annotations to and removing annotations from a declaration. - Note that the declaration is not physically altered, the modifications - are only seen by the CDI container.
    -
    -
    Since:
    -
    4.0
    -
    See Also:
    -
    Enhancement
    -
    -
  • -
-
-
- -
-
-
    -
  • - -
    -
      -
    • - - -

      Method Detail

      - - - - - - - -
        -
      • -

        addAnnotation

        -
        DeclarationConfig addAnnotation​(java.lang.Class<? extends java.lang.annotation.Annotation> annotationType)
        -
        Adds a marker annotation of given type to this declaration. - Does not allow configuring annotation members.
        -
        -
        Parameters:
        -
        annotationType - the annotation type, must not be null
        -
        Returns:
        -
        this configurator object, to allow fluent usage
        -
        -
      • -
      - - - -
        -
      • -

        addAnnotation

        -
        DeclarationConfig addAnnotation​(AnnotationInfo annotation)
        -
        Adds given annotation to this declaration. The AnnotationInfo can be obtained - from an annotation target, or constructed from scratch using AnnotationBuilder.
        -
        -
        Parameters:
        -
        annotation - the annotation to add to this declaration, must not be null
        -
        Returns:
        -
        this configurator object, to allow fluent usage
        -
        -
      • -
      - - - -
        -
      • -

        addAnnotation

        -
        DeclarationConfig addAnnotation​(java.lang.annotation.Annotation annotation)
        -
        Adds given annotation to this declaration. The annotation instance is typically - a subclass of AnnotationLiteral.
        -
        -
        Parameters:
        -
        annotation - the annotation to add to this declaration, must not be null
        -
        Returns:
        -
        this configurator object, to allow fluent usage
        -
        -
      • -
      - - - -
        -
      • -

        removeAnnotation

        -
        DeclarationConfig removeAnnotation​(java.util.function.Predicate<AnnotationInfo> predicate)
        -
        Removes all annotations matching given predicate from this declaration.
        -
        -
        Parameters:
        -
        predicate - an annotation predicate, must not be null
        -
        Returns:
        -
        this configurator object, to allow fluent usage
        -
        -
      • -
      - - - -
        -
      • -

        removeAllAnnotations

        -
        DeclarationConfig removeAllAnnotations()
        -
        Removes all annotations from this declaration.
        -
        -
        Returns:
        -
        this configurator object, to allow fluent usage
        -
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- -
- -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

-
- - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/Discovery.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/Discovery.html deleted file mode 100644 index 47f5ac90e9..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/Discovery.html +++ /dev/null @@ -1,208 +0,0 @@ - - - - - -Discovery (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Annotation Type Discovery

-
-
-
-
    -
  • -
    -
    @Target(METHOD)
    -@Retention(RUNTIME)
    -public @interface Discovery
    -
    1st phase of build compatible extension execution. - Allow adding additional classes to the set of types discovered during type discovery. - Also allows registering custom CDI meta-annotations. -

    - Methods annotated @Discovery may declare parameters of these types: -

    -
    -
    Since:
    -
    4.0
    -
    -
  • -
-
-
-
- -
- -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

-
- - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/DisposerInfo.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/DisposerInfo.html deleted file mode 100644 index d7ff694b98..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/DisposerInfo.html +++ /dev/null @@ -1,290 +0,0 @@ - - - - - -DisposerInfo (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Interface DisposerInfo

-
-
-
-
    -
  • -
    -
    public interface DisposerInfo
    -
    Disposer methods may exist for producer-based beans. Each disposer method - has a disposed parameter.
    -
    -
    Since:
    -
    4.0
    -
    -
  • -
-
-
- -
-
-
    -
  • - -
    -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        disposerMethod

        -
        MethodInfo disposerMethod()
        -
        Returns the declaration of this disposer method.
        -
        -
        Returns:
        -
        the declaration of this disposer method, never null
        -
        -
      • -
      - - - -
        -
      • -

        disposedParameter

        -
        ParameterInfo disposedParameter()
        -
        Returns the declaration of the disposed parameter of this disposer method.
        -
        -
        Returns:
        -
        the declaration of the disposed parameter of this disposer method, never null
        -
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- -
- -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

-
- - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/Enhancement.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/Enhancement.html deleted file mode 100644 index 7cbc75a202..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/Enhancement.html +++ /dev/null @@ -1,392 +0,0 @@ - - - - - -Enhancement (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Annotation Type Enhancement

-
-
-
-
    -
  • -
    -
    @Target(METHOD)
    -@Retention(RUNTIME)
    -public @interface Enhancement
    -
    2nd phase of build compatible extension execution. - Allows transforming annotations. -

    - In the following text, the term expected types denotes the set of types defined by - the types, withSubtypes and withAnnotations - members of the @Enhancement annotation. The term discovered types denotes - the subset of expected types that were discovered during type discovery. -

    - Methods annotated @Enhancement must declare exactly one parameter of one of these types: -

    - If an @Enhancement method has a parameter of type ClassConfig or ClassInfo, - the method is called once for each discovered type. -

    - If an @Enhancement method has a parameter of type MethodConfig or MethodInfo, - the method is called once for each constructor or method that is declared on each discovered type, - as defined in ClassInfo.constructors - and ClassInfo.methods. -

    - If an @Enhancement method has a parameter of type FieldConfig or FieldInfo, - the method is called once for each field that is declared on each discovered type, as defined - in ClassInfo.fields. -

    - If the @Enhancement method doesn't declare any parameter of one of these types, - or if it declares more than one, the container treats it as a definition error. -

    - Additionally, methods annotated @Enhancement may declare parameters of these types: -

    -

    - Finally, AnnotationBuilder may be used to create instances - of AnnotationInfo.

    -
    -
    Since:
    -
    4.0
    -
    -
  • -
-
-
-
    -
  • - -
    -
      -
    • - - -

      Required Element Summary

      - - - - - - - - - - - - -
      Required Elements 
      Modifier and TypeRequired ElementDescription
      java.lang.Class<?>[]types -
      Defines the set of expected types.
      -
      -
    • -
    -
    - -
    -
      -
    • - - -

      Optional Element Summary

      - - - - - - - - - - - - - - - - - -
      Optional Elements 
      Modifier and TypeOptional ElementDescription
      java.lang.Class<? extends java.lang.annotation.Annotation>[]withAnnotations -
      Narrows down the set of expected types, defined by types - and withSubtypes, to types that use any of given annotations.
      -
      booleanwithSubtypes -
      If true, the set of expected types includes all direct and - indirect subtypes of given types.
      -
      -
    • -
    -
    -
  • -
-
-
-
    -
  • - -
    -
      -
    • - - -

      Element Detail

      - - - -
        -
      • -

        types

        -
        java.lang.Class<?>[] types
        -
        Defines the set of expected types. If withSubtypes - is true, the set of expected types includes all direct and indirect - subtypes of these types. If withAnnotations is defined, - the set of expected types only includes types that use given annotations.
        -
        -
        Returns:
        -
        the set of expected types
        -
        -
      • -
      -
    • -
    -
    - -
    -
      -
    • - - -
        -
      • -

        withSubtypes

        -
        boolean withSubtypes
        -
        If true, the set of expected types includes all direct and - indirect subtypes of given types.
        -
        -
        Returns:
        -
        whether subtypes should be included in the set of expected types
        -
        -
        -
        Default:
        -
        false
        -
        -
      • -
      -
    • -
    -
    -
    -
      -
    • - - -
        -
      • -

        withAnnotations

        -
        java.lang.Class<? extends java.lang.annotation.Annotation>[] withAnnotations
        -
        Narrows down the set of expected types, defined by types - and withSubtypes, to types that use any of given annotations. - The annotation can appear on the type, or on any member of the type, or on any - parameter of any member of the type, or as a meta-annotation on any annotation - that is considered by these rules. -

        - If empty, the set of expected types is not narrowed down in any way. - If java.lang.Annotation is present, the set of expected types - is narrowed down to types that use any annotation. -

        - Defaults to an empty array, so that the set of expected types is not - narrowed down in any way.

        -
        -
        Returns:
        -
        types of annotations that must be present on the expected types
        -
        -
        -
        Default:
        -
        {}
        -
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- - - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/FieldConfig.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/FieldConfig.html deleted file mode 100644 index 651b88adb4..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/FieldConfig.html +++ /dev/null @@ -1,405 +0,0 @@ - - - - - -FieldConfig (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Interface FieldConfig

-
-
-
-
    -
  • -
    -
    All Superinterfaces:
    -
    DeclarationConfig
    -
    -
    -
    public interface FieldConfig
    -extends DeclarationConfig
    -
    Allows adding annotations to and removing annotations from a field. - Note that the field is not physically altered, the modifications - are only seen by the CDI container.
    -
    -
    Since:
    -
    4.0
    -
    See Also:
    -
    Enhancement
    -
    -
  • -
-
-
- -
-
-
    -
  • - -
    -
      -
    • - - -

      Method Detail

      - - - - - - - -
        -
      • -

        addAnnotation

        -
        FieldConfig addAnnotation​(java.lang.Class<? extends java.lang.annotation.Annotation> annotationType)
        -
        Adds a marker annotation of given type to this field. - Does not allow configuring annotation members.
        -
        -
        Specified by:
        -
        addAnnotation in interface DeclarationConfig
        -
        Parameters:
        -
        annotationType - the annotation type, must not be null
        -
        Returns:
        -
        this configurator object, to allow fluent usage
        -
        -
      • -
      - - - -
        -
      • -

        addAnnotation

        -
        FieldConfig addAnnotation​(AnnotationInfo annotation)
        -
        Adds given annotation to this field. The AnnotationInfo can be obtained - from an annotation target, or constructed from scratch using AnnotationBuilder.
        -
        -
        Specified by:
        -
        addAnnotation in interface DeclarationConfig
        -
        Parameters:
        -
        annotation - the annotation to add to this field, must not be null
        -
        Returns:
        -
        this configurator object, to allow fluent usage
        -
        -
      • -
      - - - -
        -
      • -

        addAnnotation

        -
        FieldConfig addAnnotation​(java.lang.annotation.Annotation annotation)
        -
        Adds given annotation to this field. The annotation instance is typically - a subclass of AnnotationLiteral.
        -
        -
        Specified by:
        -
        addAnnotation in interface DeclarationConfig
        -
        Parameters:
        -
        annotation - the annotation to add to this field, must not be null
        -
        Returns:
        -
        this configurator object, to allow fluent usage
        -
        -
      • -
      - - - -
        -
      • -

        removeAnnotation

        -
        FieldConfig removeAnnotation​(java.util.function.Predicate<AnnotationInfo> predicate)
        -
        Removes all annotations matching given predicate from this field.
        -
        -
        Specified by:
        -
        removeAnnotation in interface DeclarationConfig
        -
        Parameters:
        -
        predicate - an annotation predicate, must not be null
        -
        Returns:
        -
        this configurator object, to allow fluent usage
        -
        -
      • -
      - - - -
        -
      • -

        removeAllAnnotations

        -
        FieldConfig removeAllAnnotations()
        -
        Removes all annotations from this field.
        -
        -
        Specified by:
        -
        removeAllAnnotations in interface DeclarationConfig
        -
        Returns:
        -
        this configurator object, to allow fluent usage
        -
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- -
- -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

-
- - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/InjectionPointInfo.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/InjectionPointInfo.html deleted file mode 100644 index 7d22e47ae4..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/InjectionPointInfo.html +++ /dev/null @@ -1,320 +0,0 @@ - - - - - -InjectionPointInfo (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Interface InjectionPointInfo

-
-
-
-
    -
  • -
    -
    public interface InjectionPointInfo
    -
    An injection point defined on some bean. Injection points may be fields - or method parameters.
    -
    -
    Since:
    -
    4.0
    -
    -
  • -
-
-
- -
-
-
    -
  • - -
    -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        type

        -
        Type type()
        -
        Returns the type of this injection point.
        -
        -
        Returns:
        -
        the type of this injection point, never null
        -
        -
      • -
      - - - -
        -
      • -

        qualifiers

        -
        java.util.Collection<AnnotationInfo> qualifiers()
        -
        Returns a collection of qualifiers declared on this injection point, represented as AnnotationInfo.
        -
        -
        Returns:
        -
        collection of qualifiers, never null
        -
        -
      • -
      - - - -
        -
      • -

        declaration

        -
        DeclarationInfo declaration()
        -
        Returns the declaration of this injection point. - That is a FieldInfo for field injection, - or ParameterInfo for: -
          -
        • constructor injection,
        • -
        • initializer method,
        • -
        • disposer method,
        • -
        • producer method,
        • -
        • observer method.
        • -
        -
        -
        Returns:
        -
        the declaration of this injection point, never null
        -
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- -
- -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

-
- - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/InterceptorInfo.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/InterceptorInfo.html deleted file mode 100644 index 2270c0008b..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/InterceptorInfo.html +++ /dev/null @@ -1,369 +0,0 @@ - - - - - -InterceptorInfo (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Interface InterceptorInfo

-
-
-
-
    -
  • -
    -
    All Superinterfaces:
    -
    BeanInfo
    -
    -
    -
    public interface InterceptorInfo
    -extends BeanInfo
    -
    Interceptors are managed beans annotated @Interceptor. - An interceptor declares a set of interceptor binding annotations, - used to associate the interceptor with target beans. It also declares at most one interceptor method - for each interception type. Interception types are: -
      -
    • @AroundInvoke: intercept business method invocations,
    • -
    • @AroundConstruct: intercept constructor invocations,
    • -
    • @PostConstruct: called after the container creates the target instance - and completes dependency injection,
    • -
    • @PreDestroy: called before the container destroys the target instance.
    • -
    - Finally, an interceptor also needs to declare a @Priority to become enabled. -

    - Note that this description applies to CDI Lite. There are more ways to declare an interceptor, - but those are only present in CDI Full.

    -
    -
    Since:
    -
    4.0
    -
    -
  • -
-
-
- -
-
-
    -
  • - -
    -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        interceptorBindings

        -
        java.util.Collection<AnnotationInfo> interceptorBindings()
        -
        Returns the set of interceptor binding annotations - declared on this interceptor.
        -
        -
        Returns:
        -
        immutable set of interceptor binding annotations, never null
        -
        -
      • -
      - - - -
        -
      • -

        intercepts

        -
        boolean intercepts​(InterceptionType interceptionType)
        -
        Returns whether this interceptor declares an interceptor method for given - interception type.
        -
        -
        Parameters:
        -
        interceptionType - the type of interception
        -
        Returns:
        -
        whether this interceptor declares an interceptor method for given interception type
        -
        -
      • -
      - - - -
        -
      • -

        isInterceptor

        -
        default boolean isInterceptor()
        -
        Description copied from interface: BeanInfo
        -
        Returns whether this bean is an interceptor.
        -
        -
        Specified by:
        -
        isInterceptor in interface BeanInfo
        -
        Returns:
        -
        whether this bean is an interceptor
        -
        -
      • -
      - - - - -
    • -
    -
    -
  • -
-
-
-
- -
- -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

-
- - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/InvokerInfo.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/InvokerInfo.html deleted file mode 100644 index a258b63796..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/InvokerInfo.html +++ /dev/null @@ -1,204 +0,0 @@ - - - - - -InvokerInfo (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Interface InvokerInfo

-
-
-
- -
-
-
- -
- -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

-
- - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/Messages.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/Messages.html deleted file mode 100644 index 664680f9fe..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/Messages.html +++ /dev/null @@ -1,555 +0,0 @@ - - - - - -Messages (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Interface Messages

-
-
-
-
    -
  • -
    -
    public interface Messages
    -
    Allows logging and producing errors during build compatible extension - execution. If an error is produced, using any of the error methods, the container treats it - as a deployment problem.
    -
    -
    Since:
    -
    4.0
    -
    -
  • -
-
-
-
    -
  • - -
    -
      -
    • - - -

      Method Summary

      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      All Methods Instance Methods Abstract Methods 
      Modifier and TypeMethodDescription
      voiderror​(java.lang.Exception exception) -
      Add a generic error that is represented by an exception.
      -
      voiderror​(java.lang.String message) -
      Add a generic error that is not related to any particular element, or that information is not known.
      -
      voiderror​(java.lang.String message, - BeanInfo relatedTo) -
      Add an error which is related to given BeanInfo.
      -
      voiderror​(java.lang.String message, - ObserverInfo relatedTo) -
      Add an error which is related to given ObserverInfo.
      -
      voiderror​(java.lang.String message, - AnnotationTarget relatedTo) -
      Add an error which is related to given AnnotationTarget (which is most likely - a DeclarationInfo).
      -
      voidinfo​(java.lang.String message) -
      Add a generic information message that is not related to any particular element, or that information is not known.
      -
      voidinfo​(java.lang.String message, - BeanInfo relatedTo) -
      Add an information message which is related to given BeanInfo.
      -
      voidinfo​(java.lang.String message, - ObserverInfo relatedTo) -
      Add an information message which is related to given ObserverInfo.
      -
      voidinfo​(java.lang.String message, - AnnotationTarget relatedTo) -
      Add an information message which is related to given AnnotationTarget (which is most likely - a DeclarationInfo).
      -
      voidwarn​(java.lang.String message) -
      Add a generic warning that is not related to any particular element, or that information is not known.
      -
      voidwarn​(java.lang.String message, - BeanInfo relatedTo) -
      Add a warning which is related to given BeanInfo.
      -
      voidwarn​(java.lang.String message, - ObserverInfo relatedTo) -
      Add a warning which is related to given ObserverInfo.
      -
      voidwarn​(java.lang.String message, - AnnotationTarget relatedTo) -
      Add a warning which is related to given AnnotationTarget (which is most likely - a DeclarationInfo).
      -
      -
    • -
    -
    -
  • -
-
-
-
    -
  • - -
    -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        info

        -
        void info​(java.lang.String message)
        -
        Add a generic information message that is not related to any particular element, or that information is not known.
        -
        -
        Parameters:
        -
        message - information message
        -
        -
      • -
      - - - -
        -
      • -

        info

        -
        void info​(java.lang.String message,
        -          AnnotationTarget relatedTo)
        -
        Add an information message which is related to given AnnotationTarget (which is most likely - a DeclarationInfo).
        -
        -
        Parameters:
        -
        message - information message
        -
        relatedTo - annotation target to which the message is related
        -
        -
      • -
      - - - -
        -
      • -

        info

        -
        void info​(java.lang.String message,
        -          BeanInfo relatedTo)
        -
        Add an information message which is related to given BeanInfo.
        -
        -
        Parameters:
        -
        message - information message
        -
        relatedTo - bean to which the message is related
        -
        -
      • -
      - - - -
        -
      • -

        info

        -
        void info​(java.lang.String message,
        -          ObserverInfo relatedTo)
        -
        Add an information message which is related to given ObserverInfo.
        -
        -
        Parameters:
        -
        message - information message
        -
        relatedTo - observer to which the message is related
        -
        -
      • -
      - - - -
        -
      • -

        warn

        -
        void warn​(java.lang.String message)
        -
        Add a generic warning that is not related to any particular element, or that information is not known.
        -
        -
        Parameters:
        -
        message - warning message
        -
        -
      • -
      - - - -
        -
      • -

        warn

        -
        void warn​(java.lang.String message,
        -          AnnotationTarget relatedTo)
        -
        Add a warning which is related to given AnnotationTarget (which is most likely - a DeclarationInfo).
        -
        -
        Parameters:
        -
        message - warning message
        -
        relatedTo - annotation target to which the message is related
        -
        -
      • -
      - - - -
        -
      • -

        warn

        -
        void warn​(java.lang.String message,
        -          BeanInfo relatedTo)
        -
        Add a warning which is related to given BeanInfo.
        -
        -
        Parameters:
        -
        message - warning message
        -
        relatedTo - bean to which the message is related
        -
        -
      • -
      - - - -
        -
      • -

        warn

        -
        void warn​(java.lang.String message,
        -          ObserverInfo relatedTo)
        -
        Add a warning which is related to given ObserverInfo.
        -
        -
        Parameters:
        -
        message - warning message
        -
        relatedTo - observer to which the message is related
        -
        -
      • -
      - - - -
        -
      • -

        error

        -
        void error​(java.lang.String message)
        -
        Add a generic error that is not related to any particular element, or that information is not known.
        -
        -
        Parameters:
        -
        message - error message
        -
        -
      • -
      - - - -
        -
      • -

        error

        -
        void error​(java.lang.String message,
        -           AnnotationTarget relatedTo)
        -
        Add an error which is related to given AnnotationTarget (which is most likely - a DeclarationInfo).
        -
        -
        Parameters:
        -
        message - error message
        -
        relatedTo - annotation target to which the message is related
        -
        -
      • -
      - - - -
        -
      • -

        error

        -
        void error​(java.lang.String message,
        -           BeanInfo relatedTo)
        -
        Add an error which is related to given BeanInfo.
        -
        -
        Parameters:
        -
        message - error message
        -
        relatedTo - bean to which the message is related
        -
        -
      • -
      - - - -
        -
      • -

        error

        -
        void error​(java.lang.String message,
        -           ObserverInfo relatedTo)
        -
        Add an error which is related to given ObserverInfo.
        -
        -
        Parameters:
        -
        message - error message
        -
        relatedTo - observer to which the message is related
        -
        -
      • -
      - - - -
        -
      • -

        error

        -
        void error​(java.lang.Exception exception)
        -
        Add a generic error that is represented by an exception.
        -
        -
        Parameters:
        -
        exception - error, represented by an exception
        -
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- -
- -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

-
- - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/MetaAnnotations.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/MetaAnnotations.html deleted file mode 100644 index d8f9998956..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/MetaAnnotations.html +++ /dev/null @@ -1,396 +0,0 @@ - - - - - -MetaAnnotations (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Interface MetaAnnotations

-
-
-
-
    -
  • -
    -
    public interface MetaAnnotations
    -
    Allows registering custom CDI meta-annotations: qualifiers, interceptor bindings, - stereotypes, and scopes. When registering a custom scope, a context class must - also be provided.
    -
    -
    Since:
    -
    4.0
    -
    -
  • -
-
-
-
    -
  • - -
    -
      -
    • - - -

      Method Summary

      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      All Methods Instance Methods Abstract Methods 
      Modifier and TypeMethodDescription
      voidaddContext​(java.lang.Class<? extends java.lang.annotation.Annotation> scopeAnnotation, - boolean isNormal, - java.lang.Class<? extends AlterableContext> contextClass) -
      Registers custom context for given scopeAnnotation and given contextClass.
      -
      voidaddContext​(java.lang.Class<? extends java.lang.annotation.Annotation> scopeAnnotation, - java.lang.Class<? extends AlterableContext> contextClass) -
      Registers custom context for given scopeAnnotation and given contextClass.
      -
      ClassConfigaddInterceptorBinding​(java.lang.Class<? extends java.lang.annotation.Annotation> annotation) -
      Registers annotation as an interceptor binding annotation.
      -
      ClassConfigaddQualifier​(java.lang.Class<? extends java.lang.annotation.Annotation> annotation) -
      Registers annotation as a qualifier annotation.
      -
      ClassConfigaddStereotype​(java.lang.Class<? extends java.lang.annotation.Annotation> annotation) -
      Registers annotation as a stereotype annotation.
      -
      -
    • -
    -
    -
  • -
-
-
-
    -
  • - -
    -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        addQualifier

        -
        ClassConfig addQualifier​(java.lang.Class<? extends java.lang.annotation.Annotation> annotation)
        -
        Registers annotation as a qualifier annotation. Only makes sense if the annotation - is not meta-annotated @Qualifier. -

        - Returns a class configurator object that allows transforming meta-annotations - on the annotation.

        -
        -
        Parameters:
        -
        annotation - annotation type
        -
        Returns:
        -
        the class configurator, never null
        -
        -
      • -
      - - - -
        -
      • -

        addInterceptorBinding

        -
        ClassConfig addInterceptorBinding​(java.lang.Class<? extends java.lang.annotation.Annotation> annotation)
        -
        Registers annotation as an interceptor binding annotation. Only makes sense if the annotation - is not meta-annotated @InterceptorBinding. -

        - Returns a class configurator object that allows transforming meta-annotations - on the annotation.

        -
        -
        Parameters:
        -
        annotation - annotation type
        -
        Returns:
        -
        the class configurator, never null
        -
        -
      • -
      - - - -
        -
      • -

        addStereotype

        -
        ClassConfig addStereotype​(java.lang.Class<? extends java.lang.annotation.Annotation> annotation)
        -
        Registers annotation as a stereotype annotation. Only makes sense if the annotation - is not meta-annotated @Stereotype. -

        - Returns a class configurator object that allows transforming meta-annotations - on the annotation.

        -
        -
        Parameters:
        -
        annotation - annotation type
        -
        Returns:
        -
        the class configurator, never null
        -
        -
      • -
      - - - -
        -
      • -

        addContext

        -
        void addContext​(java.lang.Class<? extends java.lang.annotation.Annotation> scopeAnnotation,
        -                java.lang.Class<? extends AlterableContext> contextClass)
        -
        Registers custom context for given scopeAnnotation and given contextClass. - CDI container will create an instance of the context class once to obtain the context object. - The context class must be public and have a public zero-parameter constructor; - it must not be a bean. -

        - Whether the scope is normal is discovered from the scope annotation. This means that the scope - annotation must be meta-annotated either @NormalScope - or @Scope.

        -
        -
        Parameters:
        -
        scopeAnnotation - the scope annotation type, must not be null
        -
        contextClass - the context class, must not be null
        -
        Throws:
        -
        java.lang.IllegalArgumentException - if the scopeAnnotation is not meta-annotated @NormalScope - or @Scope
        -
        -
      • -
      - - - -
        -
      • -

        addContext

        -
        void addContext​(java.lang.Class<? extends java.lang.annotation.Annotation> scopeAnnotation,
        -                boolean isNormal,
        -                java.lang.Class<? extends AlterableContext> contextClass)
        -
        Registers custom context for given scopeAnnotation and given contextClass. - CDI container will create an instance of the context class once to obtain the context object. - The context class must be public and have a public zero-parameter constructor; - it must not be a bean. -

        - The isNormal parameter determines whether the scope is a normal scope or a pseudo-scope.

        -
        -
        Parameters:
        -
        scopeAnnotation - the scope annotation type, must not be null
        -
        isNormal - whether the scope is normal
        -
        contextClass - the context class, must not be null
        -
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- -
- -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

-
- - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/MethodConfig.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/MethodConfig.html deleted file mode 100644 index d1e6145ad0..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/MethodConfig.html +++ /dev/null @@ -1,426 +0,0 @@ - - - - - -MethodConfig (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Interface MethodConfig

-
-
-
-
    -
  • -
    -
    All Superinterfaces:
    -
    DeclarationConfig
    -
    -
    -
    public interface MethodConfig
    -extends DeclarationConfig
    -
    Allows adding annotations to and removing annotations from a method. - Note that the method is not physically altered, the modifications - are only seen by the CDI container.
    -
    -
    Since:
    -
    4.0
    -
    See Also:
    -
    Enhancement
    -
    -
  • -
-
-
- -
-
-
    -
  • - -
    -
      -
    • - - -

      Method Detail

      - - - - - - - -
        -
      • -

        addAnnotation

        -
        MethodConfig addAnnotation​(java.lang.Class<? extends java.lang.annotation.Annotation> annotationType)
        -
        Adds a marker annotation of given type to this method. - Does not allow configuring annotation members.
        -
        -
        Specified by:
        -
        addAnnotation in interface DeclarationConfig
        -
        Parameters:
        -
        annotationType - the annotation type, must not be null
        -
        Returns:
        -
        this configurator object, to allow fluent usage
        -
        -
      • -
      - - - -
        -
      • -

        addAnnotation

        -
        MethodConfig addAnnotation​(AnnotationInfo annotation)
        -
        Adds given annotation to this method. The AnnotationInfo can be obtained - from an annotation target, or constructed from scratch using AnnotationBuilder.
        -
        -
        Specified by:
        -
        addAnnotation in interface DeclarationConfig
        -
        Parameters:
        -
        annotation - the annotation to add to this method, must not be null
        -
        Returns:
        -
        this configurator object, to allow fluent usage
        -
        -
      • -
      - - - -
        -
      • -

        addAnnotation

        -
        MethodConfig addAnnotation​(java.lang.annotation.Annotation annotation)
        -
        Adds given annotation to this method. The annotation instance is typically - a subclass of AnnotationLiteral.
        -
        -
        Specified by:
        -
        addAnnotation in interface DeclarationConfig
        -
        Parameters:
        -
        annotation - the annotation to add to this method, must not be null
        -
        Returns:
        -
        this configurator object, to allow fluent usage
        -
        -
      • -
      - - - -
        -
      • -

        removeAnnotation

        -
        MethodConfig removeAnnotation​(java.util.function.Predicate<AnnotationInfo> predicate)
        -
        Removes all annotations matching given predicate from this method.
        -
        -
        Specified by:
        -
        removeAnnotation in interface DeclarationConfig
        -
        Parameters:
        -
        predicate - an annotation predicate, must not be null
        -
        Returns:
        -
        this configurator object, to allow fluent usage
        -
        -
      • -
      - - - - - - - - -
    • -
    -
    -
  • -
-
-
-
- -
- -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

-
- - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/ObserverInfo.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/ObserverInfo.html deleted file mode 100644 index d4c05729bb..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/ObserverInfo.html +++ /dev/null @@ -1,499 +0,0 @@ - - - - - -ObserverInfo (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Interface ObserverInfo

-
-
-
-
    -
  • -
    -
    public interface ObserverInfo
    -
    Observers are: - -
      -
    • observer methods
    • -
    • synthetic observers
    • -
    - - Observer methods directly correspond to a method declaration in program source code. - Synthetic observers don't and are instead defined through other mechanisms, such as - extensions.
    -
    -
    Since:
    -
    4.0
    -
    -
  • -
-
-
- -
-
-
    -
  • - -
    -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        eventType

        -
        Type eventType()
        -
        Returns the observed event type of this observer.
        -
        -
        Returns:
        -
        the observed event type of this observer, never null
        -
        -
      • -
      - - - -
        -
      • -

        qualifiers

        -
        java.util.Collection<AnnotationInfo> qualifiers()
        -
        Returns a collection of observed event qualifiers, represented as AnnotationInfo.
        -
        -
        Returns:
        -
        immutable collection of observed event qualifiers, never null
        -
        -
      • -
      - - - -
        -
      • -

        declaringClass

        -
        ClassInfo declaringClass()
        -
        Returns the class that declares this observer. - In case of synthetic observers, returns the class that was designated - as a declaring class during synthetic observer registration.
        -
        -
        Returns:
        -
        the class that declares this observer, never null
        -
        -
      • -
      - - - -
        -
      • -

        observerMethod

        -
        MethodInfo observerMethod()
        -
        Returns the declaration of this observer method. - Returns null if this is a synthetic observer.
        -
        -
        Returns:
        -
        this observer method, or null if this is a synthetic observer
        -
        -
      • -
      - - - -
        -
      • -

        eventParameter

        -
        ParameterInfo eventParameter()
        -
        Returns the event parameter of this observer method. - Returns null if this is a synthetic observer.
        -
        -
        Returns:
        -
        the event parameter of this observer method, or null if this is a synthetic observer
        -
        -
      • -
      - - - -
        -
      • -

        bean

        -
        BeanInfo bean()
        -
        Returns the bean that declares this observer method. - Returns null if this is a synthetic observer.
        -
        -
        Returns:
        -
        the bean declaring this observer method, or null if this is a synthetic observer
        -
        -
      • -
      - - - -
        -
      • -

        isSynthetic

        -
        boolean isSynthetic()
        -
        Returns whether this observer is synthetic.
        -
        -
        Returns:
        -
        whether this observer is synthetic
        -
        -
      • -
      - - - -
        -
      • -

        priority

        -
        int priority()
        -
        Returns the priority of this observer. This is typically defined by adding - the @Priority annotation to the event parameter of the observer method. - If the annotation is not used, the default priority, as defined by the CDI specification, is returned,
        -
        -
        Returns:
        -
        the priority of this observer
        -
        -
      • -
      - - - -
        -
      • -

        isAsync

        -
        boolean isAsync()
        -
        Returns whether this observer is asynchronous. For observer methods, this means whether - this observer method uses @ObservesAsync.
        -
        -
        Returns:
        -
        whether this observer is asynchronous
        -
        -
      • -
      - - - -
        -
      • -

        reception

        -
        Reception reception()
        -
        Returns the reception type of this observer. Allows distinguishing - conditional observer methods from always notified observer methods. - Returns Reception.ALWAYS if this is a synthetic observer.
        -
        -
        Returns:
        -
        the reception type of this observer, never null
        -
        -
      • -
      - - - -
        -
      • -

        transactionPhase

        -
        TransactionPhase transactionPhase()
        -
        Returns the transaction phase of this transactional observer. - Returns TransactionPhase.IN_PROGRESS if this is a regular synchronous observer. - Returns null if this is an asynchronous observer.
        -
        -
        Returns:
        -
        the transaction phase of this observer, or null if this is an asynchronous observer
        -
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- -
- -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

-
- - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/ParameterConfig.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/ParameterConfig.html deleted file mode 100644 index bf0c8724a1..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/ParameterConfig.html +++ /dev/null @@ -1,405 +0,0 @@ - - - - - -ParameterConfig (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Interface ParameterConfig

-
-
-
-
    -
  • -
    -
    All Superinterfaces:
    -
    DeclarationConfig
    -
    -
    -
    public interface ParameterConfig
    -extends DeclarationConfig
    -
    Allows adding annotations to and removing annotations from a method parameter. - Note that the method parameter is not physically altered, the modifications - are only seen by the CDI container.
    -
    -
    Since:
    -
    4.0
    -
    See Also:
    -
    Enhancement
    -
    -
  • -
-
-
- -
-
-
    -
  • - -
    -
      -
    • - - -

      Method Detail

      - - - - - - - -
        -
      • -

        addAnnotation

        -
        ParameterConfig addAnnotation​(java.lang.Class<? extends java.lang.annotation.Annotation> annotationType)
        -
        Adds a marker annotation of given type to this method parameter. - Does not allow configuring annotation members.
        -
        -
        Specified by:
        -
        addAnnotation in interface DeclarationConfig
        -
        Parameters:
        -
        annotationType - the annotation type, must not be null
        -
        Returns:
        -
        this configurator object, to allow fluent usage
        -
        -
      • -
      - - - -
        -
      • -

        addAnnotation

        -
        ParameterConfig addAnnotation​(AnnotationInfo annotation)
        -
        Adds given annotation to this method parameter. The AnnotationInfo can be obtained - from an annotation target, or constructed from scratch using AnnotationBuilder.
        -
        -
        Specified by:
        -
        addAnnotation in interface DeclarationConfig
        -
        Parameters:
        -
        annotation - the annotation to add to this method parameter, must not be null
        -
        Returns:
        -
        this configurator object, to allow fluent usage
        -
        -
      • -
      - - - -
        -
      • -

        addAnnotation

        -
        ParameterConfig addAnnotation​(java.lang.annotation.Annotation annotation)
        -
        Adds given annotation to this method parameter. The annotation instance is typically - a subclass of AnnotationLiteral.
        -
        -
        Specified by:
        -
        addAnnotation in interface DeclarationConfig
        -
        Parameters:
        -
        annotation - the annotation to add to this method parameter, must not be null
        -
        Returns:
        -
        this configurator object, to allow fluent usage
        -
        -
      • -
      - - - -
        -
      • -

        removeAnnotation

        -
        ParameterConfig removeAnnotation​(java.util.function.Predicate<AnnotationInfo> predicate)
        -
        Removes all annotations matching given predicate from this method parameter.
        -
        -
        Specified by:
        -
        removeAnnotation in interface DeclarationConfig
        -
        Parameters:
        -
        predicate - an annotation predicate, must not be null
        -
        Returns:
        -
        this configurator object, to allow fluent usage
        -
        -
      • -
      - - - - -
    • -
    -
    -
  • -
-
-
-
- -
- -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

-
- - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/Parameters.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/Parameters.html deleted file mode 100644 index 473ed846f7..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/Parameters.html +++ /dev/null @@ -1,340 +0,0 @@ - - - - - -Parameters (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Interface Parameters

-
-
-
-
    -
  • -
    -
    public interface Parameters
    -
    A String-keyed parameter map. The parameter mappings are defined - by a synthetic component builder. The CDI container passes the parameter map - to functions defined by the same synthetic component builder, whenever - it needs to invoke those functions. That is: - - - - Parameter values are transferred from the builder to the Parameters-accepting - function without a change. For example, if the builder defines an int parameter, - it must be looked up as int and cannot be looked up as long. -

    - Values of primitive types may be looked up either using the primitive type (such as - int.class), or using the corresponding wrapper type (Integer.class). - The return value is always of the wrapper type, so that null can be returned - when the parameter does not exist. Note that this does not apply to arrays - of primitive types; an int[] cannot be looked up as Integer[]. - This is because arrays are reference types and so null can be returned. -

    - Class-typed parameters are available as instances of Class, even if an instance - of ClassInfo was passed to the builder. -

    - Annotation-typed parameters are available as instances of the annotation type, - even if an instance of AnnotationInfo was passed to the builder. -

    - Invoker-typed parameters are available as instances of Invoker, even though - an instance of InvokerInfo was passed to the builder.

    -
  • -
-
-
-
    -
  • - -
    -
      -
    • - - -

      Method Summary

      - - - - - - - - - - - - - - - - - -
      All Methods Instance Methods Abstract Methods 
      Modifier and TypeMethodDescription
      <T> Tget​(java.lang.String key, - java.lang.Class<T> type) -
      Returns the value of a parameter with given key.
      -
      <T> Tget​(java.lang.String key, - java.lang.Class<T> type, - T defaultValue) -
      Returns the value of a parameter with given key.
      -
      -
    • -
    -
    -
  • -
-
-
-
    -
  • - -
    -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        get

        -
        <T> T get​(java.lang.String key,
        -          java.lang.Class<T> type)
        -
        Returns the value of a parameter with given key. The value is expected to be of given type.
        -
        -
        Type Parameters:
        -
        T - the parameter type
        -
        Parameters:
        -
        key - the parameter key, must not be null
        -
        type - the parameter type, must not be null
        -
        Returns:
        -
        the parameter value, or null if parameter with given key does not exist
        -
        Throws:
        -
        java.lang.ClassCastException - if the parameter exists, but is of a different type
        -
        -
      • -
      - - - - - -
        -
      • -

        get

        -
        <T> T get​(java.lang.String key,
        -          java.lang.Class<T> type,
        -          T defaultValue)
        -
        Returns the value of a parameter with given key. The value is expected to be of given type. - If the parameter does not exist, returns defaultValue.
        -
        -
        Type Parameters:
        -
        T - the parameter type
        -
        Parameters:
        -
        key - the parameter key, must not be null
        -
        type - the parameter type, must not be null
        -
        defaultValue - the value to return if parameter with given key does not exist
        -
        Returns:
        -
        the parameter value, or defaultValue if parameter with given key does not exist
        -
        Throws:
        -
        java.lang.ClassCastException - if the parameter exists, but is of a different type
        -
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- -
- -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

-
- - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/Registration.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/Registration.html deleted file mode 100644 index 27a43c48e7..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/Registration.html +++ /dev/null @@ -1,295 +0,0 @@ - - - - - -Registration (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Annotation Type Registration

-
-
-
-
    -
  • -
    -
    @Target(METHOD)
    -@Retention(RUNTIME)
    -public @interface Registration
    -
    3rd phase of build compatible extension execution. - Allows observing registered beans and observers. -

    - This phase is executed twice. - For non-synthetic beans and observers, this phase is executed before synthesis. - For synthetic beans and observers, this phase is executed after synthesis. -

    - In the following text, the term expected types denotes the set of types defined by - the types member of the @Registration annotation. -

    - Methods annotated @Registration must declare exactly one parameter of one of these types: -

    - If a @Registration method has a parameter of type BeanInfo, the method is called once - for each bean whose set of bean types contains at least one expected type. -

    - If the @Registration method has a parameter of type InterceptorInfo, the method is called once - for each interceptor whose set of bean types contains at least one expected type. -

    - If the @Registration method has a parameter of type ObserverInfo, the method is called once - for each observer whose observed event type is assignable to at least one expected type. -

    - Note that InterceptorInfo is a subtype of BeanInfo, so if the method has a parameter - of type BeanInfo, it will be called for interceptors as well. -

    - If the @Registration method doesn't declare any parameter of one of these types, - or if it declares more than one, the container treats it as a definition error. -

    - Additionally, methods annotated @Registration may declare parameters of these types: -

    -
    -
    Since:
    -
    4.0
    -
    -
  • -
-
-
-
    -
  • - -
    -
      -
    • - - -

      Required Element Summary

      - - - - - - - - - - - - -
      Required Elements 
      Modifier and TypeRequired ElementDescription
      java.lang.Class<?>[]types -
      Defines the set of expected types.
      -
      -
    • -
    -
    -
  • -
-
-
-
    -
  • - -
    -
      -
    • - - -

      Element Detail

      - - - -
        -
      • -

        types

        -
        java.lang.Class<?>[] types
        -
        Defines the set of expected types.
        -
        -
        Returns:
        -
        the set of expected types
        -
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- - - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/ScannedClasses.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/ScannedClasses.html deleted file mode 100644 index 7ebcdb8e97..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/ScannedClasses.html +++ /dev/null @@ -1,275 +0,0 @@ - - - - - -ScannedClasses (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Interface ScannedClasses

-
-
-
-
    -
  • -
    -
    public interface ScannedClasses
    -
    Allows adding additional classes to the set of types discovered during type discovery. - Such classes will therefore be scanned during bean discovery. Annotations on these classes - can later be transformed using @Enhancement.
    -
    -
    Since:
    -
    4.0
    -
    -
  • -
-
-
-
    -
  • - -
    -
      -
    • - - -

      Method Summary

      - - - - - - - - - - - - -
      All Methods Instance Methods Abstract Methods 
      Modifier and TypeMethodDescription
      voidadd​(java.lang.String className) -
      Adds a class with given name to the set of types discovered during type discovery.
      -
      -
    • -
    -
    -
  • -
-
-
-
    -
  • - -
    -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        add

        -
        void add​(java.lang.String className)
        -
        Adds a class with given name to the set of types discovered during type discovery. - The class will therefore be scanned during bean discovery. -

        - Adding the same class multiple times, or adding a class that is automatically discovered - by the container, leads to non-portable behavior.

        -
        -
        Parameters:
        -
        className - binary name of the class, as defined by The Java™ Language Specification; - in other words, the class name as returned by Class.getName()
        -
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- -
- -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

-
- - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/ScopeInfo.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/ScopeInfo.html deleted file mode 100644 index 66a30e7193..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/ScopeInfo.html +++ /dev/null @@ -1,316 +0,0 @@ - - - - - -ScopeInfo (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Interface ScopeInfo

-
-
-
-
    -
  • -
    -
    public interface ScopeInfo
    -
    A scope of a bean. Scope type is an annotation, meta-annotated - @Scope or @NormalScope. - Lifecycle of beans with given scope is determined by a context.
    -
    -
    Since:
    -
    4.0
    -
    -
  • -
-
-
-
    -
  • - -
    -
      -
    • - - -

      Method Summary

      - - - - - - - - - - - - - - - - - - - - - - -
      All Methods Instance Methods Abstract Methods Default Methods 
      Modifier and TypeMethodDescription
      ClassInfoannotation() -
      Returns the declaration of this scope annotation.
      -
      booleanisNormal() -
      Returns whether this scope type is normal.
      -
      default java.lang.Stringname() -
      Binary name of this scope annotation, as defined by The Java™ Language Specification; - in other words, the scope annotation name as returned by Class.getName().
      -
      -
    • -
    -
    -
  • -
-
-
-
    -
  • - -
    -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        annotation

        -
        ClassInfo annotation()
        -
        Returns the declaration of this scope annotation.
        -
        -
        Returns:
        -
        declaration of this scope annotation, never null
        -
        -
      • -
      - - - -
        -
      • -

        name

        -
        default java.lang.String name()
        -
        Binary name of this scope annotation, as defined by The Java™ Language Specification; - in other words, the scope annotation name as returned by Class.getName(). - Equivalent to annotation().name().
        -
        -
        Returns:
        -
        binary name of this scope annotation, never null
        -
        -
      • -
      - - - -
        -
      • -

        isNormal

        -
        boolean isNormal()
        -
        Returns whether this scope type is normal. In other words, returns whether - this scope annotation is meta-annotated @NormalScope.
        -
        -
        Returns:
        -
        whether this scope type is normal
        -
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- -
- -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

-
- - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/SkipIfPortableExtensionPresent.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/SkipIfPortableExtensionPresent.html deleted file mode 100644 index eea1335de0..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/SkipIfPortableExtensionPresent.html +++ /dev/null @@ -1,269 +0,0 @@ - - - - - -SkipIfPortableExtensionPresent (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Annotation Type SkipIfPortableExtensionPresent

-
-
-
-
    -
  • -
    -
    @Target(TYPE)
    -@Retention(RUNTIME)
    -public @interface SkipIfPortableExtensionPresent
    -
    If a build compatible extension is annotated - @SkipIfPortableExtensionPresent, it is ignored when the CDI container - can execute portable extensions and determines that a portable extension - of given class is present. -

    - It is expected that the specified portable extension class will mirror the functionality - of the annotated build compatible extension. This allows portable extensions - and build compatible extensions to coexist.

    -
    -
    Since:
    -
    4.0
    -
    -
  • -
-
-
-
    -
  • - -
    -
      -
    • - - -

      Required Element Summary

      - - - - - - - - - - - - -
      Required Elements 
      Modifier and TypeRequired ElementDescription
      java.lang.Class<? extends Extension>value -
      A class implementing Extension that is expected to mirror the functionality of the annotated - build compatible extension.
      -
      -
    • -
    -
    -
  • -
-
-
-
    -
  • - -
    -
      -
    • - - -

      Element Detail

      - - - -
        -
      • -

        value

        -
        java.lang.Class<? extends Extension> value
        -
        A class implementing Extension that is expected to mirror the functionality of the annotated - build compatible extension.
        -
        -
        Returns:
        -
        a portable extension class
        -
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- - - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/StereotypeInfo.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/StereotypeInfo.html deleted file mode 100644 index 2accaa2f9e..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/StereotypeInfo.html +++ /dev/null @@ -1,366 +0,0 @@ - - - - - -StereotypeInfo (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Interface StereotypeInfo

-
-
-
- -
-
- -
-
-
    -
  • - -
    -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        defaultScope

        -
        ScopeInfo defaultScope()
        -
        Returns the default scope defined by this stereotype. - Returns null if this stereotype does not define a default scope.
        -
        -
        Returns:
        -
        the default scope or null
        -
        -
      • -
      - - - - - - - -
        -
      • -

        isAlternative

        -
        boolean isAlternative()
        -
        Returns whether this stereotype is meta-annotated @Alternative. - This means that all beans with this stereotype are alternatives.
        -
        -
        Returns:
        -
        whether this stereotype is meta-annotated @Alternative
        -
        -
      • -
      - - - -
        -
      • -

        priority

        -
        java.lang.Integer priority()
        -
        Returns the priority value this stereotype declares using the @Priority - meta-annotation. Beans with this stereotype will be enabled for the application and ordered using this priority - value (unless they declare priority explicitly). -

        - Returns null if this stereotype is not meta-annotated @Priority.

        -
        -
        Returns:
        -
        the @Priority value declared by this stereotype, or null - if this stereotype is not meta-annotated @Priority
        -
        -
      • -
      - - - -
        -
      • -

        isNamed

        -
        boolean isNamed()
        -
        Returns whether this stereotype is meta-annotated @Named. - This means that all beans with this stereotype have default bean names.
        -
        -
        Returns:
        -
        whether this stereotype is meta-annotated @Named
        -
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- -
- -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

-
- - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/Synthesis.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/Synthesis.html deleted file mode 100644 index 69b6fcb8e5..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/Synthesis.html +++ /dev/null @@ -1,207 +0,0 @@ - - - - - -Synthesis (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Annotation Type Synthesis

-
-
-
-
    -
  • -
    -
    @Target(METHOD)
    -@Retention(RUNTIME)
    -public @interface Synthesis
    -
    4th phase of build compatible extension execution. - Allows registering synthetic beans and observers. -

    - Methods annotated @Synthesis may declare parameters of these types: -

    -
    -
    Since:
    -
    4.0
    -
    -
  • -
-
-
-
- -
- -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

-
- - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/SyntheticBeanBuilder.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/SyntheticBeanBuilder.html deleted file mode 100644 index ad8d938c34..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/SyntheticBeanBuilder.html +++ /dev/null @@ -1,1283 +0,0 @@ - - - - - -SyntheticBeanBuilder (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Interface SyntheticBeanBuilder<T>

-
-
-
-
    -
  • -
    -
    Type Parameters:
    -
    T - the bean class of this synthetic bean
    -
    -
    -
    public interface SyntheticBeanBuilder<T>
    -
    Builder for synthetic beans. - Instances are not reusable. For each synthetic bean, new instance - must be created by SyntheticComponents.addBean(Class).
    -
    -
    Since:
    -
    4.0
    -
    -
  • -
-
-
- -
-
-
    -
  • - -
    -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        type

        -
        SyntheticBeanBuilder<T> type​(java.lang.Class<?> type)
        -
        Adds type to the set of bean types of this synthetic bean. This method may be called - multiple times to add multiple bean types. -

        - If not called, the set of bean types of this synthetic bean will be a singleton set - containing java.lang.Object.

        -
        -
        Parameters:
        -
        type - the bean type, must not be null
        -
        Returns:
        -
        this SyntheticBeanBuilder
        -
        -
      • -
      - - - -
        -
      • -

        type

        -
        SyntheticBeanBuilder<T> type​(ClassInfo type)
        -
        Adds type to the set of bean types of this synthetic bean. This method may be called - multiple times to add multiple bean types. -

        - If not called, the set of bean types of this synthetic bean will be a singleton set - containing java.lang.Object.

        -
        -
        Parameters:
        -
        type - the bean type, must not be null
        -
        Returns:
        -
        this SyntheticBeanBuilder
        -
        -
      • -
      - - - -
        -
      • -

        type

        -
        SyntheticBeanBuilder<T> type​(Type type)
        -
        Adds type to the set of bean types of this synthetic bean. This method may be called - multiple times to add multiple bean types. -

        - If not called, the set of bean types of this synthetic bean will be a singleton set - containing java.lang.Object.

        -
        -
        Parameters:
        -
        type - the bean type, must not be null
        -
        Returns:
        -
        this SyntheticBeanBuilder
        -
        -
      • -
      - - - -
        -
      • -

        qualifier

        -
        SyntheticBeanBuilder<T> qualifier​(java.lang.Class<? extends java.lang.annotation.Annotation> annotationType)
        -
        Adds a marker annotation of given type to the set of qualifiers of this synthetic bean. - This method may be called multiple times to add multiple qualifiers. -

        - If not called, this synthetic bean will have the @Default qualifier - (and the @Any qualifier that all beans have).

        -
        -
        Parameters:
        -
        annotationType - the type of the marker annotation, must not be null
        -
        Returns:
        -
        this SyntheticBeanBuilder
        -
        -
      • -
      - - - -
        -
      • -

        qualifier

        -
        SyntheticBeanBuilder<T> qualifier​(AnnotationInfo qualifierAnnotation)
        -
        Adds given annotation to the set of qualifiers of this synthetic bean. - This method may be called multiple times to add multiple qualifiers. -

        - If not called, this synthetic bean will have the @Default qualifier - (and the @Any qualifier that all beans have).

        -
        -
        Parameters:
        -
        qualifierAnnotation - the annotation, must not be null
        -
        Returns:
        -
        this SyntheticBeanBuilder
        -
        -
      • -
      - - - -
        -
      • -

        qualifier

        -
        SyntheticBeanBuilder<T> qualifier​(java.lang.annotation.Annotation qualifierAnnotation)
        -
        Adds given annotation to the set of qualifiers of this synthetic bean. - This method may be called multiple times to add multiple qualifiers. -

        - If not called, this synthetic bean will have the @Default qualifier - (and the @Any qualifier that all beans have).

        -
        -
        Parameters:
        -
        qualifierAnnotation - the annotation, must not be null
        -
        Returns:
        -
        this SyntheticBeanBuilder
        -
        -
      • -
      - - - -
        -
      • -

        scope

        -
        SyntheticBeanBuilder<T> scope​(java.lang.Class<? extends java.lang.annotation.Annotation> scopeAnnotation)
        -
        Sets the scope of this synthetic bean to given scope type. -

        - If not called, and if no stereotype is added that defines a scope, - this synthetic bean will be @Dependent.

        -
        -
        Parameters:
        -
        scopeAnnotation - the scope type, must not be null
        -
        Returns:
        -
        this SyntheticBeanBuilder
        -
        Throws:
        -
        java.lang.IllegalStateException - if this method is called multiple times
        -
        -
      • -
      - - - -
        -
      • -

        alternative

        -
        SyntheticBeanBuilder<T> alternative​(boolean isAlternative)
        -
        Marks this synthetic bean as an alternative if desired. To make this synthetic bean - an enabled alternative, call both alternative(true) and priority(some priority). -

        - If this synthetic bean is an alternative, not setting a priority means - that it is not enabled, which is equivalent to not registering it at all. -

        - If not called, this synthetic bean will not be an alternative.

        -
        -
        Parameters:
        -
        isAlternative - whether this synthetic bean should be an alternative
        -
        Returns:
        -
        this SyntheticBeanBuilder
        -
        Throws:
        -
        java.lang.IllegalStateException - if this method is called multiple times
        -
        -
      • -
      - - - -
        -
      • -

        priority

        -
        SyntheticBeanBuilder<T> priority​(int priority)
        -
        Sets a priority of this synthetic bean. To make this synthetic bean an enabled alternative, - call both alternative(true) and priority(some priority). -

        - If this synthetic bean is an alternative, not setting a priority means - that it is not enabled, which is equivalent to not registering it at all. -

        - If not called, this synthetic bean will not have a priority.

        -
        -
        Parameters:
        -
        priority - the priority of this synthetic bean
        -
        Returns:
        -
        this SyntheticBeanBuilder
        -
        Throws:
        -
        java.lang.IllegalStateException - if this method is called multiple times
        -
        -
      • -
      - - - -
        -
      • -

        name

        -
        SyntheticBeanBuilder<T> name​(java.lang.String beanName)
        -
        Sets the bean name of this synthetic bean. If beanName is null, - this synthetic bean will not have a name. -

        - If not called, this synthetic bean will not have a name.

        -
        -
        Parameters:
        -
        beanName - the bean name of this synthetic bean
        -
        Returns:
        -
        this SyntheticBeanBuilder
        -
        Throws:
        -
        java.lang.IllegalStateException - if this method is called multiple times
        -
        -
      • -
      - - - -
        -
      • -

        stereotype

        -
        SyntheticBeanBuilder<T> stereotype​(java.lang.Class<? extends java.lang.annotation.Annotation> stereotypeAnnotation)
        -
        Adds stereotypeAnnotation to the set of stereotypes of this synthetic bean. - This method may be called multiple times to add multiple stereotypes. -

        - If not called, this synthetic bean will have no stereotype.

        -
        -
        Parameters:
        -
        stereotypeAnnotation - the stereotype, must not be null
        -
        Returns:
        -
        this SyntheticBeanBuilder
        -
        -
      • -
      - - - -
        -
      • -

        stereotype

        -
        SyntheticBeanBuilder<T> stereotype​(ClassInfo stereotypeAnnotation)
        -
        Adds stereotypeAnnotation to the set of stereotypes of this synthetic bean. - This method may be called multiple times to add multiple stereotypes. -

        - If not called, this synthetic bean will have no stereotype.

        -
        -
        Parameters:
        -
        stereotypeAnnotation - the stereotype, must not be null
        -
        Returns:
        -
        this SyntheticBeanBuilder
        -
        -
      • -
      - - - -
        -
      • -

        withParam

        -
        SyntheticBeanBuilder<T> withParam​(java.lang.String key,
        -                                  boolean value)
        -
        Adds a boolean-valued parameter to the parameter map. The parameter map is passed - to the creation and destruction - functions when a bean instance is created/destroyed.
        -
        -
        Parameters:
        -
        key - the parameter key, must not be null
        -
        value - the parameter value
        -
        Returns:
        -
        this SyntheticBeanBuilder
        -
        -
      • -
      - - - -
        -
      • -

        withParam

        -
        SyntheticBeanBuilder<T> withParam​(java.lang.String key,
        -                                  boolean[] value)
        -
        Adds a boolean array-valued parameter to the parameter map. The parameter map is passed - to the creation and destruction - functions when a bean instance is created/destroyed.
        -
        -
        Parameters:
        -
        key - the parameter key, must not be null
        -
        value - the parameter value
        -
        Returns:
        -
        this SyntheticBeanBuilder
        -
        -
      • -
      - - - -
        -
      • -

        withParam

        -
        SyntheticBeanBuilder<T> withParam​(java.lang.String key,
        -                                  int value)
        -
        Adds an int-valued parameter to the parameter map. The parameter map is passed - to the creation and destruction - functions when a bean instance is created/destroyed.
        -
        -
        Parameters:
        -
        key - the parameter key, must not be null
        -
        value - the parameter value
        -
        Returns:
        -
        this SyntheticBeanBuilder
        -
        -
      • -
      - - - -
        -
      • -

        withParam

        -
        SyntheticBeanBuilder<T> withParam​(java.lang.String key,
        -                                  int[] value)
        -
        Adds an int array-valued parameter to the parameter map. The parameter map is passed - to the creation and destruction - functions when a bean instance is created/destroyed.
        -
        -
        Parameters:
        -
        key - the parameter key, must not be null
        -
        value - the parameter value
        -
        Returns:
        -
        this SyntheticBeanBuilder
        -
        -
      • -
      - - - -
        -
      • -

        withParam

        -
        SyntheticBeanBuilder<T> withParam​(java.lang.String key,
        -                                  long value)
        -
        Adds a long-valued parameter to the parameter map. The parameter map is passed - to the creation and destruction - functions when a bean instance is created/destroyed.
        -
        -
        Parameters:
        -
        key - the parameter key, must not be null
        -
        value - the parameter value
        -
        Returns:
        -
        this SyntheticBeanBuilder
        -
        -
      • -
      - - - -
        -
      • -

        withParam

        -
        SyntheticBeanBuilder<T> withParam​(java.lang.String key,
        -                                  long[] value)
        -
        Adds a long array-valued parameter to the parameter map. The parameter map is passed - to the creation and destruction - functions when a bean instance is created/destroyed.
        -
        -
        Parameters:
        -
        key - the parameter key, must not be null
        -
        value - the parameter value
        -
        Returns:
        -
        this SyntheticBeanBuilder
        -
        -
      • -
      - - - -
        -
      • -

        withParam

        -
        SyntheticBeanBuilder<T> withParam​(java.lang.String key,
        -                                  double value)
        -
        Adds a double-valued parameter to the parameter map. The parameter map is passed - to the creation and destruction - functions when a bean instance is created/destroyed.
        -
        -
        Parameters:
        -
        key - the parameter key, must not be null
        -
        value - the parameter value
        -
        Returns:
        -
        this SyntheticBeanBuilder
        -
        -
      • -
      - - - -
        -
      • -

        withParam

        -
        SyntheticBeanBuilder<T> withParam​(java.lang.String key,
        -                                  double[] value)
        -
        Adds a double array-valued parameter to the parameter map. The parameter map is passed - to the creation and destruction - functions when a bean instance is created/destroyed.
        -
        -
        Parameters:
        -
        key - the parameter key, must not be null
        -
        value - the parameter value
        -
        Returns:
        -
        this SyntheticBeanBuilder
        -
        -
      • -
      - - - -
        -
      • -

        withParam

        -
        SyntheticBeanBuilder<T> withParam​(java.lang.String key,
        -                                  java.lang.String value)
        -
        Adds a String-valued parameter to the parameter map. The parameter map is passed - to the creation and destruction - functions when a bean instance is created/destroyed.
        -
        -
        Parameters:
        -
        key - the parameter key, must not be null
        -
        value - the parameter value
        -
        Returns:
        -
        this SyntheticBeanBuilder
        -
        -
      • -
      - - - -
        -
      • -

        withParam

        -
        SyntheticBeanBuilder<T> withParam​(java.lang.String key,
        -                                  java.lang.String[] value)
        -
        Adds a String array-valued parameter to the parameter map. The parameter map is passed - to the creation and destruction - functions when a bean instance is created/destroyed.
        -
        -
        Parameters:
        -
        key - the parameter key, must not be null
        -
        value - the parameter value
        -
        Returns:
        -
        this SyntheticBeanBuilder
        -
        -
      • -
      - - - -
        -
      • -

        withParam

        -
        SyntheticBeanBuilder<T> withParam​(java.lang.String key,
        -                                  java.lang.Enum<?> value)
        -
        Adds an enum-valued parameter to the parameter map. The parameter map is passed - to the creation and destruction - functions when a bean instance is created/destroyed.
        -
        -
        Parameters:
        -
        key - the parameter key, must not be null
        -
        value - the parameter value
        -
        Returns:
        -
        this SyntheticBeanBuilder
        -
        -
      • -
      - - - -
        -
      • -

        withParam

        -
        SyntheticBeanBuilder<T> withParam​(java.lang.String key,
        -                                  java.lang.Enum<?>[] value)
        -
        Adds an enum array-valued parameter to the parameter map. The parameter map is passed - to the creation and destruction - functions when a bean instance is created/destroyed.
        -
        -
        Parameters:
        -
        key - the parameter key, must not be null
        -
        value - the parameter value
        -
        Returns:
        -
        this SyntheticBeanBuilder
        -
        -
      • -
      - - - -
        -
      • -

        withParam

        -
        SyntheticBeanBuilder<T> withParam​(java.lang.String key,
        -                                  java.lang.Class<?> value)
        -
        Adds a Class-valued parameter to the parameter map. The parameter map is passed - to the creation and destruction - functions when a bean instance is created/destroyed.
        -
        -
        Parameters:
        -
        key - the parameter key, must not be null
        -
        value - the parameter value
        -
        Returns:
        -
        this SyntheticBeanBuilder
        -
        -
      • -
      - - - -
        -
      • -

        withParam

        -
        SyntheticBeanBuilder<T> withParam​(java.lang.String key,
        -                                  ClassInfo value)
        -
        Adds a Class-valued parameter to the parameter map. The parameter map is passed - to the creation and destruction - functions when a bean instance is created/destroyed. -

        - When looked up from the parameter map in the creation/destruction function, the value will be - an instance of Class, not a ClassInfo.

        -
        -
        Parameters:
        -
        key - the parameter key, must not be null
        -
        value - the parameter value
        -
        Returns:
        -
        this SyntheticBeanBuilder
        -
        -
      • -
      - - - -
        -
      • -

        withParam

        -
        SyntheticBeanBuilder<T> withParam​(java.lang.String key,
        -                                  java.lang.Class<?>[] value)
        -
        Adds a Class array-valued parameter to the parameter map. The parameter map is passed - to the creation and destruction - functions when a bean instance is created/destroyed.
        -
        -
        Parameters:
        -
        key - the parameter key, must not be null
        -
        value - the parameter value
        -
        Returns:
        -
        this SyntheticBeanBuilder
        -
        -
      • -
      - - - -
        -
      • -

        withParam

        -
        SyntheticBeanBuilder<T> withParam​(java.lang.String key,
        -                                  ClassInfo[] value)
        -
        Adds a Class array-valued parameter to the parameter map. The parameter map is passed - to the creation and destruction - functions when a bean instance is created/destroyed. -

        - When looked up from the parameter map in the creation/destruction function, the values will be - instances of Class, not ClassInfo.

        -
        -
        Parameters:
        -
        key - the parameter key, must not be null
        -
        value - the parameter value
        -
        Returns:
        -
        this SyntheticBeanBuilder
        -
        -
      • -
      - - - -
        -
      • -

        withParam

        -
        SyntheticBeanBuilder<T> withParam​(java.lang.String key,
        -                                  AnnotationInfo value)
        -
        Adds an annotation-valued parameter to the parameter map. The parameter map is passed - to the creation and destruction - functions when a bean instance is created/destroyed. -

        - When looked up from the parameter map in the creation/destruction function, the value will be - an instance of the annotation type, not an AnnotationInfo.

        -
        -
        Parameters:
        -
        key - the parameter key, must not be null
        -
        value - the parameter value
        -
        Returns:
        -
        this SyntheticBeanBuilder
        -
        -
      • -
      - - - -
        -
      • -

        withParam

        -
        SyntheticBeanBuilder<T> withParam​(java.lang.String key,
        -                                  java.lang.annotation.Annotation value)
        -
        Adds an annotation-valued parameter to the parameter map. The parameter map is passed - to the creation and destruction - functions when a bean instance is created/destroyed.
        -
        -
        Parameters:
        -
        key - the parameter key, must not be null
        -
        value - the parameter value
        -
        Returns:
        -
        this SyntheticBeanBuilder
        -
        -
      • -
      - - - -
        -
      • -

        withParam

        -
        SyntheticBeanBuilder<T> withParam​(java.lang.String key,
        -                                  AnnotationInfo[] value)
        -
        Adds an annotation array-valued parameter to the parameter map. The parameter map is passed - to the creation and destruction - functions when a bean instance is created/destroyed. -

        - When looked up from the parameter map in the creation/destruction function, the values will be - instances of the corresponding annotation types, not AnnotationInfo.

        -
        -
        Parameters:
        -
        key - the parameter key, must not be null
        -
        value - the parameter value
        -
        Returns:
        -
        this SyntheticBeanBuilder
        -
        -
      • -
      - - - -
        -
      • -

        withParam

        -
        SyntheticBeanBuilder<T> withParam​(java.lang.String key,
        -                                  java.lang.annotation.Annotation[] value)
        -
        Adds an annotation array-valued parameter to the parameter map. The parameter map is passed - to the creation and destruction - functions when a bean instance is created/destroyed.
        -
        -
        Parameters:
        -
        key - the parameter key, must not be null
        -
        value - the parameter value
        -
        Returns:
        -
        this SyntheticBeanBuilder
        -
        -
      • -
      - - - -
        -
      • -

        withParam

        -
        SyntheticBeanBuilder<T> withParam​(java.lang.String key,
        -                                  InvokerInfo value)
        -
        Adds an invoker-valued parameter to the parameter map. The parameter map is passed - to the creation and destruction - functions when a bean instance is created/destroyed. -

        - When looked up from the parameter map in the creation/destruction function, the value will be - an instance of Invoker, not an InvokerInfo.

        -
        -
        Parameters:
        -
        key - the parameter key, must not be null
        -
        value - the parameter value
        -
        Returns:
        -
        this SyntheticBeanBuilder
        -
        Since:
        -
        4.1
        -
        -
      • -
      - - - -
        -
      • -

        withParam

        -
        SyntheticBeanBuilder<T> withParam​(java.lang.String key,
        -                                  InvokerInfo[] value)
        -
        Adds an invoker array-valued parameter to the parameter map. The parameter map is passed - to the creation and destruction - functions when a bean instance is created/destroyed. -

        - When looked up from the parameter map in the creation/destruction function, the values will be - instances of Invoker, not InvokerInfo.

        -
        -
        Parameters:
        -
        key - the parameter key, must not be null
        -
        value - the parameter value
        -
        Returns:
        -
        this SyntheticBeanBuilder
        -
        Since:
        -
        4.1
        -
        -
      • -
      - - - -
        -
      • -

        createWith

        -
        SyntheticBeanBuilder<T> createWith​(java.lang.Class<? extends SyntheticBeanCreator<T>> creatorClass)
        -
        Sets the class of the synthetic bean creation function. - CDI container will create an instance of the creation function every time when it needs - to obtain an instance of the synthetic bean. The class must be public and have - a public zero-parameter constructor; it must not be a bean. -

        - If not called, the synthetic bean registration will fail.

        -
        -
        Parameters:
        -
        creatorClass - the creation function class, must not be null
        -
        Returns:
        -
        this SyntheticBeanBuilder
        -
        Throws:
        -
        java.lang.IllegalStateException - if this method is called multiple times
        -
        -
      • -
      - - - -
        -
      • -

        disposeWith

        -
        SyntheticBeanBuilder<T> disposeWith​(java.lang.Class<? extends SyntheticBeanDisposer<T>> disposerClass)
        -
        Sets the class of the synthetic bean destruction function. - CDI container will create an instance of the destruction function every time when it needs - to destruction an instance of the synthetic bean. The class must be public and have - a public zero-parameter constructor; it must not be a bean. -

        - If not called, a noop destruction function will be used.

        -
        -
        Parameters:
        -
        disposerClass - the destruction function class, must not be null
        -
        Returns:
        -
        this SyntheticBeanBuilder
        -
        Throws:
        -
        java.lang.IllegalStateException - if this method is called multiple times
        -
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- -
- -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

-
- - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/SyntheticBeanCreator.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/SyntheticBeanCreator.html deleted file mode 100644 index 481c039646..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/SyntheticBeanCreator.html +++ /dev/null @@ -1,292 +0,0 @@ - - - - - -SyntheticBeanCreator (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Interface SyntheticBeanCreator<T>

-
-
-
-
    -
  • -
    -
    Type Parameters:
    -
    T - the bean class of the synthetic bean
    -
    -
    -
    public interface SyntheticBeanCreator<T>
    -
    Creation function for a synthetic bean defined by SyntheticBeanBuilder. - CDI container will create an instance of the creation function every time when it needs - to obtain an instance of the synthetic bean. Implementations must be public - classes with a public zero-parameter constructor; they must not be beans.
    -
    -
    Since:
    -
    4.0
    -
    -
  • -
-
-
- -
-
-
    -
  • - -
    -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        create

        -
        T create​(Instance<java.lang.Object> lookup,
        -         Parameters params)
        -
        Creates an instance of the synthetic bean. - May only return null if the synthetic bean is @Dependent. -

        - The Instance parameter may be used to simulate producer method parameter injection. - However, @Dependent bean instances obtained from the Instance during execution - remain managed until the synthetic bean instance is destroyed. Therefore, implementations - are encouraged to destroy unneeded @Dependent bean instances obtained from the Instance. -

        - If the synthetic bean is @Dependent, the InjectionPoint to which it is injected - may be looked up from the Instance parameter. -

        - The parameter map contains the same values that were passed to the SyntheticBeanBuilder - that defined the synthetic bean.

        -
        -
        Parameters:
        -
        lookup - an Instance that can be used to lookup other beans, never null
        -
        params - the parameter map, never null
        -
        Returns:
        -
        an instance of the bean, may only be null if the synthetic bean is @Dependent
        -
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- -
- -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

-
- - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/SyntheticBeanDisposer.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/SyntheticBeanDisposer.html deleted file mode 100644 index 0f0d8b169b..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/SyntheticBeanDisposer.html +++ /dev/null @@ -1,292 +0,0 @@ - - - - - -SyntheticBeanDisposer (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Interface SyntheticBeanDisposer<T>

-
-
-
-
    -
  • -
    -
    Type Parameters:
    -
    T - the bean class of the synthetic bean
    -
    -
    -
    public interface SyntheticBeanDisposer<T>
    -
    Destruction function for a synthetic bean defined by SyntheticBeanBuilder. - CDI container will create an instance of the destruction function every time when it needs - to destroy an instance of the synthetic bean. Implementations must be public - classes with a public zero-parameter constructor; they must not be beans.
    -
    -
    Since:
    -
    4.0
    -
    -
  • -
-
-
- -
-
-
    -
  • - -
    -
      -
    • - - -

      Method Detail

      - - - - - -
        -
      • -

        dispose

        -
        void dispose​(T instance,
        -             Instance<java.lang.Object> lookup,
        -             Parameters params)
        -
        Destroys an instance of the synthetic bean. -

        - The Instance parameter may be used to simulate disposer method parameter injection. - All @Dependent bean instances obtained from the Instance during execution - are destroyed when execution completes. -

        - Trying to look up InjectionPoint from the Instance parameter is invalid. -

        - The parameter map contains the same values that were passed to the SyntheticBeanBuilder - that defined the synthetic bean.

        -
        -
        Parameters:
        -
        instance - the synthetic bean instance, never null
        -
        lookup - an Instance that can be used to lookup other beans, never null
        -
        params - the parameter map, never null
        -
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- -
- -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

-
- - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/SyntheticComponents.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/SyntheticComponents.html deleted file mode 100644 index 0783a0265a..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/SyntheticComponents.html +++ /dev/null @@ -1,340 +0,0 @@ - - - - - -SyntheticComponents (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Interface SyntheticComponents

-
-
-
-
    -
  • -
    -
    public interface SyntheticComponents
    -
    Allows registering synthetic beans and observers.
    -
    -
    Since:
    -
    4.0
    -
    -
  • -
-
-
- -
-
-
    -
  • - -
    -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        addBean

        -
        <T> SyntheticBeanBuilder<T> addBean​(java.lang.Class<T> implementationClass)
        -
        Creates a SyntheticBeanBuilder that allows configuring a new synthetic bean - of given implementationClass. The synthetic bean will be registered at the end of - the @Synthesis method.
        -
        -
        Type Parameters:
        -
        T - the implementation class of the new synthetic bean
        -
        Parameters:
        -
        implementationClass - the implementation class of the new synthetic bean, must not be null
        -
        Returns:
        -
        a new SyntheticBeanBuilder, never null
        -
        -
      • -
      - - - -
        -
      • -

        addObserver

        -
        <T> SyntheticObserverBuilder<T> addObserver​(java.lang.Class<T> eventType)
        -
        Creates a SyntheticObserverBuilder that allows configuring a new synthetic observer - for given eventType. The synthetic observer will be registered at the end of - the @Synthesis method.
        -
        -
        Type Parameters:
        -
        T - the observed event type of the new synthetic observer
        -
        Parameters:
        -
        eventType - the observed event type of the new synthetic observer, must not be null
        -
        Returns:
        -
        a new SyntheticObserverBuilder, never null
        -
        -
      • -
      - - - -
        -
      • -

        addObserver

        -
        <T> SyntheticObserverBuilder<T> addObserver​(Type eventType)
        -
        Creates a SyntheticObserverBuilder that allows configuring a new synthetic observer - for given eventType. The synthetic observer will be registered at the end of - the @Synthesis method. -

        - This method is supposed to be called with explicitly provided type arguments. For example, - to define a synthetic observer of event type List<String>, one would call: -

        
        - // types is of type Types
        - // syntheticComponents is of type SyntheticComponents
        - syntheticComponents.<List<String>>addObserver(types.parameterized(List.class, String.class))
        -     ...
        - 
        -
        -
        Type Parameters:
        -
        T - the observed event type of the new synthetic observer
        -
        Parameters:
        -
        eventType - the observed event type of the new synthetic observer, must not be null
        -
        Returns:
        -
        a new SyntheticObserverBuilder, never null
        -
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- -
- -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

-
- - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/SyntheticObserver.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/SyntheticObserver.html deleted file mode 100644 index 7bbe56bec1..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/SyntheticObserver.html +++ /dev/null @@ -1,285 +0,0 @@ - - - - - -SyntheticObserver (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Interface SyntheticObserver<T>

-
-
-
-
    -
  • -
    -
    Type Parameters:
    -
    T - the observed event type of the synthetic observer
    -
    -
    -
    public interface SyntheticObserver<T>
    -
    The event notification function for a synthetic observer defined by SyntheticObserverBuilder. - CDI container will create an instance of the event notification function every time when it needs - to notify the synthetic observer. Implementations must be public classes with a public - zero-parameter constructor; they must not be beans.
    -
    -
    Since:
    -
    4.0
    -
    -
  • -
-
-
- -
-
-
    -
  • - -
    -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        observe

        -
        void observe​(EventContext<T> event,
        -             Parameters params)
        -      throws java.lang.Exception
        -
        Consumes an event. The EventContext provides access to the event payload, - as well as the EventMetadata. -

        - The parameter map contains the same values that were passed to - the SyntheticObserverBuilder that defined the synthetic observer.

        -
        -
        Parameters:
        -
        event - the event context, never null
        -
        params - the parameter map, never null
        -
        Throws:
        -
        java.lang.Exception - checked exception will be wrapped and rethrown as an ObserverException
        -
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- -
- -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

-
- - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/SyntheticObserverBuilder.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/SyntheticObserverBuilder.html deleted file mode 100644 index f1f3023a44..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/SyntheticObserverBuilder.html +++ /dev/null @@ -1,1120 +0,0 @@ - - - - - -SyntheticObserverBuilder (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Interface SyntheticObserverBuilder<T>

-
-
-
- -
-
- -
-
-
    -
  • - -
    -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        declaringClass

        -
        SyntheticObserverBuilder<T> declaringClass​(java.lang.Class<?> declaringClass)
        -
        Sets the bean class that "declares" this synthetic observer. -

        - If not called, the class declaring the extension which creates this synthetic observer is used.

        -
        -
        Parameters:
        -
        declaringClass - bean class that "declares" this synthetic observer, must not be null
        -
        Returns:
        -
        this SyntheticObserverBuilder
        -
        Throws:
        -
        java.lang.IllegalStateException - if this method is called multiple times
        -
        -
      • -
      - - - -
        -
      • -

        declaringClass

        -
        SyntheticObserverBuilder<T> declaringClass​(ClassInfo declaringClass)
        -
        Sets the bean class that "declares" this synthetic observer. -

        - If not called, the class declaring the extension which creates this synthetic observer is used.

        -
        -
        Parameters:
        -
        declaringClass - bean class that "declares" this synthetic observer, must not be null
        -
        Returns:
        -
        this SyntheticObserverBuilder
        -
        Throws:
        -
        java.lang.IllegalStateException - if this method is called multiple times
        -
        -
      • -
      - - - -
        -
      • -

        qualifier

        -
        SyntheticObserverBuilder<T> qualifier​(java.lang.Class<? extends java.lang.annotation.Annotation> annotationType)
        -
        Adds a marker annotation of given type to the set of qualifiers of this synthetic observer. - This method may be called multiple times to add multiple qualifiers. -

        - If not called, this synthetic observer will have no qualifier.

        -
        -
        Parameters:
        -
        annotationType - the type of the marker annotation, must not be null
        -
        Returns:
        -
        this SyntheticObserverBuilder
        -
        -
      • -
      - - - -
        -
      • -

        qualifier

        -
        SyntheticObserverBuilder<T> qualifier​(AnnotationInfo qualifierAnnotation)
        -
        Adds given annotation to the set of qualifiers of this synthetic observer. - This method may be called multiple times to add multiple qualifiers. -

        - If not called, this synthetic observer will have no qualifier.

        -
        -
        Parameters:
        -
        qualifierAnnotation - the annotation, must not be null
        -
        Returns:
        -
        this SyntheticObserverBuilder
        -
        -
      • -
      - - - -
        -
      • -

        qualifier

        -
        SyntheticObserverBuilder<T> qualifier​(java.lang.annotation.Annotation qualifierAnnotation)
        -
        Adds given annotation to the set of qualifiers of this synthetic observer. - This method may be called multiple times to add multiple qualifiers. -

        - If not called, this synthetic observer will have no qualifier.

        -
        -
        Parameters:
        -
        qualifierAnnotation - the annotation, must not be null
        -
        Returns:
        -
        this SyntheticObserverBuilder
        -
        -
      • -
      - - - -
        -
      • -

        priority

        -
        SyntheticObserverBuilder<T> priority​(int priority)
        -
        Sets a priority of this synthetic observer. -

        - If not called, this synthetic observer will have a default priority - of Priority.APPLICATION + 500.

        -
        -
        Parameters:
        -
        priority - the priority of this synthetic observer
        -
        Returns:
        -
        this SyntheticObserverBuilder
        -
        Throws:
        -
        java.lang.IllegalStateException - if this method is called multiple times
        -
        -
      • -
      - - - -
        -
      • -

        async

        -
        SyntheticObserverBuilder<T> async​(boolean isAsync)
        -
        Marks this synthetic observer as asynchronous if desired. -

        - If not called, this synthetic observer will not be asynchronous.

        -
        -
        Parameters:
        -
        isAsync - whether this synthetic observer should be asynchronous
        -
        Returns:
        -
        this SyntheticObserverBuilder
        -
        Throws:
        -
        java.lang.IllegalStateException - if this method is called multiple times
        -
        -
      • -
      - - - -
        -
      • -

        transactionPhase

        -
        SyntheticObserverBuilder<T> transactionPhase​(TransactionPhase transactionPhase)
        -
        Sets the TransactionPhase during which this synthetic observer should be notified. - If anything else than TransactionPhase.IN_PROGRESS is passed, this synthetic observer - will be a transactional observer. -

        - If not called, this synthetic observer will not be a transactional observer. - In other words, the default is TransactionPhase.IN_PROGRESS. -

        - Note that transactional observers cannot be asynchronous. If this synthetic observer - is configured to be both transactional and asynchronous, its registration will fail.

        -
        -
        Parameters:
        -
        transactionPhase - the TransactionPhase, must not be null
        -
        Returns:
        -
        this SyntheticObserverBuilder
        -
        Throws:
        -
        java.lang.IllegalStateException - if this method is called multiple times
        -
        -
      • -
      - - - -
        -
      • -

        withParam

        -
        SyntheticObserverBuilder<T> withParam​(java.lang.String key,
        -                                      boolean value)
        -
        Adds a boolean-valued parameter to the parameter map. The parameter map is passed - to the event notification function when the event is fired.
        -
        -
        Parameters:
        -
        key - the parameter key, must not be null
        -
        value - the parameter value
        -
        Returns:
        -
        this SyntheticObserverBuilder
        -
        -
      • -
      - - - -
        -
      • -

        withParam

        -
        SyntheticObserverBuilder<T> withParam​(java.lang.String key,
        -                                      boolean[] value)
        -
        Adds a boolean array-valued parameter to the parameter map. The parameter map is passed - to the event notification function when the event is fired.
        -
        -
        Parameters:
        -
        key - the parameter key, must not be null
        -
        value - the parameter value
        -
        Returns:
        -
        this SyntheticObserverBuilder
        -
        -
      • -
      - - - -
        -
      • -

        withParam

        -
        SyntheticObserverBuilder<T> withParam​(java.lang.String key,
        -                                      int value)
        -
        Adds an int-valued parameter to the parameter map. The parameter map is passed - to the event notification function when the event is fired.
        -
        -
        Parameters:
        -
        key - the parameter key, must not be null
        -
        value - the parameter value
        -
        Returns:
        -
        this SyntheticObserverBuilder
        -
        -
      • -
      - - - -
        -
      • -

        withParam

        -
        SyntheticObserverBuilder<T> withParam​(java.lang.String key,
        -                                      int[] value)
        -
        Adds an int array-valued parameter to the parameter map. The parameter map is passed - to the event notification function when the event is fired.
        -
        -
        Parameters:
        -
        key - the parameter key, must not be null
        -
        value - the parameter value
        -
        Returns:
        -
        this SyntheticObserverBuilder
        -
        -
      • -
      - - - -
        -
      • -

        withParam

        -
        SyntheticObserverBuilder<T> withParam​(java.lang.String key,
        -                                      long value)
        -
        Adds a long-valued parameter to the parameter map. The parameter map is passed - to the event notification function when the event is fired.
        -
        -
        Parameters:
        -
        key - the parameter key, must not be null
        -
        value - the parameter value
        -
        Returns:
        -
        this SyntheticObserverBuilder
        -
        -
      • -
      - - - -
        -
      • -

        withParam

        -
        SyntheticObserverBuilder<T> withParam​(java.lang.String key,
        -                                      long[] value)
        -
        Adds a long array-valued parameter to the parameter map. The parameter map is passed - to the event notification function when the event is fired.
        -
        -
        Parameters:
        -
        key - the parameter key, must not be null
        -
        value - the parameter value
        -
        Returns:
        -
        this SyntheticObserverBuilder
        -
        -
      • -
      - - - -
        -
      • -

        withParam

        -
        SyntheticObserverBuilder<T> withParam​(java.lang.String key,
        -                                      double value)
        -
        Adds a double-valued parameter to the parameter map. The parameter map is passed - to the event notification function when the event is fired.
        -
        -
        Parameters:
        -
        key - the parameter key, must not be null
        -
        value - the parameter value
        -
        Returns:
        -
        this SyntheticObserverBuilder
        -
        -
      • -
      - - - -
        -
      • -

        withParam

        -
        SyntheticObserverBuilder<T> withParam​(java.lang.String key,
        -                                      double[] value)
        -
        Adds a double array-valued parameter to the parameter map. The parameter map is passed - to the event notification function when the event is fired.
        -
        -
        Parameters:
        -
        key - the parameter key, must not be null
        -
        value - the parameter value
        -
        Returns:
        -
        this SyntheticObserverBuilder
        -
        -
      • -
      - - - -
        -
      • -

        withParam

        -
        SyntheticObserverBuilder<T> withParam​(java.lang.String key,
        -                                      java.lang.String value)
        -
        Adds a String-valued parameter to the parameter map. The parameter map is passed - to the event notification function when the event is fired.
        -
        -
        Parameters:
        -
        key - the parameter key, must not be null
        -
        value - the parameter value
        -
        Returns:
        -
        this SyntheticObserverBuilder
        -
        -
      • -
      - - - -
        -
      • -

        withParam

        -
        SyntheticObserverBuilder<T> withParam​(java.lang.String key,
        -                                      java.lang.String[] value)
        -
        Adds a String array-valued parameter to the parameter map. The parameter map is passed - to the event notification function when the event is fired.
        -
        -
        Parameters:
        -
        key - the parameter key, must not be null
        -
        value - the parameter value
        -
        Returns:
        -
        this SyntheticObserverBuilder
        -
        -
      • -
      - - - -
        -
      • -

        withParam

        -
        SyntheticObserverBuilder<T> withParam​(java.lang.String key,
        -                                      java.lang.Enum<?> value)
        -
        Adds an enum-valued parameter to the parameter map. The parameter map is passed - to the event notification function when the event is fired.
        -
        -
        Parameters:
        -
        key - the parameter key, must not be null
        -
        value - the parameter value
        -
        Returns:
        -
        this SyntheticObserverBuilder
        -
        -
      • -
      - - - -
        -
      • -

        withParam

        -
        SyntheticObserverBuilder<T> withParam​(java.lang.String key,
        -                                      java.lang.Enum<?>[] value)
        -
        Adds an enum array-valued parameter to the parameter map. The parameter map is passed - to the event notification function when the event is fired.
        -
        -
        Parameters:
        -
        key - the parameter key, must not be null
        -
        value - the parameter value
        -
        Returns:
        -
        this SyntheticObserverBuilder
        -
        -
      • -
      - - - -
        -
      • -

        withParam

        -
        SyntheticObserverBuilder<T> withParam​(java.lang.String key,
        -                                      java.lang.Class<?> value)
        -
        Adds a Class-valued parameter to the parameter map. The parameter map is passed - to the event notification function when the event is fired.
        -
        -
        Parameters:
        -
        key - the parameter key, must not be null
        -
        value - the parameter value
        -
        Returns:
        -
        this SyntheticObserverBuilder
        -
        -
      • -
      - - - -
        -
      • -

        withParam

        -
        SyntheticObserverBuilder<T> withParam​(java.lang.String key,
        -                                      ClassInfo value)
        -
        Adds a Class-valued parameter to the parameter map. The parameter map is passed - to the event notification function when the event is fired. -

        - When looked up from the parameter map in the event notification function, the value will be - an instance of Class, not a ClassInfo.

        -
        -
        Parameters:
        -
        key - the parameter key, must not be null
        -
        value - the parameter value
        -
        Returns:
        -
        this SyntheticObserverBuilder
        -
        -
      • -
      - - - -
        -
      • -

        withParam

        -
        SyntheticObserverBuilder<T> withParam​(java.lang.String key,
        -                                      java.lang.Class<?>[] value)
        -
        Adds a Class array-valued parameter to the parameter map. The parameter map is passed - to the event notification function when the event is fired.
        -
        -
        Parameters:
        -
        key - the parameter key, must not be null
        -
        value - the parameter value
        -
        Returns:
        -
        this SyntheticObserverBuilder
        -
        -
      • -
      - - - -
        -
      • -

        withParam

        -
        SyntheticObserverBuilder<T> withParam​(java.lang.String key,
        -                                      ClassInfo[] value)
        -
        Adds a Class array-valued parameter to the parameter map. The parameter map is passed - to the event notification function when the event is fired. -

        - When looked up from the parameter map in the event notification function, the values will be - instances of Class, not ClassInfo.

        -
        -
        Parameters:
        -
        key - the parameter key, must not be null
        -
        value - the parameter value
        -
        Returns:
        -
        this SyntheticObserverBuilder
        -
        -
      • -
      - - - -
        -
      • -

        withParam

        -
        SyntheticObserverBuilder<T> withParam​(java.lang.String key,
        -                                      AnnotationInfo value)
        -
        Adds an annotation-valued parameter to the parameter map. The parameter map is passed - to the event notification function when the event is fired. -

        - When looked up from the parameter map in the event notification function, the value will be - an instance of the annotation type, not an AnnotationInfo.

        -
        -
        Parameters:
        -
        key - the parameter key, must not be null
        -
        value - the parameter value
        -
        Returns:
        -
        this SyntheticObserverBuilder
        -
        -
      • -
      - - - -
        -
      • -

        withParam

        -
        SyntheticObserverBuilder<T> withParam​(java.lang.String key,
        -                                      java.lang.annotation.Annotation value)
        -
        Adds an annotation-valued parameter to the parameter map. The parameter map is passed - to the event notification function when the event is fired.
        -
        -
        Parameters:
        -
        key - the parameter key, must not be null
        -
        value - the parameter value
        -
        Returns:
        -
        this SyntheticObserverBuilder
        -
        -
      • -
      - - - -
        -
      • -

        withParam

        -
        SyntheticObserverBuilder<T> withParam​(java.lang.String key,
        -                                      AnnotationInfo[] value)
        -
        Adds an annotation array-valued parameter to the parameter map. The parameter map is passed - to the event notification function when the event is fired. -

        - When looked up from the parameter map in the event notification function, the values will be - instances of the corresponding annotation types, not AnnotationInfo.

        -
        -
        Parameters:
        -
        key - the parameter key, must not be null
        -
        value - the parameter value
        -
        Returns:
        -
        this SyntheticObserverBuilder
        -
        -
      • -
      - - - -
        -
      • -

        withParam

        -
        SyntheticObserverBuilder<T> withParam​(java.lang.String key,
        -                                      java.lang.annotation.Annotation[] value)
        -
        Adds an annotation array-valued parameter to the parameter map. The parameter map is passed - to the event notification function when the event is fired.
        -
        -
        Parameters:
        -
        key - the parameter key, must not be null
        -
        value - the parameter value
        -
        Returns:
        -
        this SyntheticObserverBuilder
        -
        -
      • -
      - - - -
        -
      • -

        withParam

        -
        SyntheticObserverBuilder<T> withParam​(java.lang.String key,
        -                                      InvokerInfo value)
        -
        Adds an invoker-valued parameter to the parameter map. The parameter map is passed - to the event notification function when the event is fired. -

        - When looked up from the parameter map in the event notification function, the value will be - an instance of Invoker, not an InvokerInfo.

        -
        -
        Parameters:
        -
        key - the parameter key, must not be null
        -
        value - the parameter value
        -
        Returns:
        -
        this SyntheticBeanBuilder
        -
        Since:
        -
        4.1
        -
        -
      • -
      - - - -
        -
      • -

        withParam

        -
        SyntheticObserverBuilder<T> withParam​(java.lang.String key,
        -                                      InvokerInfo[] value)
        -
        Adds an invoker array-valued parameter to the parameter map. The parameter map is passed - to the event notification function when the event is fired. -

        - When looked up from the parameter map in the event notification function, the values will be - instances of Invoker, not InvokerInfo.

        -
        -
        Parameters:
        -
        key - the parameter key, must not be null
        -
        value - the parameter value
        -
        Returns:
        -
        this SyntheticBeanBuilder
        -
        Since:
        -
        4.1
        -
        -
      • -
      - - - -
        -
      • -

        observeWith

        -
        SyntheticObserverBuilder<T> observeWith​(java.lang.Class<? extends SyntheticObserver<T>> observerClass)
        -
        Sets the class of the synthetic observer event notification function. - CDI container will create an instance of the event notification function every time when it needs - to notify the synthetic observer. The class must be public and have a public - zero-parameter constructor; it must not be a bean. -

        - If not called, the synthetic observer registration will fail.

        -
        -
        Parameters:
        -
        observerClass - the event notification function class, must not be null
        -
        Returns:
        -
        this SyntheticObserverBuilder
        -
        Throws:
        -
        java.lang.IllegalStateException - if this method is called multiple times
        -
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- -
- -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

-
- - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/Types.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/Types.html deleted file mode 100644 index bcfe391de1..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/Types.html +++ /dev/null @@ -1,568 +0,0 @@ - - - - - -Types (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Interface Types

-
-
-
-
    -
  • -
    -
    public interface Types
    -
    Factory for types. Allows creating representations of the void pseudo-type, - primitive types, class types, array types, parameterized types and wildcard types.
    -
    -
    Since:
    -
    4.0
    -
    -
  • -
-
-
- -
-
-
    -
  • - -
    -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        of

        -
        Type of​(java.lang.Class<?> clazz)
        -
        Returns a type from given class literal. - For example: -
          -
        • of(void.class): same as ofVoid()
        • -
        • of(int.class): same as ofPrimitive(PrimitiveKind.INT)
        • -
        • of(String.class): same as ofClass(... ClassInfo for String ...)
        • -
        • of(int[].class): same as ofArray(ofPrimitive(PrimitiveKind.INT), 1)
        • -
        • of(String[][].class): same as ofArray(ofClass(... ClassInfo for String ...), 2)
        • -
        -
        -
        Parameters:
        -
        clazz - the class literal, must not be null
        -
        Returns:
        -
        Type object representing the given class literal
        -
        -
      • -
      - - - -
        -
      • -

        ofVoid

        -
        VoidType ofVoid()
        -
        Returns a VoidType, representing the void pseudo-type.
        -
        -
        Returns:
        -
        the VoidType, never null
        -
        -
      • -
      - - - - - - - -
        -
      • -

        ofClass

        -
        ClassType ofClass​(java.lang.String name)
        -
        Returns a ClassType for the given binary name, as defined by The Java™ Language Specification; - in other words, the class name as returned by Class.getName(). -

        - Note that this method returns ClassType, so name may only be a name of a class. - For primitives, use ofPrimitive(PrimitiveType.PrimitiveKind). For arrays, use ofArray(Type, int).

        -
        -
        Parameters:
        -
        name - the binary name of the class, must not be null
        -
        Returns:
        -
        the ClassType or null if the class is not present in any bean archive
        -
        -
      • -
      - - - - - - - -
        -
      • -

        ofArray

        -
        ArrayType ofArray​(Type elementType,
        -                  int dimensions)
        -
        Returns an ArrayType for the given element type and number of dimensions. -

        - Note that this method accepts the element type of an array, even though ArrayType - uses a component type representation. For example, the component type of String[][] - is String[], while the element type is String.

        -
        -
        Parameters:
        -
        elementType - the element Type, must not be null
        -
        dimensions - the number of dimensions
        -
        Returns:
        -
        the ArrayType, never null
        -
        Throws:
        -
        java.lang.IllegalArgumentException - if the element type is an array type, a wildcard type, or the void pseudo-type
        -
        -
      • -
      - - - -
        -
      • -

        parameterized

        -
        ParameterizedType parameterized​(java.lang.Class<?> genericType,
        -                                java.lang.Class<?>... typeArguments)
        -
        Returns a ParameterizedType for the given generic type and type arguments. - The array of type arguments must have the same shape as the generic type's - list of type parameters.
        -
        -
        Parameters:
        -
        genericType - the type to parameterize, must not be null
        -
        typeArguments - one or more type arguments
        -
        Returns:
        -
        the parameterized type, never null
        -
        Throws:
        -
        java.lang.IllegalArgumentException - if given genericType is not generic or if the number of type arguments - does not match the number of type parameters declared by genericType
        -
        -
      • -
      - - - -
        -
      • -

        parameterized

        -
        ParameterizedType parameterized​(java.lang.Class<?> genericType,
        -                                Type... typeArguments)
        -
        Returns a ParameterizedType for the given generic type and type arguments. - The array of type arguments must have the same shape as the generic type's - list of type parameters.
        -
        -
        Parameters:
        -
        genericType - the type to parameterize, must not be null
        -
        typeArguments - one or more type arguments
        -
        Returns:
        -
        the parameterized type, never null
        -
        Throws:
        -
        java.lang.IllegalArgumentException - if given genericType is not generic or if the number of type arguments - does not match the number of type parameters declared by genericType
        -
        -
      • -
      - - - -
        -
      • -

        parameterized

        -
        ParameterizedType parameterized​(ClassType genericType,
        -                                Type... typeArguments)
        -
        Returns a ParameterizedType for the given generic type and type arguments. - The array of type arguments must have the same shape as the generic type's - list of type parameters.
        -
        -
        Parameters:
        -
        genericType - the type to parameterize, must not be null
        -
        typeArguments - one or more type arguments
        -
        Returns:
        -
        the parameterized type, never null
        -
        Throws:
        -
        java.lang.IllegalArgumentException - if given genericType is not generic or if the number of type arguments - does not match the number of type parameters declared by genericType
        -
        -
      • -
      - - - -
        -
      • -

        wildcardWithUpperBound

        -
        WildcardType wildcardWithUpperBound​(Type upperBound)
        -
        Returns a WildcardType that represents an equivalent of ? extends upperBound. - Note that if upperBound represents the java.lang.Object type, then the result - is equivalent to wildcardUnbounded().
        -
        -
        Parameters:
        -
        upperBound - upper bound type, must not be null
        -
        Returns:
        -
        a WildcardType object representing a wildcard type with given upper bound
        -
        -
      • -
      - - - -
        -
      • -

        wildcardWithLowerBound

        -
        WildcardType wildcardWithLowerBound​(Type lowerBound)
        -
        Returns a WildcardType that represents an equivalent of ? super lowerBound.
        -
        -
        Parameters:
        -
        lowerBound - lower bound type, must not be null
        -
        Returns:
        -
        a WildcardType object representing a wildcard type with given upper bound
        -
        -
      • -
      - - - -
        -
      • -

        wildcardUnbounded

        -
        WildcardType wildcardUnbounded()
        -
        Returns a WildcardType that represents an equivalent of ?.
        -
        -
        Returns:
        -
        a WildcardType object representing an unbounded wildcard type
        -
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- -
- -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

-
- - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/Validation.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/Validation.html deleted file mode 100644 index 40bcffcb9f..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/Validation.html +++ /dev/null @@ -1,206 +0,0 @@ - - - - - -Validation (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Annotation Type Validation

-
-
-
-
    -
  • -
    -
    @Target(METHOD)
    -@Retention(RUNTIME)
    -public @interface Validation
    -
    5th phase of build compatible extension execution. - Allows custom validation. -

    - Methods annotated @Validation may declare parameters of these types: -

    -
    -
    Since:
    -
    4.0
    -
    -
  • -
-
-
-
- -
- -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

-
- - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/class-use/AnnotationBuilder.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/class-use/AnnotationBuilder.html deleted file mode 100644 index fb8c4d4d8b..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/class-use/AnnotationBuilder.html +++ /dev/null @@ -1,755 +0,0 @@ - - - - - -Uses of Interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Interface
jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder

-
-
-
    -
  • - - - - - - - - - - - - -
    Packages that use AnnotationBuilder 
    PackageDescription
    jakarta.enterprise.inject.build.compatible.spi -
    The build compatible extension SPI.
    -
    -
  • -
  • -
      -
    • -
      - - -

      Uses of AnnotationBuilder in jakarta.enterprise.inject.build.compatible.spi

      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      Methods in jakarta.enterprise.inject.build.compatible.spi that return AnnotationBuilder 
      Modifier and TypeMethodDescription
      AnnotationBuilderAnnotationBuilderFactory.create​(ClassInfo annotationType) -
      Returns a new AnnotationBuilder for given annotation type.
      -
      AnnotationBuilderAnnotationBuilderFactory.create​(java.lang.Class<? extends java.lang.annotation.Annotation> annotationType) -
      Returns a new AnnotationBuilder for given annotation type.
      -
      AnnotationBuilderAnnotationBuilder.member​(java.lang.String name, - boolean value) -
      Adds a boolean-valued annotation member with given name.
      -
      AnnotationBuilderAnnotationBuilder.member​(java.lang.String name, - boolean[] values) -
      Adds a boolean array-valued annotation member with given name.
      -
      AnnotationBuilderAnnotationBuilder.member​(java.lang.String name, - byte value) -
      Adds a byte-valued annotation member with given name.
      -
      AnnotationBuilderAnnotationBuilder.member​(java.lang.String name, - byte[] values) -
      Adds a byte array-valued annotation member with given name.
      -
      AnnotationBuilderAnnotationBuilder.member​(java.lang.String name, - char value) -
      Adds a char-valued annotation member with given name.
      -
      AnnotationBuilderAnnotationBuilder.member​(java.lang.String name, - char[] values) -
      Adds a char array-valued annotation member with given name.
      -
      AnnotationBuilderAnnotationBuilder.member​(java.lang.String name, - double value) -
      Adds a double-valued annotation member with given name.
      -
      AnnotationBuilderAnnotationBuilder.member​(java.lang.String name, - double[] values) -
      Adds a double array-valued annotation member with given name.
      -
      AnnotationBuilderAnnotationBuilder.member​(java.lang.String name, - float value) -
      Adds a float-valued annotation member with given name.
      -
      AnnotationBuilderAnnotationBuilder.member​(java.lang.String name, - float[] values) -
      Adds a float array-valued annotation member with given name.
      -
      AnnotationBuilderAnnotationBuilder.member​(java.lang.String name, - int value) -
      Adds an int-valued annotation member with given name.
      -
      AnnotationBuilderAnnotationBuilder.member​(java.lang.String name, - int[] values) -
      Adds an int array-valued annotation member with given name.
      -
      AnnotationBuilderAnnotationBuilder.member​(java.lang.String name, - long value) -
      Adds a long-valued annotation member with given name.
      -
      AnnotationBuilderAnnotationBuilder.member​(java.lang.String name, - long[] values) -
      Adds a long array-valued annotation member with given name.
      -
      AnnotationBuilderAnnotationBuilder.member​(java.lang.String name, - short value) -
      Adds a short-valued annotation member with given name.
      -
      AnnotationBuilderAnnotationBuilder.member​(java.lang.String name, - short[] values) -
      Adds a short array-valued annotation member with given name.
      -
      AnnotationBuilderAnnotationBuilder.member​(java.lang.String name, - AnnotationInfo value) -
      Adds an annotation-valued annotation member with given name.
      -
      AnnotationBuilderAnnotationBuilder.member​(java.lang.String name, - AnnotationInfo[] values) -
      Adds an annotation array-valued annotation member with given name.
      -
      AnnotationBuilderAnnotationBuilder.member​(java.lang.String name, - AnnotationMember value) -
      Adds an annotation member with given name, whose value is given value.
      -
      AnnotationBuilderAnnotationBuilder.member​(java.lang.String name, - ClassInfo value) -
      Adds a class-valued annotation member with given name.
      -
      AnnotationBuilderAnnotationBuilder.member​(java.lang.String name, - ClassInfo[] values) -
      Adds a class array-valued annotation member with given name.
      -
      AnnotationBuilderAnnotationBuilder.member​(java.lang.String name, - ClassInfo enumType, - java.lang.String enumValue) -
      Adds an enum-valued annotation member with given name.
      -
      AnnotationBuilderAnnotationBuilder.member​(java.lang.String name, - ClassInfo enumType, - java.lang.String[] enumValues) -
      Adds an enum array-valued annotation member with given name.
      -
      AnnotationBuilderAnnotationBuilder.member​(java.lang.String name, - Type value) -
      Adds a class-valued annotation member with given name.
      -
      AnnotationBuilderAnnotationBuilder.member​(java.lang.String name, - Type[] values) -
      Adds a class array-valued annotation member with given name.
      -
      AnnotationBuilderAnnotationBuilder.member​(java.lang.String name, - java.lang.annotation.Annotation value) -
      Adds an annotation-valued annotation member with given name.
      -
      AnnotationBuilderAnnotationBuilder.member​(java.lang.String name, - java.lang.annotation.Annotation[] values) -
      Adds an annotation array-valued annotation member with given name.
      -
      AnnotationBuilderAnnotationBuilder.member​(java.lang.String name, - java.lang.Class<?> value) -
      Adds a class-valued annotation member with given name.
      -
      AnnotationBuilderAnnotationBuilder.member​(java.lang.String name, - java.lang.Class<?>[] values) -
      Adds a class array-valued annotation member with given name.
      -
      AnnotationBuilderAnnotationBuilder.member​(java.lang.String name, - java.lang.Class<? extends java.lang.Enum<?>> enumType, - java.lang.String enumValue) -
      Adds an enum-valued annotation member with given name.
      -
      AnnotationBuilderAnnotationBuilder.member​(java.lang.String name, - java.lang.Class<? extends java.lang.Enum<?>> enumType, - java.lang.String[] enumValues) -
      Adds an enum array-valued annotation member with given name.
      -
      AnnotationBuilderAnnotationBuilder.member​(java.lang.String name, - java.lang.Enum<?> value) -
      Adds an enum-valued annotation member with given name.
      -
      AnnotationBuilderAnnotationBuilder.member​(java.lang.String name, - java.lang.Enum<?>[] values) -
      Adds an enum array-valued annotation member with given name.
      -
      AnnotationBuilderAnnotationBuilder.member​(java.lang.String name, - java.lang.String value) -
      Adds a String-valued annotation member with given name.
      -
      AnnotationBuilderAnnotationBuilder.member​(java.lang.String name, - java.lang.String[] values) -
      Adds a String array-valued annotation member with given name.
      -
      static AnnotationBuilderAnnotationBuilder.of​(ClassInfo annotationType) -
      Returns a new AnnotationBuilder that builds an annotation of given type.
      -
      static AnnotationBuilderAnnotationBuilder.of​(java.lang.Class<? extends java.lang.annotation.Annotation> annotationType) -
      Returns a new AnnotationBuilder that builds an annotation of given type.
      -
      default AnnotationBuilderAnnotationBuilder.value​(boolean value) -
      Adds a boolean-valued annotation member called value.
      -
      default AnnotationBuilderAnnotationBuilder.value​(boolean[] values) -
      Adds a boolean array-valued annotation member called value.
      -
      default AnnotationBuilderAnnotationBuilder.value​(byte value) -
      Adds a byte-valued annotation member called value.
      -
      default AnnotationBuilderAnnotationBuilder.value​(byte[] values) -
      Adds a byte array-valued annotation member called value.
      -
      default AnnotationBuilderAnnotationBuilder.value​(char value) -
      Adds a char-valued annotation member called value.
      -
      default AnnotationBuilderAnnotationBuilder.value​(char[] values) -
      Adds a char array-valued annotation member called value.
      -
      default AnnotationBuilderAnnotationBuilder.value​(double value) -
      Adds a double-valued annotation member called value.
      -
      default AnnotationBuilderAnnotationBuilder.value​(double[] values) -
      Adds a double array-valued annotation member called value.
      -
      default AnnotationBuilderAnnotationBuilder.value​(float value) -
      Adds a float-valued annotation member called value.
      -
      default AnnotationBuilderAnnotationBuilder.value​(float[] values) -
      Adds a float array-valued annotation member called value.
      -
      default AnnotationBuilderAnnotationBuilder.value​(int value) -
      Adds an int-valued annotation member called value.
      -
      default AnnotationBuilderAnnotationBuilder.value​(int[] values) -
      Adds an int array-valued annotation member called value.
      -
      default AnnotationBuilderAnnotationBuilder.value​(long value) -
      Adds a long-valued annotation member called value.
      -
      default AnnotationBuilderAnnotationBuilder.value​(long[] values) -
      Adds a long array-valued annotation member called value.
      -
      default AnnotationBuilderAnnotationBuilder.value​(short value) -
      Adds a short-valued annotation member called value.
      -
      default AnnotationBuilderAnnotationBuilder.value​(short[] values) -
      Adds a short array-valued annotation member called value.
      -
      default AnnotationBuilderAnnotationBuilder.value​(AnnotationInfo value) -
      Adds an annotation-valued annotation member called value.
      -
      default AnnotationBuilderAnnotationBuilder.value​(AnnotationInfo[] values) -
      Adds an annotation array-valued annotation member called value.
      -
      default AnnotationBuilderAnnotationBuilder.value​(AnnotationMember value) -
      Adds an annotation member called value, whose value is given value.
      -
      default AnnotationBuilderAnnotationBuilder.value​(ClassInfo value) -
      Adds a class-valued annotation member called value.
      -
      default AnnotationBuilderAnnotationBuilder.value​(ClassInfo[] values) -
      Adds a class array-valued annotation member called value.
      -
      default AnnotationBuilderAnnotationBuilder.value​(ClassInfo enumType, - java.lang.String enumValue) -
      Adds an enum-valued annotation member called value.
      -
      default AnnotationBuilderAnnotationBuilder.value​(ClassInfo enumType, - java.lang.String[] enumValues) -
      Adds an enum array-valued annotation member called value.
      -
      default AnnotationBuilderAnnotationBuilder.value​(Type value) -
      Adds a class-valued annotation member called value.
      -
      default AnnotationBuilderAnnotationBuilder.value​(Type[] values) -
      Adds a class array-valued annotation member called value.
      -
      default AnnotationBuilderAnnotationBuilder.value​(java.lang.annotation.Annotation value) -
      Adds an annotation-valued annotation member called value.
      -
      default AnnotationBuilderAnnotationBuilder.value​(java.lang.annotation.Annotation[] values) -
      Adds an annotation array-valued annotation member called value.
      -
      default AnnotationBuilderAnnotationBuilder.value​(java.lang.Class<?> value) -
      Adds a class-valued annotation member called value.
      -
      default AnnotationBuilderAnnotationBuilder.value​(java.lang.Class<?>[] values) -
      Adds a class array-valued annotation member called value.
      -
      default AnnotationBuilderAnnotationBuilder.value​(java.lang.Class<? extends java.lang.Enum<?>> enumType, - java.lang.String enumValue) -
      Adds an enum-valued annotation member called value.
      -
      default AnnotationBuilderAnnotationBuilder.value​(java.lang.Class<? extends java.lang.Enum<?>> enumType, - java.lang.String[] enumValues) -
      Adds an enum array-valued annotation member called value.
      -
      default AnnotationBuilderAnnotationBuilder.value​(java.lang.Enum<?> value) -
      Adds an enum-valued annotation member called value.
      -
      default AnnotationBuilderAnnotationBuilder.value​(java.lang.Enum<?>[] values) -
      Adds an enum array-valued annotation member called value.
      -
      default AnnotationBuilderAnnotationBuilder.value​(java.lang.String value) -
      Adds a String-valued annotation member called value.
      -
      default AnnotationBuilderAnnotationBuilder.value​(java.lang.String[] values) -
      Adds a String array-valued annotation member called value.
      -
      -
      -
    • -
    -
  • -
-
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/class-use/AnnotationBuilderFactory.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/class-use/AnnotationBuilderFactory.html deleted file mode 100644 index a8674455ff..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/class-use/AnnotationBuilderFactory.html +++ /dev/null @@ -1,199 +0,0 @@ - - - - - -Uses of Interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilderFactory (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Interface
jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilderFactory

-
-
- -
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/class-use/BeanInfo.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/class-use/BeanInfo.html deleted file mode 100644 index 7058ce171c..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/class-use/BeanInfo.html +++ /dev/null @@ -1,252 +0,0 @@ - - - - - -Uses of Interface jakarta.enterprise.inject.build.compatible.spi.BeanInfo (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Interface
jakarta.enterprise.inject.build.compatible.spi.BeanInfo

-
-
- -
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/class-use/BuildCompatibleExtension.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/class-use/BuildCompatibleExtension.html deleted file mode 100644 index 3f2992886d..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/class-use/BuildCompatibleExtension.html +++ /dev/null @@ -1,153 +0,0 @@ - - - - - -Uses of Interface jakarta.enterprise.inject.build.compatible.spi.BuildCompatibleExtension (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Interface
jakarta.enterprise.inject.build.compatible.spi.BuildCompatibleExtension

-
-
No usage of jakarta.enterprise.inject.build.compatible.spi.BuildCompatibleExtension
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/class-use/BuildServices.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/class-use/BuildServices.html deleted file mode 100644 index a86908585d..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/class-use/BuildServices.html +++ /dev/null @@ -1,201 +0,0 @@ - - - - - -Uses of Interface jakarta.enterprise.inject.build.compatible.spi.BuildServices (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Interface
jakarta.enterprise.inject.build.compatible.spi.BuildServices

-
-
- -
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/class-use/BuildServicesResolver.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/class-use/BuildServicesResolver.html deleted file mode 100644 index 15b8cb75be..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/class-use/BuildServicesResolver.html +++ /dev/null @@ -1,153 +0,0 @@ - - - - - -Uses of Class jakarta.enterprise.inject.build.compatible.spi.BuildServicesResolver (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Class
jakarta.enterprise.inject.build.compatible.spi.BuildServicesResolver

-
-
No usage of jakarta.enterprise.inject.build.compatible.spi.BuildServicesResolver
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/class-use/ClassConfig.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/class-use/ClassConfig.html deleted file mode 100644 index 5b51772ea8..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/class-use/ClassConfig.html +++ /dev/null @@ -1,250 +0,0 @@ - - - - - -Uses of Interface jakarta.enterprise.inject.build.compatible.spi.ClassConfig (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Interface
jakarta.enterprise.inject.build.compatible.spi.ClassConfig

-
-
- -
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/class-use/DeclarationConfig.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/class-use/DeclarationConfig.html deleted file mode 100644 index 4e794c7fae..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/class-use/DeclarationConfig.html +++ /dev/null @@ -1,267 +0,0 @@ - - - - - -Uses of Interface jakarta.enterprise.inject.build.compatible.spi.DeclarationConfig (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Interface
jakarta.enterprise.inject.build.compatible.spi.DeclarationConfig

-
-
- -
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/class-use/Discovery.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/class-use/Discovery.html deleted file mode 100644 index d3e4401a0b..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/class-use/Discovery.html +++ /dev/null @@ -1,153 +0,0 @@ - - - - - -Uses of Class jakarta.enterprise.inject.build.compatible.spi.Discovery (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Class
jakarta.enterprise.inject.build.compatible.spi.Discovery

-
-
No usage of jakarta.enterprise.inject.build.compatible.spi.Discovery
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/class-use/DisposerInfo.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/class-use/DisposerInfo.html deleted file mode 100644 index 7ff0c94f4e..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/class-use/DisposerInfo.html +++ /dev/null @@ -1,201 +0,0 @@ - - - - - -Uses of Interface jakarta.enterprise.inject.build.compatible.spi.DisposerInfo (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Interface
jakarta.enterprise.inject.build.compatible.spi.DisposerInfo

-
-
- -
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/class-use/Enhancement.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/class-use/Enhancement.html deleted file mode 100644 index c49954a13f..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/class-use/Enhancement.html +++ /dev/null @@ -1,153 +0,0 @@ - - - - - -Uses of Class jakarta.enterprise.inject.build.compatible.spi.Enhancement (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Class
jakarta.enterprise.inject.build.compatible.spi.Enhancement

-
-
No usage of jakarta.enterprise.inject.build.compatible.spi.Enhancement
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/class-use/FieldConfig.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/class-use/FieldConfig.html deleted file mode 100644 index 3ca507073e..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/class-use/FieldConfig.html +++ /dev/null @@ -1,247 +0,0 @@ - - - - - -Uses of Interface jakarta.enterprise.inject.build.compatible.spi.FieldConfig (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Interface
jakarta.enterprise.inject.build.compatible.spi.FieldConfig

-
-
- -
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/class-use/InjectionPointInfo.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/class-use/InjectionPointInfo.html deleted file mode 100644 index 296a31fa28..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/class-use/InjectionPointInfo.html +++ /dev/null @@ -1,201 +0,0 @@ - - - - - -Uses of Interface jakarta.enterprise.inject.build.compatible.spi.InjectionPointInfo (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Interface
jakarta.enterprise.inject.build.compatible.spi.InjectionPointInfo

-
-
- -
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/class-use/InterceptorInfo.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/class-use/InterceptorInfo.html deleted file mode 100644 index 6a521bd670..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/class-use/InterceptorInfo.html +++ /dev/null @@ -1,206 +0,0 @@ - - - - - -Uses of Interface jakarta.enterprise.inject.build.compatible.spi.InterceptorInfo (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Interface
jakarta.enterprise.inject.build.compatible.spi.InterceptorInfo

-
-
- -
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/class-use/InvokerInfo.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/class-use/InvokerInfo.html deleted file mode 100644 index 4c9f2365e4..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/class-use/InvokerInfo.html +++ /dev/null @@ -1,243 +0,0 @@ - - - - - -Uses of Interface jakarta.enterprise.inject.build.compatible.spi.InvokerInfo (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Interface
jakarta.enterprise.inject.build.compatible.spi.InvokerInfo

-
-
- -
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/class-use/Messages.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/class-use/Messages.html deleted file mode 100644 index 41f0a48a73..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/class-use/Messages.html +++ /dev/null @@ -1,153 +0,0 @@ - - - - - -Uses of Interface jakarta.enterprise.inject.build.compatible.spi.Messages (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Interface
jakarta.enterprise.inject.build.compatible.spi.Messages

-
-
No usage of jakarta.enterprise.inject.build.compatible.spi.Messages
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/class-use/MetaAnnotations.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/class-use/MetaAnnotations.html deleted file mode 100644 index de034cd4cb..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/class-use/MetaAnnotations.html +++ /dev/null @@ -1,153 +0,0 @@ - - - - - -Uses of Interface jakarta.enterprise.inject.build.compatible.spi.MetaAnnotations (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Interface
jakarta.enterprise.inject.build.compatible.spi.MetaAnnotations

-
-
No usage of jakarta.enterprise.inject.build.compatible.spi.MetaAnnotations
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/class-use/MethodConfig.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/class-use/MethodConfig.html deleted file mode 100644 index 7f4cc6c4e2..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/class-use/MethodConfig.html +++ /dev/null @@ -1,255 +0,0 @@ - - - - - -Uses of Interface jakarta.enterprise.inject.build.compatible.spi.MethodConfig (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Interface
jakarta.enterprise.inject.build.compatible.spi.MethodConfig

-
-
- -
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/class-use/ObserverInfo.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/class-use/ObserverInfo.html deleted file mode 100644 index ec77d2924c..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/class-use/ObserverInfo.html +++ /dev/null @@ -1,218 +0,0 @@ - - - - - -Uses of Interface jakarta.enterprise.inject.build.compatible.spi.ObserverInfo (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Interface
jakarta.enterprise.inject.build.compatible.spi.ObserverInfo

-
-
- -
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/class-use/ParameterConfig.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/class-use/ParameterConfig.html deleted file mode 100644 index 258252f0b7..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/class-use/ParameterConfig.html +++ /dev/null @@ -1,246 +0,0 @@ - - - - - -Uses of Interface jakarta.enterprise.inject.build.compatible.spi.ParameterConfig (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Interface
jakarta.enterprise.inject.build.compatible.spi.ParameterConfig

-
-
- -
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/class-use/Parameters.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/class-use/Parameters.html deleted file mode 100644 index 1584bbfafc..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/class-use/Parameters.html +++ /dev/null @@ -1,219 +0,0 @@ - - - - - -Uses of Interface jakarta.enterprise.inject.build.compatible.spi.Parameters (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Interface
jakarta.enterprise.inject.build.compatible.spi.Parameters

-
-
- -
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/class-use/Registration.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/class-use/Registration.html deleted file mode 100644 index b809db50fc..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/class-use/Registration.html +++ /dev/null @@ -1,153 +0,0 @@ - - - - - -Uses of Class jakarta.enterprise.inject.build.compatible.spi.Registration (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Class
jakarta.enterprise.inject.build.compatible.spi.Registration

-
-
No usage of jakarta.enterprise.inject.build.compatible.spi.Registration
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/class-use/ScannedClasses.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/class-use/ScannedClasses.html deleted file mode 100644 index 327a43b211..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/class-use/ScannedClasses.html +++ /dev/null @@ -1,153 +0,0 @@ - - - - - -Uses of Interface jakarta.enterprise.inject.build.compatible.spi.ScannedClasses (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Interface
jakarta.enterprise.inject.build.compatible.spi.ScannedClasses

-
-
No usage of jakarta.enterprise.inject.build.compatible.spi.ScannedClasses
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/class-use/ScopeInfo.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/class-use/ScopeInfo.html deleted file mode 100644 index 81d3720190..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/class-use/ScopeInfo.html +++ /dev/null @@ -1,208 +0,0 @@ - - - - - -Uses of Interface jakarta.enterprise.inject.build.compatible.spi.ScopeInfo (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Interface
jakarta.enterprise.inject.build.compatible.spi.ScopeInfo

-
-
- -
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/class-use/SkipIfPortableExtensionPresent.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/class-use/SkipIfPortableExtensionPresent.html deleted file mode 100644 index 434d7c5dba..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/class-use/SkipIfPortableExtensionPresent.html +++ /dev/null @@ -1,153 +0,0 @@ - - - - - -Uses of Class jakarta.enterprise.inject.build.compatible.spi.SkipIfPortableExtensionPresent (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Class
jakarta.enterprise.inject.build.compatible.spi.SkipIfPortableExtensionPresent

-
-
No usage of jakarta.enterprise.inject.build.compatible.spi.SkipIfPortableExtensionPresent
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/class-use/StereotypeInfo.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/class-use/StereotypeInfo.html deleted file mode 100644 index 4fa9f99650..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/class-use/StereotypeInfo.html +++ /dev/null @@ -1,201 +0,0 @@ - - - - - -Uses of Interface jakarta.enterprise.inject.build.compatible.spi.StereotypeInfo (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Interface
jakarta.enterprise.inject.build.compatible.spi.StereotypeInfo

-
-
- -
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/class-use/Synthesis.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/class-use/Synthesis.html deleted file mode 100644 index d0beb11811..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/class-use/Synthesis.html +++ /dev/null @@ -1,153 +0,0 @@ - - - - - -Uses of Class jakarta.enterprise.inject.build.compatible.spi.Synthesis (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Class
jakarta.enterprise.inject.build.compatible.spi.Synthesis

-
-
No usage of jakarta.enterprise.inject.build.compatible.spi.Synthesis
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/class-use/SyntheticBeanBuilder.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/class-use/SyntheticBeanBuilder.html deleted file mode 100644 index 3514fe1f1a..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/class-use/SyntheticBeanBuilder.html +++ /dev/null @@ -1,476 +0,0 @@ - - - - - -Uses of Interface jakarta.enterprise.inject.build.compatible.spi.SyntheticBeanBuilder (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Interface
jakarta.enterprise.inject.build.compatible.spi.SyntheticBeanBuilder

-
-
- -
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/class-use/SyntheticBeanCreator.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/class-use/SyntheticBeanCreator.html deleted file mode 100644 index e4ff1c5943..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/class-use/SyntheticBeanCreator.html +++ /dev/null @@ -1,201 +0,0 @@ - - - - - -Uses of Interface jakarta.enterprise.inject.build.compatible.spi.SyntheticBeanCreator (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Interface
jakarta.enterprise.inject.build.compatible.spi.SyntheticBeanCreator

-
-
- -
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/class-use/SyntheticBeanDisposer.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/class-use/SyntheticBeanDisposer.html deleted file mode 100644 index 381527c51e..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/class-use/SyntheticBeanDisposer.html +++ /dev/null @@ -1,201 +0,0 @@ - - - - - -Uses of Interface jakarta.enterprise.inject.build.compatible.spi.SyntheticBeanDisposer (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Interface
jakarta.enterprise.inject.build.compatible.spi.SyntheticBeanDisposer

-
-
- -
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/class-use/SyntheticComponents.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/class-use/SyntheticComponents.html deleted file mode 100644 index 683a835c73..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/class-use/SyntheticComponents.html +++ /dev/null @@ -1,153 +0,0 @@ - - - - - -Uses of Interface jakarta.enterprise.inject.build.compatible.spi.SyntheticComponents (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Interface
jakarta.enterprise.inject.build.compatible.spi.SyntheticComponents

-
-
No usage of jakarta.enterprise.inject.build.compatible.spi.SyntheticComponents
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/class-use/SyntheticObserver.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/class-use/SyntheticObserver.html deleted file mode 100644 index 4aebe1dd52..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/class-use/SyntheticObserver.html +++ /dev/null @@ -1,201 +0,0 @@ - - - - - -Uses of Interface jakarta.enterprise.inject.build.compatible.spi.SyntheticObserver (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Interface
jakarta.enterprise.inject.build.compatible.spi.SyntheticObserver

-
-
- -
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/class-use/SyntheticObserverBuilder.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/class-use/SyntheticObserverBuilder.html deleted file mode 100644 index e0082775c9..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/class-use/SyntheticObserverBuilder.html +++ /dev/null @@ -1,449 +0,0 @@ - - - - - -Uses of Interface jakarta.enterprise.inject.build.compatible.spi.SyntheticObserverBuilder (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Interface
jakarta.enterprise.inject.build.compatible.spi.SyntheticObserverBuilder

-
-
- -
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/class-use/Types.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/class-use/Types.html deleted file mode 100644 index a58c7ad822..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/class-use/Types.html +++ /dev/null @@ -1,153 +0,0 @@ - - - - - -Uses of Interface jakarta.enterprise.inject.build.compatible.spi.Types (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Interface
jakarta.enterprise.inject.build.compatible.spi.Types

-
-
No usage of jakarta.enterprise.inject.build.compatible.spi.Types
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/class-use/Validation.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/class-use/Validation.html deleted file mode 100644 index 3d964bf5fe..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/class-use/Validation.html +++ /dev/null @@ -1,153 +0,0 @@ - - - - - -Uses of Class jakarta.enterprise.inject.build.compatible.spi.Validation (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Class
jakarta.enterprise.inject.build.compatible.spi.Validation

-
-
No usage of jakarta.enterprise.inject.build.compatible.spi.Validation
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/package-summary.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/package-summary.html deleted file mode 100644 index 59809d3f9c..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/package-summary.html +++ /dev/null @@ -1,436 +0,0 @@ - - - - - -jakarta.enterprise.inject.build.compatible.spi (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-
Module jakarta.cdi
-

Package jakarta.enterprise.inject.build.compatible.spi

-
-
-
- - -

The build compatible extension SPI. See:

- -
-
- -
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/package-tree.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/package-tree.html deleted file mode 100644 index 877a1ec045..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/package-tree.html +++ /dev/null @@ -1,222 +0,0 @@ - - - - - -jakarta.enterprise.inject.build.compatible.spi Class Hierarchy (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Hierarchy For Package jakarta.enterprise.inject.build.compatible.spi

-Package Hierarchies: - -
-
-
-

Class Hierarchy

- -
-
-

Interface Hierarchy

- -
-
-

Annotation Type Hierarchy

-
    -
  • jakarta.enterprise.inject.build.compatible.spi.Discovery (implements java.lang.annotation.Annotation)
  • -
  • jakarta.enterprise.inject.build.compatible.spi.Enhancement (implements java.lang.annotation.Annotation)
  • -
  • jakarta.enterprise.inject.build.compatible.spi.Registration (implements java.lang.annotation.Annotation)
  • -
  • jakarta.enterprise.inject.build.compatible.spi.SkipIfPortableExtensionPresent (implements java.lang.annotation.Annotation)
  • -
  • jakarta.enterprise.inject.build.compatible.spi.Synthesis (implements java.lang.annotation.Annotation)
  • -
  • jakarta.enterprise.inject.build.compatible.spi.Validation (implements java.lang.annotation.Annotation)
  • -
-
-
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/package-use.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/package-use.html deleted file mode 100644 index e6026b40fc..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/package-use.html +++ /dev/null @@ -1,335 +0,0 @@ - - - - - -Uses of Package jakarta.enterprise.inject.build.compatible.spi (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Package
jakarta.enterprise.inject.build.compatible.spi

-
-
- -
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/class-use/Alternative.Literal.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/class-use/Alternative.Literal.html deleted file mode 100644 index ea31b0ba48..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/class-use/Alternative.Literal.html +++ /dev/null @@ -1,197 +0,0 @@ - - - - - -Uses of Class jakarta.enterprise.inject.Alternative.Literal (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Class
jakarta.enterprise.inject.Alternative.Literal

-
-
- -
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/class-use/Alternative.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/class-use/Alternative.html deleted file mode 100644 index ee55f81dfd..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/class-use/Alternative.html +++ /dev/null @@ -1,153 +0,0 @@ - - - - - -Uses of Class jakarta.enterprise.inject.Alternative (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Class
jakarta.enterprise.inject.Alternative

-
-
No usage of jakarta.enterprise.inject.Alternative
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/class-use/AmbiguousResolutionException.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/class-use/AmbiguousResolutionException.html deleted file mode 100644 index d9396a73d2..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/class-use/AmbiguousResolutionException.html +++ /dev/null @@ -1,153 +0,0 @@ - - - - - -Uses of Class jakarta.enterprise.inject.AmbiguousResolutionException (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Class
jakarta.enterprise.inject.AmbiguousResolutionException

-
-
No usage of jakarta.enterprise.inject.AmbiguousResolutionException
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/class-use/Any.Literal.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/class-use/Any.Literal.html deleted file mode 100644 index 8f4625b261..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/class-use/Any.Literal.html +++ /dev/null @@ -1,197 +0,0 @@ - - - - - -Uses of Class jakarta.enterprise.inject.Any.Literal (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Class
jakarta.enterprise.inject.Any.Literal

-
-
- -
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/class-use/Any.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/class-use/Any.html deleted file mode 100644 index 7aa6a52620..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/class-use/Any.html +++ /dev/null @@ -1,153 +0,0 @@ - - - - - -Uses of Class jakarta.enterprise.inject.Any (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Class
jakarta.enterprise.inject.Any

-
-
No usage of jakarta.enterprise.inject.Any
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/class-use/CreationException.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/class-use/CreationException.html deleted file mode 100644 index 6a5c10295d..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/class-use/CreationException.html +++ /dev/null @@ -1,153 +0,0 @@ - - - - - -Uses of Class jakarta.enterprise.inject.CreationException (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Class
jakarta.enterprise.inject.CreationException

-
-
No usage of jakarta.enterprise.inject.CreationException
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/class-use/Decorated.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/class-use/Decorated.html deleted file mode 100644 index f3bd193d75..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/class-use/Decorated.html +++ /dev/null @@ -1,153 +0,0 @@ - - - - - -Uses of Class jakarta.enterprise.inject.Decorated (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Class
jakarta.enterprise.inject.Decorated

-
-
No usage of jakarta.enterprise.inject.Decorated
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/class-use/Default.Literal.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/class-use/Default.Literal.html deleted file mode 100644 index eab410b686..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/class-use/Default.Literal.html +++ /dev/null @@ -1,197 +0,0 @@ - - - - - -Uses of Class jakarta.enterprise.inject.Default.Literal (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Class
jakarta.enterprise.inject.Default.Literal

-
-
- -
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/class-use/Default.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/class-use/Default.html deleted file mode 100644 index 74d760166b..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/class-use/Default.html +++ /dev/null @@ -1,153 +0,0 @@ - - - - - -Uses of Class jakarta.enterprise.inject.Default (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Class
jakarta.enterprise.inject.Default

-
-
No usage of jakarta.enterprise.inject.Default
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/class-use/Disposes.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/class-use/Disposes.html deleted file mode 100644 index 6f9492192e..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/class-use/Disposes.html +++ /dev/null @@ -1,153 +0,0 @@ - - - - - -Uses of Class jakarta.enterprise.inject.Disposes (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Class
jakarta.enterprise.inject.Disposes

-
-
No usage of jakarta.enterprise.inject.Disposes
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/class-use/IllegalProductException.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/class-use/IllegalProductException.html deleted file mode 100644 index 86ee1b174c..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/class-use/IllegalProductException.html +++ /dev/null @@ -1,153 +0,0 @@ - - - - - -Uses of Class jakarta.enterprise.inject.IllegalProductException (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Class
jakarta.enterprise.inject.IllegalProductException

-
-
No usage of jakarta.enterprise.inject.IllegalProductException
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/class-use/InjectionException.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/class-use/InjectionException.html deleted file mode 100644 index 546a101b36..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/class-use/InjectionException.html +++ /dev/null @@ -1,243 +0,0 @@ - - - - - -Uses of Class jakarta.enterprise.inject.InjectionException (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Class
jakarta.enterprise.inject.InjectionException

-
-
- -
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/class-use/Instance.Handle.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/class-use/Instance.Handle.html deleted file mode 100644 index 46160b7fd5..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/class-use/Instance.Handle.html +++ /dev/null @@ -1,225 +0,0 @@ - - - - - -Uses of Interface jakarta.enterprise.inject.Instance.Handle (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Interface
jakarta.enterprise.inject.Instance.Handle

-
-
- -
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/class-use/Instance.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/class-use/Instance.html deleted file mode 100644 index fff02c23ab..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/class-use/Instance.html +++ /dev/null @@ -1,368 +0,0 @@ - - - - - -Uses of Interface jakarta.enterprise.inject.Instance (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Interface
jakarta.enterprise.inject.Instance

-
-
- -
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/class-use/Intercepted.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/class-use/Intercepted.html deleted file mode 100644 index ef20483111..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/class-use/Intercepted.html +++ /dev/null @@ -1,153 +0,0 @@ - - - - - -Uses of Class jakarta.enterprise.inject.Intercepted (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Class
jakarta.enterprise.inject.Intercepted

-
-
No usage of jakarta.enterprise.inject.Intercepted
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/class-use/Model.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/class-use/Model.html deleted file mode 100644 index 68a29dbfdb..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/class-use/Model.html +++ /dev/null @@ -1,153 +0,0 @@ - - - - - -Uses of Class jakarta.enterprise.inject.Model (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Class
jakarta.enterprise.inject.Model

-
-
No usage of jakarta.enterprise.inject.Model
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/class-use/Produces.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/class-use/Produces.html deleted file mode 100644 index 340786ac29..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/class-use/Produces.html +++ /dev/null @@ -1,153 +0,0 @@ - - - - - -Uses of Class jakarta.enterprise.inject.Produces (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Class
jakarta.enterprise.inject.Produces

-
-
No usage of jakarta.enterprise.inject.Produces
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/class-use/ResolutionException.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/class-use/ResolutionException.html deleted file mode 100644 index 7c5f62ab19..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/class-use/ResolutionException.html +++ /dev/null @@ -1,219 +0,0 @@ - - - - - -Uses of Class jakarta.enterprise.inject.ResolutionException (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Class
jakarta.enterprise.inject.ResolutionException

-
-
- -
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/class-use/Specializes.Literal.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/class-use/Specializes.Literal.html deleted file mode 100644 index bb74bc165c..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/class-use/Specializes.Literal.html +++ /dev/null @@ -1,197 +0,0 @@ - - - - - -Uses of Class jakarta.enterprise.inject.Specializes.Literal (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Class
jakarta.enterprise.inject.Specializes.Literal

-
-
- -
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/class-use/Specializes.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/class-use/Specializes.html deleted file mode 100644 index af3d53f2d0..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/class-use/Specializes.html +++ /dev/null @@ -1,153 +0,0 @@ - - - - - -Uses of Class jakarta.enterprise.inject.Specializes (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Class
jakarta.enterprise.inject.Specializes

-
-
No usage of jakarta.enterprise.inject.Specializes
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/class-use/Stereotype.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/class-use/Stereotype.html deleted file mode 100644 index 32cf0ee171..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/class-use/Stereotype.html +++ /dev/null @@ -1,232 +0,0 @@ - - - - - -Uses of Class jakarta.enterprise.inject.Stereotype (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Class
jakarta.enterprise.inject.Stereotype

-
-
- -
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/class-use/TransientReference.Literal.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/class-use/TransientReference.Literal.html deleted file mode 100644 index c59cf71cdd..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/class-use/TransientReference.Literal.html +++ /dev/null @@ -1,197 +0,0 @@ - - - - - -Uses of Class jakarta.enterprise.inject.TransientReference.Literal (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Class
jakarta.enterprise.inject.TransientReference.Literal

-
-
- -
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/class-use/TransientReference.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/class-use/TransientReference.html deleted file mode 100644 index 6b9cf6b3c3..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/class-use/TransientReference.html +++ /dev/null @@ -1,153 +0,0 @@ - - - - - -Uses of Class jakarta.enterprise.inject.TransientReference (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Class
jakarta.enterprise.inject.TransientReference

-
-
No usage of jakarta.enterprise.inject.TransientReference
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/class-use/Typed.Literal.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/class-use/Typed.Literal.html deleted file mode 100644 index 67e9659ea7..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/class-use/Typed.Literal.html +++ /dev/null @@ -1,212 +0,0 @@ - - - - - -Uses of Class jakarta.enterprise.inject.Typed.Literal (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Class
jakarta.enterprise.inject.Typed.Literal

-
-
- -
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/class-use/Typed.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/class-use/Typed.html deleted file mode 100644 index 7460f2e7e0..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/class-use/Typed.html +++ /dev/null @@ -1,153 +0,0 @@ - - - - - -Uses of Class jakarta.enterprise.inject.Typed (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Class
jakarta.enterprise.inject.Typed

-
-
No usage of jakarta.enterprise.inject.Typed
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/class-use/UnproxyableResolutionException.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/class-use/UnproxyableResolutionException.html deleted file mode 100644 index e73c5cc5f2..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/class-use/UnproxyableResolutionException.html +++ /dev/null @@ -1,153 +0,0 @@ - - - - - -Uses of Class jakarta.enterprise.inject.UnproxyableResolutionException (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Class
jakarta.enterprise.inject.UnproxyableResolutionException

-
-
No usage of jakarta.enterprise.inject.UnproxyableResolutionException
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/class-use/UnsatisfiedResolutionException.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/class-use/UnsatisfiedResolutionException.html deleted file mode 100644 index df0a29a411..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/class-use/UnsatisfiedResolutionException.html +++ /dev/null @@ -1,153 +0,0 @@ - - - - - -Uses of Class jakarta.enterprise.inject.UnsatisfiedResolutionException (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Class
jakarta.enterprise.inject.UnsatisfiedResolutionException

-
-
No usage of jakarta.enterprise.inject.UnsatisfiedResolutionException
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/class-use/Vetoed.Literal.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/class-use/Vetoed.Literal.html deleted file mode 100644 index a3edfbb487..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/class-use/Vetoed.Literal.html +++ /dev/null @@ -1,197 +0,0 @@ - - - - - -Uses of Class jakarta.enterprise.inject.Vetoed.Literal (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Class
jakarta.enterprise.inject.Vetoed.Literal

-
-
- -
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/class-use/Vetoed.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/class-use/Vetoed.html deleted file mode 100644 index fa78af307a..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/class-use/Vetoed.html +++ /dev/null @@ -1,153 +0,0 @@ - - - - - -Uses of Class jakarta.enterprise.inject.Vetoed (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Class
jakarta.enterprise.inject.Vetoed

-
-
No usage of jakarta.enterprise.inject.Vetoed
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/literal/InjectLiteral.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/literal/InjectLiteral.html deleted file mode 100644 index 8b9b16d759..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/literal/InjectLiteral.html +++ /dev/null @@ -1,349 +0,0 @@ - - - - - -InjectLiteral (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Class InjectLiteral

-
-
- -
-
    -
  • -
    -
    All Implemented Interfaces:
    -
    java.lang.annotation.Annotation
    -
    -
    -
    public final class InjectLiteral
    -extends AnnotationLiteral<jakarta.inject.Inject>
    -implements jakarta.inject.Inject
    -
    Supports inline instantiation of the Inject annotation.
    -
    -
    Since:
    -
    2.0
    -
    Author:
    -
    Martin Kouba
    -
    See Also:
    -
    Serialized Form
    -
    -
  • -
-
-
-
    -
  • - -
    - -
    - -
    -
      -
    • - - -

      Constructor Summary

      - - - - - - - - - - -
      Constructors 
      ConstructorDescription
      InjectLiteral() 
      -
    • -
    -
    - -
    -
      -
    • - - -

      Method Summary

      - -
        -
      • - - -

        Methods inherited from class java.lang.Object

        -clone, finalize, getClass, notify, notifyAll, wait, wait, wait
      • -
      -
        -
      • - - -

        Methods inherited from interface java.lang.annotation.Annotation

        -annotationType, equals, hashCode, toString
      • -
      -
    • -
    -
    -
  • -
-
-
-
    -
  • - -
    - -
    - -
    -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        InjectLiteral

        -
        public InjectLiteral()
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- - - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/literal/NamedLiteral.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/literal/NamedLiteral.html deleted file mode 100644 index 77eb17ca56..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/literal/NamedLiteral.html +++ /dev/null @@ -1,361 +0,0 @@ - - - - - -NamedLiteral (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Class NamedLiteral

-
-
- -
-
    -
  • -
    -
    All Implemented Interfaces:
    -
    java.lang.annotation.Annotation
    -
    -
    -
    public final class NamedLiteral
    -extends AnnotationLiteral<jakarta.inject.Named>
    -implements jakarta.inject.Named
    -
    Supports inline instantiation of the Named qualifier.
    -
    -
    Since:
    -
    2.0
    -
    Author:
    -
    Pete Muir, Jozef Hartinger
    -
    See Also:
    -
    Serialized Form
    -
    -
  • -
-
-
-
    -
  • - -
    -
      -
    • - - -

      Field Summary

      - - - - - - - - - - - - -
      Fields 
      Modifier and TypeFieldDescription
      static jakarta.inject.NamedINSTANCE 
      -
    • -
    -
    - -
    - -
    -
  • -
-
-
-
    -
  • - -
    -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        INSTANCE

        -
        public static final jakarta.inject.Named INSTANCE
        -
      • -
      -
    • -
    -
    - -
    -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        of

        -
        public static NamedLiteral of​(java.lang.String value)
        -
      • -
      - - - -
        -
      • -

        value

        -
        public java.lang.String value()
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- - - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/literal/QualifierLiteral.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/literal/QualifierLiteral.html deleted file mode 100644 index 26c7b8b777..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/literal/QualifierLiteral.html +++ /dev/null @@ -1,349 +0,0 @@ - - - - - -QualifierLiteral (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Class QualifierLiteral

-
-
- -
-
    -
  • -
    -
    All Implemented Interfaces:
    -
    java.lang.annotation.Annotation
    -
    -
    -
    public final class QualifierLiteral
    -extends AnnotationLiteral<jakarta.inject.Qualifier>
    -implements jakarta.inject.Qualifier
    -
    Supports inline instantiation of the Qualifier annotation.
    -
    -
    Since:
    -
    2.0
    -
    Author:
    -
    Martin Kouba
    -
    See Also:
    -
    Serialized Form
    -
    -
  • -
-
-
-
    -
  • - -
    - -
    - -
    -
      -
    • - - -

      Constructor Summary

      - - - - - - - - - - -
      Constructors 
      ConstructorDescription
      QualifierLiteral() 
      -
    • -
    -
    - -
    -
      -
    • - - -

      Method Summary

      - -
        -
      • - - -

        Methods inherited from class java.lang.Object

        -clone, finalize, getClass, notify, notifyAll, wait, wait, wait
      • -
      -
        -
      • - - -

        Methods inherited from interface java.lang.annotation.Annotation

        -annotationType, equals, hashCode, toString
      • -
      -
    • -
    -
    -
  • -
-
-
-
    -
  • - -
    - -
    - -
    -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        QualifierLiteral

        -
        public QualifierLiteral()
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- - - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/literal/SingletonLiteral.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/literal/SingletonLiteral.html deleted file mode 100644 index e98a1ce56e..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/literal/SingletonLiteral.html +++ /dev/null @@ -1,349 +0,0 @@ - - - - - -SingletonLiteral (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Class SingletonLiteral

-
-
- -
-
    -
  • -
    -
    All Implemented Interfaces:
    -
    java.lang.annotation.Annotation
    -
    -
    -
    public final class SingletonLiteral
    -extends AnnotationLiteral<jakarta.inject.Singleton>
    -implements jakarta.inject.Singleton
    -
    Supports inline instantiation of the Singleton annotation.
    -
    -
    Since:
    -
    2.0
    -
    Author:
    -
    Martin Kouba
    -
    See Also:
    -
    Serialized Form
    -
    -
  • -
-
-
-
    -
  • - -
    - -
    - -
    -
      -
    • - - -

      Constructor Summary

      - - - - - - - - - - -
      Constructors 
      ConstructorDescription
      SingletonLiteral() 
      -
    • -
    -
    - -
    -
      -
    • - - -

      Method Summary

      - -
        -
      • - - -

        Methods inherited from class java.lang.Object

        -clone, finalize, getClass, notify, notifyAll, wait, wait, wait
      • -
      -
        -
      • - - -

        Methods inherited from interface java.lang.annotation.Annotation

        -annotationType, equals, hashCode, toString
      • -
      -
    • -
    -
    -
  • -
-
-
-
    -
  • - -
    - -
    - -
    -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        SingletonLiteral

        -
        public SingletonLiteral()
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- - - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/literal/class-use/InjectLiteral.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/literal/class-use/InjectLiteral.html deleted file mode 100644 index f487a5300a..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/literal/class-use/InjectLiteral.html +++ /dev/null @@ -1,197 +0,0 @@ - - - - - -Uses of Class jakarta.enterprise.inject.literal.InjectLiteral (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Class
jakarta.enterprise.inject.literal.InjectLiteral

-
-
- -
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/literal/class-use/NamedLiteral.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/literal/class-use/NamedLiteral.html deleted file mode 100644 index 38f2513afc..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/literal/class-use/NamedLiteral.html +++ /dev/null @@ -1,197 +0,0 @@ - - - - - -Uses of Class jakarta.enterprise.inject.literal.NamedLiteral (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Class
jakarta.enterprise.inject.literal.NamedLiteral

-
-
- -
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/literal/class-use/QualifierLiteral.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/literal/class-use/QualifierLiteral.html deleted file mode 100644 index 2b7826270d..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/literal/class-use/QualifierLiteral.html +++ /dev/null @@ -1,197 +0,0 @@ - - - - - -Uses of Class jakarta.enterprise.inject.literal.QualifierLiteral (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Class
jakarta.enterprise.inject.literal.QualifierLiteral

-
-
- -
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/literal/class-use/SingletonLiteral.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/literal/class-use/SingletonLiteral.html deleted file mode 100644 index 7d5ce84e39..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/literal/class-use/SingletonLiteral.html +++ /dev/null @@ -1,197 +0,0 @@ - - - - - -Uses of Class jakarta.enterprise.inject.literal.SingletonLiteral (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Class
jakarta.enterprise.inject.literal.SingletonLiteral

-
-
- -
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/literal/package-summary.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/literal/package-summary.html deleted file mode 100644 index 595aa51539..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/literal/package-summary.html +++ /dev/null @@ -1,192 +0,0 @@ - - - - - -jakarta.enterprise.inject.literal (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-
Module jakarta.cdi
-

Package jakarta.enterprise.inject.literal

-
-
-
    -
  • - - - - - - - - - - - - - - - - - - - - - - - - -
    Class Summary 
    ClassDescription
    InjectLiteral -
    Supports inline instantiation of the Inject annotation.
    -
    NamedLiteral -
    Supports inline instantiation of the Named qualifier.
    -
    QualifierLiteral -
    Supports inline instantiation of the Qualifier annotation.
    -
    SingletonLiteral -
    Supports inline instantiation of the Singleton annotation.
    -
    -
  • -
-
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/literal/package-tree.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/literal/package-tree.html deleted file mode 100644 index 53eb2369c4..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/literal/package-tree.html +++ /dev/null @@ -1,175 +0,0 @@ - - - - - -jakarta.enterprise.inject.literal Class Hierarchy (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Hierarchy For Package jakarta.enterprise.inject.literal

-Package Hierarchies: - -
-
-
-

Class Hierarchy

-
    -
  • java.lang.Object -
      -
    • jakarta.enterprise.util.AnnotationLiteral<T> (implements java.lang.annotation.Annotation, java.io.Serializable) -
        -
      • jakarta.enterprise.inject.literal.InjectLiteral (implements jakarta.inject.Inject)
      • -
      • jakarta.enterprise.inject.literal.NamedLiteral (implements jakarta.inject.Named)
      • -
      • jakarta.enterprise.inject.literal.QualifierLiteral (implements jakarta.inject.Qualifier)
      • -
      • jakarta.enterprise.inject.literal.SingletonLiteral (implements jakarta.inject.Singleton)
      • -
      -
    • -
    -
  • -
-
-
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/literal/package-use.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/literal/package-use.html deleted file mode 100644 index 0fe6eec383..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/literal/package-use.html +++ /dev/null @@ -1,208 +0,0 @@ - - - - - -Uses of Package jakarta.enterprise.inject.literal (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Package
jakarta.enterprise.inject.literal

-
-
- -
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/package-summary.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/package-summary.html deleted file mode 100644 index 27026a63a4..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/package-summary.html +++ /dev/null @@ -1,400 +0,0 @@ - - - - - -jakarta.enterprise.inject (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-
Module jakarta.cdi
-

Package jakarta.enterprise.inject

-
-
-
    -
  • - - - - - - - - - - - - - - - - -
    Interface Summary 
    InterfaceDescription
    Instance<T> -
    - Allows the application to dynamically obtain instances of beans with a specified combination of required type and qualifiers.
    -
    Instance.Handle<T> -
    This interface represents a contextual reference handle.
    -
    -
  • -
  • - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Class Summary 
    ClassDescription
    Alternative.Literal -
    Supports inline instantiation of the Alternative annotation.
    -
    Any.Literal -
    Supports inline instantiation of the Any qualifier.
    -
    Default.Literal -
    Supports inline instantiation of the Default qualifier.
    -
    Specializes.Literal -
    Supports inline instantiation of the Specializes annotation.
    -
    TransientReference.Literal -
    Supports inline instantiation of the TransientReference annotation.
    -
    Typed.Literal -
    Supports inline instantiation of the Typed annotation.
    -
    Vetoed.Literal -
    Supports inline instantiation of the Vetoed annotation.
    -
    -
  • -
  • - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Exception Summary 
    ExceptionDescription
    AmbiguousResolutionException -
    - Indicates that multiple beans match a certain combination of required type and required qualifiers and are eligible for - injection into a certain class.
    -
    CreationException -
    - Indicates that a checked exception was thrown during creation of a bean.
    -
    IllegalProductException -
    - Indicates that a producer method returned a null value or a producer field contained a null value, and the scope of the - producer method or field was not Dependent.
    -
    InjectionException -
    Indicates a problem relating to dependency injection.
    -
    ResolutionException -
    Indicates a problem relating to typesafe resolution.
    -
    UnproxyableResolutionException -
    - Indicates that a contextual reference for a bean with a normal scope and a certain bean type cannot be obtained because the - bean type cannot be proxied by the container.
    -
    UnsatisfiedResolutionException -
    - Indicates that no bean matches a certain combination of required type and required qualifiers and is eligible for injection - into a certain class.
    -
    -
  • -
  • - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Annotation Types Summary 
    Annotation TypeDescription
    Alternative -
    - Specifies that a bean is an alternative.
    -
    Any -
    - The built-in qualifier type.
    -
    Decorated -
    - A decorator may inject metadata about the bean it is decorating
    -
    Default -
    - The default qualifier type.
    -
    Disposes -
    - Identifies the disposed parameter of a disposer method.
    -
    Intercepted -
    - An interceptor may inject metadata about the bean it is intercepting.
    -
    Model -
    - The built-in stereotype intended for use with beans that define the model layer of an MVC web application architecture such - as JSF.
    -
    Produces -
    - Identifies a producer method or field.
    -
    Specializes -
    - Indicates that a bean directly specializes another bean.
    -
    Stereotype -
    - Specifies that an annotation type is a stereotype.
    -
    TransientReference -
    - If a parameter annotated with @TransientReference resolves to a dependent scoped bean, then the bean will be - destroyed after the invocation completes.
    -
    Typed -
    - Restricts the bean types of a bean.
    -
    Vetoed -
    - Veto the processing of the class.
    -
    -
  • -
-
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/package-tree.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/package-tree.html deleted file mode 100644 index 04a8ca7acf..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/package-tree.html +++ /dev/null @@ -1,241 +0,0 @@ - - - - - -jakarta.enterprise.inject Class Hierarchy (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Hierarchy For Package jakarta.enterprise.inject

-Package Hierarchies: - -
-
-
-

Class Hierarchy

- -
-
-

Interface Hierarchy

-
    -
  • java.lang.AutoCloseable - -
  • -
  • java.lang.Iterable<T> -
      -
    • jakarta.enterprise.inject.Instance<T> (also extends jakarta.inject.Provider<T>)
    • -
    -
  • -
  • jakarta.inject.Provider<T> -
      -
    • jakarta.enterprise.inject.Instance<T> (also extends java.lang.Iterable<T>)
    • -
    -
  • -
-
-
-

Annotation Type Hierarchy

-
    -
  • jakarta.enterprise.inject.Alternative (implements java.lang.annotation.Annotation)
  • -
  • jakarta.enterprise.inject.Any (implements java.lang.annotation.Annotation)
  • -
  • jakarta.enterprise.inject.Decorated (implements java.lang.annotation.Annotation)
  • -
  • jakarta.enterprise.inject.Default (implements java.lang.annotation.Annotation)
  • -
  • jakarta.enterprise.inject.Disposes (implements java.lang.annotation.Annotation)
  • -
  • jakarta.enterprise.inject.Intercepted (implements java.lang.annotation.Annotation)
  • -
  • jakarta.enterprise.inject.Model (implements java.lang.annotation.Annotation)
  • -
  • jakarta.enterprise.inject.Produces (implements java.lang.annotation.Annotation)
  • -
  • jakarta.enterprise.inject.Specializes (implements java.lang.annotation.Annotation)
  • -
  • jakarta.enterprise.inject.Stereotype (implements java.lang.annotation.Annotation)
  • -
  • jakarta.enterprise.inject.TransientReference (implements java.lang.annotation.Annotation)
  • -
  • jakarta.enterprise.inject.Typed (implements java.lang.annotation.Annotation)
  • -
  • jakarta.enterprise.inject.Vetoed (implements java.lang.annotation.Annotation)
  • -
-
-
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/package-use.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/package-use.html deleted file mode 100644 index b067f9a529..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/package-use.html +++ /dev/null @@ -1,384 +0,0 @@ - - - - - -Uses of Package jakarta.enterprise.inject (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Package
jakarta.enterprise.inject

-
-
- -
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/se/SeContainer.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/se/SeContainer.html deleted file mode 100644 index 1326ad4544..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/se/SeContainer.html +++ /dev/null @@ -1,394 +0,0 @@ - - - - - -SeContainer (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Interface SeContainer

-
-
-
-
    -
  • -
    -
    All Superinterfaces:
    -
    java.lang.AutoCloseable, Instance<java.lang.Object>, java.lang.Iterable<java.lang.Object>, jakarta.inject.Provider<java.lang.Object>
    -
    -
    -
    public interface SeContainer
    -extends Instance<java.lang.Object>, java.lang.AutoCloseable
    -
    Provides access to the current container in Java SE. - -

    - SeContainer implements Instance and therefore might be used to perform programmatic lookup. - If no qualifier is passed to Instance.select(java.lang.annotation.Annotation...) method, the @Default qualifier is assumed. -

    - -

    CDI Lite implementations are not required to provide support for CDI in Java SE.

    -
    -
    Since:
    -
    2.0
    -
    Author:
    -
    Antoine Sabot-Durand, John D. Ament, Graeme Rocher
    -
    -
  • -
-
-
- -
-
-
    -
  • - -
    -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        close

        -
        void close()
        -

        - Shuts down this SeContainer instance when it is no longer in scope. Implemented from AutoCloseable, -

        -
        -
        Specified by:
        -
        close in interface java.lang.AutoCloseable
        -
        Throws:
        -
        java.lang.IllegalStateException - if the container is already shutdown
        -
        -
      • -
      - - - -
        -
      • -

        isRunning

        -
        boolean isRunning()
        -
        Check if the container is running or was shut down
        -
        -
        Returns:
        -
        true if called before container shutdown
        -
        -
      • -
      - - - -
        -
      • -

        getBeanManager

        -
        BeanManager getBeanManager()
        -
        Get the CDI BeanManager for this container
        -
        -
        Returns:
        -
        the BeanManager
        -
        Throws:
        -
        java.lang.IllegalStateException - if called when the container is already shutdown
        -
        -
      • -
      - - - - -
    • -
    -
    -
  • -
-
-
-
- - - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/se/SeContainerInitializer.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/se/SeContainerInitializer.html deleted file mode 100644 index 6aa89345a3..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/se/SeContainerInitializer.html +++ /dev/null @@ -1,801 +0,0 @@ - - - - - -SeContainerInitializer (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Class SeContainerInitializer

-
-
-
    -
  • java.lang.Object
  • -
  • -
      -
    • jakarta.enterprise.inject.se.SeContainerInitializer
    • -
    -
  • -
-
-
    -
  • -
    -
    public abstract class SeContainerInitializer
    -extends java.lang.Object
    -
    A CDI container initializer for Java SE. An instance may be obtained by calling newInstance() - static method. -

    - Typical usage looks like this: -

    - -
    - SeContainer container = SeContainerInitializer.newInstance().initialize();
    - container.select(Foo.class).get();
    - container.close();
    - 
    - -

    - Since SeContainer interface implements AutoCloseable: -

    - -
    - try (SeContainer container = SeContainerInitializer.newInstance().initialize()) {
    -     container.select(Foo.class).get();
    - }
    - 
    - -

    - By default, the discovery is enabled so that all beans from all discovered bean archives are considered. However, it's - possible to define a "synthetic" bean archive, or the set of bean classes and enablement respectively: -

    - -
    - SeContainer container = SeContainerInitializer.newInstance().addBeanClasses(Foo.class, Bar.class).selectAlternatives(Bar.class).initialize());
    - 
    - -

    - Moreover, it's also possible to disable the discovery completely so that only the "synthetic" bean archive is considered: -

    - -
    - SeContainer container = SeContainerInitializer.newInstance().disableDiscovery().addBeanClasses(Foo.class, Bar.class).initialize());
    - 
    - -

    - In the same manner, it is possible to explicitly declare interceptors, decorators, extensions and implementation specific - options using the builder. -

    - -
    - SeContainerInitializer containerInitializer = SeContainerInitializer.newInstance()
    -         .disableDiscovery()
    -         .addPackages(Main.class, Utils.class)
    -         .enableInterceptors(TransactionalInterceptor.class)
    -         .addProperty("property", true);
    - SeContainer container = container.initialize();
    - 
    - -

    CDI Lite implementations are not required to provide support for CDI in Java SE.

    -
    -
    Since:
    -
    2.0
    -
    Author:
    -
    Antoine Sabot-Durand, Martin Kouba, John D. Ament
    -
    -
  • -
-
-
- -
-
-
    -
  • - -
    -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        SeContainerInitializer

        -
        public SeContainerInitializer()
        -
      • -
      -
    • -
    -
    - -
    -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        newInstance

        -
        public static SeContainerInitializer newInstance()
        -
        Returns an instance of SeContainerInitializer - Each call returns a new instance
        -
        -
        Returns:
        -
        a new SeContainerInitializer instance.
        -
        Throws:
        -
        java.lang.IllegalStateException - if called in a Java EE container
        -
        -
      • -
      - - - -
        -
      • -

        addBeanClasses

        -
        public abstract SeContainerInitializer addBeanClasses​(java.lang.Class<?>... classes)
        -
        Add provided bean classes to the synthetic bean archive.
        -
        -
        Parameters:
        -
        classes - classes to add to the synthetic bean archive
        -
        Returns:
        -
        self
        -
        -
      • -
      - - - -
        -
      • -

        addPackages

        -
        public abstract SeContainerInitializer addPackages​(java.lang.Class<?>... packageClasses)
        -
        All classes from the packages of the specified classes will be added to the set of bean classes for the synthetic bean archive. -

        - Note that the scanning possibilities are limited. Therefore, only directories and jar files from the filesystem are supported. -

        -

        - Scanning may also have negative impact on SE performance. -

        -
        -
        Parameters:
        -
        packageClasses - classes whose packages will be added to the synthetic bean archive
        -
        Returns:
        -
        self
        -
        -
      • -
      - - - -
        -
      • -

        addPackages

        -
        public abstract SeContainerInitializer addPackages​(boolean scanRecursively,
        -                                                   java.lang.Class<?>... packageClasses)
        -
        Packages of the specified classes will be scanned and found classes will be added to the set of bean classes for the synthetic bean archive.* -

        - Note that the scanning possibilities are limited. Therefore, only directories and jar files from the filesystem are supported. -

        -

        - Scanning may also have negative impact on SE performance. -

        -
        -
        Parameters:
        -
        scanRecursively - should subpackages be scanned or not
        -
        packageClasses - classes whose packages will be scanned
        -
        Returns:
        -
        self
        -
        -
      • -
      - - - -
        -
      • -

        addPackages

        -
        public abstract SeContainerInitializer addPackages​(java.lang.Package... packages)
        -
        All classes from the specified packages will be added to the set of bean classes for the synthetic bean archive. -

        - Note that the scanning possibilities are limited. Therefore, only directories and jar files from the filesystem are supported. -

        -

        - Scanning may also have negative impact on SE performance. -

        -
        -
        Parameters:
        -
        packages - packages that will be added to the synthetic bean archive
        -
        Returns:
        -
        self
        -
        -
      • -
      - - - -
        -
      • -

        addPackages

        -
        public abstract SeContainerInitializer addPackages​(boolean scanRecursively,
        -                                                   java.lang.Package... packages)
        -
        All classes from the specified packages will be added to the set of bean classes for the synthetic bean archive. -

        - Note that the scanning possibilities are limited. Therefore, only directories and jar files from the filesystem are supported. -

        -

        - Scanning may also have negative impact on SE performance. -

        -
        -
        Parameters:
        -
        scanRecursively - should subpackages be scanned or not
        -
        packages - packages that will be added to the synthetic bean archive
        -
        Returns:
        -
        self
        -
        -
      • -
      - - - -
        -
      • -

        addExtensions

        -
        public abstract SeContainerInitializer addExtensions​(Extension... extensions)
        -
        Add extensions to the set of extensions.
        -
        -
        Parameters:
        -
        extensions - extensions to use in the container
        -
        Returns:
        -
        self
        -
        -
      • -
      - - - -
        -
      • -

        addExtensions

        -
        public abstract SeContainerInitializer addExtensions​(java.lang.Class<? extends Extension>... extensions)
        -
        Add extensions to the set of extensions.
        -
        -
        Parameters:
        -
        extensions - extensions class to use in the container
        -
        Returns:
        -
        self
        -
        -
      • -
      - - - -
        -
      • -

        enableInterceptors

        -
        public abstract SeContainerInitializer enableInterceptors​(java.lang.Class<?>... interceptorClasses)
        -
        Add interceptor classes to the list of enabled interceptors for the synthetic bean archive. -

        - This method does not add any class to the set of bean classes of the synthetic bean archive. -

        -
        -
        Parameters:
        -
        interceptorClasses - classes of the interceptors to enable.
        -
        Returns:
        -
        self
        -
        -
      • -
      - - - -
        -
      • -

        enableDecorators

        -
        public abstract SeContainerInitializer enableDecorators​(java.lang.Class<?>... decoratorClasses)
        -
        Add decorator classes to the list of enabled decorators for the synthetic bean archive. -

        - This method does not add any class to the set of bean classes of the synthetic bean archive. -

        -
        -
        Parameters:
        -
        decoratorClasses - classes of the decorators to enable.
        -
        Returns:
        -
        self
        -
        -
      • -
      - - - -
        -
      • -

        selectAlternatives

        -
        public abstract SeContainerInitializer selectAlternatives​(java.lang.Class<?>... alternativeClasses)
        -
        Add alternatives classes to the list of selected alternatives for the synthetic bean archive. -

        - This method does not add any class to the set of bean classes of the synthetic bean archive. -

        -
        -
        Parameters:
        -
        alternativeClasses - classes of the alternatives to select
        -
        Returns:
        -
        self
        -
        -
      • -
      - - - -
        -
      • -

        selectAlternativeStereotypes

        -
        public abstract SeContainerInitializer selectAlternativeStereotypes​(java.lang.Class<? extends java.lang.annotation.Annotation>... alternativeStereotypeClasses)
        -
        Add alternative stereotype classes to the list of selected alternative stereotypes for the synthetic bean archive. -

        - This method does not add any class to the set of bean classes of the synthetic bean archive. -

        -
        -
        Parameters:
        -
        alternativeStereotypeClasses - alternatives stereotypes to select
        -
        Returns:
        -
        self
        -
        -
      • -
      - - - -
        -
      • -

        addProperty

        -
        public abstract SeContainerInitializer addProperty​(java.lang.String key,
        -                                                   java.lang.Object value)
        -
        Add a configuration property to the container
        -
        -
        Parameters:
        -
        key - property name
        -
        value - property value
        -
        Returns:
        -
        self
        -
        -
      • -
      - - - -
        -
      • -

        setProperties

        -
        public abstract SeContainerInitializer setProperties​(java.util.Map<java.lang.String,​java.lang.Object> properties)
        -
        Set all the configuration properties. - Erase previous properties set
        -
        -
        Parameters:
        -
        properties - a map containing properties to add
        -
        Returns:
        -
        self
        -
        -
      • -
      - - - -
        -
      • -

        disableDiscovery

        -
        public abstract SeContainerInitializer disableDiscovery()
        -
        By default, the discovery is enabled. However, it's possible to disable the discovery completely so that only the "synthetic" bean archive is considered.
        -
        -
        Returns:
        -
        self
        -
        -
      • -
      - - - -
        -
      • -

        setClassLoader

        -
        public abstract SeContainerInitializer setClassLoader​(java.lang.ClassLoader classLoader)
        -
        Set a ClassLoader. The given ClassLoader will be scanned automatically for bean archives if scanning is enabled.
        -
        -
        Parameters:
        -
        classLoader - the class loader to use
        -
        Returns:
        -
        self
        -
        -
      • -
      - - - -
        -
      • -

        initialize

        -
        public abstract SeContainer initialize()
        -

        - Initializes a CDI SeContainerInitializer. -

        -

        - Cannot be called within an application server. -

        -
        -
        Returns:
        -
        the SeContainer instance associated with the container.
        -
        Throws:
        -
        java.lang.UnsupportedOperationException - if called within an application server
        -
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- - - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/se/class-use/SeContainer.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/se/class-use/SeContainer.html deleted file mode 100644 index 60f87c523a..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/se/class-use/SeContainer.html +++ /dev/null @@ -1,200 +0,0 @@ - - - - - -Uses of Interface jakarta.enterprise.inject.se.SeContainer (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Interface
jakarta.enterprise.inject.se.SeContainer

-
-
- -
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/se/class-use/SeContainerInitializer.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/se/class-use/SeContainerInitializer.html deleted file mode 100644 index 23d10c6d8d..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/se/class-use/SeContainerInitializer.html +++ /dev/null @@ -1,308 +0,0 @@ - - - - - -Uses of Class jakarta.enterprise.inject.se.SeContainerInitializer (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Class
jakarta.enterprise.inject.se.SeContainerInitializer

-
-
- -
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/se/package-summary.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/se/package-summary.html deleted file mode 100644 index 5de0b37a13..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/se/package-summary.html +++ /dev/null @@ -1,191 +0,0 @@ - - - - - -jakarta.enterprise.inject.se (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-
Module jakarta.cdi
-

Package jakarta.enterprise.inject.se

-
-
-
    -
  • - - - - - - - - - - - - -
    Interface Summary 
    InterfaceDescription
    SeContainer -
    Provides access to the current container in Java SE.
    -
    -
  • -
  • - - - - - - - - - - - - -
    Class Summary 
    ClassDescription
    SeContainerInitializer -
    A CDI container initializer for Java SE.
    -
    -
  • -
-
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/se/package-tree.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/se/package-tree.html deleted file mode 100644 index a5780b70be..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/se/package-tree.html +++ /dev/null @@ -1,196 +0,0 @@ - - - - - -jakarta.enterprise.inject.se Class Hierarchy (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Hierarchy For Package jakarta.enterprise.inject.se

-Package Hierarchies: - -
-
-
-

Class Hierarchy

- -
-
-

Interface Hierarchy

-
    -
  • java.lang.AutoCloseable -
      -
    • jakarta.enterprise.inject.se.SeContainer (also extends jakarta.enterprise.inject.Instance<T>)
    • -
    -
  • -
  • java.lang.Iterable<T> -
      -
    • jakarta.enterprise.inject.Instance<T> (also extends jakarta.inject.Provider<T>) -
        -
      • jakarta.enterprise.inject.se.SeContainer (also extends java.lang.AutoCloseable)
      • -
      -
    • -
    -
  • -
  • jakarta.inject.Provider<T> -
      -
    • jakarta.enterprise.inject.Instance<T> (also extends java.lang.Iterable<T>) -
        -
      • jakarta.enterprise.inject.se.SeContainer (also extends java.lang.AutoCloseable)
      • -
      -
    • -
    -
  • -
-
-
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/se/package-use.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/se/package-use.html deleted file mode 100644 index 8752859855..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/se/package-use.html +++ /dev/null @@ -1,196 +0,0 @@ - - - - - -Uses of Package jakarta.enterprise.inject.se (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Package
jakarta.enterprise.inject.se

-
-
- -
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/AfterBeanDiscovery.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/AfterBeanDiscovery.html deleted file mode 100644 index af82018666..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/AfterBeanDiscovery.html +++ /dev/null @@ -1,503 +0,0 @@ - - - - - -AfterBeanDiscovery (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Interface AfterBeanDiscovery

-
-
-
-
    -
  • -
    -
    public interface AfterBeanDiscovery
    -

    - The event type of the second event fired by the container when it has fully completed the bean discovery process, validated - that there are no definition errors relating to the discovered beans, and registered Bean - and ObserverMethod objects for the discovered beans, but before detecting deployment - problems. -

    -

    - A portable extension may take advantage of this event to register beans, - interceptors, decorators, - observer methods and custom context - objects with the container. -

    - -
    -     void afterBeanDiscovery(@Observes AfterBeanDiscovery event, BeanManager manager) { ... }
    - 
    -

    - If any observer method of the AfterBeanDiscovery event throws an exception, the exception is treated as a definition - error by the container. -

    - -

    CDI Lite implementations are not required to provide support for Portable Extensions.

    -
    -
    Author:
    -
    David Allen, Antoine Sabot-Durand
    -
    -
  • -
-
-
- -
-
-
    -
  • - -
    -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        addDefinitionError

        -
        void addDefinitionError​(java.lang.Throwable t)
        -
        Registers a definition error with the container, causing the container to abort deployment after all observers have been - notified.
        -
        -
        Parameters:
        -
        t - The definition error as a Throwable
        -
        Throws:
        -
        java.lang.IllegalStateException - if called outside of the observer method invocation
        -
        -
      • -
      - - - -
        -
      • -

        addBean

        -
        void addBean​(Bean<?> bean)
        -
        Fires an event of type ProcessBean containing the given - Bean and then registers the Bean with the - container, thereby making a bean which is not an interceptor nor a decorator available for injection into other beans. - The given Bean may implement Interceptor or Decorator.
        -
        -
        Parameters:
        -
        bean - The bean to add to the deployment
        -
        Throws:
        -
        java.lang.IllegalStateException - if called outside of the observer method invocation
        -
        -
      • -
      - - - -
        -
      • -

        addBean

        -
        <T> BeanConfigurator<T> addBean()
        -
        Obtains a new BeanConfigurator to configure a new Bean and add it at the end of the observer invocation. - It will then fire an event of type ProcessBean containing the built - Bean from this configuration and then register it with the - container, thereby making it available for injection into other beans. - - Each call returns a new BeanConfigurator.
        -
        -
        Type Parameters:
        -
        T - type of bean
        -
        Returns:
        -
        a non reusable BeanConfigurator to configure the bean to add
        -
        Throws:
        -
        java.lang.IllegalStateException - if called outside of the observer method invocation
        -
        Since:
        -
        2.0
        -
        -
      • -
      - - - -
        -
      • -

        addObserverMethod

        -
        void addObserverMethod​(ObserverMethod<?> observerMethod)
        -
        Fires an event of type ProcessObserverMethod containing the given - ObserverMethod and then registers the - ObserverMethod with the container, thereby making it available for event - notifications.
        -
        -
        Parameters:
        -
        observerMethod - The custom observer method to add to the deployment
        -
        Throws:
        -
        java.lang.IllegalStateException - if called outside of the observer method invocation
        -
        -
      • -
      - - - -
        -
      • -

        addObserverMethod

        -
        <T> ObserverMethodConfigurator<T> addObserverMethod()
        -
        obtains a new ObserverMethodConfigurator to configure a new ObserverMethod and add it at the end of the observer invocation. - It will then fire an event of type ProcessObserverMethod containing the built - ObserverMethod from this configuration and then registers the - ObserverMethod with the container, thereby making it available for event - notifications. - - Each call returns a new ObserverMethodConfigurator.
        -
        -
        Type Parameters:
        -
        T - type of the event the configured ObserverMethod will observe
        -
        Returns:
        -
        a non reusable ObserverMethodConfigurator instance
        -
        Throws:
        -
        java.lang.IllegalStateException - if called outside of the observer method invocation
        -
        Since:
        -
        2.0
        -
        -
      • -
      - - - -
        -
      • -

        addContext

        -
        void addContext​(Context context)
        -
        Registers a custom Context object with the container.
        -
        -
        Parameters:
        -
        context - The custom context to add to the deployment
        -
        Throws:
        -
        java.lang.IllegalStateException - if called outside of the observer method invocation
        -
        -
      • -
      - - - -
        -
      • -

        getAnnotatedType

        -
        <T> AnnotatedType<T> getAnnotatedType​(java.lang.Class<T> type,
        -                                      java.lang.String id)
        -
        Obtain the AnnotatedType that may be used to read the annotations of the given class or interface as defined - during container initialization.
        -
        -
        Type Parameters:
        -
        T - the class or interface
        -
        Parameters:
        -
        type - the Class object
        -
        id - the type identifier. If null, the fully qualifier class name of type is used
        -
        Returns:
        -
        the AnnotatedType
        -
        Throws:
        -
        java.lang.IllegalStateException - if called outside of the observer method invocation
        -
        Since:
        -
        1.1
        -
        -
      • -
      - - - -
        -
      • -

        getAnnotatedTypes

        -
        <T> java.lang.Iterable<AnnotatedType<T>> getAnnotatedTypes​(java.lang.Class<T> type)
        -
        Obtain the AnnotatedTypes that may be used to read the annotations of the given class or interface as defined - during container initialization.
        -
        -
        Type Parameters:
        -
        T - the class or interface
        -
        Parameters:
        -
        type - the Class object
        -
        Returns:
        -
        the AnnotatedTypes
        -
        Throws:
        -
        java.lang.IllegalStateException - if called outside of the observer method invocation
        -
        Since:
        -
        1.1
        -
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- -
- -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

-
- - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/AfterDeploymentValidation.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/AfterDeploymentValidation.html deleted file mode 100644 index ada4ee9acb..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/AfterDeploymentValidation.html +++ /dev/null @@ -1,281 +0,0 @@ - - - - - -AfterDeploymentValidation (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Interface AfterDeploymentValidation

-
-
-
-
    -
  • -
    -
    public interface AfterDeploymentValidation
    -

    - The event type of the third event fired by the container after it has validated that there are no deployment problems and - before creating contexts or processing requests. If any observer method of the AfterDeploymentValidation event throws - an exception, the exception is treated as a deployment problem by the container. -

    -

    - No requests will be processed by the deployment until all observers of this event return. -

    - -

    CDI Lite implementations are not required to provide support for Portable Extensions.

    -
    -
    Author:
    -
    David Allen
    -
    -
  • -
-
-
-
    -
  • - -
    -
      -
    • - - -

      Method Summary

      - - - - - - - - - - - - -
      All Methods Instance Methods Abstract Methods 
      Modifier and TypeMethodDescription
      voidaddDeploymentProblem​(java.lang.Throwable t) -
      Registers a deployment problem with the container, causing the container to abort deployment after all observers have - been notified.
      -
      -
    • -
    -
    -
  • -
-
-
-
    -
  • - -
    -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        addDeploymentProblem

        -
        void addDeploymentProblem​(java.lang.Throwable t)
        -
        Registers a deployment problem with the container, causing the container to abort deployment after all observers have - been notified.
        -
        -
        Parameters:
        -
        t - The deployment problem as a Throwable
        -
        Throws:
        -
        java.lang.IllegalStateException - if called outside of the observer method invocation
        -
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- -
- -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

-
- - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/AfterTypeDiscovery.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/AfterTypeDiscovery.html deleted file mode 100644 index 385f116036..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/AfterTypeDiscovery.html +++ /dev/null @@ -1,413 +0,0 @@ - - - - - -AfterTypeDiscovery (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Interface AfterTypeDiscovery

-
-
-
-
    -
  • -
    -
    public interface AfterTypeDiscovery
    -

    - This event type is thrown by the container after type discovery is complete. If any observer method of the - AfterTypeDiscovery event throws an exception, the exception is treated as a definition error by the container. -

    -

    - Any observer of this event is permitted to add classes to, or remove classes from, the list of alternatives, list of - interceptors or list of decorators. The container will use the final values of these lists, after all observers have been - called, to determine the enabled alternatives, interceptors, and decorators for application. - Changes made to these lists after the invocation of the last observer method of the AfterTypeDiscovery are ignored. -

    - -

    CDI Lite implementations are not required to provide support for Portable Extensions.

    -
    -
    Since:
    -
    1.1
    -
    Author:
    -
    Pete Muir, Antoine Sabot-Durand
    -
    -
  • -
-
-
- -
-
-
    -
  • - -
    -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        getAlternatives

        -
        java.util.List<java.lang.Class<?>> getAlternatives()
        -
        -
        Returns:
        -
        the list of enabled alternatives for the application, sorted by priority in ascending order. Alternatives enabled for a bean archive are not included.
        -
        Throws:
        -
        java.lang.IllegalStateException - if called outside of the observer method invocation
        -
        -
      • -
      - - - -
        -
      • -

        getInterceptors

        -
        java.util.List<java.lang.Class<?>> getInterceptors()
        -
        -
        Returns:
        -
        the list of enabled interceptors for the application, sorted by priority in ascending order. Interceptors enabled for a bean archive are not included.
        -
        Throws:
        -
        java.lang.IllegalStateException - if called outside of the observer method invocation
        -
        -
      • -
      - - - -
        -
      • -

        getDecorators

        -
        java.util.List<java.lang.Class<?>> getDecorators()
        -
        -
        Returns:
        -
        the list of enabled decorators for the application, sorted by priority in ascending order. Decorators enabled for a bean archive are not included.
        -
        Throws:
        -
        java.lang.IllegalStateException - if called outside of the observer method invocation
        -
        -
      • -
      - - - -
        -
      • -

        addAnnotatedType

        -
        void addAnnotatedType​(AnnotatedType<?> type,
        -                      java.lang.String id)
        -

        - Adds a given AnnotatedType to the set of types which will be scanned during bean - discovery. -

        - -

        - Thanks to the id parameter, this method allows multiple annotated types, based on the same underlying type, to be defined. AnnotatedTypes - discovered by the container use the fully qualified class name of AnnotatedType.getJavaClass() to identify the - type. -

        - -

        - AfterBeanDiscovery.getAnnotatedType(Class, String) and AfterBeanDiscovery.getAnnotatedTypes(Class) allows - annotated types to be obtained by identifier. -

        -
        -
        Parameters:
        -
        type - The AnnotatedType to add for later scanning
        -
        id - the identifier used to distinguish this AnnotatedType from an other one based on the same underlying type
        -
        Throws:
        -
        java.lang.IllegalStateException - if called outside of the observer method invocation
        -
        -
      • -
      - - - -
        -
      • -

        addAnnotatedType

        -
        <T> AnnotatedTypeConfigurator<T> addAnnotatedType​(java.lang.Class<T> type,
        -                                                  java.lang.String id)
        -

        - Obtains a new AnnotatedTypeConfigurator to configure a new AnnotatedType and - add it to the set of types which will be scanned during bean discovery at the end of the observer invocation. - Calling this method multiple times will return a new AnnotatedTypeConfigurator. -

        - -

        - Thanks to the id parameter, this method allows multiple annotated types, based on the same underlying type, to be defined. AnnotatedTypes - discovered by the container use the fully qualified class name of AnnotatedType.getJavaClass() to identify the - type. -

        - -

        - AfterBeanDiscovery.getAnnotatedType(Class, String) and AfterBeanDiscovery.getAnnotatedTypes(Class) allows - annotated types to be obtained by identifier. -

        - - Each call returns a new AnnotatedTypeConfigurator.
        -
        -
        Type Parameters:
        -
        T - annotatated instance type
        -
        Parameters:
        -
        type - class used to initialized the type and annotations on the AnnotatedTypeConfigurator
        -
        id - the identifier used to distinguish this AnnotatedType from an other one based on the same underlying type
        -
        Returns:
        -
        a non reusable AnnotatedTypeConfigurator to configure the new AnnotatedType
        -
        Throws:
        -
        java.lang.IllegalStateException - if called outside of the observer method invocation
        -
        Since:
        -
        2.0
        -
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- -
- -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

-
- - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/Annotated.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/Annotated.html deleted file mode 100644 index 36dcaea96a..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/Annotated.html +++ /dev/null @@ -1,419 +0,0 @@ - - - - - -Annotated (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Interface Annotated

-
-
-
- -
-
-
    -
  • - -
    -
      -
    • - - -

      Method Summary

      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      All Methods Instance Methods Abstract Methods 
      Modifier and TypeMethodDescription
      <T extends java.lang.annotation.Annotation>
      T
      getAnnotation​(java.lang.Class<T> annotationType) -
      - Get program element annotation of a certain annotation type.
      -
      java.util.Set<java.lang.annotation.Annotation>getAnnotations() -
      - Get all annotations of the program element.
      -
      <T extends java.lang.annotation.Annotation>
      java.util.Set<T>
      getAnnotations​(java.lang.Class<T> annotationType) -
      - Get program element annotations of a certain annotation type.
      -
      java.lang.reflect.TypegetBaseType() -
      - Get the type of the annotated program element.
      -
      java.util.Set<java.lang.reflect.Type>getTypeClosure() -
      - Get all types to which the base type should be considered assignable.
      -
      booleanisAnnotationPresent​(java.lang.Class<? extends java.lang.annotation.Annotation> annotationType) -
      - Determine if the program element has an annotation of a certain annotation type.
      -
      -
    • -
    -
    -
  • -
-
-
-
    -
  • - -
    -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        getBaseType

        -
        java.lang.reflect.Type getBaseType()
        -

        - Get the type of the annotated program element. -

        -
        -
        Returns:
        -
        the type of the annotated program element
        -
        -
      • -
      - - - -
        -
      • -

        getTypeClosure

        -
        java.util.Set<java.lang.reflect.Type> getTypeClosure()
        -

        - Get all types to which the base type should be considered assignable. -

        -
        -
        Returns:
        -
        a set of all types to which the base type should be considered assignable
        -
        -
      • -
      - - - -
        -
      • -

        getAnnotation

        -
        <T extends java.lang.annotation.Annotation> T getAnnotation​(java.lang.Class<T> annotationType)
        -

        - Get program element annotation of a certain annotation type. - - The behavior of this method is intended to be the same behavior as AnnotatedElement.getAnnotation(Class), - where repeatable annotations are not supported. -

        -
        -
        Type Parameters:
        -
        T - the type of the annotation
        -
        Parameters:
        -
        annotationType - the class of the annotation type
        -
        Returns:
        -
        the first program element annotation of the given annotation type, or a null value
        -
        -
      • -
      - - - -
        -
      • -

        getAnnotations

        -
        <T extends java.lang.annotation.Annotation> java.util.Set<T> getAnnotations​(java.lang.Class<T> annotationType)
        -

        - Get program element annotations of a certain annotation type. -

        - This method returns back all annotations, including repeatable annotations of this type. - - The behavior of this method is intended to be the same behavior as AnnotatedElement.getAnnotationsByType(Class), - where repeatable annotations are supported. -

        -
        -
        Type Parameters:
        -
        T - the type of the annotation
        -
        Parameters:
        -
        annotationType - the class of the annotation type
        -
        Returns:
        -
        the program element annotations of the given annotation type, or an empty collection
        -
        -
      • -
      - - - -
        -
      • -

        getAnnotations

        -
        java.util.Set<java.lang.annotation.Annotation> getAnnotations()
        -

        - Get all annotations of the program element. -

        -
        -
        Returns:
        -
        all annotations of the program element, or an empty set if no annotations are present
        -
        -
      • -
      - - - -
        -
      • -

        isAnnotationPresent

        -
        boolean isAnnotationPresent​(java.lang.Class<? extends java.lang.annotation.Annotation> annotationType)
        -

        - Determine if the program element has an annotation of a certain annotation type. - - The behavior of this method is similar to AnnotatedElement.isAnnotationPresent(Class) for the underlying - program element.

        -
        -
        Parameters:
        -
        annotationType - the annotation type to check for
        -
        Returns:
        -
        true if the program element has an annotation of the given annotation type, or false otherwise
        -
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- -
- -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

-
- - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/AnnotatedCallable.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/AnnotatedCallable.html deleted file mode 100644 index c01bdbc76b..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/AnnotatedCallable.html +++ /dev/null @@ -1,300 +0,0 @@ - - - - - -AnnotatedCallable (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Interface AnnotatedCallable<X>

-
-
-
- -
-
- -
-
-
    -
  • - -
    -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        getParameters

        -
        java.util.List<AnnotatedParameter<X>> getParameters()
        -

        - Get the parameters of the callable member. -

        -
        -
        Returns:
        -
        the parameters
        -
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- -
- -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

-
- - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/AnnotatedConstructor.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/AnnotatedConstructor.html deleted file mode 100644 index 53a283f3db..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/AnnotatedConstructor.html +++ /dev/null @@ -1,343 +0,0 @@ - - - - - -AnnotatedConstructor (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Interface AnnotatedConstructor<X>

-
-
-
-
    -
  • -
    -
    Type Parameters:
    -
    X - the declaring class
    -
    -
    -
    All Superinterfaces:
    -
    Annotated, AnnotatedCallable<X>, AnnotatedMember<X>
    -
    -
    -
    public interface AnnotatedConstructor<X>
    -extends AnnotatedCallable<X>
    -

    - Represents a constructor of a Java class. -

    -
    -
    Author:
    -
    Gavin King, Pete Muir
    -
    See Also:
    -
    Constructor
    -
    -
  • -
-
-
- -
-
-
    -
  • - -
    -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        getJavaMember

        -
        java.lang.reflect.Constructor<X> getJavaMember()
        -

        - Get the underlying Constructor. -

        -
        -
        Specified by:
        -
        getJavaMember in interface AnnotatedMember<X>
        -
        Returns:
        -
        the constructor
        -
        -
      • -
      - - - -
        -
      • -

        getAnnotations

        -
        default <T extends java.lang.annotation.Annotation> java.util.Set<T> getAnnotations​(java.lang.Class<T> annotationType)
        -
        Description copied from interface: Annotated
        -

        - Get program element annotations of a certain annotation type. -

        - This method returns back all annotations, including repeatable annotations of this type. - - The behavior of this method is intended to be the same behavior as AnnotatedElement.getAnnotationsByType(Class), - where repeatable annotations are supported. -

        -
        -
        Specified by:
        -
        getAnnotations in interface Annotated
        -
        Type Parameters:
        -
        T - the type of the annotation
        -
        Parameters:
        -
        annotationType - the class of the annotation type
        -
        Returns:
        -
        the program element annotations of the given annotation type, or an empty collection
        -
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- -
- -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

-
- - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/AnnotatedField.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/AnnotatedField.html deleted file mode 100644 index 03df05267d..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/AnnotatedField.html +++ /dev/null @@ -1,336 +0,0 @@ - - - - - -AnnotatedField (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Interface AnnotatedField<X>

-
-
-
-
    -
  • -
    -
    Type Parameters:
    -
    X - the declaring type
    -
    -
    -
    All Superinterfaces:
    -
    Annotated, AnnotatedMember<X>
    -
    -
    -
    public interface AnnotatedField<X>
    -extends AnnotatedMember<X>
    -

    - Represents a field of a Java class. -

    -
    -
    Author:
    -
    Gavin King, Pete Muir
    -
    See Also:
    -
    Field
    -
    -
  • -
-
-
- -
-
-
    -
  • - -
    -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        getJavaMember

        -
        java.lang.reflect.Field getJavaMember()
        -

        - Get the underlying Field. -

        -
        -
        Specified by:
        -
        getJavaMember in interface AnnotatedMember<X>
        -
        Returns:
        -
        the Field
        -
        -
      • -
      - - - -
        -
      • -

        getAnnotations

        -
        default <T extends java.lang.annotation.Annotation> java.util.Set<T> getAnnotations​(java.lang.Class<T> annotationType)
        -
        Description copied from interface: Annotated
        -

        - Get program element annotations of a certain annotation type. -

        - This method returns back all annotations, including repeatable annotations of this type. - - The behavior of this method is intended to be the same behavior as AnnotatedElement.getAnnotationsByType(Class), - where repeatable annotations are supported. -

        -
        -
        Specified by:
        -
        getAnnotations in interface Annotated
        -
        Type Parameters:
        -
        T - the type of the annotation
        -
        Parameters:
        -
        annotationType - the class of the annotation type
        -
        Returns:
        -
        the program element annotations of the given annotation type, or an empty collection
        -
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- -
- -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

-
- - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/AnnotatedMember.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/AnnotatedMember.html deleted file mode 100644 index c139fd1dd0..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/AnnotatedMember.html +++ /dev/null @@ -1,343 +0,0 @@ - - - - - -AnnotatedMember (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Interface AnnotatedMember<X>

-
-
-
- -
-
- -
-
-
    -
  • - -
    -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        getJavaMember

        -
        java.lang.reflect.Member getJavaMember()
        -

        - Get the underlying Member. -

        -
        -
        Returns:
        -
        the Member
        -
        -
      • -
      - - - -
        -
      • -

        isStatic

        -
        boolean isStatic()
        -

        - Determines if the member is static. -

        -
        -
        Returns:
        -
        true if the member is static
        -
        -
      • -
      - - - -
        -
      • -

        getDeclaringType

        -
        AnnotatedType<X> getDeclaringType()
        -

        - Get the type which defines this member. -

        -
        -
        Returns:
        -
        the type which defines this member
        -
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- -
- -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

-
- - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/AnnotatedMethod.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/AnnotatedMethod.html deleted file mode 100644 index 3ad06bf313..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/AnnotatedMethod.html +++ /dev/null @@ -1,343 +0,0 @@ - - - - - -AnnotatedMethod (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Interface AnnotatedMethod<X>

-
-
-
-
    -
  • -
    -
    Type Parameters:
    -
    X - the declaring type
    -
    -
    -
    All Superinterfaces:
    -
    Annotated, AnnotatedCallable<X>, AnnotatedMember<X>
    -
    -
    -
    public interface AnnotatedMethod<X>
    -extends AnnotatedCallable<X>
    -

    - Represents a method of a Java type. -

    -
    -
    Author:
    -
    Gavin King, Pete Muir
    -
    See Also:
    -
    Method
    -
    -
  • -
-
-
- -
-
-
    -
  • - -
    -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        getJavaMember

        -
        java.lang.reflect.Method getJavaMember()
        -

        - Get the underlying Method. -

        -
        -
        Specified by:
        -
        getJavaMember in interface AnnotatedMember<X>
        -
        Returns:
        -
        the Method
        -
        -
      • -
      - - - -
        -
      • -

        getAnnotations

        -
        default <T extends java.lang.annotation.Annotation> java.util.Set<T> getAnnotations​(java.lang.Class<T> annotationType)
        -
        Description copied from interface: Annotated
        -

        - Get program element annotations of a certain annotation type. -

        - This method returns back all annotations, including repeatable annotations of this type. - - The behavior of this method is intended to be the same behavior as AnnotatedElement.getAnnotationsByType(Class), - where repeatable annotations are supported. -

        -
        -
        Specified by:
        -
        getAnnotations in interface Annotated
        -
        Type Parameters:
        -
        T - the type of the annotation
        -
        Parameters:
        -
        annotationType - the class of the annotation type
        -
        Returns:
        -
        the program element annotations of the given annotation type, or an empty collection
        -
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- -
- -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

-
- - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/AnnotatedParameter.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/AnnotatedParameter.html deleted file mode 100644 index a40024b4d5..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/AnnotatedParameter.html +++ /dev/null @@ -1,370 +0,0 @@ - - - - - -AnnotatedParameter (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Interface AnnotatedParameter<X>

-
-
-
-
    -
  • -
    -
    Type Parameters:
    -
    X - the type that declares the method or constructor
    -
    -
    -
    All Superinterfaces:
    -
    Annotated
    -
    -
    -
    public interface AnnotatedParameter<X>
    -extends Annotated
    -

    - Represents a parameter of a method or constructor. -

    -
    -
    Author:
    -
    Gavin King, Pete Muir, Jozef Hartinger
    -
    -
  • -
-
-
- -
-
-
    -
  • - -
    -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        getPosition

        -
        int getPosition()
        -

        - Get the position of the parameter in the method or constructor argument list. -

        -
        -
        Returns:
        -
        the position of the parameter
        -
        -
      • -
      - - - - - - - -
        -
      • -

        getJavaParameter

        -
        default java.lang.reflect.Parameter getJavaParameter()
        -
        Get the underlying Parameter.
        -
        -
        Returns:
        -
        the Parameter
        -
        -
      • -
      - - - -
        -
      • -

        getAnnotations

        -
        default <T extends java.lang.annotation.Annotation> java.util.Set<T> getAnnotations​(java.lang.Class<T> annotationType)
        -
        Description copied from interface: Annotated
        -

        - Get program element annotations of a certain annotation type. -

        - This method returns back all annotations, including repeatable annotations of this type. - - The behavior of this method is intended to be the same behavior as AnnotatedElement.getAnnotationsByType(Class), - where repeatable annotations are supported. -

        -
        -
        Specified by:
        -
        getAnnotations in interface Annotated
        -
        Type Parameters:
        -
        T - the type of the annotation
        -
        Parameters:
        -
        annotationType - the class of the annotation type
        -
        Returns:
        -
        the program element annotations of the given annotation type, or an empty collection
        -
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- -
- -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

-
- - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/AnnotatedType.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/AnnotatedType.html deleted file mode 100644 index d453164c01..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/AnnotatedType.html +++ /dev/null @@ -1,400 +0,0 @@ - - - - - -AnnotatedType (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Interface AnnotatedType<X>

-
-
-
-
    -
  • -
    -
    Type Parameters:
    -
    X - the type
    -
    -
    -
    All Superinterfaces:
    -
    Annotated
    -
    -
    -
    public interface AnnotatedType<X>
    -extends Annotated
    -

    - Represents a Java class or interface. -

    -
    -
    Author:
    -
    Gavin King, Pete Muir
    -
    See Also:
    -
    Class
    -
    -
  • -
-
-
- -
-
-
    -
  • - -
    -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        getJavaClass

        -
        java.lang.Class<X> getJavaClass()
        -

        - Get the underlying Class. -

        -
        -
        Returns:
        -
        the Class
        -
        -
      • -
      - - - -
        -
      • -

        getConstructors

        -
        java.util.Set<AnnotatedConstructor<X>> getConstructors()
        -

        - Get the constructors of the type. If an empty set is returned, a default constructor - with no parameters will be assumed. -

        -
        -
        Returns:
        -
        the constructors, or an empty set if none are defined
        -
        -
      • -
      - - - -
        -
      • -

        getMethods

        -
        java.util.Set<AnnotatedMethod<? super X>> getMethods()
        -

        - Get the methods of the type. -

        -
        -
        Returns:
        -
        the methods, or an empty set if none are defined
        -
        -
      • -
      - - - -
        -
      • -

        getFields

        -
        java.util.Set<AnnotatedField<? super X>> getFields()
        -

        - Get the fields of the type. -

        -
        -
        Returns:
        -
        the fields, or an empty set if none are defined
        -
        -
      • -
      - - - -
        -
      • -

        getAnnotations

        -
        default <T extends java.lang.annotation.Annotation> java.util.Set<T> getAnnotations​(java.lang.Class<T> annotationType)
        -
        Description copied from interface: Annotated
        -

        - Get program element annotations of a certain annotation type. -

        - This method returns back all annotations, including repeatable annotations of this type. - - The behavior of this method is intended to be the same behavior as AnnotatedElement.getAnnotationsByType(Class), - where repeatable annotations are supported. -

        -
        -
        Specified by:
        -
        getAnnotations in interface Annotated
        -
        Type Parameters:
        -
        T - the type of the annotation
        -
        Parameters:
        -
        annotationType - the class of the annotation type
        -
        Returns:
        -
        the program element annotations of the given annotation type, or an empty collection
        -
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- -
- -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

-
- - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/Bean.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/Bean.html deleted file mode 100644 index 9be39104f6..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/Bean.html +++ /dev/null @@ -1,323 +0,0 @@ - - - - - -Bean (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Interface Bean<T>

-
-
-
-
    -
  • -
    -
    Type Parameters:
    -
    T - the class of the bean instance
    -
    -
    -
    All Superinterfaces:
    -
    BeanAttributes<T>, Contextual<T>
    -
    -
    -
    All Known Subinterfaces:
    -
    Decorator<T>, Interceptor<T>
    -
    -
    -
    public interface Bean<T>
    -extends Contextual<T>, BeanAttributes<T>
    -

    - Represents an enabled bean. This interface defines everything the container needs to - manage instances of the bean. -

    -
    -
    Author:
    -
    Gavin King, David Allen
    -
    -
  • -
-
-
- -
-
-
    -
  • - -
    -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        getBeanClass

        -
        java.lang.Class<?> getBeanClass()
        -
        The bean class of the managed bean or session bean or of the bean that declares the producer method or - field.
        -
        -
        Returns:
        -
        the bean class
        -
        -
      • -
      - - - -
        -
      • -

        getInjectionPoints

        -
        java.util.Set<InjectionPoint> getInjectionPoints()
        -
        Obtains the InjectionPoint objects representing injection points of the bean, that - will be validated by the container at initialization time.
        -
        -
        Returns:
        -
        the set of injection points of the bean
        -
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- -
- -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

-
- - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/BeanAttributes.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/BeanAttributes.html deleted file mode 100644 index c70c7c7417..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/BeanAttributes.html +++ /dev/null @@ -1,387 +0,0 @@ - - - - - -BeanAttributes (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Interface BeanAttributes<T>

-
-
-
-
    -
  • -
    -
    Type Parameters:
    -
    T - the class of the bean instance
    -
    -
    -
    All Known Subinterfaces:
    -
    Bean<T>, Decorator<T>, Interceptor<T>
    -
    -
    -
    public interface BeanAttributes<T>
    -
    The BeanAttributes interface exposes the basic attributes of a bean.
    -
    -
    Since:
    -
    1.1
    -
    Author:
    -
    Pete Muir
    -
    -
  • -
-
-
-
    -
  • - -
    -
      -
    • - - -

      Method Summary

      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      All Methods Instance Methods Abstract Methods 
      Modifier and TypeMethodDescription
      java.lang.StringgetName() -
      Obtains the EL name of a bean, if it has one.
      -
      java.util.Set<java.lang.annotation.Annotation>getQualifiers() -
      Obtains the qualifiers of the bean.
      -
      java.lang.Class<? extends java.lang.annotation.Annotation>getScope() -
      Obtains the scope of the bean.
      -
      java.util.Set<java.lang.Class<? extends java.lang.annotation.Annotation>>getStereotypes() -
      Obtains the stereotypes of the bean.
      -
      java.util.Set<java.lang.reflect.Type>getTypes() -
      Obtains the bean types of the bean.
      -
      booleanisAlternative() -
      Determines if the bean is an alternative.
      -
      -
    • -
    -
    -
  • -
-
-
-
    -
  • - -
    -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        getTypes

        -
        java.util.Set<java.lang.reflect.Type> getTypes()
        -
        Obtains the bean types of the bean.
        -
        -
        Returns:
        -
        the bean types
        -
        -
      • -
      - - - -
        -
      • -

        getQualifiers

        -
        java.util.Set<java.lang.annotation.Annotation> getQualifiers()
        -
        Obtains the qualifiers of the bean.
        -
        -
        Returns:
        -
        the qualifiers
        -
        -
      • -
      - - - -
        -
      • -

        getScope

        -
        java.lang.Class<? extends java.lang.annotation.Annotation> getScope()
        -
        Obtains the scope of the bean.
        -
        -
        Returns:
        -
        the scope
        -
        -
      • -
      - - - -
        -
      • -

        getName

        -
        java.lang.String getName()
        -
        Obtains the EL name of a bean, if it has one.
        -
        -
        Returns:
        -
        the EL name
        -
        -
      • -
      - - - -
        -
      • -

        getStereotypes

        -
        java.util.Set<java.lang.Class<? extends java.lang.annotation.Annotation>> getStereotypes()
        -
        Obtains the stereotypes of the bean.
        -
        -
        Returns:
        -
        the set of stereotypes
        -
        -
      • -
      - - - -
        -
      • -

        isAlternative

        -
        boolean isAlternative()
        -
        Determines if the bean is an alternative. - - A custom implementation of Bean may implement Prioritized in order to be selected for the application. - Prioritized.getPriority() determines the priority used to resolve ambiguities.
        -
        -
        Returns:
        -
        true if the bean is an alternative, and false - otherwise.
        -
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- -
- -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

-
- - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/BeanContainer.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/BeanContainer.html deleted file mode 100644 index 8a6d0d4c5d..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/BeanContainer.html +++ /dev/null @@ -1,758 +0,0 @@ - - - - - -BeanContainer (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Interface BeanContainer

-
-
-
-
    -
  • -
    -
    All Known Subinterfaces:
    -
    BeanManager
    -
    -
    -
    public interface BeanContainer
    -

    - BeanContainer is a superclass of BeanManager containing capabilities that are portable across - all CDI environments. -

    - -

    - Provides operations for obtaining contextual references for beans, along with many other operations of use to - CDI applications. -

    - -

    - Any bean may obtain an instance of BeanContainer by injecting it: -

    - -
    - @Inject
    - BeanContainer container;
    - 
    -
    -
    Since:
    -
    4.0
    -
    Author:
    -
    Matej Novotny
    -
    -
  • -
-
-
-
    -
  • - -
    -
      -
    • - - -

      Method Summary

      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      All Methods Instance Methods Abstract Methods 
      Modifier and TypeMethodDescription
      <T> CreationalContext<T>createCreationalContext​(Contextual<T> contextual) -
      Obtain an instance of a CreationalContext for the given - contextual type, or for a non-contextual object.
      -
      Instance<java.lang.Object>createInstance() -
      Obtains an Instance object to access to beans instances.
      -
      java.util.Set<Bean<?>>getBeans​(java.lang.reflect.Type beanType, - java.lang.annotation.Annotation... qualifiers) -
      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 BeanManager/BeanContainer was injected or, - in the Jakarta EE environment, the Jakarta EE component from whose JNDI environment namespace the - BeanManager/BeanContainer was obtained, according to the rules of typesafe resolution.
      -
      java.util.Set<Bean<?>>getBeans​(java.lang.String name) -
      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 BeanManager/BeanContainer was injected or, in the Jakarta EE - environment, the Jakarta EE component from whose JNDI environment namespace the - BeanManager/BeanContainer was obtained, according to the rules of EL name resolution.
      -
      ContextgetContext​(java.lang.Class<? extends java.lang.annotation.Annotation> scopeType) -
      Obtains an active context object for the given - scope .
      -
      java.util.Collection<Context>getContexts​(java.lang.Class<? extends java.lang.annotation.Annotation> scopeType) -
      Obtains all context objects, active and inactive, for the given - scope.
      -
      Event<java.lang.Object>getEvent() -
      Returns an instance of Event with specified type java.lang.Object and specified qualifier @Default - It allows typesafe synchronous or asynchronous event firing without injection of Event built-in bean requirement.
      -
      java.lang.ObjectgetReference​(Bean<?> bean, - java.lang.reflect.Type beanType, - CreationalContext<?> ctx) -
      - Obtains a contextual reference for a certain bean and a certain bean type of the bean.
      -
      booleanisInterceptorBinding​(java.lang.Class<? extends java.lang.annotation.Annotation> annotationType) -
      Test the given annotation type to determine if it is an interceptor - binding type .
      -
      booleanisNormalScope​(java.lang.Class<? extends java.lang.annotation.Annotation> annotationType) -
      Test the given annotation type to determine if it is a normal scope type.
      -
      booleanisQualifier​(java.lang.Class<? extends java.lang.annotation.Annotation> annotationType) -
      Test the given annotation type to determine if it is a qualifier type.
      -
      booleanisScope​(java.lang.Class<? extends java.lang.annotation.Annotation> annotationType) -
      Test the given annotation type to determine if it is a scope type.
      -
      booleanisStereotype​(java.lang.Class<? extends java.lang.annotation.Annotation> annotationType) -
      Test the given annotation type to determine if it is a stereotype.
      -
      <X> Bean<? extends X>resolve​(java.util.Set<Bean<? extends X>> beans) -
      Apply the ambiguous dependency resolution rules to a set of beans.
      -
      java.util.List<Interceptor<?>>resolveInterceptors​(InterceptionType type, - java.lang.annotation.Annotation... interceptorBindings) -
      Return an ordered list of enabled 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 - BeanManager/BeanContainer was injected or, in the Jakarta EE environment, - the Jakarta EE component from whose JNDI environment namespace the - BeanManager/BeanContainer was obtained.
      -
      <T> java.util.Set<ObserverMethod<? super T>>resolveObserverMethods​(T event, - java.lang.annotation.Annotation... qualifiers) -
      Return an ordered set of observer methods for an event.
      -
      -
    • -
    -
    -
  • -
-
-
-
    -
  • - -
    -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        getReference

        -
        java.lang.Object getReference​(Bean<?> bean,
        -                              java.lang.reflect.Type beanType,
        -                              CreationalContext<?> ctx)
        -

        - Obtains a contextual reference for a certain bean and a certain bean type of the bean. -

        -
        -
        Parameters:
        -
        bean - the Bean object representing the bean
        -
        beanType - a bean type that must be implemented by any client proxy that is returned
        -
        ctx - a CreationalContext that may be used to destroy any object with scope - Dependent that is created
        -
        Returns:
        -
        a contextual reference representing the bean
        -
        Throws:
        -
        java.lang.IllegalArgumentException - if the given type is not a bean type of the given bean
        -
        java.lang.IllegalStateException - if called during application initialization, before the AfterDeploymentValidation - event is fired.
        -
        -
      • -
      - - - - - - - -
        -
      • -

        getBeans

        -
        java.util.Set<Bean<?>> getBeans​(java.lang.reflect.Type beanType,
        -                                java.lang.annotation.Annotation... qualifiers)
        -
        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 BeanManager/BeanContainer was injected or, - in the Jakarta EE environment, the Jakarta EE component from whose JNDI environment namespace the - BeanManager/BeanContainer was obtained, according to the rules of typesafe resolution. - If no qualifiers are given, the default qualifier is assumed. -

        - Note that when called during invocation of an AfterBeanDiscovery event observer, - this method will only return beans discovered by the container before the AfterBeanDiscovery event is fired.

        -
        -
        Parameters:
        -
        beanType - the required bean type
        -
        qualifiers - the required qualifiers
        -
        Returns:
        -
        the resulting set of beans
        -
        Throws:
        -
        java.lang.IllegalArgumentException - if the given type represents a type variable
        -
        java.lang.IllegalArgumentException - if two instances of the same non repeating qualifier type are given
        -
        java.lang.IllegalArgumentException - if an instance of an annotation that is not a qualifier type is given
        -
        java.lang.IllegalStateException - if called during application initialization, before the AfterBeanDiscovery - event is fired.
        -
        -
      • -
      - - - -
        -
      • -

        getBeans

        -
        java.util.Set<Bean<?>> getBeans​(java.lang.String name)
        -
        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 BeanManager/BeanContainer was injected or, in the Jakarta EE - environment, the Jakarta EE component from whose JNDI environment namespace the - BeanManager/BeanContainer was obtained, according to the rules of EL name resolution. -

        - Note that when called during invocation of an AfterBeanDiscovery event observer, - this method will only return beans discovered by the container before the AfterBeanDiscovery event is fired.

        -
        -
        Parameters:
        -
        name - the EL name
        -
        Returns:
        -
        the resulting set of beans
        -
        Throws:
        -
        java.lang.IllegalStateException - if called during application initialization, before the AfterBeanDiscovery - event is fired.
        -
        -
      • -
      - - - -
        -
      • -

        resolve

        -
        <X> Bean<? extends X> resolve​(java.util.Set<Bean<? extends X>> beans)
        -
        Apply the ambiguous dependency resolution rules to a set of beans. -

        - Note that when called during invocation of an AfterBeanDiscovery event observer, - this method will only return beans discovered by the container before the AfterBeanDiscovery event is fired.

        -
        -
        Type Parameters:
        -
        X - a common type of the beans
        -
        Parameters:
        -
        beans - a set of beans of the given type
        -
        Returns:
        -
        the resolved bean, or null if null or an empty set is passed
        -
        Throws:
        -
        AmbiguousResolutionException - if the ambiguous dependency resolution rules fail
        -
        java.lang.IllegalStateException - if called during application initialization, before the AfterBeanDiscovery - event is fired.
        -
        -
      • -
      - - - - - -
        -
      • -

        resolveObserverMethods

        -
        <T> java.util.Set<ObserverMethod<? super T>> resolveObserverMethods​(T event,
        -                                                                    java.lang.annotation.Annotation... qualifiers)
        -
        Return an ordered set of observer methods for an event. -

        - Note that when called during invocation of an AfterBeanDiscovery event observer, - this method will only return observers discovered by the container before the AfterBeanDiscovery event is fired.

        -
        -
        Type Parameters:
        -
        T - the type of the event
        -
        Parameters:
        -
        event - the event object
        -
        qualifiers - the event qualifiers
        -
        Returns:
        -
        the resulting set of observer methods
        -
        Throws:
        -
        java.lang.IllegalArgumentException - if the runtime type of the event object contains a type variable
        -
        java.lang.IllegalArgumentException - if two instances of the same non repeating qualifier type are given
        -
        java.lang.IllegalArgumentException - if an instance of an annotation that is not a qualifier type is given
        -
        java.lang.IllegalStateException - if called during application initialization, before the AfterBeanDiscovery - event is fired.
        -
        -
      • -
      - - - -
        -
      • -

        resolveInterceptors

        -
        java.util.List<Interceptor<?>> resolveInterceptors​(InterceptionType type,
        -                                                   java.lang.annotation.Annotation... interceptorBindings)
        -
        Return an ordered list of enabled 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 - BeanManager/BeanContainer was injected or, in the Jakarta EE environment, - the Jakarta EE component from whose JNDI environment namespace the - BeanManager/BeanContainer was obtained. -

        - Note that when called during invocation of an AfterBeanDiscovery event observer, - this method will only return interceptors discovered by the container before the AfterBeanDiscovery event is - fired.

        -
        -
        Parameters:
        -
        type - the type of the interception
        -
        interceptorBindings - the interceptor bindings
        -
        Returns:
        -
        the resulting set of interceptors
        -
        Throws:
        -
        java.lang.IllegalArgumentException - if no interceptor binding type is given
        -
        java.lang.IllegalArgumentException - if two instances of the same interceptor binding type are given
        -
        java.lang.IllegalArgumentException - if an instance of an annotation that is not an interceptor binding type is given
        -
        java.lang.IllegalStateException - if called during application initialization, before the AfterBeanDiscovery - event is fired.
        -
        -
      • -
      - - - -
        -
      • -

        isScope

        -
        boolean isScope​(java.lang.Class<? extends java.lang.annotation.Annotation> annotationType)
        -
        Test the given annotation type to determine if it is a scope type.
        -
        -
        Parameters:
        -
        annotationType - the annotation type
        -
        Returns:
        -
        true if the annotation type is a scope type
        -
        -
      • -
      - - - -
        -
      • -

        isNormalScope

        -
        boolean isNormalScope​(java.lang.Class<? extends java.lang.annotation.Annotation> annotationType)
        -
        Test the given annotation type to determine if it is a normal scope type.
        -
        -
        Parameters:
        -
        annotationType - the annotation type
        -
        Returns:
        -
        true if the annotation type is a normal scope type
        -
        -
      • -
      - - - -
        -
      • -

        isQualifier

        -
        boolean isQualifier​(java.lang.Class<? extends java.lang.annotation.Annotation> annotationType)
        -
        Test the given annotation type to determine if it is a qualifier type.
        -
        -
        Parameters:
        -
        annotationType - the annotation type
        -
        Returns:
        -
        true if the annotation type is a qualifier type
        -
        -
      • -
      - - - -
        -
      • -

        isStereotype

        -
        boolean isStereotype​(java.lang.Class<? extends java.lang.annotation.Annotation> annotationType)
        -
        Test the given annotation type to determine if it is a stereotype.
        -
        -
        Parameters:
        -
        annotationType - the annotation type
        -
        Returns:
        -
        true if the annotation type is a stereotype
        -
        -
      • -
      - - - -
        -
      • -

        isInterceptorBinding

        -
        boolean isInterceptorBinding​(java.lang.Class<? extends java.lang.annotation.Annotation> annotationType)
        -
        Test the given annotation type to determine if it is an interceptor - binding type .
        -
        -
        Parameters:
        -
        annotationType - the annotation to test
        -
        Returns:
        -
        true if the annotation type is a interceptor binding - type
        -
        -
      • -
      - - - -
        -
      • -

        getContext

        -
        Context getContext​(java.lang.Class<? extends java.lang.annotation.Annotation> scopeType)
        -
        Obtains an active context object for the given - scope .
        -
        -
        Parameters:
        -
        scopeType - the scope
        -
        Returns:
        -
        the context object
        -
        Throws:
        -
        ContextNotActiveException - if there is no active context object for the given scope
        -
        java.lang.IllegalArgumentException - if there is more than one active context object for the given scope
        -
        -
      • -
      - - - -
        -
      • -

        getContexts

        -
        java.util.Collection<Context> getContexts​(java.lang.Class<? extends java.lang.annotation.Annotation> scopeType)
        -
        Obtains all context objects, active and inactive, for the given - scope.
        -
        -
        Parameters:
        -
        scopeType - the scope; must not be null
        -
        Returns:
        -
        immutable collection of context objects; never null, but may be empty
        -
        -
      • -
      - - - -
        -
      • -

        getEvent

        -
        Event<java.lang.Object> getEvent()
        -
        Returns an instance of Event with specified type java.lang.Object and specified qualifier @Default - It allows typesafe synchronous or asynchronous event firing without injection of Event built-in bean requirement.
        -
        -
        Returns:
        -
        a new Event object whose event type is Object and qualifier @Default
        -
        Since:
        -
        2.0
        -
        -
      • -
      - - - -
        -
      • -

        createInstance

        -
        Instance<java.lang.Object> createInstance()
        -
        Obtains an Instance object to access to beans instances. -

        - The returned Instance object can only access instances of beans that are available for injection in the module - or library containing the class into which the BeanManager/BeanContainer was injected - or, in the Jakarta EE environment, the Jakarta EE component from whose JNDI environment namespace the - BeanContainer was obtained, according to the rules of typesafe resolution. -

        - Instances of dependent scoped beans obtained with this Instance must be explicitly destroyed by calling Instance.destroy(Object) -

        - If no qualifier is passed to Instance.select(java.lang.annotation.Annotation...) method, the @Default qualifier is assumed.

        -
        -
        Returns:
        -
        an Instance object to request beans instances
        -
        Throws:
        -
        java.lang.IllegalStateException - if called during application initialization, before the AfterDeploymentValidation - event is fired.
        -
        Since:
        -
        2.0
        -
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- -
- -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

-
- - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/BeanManager.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/BeanManager.html deleted file mode 100644 index aeb8c51dc3..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/BeanManager.html +++ /dev/null @@ -1,1087 +0,0 @@ - - - - - -BeanManager (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Interface BeanManager

-
-
-
- -
-
- -
-
-
    -
  • - -
    -
      -
    • - - -

      Method Detail

      - - - - - - - -
        -
      • -

        getPassivationCapableBean

        -
        Bean<?> getPassivationCapableBean​(java.lang.String id)
        -
        Returns the PassivationCapable bean with the given identifier. - - Note that when called during invocation of an AfterBeanDiscovery event observer, - this method will only return beans discovered by the container before the AfterBeanDiscovery event is fired.
        -
        -
        Parameters:
        -
        id - the identifier
        -
        Returns:
        -
        a Bean that implements PassivationCapable and has the given - identifier, or a null value if there is no such bean
        -
        Throws:
        -
        java.lang.IllegalStateException - if called during application initialization, before the AfterBeanDiscovery - event is fired.
        -
        -
      • -
      - - - -
        -
      • -

        validate

        -
        void validate​(InjectionPoint injectionPoint)
        -
        Validate a certain injection point. - - Note that when called during invocation of an AfterBeanDiscovery event observer, - this method will only validate injection points discovered by the container before the AfterBeanDiscovery - event is fired.
        -
        -
        Parameters:
        -
        injectionPoint - the injection point to validate
        -
        Throws:
        -
        InjectionException - if there is a deployment problem (for example, an unsatisfied or unresolvable ambiguous - dependency) associated with the injection point
        -
        java.lang.IllegalStateException - if called during application initialization, before the AfterBeanDiscovery - event is fired.
        -
        -
      • -
      - - - -
        -
      • -

        resolveDecorators

        -
        java.util.List<Decorator<?>> resolveDecorators​(java.util.Set<java.lang.reflect.Type> types,
        -                                               java.lang.annotation.Annotation... qualifiers)
        -
        Return an ordered list of 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 BeanManager was injected or the Java EE - component from whose JNDI environment namespace the BeanManager was obtained. - - Note that when called during invocation of an AfterBeanDiscovery event observer, - this method will only return decorators discovered by the container before the AfterBeanDiscovery event is fired.
        -
        -
        Parameters:
        -
        types - the set of bean types of the decorated bean
        -
        qualifiers - the qualifiers declared by the decorated bean
        -
        Returns:
        -
        the resulting set of decorators
        -
        Throws:
        -
        java.lang.IllegalArgumentException - if the set of bean types is empty
        -
        java.lang.IllegalArgumentException - if an annotation which is not a binding type is passed
        -
        java.lang.IllegalArgumentException - if two instances of the same binding type are passed
        -
        java.lang.IllegalStateException - if called during application initialization, before the AfterBeanDiscovery - event is fired.
        -
        -
      • -
      - - - -
        -
      • -

        isPassivatingScope

        -
        boolean isPassivatingScope​(java.lang.Class<? extends java.lang.annotation.Annotation> annotationType)
        -
        Test the given annotation type to determine if it is a passivating scope type.
        -
        -
        Parameters:
        -
        annotationType - the annotation type
        -
        Returns:
        -
        true if the annotation type is a passivating scope type
        -
        -
      • -
      - - - -
        -
      • -

        getInterceptorBindingDefinition

        -
        java.util.Set<java.lang.annotation.Annotation> getInterceptorBindingDefinition​(java.lang.Class<? extends java.lang.annotation.Annotation> bindingType)
        -
        Obtains the set of meta-annotations for a certain interceptor binding - type .
        -
        -
        Parameters:
        -
        bindingType - the interceptor binding type
        -
        Returns:
        -
        the set of meta-annotations
        -
        -
      • -
      - - - -
        -
      • -

        getStereotypeDefinition

        -
        java.util.Set<java.lang.annotation.Annotation> getStereotypeDefinition​(java.lang.Class<? extends java.lang.annotation.Annotation> stereotype)
        -
        Obtains meta-annotations for a certain stereotype.
        -
        -
        Parameters:
        -
        stereotype - the stereotype
        -
        Returns:
        -
        the set of meta-annotations
        -
        -
      • -
      - - - -
        -
      • -

        areQualifiersEquivalent

        -
        boolean areQualifiersEquivalent​(java.lang.annotation.Annotation qualifier1,
        -                                java.lang.annotation.Annotation qualifier2)
        -
        Determine if two qualifiers are considered equivalent for the purposes of typesafe resolution, taking into account any - members annotated with Nonbinding.
        -
        -
        Parameters:
        -
        qualifier1 - a qualifier to check
        -
        qualifier2 - a qualifier to check
        -
        Returns:
        -
        true if the two qualifiers are equivalent, otherwise false
        -
        Since:
        -
        1.1
        -
        -
      • -
      - - - -
        -
      • -

        areInterceptorBindingsEquivalent

        -
        boolean areInterceptorBindingsEquivalent​(java.lang.annotation.Annotation interceptorBinding1,
        -                                         java.lang.annotation.Annotation interceptorBinding2)
        -
        Determine if two interceptor bindings are considered equivalent for the purposes of typesafe resolution, taking into - account any members annotated with Nonbinding.
        -
        -
        Parameters:
        -
        interceptorBinding1 - an interceptor binding to check
        -
        interceptorBinding2 - an interceptor binding to check
        -
        Returns:
        -
        true if the two interceptor bindings are equivalent, otherwise false
        -
        Since:
        -
        1.1
        -
        -
      • -
      - - - -
        -
      • -

        getQualifierHashCode

        -
        int getQualifierHashCode​(java.lang.annotation.Annotation qualifier)
        -
        Determine the hash code of a qualifier, using the JDK algorithm for determining an annotation hash code, ignoring any - members annotated with Nonbinding.
        -
        -
        Parameters:
        -
        qualifier - the qualifier to consider
        -
        Returns:
        -
        the hashCode for the qualifier
        -
        Since:
        -
        1.1
        -
        -
      • -
      - - - -
        -
      • -

        getInterceptorBindingHashCode

        -
        int getInterceptorBindingHashCode​(java.lang.annotation.Annotation interceptorBinding)
        -
        Determine the hash code of an interceptor binding, using the JDK algorithm for determining an annotation hash code, - ignoring any members annotated with Nonbinding.
        -
        -
        Parameters:
        -
        interceptorBinding - the interceptor binding to consider
        -
        Returns:
        -
        the hashCode for the interceptor binding
        -
        Since:
        -
        1.1
        -
        -
      • -
      - - - -
        -
      • -

        getELResolver

        -
        @Deprecated(since="4.1",
        -            forRemoval=true)
        -jakarta.el.ELResolver getELResolver()
        -
        Deprecated, for removal: This API element is subject to removal in a future version. -
        use ELAwareBeanManager, this method will be removed in CDI 5.0
        -
        -
        Returns a ELResolver that resolves beans by EL name.
        -
        -
        Returns:
        -
        the ELResolver
        -
        -
      • -
      - - - -
        -
      • -

        wrapExpressionFactory

        -
        @Deprecated(since="4.1",
        -            forRemoval=true)
        -jakarta.el.ExpressionFactory wrapExpressionFactory​(jakarta.el.ExpressionFactory expressionFactory)
        -
        Deprecated, for removal: This API element is subject to removal in a future version. -
        use ELAwareBeanManager, this method will be removed in CDI 5.0
        -
        -
        Returns a wrapper ExpressionFactory that delegates MethodExpression and - ValueExpression creation to the given ExpressionFactory. When a Unified EL expression - is evaluated using a MethodExpression or ValueExpression returned by the wrapper - ExpressionFactory, the container handles destruction of objects with scope - Dependent.
        -
        -
        Parameters:
        -
        expressionFactory - the ExpressionFactory to wrap
        -
        Returns:
        -
        the wrapped ExpressionFactory
        -
        -
      • -
      - - - -
        -
      • -

        createAnnotatedType

        -
        <T> AnnotatedType<T> createAnnotatedType​(java.lang.Class<T> type)
        -
        Obtain an AnnotatedType that may be used to read the annotations of the given class or interface.
        -
        -
        Type Parameters:
        -
        T - the class or interface
        -
        Parameters:
        -
        type - the Class object
        -
        Returns:
        -
        the AnnotatedType
        -
        -
      • -
      - - - -
        -
      • -

        getInjectionTargetFactory

        -
        <T> InjectionTargetFactory<T> getInjectionTargetFactory​(AnnotatedType<T> annotatedType)
        -

        - An implementation of InjectionTargetFactory that provides container created InjectionTarget instances. -

        - -

        - This factory can be wrapped to add behavior to container created injection targets. -

        -
        -
        Type Parameters:
        -
        T - the type
        -
        Parameters:
        -
        annotatedType - the annotated type to create the injection target factory for
        -
        Returns:
        -
        an InjectionTargetFactory
        -
        Since:
        -
        1.1
        -
        -
      • -
      - - - -
        -
      • -

        getProducerFactory

        -
        <X> ProducerFactory<X> getProducerFactory​(AnnotatedField<? super X> field,
        -                                          Bean<X> declaringBean)
        -

        - An implementation of ProducerFactory that provides container created Producer instances for the given - field. -

        - -

        - This factory can be wrapped to add behavior to container created producers. -

        -
        -
        Type Parameters:
        -
        X - the declaring type
        -
        Parameters:
        -
        field - the field to create the producer factory for
        -
        declaringBean - the bean declaring the producer. May be null if the producer is static or the declaring object is - non-contextual
        -
        Returns:
        -
        the producer factory for the field
        -
        Since:
        -
        1.1
        -
        -
      • -
      - - - -
        -
      • -

        getProducerFactory

        -
        <X> ProducerFactory<X> getProducerFactory​(AnnotatedMethod<? super X> method,
        -                                          Bean<X> declaringBean)
        -

        - An implementation of ProducerFactory that provides container created Producer instances for the given - method. -

        - -

        - This factory can be wrapped to add behavior to container created producers. -

        -
        -
        Type Parameters:
        -
        X - bean type
        -
        Parameters:
        -
        method - the method to create the producer factory for
        -
        declaringBean - the bean declaring the producer. May be null if the producer is static or the declaring object is - non-contextual
        -
        Returns:
        -
        the producer factory for the method
        -
        Since:
        -
        1.1
        -
        -
      • -
      - - - -
        -
      • -

        createBeanAttributes

        -
        <T> BeanAttributes<T> createBeanAttributes​(AnnotatedType<T> type)
        -
        Obtains a BeanAttributes for the given AnnotatedType. The container ignores the annotations and types - declared by the elements of the actual Java class and uses the metadata provided via the Annotated interface - instead.
        -
        -
        Type Parameters:
        -
        T - the type
        -
        Parameters:
        -
        type - the AnnotatedType
        -
        Returns:
        -
        a container provided implementation of InjectionTarget
        -
        Since:
        -
        1.1
        -
        -
      • -
      - - - - - - - - - - - - - - - -
        -
      • -

        createInjectionPoint

        -
        InjectionPoint createInjectionPoint​(AnnotatedField<?> field)
        -
        Obtains a container provided implementation of InjectionPoint for the given AnnotatedField.
        -
        -
        Parameters:
        -
        field - the AnnotatedField defining the injection point
        -
        Returns:
        -
        the container provided InjectionPoint
        -
        Throws:
        -
        java.lang.IllegalArgumentException - if there is a definition error associated with the injection point
        -
        Since:
        -
        1.1
        -
        -
      • -
      - - - - - - - -
        -
      • -

        getExtension

        -
        <T extends Extension> T getExtension​(java.lang.Class<T> extensionClass)
        -
        Obtains the container's instance of an Extension class declared in META-INF/services.
        -
        -
        Type Parameters:
        -
        T - the type of the extension
        -
        Parameters:
        -
        extensionClass - the type of the extension class
        -
        Returns:
        -
        the extension instance
        -
        Throws:
        -
        java.lang.IllegalArgumentException - if the container has no instance of the given class
        -
        Since:
        -
        1.1
        -
        -
      • -
      - - - - -
    • -
    -
    -
  • -
-
-
-
- -
- -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

-
- - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/BeforeBeanDiscovery.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/BeforeBeanDiscovery.html deleted file mode 100644 index 6044ddda4f..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/BeforeBeanDiscovery.html +++ /dev/null @@ -1,630 +0,0 @@ - - - - - -BeforeBeanDiscovery (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Interface BeforeBeanDiscovery

-
-
-
-
    -
  • -
    -
    public interface BeforeBeanDiscovery
    -

    - This event type is thrown by the container before the bean discovery process begins. If any observer method of the - BeforeBeanDiscovery event throws an exception, the exception is treated as a definition error by the container. -

    - -

    CDI Lite implementations are not required to provide support for Portable Extensions.

    -
    -
    Author:
    -
    Pete Muir, David Allen, Antoine Sabot-Durand
    -
    -
  • -
-
-
- -
-
-
    -
  • - -
    -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        addQualifier

        -
        void addQualifier​(java.lang.Class<? extends java.lang.annotation.Annotation> qualifier)
        -

        - Declares an annotation type as a Qualifier qualifier type. -

        - -

        - This is only required if you wish to make an annotation a qualifier without adding Qualifier to it. -

        -
        -
        Parameters:
        -
        qualifier - The annotation to treat as a qualifier
        -
        Throws:
        -
        java.lang.IllegalStateException - if called outside of the observer method invocation
        -
        -
      • -
      - - - -
        -
      • -

        addQualifier

        -
        void addQualifier​(AnnotatedType<? extends java.lang.annotation.Annotation> qualifier)
        -

        - Declares an annotation type as a Qualifier qualifier type. -

        - -

        - This is only required if you wish to make an annotation a qualifier without adding Qualifier to it. -

        -
        -
        Parameters:
        -
        qualifier - The annotation to treat as a qualifier
        -
        Throws:
        -
        java.lang.IllegalStateException - if called outside of the observer method invocation
        -
        Since:
        -
        1.1
        -
        -
      • -
      - - - -
        -
      • -

        addScope

        -
        void addScope​(java.lang.Class<? extends java.lang.annotation.Annotation> scopeType,
        -              boolean normal,
        -              boolean passivating)
        -

        - Declares an annotation type as a scope type. -

        - -

        - This is only required if you wish to make an annotation a scope type without adding the NormalScope or - Scope annotations to it. You can also use this method to override an existing normal scope definition. -

        -
        -
        Parameters:
        -
        scopeType - The annotation type to treat as a scope type
        -
        normal - Indicates if the scope is normal
        -
        passivating - Indicates if the scope is passivation - capable
        -
        Throws:
        -
        java.lang.IllegalStateException - if called outside of the observer method invocation
        -
        See Also:
        -
        AfterBeanDiscovery.addContext(Context)
        -
        -
      • -
      - - - -
        -
      • -

        addStereotype

        -
        void addStereotype​(java.lang.Class<? extends java.lang.annotation.Annotation> stereotype,
        -                   java.lang.annotation.Annotation... stereotypeDef)
        -

        - Declares an annotation type as a stereotype, and specifies its - meta-annotations. -

        - -

        - This is only required if you wish to make an annotation a stereotype without adding Stereotype to it. You can - also use this method to override an existing stereotype definition. -

        -
        -
        Parameters:
        -
        stereotype - The annotation type to treat as a stereotype
        -
        stereotypeDef - An optional list of annotations defining the stereotype
        -
        Throws:
        -
        java.lang.IllegalStateException - if called outside of the observer method invocation
        -
        -
      • -
      - - - -
        -
      • -

        addInterceptorBinding

        -
        void addInterceptorBinding​(AnnotatedType<? extends java.lang.annotation.Annotation> bindingType)
        -

        - Declares an annotation type as an interceptor binding type. -

        - -

        - This is only required if you wish to make an annotation an interceptor binding type without adding - InterceptorBinding to it. -

        -
        -
        Parameters:
        -
        bindingType - The annotation type to treat as an interceptor binding type
        -
        Throws:
        -
        java.lang.IllegalStateException - if called outside of the observer method invocation
        -
        -
      • -
      - - - -
        -
      • -

        addInterceptorBinding

        -
        void addInterceptorBinding​(java.lang.Class<? extends java.lang.annotation.Annotation> bindingType,
        -                           java.lang.annotation.Annotation... bindingTypeDef)
        -

        - Declares an annotation type as an interceptor binding type, and specifies its meta-annotations. -

        - -

        - This is only required if you wish to make an annotation an interceptor binding type without adding - InterceptorBinding to it. -

        -
        -
        Parameters:
        -
        bindingType - The annotation type to treat as an interceptor binding type
        -
        bindingTypeDef - An optional list of annotations defining the interceptor
        -
        Throws:
        -
        java.lang.IllegalStateException - if called outside of the observer method invocation
        -
        Since:
        -
        1.1
        -
        -
      • -
      - - - -
        -
      • -

        addAnnotatedType

        -
        void addAnnotatedType​(AnnotatedType<?> type,
        -                      java.lang.String id)
        -

        - Adds a given AnnotatedType to the set of types which will be scanned during bean - discovery. -

        - -

        - Thanks to the id parameter, this method allows multiple annotated types, based on the same underlying type, to be defined. AnnotatedTypes - discovered by the container use the fully qualified class name of AnnotatedType.getJavaClass() to identify the - type. -

        - -

        - AfterBeanDiscovery.getAnnotatedType(Class, String) and AfterBeanDiscovery.getAnnotatedTypes(Class) allows - annotated types to be obtained by identifier. -

        -
        -
        Parameters:
        -
        type - The AnnotatedType to add for later scanning
        -
        id - the identifier used to distinguish this AnnotatedType from an other one based on the same underlying type
        -
        Throws:
        -
        java.lang.IllegalStateException - if called outside of the observer method invocation
        -
        Since:
        -
        1.1
        -
        -
      • -
      - - - -
        -
      • -

        addAnnotatedType

        -
        <T> AnnotatedTypeConfigurator<T> addAnnotatedType​(java.lang.Class<T> type,
        -                                                  java.lang.String id)
        -

        - Obtains a new AnnotatedTypeConfigurator to configure a new AnnotatedType and - add it to the set of types which will be scanned during bean discovery at the end of the observer invocation -

        - -

        - Thanks to the id parameter, this method allows multiple annotated types, based on the same underlying type, to be defined with a builder. - AnnotatedTypes discovered by the container use the fully qualified class name of - AnnotatedType.getJavaClass() to identify the type. -

        - -

        - AfterBeanDiscovery.getAnnotatedType(Class, String) and AfterBeanDiscovery.getAnnotatedTypes(Class) allows - annotated types to be obtained by identifier. -

        - - Each call returns a new AnnotatedTypeConfigurator
        -
        -
        Type Parameters:
        -
        T - class type
        -
        Parameters:
        -
        type - class used to initialized the type and annotations on the AnnotatedTypeConfigurator
        -
        id - the identifier used to distinguish this AnnotatedType from an other one based on the same underlying type
        -
        Returns:
        -
        a non reusable AnnotatedTypeConfigurator to configure the new AnnotatedType
        -
        Throws:
        -
        java.lang.IllegalStateException - if called outside of the observer method invocation
        -
        Since:
        -
        2.0
        -
        -
      • -
      - - - -
        -
      • -

        configureQualifier

        -
        <T extends java.lang.annotation.Annotation> AnnotatedTypeConfigurator<T> configureQualifier​(java.lang.Class<T> qualifier)
        -

        - Obtains a new AnnotatedTypeConfigurator to configure a new AnnotatedType - and declares it as a Qualifier qualifier type. -

        - -

        - This is only required if you wish to make an annotation a qualifier without adding Qualifier to it and need to - easily add other annotations (like Nonbinding on its members. -

        -
        -
        Type Parameters:
        -
        T - qualifier type
        -
        Parameters:
        -
        qualifier - The annotation class used to initialized the configurator
        -
        Returns:
        -
        a non reusable AnnotatedTypeConfigurator to configure the qualifier
        -
        Throws:
        -
        java.lang.IllegalStateException - if called outside of the observer method invocation
        -
        Since:
        -
        2.0
        -
        -
      • -
      - - - -
        -
      • -

        configureInterceptorBinding

        -
        <T extends java.lang.annotation.Annotation> AnnotatedTypeConfigurator<T> configureInterceptorBinding​(java.lang.Class<T> bindingType)
        -

        - Obtains a new AnnotatedTypeConfigurator to configure a new AnnotatedType - and declares it as an interceptor binding type. -

        - -

        - This is only required if you wish to make an annotation an interceptor binding type without adding - InterceptorBinding to it and need to easily add other annotations - (like Nonbinding on its members. -

        -
        -
        Type Parameters:
        -
        T - binding class type
        -
        Parameters:
        -
        bindingType - The annotation class used to initialized the configurator
        -
        Returns:
        -
        a non reusable AnnotatedTypeConfigurator to configure the interceptor binding
        -
        Throws:
        -
        java.lang.IllegalStateException - if called outside of the observer method invocation
        -
        Since:
        -
        2.0
        -
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- -
- -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

-
- - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/BeforeShutdown.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/BeforeShutdown.html deleted file mode 100644 index 00a56d3a76..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/BeforeShutdown.html +++ /dev/null @@ -1,206 +0,0 @@ - - - - - -BeforeShutdown (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Interface BeforeShutdown

-
-
-
-
    -
  • -
    -
    public interface BeforeShutdown
    -

    - 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 BeforeShutdown event throws an exception, the exception is ignored by the container. -

    - -

    CDI Lite implementations are not required to provide support for Portable Extensions.

    -
    -
    Author:
    -
    David Allen
    -
    -
  • -
-
-
-
- -
- -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

-
- - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/CDI.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/CDI.html deleted file mode 100644 index 3928d479de..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/CDI.html +++ /dev/null @@ -1,518 +0,0 @@ - - - - - -CDI (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Class CDI<T>

-
-
-
    -
  • java.lang.Object
  • -
  • -
      -
    • jakarta.enterprise.inject.spi.CDI<T>
    • -
    -
  • -
-
-
    -
  • -
    -
    Type Parameters:
    -
    T - type inherited from Instance. Always Object for CDI
    -
    -
    -
    All Implemented Interfaces:
    -
    Instance<T>, jakarta.inject.Provider<T>, java.lang.Iterable<T>
    -
    -
    -
    public abstract class CDI<T>
    -extends java.lang.Object
    -implements Instance<T>
    -
    Provides access to the current container. - -

    - CDI implements Instance and therefore might be used to perform programmatic lookup. - If no qualifier is passed to Instance.select(java.lang.annotation.Annotation...) method, the @Default qualifier is assumed. -

    -
    -
    Since:
    -
    1.1
    -
    Author:
    -
    Pete Muir, Antoine Sabot-Durand, John D. Ament
    -
    -
  • -
-
-
- -
-
-
    -
  • - -
    -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        discoveredProviders

        -
        protected static volatile java.util.Set<CDIProvider> discoveredProviders
        -
      • -
      - - - -
        -
      • -

        configuredProvider

        -
        protected static volatile CDIProvider configuredProvider
        -
      • -
      -
    • -
    -
    - -
    -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        CDI

        -
        public CDI()
        -
      • -
      -
    • -
    -
    - -
    -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        current

        -
        public static CDI<java.lang.Object> current()
        -

        - Get the CDI instance that provides access to the current container. -

        - -

        - If there are no providers available, an IllegalStateException is thrown, otherwise the first provider which can - access the container is used. -

        -
        -
        Returns:
        -
        the CDI instance
        -
        Throws:
        -
        java.lang.IllegalStateException - if no CDIProvider is available
        -
        -
      • -
      - - - -
        -
      • -

        setCDIProvider

        -
        public static void setCDIProvider​(CDIProvider provider)
        -

        - Set the CDIProvider to use. -

        - -

        - If a CDIProvider is set using this method, any provider specified as a service provider will not be used. -

        -
        -
        Parameters:
        -
        provider - the provider to use
        -
        Throws:
        -
        java.lang.IllegalArgumentException - if the provided argument is null
        -
        -
      • -
      - - - -
        -
      • -

        getBeanManager

        -
        public abstract BeanManager getBeanManager()
        -
        Get the CDI BeanManager for the current context
        -
        -
        Returns:
        -
        the BeanManager
        -
        -
      • -
      - - - - -
    • -
    -
    -
  • -
-
-
-
- - - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/CDIProvider.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/CDIProvider.html deleted file mode 100644 index 00aaf26f30..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/CDIProvider.html +++ /dev/null @@ -1,350 +0,0 @@ - - - - - -CDIProvider (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Interface CDIProvider

-
-
-
-
    -
  • -
    -
    All Superinterfaces:
    -
    Prioritized
    -
    -
    -
    public interface CDIProvider
    -extends Prioritized
    -
    Interface implemented by a CDI provider to provide access to the current container
    -
    -
    Since:
    -
    1.1
    -
    Author:
    -
    Pete Muir
    -
    -
  • -
-
-
- -
-
-
    -
  • - -
    -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        DEFAULT_CDI_PROVIDER_PRIORITY

        -
        static final int DEFAULT_CDI_PROVIDER_PRIORITY
        -
        -
        See Also:
        -
        Constant Field Values
        -
        -
      • -
      -
    • -
    -
    - -
    -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        getCDI

        -
        CDI<java.lang.Object> getCDI()
        -
        Provides access to the current container
        -
        -
        Returns:
        -
        the CDI instance for the current container
        -
        Throws:
        -
        java.lang.IllegalStateException - if no CDI container is available
        -
        -
      • -
      - - - -
        -
      • -

        getPriority

        -
        default int getPriority()
        -
        Description copied from interface: Prioritized
        -

        - Returns the priority for this SPI element. -

        -
        -
        Specified by:
        -
        getPriority in interface Prioritized
        -
        Returns:
        -
        the priority value
        -
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- - - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/Decorator.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/Decorator.html deleted file mode 100644 index 4344b4e90f..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/Decorator.html +++ /dev/null @@ -1,359 +0,0 @@ - - - - - -Decorator (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Interface Decorator<T>

-
-
-
-
    -
  • -
    -
    Type Parameters:
    -
    T - the decorator bean class
    -
    -
    -
    All Superinterfaces:
    -
    Bean<T>, BeanAttributes<T>, Contextual<T>
    -
    -
    -
    public interface Decorator<T>
    -extends Bean<T>
    -

    - Represents an enabled decorator. -

    -

    - Since CDI 2.0, an implementation of this interface may implement Prioritized in order to enable the decorator with - given priority value for entire application. -

    - -

    CDI Lite implementations are not required to provide support for decorators.

    -
    -
    Author:
    -
    Gavin King, Pete Muir
    -
    -
  • -
-
-
- -
-
-
    -
  • - -
    -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        getDelegateType

        -
        java.lang.reflect.Type getDelegateType()
        -

        - Obtains the type of the delegate injection point. -

        -
        -
        Returns:
        -
        the delegate type
        -
        -
      • -
      - - - -
        -
      • -

        getDelegateQualifiers

        -
        java.util.Set<java.lang.annotation.Annotation> getDelegateQualifiers()
        -

        - Obtains the qualifiers of the delegate injection - point. -

        -
        -
        Returns:
        -
        the delegate qualifiers
        -
        -
      • -
      - - - -
        -
      • -

        getDecoratedTypes

        -
        java.util.Set<java.lang.reflect.Type> getDecoratedTypes()
        -

        - Obtains the decorated types. -

        -
        -
        Returns:
        -
        the set of decorated types
        -
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- -
- -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

-
- - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/DefinitionException.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/DefinitionException.html deleted file mode 100644 index 299bdfa142..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/DefinitionException.html +++ /dev/null @@ -1,354 +0,0 @@ - - - - - -DefinitionException (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Class DefinitionException

-
-
-
    -
  • java.lang.Object
  • -
  • -
      -
    • java.lang.Throwable
    • -
    • -
        -
      • java.lang.Exception
      • -
      • -
          -
        • java.lang.RuntimeException
        • -
        • -
            -
          • jakarta.enterprise.inject.spi.DefinitionException
          • -
          -
        • -
        -
      • -
      -
    • -
    -
  • -
-
-
    -
  • -
    -
    All Implemented Interfaces:
    -
    java.io.Serializable
    -
    -
    -
    public class DefinitionException
    -extends java.lang.RuntimeException
    -

    - Thrown when a definition error occurs. -

    - -

    - Definition errors are developer errors. They may be detected by tooling at development time, and are also detected by the - container at initialization time. If a definition error exists in a deployment, initialization will be aborted by the - container. -

    - -

    - The container is permitted to define a non-portable mode, for use at development time, in which some definition errors do not - cause application initialization to abort. -

    - -

    - An implementation is permitted to throw a subclass of DefinitionException for any definition error which exists. -

    -
    -
    Since:
    -
    1.1
    -
    Author:
    -
    Pete Muir
    -
    See Also:
    -
    Serialized Form
    -
    -
  • -
-
-
-
    -
  • - -
    - -
    - -
    -
      -
    • - - -

      Method Summary

      -
        -
      • - - -

        Methods inherited from class java.lang.Throwable

        -addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
      • -
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

        -clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
      • -
      -
    • -
    -
    -
  • -
-
-
-
    -
  • - -
    -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        DefinitionException

        -
        public DefinitionException​(java.lang.String message,
        -                           java.lang.Throwable t)
        -
      • -
      - - - -
        -
      • -

        DefinitionException

        -
        public DefinitionException​(java.lang.String message)
        -
      • -
      - - - -
        -
      • -

        DefinitionException

        -
        public DefinitionException​(java.lang.Throwable t)
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- - - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/DeploymentException.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/DeploymentException.html deleted file mode 100644 index 2a71dfb948..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/DeploymentException.html +++ /dev/null @@ -1,353 +0,0 @@ - - - - - -DeploymentException (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Class DeploymentException

-
-
-
    -
  • java.lang.Object
  • -
  • -
      -
    • java.lang.Throwable
    • -
    • -
        -
      • java.lang.Exception
      • -
      • -
          -
        • java.lang.RuntimeException
        • -
        • -
            -
          • jakarta.enterprise.inject.spi.DeploymentException
          • -
          -
        • -
        -
      • -
      -
    • -
    -
  • -
-
-
    -
  • -
    -
    All Implemented Interfaces:
    -
    java.io.Serializable
    -
    -
    -
    public class DeploymentException
    -extends java.lang.RuntimeException
    -

    - Thrown when a deployment problem occurs. -

    - -

    - Deployment problems are detected by the container at initialization time. If a deployment problem exists in a deployment, - initialization will be aborted by the container. -

    - -

    - The container is permitted to define a non-portable mode, for use at development time, in which some deployment problems do - not cause application initialization to abort. -

    - -

    - An implementation is permitted to throw a subclass of DeploymentException for any deployment problem. -

    -
    -
    Since:
    -
    1.1
    -
    Author:
    -
    Pete Muir
    -
    See Also:
    -
    Serialized Form
    -
    -
  • -
-
-
-
    -
  • - -
    - -
    - -
    -
      -
    • - - -

      Method Summary

      -
        -
      • - - -

        Methods inherited from class java.lang.Throwable

        -addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
      • -
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

        -clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
      • -
      -
    • -
    -
    -
  • -
-
-
-
    -
  • - -
    -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        DeploymentException

        -
        public DeploymentException​(java.lang.String message,
        -                           java.lang.Throwable t)
        -
      • -
      - - - -
        -
      • -

        DeploymentException

        -
        public DeploymentException​(java.lang.String message)
        -
      • -
      - - - -
        -
      • -

        DeploymentException

        -
        public DeploymentException​(java.lang.Throwable t)
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- - - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/EventContext.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/EventContext.html deleted file mode 100644 index 809885862d..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/EventContext.html +++ /dev/null @@ -1,292 +0,0 @@ - - - - - -EventContext (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Interface EventContext<T>

-
-
-
-
    -
  • -
    -
    Type Parameters:
    -
    T - type of event object
    -
    -
    -
    public interface EventContext<T>
    -
    Represents a context of a fired event. Provides access to an event object and corresponding metadata.
    -
    -
    Since:
    -
    2.0
    -
    Author:
    -
    Martin Kouba
    -
    See Also:
    -
    ObserverMethod.notify(EventContext), -EventMetadata
    -
    -
  • -
-
-
- -
-
-
    -
  • - -
    -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        getEvent

        -
        T getEvent()
        -
        -
        Returns:
        -
        the event object, aka the payload
        -
        -
      • -
      - - - -
        -
      • -

        getMetadata

        -
        EventMetadata getMetadata()
        -
        -
        Returns:
        -
        the event metadata
        -
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- -
- -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

-
- - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/EventMetadata.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/EventMetadata.html deleted file mode 100644 index ef087451d5..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/EventMetadata.html +++ /dev/null @@ -1,320 +0,0 @@ - - - - - -EventMetadata (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Interface EventMetadata

-
-
-
-
    -
  • -
    -
    public interface EventMetadata
    -

    - Provides access to metadata about an observed event payload. -

    -

    - EventMetadata may only be injected into an observer method. For example: -

    - -
    - public void afterLogin(@Observes LoggedInEvent event, EventMetadata eventMetadata) { ... }
    - 
    -
    -
    Since:
    -
    1.1
    -
    Author:
    -
    Lincoln Baxter, III, Pete Muir, Antoine Sabot-Durand
    -
    See Also:
    -
    Observes
    -
    -
  • -
-
-
- -
-
-
    -
  • - -
    -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        getQualifiers

        -
        java.util.Set<java.lang.annotation.Annotation> getQualifiers()
        -
        -
        Returns:
        -
        the qualifiers for which event payload was fired.
        -
        -
      • -
      - - - -
        -
      • -

        getInjectionPoint

        -
        InjectionPoint getInjectionPoint()
        -
        Get the InjectionPoint representing the injected Event instance which fired the event
        -
        -
        Returns:
        -
        InjectionPoint of the Event
        -
        -
      • -
      - - - -
        -
      • -

        getType

        -
        java.lang.reflect.Type getType()
        -
        Get the type representing runtime class of the event object with type variables resolved.
        -
        -
        Returns:
        -
        the runtime type of the event object
        -
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- -
- -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

-
- - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/Extension.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/Extension.html deleted file mode 100644 index b10982c482..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/Extension.html +++ /dev/null @@ -1,221 +0,0 @@ - - - - - -Extension (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Interface Extension

-
-
-
-
    -
  • -
    -
    public interface Extension
    -

    - Service interface implemented by extensions. An extension is a service provider declared in META-INF/services. -

    - -

    - Service providers may have observer methods, which may observe any event, - including any container lifecycle event, and obtain an injected - BeanManager. -

    - -

    - The container instantiates a single instance of each extension at the beginning of the application initialization process and - maintains a reference to it until the application shuts down. The container delivers event notifications to this instance by - calling its observer methods. -

    - -

    - Service providers are made available for injection as beans with the qualifier @Default. -

    - -

    CDI Lite implementations are not required to provide support for Portable Extensions.

    -
    -
    Author:
    -
    Gavin King, Pete Muir
    -
    -
  • -
-
-
-
- -
- -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

-
- - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/InjectionPoint.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/InjectionPoint.html deleted file mode 100644 index cb1dc3a013..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/InjectionPoint.html +++ /dev/null @@ -1,437 +0,0 @@ - - - - - -InjectionPoint (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Interface InjectionPoint

-
-
-
-
    -
  • -
    -
    public interface InjectionPoint
    -

    - Provides access to metadata about an injection point. May represent an injected field or a - parameter of a bean constructor, initializer method, - producer method, disposer method - or observer method. -

    - -

    - If the injection point is a dynamically selected reference obtained then the metadata obtain reflects the injection point of - the Instance, with the required type and any additional required qualifiers defined by Instance.select(). -

    - -

    - Occasionally, a bean with scope @Dependent needs to access metadata relating - to the object to which it belongs. The bean may inject an InjectionPoint representing the injection point into which - the bean was injected. -

    - -

    - For example, the following producer method creates injectable Logger s. The log category of a Logger - depends upon the class of the object into which it is injected. -

    - -
    - @Produces
    - Logger createLogger(InjectionPoint injectionPoint) {
    -     return Logger.getLogger(injectionPoint.getMember().getDeclaringClass().getName());
    - }
    - 
    - -

    - Only dependent objects, may obtain information about the injection point to - which they belong. -

    -
    -
    Author:
    -
    Gavin King, Pete Muir
    -
    -
  • -
-
-
-
    -
  • - -
    -
      -
    • - - -

      Method Summary

      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      All Methods Instance Methods Abstract Methods 
      Modifier and TypeMethodDescription
      AnnotatedgetAnnotated() -
      Obtain an instance of AnnotatedField or - AnnotatedParameter, depending upon whether the injection point is an injected field - or a constructor/method parameter.
      -
      Bean<?>getBean() -
      Get the Bean object representing the bean that defines the injection point.
      -
      java.lang.reflect.MembergetMember() -
      Get the Field object in the case of field injection, the Method - object in the case of method parameter injection or the Constructor object in the case of - constructor parameter injection.
      -
      java.util.Set<java.lang.annotation.Annotation>getQualifiers() -
      Get the required qualifiers of the injection point.
      -
      java.lang.reflect.TypegetType() -
      Get the required type of injection point.
      -
      booleanisDelegate() -
      Determines if the injection point is a decorator delegate injection point.
      -
      booleanisTransient() -
      Determines if the injection is a transient field.
      -
      -
    • -
    -
    -
  • -
-
-
-
    -
  • - -
    -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        getType

        -
        java.lang.reflect.Type getType()
        -
        Get the required type of injection point.
        -
        -
        Returns:
        -
        the required type
        -
        -
      • -
      - - - -
        -
      • -

        getQualifiers

        -
        java.util.Set<java.lang.annotation.Annotation> getQualifiers()
        -
        Get the required qualifiers of the injection point.
        -
        -
        Returns:
        -
        the required qualifiers
        -
        -
      • -
      - - - -
        -
      • -

        getBean

        -
        Bean<?> getBean()
        -
        Get the Bean object representing the bean that defines the injection point. If the - injection point does not belong to a bean, return a null value.
        -
        -
        Returns:
        -
        the Bean object representing bean that defines the injection point, of null - if the injection point does not belong to a bean
        -
        -
      • -
      - - - -
        -
      • -

        getMember

        -
        java.lang.reflect.Member getMember()
        -
        Get the Field object in the case of field injection, the Method - object in the case of method parameter injection or the Constructor object in the case of - constructor parameter injection.
        -
        -
        Returns:
        -
        the member
        -
        -
      • -
      - - - -
        -
      • -

        getAnnotated

        -
        Annotated getAnnotated()
        -
        Obtain an instance of AnnotatedField or - AnnotatedParameter, depending upon whether the injection point is an injected field - or a constructor/method parameter.
        -
        -
        Returns:
        -
        an AnnotatedField or AnnotatedParameter
        -
        -
      • -
      - - - -
        -
      • -

        isDelegate

        -
        boolean isDelegate()
        -
        Determines if the injection point is a decorator delegate injection point.
        -
        -
        Returns:
        -
        true if the injection point is a decorator delegate injection point, and false otherwise
        -
        -
      • -
      - - - -
        -
      • -

        isTransient

        -
        boolean isTransient()
        -
        Determines if the injection is a transient field.
        -
        -
        Returns:
        -
        true if the injection point is a transient field, and false otherwise
        -
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- -
- -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

-
- - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/InjectionTarget.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/InjectionTarget.html deleted file mode 100644 index 96459252b6..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/InjectionTarget.html +++ /dev/null @@ -1,357 +0,0 @@ - - - - - -InjectionTarget (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Interface InjectionTarget<T>

-
-
-
-
    -
  • -
    -
    Type Parameters:
    -
    T - The class of the instance
    -
    -
    -
    All Superinterfaces:
    -
    Producer<T>
    -
    -
    -
    public interface InjectionTarget<T>
    -extends Producer<T>
    -

    - Provides operations for performing dependency injection and lifecycle callbacks on an - instance of a type. -

    - -

    CDI Lite implementations are not required to provide support for InjectionTarget.

    -
    -
    Author:
    -
    Pete Muir, David Allen
    -
    See Also:
    -
    PostConstruct, -PreDestroy
    -
    -
  • -
-
-
-
    -
  • - -
    -
      -
    • - - -

      Method Summary

      - - - - - - - - - - - - - - - - - - - - - - -
      All Methods Instance Methods Abstract Methods 
      Modifier and TypeMethodDescription
      voidinject​(T instance, - CreationalContext<T> ctx) -
      - Performs dependency injection upon the given object.
      -
      voidpostConstruct​(T instance) -
      - Calls the PostConstruct callback, if it exists, according to the semantics required by the Java - EE platform specification.
      -
      voidpreDestroy​(T instance) -
      - Calls the PreDestroy callback, if it exists, according to the semantics required by the Java EE - platform specification.
      -
      - -
    • -
    -
    -
  • -
-
-
-
    -
  • - -
    -
      -
    • - - -

      Method Detail

      - - - - - -
        -
      • -

        inject

        -
        void inject​(T instance,
        -            CreationalContext<T> ctx)
        -

        - Performs dependency injection upon the given object. Performs Java EE component environment injection, sets the value of - all injected fields, and calls all initializer methods. -

        -
        -
        Parameters:
        -
        instance - The instance upon which to perform injection
        -
        ctx - The CreationalContext to use for creating new instances
        -
        -
      • -
      - - - - - -
        -
      • -

        postConstruct

        -
        void postConstruct​(T instance)
        -

        - Calls the PostConstruct callback, if it exists, according to the semantics required by the Java - EE platform specification. -

        -
        -
        Parameters:
        -
        instance - The instance on which to invoke the PostConstruct method
        -
        -
      • -
      - - - - - -
        -
      • -

        preDestroy

        -
        void preDestroy​(T instance)
        -

        - Calls the PreDestroy callback, if it exists, according to the semantics required by the Java EE - platform specification. -

        -
        -
        Parameters:
        -
        instance - The instance on which to invoke the PreDestroy method
        -
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- -
- -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

-
- - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/InjectionTargetFactory.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/InjectionTargetFactory.html deleted file mode 100644 index b78e257d2a..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/InjectionTargetFactory.html +++ /dev/null @@ -1,327 +0,0 @@ - - - - - -InjectionTargetFactory (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Interface InjectionTargetFactory<T>

-
-
-
-
    -
  • -
    -
    Type Parameters:
    -
    T - type on which this InjectionTarget operates
    -
    -
    -
    public interface InjectionTargetFactory<T>
    -

    - An InjectionTargetFactory can create an InjectionTarget for a given bean. -

    - -

    - The InjectionTargetFactory obtained from BeanManager.getInjectionTargetFactory(AnnotatedType) is capable of providing - container created injection targets. This factory can be wrapped to add behavior to container created injection targets. -

    - -

    - For example: -

    - -
    - BeanAttributes<MyBean> myBeanAttributes = beanManager.createBeanAttributes(myBeanAnnotatedType);
    - beanManager.createBean(myBeanAttributes, MyBean.class, new InjectionTargetFactory() {
    - 
    -     public <T> InjectionTarget<T> createInjectionTarget(Bean<T> bean) {
    -         return new WrappingInjectionTarget<T>(beanManager.getInjectionTargetFactory(myBeanAnnotatedType).createInjectionTarget(
    -                 bean));
    -     }
    - });
    - 
    - -

    CDI Lite implementations are not required to provide support for InjectionTargetFactory.

    -
    -
    Since:
    -
    1.1
    -
    Author:
    -
    Pete Muir, Antoine Sabot-Durand
    -
    -
  • -
-
-
- -
-
- -
-
-
- -
- -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

-
- - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/InterceptionFactory.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/InterceptionFactory.html deleted file mode 100644 index 2eca77c0ec..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/InterceptionFactory.html +++ /dev/null @@ -1,408 +0,0 @@ - - - - - -InterceptionFactory (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Interface InterceptionFactory<T>

-
-
-
-
    -
  • -
    -
    Type Parameters:
    -
    T - type for which the wrapper is created
    -
    -
    -
    public interface InterceptionFactory<T>
    -
    InterceptionFactory allows to create a wrapper instance whose method invocations are intercepted by method - interceptors and forwarded to a provided instance. - -

    - An implementation of InterceptionFactory may be obtained by calling - BeanManager.createInterceptionFactory(CreationalContext, Class) to be used in the create method of a custom bean for - example. -

    - -
    - public class MyCustomBean implements Bean<MyClass> {
    -
    -     BeanManager bm;
    -
    -     public MyBean(BeanManager bm) {
    -        this.bm = bm;
    -     }
    -
    -     public MyClass create(CreationalContext<MyClass> creationalContext) {
    -
    -         InterceptionFactory<MyClass> factory = bm.createInterceptionFactory(creationalContext, MyClass.class);
    -
    -         factory.configure().filterMethods(m -> m.getJavaMember().getName().equals("shouldBeTransactional")).findFirst()
    -                 .ifPresent(m -> m.add(new AnnotationLiteral<Transactional>() {
    -                 }));
    -
    -         return factory.createInterceptedInstance(new MyClass());
    -     }
    - }
    - 
    - -

    - The container must also provide a built-in bean with scope Dependent, bean type InterceptionFactory and - qualifier Default that can be injected in a producer method parameter. -

    - -
    - @Produces
    - @RequestScoped
    - public MyClass produceMyClass(InterceptionFactory<MyClass> factory) {
    -     factory.configure().add(new AnnotationLiteral<Transactional>() {
    -     });
    -     return factory.createInterceptedInstance(new MyClass());
    - }
    - 
    - -

    - Instances of this class are neither reusable nor suitable for sharing between threads. -

    - -

    CDI Lite implementations are not required to provide support for InterceptionFactory.

    -
    -
    Since:
    -
    2.0
    -
    Author:
    -
    Antoine Sabot-Durand
    -
    -
  • -
-
-
- -
-
- -
-
-
- -
- -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

-
- - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/InterceptionType.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/InterceptionType.html deleted file mode 100644 index c844407efc..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/InterceptionType.html +++ /dev/null @@ -1,477 +0,0 @@ - - - - - -InterceptionType (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Enum InterceptionType

-
-
-
    -
  • java.lang.Object
  • -
  • -
      -
    • java.lang.Enum<InterceptionType>
    • -
    • -
        -
      • jakarta.enterprise.inject.spi.InterceptionType
      • -
      -
    • -
    -
  • -
-
-
    -
  • -
    -
    All Implemented Interfaces:
    -
    java.io.Serializable, java.lang.Comparable<InterceptionType>
    -
    -
    -
    public enum InterceptionType
    -extends java.lang.Enum<InterceptionType>
    -

    - Identifies the kind of lifecycle callback, EJB timeout method or business method interception. -

    -
    -
    Author:
    -
    Gavin King, Pete Muir
    -
    -
  • -
-
-
-
    -
  • - -
    -
      -
    • - - -

      Enum Constant Summary

      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      Enum Constants 
      Enum ConstantDescription
      AROUND_CONSTRUCT -
      Intercepts a constructor invocation
      -
      AROUND_INVOKE -
      Intercepts method invocation
      -
      AROUND_TIMEOUT -
      Intercepts a timeout
      -
      POST_ACTIVATE -
      Intercepts bean activation, only called for EJBs
      -
      POST_CONSTRUCT -
      Intercepts bean construction
      -
      PRE_DESTROY -
      Intercepts bean destruction
      -
      PRE_PASSIVATE -
      Intercepts bean passivation, only called for EJBs
      -
      -
    • -
    -
    - -
    -
      -
    • - - -

      Method Summary

      - - - - - - - - - - - - - - - - - -
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethodDescription
      static InterceptionTypevalueOf​(java.lang.String name) -
      Returns the enum constant of this type with the specified name.
      -
      static InterceptionType[]values() -
      Returns an array containing the constants of this enum type, in -the order they are declared.
      -
      -
        -
      • - - -

        Methods inherited from class java.lang.Enum

        -clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
      • -
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

        -getClass, notify, notifyAll, wait, wait, wait
      • -
      -
    • -
    -
    -
  • -
-
-
-
    -
  • - -
    -
      -
    • - - -

      Enum Constant Detail

      - - - -
        -
      • -

        AROUND_INVOKE

        -
        public static final InterceptionType AROUND_INVOKE
        -
        Intercepts method invocation
        -
      • -
      - - - -
        -
      • -

        AROUND_TIMEOUT

        -
        public static final InterceptionType AROUND_TIMEOUT
        -
        Intercepts a timeout
        -
      • -
      - - - -
        -
      • -

        AROUND_CONSTRUCT

        -
        public static final InterceptionType AROUND_CONSTRUCT
        -
        Intercepts a constructor invocation
        -
      • -
      - - - -
        -
      • -

        POST_CONSTRUCT

        -
        public static final InterceptionType POST_CONSTRUCT
        -
        Intercepts bean construction
        -
      • -
      - - - -
        -
      • -

        PRE_DESTROY

        -
        public static final InterceptionType PRE_DESTROY
        -
        Intercepts bean destruction
        -
      • -
      - - - -
        -
      • -

        PRE_PASSIVATE

        -
        public static final InterceptionType PRE_PASSIVATE
        -
        Intercepts bean passivation, only called for EJBs
        -
      • -
      - - - -
        -
      • -

        POST_ACTIVATE

        -
        public static final InterceptionType POST_ACTIVATE
        -
        Intercepts bean activation, only called for EJBs
        -
      • -
      -
    • -
    -
    - -
    -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        values

        -
        public static InterceptionType[] values()
        -
        Returns an array containing the constants of this enum type, in -the order they are declared. This method may be used to iterate -over the constants as follows: -
        -for (InterceptionType c : InterceptionType.values())
        -    System.out.println(c);
        -
        -
        -
        Returns:
        -
        an array containing the constants of this enum type, in the order they are declared
        -
        -
      • -
      - - - -
        -
      • -

        valueOf

        -
        public static InterceptionType valueOf​(java.lang.String name)
        -
        Returns the enum constant of this type with the specified name. -The string must match exactly an identifier used to declare an -enum constant in this type. (Extraneous whitespace characters are -not permitted.)
        -
        -
        Parameters:
        -
        name - the name of the enum constant to be returned.
        -
        Returns:
        -
        the enum constant with the specified name
        -
        Throws:
        -
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        -
        java.lang.NullPointerException - if the argument is null
        -
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- - - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/Interceptor.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/Interceptor.html deleted file mode 100644 index 32440aa676..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/Interceptor.html +++ /dev/null @@ -1,375 +0,0 @@ - - - - - -Interceptor (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Interface Interceptor<T>

-
-
-
-
    -
  • -
    -
    Type Parameters:
    -
    T - the interceptor bean class
    -
    -
    -
    All Superinterfaces:
    -
    Bean<T>, BeanAttributes<T>, Contextual<T>
    -
    -
    -
    public interface Interceptor<T>
    -extends Bean<T>
    -

    - Represents an enabled interceptor. -

    -

    - Since CDI 2.0, an implementation of this interface may implement Prioritized in order to enable the interceptor with - given priority value for entire application. -

    -
    -
    Author:
    -
    Gavin King, Pete Muir, David Allen
    -
    -
  • -
-
-
- -
-
-
    -
  • - -
    -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        getInterceptorBindings

        -
        java.util.Set<java.lang.annotation.Annotation> getInterceptorBindings()
        -

        - Obtains the interceptor bindings of the interceptor. -

        -
        -
        Returns:
        -
        the set of interceptor bindings
        -
        -
      • -
      - - - - - - - - - -
        -
      • -

        intercept

        -
        java.lang.Object intercept​(InterceptionType type,
        -                           T instance,
        -                           jakarta.interceptor.InvocationContext ctx)
        -                    throws java.lang.Exception
        -

        - Invokes the specified kind of lifecycle callback or method invocation interception upon the - given interceptor instance. -

        -
        -
        Parameters:
        -
        type - the kind of interception
        -
        instance - the interceptor instance to invoke
        -
        ctx - the context for the invocation
        -
        Returns:
        -
        the invocation return value
        -
        Throws:
        -
        java.lang.Exception - thrown by the target method and/or the following interceptors in the chain
        -
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- -
- -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

-
- - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/ObserverMethod.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/ObserverMethod.html deleted file mode 100644 index 6c58bd84c8..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/ObserverMethod.html +++ /dev/null @@ -1,560 +0,0 @@ - - - - - -ObserverMethod (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Interface ObserverMethod<T>

-
-
-
-
    -
  • -
    -
    Type Parameters:
    -
    T - the event type
    -
    -
    -
    All Superinterfaces:
    -
    Prioritized
    -
    -
    -
    public interface ObserverMethod<T>
    -extends Prioritized
    -

    - Represents an observer method of an enabled - bean. Defines everything the container needs to know about an observer method. -

    - -

    - If a custom implementation of this interface does not override either notify(Object) or - notify(EventContext), the container automatically detects the problem and treats it as a definition error. -

    -
    -
    Author:
    -
    Gavin King, David Allen, Mark Paluch, Antoine Sabot-Durand
    -
    -
  • -
-
-
- -
-
-
    -
  • - -
    - -
    - -
    -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        getBeanClass

        -
        java.lang.Class<?> getBeanClass()
        -

        - Obtains the class of the type that declares the observer method. -

        -
        -
        Returns:
        -
        the defining class
        -
        -
      • -
      - - - -
        -
      • -

        getDeclaringBean

        -
        default Bean<?> getDeclaringBean()
        -

        - Obtains the bean that declares the observer method. - For synthetic observers, the return value is undefined. -

        - -

        - For the sake of compatibility with existing custom ObserverMethod implementations, this method by default - returns null. -

        -
        -
        Returns:
        -
        the declaring bean
        -
        Since:
        -
        4.0
        -
        -
      • -
      - - - -
        -
      • -

        getObservedType

        -
        java.lang.reflect.Type getObservedType()
        -
        Obtains the observed event type.
        -
        -
        Returns:
        -
        the observed event type
        -
        -
      • -
      - - - -
        -
      • -

        getObservedQualifiers

        -
        java.util.Set<java.lang.annotation.Annotation> getObservedQualifiers()
        -
        Obtains the set of observed event qualifiers.
        -
        -
        Returns:
        -
        the observed event qualifiers
        -
        -
      • -
      - - - -
        -
      • -

        getReception

        -
        Reception getReception()
        -
        Obtains the specified Reception for the observer method. This indicates if the observer is conditional or not.
        -
        -
        Returns:
        -
        the Reception
        -
        -
      • -
      - - - - - - - -
        -
      • -

        getPriority

        -
        default int getPriority()
        -
        The priority that will be used by the container to determine the notification order in which event observer - methods are invoked.
        -
        -
        Specified by:
        -
        getPriority in interface Prioritized
        -
        Returns:
        -
        The priority that will be used by the container to determine the notification order in which event - observer methods are invoked.
        -
        Since:
        -
        2.0
        -
        -
      • -
      - - - - - -
        -
      • -

        notify

        -
        default void notify​(T event)
        -

        - Calls the observer method, passing the given event object. -

        - -

        - The implementation of this method for a custom observer method is responsible for deciding whether to call - the method if the getReception() returns Reception.IF_EXISTS. -

        -
        -
        Parameters:
        -
        event - the event object
        -
        -
      • -
      - - - -
        -
      • -

        notify

        -
        default void notify​(EventContext<T> eventContext)
        -
        Calls the observer method, passing the given event context. -

        - The container should always call this method, but the default implementation delegates to notify(Object). -

        - The implementation of this method for a custom observer method is responsible for deciding whether to call the method if - the getReception() returns Reception.IF_EXISTS.

        -
        -
        Parameters:
        -
        eventContext - EventContext used to notify observers
        -
        -
      • -
      - - - -
        -
      • -

        isAsync

        -
        default boolean isAsync()
        -

        - Determines if this observer method is asynchronous -

        -
        -
        Returns:
        -
        returns true if the method is an asynchronous observer method (i.e. defined with ObservesAsync), - otherwise returns false
        -
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- - - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/PassivationCapable.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/PassivationCapable.html deleted file mode 100644 index efa4fd1cb4..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/PassivationCapable.html +++ /dev/null @@ -1,275 +0,0 @@ - - - - - -PassivationCapable (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Interface PassivationCapable

-
-
-
-
    -
  • -
    -
    public interface PassivationCapable
    -
    Indicates that a custom implementation of Bean or - Contextual is passivation capable. - -

    CDI Lite implementations are not required to provide support for passivation.

    -
    -
    Author:
    -
    Gavin King, David Allen
    -
    -
  • -
-
-
- -
-
-
    -
  • - -
    -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        getId

        -
        java.lang.String getId()
        -
        A string that uniquely identifies the instance of Bean or - Contextual. It is recommended that the string contain the package name of the class - that implements Bean or Contextual.
        -
        -
        Returns:
        -
        a unique identifier for the Bean or - Contextual
        -
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- -
- -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

-
- - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/Prioritized.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/Prioritized.html deleted file mode 100644 index ddaa3b0c29..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/Prioritized.html +++ /dev/null @@ -1,289 +0,0 @@ - - - - - -Prioritized (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Interface Prioritized

-
-
-
-
    -
  • -
    -
    All Known Subinterfaces:
    -
    BuildServices, CDIProvider, ObserverMethod<T>
    -
    -
    -
    public interface Prioritized
    -

    - This interface allows some SPI implementation to change their priority programmatically. -

    - -

    - For instance ObserverMethod extends this interface to set the observer priority. - - A custom alternative Bean, Interceptor or Decorator may implement this interface to be activated - with a given priority - -

    -
    -
    Since:
    -
    2.0
    -
    Author:
    -
    Mark Paluch, Antoine Sabot-Durand
    -
    See Also:
    -
    Bean
    -
    -
  • -
-
-
- -
-
-
    -
  • - -
    -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        getPriority

        -
        int getPriority()
        -

        - Returns the priority for this SPI element. -

        -
        -
        Returns:
        -
        the priority value
        -
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- -
- -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

-
- - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/ProcessAnnotatedType.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/ProcessAnnotatedType.html deleted file mode 100644 index f45a7bc0e4..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/ProcessAnnotatedType.html +++ /dev/null @@ -1,379 +0,0 @@ - - - - - -ProcessAnnotatedType (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Interface ProcessAnnotatedType<X>

-
-
-
-
    -
  • -
    -
    Type Parameters:
    -
    X - The class being annotated
    -
    -
    -
    All Known Subinterfaces:
    -
    ProcessSyntheticAnnotatedType<X>
    -
    -
    -
    public interface ProcessAnnotatedType<X>
    -

    - The container fires an event of this type for each Java class or interface it discovers in a bean archive, before it reads - the declared annotations. -

    -

    - Any observer of this event is permitted to wrap and/or replace the AnnotatedType by calling either setAnnotatedType(AnnotatedType) or configureAnnotatedType(). - If both methods are called within an observer notification an IllegalStateException is thrown. - The container must use the final value of this property, after all observers have been called, to discover the types and read the annotations of the program elements. -

    -

    - For example, the following observer decorates the AnnotatedType for every class that is - discovered by the container. -

    - -
    - public <T> void decorateAnnotatedType(@Observes ProcessAnnotatedType<T> pat) {
    -     pat.setAnnotatedType(decorate(pat.getAnnotatedType()));
    - }
    - 
    -

    - If any observer method of a ProcessAnnotatedType event throws an exception, the exception is treated as a definition - error by the container. -

    - -

    CDI Lite implementations are not required to provide support for Portable Extensions.

    -
    -
    Author:
    -
    David Allen, Antoine Sabot-Durand
    -
    See Also:
    -
    AnnotatedType
    -
    -
  • -
-
-
- -
-
-
    -
  • - -
    -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        getAnnotatedType

        -
        AnnotatedType<X> getAnnotatedType()
        -
        Returns the AnnotatedType object that will be used by the container to read the - declared annotations.
        -
        -
        Returns:
        -
        the AnnotatedType object
        -
        Throws:
        -
        java.lang.IllegalStateException - if called outside of the observer method invocation
        -
        -
      • -
      - - - -
        -
      • -

        setAnnotatedType

        -
        void setAnnotatedType​(AnnotatedType<X> type)
        -
        Replaces the AnnotatedType.
        -
        -
        Parameters:
        -
        type - the new AnnotatedType object to use
        -
        Throws:
        -
        java.lang.IllegalStateException - if called outside of the observer method invocation
        -
        -
      • -
      - - - -
        -
      • -

        configureAnnotatedType

        -
        AnnotatedTypeConfigurator<X> configureAnnotatedType()
        -
        Returns an AnnotatedTypeConfigurator initialized with the AnnotatedType processed by this event - to configure a new AnnotatedType that will replace the original one at the end of the observer invocation. - - Each call returns the same AnnotatedTypeConfigurator.
        -
        -
        Returns:
        -
        a non reusable AnnotatedTypeConfigurator to configure the replacing AnnotatedType
        -
        Throws:
        -
        java.lang.IllegalStateException - if called outside of the observer method invocation
        -
        Since:
        -
        2.0
        -
        -
      • -
      - - - -
        -
      • -

        veto

        -
        void veto()
        -
        Forces the container to ignore this type.
        -
        -
        Throws:
        -
        java.lang.IllegalStateException - if called outside of the observer method invocation
        -
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- -
- -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

-
- - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/ProcessBean.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/ProcessBean.html deleted file mode 100644 index 2ea5bee9d1..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/ProcessBean.html +++ /dev/null @@ -1,364 +0,0 @@ - - - - - -ProcessBean (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Interface ProcessBean<X>

-
-
-
-
    -
  • -
    -
    Type Parameters:
    -
    X - The class of the bean
    -
    -
    -
    All Known Subinterfaces:
    -
    ProcessManagedBean<X>, ProcessProducerField<T,​X>, ProcessProducerMethod<T,​X>, ProcessSessionBean<X>, ProcessSyntheticBean<X>
    -
    -
    -
    public interface ProcessBean<X>
    -

    - The container fires an event of this type for each enabled bean, interceptor or decorator deployed in a bean archive, before - registering the Bean object. -

    -

    - The event object type depends upon what kind of bean was discovered: -

    -
      -
    • For a managed bean with bean class X, the container must raise an event of type - ProcessManagedBean.
    • -
    • For a session bean with bean class X, the container must raise an event of type - ProcessSessionBean.
    • -
    • For a producer method with method return type X of a bean with bean class T, the container must raise an event of type - ProcessProducerMethod.
    • -
    • For a producer field with field type X of a bean with bean class T, the container must raise an event of type - ProcessProducerField.
    • -
    • For a custom implementation of Bean, the container must raise an event of type ProcessSyntheticBean.
    • -
    -

    - Resources are considered to be producer fields. -

    -

    - If any observer method of a ProcessBean event throws an exception, the exception is treated as a definition error by - the container. -

    - -

    CDI Lite implementations are not required to provide support for Portable Extensions.

    -
    -
    Author:
    -
    David Allen
    -
    See Also:
    -
    Bean
    -
    -
  • -
-
-
- -
-
-
    -
  • - -
    -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        getAnnotated

        -
        Annotated getAnnotated()
        -
        Returns the AnnotatedType representing the bean class, the - AnnotatedMethod representing the producer method, or the - AnnotatedField representing the producer field. - -

        - If invoked upon a ProcessSyntheticBean event, non-portable behavior results and the returned value should be ignored. -

        -
        -
        Returns:
        -
        the Annotated for the bean being registered
        -
        Throws:
        -
        java.lang.IllegalStateException - if called outside of the observer method invocation
        -
        -
      • -
      - - - -
        -
      • -

        getBean

        -
        Bean<X> getBean()
        -
        Returns the Bean object that is about to be registered. The - Bean may implement Interceptor or - Decorator.
        -
        -
        Returns:
        -
        the Bean object about to be registered
        -
        Throws:
        -
        java.lang.IllegalStateException - if called outside of the observer method invocation
        -
        -
      • -
      - - - -
        -
      • -

        addDefinitionError

        -
        void addDefinitionError​(java.lang.Throwable t)
        -
        Registers a definition error with the container, causing the container to abort deployment after bean discovery is - complete.
        -
        -
        Parameters:
        -
        t - The definition error to register as a Throwable
        -
        Throws:
        -
        java.lang.IllegalStateException - if called outside of the observer method invocation
        -
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- -
- -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

-
- - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/ProcessBeanAttributes.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/ProcessBeanAttributes.html deleted file mode 100644 index 060b02e4bb..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/ProcessBeanAttributes.html +++ /dev/null @@ -1,433 +0,0 @@ - - - - - -ProcessBeanAttributes (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Interface ProcessBeanAttributes<T>

-
-
-
-
    -
  • -
    -
    Type Parameters:
    -
    T - The class of the bean
    -
    -
    -
    public interface ProcessBeanAttributes<T>
    -

    - The container fires an event of this type for each enabled bean, interceptor or decorator deployed in a bean archive before - registering the Bean object. -

    -

    - Any observer of this event is permitted to wrap and/or replace the BeanAttributes by calling either setBeanAttributes(BeanAttributes) or configureBeanAttributes(). - If both methods are called within an observer notification an IllegalStateException is thrown. - The container must use the final value of this property, after all observers have been called, to manage instances of the bean. -

    -

    - If any observer method of a ProcessBeanAttributes event throws an exception, the exception is treated as a definition - error by the container. -

    - -

    CDI Lite implementations are not required to provide support for Portable Extensions.

    -
    -
    Since:
    -
    1.1
    -
    Author:
    -
    Pete Muir, Antoine Sabot-Durand
    -
    -
  • -
-
-
- -
-
-
    -
  • - -
    -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        getAnnotated

        -
        Annotated getAnnotated()
        -
        -
        Returns:
        -
        the AnnotatedType representing the managed bean class or session bean class, the AnnotatedMethod - representing the producer field, or the AnnotatedField representing the producer field
        -
        Throws:
        -
        java.lang.IllegalStateException - if called outside of the observer method invocation
        -
        -
      • -
      - - - -
        -
      • -

        getBeanAttributes

        -
        BeanAttributes<T> getBeanAttributes()
        -
        -
        Returns:
        -
        the BeanAttributes object that will be used by the container to manage instances of the bean
        -
        Throws:
        -
        java.lang.IllegalStateException - if called outside of the observer method invocation
        -
        -
      • -
      - - - -
        -
      • -

        setBeanAttributes

        -
        void setBeanAttributes​(BeanAttributes<T> beanAttributes)
        -
        Replaces the BeanAttributes.
        -
        -
        Parameters:
        -
        beanAttributes - the new BeanAttributes to use
        -
        Throws:
        -
        java.lang.IllegalStateException - if called outside of the observer method invocation
        -
        -
      • -
      - - - -
        -
      • -

        configureBeanAttributes

        -
        BeanAttributesConfigurator<T> configureBeanAttributes()
        -
        returns a BeanAttributesConfigurator initialized with the BeanAttributes processed by this event - to configure a new BeanAttributes that will replace the original one at the end of the observer invocation. - - Each call returns the same BeanAttributesConfigurator.
        -
        -
        Returns:
        -
        a non reusable BeanAttributesConfigurator to configure the replacing BeanAttributes
        -
        Throws:
        -
        java.lang.IllegalStateException - if called outside of the observer method invocation
        -
        Since:
        -
        2.0
        -
        -
      • -
      - - - -
        -
      • -

        addDefinitionError

        -
        void addDefinitionError​(java.lang.Throwable t)
        -
        Registers a definition error with the container, causing the container to abort deployment after bean discovery is - complete.
        -
        -
        Parameters:
        -
        t - the error to add
        -
        Throws:
        -
        java.lang.IllegalStateException - if called outside of the observer method invocation
        -
        -
      • -
      - - - -
        -
      • -

        veto

        -
        void veto()
        -
        Forces the container to ignore the bean.
        -
        -
        Throws:
        -
        java.lang.IllegalStateException - if called outside of the observer method invocation
        -
        -
      • -
      - - - -
        -
      • -

        ignoreFinalMethods

        -
        void ignoreFinalMethods()
        -

        Instructs the container to ignore all non-static, final methods with public, protected or default visibility - declared on any bean type of the specific bean during validation of injection points that require proxyable bean type.

        - -

        These method should never be invoked upon bean instances. Otherwise, unpredictable behavior results.

        -
        -
        Throws:
        -
        java.lang.IllegalStateException - if called outside of the observer method invocation
        -
        Since:
        -
        2.0
        -
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- -
- -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

-
- - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/ProcessInjectionPoint.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/ProcessInjectionPoint.html deleted file mode 100644 index 2bb0010fac..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/ProcessInjectionPoint.html +++ /dev/null @@ -1,368 +0,0 @@ - - - - - -ProcessInjectionPoint (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Interface ProcessInjectionPoint<T,​X>

-
-
-
-
    -
  • -
    -
    Type Parameters:
    -
    X - the declared type of the injection point.
    -
    T - the bean class of the bean that declares the injection point
    -
    -
    -
    public interface ProcessInjectionPoint<T,​X>
    -

    - The container fires an event of this type for every injection point of every Java EE component class supporting injection - that may be instantiated by the container at runtime, including every managed bean declared using - jakarta.annotation.ManagedBean, EJB session or message-driven bean, enabled bean, enabled interceptor or enabled - decorator. -

    -

    - Any observer of this event is permitted to wrap and/or replace the InjectionPoint by calling either setInjectionPoint(InjectionPoint) or configureInjectionPoint(). - If both methods are called within an observer notification an IllegalStateException is thrown. - The container must use the final value of this property, after all observers have been called, he container must use the final - value of this property, after all observers have been called, whenever it performs injection upon the injection point. -

    -

    - If any observer method of a ProcessInjectionPoint event throws an exception, the exception is treated as a definition - error by the container. -

    - -

    CDI Lite implementations are not required to provide support for Portable Extensions.

    -
    -
    Author:
    -
    Pete Muir, Antoine Sabot-Durand
    -
    See Also:
    -
    InjectionPoint
    -
    -
  • -
-
-
- -
-
-
    -
  • - -
    -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        getInjectionPoint

        -
        InjectionPoint getInjectionPoint()
        -
        -
        Returns:
        -
        the InjectionPoint object that will be used by the container to perform injection
        -
        Throws:
        -
        java.lang.IllegalStateException - if called outside of the observer method invocation
        -
        -
      • -
      - - - -
        -
      • -

        setInjectionPoint

        -
        void setInjectionPoint​(InjectionPoint injectionPoint)
        -
        Replaces the InjectionPoint.
        -
        -
        Parameters:
        -
        injectionPoint - the new injection point
        -
        Throws:
        -
        java.lang.IllegalStateException - if called outside of the observer method invocation
        -
        -
      • -
      - - - -
        -
      • -

        configureInjectionPoint

        -
        InjectionPointConfigurator configureInjectionPoint()
        -
        Returns an InjectionPointConfigurator initialized with the InjectionPoint processed by this event - to configure a new InjectionPoint that will replace the original one at the end of the observer invocation. - - Each call returns the same InjectionPointConfigurator
        -
        -
        Returns:
        -
        a non reusable InjectionPointConfigurator to configure the replacing InjectionPoint
        -
        Throws:
        -
        java.lang.IllegalStateException - if called outside of the observer method invocation
        -
        Since:
        -
        2.0
        -
        -
      • -
      - - - -
        -
      • -

        addDefinitionError

        -
        void addDefinitionError​(java.lang.Throwable t)
        -
        Registers a definition error with the container, causing the container to abort deployment after bean discovery is - complete.
        -
        -
        Parameters:
        -
        t - the definition error
        -
        Throws:
        -
        java.lang.IllegalStateException - if called outside of the observer method invocation
        -
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- -
- -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

-
- - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/ProcessInjectionTarget.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/ProcessInjectionTarget.html deleted file mode 100644 index 47754bdf5a..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/ProcessInjectionTarget.html +++ /dev/null @@ -1,375 +0,0 @@ - - - - - -ProcessInjectionTarget (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Interface ProcessInjectionTarget<X>

-
-
-
-
    -
  • -
    -
    Type Parameters:
    -
    X - The managed bean class, session bean class or Java EE component class supporting injection
    -
    -
    -
    public interface ProcessInjectionTarget<X>
    -

    - 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 jakarta.annotation.ManagedBean, EJB session or - message-driven bean, enabled bean, enabled interceptor or enabled decorator. -

    -

    - Any observer of this event is permitted to wrap and/or replace the 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. -

    -

    - For example, this observer decorates the InjectionTarget for all servlets. -

    - -
    - public <T extends Servlet> void decorateServlet(@Observes ProcessInjectionTarget<T> pit) {
    -     pit.setInjectionTarget(decorate(pit.getInjectionTarget()));
    - }
    - 
    -

    - If any observer method of a ProcessInjectionTarget event throws an exception, the exception is treated as a - definition error by the container. -

    - -

    CDI Lite implementations are not required to provide support for Portable Extensions.

    -
    -
    Author:
    -
    David Allen
    -
    See Also:
    -
    InjectionTarget
    -
    -
  • -
-
-
- -
-
-
    -
  • - -
    -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        getAnnotatedType

        -
        AnnotatedType<X> getAnnotatedType()
        -
        Returns the AnnotatedType representing the managed bean class, session bean class or - other Java EE component class supporting injection.
        -
        -
        Returns:
        -
        the AnnotatedType of the bean with an injection target
        -
        Throws:
        -
        java.lang.IllegalStateException - if called outside of the observer method invocation
        -
        -
      • -
      - - - -
        -
      • -

        getInjectionTarget

        -
        InjectionTarget<X> getInjectionTarget()
        -
        Returns the InjectionTarget object that will be used by the container to perform - injection.
        -
        -
        Returns:
        -
        the InjectionTarget object which performs the injection
        -
        Throws:
        -
        java.lang.IllegalStateException - if called outside of the observer method invocation
        -
        -
      • -
      - - - -
        -
      • -

        setInjectionTarget

        -
        void setInjectionTarget​(InjectionTarget<X> injectionTarget)
        -
        Replaces the InjectionTarget which performs injection for this target.
        -
        -
        Parameters:
        -
        injectionTarget - The new InjectionTarget to use
        -
        Throws:
        -
        java.lang.IllegalStateException - if called outside of the observer method invocation
        -
        -
      • -
      - - - -
        -
      • -

        addDefinitionError

        -
        void addDefinitionError​(java.lang.Throwable t)
        -
        Registers a definition error with the container, causing the container to abort deployment after bean discovery is - complete.
        -
        -
        Parameters:
        -
        t - A Throwable representing the definition error
        -
        Throws:
        -
        java.lang.IllegalStateException - if called outside of the observer method invocation
        -
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- -
- -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

-
- - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/ProcessManagedBean.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/ProcessManagedBean.html deleted file mode 100644 index 70f672243f..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/ProcessManagedBean.html +++ /dev/null @@ -1,328 +0,0 @@ - - - - - -ProcessManagedBean (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Interface ProcessManagedBean<X>

-
-
-
-
    -
  • -
    -
    Type Parameters:
    -
    X - The class of the bean
    -
    -
    -
    All Superinterfaces:
    -
    ProcessBean<X>
    -
    -
    -
    All Known Subinterfaces:
    -
    ProcessSessionBean<X>
    -
    -
    -
    public interface ProcessManagedBean<X>
    -extends ProcessBean<X>
    -

    - The container fires an event of this type for each enabled managed bean, before registering the - Bean object. -

    -

    - If any observer method of a ProcessManagedBean event throws an exception, the exception is treated as a definition - error by the container. -

    - -

    CDI Lite implementations are not required to provide support for Portable Extensions.

    -
    -
    Author:
    -
    David Allen
    -
    -
  • -
-
-
- -
-
-
    -
  • - -
    -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        getAnnotatedBeanClass

        -
        AnnotatedType<X> getAnnotatedBeanClass()
        -
        Returns the AnnotatedType representing the bean class.
        -
        -
        Returns:
        -
        the AnnotatedType for the bean being registered
        -
        Throws:
        -
        java.lang.IllegalStateException - if called outside of the observer method invocation
        -
        -
      • -
      - - - -
        -
      • -

        createInvoker

        -
        InvokerBuilder<Invoker<X,​?>> createInvoker​(AnnotatedMethod<? super X> method)
        -
        Returns a new InvokerBuilder for given method. The builder eventually produces an invoker - for the given method. -

        - The method must be declared on the bean class or inherited from a supertype - of the bean class of the bean being registered, otherwise an exception is thrown.

        -
        -
        Parameters:
        -
        method - method of the bean being registered, must not be null
        -
        Returns:
        -
        the invoker builder, never null
        -
        Since:
        -
        4.1
        -
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- -
- -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

-
- - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/ProcessObserverMethod.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/ProcessObserverMethod.html deleted file mode 100644 index 15c3232b6f..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/ProcessObserverMethod.html +++ /dev/null @@ -1,431 +0,0 @@ - - - - - -ProcessObserverMethod (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Interface ProcessObserverMethod<T,​X>

-
-
-
-
    -
  • -
    -
    Type Parameters:
    -
    T - The type of the event being observed
    -
    X - The bean type containing the observer method
    -
    -
    -
    All Known Subinterfaces:
    -
    ProcessSyntheticObserverMethod<T,​X>
    -
    -
    -
    public interface ProcessObserverMethod<T,​X>
    -

    - The container fires an event of this type for each observer method of each - enabled bean, before registering the ObserverMethod object. -

    -

    - For a custom implementation of ObserverMethod, the container must raise an event of type ProcessSyntheticObserverMethod. -

    -

    - Any observer of this event is permitted to wrap and/or replace the ObserverMethod by calling either setObserverMethod(ObserverMethod) or configureObserverMethod(). - If both methods are called within an observer notification an IllegalStateException is thrown. - The container must use the final value of this property, after all observers have been called, he container must use the final - value of this property, after all observers have been called, whenever it performs observer resolution. -

    -

    - If any observer method of a ProcessObserverMethod event throws an exception, the exception is treated as a definition - error by the container. -

    - -

    CDI Lite implementations are not required to provide support for Portable Extensions.

    -
    -
    Author:
    -
    Gavin King, David Allen, Antoine Sabot-Durand
    -
    See Also:
    -
    ObserverMethod
    -
    -
  • -
-
-
- -
-
-
    -
  • - -
    -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        getAnnotatedMethod

        -
        AnnotatedMethod<X> getAnnotatedMethod()
        -
        The AnnotatedMethod representing the observer method. - -

        - If invoked upon a ProcessSyntheticObserverMethod event, non-portable behavior results and the returned value should be ignored. -

        -
        -
        Returns:
        -
        the AnnotatedMethod representing the observer method
        -
        Throws:
        -
        java.lang.IllegalStateException - if called outside of the observer method invocation
        -
        -
      • -
      - - - -
        -
      • -

        getObserverMethod

        -
        ObserverMethod<T> getObserverMethod()
        -
        The ObserverMethod object that will be used by the container to invoke the observer - when a matching event is fired.
        -
        -
        Returns:
        -
        the ObserverMethod object that will be used by the container to call the - observer method
        -
        Throws:
        -
        java.lang.IllegalStateException - if called outside of the observer method invocation
        -
        -
      • -
      - - - -
        -
      • -

        addDefinitionError

        -
        void addDefinitionError​(java.lang.Throwable t)
        -
        Registers a definition error with the container, causing the container to abort deployment after bean discovery is - complete.
        -
        -
        Parameters:
        -
        t - A Throwable representing the definition error
        -
        Throws:
        -
        java.lang.IllegalStateException - if called outside of the observer method invocation
        -
        -
      • -
      - - - -
        -
      • -

        setObserverMethod

        -
        void setObserverMethod​(ObserverMethod<T> observerMethod)
        -
        Replaces the ObserverMethod.
        -
        -
        Parameters:
        -
        observerMethod - the new ObserverMethod object to use
        -
        Throws:
        -
        java.lang.IllegalStateException - if called outside of the observer method invocation
        -
        Since:
        -
        2.0
        -
        -
      • -
      - - - -
        -
      • -

        configureObserverMethod

        -
        ObserverMethodConfigurator<T> configureObserverMethod()
        -
        Returns a ObserverMethodConfigurator initialized with the ObserverMethod processed by this event, - to configure a new ObserverMethod that will replace the original one at the end of the observer invocation. - - Each call returns the same ObserverMethodConfigurator
        -
        -
        Returns:
        -
        a non reusable ObserverMethodConfigurator to configure the replacing ObserverMethod
        -
        Throws:
        -
        java.lang.IllegalStateException - if called outside of the observer method invocation
        -
        Since:
        -
        2.0
        -
        -
      • -
      - - - -
        -
      • -

        veto

        -
        void veto()
        -
        Forces the container to ignore the observer method.
        -
        -
        Throws:
        -
        java.lang.IllegalStateException - if called outside of the observer method invocation
        -
        Since:
        -
        2.0
        -
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- -
- -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

-
- - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/ProcessProducer.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/ProcessProducer.html deleted file mode 100644 index 6b2556ecef..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/ProcessProducer.html +++ /dev/null @@ -1,411 +0,0 @@ - - - - - -ProcessProducer (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Interface ProcessProducer<T,​X>

-
-
-
-
    -
  • -
    -
    Type Parameters:
    -
    T - The bean class of the bean that declares the producer method or field
    -
    X - The return type of the producer method or the type of the producer field
    -
    -
    -
    public interface ProcessProducer<T,​X>
    -

    - The container fires an event of this type for each producer method or field of - each enabled bean, including resources. -

    -

    - Any observer of this event is permitted to wrap and/or replace the Producer by calling either - setProducer(Producer) or configureProducer(). If both methods are called within an observer notification an - IllegalStateException is thrown. The container must use the final value of this property, after all observers have - been called, whenever it calls the producer or disposer. -

    -

    - For example, this observer decorates the Producer for the all producer methods and field of type - EntityManager. -

    - -
    - void decorateEntityManager(@Observes ProcessProducer<?, EntityManager> pp) {
    -     pit.setProducer(decorate(pp.getProducer()));
    - }
    - 
    -

    - If any observer method of a ProcessProducer event throws an exception, the exception is treated as a definition error - by the container. -

    - -

    CDI Lite implementations are not required to provide support for Portable Extensions.

    -
    -
    Author:
    -
    David Allen
    -
    See Also:
    -
    Producer
    -
    -
  • -
-
-
- -
-
-
    -
  • - -
    -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        getAnnotatedMember

        -
        AnnotatedMember<T> getAnnotatedMember()
        -
        Returns the AnnotatedField representing the producer field or the - AnnotatedMethod representing the producer method.
        -
        -
        Returns:
        -
        the AnnotatedMember representing the producer
        -
        Throws:
        -
        java.lang.IllegalStateException - if called outside of the observer method invocation
        -
        -
      • -
      - - - -
        -
      • -

        getProducer

        -
        Producer<X> getProducer()
        -
        Returns the Producer object that will be used by the container to call the producer - method or read the producer field.
        -
        -
        Returns:
        -
        the Producer invoker object used by the container
        -
        Throws:
        -
        java.lang.IllegalStateException - if called outside of the observer method invocation
        -
        -
      • -
      - - - -
        -
      • -

        setProducer

        -
        void setProducer​(Producer<X> producer)
        -
        Replaces the Producer object that will be used by the container to call the producer - method or read the producer field.
        -
        -
        Parameters:
        -
        producer - the new Producer object to use
        -
        Throws:
        -
        java.lang.IllegalStateException - if called outside of the observer method invocation
        -
        -
      • -
      - - - -
        -
      • -

        configureProducer

        -
        ProducerConfigurator<X> configureProducer()
        -
        Returns a ProducerConfigurator initialized with the Producer processed by this event, to configure a new - Producer that will replace the original one at the end of the observer invocation. - -

        - Each call returns the same configurator instance within an observer notification. -

        -
        -
        Returns:
        -
        a non reusable ProducerConfigurator to configure the original - Producer.
        -
        Throws:
        -
        java.lang.IllegalStateException - if called outside of the observer method invocation
        -
        Since:
        -
        2.0
        -
        -
      • -
      - - - -
        -
      • -

        addDefinitionError

        -
        void addDefinitionError​(java.lang.Throwable t)
        -
        Registers a definition error with the container, causing the container to abort deployment after bean discovery is - complete.
        -
        -
        Parameters:
        -
        t - The definition error to register as a Throwable
        -
        Throws:
        -
        java.lang.IllegalStateException - if called outside of the observer method invocation
        -
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- -
- -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

-
- - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/ProcessProducerField.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/ProcessProducerField.html deleted file mode 100644 index f61cb1186f..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/ProcessProducerField.html +++ /dev/null @@ -1,323 +0,0 @@ - - - - - -ProcessProducerField (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Interface ProcessProducerField<T,​X>

-
-
-
-
    -
  • -
    -
    Type Parameters:
    -
    T - The type of the producer field
    -
    X - The class of the bean declaring the producer field
    -
    -
    -
    All Superinterfaces:
    -
    ProcessBean<X>
    -
    -
    -
    public interface ProcessProducerField<T,​X>
    -extends ProcessBean<X>
    -

    - The container fires an event of this type for each enabled producer field, before registering the - Bean object. Resources are considered to be producer fields. -

    -

    - If any observer method of a ProcessProducerField event throws an exception, the exception is treated as a definition - error by the container. -

    - -

    CDI Lite implementations are not required to provide support for Portable Extensions.

    -
    -
    Author:
    -
    David Allen
    -
    -
  • -
-
-
- -
-
-
    -
  • - -
    -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        getAnnotatedProducerField

        -
        AnnotatedField<T> getAnnotatedProducerField()
        -
        Returns the AnnotatedField representing the producer field.
        -
        -
        Returns:
        -
        the AnnotatedField for the producer field being registered
        -
        Throws:
        -
        java.lang.IllegalStateException - if called outside of the observer method invocation
        -
        -
      • -
      - - - -
        -
      • -

        getAnnotatedDisposedParameter

        -
        AnnotatedParameter<T> getAnnotatedDisposedParameter()
        -
        Returns the AnnotatedParameter for any matching injection point of the same type as - the producer field return type found on a disposal method.
        -
        -
        Returns:
        -
        the disposal method's AnnotatedParameter
        -
        Throws:
        -
        java.lang.IllegalStateException - if called outside of the observer method invocation
        -
        Since:
        -
        1.1
        -
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- -
- -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

-
- - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/ProcessProducerMethod.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/ProcessProducerMethod.html deleted file mode 100644 index d1f48fc6a0..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/ProcessProducerMethod.html +++ /dev/null @@ -1,321 +0,0 @@ - - - - - -ProcessProducerMethod (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Interface ProcessProducerMethod<T,​X>

-
-
-
-
    -
  • -
    -
    Type Parameters:
    -
    T - The return type of the producer method
    -
    X - The class of the bean declaring the producer method
    -
    -
    -
    All Superinterfaces:
    -
    ProcessBean<X>
    -
    -
    -
    public interface ProcessProducerMethod<T,​X>
    -extends ProcessBean<X>
    -

    - The container fires an event of this type for each enabled producer method, before registering the - Bean object. -

    -

    - If any observer method of a ProcessProducerMethod event throws an exception, the exception is treated as a definition - error by the container. -

    - -

    CDI Lite implementations are not required to provide support for Portable Extensions.

    -
    -
    Author:
    -
    David Allen
    -
    -
  • -
-
-
- -
-
-
    -
  • - -
    -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        getAnnotatedProducerMethod

        -
        AnnotatedMethod<T> getAnnotatedProducerMethod()
        -
        Returns the AnnotatedMethod representing the producer method.
        -
        -
        Returns:
        -
        the AnnotatedMethod for the producer method being registered
        -
        Throws:
        -
        java.lang.IllegalStateException - if called outside of the observer method invocation
        -
        -
      • -
      - - - -
        -
      • -

        getAnnotatedDisposedParameter

        -
        AnnotatedParameter<T> getAnnotatedDisposedParameter()
        -
        Returns the AnnotatedParameter for any matching injection point of the same type as - the producer method return type found on a disposal method.
        -
        -
        Returns:
        -
        the disposal method's AnnotatedParameter
        -
        Throws:
        -
        java.lang.IllegalStateException - if called outside of the observer method invocation
        -
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- -
- -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

-
- - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/ProcessSessionBean.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/ProcessSessionBean.html deleted file mode 100644 index 6067df9aa0..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/ProcessSessionBean.html +++ /dev/null @@ -1,332 +0,0 @@ - - - - - -ProcessSessionBean (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Interface ProcessSessionBean<X>

-
-
-
-
    -
  • -
    -
    Type Parameters:
    -
    X - session bean type
    -
    -
    -
    All Superinterfaces:
    -
    ProcessBean<java.lang.Object>, ProcessManagedBean<java.lang.Object>
    -
    -
    -
    public interface ProcessSessionBean<X>
    -extends ProcessManagedBean<java.lang.Object>
    -

    - The container fires an event of this type for each enabled session bean, before registering the - Bean object. -

    - -

    - If any observer method of a ProcessSessionBean event throws an exception, the exception is treated as a definition - error by the container. -

    - -

    - Note that the type parameter of the super-interface of ProcessSessionBean is Object as ProcessBean - allows you access to the Bean, which in turn allows you to instantiate an instance, which, for interface-view EJBs - will not be an instance of X. -

    - -

    CDI Lite implementations are not required to provide support for Portable Extensions.

    -
    -
    Author:
    -
    David Allen
    -
    -
  • -
-
-
- -
-
-
    -
  • - -
    -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        getEjbName

        -
        java.lang.String getEjbName()
        -
        Returns the EJB name of the session bean.
        -
        -
        Returns:
        -
        the name of the EJB
        -
        Throws:
        -
        java.lang.IllegalStateException - if called outside of the observer method invocation
        -
        -
      • -
      - - - -
        -
      • -

        getSessionBeanType

        -
        SessionBeanType getSessionBeanType()
        -
        Returns a SessionBeanType representing the kind of session bean.
        -
        -
        Returns:
        -
        the SessionBeanType
        -
        Throws:
        -
        java.lang.IllegalStateException - if called outside of the observer method invocation
        -
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- -
- -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

-
- - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/ProcessSyntheticAnnotatedType.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/ProcessSyntheticAnnotatedType.html deleted file mode 100644 index 2790c40e97..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/ProcessSyntheticAnnotatedType.html +++ /dev/null @@ -1,316 +0,0 @@ - - - - - -ProcessSyntheticAnnotatedType (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Interface ProcessSyntheticAnnotatedType<X>

-
-
-
- -
-
- -
-
-
    -
  • - -
    -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        getSource

        -
        Extension getSource()
        -
        Get the extension instance which added the AnnotatedType for which this event is being fired.
        -
        -
        Returns:
        -
        the extension instance
        -
        Throws:
        -
        java.lang.IllegalStateException - if called outside of the observer method invocation
        -
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- -
- -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

-
- - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/ProcessSyntheticBean.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/ProcessSyntheticBean.html deleted file mode 100644 index 06f554a82b..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/ProcessSyntheticBean.html +++ /dev/null @@ -1,298 +0,0 @@ - - - - - -ProcessSyntheticBean (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Interface ProcessSyntheticBean<X>

-
-
-
-
    -
  • -
    -
    Type Parameters:
    -
    X - The class of the bean
    -
    -
    -
    All Superinterfaces:
    -
    ProcessBean<X>
    -
    -
    -
    public interface ProcessSyntheticBean<X>
    -extends ProcessBean<X>
    -

    - The container fires an event of this type for each custom bean implementation added through - AfterBeanDiscovery.addBean() or AfterBeanDiscovery.addBean(Bean), before registering the - Bean object. -

    -

    - If any observer method of a ProcessSyntheticBean event throws an exception, the exception is treated as a definition - error by the container. -

    - -

    CDI Lite implementations are not required to provide support for Portable Extensions.

    -
    -
    Since:
    -
    2.0
    -
    Author:
    -
    Martin Kouba
    -
    -
  • -
-
-
- -
-
-
    -
  • - -
    -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        getSource

        -
        Extension getSource()
        -
        Get the extension instance which added the Bean for which this event is being fired.
        -
        -
        Returns:
        -
        the extension instance
        -
        Throws:
        -
        java.lang.IllegalStateException - if called outside of the observer method invocation
        -
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- -
- -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

-
- - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/ProcessSyntheticObserverMethod.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/ProcessSyntheticObserverMethod.html deleted file mode 100644 index fdfffb3180..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/ProcessSyntheticObserverMethod.html +++ /dev/null @@ -1,301 +0,0 @@ - - - - - -ProcessSyntheticObserverMethod (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Interface ProcessSyntheticObserverMethod<T,​X>

-
-
-
- -
-
- -
-
-
    -
  • - -
    -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        getSource

        -
        Extension getSource()
        -
        Get the extension instance which added the ObserverMethod for which this event is being fired.
        -
        -
        Returns:
        -
        the extension instance
        -
        Throws:
        -
        java.lang.IllegalStateException - if called outside of the observer method invocation
        -
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- -
- -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

-
- - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/Producer.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/Producer.html deleted file mode 100644 index 2eaa33ea0f..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/Producer.html +++ /dev/null @@ -1,355 +0,0 @@ - - - - - -Producer (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Interface Producer<T>

-
-
-
-
    -
  • -
    -
    Type Parameters:
    -
    T - The class of object produced by the producer
    -
    -
    -
    All Known Subinterfaces:
    -
    InjectionTarget<T>
    -
    -
    -
    public interface Producer<T>
    -

    - Provides a generic operation for producing an instance of a type. -

    - -

    CDI Lite implementations are not required to provide support for Producer.

    -
    -
    Author:
    -
    Pete Muir, David Allen
    -
    -
  • -
-
-
- -
-
-
    -
  • - -
    -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        produce

        -
        T produce​(CreationalContext<T> ctx)
        -

        - Causes an instance to be produced via the Producer. -

        -

        - If the Producer represents a class, this will invoke the constructor annotated Inject if it - exists, or the constructor with no parameters otherwise. If the class has interceptors, produce() is responsible - for building the interceptors and decorators of the instance. -

        -

        - If the Producer represents a producer field or method, this will invoke the producer method on, or access the - producer field of, a contextual instance of the bean that declares the producer. -

        -
        -
        Parameters:
        -
        ctx - The CreationalContext to use for the produced object
        -
        Returns:
        -
        the instance produced
        -
        -
      • -
      - - - - - -
        -
      • -

        dispose

        -
        void dispose​(T instance)
        -

        - Destroys the instance. -

        -

        - If the Producer represents a class, then this operation does nothing. -

        -

        - If the Producer represents a producer field or method, this calls the disposer method, if any, on a contextual - instance of the bean that declares the disposer method or performs any additional required cleanup, if any, to destroy - state associated with a resource. -

        -
        -
        Parameters:
        -
        instance - The instance to dispose
        -
        -
      • -
      - - - -
        -
      • -

        getInjectionPoints

        -
        java.util.Set<InjectionPoint> getInjectionPoints()
        -

        - Returns the set of all InjectionPoints. If the Producer represents a class, then this returns returns the - set of InjectionPoint objects representing all injected fields, bean constructor parameters and initializer - method parameters. For a producer method, this returns the set of InjectionPoint objects representing all - parameters of the producer method. -

        -
        -
        Returns:
        -
        the set of all injection points for the producer
        -
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- -
- -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

-
- - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/ProducerFactory.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/ProducerFactory.html deleted file mode 100644 index 1cd92ab4a8..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/ProducerFactory.html +++ /dev/null @@ -1,302 +0,0 @@ - - - - - -ProducerFactory (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Interface ProducerFactory<X>

-
-
-
-
    -
  • -
    -
    Type Parameters:
    -
    X - type of the bean containing the producer
    -
    -
    -
    public interface ProducerFactory<X>
    -

    - An ProducerFactory can create an Producer for a given bean. -

    - -

    - The ProducerFactory obtained from BeanManager.getProducerFactory(AnnotatedMethod, Bean) or - BeanManager.getProducerFactory(AnnotatedField, Bean) is capable of providing container created - producers. This factory can be wrapped to add behavior to container created producers. -

    - -

    - For example: -

    - -
    - BeanAttributes<MyBean> myBeanAttributes = beanManager.createBeanAttributes(myBeanAnnotatedFieldField);
    - beanManager.createBean(myBeanAttributes, MyBean.class, new ProducerFactory() {
    - 
    -     public <T> Producer<T> createProducer(Bean<T> bean) {
    -         return new WrappingProducer<T>(beanManager.getProducerFactory(myBeanAnnotatedField).createProducer(bean));
    -     }
    - });
    - 
    - -

    CDI Lite implementations are not required to provide support for ProducerFactory.

    -
    -
    Since:
    -
    1.1
    -
    Author:
    -
    Pete Muir
    -
    -
  • -
-
-
- -
-
-
    -
  • - -
    -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        createProducer

        -
        <T> Producer<T> createProducer​(Bean<T> bean)
        -
        Create a new producer for a bean.
        -
        -
        Type Parameters:
        -
        T - bean type
        -
        Parameters:
        -
        bean - the bean to create the producer for, or null if creating a non-contextual object
        -
        Returns:
        -
        the producer
        -
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- -
- -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

-
- - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/SessionBeanType.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/SessionBeanType.html deleted file mode 100644 index a4ea2911aa..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/SessionBeanType.html +++ /dev/null @@ -1,411 +0,0 @@ - - - - - -SessionBeanType (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Enum SessionBeanType

-
-
-
    -
  • java.lang.Object
  • -
  • -
      -
    • java.lang.Enum<SessionBeanType>
    • -
    • -
        -
      • jakarta.enterprise.inject.spi.SessionBeanType
      • -
      -
    • -
    -
  • -
-
-
    -
  • -
    -
    All Implemented Interfaces:
    -
    java.io.Serializable, java.lang.Comparable<SessionBeanType>
    -
    -
    -
    public enum SessionBeanType
    -extends java.lang.Enum<SessionBeanType>
    -
    Identifies the kind of EJB session bean.
    -
    -
    Author:
    -
    Gavin King
    -
    -
  • -
-
-
-
    -
  • - -
    -
      -
    • - - -

      Enum Constant Summary

      - - - - - - - - - - - - - - - - - - -
      Enum Constants 
      Enum ConstantDescription
      SINGLETON -
      A singleton (jakarta.ejb.Singleton) session bean
      -
      STATEFUL -
      A stateful (jakarta.ejb.Stateful) session bean
      -
      STATELESS -
      A stateless (jakarta.ejb.Stateless) session bean
      -
      -
    • -
    -
    - -
    -
      -
    • - - -

      Method Summary

      - - - - - - - - - - - - - - - - - -
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethodDescription
      static SessionBeanTypevalueOf​(java.lang.String name) -
      Returns the enum constant of this type with the specified name.
      -
      static SessionBeanType[]values() -
      Returns an array containing the constants of this enum type, in -the order they are declared.
      -
      -
        -
      • - - -

        Methods inherited from class java.lang.Enum

        -clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
      • -
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

        -getClass, notify, notifyAll, wait, wait, wait
      • -
      -
    • -
    -
    -
  • -
-
-
-
    -
  • - -
    -
      -
    • - - -

      Enum Constant Detail

      - - - -
        -
      • -

        STATELESS

        -
        public static final SessionBeanType STATELESS
        -
        A stateless (jakarta.ejb.Stateless) session bean
        -
      • -
      - - - -
        -
      • -

        STATEFUL

        -
        public static final SessionBeanType STATEFUL
        -
        A stateful (jakarta.ejb.Stateful) session bean
        -
      • -
      - - - -
        -
      • -

        SINGLETON

        -
        public static final SessionBeanType SINGLETON
        -
        A singleton (jakarta.ejb.Singleton) session bean
        -
      • -
      -
    • -
    -
    - -
    -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        values

        -
        public static SessionBeanType[] values()
        -
        Returns an array containing the constants of this enum type, in -the order they are declared. This method may be used to iterate -over the constants as follows: -
        -for (SessionBeanType c : SessionBeanType.values())
        -    System.out.println(c);
        -
        -
        -
        Returns:
        -
        an array containing the constants of this enum type, in the order they are declared
        -
        -
      • -
      - - - -
        -
      • -

        valueOf

        -
        public static SessionBeanType valueOf​(java.lang.String name)
        -
        Returns the enum constant of this type with the specified name. -The string must match exactly an identifier used to declare an -enum constant in this type. (Extraneous whitespace characters are -not permitted.)
        -
        -
        Parameters:
        -
        name - the name of the enum constant to be returned.
        -
        Returns:
        -
        the enum constant with the specified name
        -
        Throws:
        -
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        -
        java.lang.NullPointerException - if the argument is null
        -
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- - - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/Unmanaged.UnmanagedInstance.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/Unmanaged.UnmanagedInstance.html deleted file mode 100644 index d611725b3f..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/Unmanaged.UnmanagedInstance.html +++ /dev/null @@ -1,408 +0,0 @@ - - - - - -Unmanaged.UnmanagedInstance (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Class Unmanaged.UnmanagedInstance<T>

-
-
-
    -
  • java.lang.Object
  • -
  • -
      -
    • jakarta.enterprise.inject.spi.Unmanaged.UnmanagedInstance<T>
    • -
    -
  • -
-
-
    -
  • -
    -
    Enclosing class:
    -
    Unmanaged<T>
    -
    -
    -
    public static class Unmanaged.UnmanagedInstance<T>
    -extends java.lang.Object
    -
    Represents a non-contextual instance.
    -
    -
    See Also:
    -
    Unmanaged
    -
    -
  • -
-
-
- -
-
-
    -
  • - -
    -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        get

        -
        public T get()
        -
        Get the instance
        -
        -
        Returns:
        -
        the instance
        -
        -
      • -
      - - - -
        -
      • -

        produce

        -
        public Unmanaged.UnmanagedInstance<T> produce()
        -
        Create the instance
        -
        -
        Returns:
        -
        self
        -
        Throws:
        -
        java.lang.IllegalStateException - if produce() is called on an already produced instance
        -
        java.lang.IllegalStateException - if produce() is called on an instance that has already been disposed
        -
        -
      • -
      - - - -
        -
      • -

        inject

        -
        public Unmanaged.UnmanagedInstance<T> inject()
        -
        Inject the instance
        -
        -
        Returns:
        -
        self
        -
        Throws:
        -
        java.lang.IllegalStateException - if inject() is called before produce() is called
        -
        java.lang.IllegalStateException - if inject() is called on an instance that has already been disposed
        -
        -
      • -
      - - - -
        -
      • -

        postConstruct

        -
        public Unmanaged.UnmanagedInstance<T> postConstruct()
        -
        Call the @PostConstruct callback
        -
        -
        Returns:
        -
        self
        -
        Throws:
        -
        java.lang.IllegalStateException - if postConstruct() is called before produce() is called
        -
        java.lang.IllegalStateException - if postConstruct() is called on an instance that has already been disposed
        -
        -
      • -
      - - - -
        -
      • -

        preDestroy

        -
        public Unmanaged.UnmanagedInstance<T> preDestroy()
        -
        Call the @PreDestroy callback
        -
        -
        Returns:
        -
        self
        -
        Throws:
        -
        java.lang.IllegalStateException - if preDestroy() is called before produce() is called
        -
        java.lang.IllegalStateException - if preDestroy() is called on an instance that has already been disposed
        -
        -
      • -
      - - - -
        -
      • -

        dispose

        -
        public Unmanaged.UnmanagedInstance<T> dispose()
        -
        Dispose of the instance, doing any necessary cleanup
        -
        -
        Returns:
        -
        self
        -
        Throws:
        -
        java.lang.IllegalStateException - if dispose() is called before produce() is called
        -
        java.lang.IllegalStateException - if dispose() is called on an instance that has already been disposed
        -
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- -
- -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

-
- - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/Unmanaged.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/Unmanaged.html deleted file mode 100644 index e3cceb57ef..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/Unmanaged.html +++ /dev/null @@ -1,405 +0,0 @@ - - - - - -Unmanaged (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Class Unmanaged<T>

-
-
-
    -
  • java.lang.Object
  • -
  • -
      -
    • jakarta.enterprise.inject.spi.Unmanaged<T>
    • -
    -
  • -
-
-
    -
  • -
    -
    Type Parameters:
    -
    T - type of unmanaged instances
    -
    -
    -
    public class Unmanaged<T>
    -extends java.lang.Object
    -

    - Helper class for injecting and calling lifecycle callbacks unmanaged instances for use by framework and library integrators. -

    - -
    - Unmanaged<Foo> unmanagedFoo = new Unmanaged<Foo>(Foo.class);
    - UnmanagedInstance<Foo> fooInstance = unmanagedFoo.newInstance();
    - Foo foo = fooInstance.produce().inject().postConstruct().get();
    - ... // Use the foo instance
    - fooInstance.preDestroy().dispose();
    - 
    - -

    - An instance of this class can be safely held for the lifetime of the application. -

    - -

    - Unmanaged.UnmanagedInstances created by this class are not suitable for sharing between threads. -

    - -

    CDI Lite implementations are not required to provide support for Unmanaged.

    -
    -
    Since:
    -
    1.1
    -
    Author:
    -
    Pete Muir
    -
    -
  • -
-
-
-
    -
  • - -
    -
      -
    • - - -

      Nested Class Summary

      - - - - - - - - - - - - -
      Nested Classes 
      Modifier and TypeClassDescription
      static class Unmanaged.UnmanagedInstance<T> -
      Represents a non-contextual instance.
      -
      -
    • -
    -
    - -
    -
      -
    • - - -

      Constructor Summary

      - - - - - - - - - - - - - - -
      Constructors 
      ConstructorDescription
      Unmanaged​(BeanManager manager, - java.lang.Class<T> clazz) -
      Create an injector for the given class
      -
      Unmanaged​(java.lang.Class<T> clazz) -
      Create an injector for the given class, using the current bean manager
      -
      -
    • -
    -
    - -
    - -
    -
  • -
-
-
-
    -
  • - -
    -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        Unmanaged

        -
        public Unmanaged​(BeanManager manager,
        -                 java.lang.Class<T> clazz)
        -
        Create an injector for the given class
        -
        -
        Parameters:
        -
        manager - the BeanManager
        -
        clazz - class of the unmanaged instances
        -
        -
      • -
      - - - -
        -
      • -

        Unmanaged

        -
        public Unmanaged​(java.lang.Class<T> clazz)
        -
        Create an injector for the given class, using the current bean manager
        -
        -
        Parameters:
        -
        clazz - class of the unmanaged instances
        -
        -
      • -
      -
    • -
    -
    - -
    - -
    -
  • -
-
-
-
- - - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/WithAnnotations.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/WithAnnotations.html deleted file mode 100644 index 22aafef412..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/WithAnnotations.html +++ /dev/null @@ -1,267 +0,0 @@ - - - - - -WithAnnotations (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Annotation Type WithAnnotations

-
-
-
-
    -
  • -
    -
    @Retention(RUNTIME)
    -@Target(PARAMETER)
    -public @interface WithAnnotations
    -

    - WithAnnotations may be applied to any portable extension observer method with an event parameter type of - ProcessAnnotatedType to filter the events delivered. -

    - -

    - If the WithAnnotations annotation is applied to a portable extension observer method, then only - ProcessAnnotatedType events for types which have at least one of the annotations specified are observed. The - annotation can appear on the annotated type, or on any member, or any parameter of any member of the annotated type, as defined - in section 11.4 Alternative metadata sources. - The annotation may be applied as a meta-annotation on any annotation considered. - -

    CDI Lite implementations are not required to provide support for Portable Extensions.

    -
    -
    Since:
    -
    1.1
    -
    Author:
    -
    Pete Muir
    -
    -
  • -
-
-
-
    -
  • - -
    -
      -
    • - - -

      Required Element Summary

      - - - - - - - - - - - - -
      Required Elements 
      Modifier and TypeRequired ElementDescription
      java.lang.Class<? extends java.lang.annotation.Annotation>[]value 
      -
    • -
    -
    -
  • -
-
-
-
    -
  • - -
    -
      -
    • - - -

      Element Detail

      - - - -
        -
      • -

        value

        -
        java.lang.Class<? extends java.lang.annotation.Annotation>[] value
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- - - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/AfterBeanDiscovery.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/AfterBeanDiscovery.html deleted file mode 100644 index d997f79c62..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/AfterBeanDiscovery.html +++ /dev/null @@ -1,153 +0,0 @@ - - - - - -Uses of Interface jakarta.enterprise.inject.spi.AfterBeanDiscovery (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Interface
jakarta.enterprise.inject.spi.AfterBeanDiscovery

-
-
No usage of jakarta.enterprise.inject.spi.AfterBeanDiscovery
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/AfterDeploymentValidation.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/AfterDeploymentValidation.html deleted file mode 100644 index 37b203ce7a..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/AfterDeploymentValidation.html +++ /dev/null @@ -1,153 +0,0 @@ - - - - - -Uses of Interface jakarta.enterprise.inject.spi.AfterDeploymentValidation (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Interface
jakarta.enterprise.inject.spi.AfterDeploymentValidation

-
-
No usage of jakarta.enterprise.inject.spi.AfterDeploymentValidation
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/AfterTypeDiscovery.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/AfterTypeDiscovery.html deleted file mode 100644 index f993cb030a..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/AfterTypeDiscovery.html +++ /dev/null @@ -1,153 +0,0 @@ - - - - - -Uses of Interface jakarta.enterprise.inject.spi.AfterTypeDiscovery (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Interface
jakarta.enterprise.inject.spi.AfterTypeDiscovery

-
-
No usage of jakarta.enterprise.inject.spi.AfterTypeDiscovery
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/Annotated.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/Annotated.html deleted file mode 100644 index 9b3944fe09..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/Annotated.html +++ /dev/null @@ -1,283 +0,0 @@ - - - - - -Uses of Interface jakarta.enterprise.inject.spi.Annotated (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Interface
jakarta.enterprise.inject.spi.Annotated

-
-
- -
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/AnnotatedCallable.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/AnnotatedCallable.html deleted file mode 100644 index bda17dea07..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/AnnotatedCallable.html +++ /dev/null @@ -1,228 +0,0 @@ - - - - - -Uses of Interface jakarta.enterprise.inject.spi.AnnotatedCallable (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Interface
jakarta.enterprise.inject.spi.AnnotatedCallable

-
-
- -
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/AnnotatedConstructor.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/AnnotatedConstructor.html deleted file mode 100644 index 97a8329c3e..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/AnnotatedConstructor.html +++ /dev/null @@ -1,243 +0,0 @@ - - - - - -Uses of Interface jakarta.enterprise.inject.spi.AnnotatedConstructor (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Interface
jakarta.enterprise.inject.spi.AnnotatedConstructor

-
-
- -
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/AnnotatedField.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/AnnotatedField.html deleted file mode 100644 index 752fc2eef5..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/AnnotatedField.html +++ /dev/null @@ -1,287 +0,0 @@ - - - - - -Uses of Interface jakarta.enterprise.inject.spi.AnnotatedField (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Interface
jakarta.enterprise.inject.spi.AnnotatedField

-
-
- -
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/AnnotatedMember.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/AnnotatedMember.html deleted file mode 100644 index 0e4f765952..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/AnnotatedMember.html +++ /dev/null @@ -1,261 +0,0 @@ - - - - - -Uses of Interface jakarta.enterprise.inject.spi.AnnotatedMember (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Interface
jakarta.enterprise.inject.spi.AnnotatedMember

-
-
- -
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/AnnotatedMethod.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/AnnotatedMethod.html deleted file mode 100644 index b43eba1d79..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/AnnotatedMethod.html +++ /dev/null @@ -1,311 +0,0 @@ - - - - - -Uses of Interface jakarta.enterprise.inject.spi.AnnotatedMethod (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Interface
jakarta.enterprise.inject.spi.AnnotatedMethod

-
-
- -
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/AnnotatedParameter.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/AnnotatedParameter.html deleted file mode 100644 index 07faf56f0e..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/AnnotatedParameter.html +++ /dev/null @@ -1,291 +0,0 @@ - - - - - -Uses of Interface jakarta.enterprise.inject.spi.AnnotatedParameter (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Interface
jakarta.enterprise.inject.spi.AnnotatedParameter

-
-
- -
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/AnnotatedType.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/AnnotatedType.html deleted file mode 100644 index e2ef68657c..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/AnnotatedType.html +++ /dev/null @@ -1,370 +0,0 @@ - - - - - -Uses of Interface jakarta.enterprise.inject.spi.AnnotatedType (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Interface
jakarta.enterprise.inject.spi.AnnotatedType

-
-
- -
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/Bean.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/Bean.html deleted file mode 100644 index 4c655d2314..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/Bean.html +++ /dev/null @@ -1,413 +0,0 @@ - - - - - -Uses of Interface jakarta.enterprise.inject.spi.Bean (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Interface
jakarta.enterprise.inject.spi.Bean

-
-
- -
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/BeanAttributes.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/BeanAttributes.html deleted file mode 100644 index 4ed2414c46..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/BeanAttributes.html +++ /dev/null @@ -1,312 +0,0 @@ - - - - - -Uses of Interface jakarta.enterprise.inject.spi.BeanAttributes (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Interface
jakarta.enterprise.inject.spi.BeanAttributes

-
-
- -
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/BeanContainer.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/BeanContainer.html deleted file mode 100644 index 55c5229fa1..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/BeanContainer.html +++ /dev/null @@ -1,247 +0,0 @@ - - - - - -Uses of Interface jakarta.enterprise.inject.spi.BeanContainer (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Interface
jakarta.enterprise.inject.spi.BeanContainer

-
-
- -
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/BeanManager.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/BeanManager.html deleted file mode 100644 index 7b7a159747..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/BeanManager.html +++ /dev/null @@ -1,245 +0,0 @@ - - - - - -Uses of Interface jakarta.enterprise.inject.spi.BeanManager (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Interface
jakarta.enterprise.inject.spi.BeanManager

-
-
- -
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/BeforeBeanDiscovery.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/BeforeBeanDiscovery.html deleted file mode 100644 index 7a758442dc..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/BeforeBeanDiscovery.html +++ /dev/null @@ -1,153 +0,0 @@ - - - - - -Uses of Interface jakarta.enterprise.inject.spi.BeforeBeanDiscovery (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Interface
jakarta.enterprise.inject.spi.BeforeBeanDiscovery

-
-
No usage of jakarta.enterprise.inject.spi.BeforeBeanDiscovery
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/BeforeShutdown.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/BeforeShutdown.html deleted file mode 100644 index 6f9c92a128..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/BeforeShutdown.html +++ /dev/null @@ -1,153 +0,0 @@ - - - - - -Uses of Interface jakarta.enterprise.inject.spi.BeforeShutdown (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Interface
jakarta.enterprise.inject.spi.BeforeShutdown

-
-
No usage of jakarta.enterprise.inject.spi.BeforeShutdown
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/CDI.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/CDI.html deleted file mode 100644 index 4042e83250..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/CDI.html +++ /dev/null @@ -1,209 +0,0 @@ - - - - - -Uses of Class jakarta.enterprise.inject.spi.CDI (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Class
jakarta.enterprise.inject.spi.CDI

-
-
- -
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/CDIProvider.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/CDIProvider.html deleted file mode 100644 index 77206eb542..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/CDIProvider.html +++ /dev/null @@ -1,232 +0,0 @@ - - - - - -Uses of Interface jakarta.enterprise.inject.spi.CDIProvider (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Interface
jakarta.enterprise.inject.spi.CDIProvider

-
-
- -
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/Decorator.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/Decorator.html deleted file mode 100644 index 940005ecbb..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/Decorator.html +++ /dev/null @@ -1,204 +0,0 @@ - - - - - -Uses of Interface jakarta.enterprise.inject.spi.Decorator (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Interface
jakarta.enterprise.inject.spi.Decorator

-
-
-
    -
  • - - - - - - - - - - - - -
    Packages that use Decorator 
    PackageDescription
    jakarta.enterprise.inject.spi -
    The portable extension integration SPI.
    -
    -
  • -
  • -
      -
    • -
      - - -

      Uses of Decorator in jakarta.enterprise.inject.spi

      - - - - - - - - - - - - - - -
      Methods in jakarta.enterprise.inject.spi that return types with arguments of type Decorator 
      Modifier and TypeMethodDescription
      java.util.List<Decorator<?>>BeanManager.resolveDecorators​(java.util.Set<java.lang.reflect.Type> types, - java.lang.annotation.Annotation... qualifiers) -
      Return an ordered list of 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 BeanManager was injected or the Java EE - component from whose JNDI environment namespace the BeanManager was obtained.
      -
      -
      -
    • -
    -
  • -
-
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/DefinitionException.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/DefinitionException.html deleted file mode 100644 index 00f096a588..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/DefinitionException.html +++ /dev/null @@ -1,153 +0,0 @@ - - - - - -Uses of Class jakarta.enterprise.inject.spi.DefinitionException (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Class
jakarta.enterprise.inject.spi.DefinitionException

-
-
No usage of jakarta.enterprise.inject.spi.DefinitionException
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/DeploymentException.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/DeploymentException.html deleted file mode 100644 index 42c14af965..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/DeploymentException.html +++ /dev/null @@ -1,153 +0,0 @@ - - - - - -Uses of Class jakarta.enterprise.inject.spi.DeploymentException (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Class
jakarta.enterprise.inject.spi.DeploymentException

-
-
No usage of jakarta.enterprise.inject.spi.DeploymentException
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/EventContext.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/EventContext.html deleted file mode 100644 index b68d65f271..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/EventContext.html +++ /dev/null @@ -1,258 +0,0 @@ - - - - - -Uses of Interface jakarta.enterprise.inject.spi.EventContext (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Interface
jakarta.enterprise.inject.spi.EventContext

-
-
- -
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/EventMetadata.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/EventMetadata.html deleted file mode 100644 index 7489a574e1..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/EventMetadata.html +++ /dev/null @@ -1,199 +0,0 @@ - - - - - -Uses of Interface jakarta.enterprise.inject.spi.EventMetadata (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Interface
jakarta.enterprise.inject.spi.EventMetadata

-
-
- -
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/Extension.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/Extension.html deleted file mode 100644 index a3a8c16857..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/Extension.html +++ /dev/null @@ -1,291 +0,0 @@ - - - - - -Uses of Interface jakarta.enterprise.inject.spi.Extension (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Interface
jakarta.enterprise.inject.spi.Extension

-
-
- -
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/InjectionPoint.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/InjectionPoint.html deleted file mode 100644 index 99eb36cc1d..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/InjectionPoint.html +++ /dev/null @@ -1,345 +0,0 @@ - - - - - -Uses of Interface jakarta.enterprise.inject.spi.InjectionPoint (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Interface
jakarta.enterprise.inject.spi.InjectionPoint

-
-
- -
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/InjectionTarget.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/InjectionTarget.html deleted file mode 100644 index 7d0d56ec39..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/InjectionTarget.html +++ /dev/null @@ -1,226 +0,0 @@ - - - - - -Uses of Interface jakarta.enterprise.inject.spi.InjectionTarget (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Interface
jakarta.enterprise.inject.spi.InjectionTarget

-
-
- -
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/InjectionTargetFactory.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/InjectionTargetFactory.html deleted file mode 100644 index 3cf7ffb7ec..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/InjectionTargetFactory.html +++ /dev/null @@ -1,222 +0,0 @@ - - - - - -Uses of Interface jakarta.enterprise.inject.spi.InjectionTargetFactory (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Interface
jakarta.enterprise.inject.spi.InjectionTargetFactory

-
-
- -
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/InterceptionFactory.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/InterceptionFactory.html deleted file mode 100644 index 1b1df286c1..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/InterceptionFactory.html +++ /dev/null @@ -1,211 +0,0 @@ - - - - - -Uses of Interface jakarta.enterprise.inject.spi.InterceptionFactory (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Interface
jakarta.enterprise.inject.spi.InterceptionFactory

-
-
- -
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/InterceptionType.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/InterceptionType.html deleted file mode 100644 index 0a1bdd6be7..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/InterceptionType.html +++ /dev/null @@ -1,282 +0,0 @@ - - - - - -Uses of Class jakarta.enterprise.inject.spi.InterceptionType (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Class
jakarta.enterprise.inject.spi.InterceptionType

-
-
- -
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/Interceptor.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/Interceptor.html deleted file mode 100644 index 1a111e0173..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/Interceptor.html +++ /dev/null @@ -1,206 +0,0 @@ - - - - - -Uses of Interface jakarta.enterprise.inject.spi.Interceptor (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Interface
jakarta.enterprise.inject.spi.Interceptor

-
-
-
    -
  • - - - - - - - - - - - - -
    Packages that use Interceptor 
    PackageDescription
    jakarta.enterprise.inject.spi -
    The portable extension integration SPI.
    -
    -
  • -
  • -
      -
    • -
      - - -

      Uses of Interceptor in jakarta.enterprise.inject.spi

      - - - - - - - - - - - - - - -
      Methods in jakarta.enterprise.inject.spi that return types with arguments of type Interceptor 
      Modifier and TypeMethodDescription
      java.util.List<Interceptor<?>>BeanContainer.resolveInterceptors​(InterceptionType type, - java.lang.annotation.Annotation... interceptorBindings) -
      Return an ordered list of enabled 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 - BeanManager/BeanContainer was injected or, in the Jakarta EE environment, - the Jakarta EE component from whose JNDI environment namespace the - BeanManager/BeanContainer was obtained.
      -
      -
      -
    • -
    -
  • -
-
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/ObserverMethod.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/ObserverMethod.html deleted file mode 100644 index 60b02822c7..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/ObserverMethod.html +++ /dev/null @@ -1,275 +0,0 @@ - - - - - -Uses of Interface jakarta.enterprise.inject.spi.ObserverMethod (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Interface
jakarta.enterprise.inject.spi.ObserverMethod

-
-
- -
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/PassivationCapable.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/PassivationCapable.html deleted file mode 100644 index b044b7f1a2..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/PassivationCapable.html +++ /dev/null @@ -1,153 +0,0 @@ - - - - - -Uses of Interface jakarta.enterprise.inject.spi.PassivationCapable (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Interface
jakarta.enterprise.inject.spi.PassivationCapable

-
-
No usage of jakarta.enterprise.inject.spi.PassivationCapable
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/Prioritized.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/Prioritized.html deleted file mode 100644 index e7ada75742..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/Prioritized.html +++ /dev/null @@ -1,240 +0,0 @@ - - - - - -Uses of Interface jakarta.enterprise.inject.spi.Prioritized (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Interface
jakarta.enterprise.inject.spi.Prioritized

-
-
- -
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/ProcessAnnotatedType.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/ProcessAnnotatedType.html deleted file mode 100644 index 2ec4e5ec74..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/ProcessAnnotatedType.html +++ /dev/null @@ -1,204 +0,0 @@ - - - - - -Uses of Interface jakarta.enterprise.inject.spi.ProcessAnnotatedType (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Interface
jakarta.enterprise.inject.spi.ProcessAnnotatedType

-
-
- -
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/ProcessBean.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/ProcessBean.html deleted file mode 100644 index 34f3dd615e..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/ProcessBean.html +++ /dev/null @@ -1,240 +0,0 @@ - - - - - -Uses of Interface jakarta.enterprise.inject.spi.ProcessBean (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Interface
jakarta.enterprise.inject.spi.ProcessBean

-
-
- -
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/ProcessBeanAttributes.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/ProcessBeanAttributes.html deleted file mode 100644 index 57505aa875..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/ProcessBeanAttributes.html +++ /dev/null @@ -1,153 +0,0 @@ - - - - - -Uses of Interface jakarta.enterprise.inject.spi.ProcessBeanAttributes (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Interface
jakarta.enterprise.inject.spi.ProcessBeanAttributes

-
-
No usage of jakarta.enterprise.inject.spi.ProcessBeanAttributes
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/ProcessInjectionPoint.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/ProcessInjectionPoint.html deleted file mode 100644 index 6377560714..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/ProcessInjectionPoint.html +++ /dev/null @@ -1,153 +0,0 @@ - - - - - -Uses of Interface jakarta.enterprise.inject.spi.ProcessInjectionPoint (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Interface
jakarta.enterprise.inject.spi.ProcessInjectionPoint

-
-
No usage of jakarta.enterprise.inject.spi.ProcessInjectionPoint
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/ProcessInjectionTarget.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/ProcessInjectionTarget.html deleted file mode 100644 index 75be9c9e41..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/ProcessInjectionTarget.html +++ /dev/null @@ -1,153 +0,0 @@ - - - - - -Uses of Interface jakarta.enterprise.inject.spi.ProcessInjectionTarget (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Interface
jakarta.enterprise.inject.spi.ProcessInjectionTarget

-
-
No usage of jakarta.enterprise.inject.spi.ProcessInjectionTarget
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/ProcessManagedBean.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/ProcessManagedBean.html deleted file mode 100644 index 329c436b0c..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/ProcessManagedBean.html +++ /dev/null @@ -1,203 +0,0 @@ - - - - - -Uses of Interface jakarta.enterprise.inject.spi.ProcessManagedBean (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Interface
jakarta.enterprise.inject.spi.ProcessManagedBean

-
-
- -
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/ProcessObserverMethod.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/ProcessObserverMethod.html deleted file mode 100644 index d054276a1c..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/ProcessObserverMethod.html +++ /dev/null @@ -1,204 +0,0 @@ - - - - - -Uses of Interface jakarta.enterprise.inject.spi.ProcessObserverMethod (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Interface
jakarta.enterprise.inject.spi.ProcessObserverMethod

-
-
- -
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/ProcessProducer.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/ProcessProducer.html deleted file mode 100644 index 90eab2b330..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/ProcessProducer.html +++ /dev/null @@ -1,153 +0,0 @@ - - - - - -Uses of Interface jakarta.enterprise.inject.spi.ProcessProducer (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Interface
jakarta.enterprise.inject.spi.ProcessProducer

-
-
No usage of jakarta.enterprise.inject.spi.ProcessProducer
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/ProcessProducerField.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/ProcessProducerField.html deleted file mode 100644 index 3c088c9ccd..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/ProcessProducerField.html +++ /dev/null @@ -1,153 +0,0 @@ - - - - - -Uses of Interface jakarta.enterprise.inject.spi.ProcessProducerField (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Interface
jakarta.enterprise.inject.spi.ProcessProducerField

-
-
No usage of jakarta.enterprise.inject.spi.ProcessProducerField
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/ProcessProducerMethod.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/ProcessProducerMethod.html deleted file mode 100644 index 636d0b92bb..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/ProcessProducerMethod.html +++ /dev/null @@ -1,153 +0,0 @@ - - - - - -Uses of Interface jakarta.enterprise.inject.spi.ProcessProducerMethod (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Interface
jakarta.enterprise.inject.spi.ProcessProducerMethod

-
-
No usage of jakarta.enterprise.inject.spi.ProcessProducerMethod
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/ProcessSessionBean.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/ProcessSessionBean.html deleted file mode 100644 index f5052d1e66..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/ProcessSessionBean.html +++ /dev/null @@ -1,153 +0,0 @@ - - - - - -Uses of Interface jakarta.enterprise.inject.spi.ProcessSessionBean (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Interface
jakarta.enterprise.inject.spi.ProcessSessionBean

-
-
No usage of jakarta.enterprise.inject.spi.ProcessSessionBean
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/ProcessSyntheticAnnotatedType.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/ProcessSyntheticAnnotatedType.html deleted file mode 100644 index d52aa1b679..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/ProcessSyntheticAnnotatedType.html +++ /dev/null @@ -1,153 +0,0 @@ - - - - - -Uses of Interface jakarta.enterprise.inject.spi.ProcessSyntheticAnnotatedType (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Interface
jakarta.enterprise.inject.spi.ProcessSyntheticAnnotatedType

-
-
No usage of jakarta.enterprise.inject.spi.ProcessSyntheticAnnotatedType
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/ProcessSyntheticBean.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/ProcessSyntheticBean.html deleted file mode 100644 index a83af437fc..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/ProcessSyntheticBean.html +++ /dev/null @@ -1,153 +0,0 @@ - - - - - -Uses of Interface jakarta.enterprise.inject.spi.ProcessSyntheticBean (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Interface
jakarta.enterprise.inject.spi.ProcessSyntheticBean

-
-
No usage of jakarta.enterprise.inject.spi.ProcessSyntheticBean
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/ProcessSyntheticObserverMethod.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/ProcessSyntheticObserverMethod.html deleted file mode 100644 index 363f11479c..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/ProcessSyntheticObserverMethod.html +++ /dev/null @@ -1,153 +0,0 @@ - - - - - -Uses of Interface jakarta.enterprise.inject.spi.ProcessSyntheticObserverMethod (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Interface
jakarta.enterprise.inject.spi.ProcessSyntheticObserverMethod

-
-
No usage of jakarta.enterprise.inject.spi.ProcessSyntheticObserverMethod
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/Producer.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/Producer.html deleted file mode 100644 index 4f40fbc00e..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/Producer.html +++ /dev/null @@ -1,246 +0,0 @@ - - - - - -Uses of Interface jakarta.enterprise.inject.spi.Producer (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Interface
jakarta.enterprise.inject.spi.Producer

-
-
- -
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/ProducerFactory.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/ProducerFactory.html deleted file mode 100644 index 85497800f8..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/ProducerFactory.html +++ /dev/null @@ -1,234 +0,0 @@ - - - - - -Uses of Interface jakarta.enterprise.inject.spi.ProducerFactory (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Interface
jakarta.enterprise.inject.spi.ProducerFactory

-
-
- -
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/SessionBeanType.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/SessionBeanType.html deleted file mode 100644 index d51bbdc660..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/SessionBeanType.html +++ /dev/null @@ -1,216 +0,0 @@ - - - - - -Uses of Class jakarta.enterprise.inject.spi.SessionBeanType (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Class
jakarta.enterprise.inject.spi.SessionBeanType

-
-
- -
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/Unmanaged.UnmanagedInstance.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/Unmanaged.UnmanagedInstance.html deleted file mode 100644 index 9384410b06..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/Unmanaged.UnmanagedInstance.html +++ /dev/null @@ -1,236 +0,0 @@ - - - - - -Uses of Class jakarta.enterprise.inject.spi.Unmanaged.UnmanagedInstance (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Class
jakarta.enterprise.inject.spi.Unmanaged.UnmanagedInstance

-
-
- -
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/Unmanaged.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/Unmanaged.html deleted file mode 100644 index f746c5f922..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/Unmanaged.html +++ /dev/null @@ -1,153 +0,0 @@ - - - - - -Uses of Class jakarta.enterprise.inject.spi.Unmanaged (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Class
jakarta.enterprise.inject.spi.Unmanaged

-
-
No usage of jakarta.enterprise.inject.spi.Unmanaged
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/WithAnnotations.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/WithAnnotations.html deleted file mode 100644 index 6dfac48af3..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/class-use/WithAnnotations.html +++ /dev/null @@ -1,153 +0,0 @@ - - - - - -Uses of Class jakarta.enterprise.inject.spi.WithAnnotations (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Class
jakarta.enterprise.inject.spi.WithAnnotations

-
-
No usage of jakarta.enterprise.inject.spi.WithAnnotations
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/configurator/AnnotatedConstructorConfigurator.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/configurator/AnnotatedConstructorConfigurator.html deleted file mode 100644 index f8823bac4e..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/configurator/AnnotatedConstructorConfigurator.html +++ /dev/null @@ -1,402 +0,0 @@ - - - - - -AnnotatedConstructorConfigurator (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Interface AnnotatedConstructorConfigurator<T>

-
-
-
-
    -
  • -
    -
    Type Parameters:
    -
    T - the class declaring the constructor
    -
    -
    -
    public interface AnnotatedConstructorConfigurator<T>
    -
    This interface is part of the AnnotatedTypeConfigurator SPI and helps defining an AnnotatedConstructor - -

    CDI Lite implementations are not required to provide support for Portable Extensions.

    -
    -
    Since:
    -
    2.0
    -
    Author:
    -
    Martin Kouba, Antoine Sabot-Durand
    -
    -
  • -
-
-
- -
-
- -
-
-
- -
- -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

-
- - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/configurator/AnnotatedFieldConfigurator.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/configurator/AnnotatedFieldConfigurator.html deleted file mode 100644 index 5c0f41e912..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/configurator/AnnotatedFieldConfigurator.html +++ /dev/null @@ -1,361 +0,0 @@ - - - - - -AnnotatedFieldConfigurator (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Interface AnnotatedFieldConfigurator<T>

-
-
-
-
    -
  • -
    -
    Type Parameters:
    -
    T - the class declaring the field
    -
    -
    -
    public interface AnnotatedFieldConfigurator<T>
    -
    This interface is part of the AnnotatedTypeConfigurator SPI and helps defining an AnnotatedField - -

    CDI Lite implementations are not required to provide support for Portable Extensions.

    -
    -
    Since:
    -
    2.0
    -
    Author:
    -
    Martin Kouba, Antoine Sabot-Durand
    -
    -
  • -
-
-
- -
-
-
    -
  • - -
    -
      -
    • - - -

      Method Detail

      - - - - - - - -
        -
      • -

        add

        -
        AnnotatedFieldConfigurator<T> add​(java.lang.annotation.Annotation annotation)
        -
        Add an annotation to the field.
        -
        -
        Parameters:
        -
        annotation - the annotation to add
        -
        Returns:
        -
        self
        -
        -
      • -
      - - - -
        -
      • -

        remove

        -
        AnnotatedFieldConfigurator<T> remove​(java.util.function.Predicate<java.lang.annotation.Annotation> predicate)
        -
        Remove annotations that match the specified predicate. - -

        - Example predicates: -

        - -
        -  
        - // To remove all the annotations:
        - (a) -> true
        - 
        - // To remove annotations with a concrete annotation type:
        - (a) -> a.annotationType().equals(Foo.class)
        - 
        - // To remove annotation equal to a specified object:
        - (a) -> a.equals(fooAnnotation)
        - 
        - // To remove annotations that are considered equivalent for the purposes of typesafe resolution:
        - (a) -> beanManager.areQualifiersEquivalent(a, fooQualifier)
        - (a) -> beanManager.areInterceptorBindingsEquivalent(a, fooInterceptorBinding)
        - 
        - 
        -
        -
        Parameters:
        -
        predicate - Predicate used to filter annotations to remove
        -
        Returns:
        -
        self
        -
        -
      • -
      - - - - -
    • -
    -
    -
  • -
-
-
-
- -
- -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

-
- - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/configurator/AnnotatedMethodConfigurator.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/configurator/AnnotatedMethodConfigurator.html deleted file mode 100644 index d2774aaae9..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/configurator/AnnotatedMethodConfigurator.html +++ /dev/null @@ -1,402 +0,0 @@ - - - - - -AnnotatedMethodConfigurator (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Interface AnnotatedMethodConfigurator<T>

-
-
-
-
    -
  • -
    -
    Type Parameters:
    -
    T - the class declaring the method
    -
    -
    -
    public interface AnnotatedMethodConfigurator<T>
    -
    This interface is part of the AnnotatedTypeConfigurator SPI and helps defining an AnnotatedMethod - -

    CDI Lite implementations are not required to provide support for Portable Extensions.

    -
    -
    Since:
    -
    2.0
    -
    Author:
    -
    Martin Kouba, Antoine Sabot-Durand
    -
    -
  • -
-
-
- -
-
- -
-
-
- -
- -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

-
- - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/configurator/AnnotatedParameterConfigurator.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/configurator/AnnotatedParameterConfigurator.html deleted file mode 100644 index faa7486955..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/configurator/AnnotatedParameterConfigurator.html +++ /dev/null @@ -1,361 +0,0 @@ - - - - - -AnnotatedParameterConfigurator (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Interface AnnotatedParameterConfigurator<T>

-
-
-
-
    -
  • -
    -
    Type Parameters:
    -
    T - the class containing the method declaring the parameter
    -
    -
    -
    public interface AnnotatedParameterConfigurator<T>
    -
    This interface is part of the AnnotatedTypeConfigurator SPI and helps defining an AnnotatedParameter - -

    CDI Lite implementations are not required to provide support for Portable Extensions.

    -
    -
    Since:
    -
    2.0
    -
    Author:
    -
    Martin Kouba, Antoine Sabot-Durand
    -
    -
  • -
-
-
- -
-
-
    -
  • - -
    -
      -
    • - - -

      Method Detail

      - - - - - - - -
        -
      • -

        add

        -
        AnnotatedParameterConfigurator<T> add​(java.lang.annotation.Annotation annotation)
        -
        Add an annotation to the parameter.
        -
        -
        Parameters:
        -
        annotation - the annotation to add
        -
        Returns:
        -
        self
        -
        -
      • -
      - - - -
        -
      • -

        remove

        -
        AnnotatedParameterConfigurator<T> remove​(java.util.function.Predicate<java.lang.annotation.Annotation> predicate)
        -
        Remove annotations that match the specified predicate. - -

        - Example predicates: -

        - -
        -  
        - // To remove all the annotations:
        - (a) -> true
        - 
        - // To remove annotations with a concrete annotation type:
        - (a) -> a.annotationType().equals(Foo.class)
        - 
        - // To remove annotation equal to a specified object:
        - (a) -> a.equals(fooAnnotation)
        - 
        - // To remove annotations that are considered equivalent for the purposes of typesafe resolution:
        - (a) -> beanManager.areQualifiersEquivalent(a, fooQualifier)
        - (a) -> beanManager.areInterceptorBindingsEquivalent(a, fooInterceptorBinding)
        - 
        - 
        -
        -
        Parameters:
        -
        predicate - Predicate used to filter annotations to remove
        -
        Returns:
        -
        self
        -
        -
      • -
      - - - - -
    • -
    -
    -
  • -
-
-
-
- -
- -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

-
- - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/configurator/AnnotatedTypeConfigurator.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/configurator/AnnotatedTypeConfigurator.html deleted file mode 100644 index 35649253e8..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/configurator/AnnotatedTypeConfigurator.html +++ /dev/null @@ -1,497 +0,0 @@ - - - - - -AnnotatedTypeConfigurator (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Interface AnnotatedTypeConfigurator<T>

-
-
-
- -
-
- -
-
- -
-
-
- -
- -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

-
- - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/configurator/BeanAttributesConfigurator.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/configurator/BeanAttributesConfigurator.html deleted file mode 100644 index 99303a05b7..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/configurator/BeanAttributesConfigurator.html +++ /dev/null @@ -1,676 +0,0 @@ - - - - - -BeanAttributesConfigurator (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Interface BeanAttributesConfigurator<T>

-
-
-
-
    -
  • -
    -
    Type Parameters:
    -
    T - the class of the bean instance
    -
    -
    -
    public interface BeanAttributesConfigurator<T>
    -
    This API is an helper to configure a new BeanAttributes instance. - CDI container must provides an implementation of this interface. - - This configurator is not thread safe and shall not be used concurrently. - -

    CDI Lite implementations are not required to provide support for Portable Extensions.

    -
    -
    Since:
    -
    2.0
    -
    Author:
    -
    Antoine Sabot-Durand
    -
    See Also:
    -
    ProcessBeanAttributes.configureBeanAttributes()
    -
    -
  • -
-
-
- -
-
-
    -
  • - -
    -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        addType

        -
        BeanAttributesConfigurator<T> addType​(java.lang.reflect.Type type)
        -
        Add a type to the bean types
        -
        -
        Parameters:
        -
        type - the type to add
        -
        Returns:
        -
        self
        -
        -
      • -
      - - - - - - - -
        -
      • -

        addTypes

        -
        BeanAttributesConfigurator<T> addTypes​(java.lang.reflect.Type... types)
        -
        Add types to the bean types
        -
        -
        Parameters:
        -
        types - types to add
        -
        Returns:
        -
        self
        -
        -
      • -
      - - - -
        -
      • -

        addTypes

        -
        BeanAttributesConfigurator<T> addTypes​(java.util.Set<java.lang.reflect.Type> types)
        -
        Add types to the bean types
        -
        -
        Parameters:
        -
        types - types to add
        -
        Returns:
        -
        self
        -
        -
      • -
      - - - -
        -
      • -

        addTransitiveTypeClosure

        -
        BeanAttributesConfigurator<T> addTransitiveTypeClosure​(java.lang.reflect.Type type)
        -
        Adds an unrestricted set of bean types for the given type as if it represented a bean class of a managed bean. - Illegal bean types are omitted.
        -
        -
        Parameters:
        -
        type - to build the closure from
        -
        Returns:
        -
        self
        -
        -
      • -
      - - - -
        -
      • -

        types

        -
        BeanAttributesConfigurator<T> types​(java.lang.reflect.Type... types)
        -
        Replace bean types
        -
        -
        Parameters:
        -
        types - the types of the configured bean
        -
        Returns:
        -
        self
        -
        -
      • -
      - - - -
        -
      • -

        types

        -
        BeanAttributesConfigurator<T> types​(java.util.Set<java.lang.reflect.Type> types)
        -
        Replace bean types
        -
        -
        Parameters:
        -
        types - the types of the configured bean
        -
        Returns:
        -
        self
        -
        -
      • -
      - - - -
        -
      • -

        scope

        -
        BeanAttributesConfigurator<T> scope​(java.lang.Class<? extends java.lang.annotation.Annotation> scope)
        -
        Replace Bean scope
        -
        -
        Parameters:
        -
        scope - new scope for the configured bean
        -
        Returns:
        -
        self
        -
        -
      • -
      - - - -
        -
      • -

        addQualifier

        -
        BeanAttributesConfigurator<T> addQualifier​(java.lang.annotation.Annotation qualifier)
        -
        Add a qualifier to the configured bean
        -
        -
        Parameters:
        -
        qualifier - qualifier to add
        -
        Returns:
        -
        self
        -
        -
      • -
      - - - -
        -
      • -

        addQualifiers

        -
        BeanAttributesConfigurator<T> addQualifiers​(java.lang.annotation.Annotation... qualifiers)
        -
        Add qualifiers to the bean.
        -
        -
        Parameters:
        -
        qualifiers - qualifiers to add
        -
        Returns:
        -
        self
        -
        -
      • -
      - - - -
        -
      • -

        addQualifiers

        -
        BeanAttributesConfigurator<T> addQualifiers​(java.util.Set<java.lang.annotation.Annotation> qualifiers)
        -
        Add qualifiers to the bean.
        -
        -
        Parameters:
        -
        qualifiers - qualifiers to add
        -
        Returns:
        -
        self
        -
        -
      • -
      - - - -
        -
      • -

        qualifiers

        -
        BeanAttributesConfigurator<T> qualifiers​(java.lang.annotation.Annotation... qualifiers)
        -
        Replace all qualifiers.
        -
        -
        Parameters:
        -
        qualifiers - qualifiers for the build bean
        -
        Returns:
        -
        self
        -
        -
      • -
      - - - -
        -
      • -

        qualifiers

        -
        BeanAttributesConfigurator<T> qualifiers​(java.util.Set<java.lang.annotation.Annotation> qualifiers)
        -
        Replace all qualifiers.
        -
        -
        Parameters:
        -
        qualifiers - for the configured bean
        -
        Returns:
        -
        self
        -
        -
      • -
      - - - -
        -
      • -

        addStereotype

        -
        BeanAttributesConfigurator<T> addStereotype​(java.lang.Class<? extends java.lang.annotation.Annotation> stereotype)
        -
        Add a stereotype to the configured bean
        -
        -
        Parameters:
        -
        stereotype - stereotype to add
        -
        Returns:
        -
        self
        -
        -
      • -
      - - - -
        -
      • -

        addStereotypes

        -
        BeanAttributesConfigurator<T> addStereotypes​(java.util.Set<java.lang.Class<? extends java.lang.annotation.Annotation>> stereotypes)
        -
        Add stereotypes to the configured bean
        -
        -
        Parameters:
        -
        stereotypes - stereotypes to add
        -
        Returns:
        -
        self
        -
        -
      • -
      - - - -
        -
      • -

        stereotypes

        -
        BeanAttributesConfigurator<T> stereotypes​(java.util.Set<java.lang.Class<? extends java.lang.annotation.Annotation>> stereotypes)
        -
        Replace stereotypes on the configured bean
        -
        -
        Parameters:
        -
        stereotypes - for the configured bean
        -
        Returns:
        -
        self
        -
        -
      • -
      - - - -
        -
      • -

        name

        -
        BeanAttributesConfigurator<T> name​(java.lang.String name)
        -
        Set the name of the configured bean
        -
        -
        Parameters:
        -
        name - name for the configured bean
        -
        Returns:
        -
        self
        -
        -
      • -
      - - - -
        -
      • -

        alternative

        -
        BeanAttributesConfigurator<T> alternative​(boolean value)
        -
        Change the alternative status of the configured bean. - By default the configured bean is not an alternative.
        -
        -
        Parameters:
        -
        value - value for alternative property
        -
        Returns:
        -
        self
        -
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- -
- -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

-
- - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/configurator/BeanConfigurator.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/configurator/BeanConfigurator.html deleted file mode 100644 index 904d33b0b3..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/configurator/BeanConfigurator.html +++ /dev/null @@ -1,1029 +0,0 @@ - - - - - -BeanConfigurator (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Interface BeanConfigurator<T>

-
-
-
-
    -
  • -
    -
    Type Parameters:
    -
    T - the class of the bean instance
    -
    -
    -
    public interface BeanConfigurator<T>
    -
    This API is an helper to configure a new Bean instance. - CDI container must provides an implementation of this interface. - - This builder is not thread safe and shall not be used concurrently. - -

    CDI Lite implementations are not required to provide support for Portable Extensions.

    -
    -
    Since:
    -
    2.0
    -
    Author:
    -
    Martin Kouba, Antoine Sabot-Durand
    -
    See Also:
    -
    AfterBeanDiscovery.addBean()
    -
    -
  • -
-
-
- -
-
-
    -
  • - -
    -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        beanClass

        -
        BeanConfigurator<T> beanClass​(java.lang.Class<?> beanClass)
        -
        Set the class of the configured Bean. - If not set, the extension class is used.
        -
        -
        Parameters:
        -
        beanClass - class of the configured bean
        -
        Returns:
        -
        self
        -
        -
      • -
      - - - -
        -
      • -

        addInjectionPoint

        -
        BeanConfigurator<T> addInjectionPoint​(InjectionPoint injectionPoint)
        -
        Add an InjectionPoint to the configured bean
        -
        -
        Parameters:
        -
        injectionPoint - the injectionPoint to add
        -
        Returns:
        -
        self
        -
        -
      • -
      - - - -
        -
      • -

        addInjectionPoints

        -
        BeanConfigurator<T> addInjectionPoints​(InjectionPoint... injectionPoints)
        -
        Add InjectionPoints to the configured bean
        -
        -
        Parameters:
        -
        injectionPoints - the injectionPoints to add
        -
        Returns:
        -
        self
        -
        -
      • -
      - - - -
        -
      • -

        addInjectionPoints

        -
        BeanConfigurator<T> addInjectionPoints​(java.util.Set<InjectionPoint> injectionPoints)
        -
        Add InjectionPoints to the configured bean
        -
        -
        Parameters:
        -
        injectionPoints - the injectionPoints to add
        -
        Returns:
        -
        self
        -
        -
      • -
      - - - -
        -
      • -

        injectionPoints

        -
        BeanConfigurator<T> injectionPoints​(InjectionPoint... injectionPoints)
        -
        Replace InjectionPoints for the configured bean
        -
        -
        Parameters:
        -
        injectionPoints - the injectionPoints for the configured bean
        -
        Returns:
        -
        self
        -
        -
      • -
      - - - -
        -
      • -

        injectionPoints

        -
        BeanConfigurator<T> injectionPoints​(java.util.Set<InjectionPoint> injectionPoints)
        -
        Replace InjectionPoints for the configured bean
        -
        -
        Parameters:
        -
        injectionPoints - the injectionPoints for the configured bean
        -
        Returns:
        -
        self
        -
        -
      • -
      - - - - - - - - - - - -
        -
      • -

        produceWith

        -
        <U extends TBeanConfigurator<U> produceWith​(java.util.function.Function<Instance<java.lang.Object>,​U> callback)
        -
        Set a callback to create a bean instance. -

        - The Instance argument might be used to simulate producer method parameter injection. However, dependent scoped - bean instances obtained from Instance during the callback execution remain managed until the produced bean - instance is destroyed. Therefore, applications are encouraged to always destroy unneeded dependent scoped bean instances - obtained from Instance.

        -
        -
        Type Parameters:
        -
        U - instance type
        -
        Parameters:
        -
        callback - the callback to create the instance
        -
        Returns:
        -
        self
        -
        -
      • -
      - - - -
        -
      • -

        destroyWith

        -
        BeanConfigurator<T> destroyWith​(java.util.function.BiConsumer<T,​CreationalContext<T>> callback)
        -
        Set a callback to destroy a bean instance. -

        - If no destroy callback is specified, a NOOP callback is automatically set.

        -
        -
        Parameters:
        -
        callback - the callback to destroy the instance
        -
        Returns:
        -
        self
        -
        -
      • -
      - - - -
        -
      • -

        disposeWith

        -
        BeanConfigurator<T> disposeWith​(java.util.function.BiConsumer<T,​Instance<java.lang.Object>> callback)
        -
        Set a callback to destroy a bean instance. -

        - If no dispose callback is specified, a NOOP callback is automatically set. -

        - The Instance argument might be used to simulate disposer method parameter injection. All dependent scoped bean - instances obtained from Instance during the callback execution are destroyed when the execution completes.

        -
        -
        Parameters:
        -
        callback - the callback to dispose the instance
        -
        Returns:
        -
        self
        -
        -
      • -
      - - - -
        -
      • -

        read

        -
        <U extends TBeanConfigurator<U> read​(AnnotatedType<U> type)
        -
        Read the information from the given annotated type. All relevant information is overwritten.
        -
        -
        Type Parameters:
        -
        U - instance type
        -
        Parameters:
        -
        type - class to read information from
        -
        Returns:
        -
        self
        -
        -
      • -
      - - - -
        -
      • -

        read

        -
        BeanConfigurator<T> read​(BeanAttributes<?> beanAttributes)
        -
        Read the information from the given bean attributes. All relevant information is overwritten.
        -
        -
        Parameters:
        -
        beanAttributes - beanAttributes to read information from
        -
        Returns:
        -
        self
        -
        -
      • -
      - - - -
        -
      • -

        addType

        -
        BeanConfigurator<T> addType​(java.lang.reflect.Type type)
        -
        Add a type to the bean types
        -
        -
        Parameters:
        -
        type - the type to add
        -
        Returns:
        -
        self
        -
        -
      • -
      - - - -
        -
      • -

        addType

        -
        BeanConfigurator<T> addType​(TypeLiteral<?> typeLiteral)
        -
        Add a type to the bean types
        -
        -
        Parameters:
        -
        typeLiteral - the type to add
        -
        Returns:
        -
        self
        -
        -
      • -
      - - - -
        -
      • -

        addTypes

        -
        BeanConfigurator<T> addTypes​(java.lang.reflect.Type... types)
        -
        Add types to the bean types
        -
        -
        Parameters:
        -
        types - types to add
        -
        Returns:
        -
        self
        -
        -
      • -
      - - - -
        -
      • -

        addTypes

        -
        BeanConfigurator<T> addTypes​(java.util.Set<java.lang.reflect.Type> types)
        -
        Add types to the bean types
        -
        -
        Parameters:
        -
        types - types to add
        -
        Returns:
        -
        self
        -
        -
      • -
      - - - -
        -
      • -

        addTransitiveTypeClosure

        -
        BeanConfigurator<T> addTransitiveTypeClosure​(java.lang.reflect.Type type)
        -
        Adds an unrestricted set of bean types for the given type as if it represented a bean class of a managed bean. - Illegal bean types are omitted.
        -
        -
        Parameters:
        -
        type - to build the closure from
        -
        Returns:
        -
        self
        -
        -
      • -
      - - - -
        -
      • -

        types

        -
        BeanConfigurator<T> types​(java.lang.reflect.Type... types)
        -
        Replace bean types
        -
        -
        Parameters:
        -
        types - the types of the configured bean
        -
        Returns:
        -
        self
        -
        -
      • -
      - - - -
        -
      • -

        types

        -
        BeanConfigurator<T> types​(java.util.Set<java.lang.reflect.Type> types)
        -
        Replace bean types
        -
        -
        Parameters:
        -
        types - the types of the configured bean
        -
        Returns:
        -
        self
        -
        -
      • -
      - - - -
        -
      • -

        scope

        -
        BeanConfigurator<T> scope​(java.lang.Class<? extends java.lang.annotation.Annotation> scope)
        -
        Replace Bean scope
        -
        -
        Parameters:
        -
        scope - new scope for the configured bean
        -
        Returns:
        -
        self
        -
        -
      • -
      - - - -
        -
      • -

        addQualifier

        -
        BeanConfigurator<T> addQualifier​(java.lang.annotation.Annotation qualifier)
        -
        Add a qualifier to the configured bean
        -
        -
        Parameters:
        -
        qualifier - qualifier to add
        -
        Returns:
        -
        self
        -
        -
      • -
      - - - -
        -
      • -

        addQualifiers

        -
        BeanConfigurator<T> addQualifiers​(java.lang.annotation.Annotation... qualifiers)
        -
        Add qualifiers to the bean.
        -
        -
        Parameters:
        -
        qualifiers - qualifiers to add
        -
        Returns:
        -
        self
        -
        -
      • -
      - - - -
        -
      • -

        addQualifiers

        -
        BeanConfigurator<T> addQualifiers​(java.util.Set<java.lang.annotation.Annotation> qualifiers)
        -
        Add qualifiers to the bean.
        -
        -
        Parameters:
        -
        qualifiers - qualifiers to add
        -
        Returns:
        -
        self
        -
        -
      • -
      - - - -
        -
      • -

        qualifiers

        -
        BeanConfigurator<T> qualifiers​(java.lang.annotation.Annotation... qualifiers)
        -
        Replace all qualifiers.
        -
        -
        Parameters:
        -
        qualifiers - qualifiers for the build bean
        -
        Returns:
        -
        self
        -
        -
      • -
      - - - -
        -
      • -

        qualifiers

        -
        BeanConfigurator<T> qualifiers​(java.util.Set<java.lang.annotation.Annotation> qualifiers)
        -
        Replace all qualifiers.
        -
        -
        Parameters:
        -
        qualifiers - for the configured bean
        -
        Returns:
        -
        self
        -
        -
      • -
      - - - -
        -
      • -

        addStereotype

        -
        BeanConfigurator<T> addStereotype​(java.lang.Class<? extends java.lang.annotation.Annotation> stereotype)
        -
        Add a stereotype to the configured bean
        -
        -
        Parameters:
        -
        stereotype - stereotype to add
        -
        Returns:
        -
        self
        -
        -
      • -
      - - - -
        -
      • -

        addStereotypes

        -
        BeanConfigurator<T> addStereotypes​(java.util.Set<java.lang.Class<? extends java.lang.annotation.Annotation>> stereotypes)
        -
        Add stereotypes to the configured bean
        -
        -
        Parameters:
        -
        stereotypes - stereotypes to add
        -
        Returns:
        -
        self
        -
        -
      • -
      - - - -
        -
      • -

        stereotypes

        -
        BeanConfigurator<T> stereotypes​(java.util.Set<java.lang.Class<? extends java.lang.annotation.Annotation>> stereotypes)
        -
        Replace stereotypes on the configured bean
        -
        -
        Parameters:
        -
        stereotypes - for the configured bean
        -
        Returns:
        -
        self
        -
        -
      • -
      - - - -
        -
      • -

        name

        -
        BeanConfigurator<T> name​(java.lang.String name)
        -
        Set the name of the configured bean
        -
        -
        Parameters:
        -
        name - name for the configured bean
        -
        Returns:
        -
        self
        -
        -
      • -
      - - - -
        -
      • -

        alternative

        -
        BeanConfigurator<T> alternative​(boolean value)
        -
        Change the alternative status of the configured bean. - By default the configured bean is not an alternative.
        -
        -
        Parameters:
        -
        value - value for alternative property
        -
        Returns:
        -
        self
        -
        -
      • -
      - - - -
        -
      • -

        priority

        -
        BeanConfigurator<T> priority​(int priority)
        -
        Set the priority of the configured bean. - By default, the configured bean does not have a priority. -

        - This is equivalent to putting the Priority - annotation to an actual bean class or making a custom - Bean class implement - Prioritized. -

        - This method has no effect if the configured bean is not an alternative.

        -
        -
        Parameters:
        -
        priority - the priority value
        -
        Returns:
        -
        self
        -
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- -
- -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

-
- - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/configurator/InjectionPointConfigurator.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/configurator/InjectionPointConfigurator.html deleted file mode 100644 index 7ab9b3ea60..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/configurator/InjectionPointConfigurator.html +++ /dev/null @@ -1,444 +0,0 @@ - - - - - -InjectionPointConfigurator (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Interface InjectionPointConfigurator

-
-
-
-
    -
  • -
    -
    public interface InjectionPointConfigurator
    -
    This API is an helper to configure an existing InjectionPoint instance. - CDI container must provides an implementation of this interface. - - This builder is not thread safe and shall not be used concurrently. - -

    CDI Lite implementations are not required to provide support for Portable Extensions.

    -
    -
    Since:
    -
    2.0
    -
    Author:
    -
    Antoine Sabot-Durand
    -
    See Also:
    -
    ProcessInjectionPoint.configureInjectionPoint()
    -
    -
  • -
-
-
- -
-
-
    -
  • - -
    -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        type

        -
        InjectionPointConfigurator type​(java.lang.reflect.Type requiredType)
        -
        Set the required Type (that will be used during typesafe resolution) - of the InjectionPoint to build.
        -
        -
        Parameters:
        -
        requiredType - for the InjectionPoint to build
        -
        Returns:
        -
        self
        -
        -
      • -
      - - - -
        -
      • -

        addQualifier

        -
        InjectionPointConfigurator addQualifier​(java.lang.annotation.Annotation qualifier)
        -
        Add the qualifier to the InjectionPoint to build
        -
        -
        Parameters:
        -
        qualifier - the qualifier to add
        -
        Returns:
        -
        self
        -
        -
      • -
      - - - -
        -
      • -

        addQualifiers

        -
        InjectionPointConfigurator addQualifiers​(java.lang.annotation.Annotation... qualifiers)
        -
        Add all the qualifiers to the InjectionPoint to build
        -
        -
        Parameters:
        -
        qualifiers - a varargs or array of qualifiers to add
        -
        Returns:
        -
        self
        -
        -
      • -
      - - - -
        -
      • -

        addQualifiers

        -
        InjectionPointConfigurator addQualifiers​(java.util.Set<java.lang.annotation.Annotation> qualifiers)
        -
        Add all the qualifiers to the InjectionPoint to build
        -
        -
        Parameters:
        -
        qualifiers - a Set of qualifiers to add
        -
        Returns:
        -
        self
        -
        -
      • -
      - - - -
        -
      • -

        qualifiers

        -
        InjectionPointConfigurator qualifiers​(java.lang.annotation.Annotation... qualifiers)
        -
        Replace all qualifiers.
        -
        -
        Parameters:
        -
        qualifiers - a varargs or array of qualifiers to replace to existing ones
        -
        Returns:
        -
        self
        -
        -
      • -
      - - - -
        -
      • -

        qualifiers

        -
        InjectionPointConfigurator qualifiers​(java.util.Set<java.lang.annotation.Annotation> qualifiers)
        -
        Replace all qualifiers.
        -
        -
        Parameters:
        -
        qualifiers - a Set of qualifiers to replace to existing ones
        -
        Returns:
        -
        self
        -
        -
      • -
      - - - -
        -
      • -

        delegate

        -
        InjectionPointConfigurator delegate​(boolean delegate)
        -
        Change the delegate status of the built InjectionPoint. - By default the InjectionPoint is not a delegate one.
        -
        -
        Parameters:
        -
        delegate - boolean to define or undefine the delegate nature of the configured InjectionPoint
        -
        Returns:
        -
        self
        -
        -
      • -
      - - - -
        -
      • -

        transientField

        -
        InjectionPointConfigurator transientField​(boolean trans)
        -
        Change the transient status of the built InjectionPoint. - By default the InjectionPoint is not transient.
        -
        -
        Parameters:
        -
        trans - boolean to define or undefine the transient nature of the configured InjectionPoint
        -
        Returns:
        -
        self
        -
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- -
- -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

-
- - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/configurator/ObserverMethodConfigurator.EventConsumer.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/configurator/ObserverMethodConfigurator.EventConsumer.html deleted file mode 100644 index c583595b65..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/configurator/ObserverMethodConfigurator.EventConsumer.html +++ /dev/null @@ -1,283 +0,0 @@ - - - - - -ObserverMethodConfigurator.EventConsumer (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Interface ObserverMethodConfigurator.EventConsumer<T>

-
-
-
-
    -
  • -
    -
    Type Parameters:
    -
    T - event type
    -
    -
    -
    Enclosing interface:
    -
    ObserverMethodConfigurator<T>
    -
    -
    -
    Functional Interface:
    -
    This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
    -
    -
    -
    @FunctionalInterface
    -public static interface ObserverMethodConfigurator.EventConsumer<T>
    -
    Represents an operation that accepts a context of a fired event.
    -
    -
    Author:
    -
    Martin Kouba
    -
    See Also:
    -
    EventContext
    -
    -
  • -
-
-
- -
-
-
    -
  • - -
    -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        accept

        -
        void accept​(EventContext<T> eventContext)
        -     throws java.lang.Exception
        -
        -
        Parameters:
        -
        eventContext - the EventContext used to fire the event
        -
        Throws:
        -
        java.lang.Exception - The thrown checked exception is wrapped and rethrown as an (unchecked) ObserverException
        -
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- -
- -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

-
- - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/configurator/ObserverMethodConfigurator.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/configurator/ObserverMethodConfigurator.html deleted file mode 100644 index 9f7a9172f8..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/configurator/ObserverMethodConfigurator.html +++ /dev/null @@ -1,635 +0,0 @@ - - - - - -ObserverMethodConfigurator (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Interface ObserverMethodConfigurator<T>

-
-
-
- -
-
- -
-
-
    -
  • - -
    -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        read

        -
        ObserverMethodConfigurator<T> read​(java.lang.reflect.Method method)
        -
        Read observer meta data from a existing Method
        -
        -
        Parameters:
        -
        method - to read meta data from
        -
        Returns:
        -
        self
        -
        -
      • -
      - - - - - - - - - - - -
        -
      • -

        beanClass

        -
        ObserverMethodConfigurator<T> beanClass​(java.lang.Class<?> type)
        -
        Set the class of the Bean containing this observer. If not set, the extension class is used.
        -
        -
        Parameters:
        -
        type - the bean class containing this configurator.
        -
        Returns:
        -
        self
        -
        -
      • -
      - - - -
        -
      • -

        observedType

        -
        ObserverMethodConfigurator<T> observedType​(java.lang.reflect.Type type)
        -
        Set the type of the observed event
        -
        -
        Parameters:
        -
        type - of the observed event
        -
        Returns:
        -
        self
        -
        -
      • -
      - - - -
        -
      • -

        addQualifier

        -
        ObserverMethodConfigurator<T> addQualifier​(java.lang.annotation.Annotation qualifier)
        -
        Add the qualifier to the observed event
        -
        -
        Parameters:
        -
        qualifier - to add to event
        -
        Returns:
        -
        self
        -
        -
      • -
      - - - -
        -
      • -

        addQualifiers

        -
        ObserverMethodConfigurator<T> addQualifiers​(java.lang.annotation.Annotation... qualifiers)
        -
        Add all the qualifiers to the Observed event
        -
        -
        Parameters:
        -
        qualifiers - to add to event
        -
        Returns:
        -
        self
        -
        -
      • -
      - - - -
        -
      • -

        addQualifiers

        -
        ObserverMethodConfigurator<T> addQualifiers​(java.util.Set<java.lang.annotation.Annotation> qualifiers)
        -
        Add all the qualifiers to the Observed event
        -
        -
        Parameters:
        -
        qualifiers - to add to event
        -
        Returns:
        -
        self
        -
        -
      • -
      - - - -
        -
      • -

        qualifiers

        -
        ObserverMethodConfigurator<T> qualifiers​(java.lang.annotation.Annotation... qualifiers)
        -
        Replace all qualifiers on the Observed event.
        -
        -
        Parameters:
        -
        qualifiers - to put on event
        -
        Returns:
        -
        self
        -
        -
      • -
      - - - -
        -
      • -

        qualifiers

        -
        ObserverMethodConfigurator<T> qualifiers​(java.util.Set<java.lang.annotation.Annotation> qualifiers)
        -
        Replace all qualifiers on the Observed event.
        -
        -
        Parameters:
        -
        qualifiers - to put on event
        -
        Returns:
        -
        self
        -
        -
      • -
      - - - - - - - - - - - -
        -
      • -

        priority

        -
        ObserverMethodConfigurator<T> priority​(int priority)
        -
        Set the priority for the observer to build
        -
        -
        Parameters:
        -
        priority - priority of the observer
        -
        Returns:
        -
        self
        -
        -
      • -
      - - - - - - - -
        -
      • -

        async

        -
        ObserverMethodConfigurator<T> async​(boolean async)
        -
        Allows modification of the asynchronous status of the observer to build.
        -
        -
        Parameters:
        -
        async - async status
        -
        Returns:
        -
        self
        -
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- - - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/configurator/ProducerConfigurator.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/configurator/ProducerConfigurator.html deleted file mode 100644 index 102a68f695..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/configurator/ProducerConfigurator.html +++ /dev/null @@ -1,316 +0,0 @@ - - - - - -ProducerConfigurator (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Interface ProducerConfigurator<T>

-
-
-
-
    -
  • -
    -
    Type Parameters:
    -
    T - The return type of the producer method or the type of the producer field
    -
    -
    -
    public interface ProducerConfigurator<T>
    -

    - A ProducerConfigurator can configure a Producer. The container must provide an implementation of this - interface. -

    - -

    - This configurator is not thread safe and shall not be used concurrently. -

    - -

    CDI Lite implementations are not required to provide support for Portable Extensions.

    -
    -
    Since:
    -
    2.0
    -
    Author:
    -
    Martin Kouba
    -
    See Also:
    -
    ProcessProducer.configureProducer()
    -
    -
  • -
-
-
- -
-
-
    -
  • - -
    -
      -
    • - - -

      Method Detail

      - - - - - - - -
        -
      • -

        disposeWith

        -
        ProducerConfigurator<T> disposeWith​(java.util.function.Consumer<T> callback)
        -
        Set a callback to destroy the produced instance.
        -
        -
        Parameters:
        -
        callback - a Consumer defining the callback to set
        -
        Returns:
        -
        self
        -
        See Also:
        -
        Producer.dispose(Object)
        -
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- -
- -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

-
- - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/configurator/class-use/AnnotatedConstructorConfigurator.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/configurator/class-use/AnnotatedConstructorConfigurator.html deleted file mode 100644 index 652e9032dd..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/configurator/class-use/AnnotatedConstructorConfigurator.html +++ /dev/null @@ -1,233 +0,0 @@ - - - - - -Uses of Interface jakarta.enterprise.inject.spi.configurator.AnnotatedConstructorConfigurator (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Interface
jakarta.enterprise.inject.spi.configurator.AnnotatedConstructorConfigurator

-
-
- -
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/configurator/class-use/AnnotatedFieldConfigurator.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/configurator/class-use/AnnotatedFieldConfigurator.html deleted file mode 100644 index cd7fc4fdc3..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/configurator/class-use/AnnotatedFieldConfigurator.html +++ /dev/null @@ -1,233 +0,0 @@ - - - - - -Uses of Interface jakarta.enterprise.inject.spi.configurator.AnnotatedFieldConfigurator (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Interface
jakarta.enterprise.inject.spi.configurator.AnnotatedFieldConfigurator

-
-
- -
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/configurator/class-use/AnnotatedMethodConfigurator.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/configurator/class-use/AnnotatedMethodConfigurator.html deleted file mode 100644 index c2d9c62251..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/configurator/class-use/AnnotatedMethodConfigurator.html +++ /dev/null @@ -1,233 +0,0 @@ - - - - - -Uses of Interface jakarta.enterprise.inject.spi.configurator.AnnotatedMethodConfigurator (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Interface
jakarta.enterprise.inject.spi.configurator.AnnotatedMethodConfigurator

-
-
- -
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/configurator/class-use/AnnotatedParameterConfigurator.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/configurator/class-use/AnnotatedParameterConfigurator.html deleted file mode 100644 index d9a826340c..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/configurator/class-use/AnnotatedParameterConfigurator.html +++ /dev/null @@ -1,243 +0,0 @@ - - - - - -Uses of Interface jakarta.enterprise.inject.spi.configurator.AnnotatedParameterConfigurator (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Interface
jakarta.enterprise.inject.spi.configurator.AnnotatedParameterConfigurator

-
-
- -
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/configurator/class-use/AnnotatedTypeConfigurator.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/configurator/class-use/AnnotatedTypeConfigurator.html deleted file mode 100644 index 2f097fe332..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/configurator/class-use/AnnotatedTypeConfigurator.html +++ /dev/null @@ -1,298 +0,0 @@ - - - - - -Uses of Interface jakarta.enterprise.inject.spi.configurator.AnnotatedTypeConfigurator (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Interface
jakarta.enterprise.inject.spi.configurator.AnnotatedTypeConfigurator

-
-
- -
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/configurator/class-use/BeanAttributesConfigurator.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/configurator/class-use/BeanAttributesConfigurator.html deleted file mode 100644 index a4f3b28f61..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/configurator/class-use/BeanAttributesConfigurator.html +++ /dev/null @@ -1,349 +0,0 @@ - - - - - -Uses of Interface jakarta.enterprise.inject.spi.configurator.BeanAttributesConfigurator (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Interface
jakarta.enterprise.inject.spi.configurator.BeanAttributesConfigurator

-
-
- -
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/configurator/class-use/BeanConfigurator.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/configurator/class-use/BeanConfigurator.html deleted file mode 100644 index 1c62392115..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/configurator/class-use/BeanConfigurator.html +++ /dev/null @@ -1,446 +0,0 @@ - - - - - -Uses of Interface jakarta.enterprise.inject.spi.configurator.BeanConfigurator (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Interface
jakarta.enterprise.inject.spi.configurator.BeanConfigurator

-
-
- -
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/configurator/class-use/InjectionPointConfigurator.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/configurator/class-use/InjectionPointConfigurator.html deleted file mode 100644 index 195a2edc9f..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/configurator/class-use/InjectionPointConfigurator.html +++ /dev/null @@ -1,280 +0,0 @@ - - - - - -Uses of Interface jakarta.enterprise.inject.spi.configurator.InjectionPointConfigurator (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Interface
jakarta.enterprise.inject.spi.configurator.InjectionPointConfigurator

-
-
- -
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/configurator/class-use/ObserverMethodConfigurator.EventConsumer.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/configurator/class-use/ObserverMethodConfigurator.EventConsumer.html deleted file mode 100644 index ec882c1c0a..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/configurator/class-use/ObserverMethodConfigurator.EventConsumer.html +++ /dev/null @@ -1,199 +0,0 @@ - - - - - -Uses of Interface jakarta.enterprise.inject.spi.configurator.ObserverMethodConfigurator.EventConsumer (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Interface
jakarta.enterprise.inject.spi.configurator.ObserverMethodConfigurator.EventConsumer

-
-
- -
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/configurator/class-use/ObserverMethodConfigurator.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/configurator/class-use/ObserverMethodConfigurator.html deleted file mode 100644 index a256258b09..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/configurator/class-use/ObserverMethodConfigurator.html +++ /dev/null @@ -1,335 +0,0 @@ - - - - - -Uses of Interface jakarta.enterprise.inject.spi.configurator.ObserverMethodConfigurator (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Interface
jakarta.enterprise.inject.spi.configurator.ObserverMethodConfigurator

-
-
- -
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/configurator/class-use/ProducerConfigurator.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/configurator/class-use/ProducerConfigurator.html deleted file mode 100644 index 1d7065c16c..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/configurator/class-use/ProducerConfigurator.html +++ /dev/null @@ -1,237 +0,0 @@ - - - - - -Uses of Interface jakarta.enterprise.inject.spi.configurator.ProducerConfigurator (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Interface
jakarta.enterprise.inject.spi.configurator.ProducerConfigurator

-
-
- -
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/configurator/package-summary.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/configurator/package-summary.html deleted file mode 100644 index aaefe93793..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/configurator/package-summary.html +++ /dev/null @@ -1,237 +0,0 @@ - - - - - -jakarta.enterprise.inject.spi.configurator (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-
Module jakarta.cdi
-

Package jakarta.enterprise.inject.spi.configurator

-
-
- -
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/configurator/package-tree.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/configurator/package-tree.html deleted file mode 100644 index 6b353ab680..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/configurator/package-tree.html +++ /dev/null @@ -1,174 +0,0 @@ - - - - - -jakarta.enterprise.inject.spi.configurator Class Hierarchy (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Hierarchy For Package jakarta.enterprise.inject.spi.configurator

-Package Hierarchies: - -
-
-
-

Interface Hierarchy

- -
-
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/configurator/package-use.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/configurator/package-use.html deleted file mode 100644 index fe588c6221..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/configurator/package-use.html +++ /dev/null @@ -1,311 +0,0 @@ - - - - - -Uses of Package jakarta.enterprise.inject.spi.configurator (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Package
jakarta.enterprise.inject.spi.configurator

-
-
- -
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/package-summary.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/package-summary.html deleted file mode 100644 index 5332110d49..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/package-summary.html +++ /dev/null @@ -1,729 +0,0 @@ - - - - - -jakarta.enterprise.inject.spi (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-
Module jakarta.cdi
-

Package jakarta.enterprise.inject.spi

-
-
-
- - -

The portable extension integration SPI.

- -

A portable extension may integrate with the container by:

- -
    -
  • Providing its own beans, interceptors and decorators to the - container
  • -
  • Injecting dependencies into its own objects using the - dependency injection service
  • -
  • Providing a context implementation for a custom scope
  • -
  • Augmenting or overriding the annotation-based metadata with - metadata from some other source
  • -
- -

The BeanManager object

- -

Portable extensions sometimes interact directly with the container - via programmatic API call. The interface - BeanManager provides operations - for obtaining contextual references for beans, along with many other - operations of use to portable extensions.

- -

Container lifecycle events

- -

During the application initialization process, the container fires - a series of events, allowing - portable extensions to integrate with the container initialization - process. Observer methods of these events must belong to - extensions declared - in META-INF/services.

- -

Lifecycle events include - BeforeBeanDiscovery, - AfterBeanDiscovery, - AfterDeploymentValidation and - BeforeShutdown.

- -

Interfaces representing enabled beans

- -

The interfaces - Bean, - Decorator, - Interceptor and - ObserverMethod - define everything the container needs to manage instances of - a bean, interceptor, decorator or observer method.

- -

An instance of Bean exists for every - enabled bean. A portable - extension may add support for new kinds of beans by implementing - Bean, observing the event - AfterBeanDiscovery event - registering beans with the container. An instance of - ObserverMethod exists for every - observer method of every - enabled bean. A portable extension may add observers by implementing - ObserverMethod and - registering an instance with the container.

- -

A portable extension may be notified of the existence of an - enabled bean by observing the container lifecycle event type - ProcessBean or one of its - subtypes, - or of the existence of an observer method of an enabled bean by - observing the event type - ProcessObserverMethod.

- -

Alternate metadata sources

- -

A portable extension may provide an alternative metadata - source, such as configuration by XML.

- -

Annotated - and its subtypes allow a portable extension to specify - metadata that overrides the annotations that exist on a - bean class. The portable extension is responsible for - implementing the interfaces, thereby exposing the metadata - to the container. The container must use the operations of - Annotated and its subinterfaces to discover program - element types and annotations, instead of directly calling the - Java Reflection API.

- -

A portable extension provides its metadata to the - container by observing the event - ProcessAnnotatedType and - wrapping the AnnotatedType.

- -

Producer and InjectionTarget

- -

The interfaces Producer and - InjectionTarget abstract the - basic lifecycle of (contextual or non-contextual) container managed - objects, including instantiation and destruction, dependency injection - and lifecycle callbacks.

- -

An instance of InjectionTarget - may be product of - BeanManager.getInjectionTargetFactory(AnnotatedType) - obtained from the BeanManager, - allowing a portable extension to request these container services for - objects under the control of the portable extension.

- -

Furthermore, a portable extension may replace the implementation - of InjectionTarget or - Producer used by the container - with its own implementation by observing the events - ProcessInjectionTarget or - ProcessProducer.

-
-
See Also:
-
jakarta.enterprise.inject, -jakarta.enterprise.context.spi
-
-
-
    -
  • - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Interface Summary 
    InterfaceDescription
    AfterBeanDiscovery -
    - The event type of the second event fired by the container when it has fully completed the bean discovery process, validated - that there are no definition errors relating to the discovered beans, and registered Bean - and ObserverMethod objects for the discovered beans, but before detecting deployment - problems.
    -
    AfterDeploymentValidation -
    - The event type of the third event fired by the container after it has validated that there are no deployment problems and - before creating contexts or processing requests.
    -
    AfterTypeDiscovery -
    - This event type is thrown by the container after type discovery is complete.
    -
    Annotated -
    - Represents a Java program element that can be annotated.
    -
    AnnotatedCallable<X> -
    - Represents a callable member of a Java type.
    -
    AnnotatedConstructor<X> -
    - Represents a constructor of a Java class.
    -
    AnnotatedField<X> -
    - Represents a field of a Java class.
    -
    AnnotatedMember<X> -
    - Represents a member of a Java type.
    -
    AnnotatedMethod<X> -
    - Represents a method of a Java type.
    -
    AnnotatedParameter<X> -
    - Represents a parameter of a method or constructor.
    -
    AnnotatedType<X> -
    - Represents a Java class or interface.
    -
    Bean<T> -
    - Represents an enabled bean.
    -
    BeanAttributes<T> -
    The BeanAttributes interface exposes the basic attributes of a bean.
    -
    BeanContainer -
    - BeanContainer is a superclass of BeanManager containing capabilities that are portable across - all CDI environments.
    -
    BeanManager -
    - Allows a portable extension to interact directly with the container.
    -
    BeforeBeanDiscovery -
    - This event type is thrown by the container before the bean discovery process begins.
    -
    BeforeShutdown -
    - The type of the final event the container fires after it has finished processing requests and destroyed all contexts.
    -
    CDIProvider -
    Interface implemented by a CDI provider to provide access to the current container
    -
    Decorator<T> -
    - Represents an enabled decorator.
    -
    EventContext<T> -
    Represents a context of a fired event.
    -
    EventMetadata -
    - Provides access to metadata about an observed event payload.
    -
    Extension -
    - Service interface implemented by extensions.
    -
    InjectionPoint -
    - Provides access to metadata about an injection point.
    -
    InjectionTarget<T> -
    - Provides operations for performing dependency injection and lifecycle callbacks on an - instance of a type.
    -
    InjectionTargetFactory<T> -
    - An InjectionTargetFactory can create an InjectionTarget for a given bean.
    -
    InterceptionFactory<T> -
    InterceptionFactory allows to create a wrapper instance whose method invocations are intercepted by method - interceptors and forwarded to a provided instance.
    -
    Interceptor<T> -
    - Represents an enabled interceptor.
    -
    ObserverMethod<T> -
    - Represents an observer method of an enabled - bean.
    -
    PassivationCapable -
    Indicates that a custom implementation of Bean or - Contextual is passivation capable.
    -
    Prioritized -
    - This interface allows some SPI implementation to change their priority programmatically.
    -
    ProcessAnnotatedType<X> -
    - The container fires an event of this type for each Java class or interface it discovers in a bean archive, before it reads - the declared annotations.
    -
    ProcessBean<X> -
    - The container fires an event of this type for each enabled bean, interceptor or decorator deployed in a bean archive, before - registering the Bean object.
    -
    ProcessBeanAttributes<T> -
    - The container fires an event of this type for each enabled bean, interceptor or decorator deployed in a bean archive before - registering the Bean object.
    -
    ProcessInjectionPoint<T,​X> -
    - The container fires an event of this type for every injection point of every Java EE component class supporting injection - that may be instantiated by the container at runtime, including every managed bean declared using - jakarta.annotation.ManagedBean, EJB session or message-driven bean, enabled bean, enabled interceptor or enabled - decorator.
    -
    ProcessInjectionTarget<X> -
    - 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 jakarta.annotation.ManagedBean, EJB session or - message-driven bean, enabled bean, enabled interceptor or enabled decorator.
    -
    ProcessManagedBean<X> -
    - The container fires an event of this type for each enabled managed bean, before registering the - Bean object.
    -
    ProcessObserverMethod<T,​X> -
    - The container fires an event of this type for each observer method of each - enabled bean, before registering the ObserverMethod object.
    -
    ProcessProducer<T,​X> -
    - The container fires an event of this type for each producer method or field of - each enabled bean, including resources.
    -
    ProcessProducerField<T,​X> -
    - The container fires an event of this type for each enabled producer field, before registering the - Bean object.
    -
    ProcessProducerMethod<T,​X> -
    - The container fires an event of this type for each enabled producer method, before registering the - Bean object.
    -
    ProcessSessionBean<X> -
    - The container fires an event of this type for each enabled session bean, before registering the - Bean object.
    -
    ProcessSyntheticAnnotatedType<X> -
    - The container fires an event of this type for each Java class or interface added by - BeforeBeanDiscovery.addAnnotatedType(AnnotatedType, String) or - AfterTypeDiscovery.addAnnotatedType(AnnotatedType, String)
    -
    ProcessSyntheticBean<X> -
    - The container fires an event of this type for each custom bean implementation added through - AfterBeanDiscovery.addBean() or AfterBeanDiscovery.addBean(Bean), before registering the - Bean object.
    -
    ProcessSyntheticObserverMethod<T,​X> -
    - The container fires an event of this type for each custom implementation of ObserverMethod added through - AfterBeanDiscovery.addObserverMethod(ObserverMethod) or AfterBeanDiscovery.addObserverMethod(), before - registering the ObserverMethod object.
    -
    Producer<T> -
    - Provides a generic operation for producing an instance of a type.
    -
    ProducerFactory<X> -
    - An ProducerFactory can create an Producer for a given bean.
    -
    -
  • -
  • - - - - - - - - - - - - - - - - - - - - -
    Class Summary 
    ClassDescription
    CDI<T> -
    Provides access to the current container.
    -
    Unmanaged<T> -
    - Helper class for injecting and calling lifecycle callbacks unmanaged instances for use by framework and library integrators.
    -
    Unmanaged.UnmanagedInstance<T> -
    Represents a non-contextual instance.
    -
    -
  • -
  • - - - - - - - - - - - - - - - - -
    Enum Summary 
    EnumDescription
    InterceptionType -
    - Identifies the kind of lifecycle callback, EJB timeout method or business method interception.
    -
    SessionBeanType -
    Identifies the kind of EJB session bean.
    -
    -
  • -
  • - - - - - - - - - - - - - - - - -
    Exception Summary 
    ExceptionDescription
    DefinitionException -
    - Thrown when a definition error occurs.
    -
    DeploymentException -
    - Thrown when a deployment problem occurs.
    -
    -
  • -
  • - - - - - - - - - - - - -
    Annotation Types Summary 
    Annotation TypeDescription
    WithAnnotations -
    - WithAnnotations may be applied to any portable extension observer method with an event parameter type of - ProcessAnnotatedType to filter the events delivered.
    -
    -
  • -
-
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/package-tree.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/package-tree.html deleted file mode 100644 index b89b212e73..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/package-tree.html +++ /dev/null @@ -1,302 +0,0 @@ - - - - - -jakarta.enterprise.inject.spi Class Hierarchy (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Hierarchy For Package jakarta.enterprise.inject.spi

-Package Hierarchies: - -
-
-
-

Class Hierarchy

-
    -
  • java.lang.Object - -
  • -
-
-
-

Interface Hierarchy

- -
-
-

Annotation Type Hierarchy

-
    -
  • jakarta.enterprise.inject.spi.WithAnnotations (implements java.lang.annotation.Annotation)
  • -
-
-
-

Enum Hierarchy

-
    -
  • java.lang.Object -
      -
    • java.lang.Enum<E> (implements java.lang.Comparable<T>, java.io.Serializable) - -
    • -
    -
  • -
-
-
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/package-use.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/package-use.html deleted file mode 100644 index ea2ac8efd8..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/inject/spi/package-use.html +++ /dev/null @@ -1,613 +0,0 @@ - - - - - -Uses of Package jakarta.enterprise.inject.spi (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Package
jakarta.enterprise.inject.spi

-
-
- -
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/invoke/Invoker.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/invoke/Invoker.html deleted file mode 100644 index 2526d7f6ab..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/invoke/Invoker.html +++ /dev/null @@ -1,385 +0,0 @@ - - - - - -Invoker (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Interface Invoker<T,​R>

-
-
-
-
    -
  • -
    -
    Type Parameters:
    -
    T - type of the target instance
    -
    R - return type of the method
    -
    -
    -
    public interface Invoker<T,​R>
    -
    Allows indirectly invoking a method that belongs to a managed bean (the target method). - To invoke the method, the caller must provide all the arguments that the target method accepts, - as well as the instance on which the target method is to be invoked, if it is not static. -

    - Whenever a direct invocation of a method is a business method invocation, an indirect invocation - of that method through an invoker is also a business method invocation. -

    - Invoker implementations must be thread-safe. It is possible to use a single invoker instance - to perform multiple independent invocations of the target method, possibly on different instances - and with different arguments. - -

    Obtaining an invoker

    - - The CDI container allows building an invoker for non-private - methods declared on a managed bean class or inherited from a supertype. Attempting to build - an invoker for a private method or a constructor of a managed bean class leads to a deployment - problem. Attempting to build an invoker for a method of a class that is not a managed bean class - or that is an interceptor or decorator class leads to a deployment problem. -

    - Multiple managed beans may inherit a method from a common supertype. In that case, each bean - conceptually has its own method and an invoker obtained for one bean may not be used to invoke - the method on the other bean. -

    - Using the InvokerBuilder is the only way to obtain an invoker. An InvokerBuilder - can only be obtained in CDI portable extensions and build compatible extensions. - -

    Example

    - - To illustrate how invokers work, let's take a look at an example. Say that the following bean - exists and has a method that you want to invoke indirectly: - -
    - @Dependent
    - class MyService {
    -     String hello(String name) {
    -         return "Hello " + name + "!";
    -     }
    - }
    - 
    - - When you obtain an InvokerBuilder for the hello() method, you can - immediately build a direct invoker. In a portable extension, this results in an invoker: - -
    - InvokerBuilder<Invoker<MyService, String>> builder = ...;
    - Invoker<MyService, String> invoker = builder.build();
    - 
    - - In a build compatible extension, this results in an opaque token that later - materializes as an invoker: - -
    - InvokerBuilder<InvokerInfo> builder = ...;
    - InvokerInfo invoker = builder.build();
    - 
    - - To call the hello() method through this invoker, call - invoker.invoke(myService, new Object[] {"world"}). - The return value is "Hello world!". -

    - An implementation of the direct invoker above is equivalent to the following class: - -

    - class TheInvoker implements Invoker<MyService, String> {
    -     String invoke(MyService instance, Object[] arguments) {
    -         return instance.hello((String) arguments[0]);
    -     }
    - }
    - 
    -
    -
    Since:
    -
    4.1
    -
    See Also:
    -
    invoke(Object, Object[])
    -
    -
  • -
-
-
-
    -
  • - -
    -
      -
    • - - -

      Method Summary

      - - - - - - - - - - - - -
      All Methods Instance Methods Abstract Methods 
      Modifier and TypeMethodDescription
      Rinvoke​(T instance, - java.lang.Object[] arguments) -
      Invokes the target method of this invoker on given instance, passing given - arguments.
      -
      -
    • -
    -
    -
  • -
-
-
-
    -
  • - -
    -
      -
    • - - -

      Method Detail

      - - - - - -
        -
      • -

        invoke

        -
        R invoke​(T instance,
        -         java.lang.Object[] arguments)
        -
        Invokes the target method of this invoker on given instance, passing given - arguments. If the target method is static, the instance is ignored; - by convention, it should be null. If the target method returns normally, this - method returns its return value, unless the target method is declared void, - in which case this method returns null. If the target method throws an exception, - this method rethrows it directly. -

        - If some parameter of the target method declares a primitive type, the corresponding element of - the arguments array must be of the corresponding wrapper type. No type conversions are - performed, so if the parameter is declared int, the argument must be an Integer - and may not be Short or Long. If the argument is null, the default value - of the primitive type is used. Note that this does not apply to arrays of primitive types; - if a parameter is declared int[], the argument must be int[] and may not be - Integer[]. -

        - If the target method is not static and instance is null, - a NullPointerException is thrown. If the target method is not static and - the instance is not assignable to the class of the bean to which the method belongs, - a ClassCastException is thrown. -

        - If the target method declares no parameter, arguments are ignored. If the target method - declares any parameter and arguments is null, NullPointerException is - thrown. If the arguments array has fewer elements than the number of parameters of - the target method, ArrayIndexOutOfBoundsException is thrown. If the arguments - array has more elements than the number of parameters of the target method, the excess elements - are ignored. If some of the arguments is not assignable to the declared type of - the corresponding parameter of the target method, ClassCastException is thrown. - - TODO the previous 2 paragraphs refer to "assignability", which needs to be defined somewhere! - - TODO when the `InvokerBuilder` applies transformations, some of the requirements above - are no longer strictly necessary, should reflect that in this text somehow (it is already - mentioned in `InvokerBuilder`, but that likely isn't enough)

        -
        -
        Parameters:
        -
        instance - the instance on which the target method is to be invoked, may only be null - if the method is static
        -
        arguments - arguments to be supplied to the target method, may only be null - if the method declares no parameter
        -
        Returns:
        -
        return value of the target method, or null if the method is declared void
        -
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- -
- -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

-
- - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/invoke/InvokerBuilder.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/invoke/InvokerBuilder.html deleted file mode 100644 index 0ebfc68b81..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/invoke/InvokerBuilder.html +++ /dev/null @@ -1,735 +0,0 @@ - - - - - -InvokerBuilder (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Interface InvokerBuilder<T>

-
-
-
-
    -
  • -
    -
    Type Parameters:
    -
    T - type of outcome of this builder; always represents an Invoker, - but does not necessarily have to be an Invoker instance directly
    -
    -
    -
    public interface InvokerBuilder<T>
    -
    Builder of Invokers that allows configuring input lookups, input and output - transformations, and invoker wrapping. The method for which the invoker is built is - called the target method. If a lookup is configured, the corresponding input - of the invoker is ignored and an instance is looked up from the CDI container before - the target method is invoked. If a transformation is configured, the corresponding input - or output of the invoker is modified in certain way before or after the target method - is invoked. If a wrapper is configured, the invoker is passed to custom code for getting - invoked. As a result, the built Invoker instance may have more complex behavior - than just directly calling the target method. -

    - Transformations and wrapping are expressed by ordinary methods that must have - a pre-defined signature, as described below. Such methods are called - transformers and wrappers. -

    - Invokers may only be built during deployment. It is not possible to build new invokers - at application runtime. - -

    Example

    - - Before describing in detail how lookups, transformers and wrappers work, let's take - a look at an example. Say we have the following bean with a method: - -
    - class MyService {
    -     String hello(String name) {
    -         return "Hello " + name + "!";
    -     }
    - }
    - 
    - - And we want to build an invoker that looks up MyService from the CDI container, - always passes the argument to hello() as all upper-case, and repeats the return - value twice. To transform the argument, we can use the zero-parameter method - String.toUpperCase(), and to transform the return value, we write a transformer - as a simple static method: - -
    - class Transformations {
    -     static String repeatTwice(String str) {
    -         return str + " " + str;
    -     }
    - }
    - 
    - - Then, assuming we have obtained the InvokerBuilder for MyService.hello(), - we can set up the lookup and transformations and build an invoker like so: - -
    - builder.setInstanceLookup()
    -        .setArgumentTransformer(0, String.class, "toUpperCase")
    -        .setReturnValueTransformer(Transformations.class, "repeatTwice")
    -        .build();
    - 
    - - The resulting invoker will be equivalent to the following class: -
    - class TheInvoker implements Invoker<MyService, String> {
    -     String invoke(MyService ignored, Object[] arguments) {
    -         MyService instance = CDI.current().select(MyService.class).get();
    -         String argument = (String) arguments[0];
    -         String transformedArgument = argument.toUpperCase();
    -         String result = instance.hello(transformedArgument);
    -         String transformedResult = Transformations.repeatTwice(result);
    -         return transformedResult;
    -     }
    - }
    - 
    - - The caller of this invoker may pass null as the target instance, because - the invoker will lookup the target instance on its own. Therefore, calling - invoker.invoke(null, new Object[] {"world"}) will return - "Hello WORLD! Hello WORLD!". - -

    General requirements

    - - To refer to a transformer or a wrapper, all methods in this builder accept: - 1. the Class that that declares the method, and 2. the String name - of the method. -

    - Transformers may be static, in which case they must be declared directly - on the given class, or they may be instance methods, in which case they may be declared - on the given class or inherited from any of its supertypes. -

    - It is possible to register only one transformer of each kind, or for each argument - position in case of argument transformers. Attempting to register a second transformer - of the same kind, or for the same argument position, leads to an exception. -

    - Wrappers must be static and must be declared directly on the given class. - It is possible to register only one wrapper. Attempting to register a second wrapper - leads to an exception. -

    - It is a deployment problem if no method with given name and valid signature is found, - or if multiple methods with given name and different valid signatures are found. It is - a deployment problem if a registered transformer or wrapper is not public. -

    - Transformers and wrappers may declare the throws clause. The declared exception - types are ignored when searching for the method. -

    - For the purpose of the specification of transformers and wrappers below, the term - any-type is recursively defined as: the java.lang.Object class type, - or a type variable that has no bound, or a type variable whose first bound is - any-type. - -

    Input lookups

    - - For the target instance and for each argument, it is possible to specify that the value - passed to Invoker.invoke() should be ignored and a value should be looked up - from the CDI container instead. -

    - For the target instance, a CDI lookup is performed with the required type equal to the bean - class of the bean to which the target method belongs, and required qualifiers equal to the set - of all qualifier annotations present on the bean class of the bean to which the target method - belongs. When the target method is static, the target instance lookup is skipped. -

    - For an argument, a CDI lookup is performed with the required type equal to the type of - the corresponding parameter of the target method, and required qualifiers equal to the set - of all qualifier annotations present on the corresponding parameter of the target method. -

    - Implementations are required to resolve all lookups during deployment. It is a deployment - problem if the lookup ends up unresolved or ambiguous. -

    - If the looked up bean is @Dependent, it is guaranteed that the instance will be - destroyed after the target method is invoked but before the the invoker returns. The order - in which the looked up @Dependent beans are destroyed is not specified. -

    - The order in which input lookups are performed in not specified and must not be relied upon. - -

    Input transformations

    - - The target method has 2 kinds of inputs: the target instance (unless the target method is - static, in which case the target instance is ignored and should be null - by convention) and arguments. These inputs correspond to the parameters of - Invoker.invoke(). -

    - Each input can be transformed by a transformer that has one of the following signatures, - where X and Y are types: - -

      -
    • static X transform(Y value)
    • -
    • static X transform(Y value, Consumer<Runnable> cleanup)
    • -
    • X transform() – in this case, Y is the type of the class that - declares the transformer
    • -
    - - An input transformer must produce a type that can be consumed by the target method. - Specifically: when X is any-type, it is not type checked during deployment. - Otherwise, it is a deployment problem if X is not assignable to the corresponding type - in the declaration of the target method (that is the bean class in case of target instance - transformers, or the corresponding parameter type in case of argument transformers). Y - is not type checked during deployment, so that input transformers may consume arbitrary types. - TODO this paragraph refers to "assignability", which needs to be defined somewhere! -

    - When a transformer is registered for given input, it is called before the target method is - invoked, and the outcome of the transformer is used in the invocation instead of the original - value passed to the invoker by its caller. -

    - If the transformer declares the Consumer<Runnable> parameter, and the execution - of the transformer calls Consumer.accept() with some Runnable, it is - guaranteed that the Runnable will be called after the target method is invoked but - before the invoker returns. These Runnables are called cleanup tasks. - The order of cleanup task execution is not specified. Passing a null cleanup task - to the Consumer is permitted, but has no effect. -

    - If an input transformation is configured for an input for which a lookup is also configured, - the lookup is performed first and the transformation is applied to the looked up value. - If the looked up bean for some input is @Dependent, it is guaranteed that all - cleanup tasks registered by a transformer for that input are called before that looked up - @Dependent bean is destroyed. -

    - The order in which input transformations are performed in not specified and must not - be relied upon. - -

    Output transformations

    - - The target method has 2 kinds of outputs: the return value and the thrown exception. These - outputs correspond to the return value of Invoker.invoke() - or its thrown exception, respectively. -

    - Each output can be transformed by a transformer that has one of the following signatures, - where X and Y are types: - -

      -
    • static X transform(Y value)
    • -
    • X transform() – in this case, Y is the type of the class that - declares the transformer
    • -
    - - An output transformer must consume a type that can be produced by the target method. - Specifically: when Y is any-type, it is not type checked during deployment. - Otherwise, it is a deployment problem if Y is not assignable from the return type of - the target method in case of return value transformers, or from java.lang.Throwable - in case of exception transformers. X is not type checked during deployment, so that - output transformers may produce arbitrary types. - TODO this paragraph refers to "assignability", which needs to be defined somewhere! -

    - When a transformer is registered for given output, it is called after the target method - is invoked, and the outcome of the transformer is passed back to the caller of the invoker - instead of the original output produced by the target method. -

    - If the target method returns normally, any registered exception transformer is ignored; only - the return value transformer is called. The return value transformer may throw, in which case - the invoker will rethrow the exception. If the invoker is supposed to return normally, - the return value transformer must return normally. -

    - Similarly, if the target method throws, any registered return value transformer is ignored; - only the exception transformer is called. The exception transformer may return normally, - in which case the invoker will return the return value of the exception transformer. If - the invoker is supposed to throw an exception, the exception transformer must throw. - TODO this requires that implementations catch java.lang.Throwable, which is perhaps a bit too much? - maybe stick with java.lang.Exception? - -

    Invoker wrapping

    - - An invoker, possibly utilizing input lookups and input/output transformations, may be wrapped - by a custom piece of code for maximum flexibility. A wrapper must have the following signature, - where X, Y and Z are types: - -
      -
    • static Z wrap(X instance, Object[] arguments, Invoker<X, Y> invoker)
    • -
    - - A wrapper must operate on a matching instance type. Specifically: when X is - any-type, it is not type checked during deployment. Otherwise, it is a deployment - problem if X is not assignable from the class type of the bean class to which - the target method belongs. Y and Z are not type checked during deployment. -

    - When a wrapper is registered, 2 invokers for the same method are created. The inner - invoker applies all lookups and transformations, as described in previous sections, and - invokes the target method. The outer invoker calls the wrapper with the passed - instance and arguments and an instance of the inner invoker. The outer invoker is returned - by this invoker builder. -

    - In other words, the outer invoker is equivalent to the following class: - -

    - class InvokerWrapper implements Invoker<X, Z> {
    -     Z invoke(X instance, Object[] arguments) {
    -         // obtain the invoker as if no wrapper existed
    -         Invoker<X, Y> invoker = obtainInvoker();
    -         return SomeClass.wrap(instance, arguments, invoker);
    -     }
    - }
    - 
    - - If the wrapper returns normally, the outer invoker returns its return value, unless the wrapper - is declared void, in which case the outer invoker returns null. If the wrapper - throws an exception, the outer invoker rethrows it directly. -

    - The wrapper is supposed to call the invoker it is passed, but does not necessarily have to. - The wrapper may call the invoker multiple times. The wrapper must not use the invoker - in any other way; specifically, it is forbidden to store the invoker instance anywhere - or pass it to other methods that do not follow these rules. Doing so leads to non-portable - behavior. - -

    Type checking

    - - An invoker created by this builder has relaxed type checking rules, when compared to - the description in Invoker.invoke(), depending - on configured lookups, transformers and wrapper. Some types are checked during - deployment, as described in previous sections. Other types are checked during invocation, - at the very least due to the type checks performed implicitly by the JVM. The lookups, - transformers and the wrapper must arrange the inputs and outputs so that when the method - is eventually invoked, the rules described in - Invoker.invoke() all hold. -

    - TODO specify what happens when a transformer/wrapper declares a parameter of a primitive type - but the actual value passed to the invoker is `null` (the transformer should get a zero value?) - TODO specify what happens when a transformer/wrapper declares a parameter of some type - but the actual value passed to the invoker is not assignable to it (CCE?)

    -
    -
    Since:
    -
    4.1
    -
    -
  • -
-
-
- -
-
-
    -
  • - -
    -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        setInstanceLookup

        -
        InvokerBuilder<T> setInstanceLookup()
        -
        Enables lookup of the target instance.
        -
        -
        Returns:
        -
        this builder
        -
        -
      • -
      - - - -
        -
      • -

        setArgumentLookup

        -
        InvokerBuilder<T> setArgumentLookup​(int position)
        -
        Enables lookup of the argument on given position.
        -
        -
        Parameters:
        -
        position - zero-based argument position for which lookup is enabled
        -
        Returns:
        -
        this builder
        -
        Throws:
        -
        java.lang.IllegalArgumentException - if position is greather than or equal to - the number of parameters declared by the target method
        -
        -
      • -
      - - - -
        -
      • -

        setInstanceTransformer

        -
        InvokerBuilder<T> setInstanceTransformer​(java.lang.Class<?> clazz,
        -                                         java.lang.String methodName)
        -
        Configures an input transformer for the target instance.
        -
        -
        Parameters:
        -
        clazz - class that declares the transformer
        -
        methodName - transformer method name
        -
        Returns:
        -
        this builder
        -
        Throws:
        -
        java.lang.IllegalStateException - if this method is called more than once
        -
        -
      • -
      - - - -
        -
      • -

        setArgumentTransformer

        -
        InvokerBuilder<T> setArgumentTransformer​(int position,
        -                                         java.lang.Class<?> clazz,
        -                                         java.lang.String methodName)
        -
        Configures an input transformer for the argument on given position.
        -
        -
        Parameters:
        -
        position - zero-based argument position for which the input transformer is configured
        -
        clazz - class that declares the transformer
        -
        methodName - transformer method name
        -
        Returns:
        -
        this builder
        -
        Throws:
        -
        java.lang.IllegalArgumentException - if position is greather than or equal to - the number of parameters declared by the target method
        -
        java.lang.IllegalStateException - if this method is called more than once with the same position
        -
        -
      • -
      - - - -
        -
      • -

        setReturnValueTransformer

        -
        InvokerBuilder<T> setReturnValueTransformer​(java.lang.Class<?> clazz,
        -                                            java.lang.String methodName)
        -
        Configures an output transformer for the return value.
        -
        -
        Parameters:
        -
        clazz - class that declares the transformer
        -
        methodName - transformer method name
        -
        Returns:
        -
        this builder
        -
        Throws:
        -
        java.lang.IllegalStateException - if this method is called more than once
        -
        -
      • -
      - - - -
        -
      • -

        setExceptionTransformer

        -
        InvokerBuilder<T> setExceptionTransformer​(java.lang.Class<?> clazz,
        -                                          java.lang.String methodName)
        -
        Configures an output transformer for the thrown exception.
        -
        -
        Parameters:
        -
        clazz - class that declares the transformer
        -
        methodName - transformer method name
        -
        Returns:
        -
        this builder
        -
        Throws:
        -
        java.lang.IllegalStateException - if this method is called more than once
        -
        -
      • -
      - - - -
        -
      • -

        setInvocationWrapper

        -
        InvokerBuilder<T> setInvocationWrapper​(java.lang.Class<?> clazz,
        -                                       java.lang.String methodName)
        -
        Configures an invoker wrapper.
        -
        -
        Parameters:
        -
        clazz - class that declares the invoker wrapper
        -
        methodName - invoker wrapper method name
        -
        Returns:
        -
        this builder
        -
        Throws:
        -
        java.lang.IllegalStateException - if this method is called more than once
        -
        -
      • -
      - - - -
        -
      • -

        build

        -
        T build()
        -
        Returns the built Invoker or some represention of it. Implementations are allowed - but not required to reuse already built invokers for the same target method with the same - configuration.
        -
        -
        Returns:
        -
        the built invoker
        -
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- -
- -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

-
- - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/invoke/class-use/Invoker.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/invoke/class-use/Invoker.html deleted file mode 100644 index 4619f0585c..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/invoke/class-use/Invoker.html +++ /dev/null @@ -1,201 +0,0 @@ - - - - - -Uses of Interface jakarta.enterprise.invoke.Invoker (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Interface
jakarta.enterprise.invoke.Invoker

-
-
- -
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/invoke/class-use/InvokerBuilder.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/invoke/class-use/InvokerBuilder.html deleted file mode 100644 index 18f9180690..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/invoke/class-use/InvokerBuilder.html +++ /dev/null @@ -1,307 +0,0 @@ - - - - - -Uses of Interface jakarta.enterprise.invoke.InvokerBuilder (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Interface
jakarta.enterprise.invoke.InvokerBuilder

-
-
- -
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/invoke/package-summary.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/invoke/package-summary.html deleted file mode 100644 index c899b7f7da..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/invoke/package-summary.html +++ /dev/null @@ -1,181 +0,0 @@ - - - - - -jakarta.enterprise.invoke (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-
Module jakarta.cdi
-

Package jakarta.enterprise.invoke

-
-
-
    -
  • - - - - - - - - - - - - - - - - -
    Interface Summary 
    InterfaceDescription
    Invoker<T,​R> -
    Allows indirectly invoking a method that belongs to a managed bean (the target method).
    -
    InvokerBuilder<T> -
    Builder of Invokers that allows configuring input lookups, input and output - transformations, and invoker wrapping.
    -
    -
  • -
-
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/invoke/package-tree.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/invoke/package-tree.html deleted file mode 100644 index 2a6639f8b5..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/invoke/package-tree.html +++ /dev/null @@ -1,165 +0,0 @@ - - - - - -jakarta.enterprise.invoke Class Hierarchy (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Hierarchy For Package jakarta.enterprise.invoke

-Package Hierarchies: - -
-
-
-

Interface Hierarchy

- -
-
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/invoke/package-use.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/invoke/package-use.html deleted file mode 100644 index a3823baf9a..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/invoke/package-use.html +++ /dev/null @@ -1,249 +0,0 @@ - - - - - -Uses of Package jakarta.enterprise.invoke (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Package
jakarta.enterprise.invoke

-
-
- -
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/util/AnnotationLiteral.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/util/AnnotationLiteral.html deleted file mode 100644 index 133ee16ce8..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/util/AnnotationLiteral.html +++ /dev/null @@ -1,424 +0,0 @@ - - - - - -AnnotationLiteral (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Class AnnotationLiteral<T extends java.lang.annotation.Annotation>

-
-
-
    -
  • java.lang.Object
  • -
  • -
      -
    • jakarta.enterprise.util.AnnotationLiteral<T>
    • -
    -
  • -
-
- -
-
-
    -
  • - -
    -
      -
    • - - -

      Constructor Summary

      - - - - - - - - - - - - -
      Constructors 
      ModifierConstructorDescription
      protected AnnotationLiteral() 
      -
    • -
    -
    - -
    -
      -
    • - - -

      Method Summary

      - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      java.lang.Class<? extends java.lang.annotation.Annotation>annotationType() 
      booleanequals​(java.lang.Object other) 
      inthashCode() 
      java.lang.StringtoString() 
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

        -clone, finalize, getClass, notify, notifyAll, wait, wait, wait
      • -
      -
    • -
    -
    -
  • -
-
-
-
    -
  • - -
    -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        AnnotationLiteral

        -
        protected AnnotationLiteral()
        -
      • -
      -
    • -
    -
    - -
    -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        annotationType

        -
        public java.lang.Class<? extends java.lang.annotation.Annotation> annotationType()
        -
        -
        Specified by:
        -
        annotationType in interface java.lang.annotation.Annotation
        -
        -
      • -
      - - - -
        -
      • -

        toString

        -
        public java.lang.String toString()
        -
        -
        Specified by:
        -
        toString in interface java.lang.annotation.Annotation
        -
        Overrides:
        -
        toString in class java.lang.Object
        -
        -
      • -
      - - - -
        -
      • -

        equals

        -
        public boolean equals​(java.lang.Object other)
        -
        -
        Specified by:
        -
        equals in interface java.lang.annotation.Annotation
        -
        Overrides:
        -
        equals in class java.lang.Object
        -
        -
      • -
      - - - -
        -
      • -

        hashCode

        -
        public int hashCode()
        -
        -
        Specified by:
        -
        hashCode in interface java.lang.annotation.Annotation
        -
        Overrides:
        -
        hashCode in class java.lang.Object
        -
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- - - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/util/Nonbinding.Literal.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/util/Nonbinding.Literal.html deleted file mode 100644 index 91610ec188..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/util/Nonbinding.Literal.html +++ /dev/null @@ -1,370 +0,0 @@ - - - - - -Nonbinding.Literal (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Class Nonbinding.Literal

-
-
- -
- -
-
-
    -
  • - -
    - -
    - -
    - -
    - -
    -
      -
    • - - -

      Constructor Summary

      - - - - - - - - - - -
      Constructors 
      ConstructorDescription
      Literal() 
      -
    • -
    -
    - -
    -
      -
    • - - -

      Method Summary

      - -
        -
      • - - -

        Methods inherited from class java.lang.Object

        -clone, finalize, getClass, notify, notifyAll, wait, wait, wait
      • -
      -
        -
      • - - -

        Methods inherited from interface java.lang.annotation.Annotation

        -annotationType, equals, hashCode, toString
      • -
      -
    • -
    -
    -
  • -
-
-
-
    -
  • - -
    - -
    - -
    -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        Literal

        -
        public Literal()
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- - - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/util/Nonbinding.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/util/Nonbinding.html deleted file mode 100644 index 35c333c428..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/util/Nonbinding.html +++ /dev/null @@ -1,218 +0,0 @@ - - - - - -Nonbinding (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Annotation Type Nonbinding

-
-
-
-
    -
  • -
    -
    @Retention(RUNTIME)
    -@Target(METHOD)
    -public @interface Nonbinding
    -

    - Excludes a member of an annotation type (such as a qualifier type or - interceptor binding type) from consideration when the container compares two annotation - instances. -

    - -
    - @Qualifier
    - @Retention(RUNTIME)
    - @Target({ METHOD, FIELD, PARAMETER, TYPE })
    - public @interface PayBy {
    -     PaymentMethod value();
    -
    -     @Nonbinding
    -     String comment();
    - }
    - 
    -
    -
    Author:
    -
    Gavin King
    -
    See Also:
    -
    Qualifier, -InterceptorBinding
    -
    -
  • -
-
-
-
- -
- -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

-
- - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/util/TypeLiteral.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/util/TypeLiteral.html deleted file mode 100644 index c112a44889..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/util/TypeLiteral.html +++ /dev/null @@ -1,419 +0,0 @@ - - - - - -TypeLiteral (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
- -
-
-
Module jakarta.cdi
- -

Class TypeLiteral<T>

-
-
-
    -
  • java.lang.Object
  • -
  • -
      -
    • jakarta.enterprise.util.TypeLiteral<T>
    • -
    -
  • -
-
-
    -
  • -
    -
    Type Parameters:
    -
    T - the type, including all actual type parameters
    -
    -
    -
    All Implemented Interfaces:
    -
    java.io.Serializable
    -
    -
    -
    public abstract class TypeLiteral<T>
    -extends java.lang.Object
    -implements java.io.Serializable
    -

    - Supports inline instantiation of objects that represent parameterized types with actual type parameters. -

    - -

    - An object that represents any parameterized type may be obtained by subclassing TypeLiteral. -

    - -
    - TypeLiteral<List<String>> stringListType = new TypeLiteral<List<String>>() {
    - };
    - 
    -
    -
    Author:
    -
    Gavin King, Pete Muir
    -
    See Also:
    -
    Instance.select(TypeLiteral, Annotation...), -Event.select(TypeLiteral, Annotation...), -Serialized Form
    -
    -
  • -
-
-
-
    -
  • - -
    -
      -
    • - - -

      Constructor Summary

      - - - - - - - - - - - - -
      Constructors 
      ModifierConstructorDescription
      protected TypeLiteral() 
      -
    • -
    -
    - -
    -
      -
    • - - -

      Method Summary

      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      booleanequals​(java.lang.Object obj) 
      java.lang.Class<T>getRawType() 
      java.lang.reflect.TypegetType() 
      inthashCode() 
      java.lang.StringtoString() 
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

        -clone, finalize, getClass, notify, notifyAll, wait, wait, wait
      • -
      -
    • -
    -
    -
  • -
-
-
-
    -
  • - -
    -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        TypeLiteral

        -
        protected TypeLiteral()
        -
      • -
      -
    • -
    -
    - -
    -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        getType

        -
        public final java.lang.reflect.Type getType()
        -
        -
        Returns:
        -
        the actual type represented by this object
        -
        -
      • -
      - - - -
        -
      • -

        getRawType

        -
        public final java.lang.Class<T> getRawType()
        -
        -
        Returns:
        -
        the raw type represented by this object
        -
        -
      • -
      - - - -
        -
      • -

        equals

        -
        public boolean equals​(java.lang.Object obj)
        -
        -
        Overrides:
        -
        equals in class java.lang.Object
        -
        -
      • -
      - - - -
        -
      • -

        hashCode

        -
        public int hashCode()
        -
        -
        Overrides:
        -
        hashCode in class java.lang.Object
        -
        -
      • -
      - - - -
        -
      • -

        toString

        -
        public java.lang.String toString()
        -
        -
        Overrides:
        -
        toString in class java.lang.Object
        -
        -
      • -
      -
    • -
    -
    -
  • -
-
-
-
- - - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/util/class-use/AnnotationLiteral.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/util/class-use/AnnotationLiteral.html deleted file mode 100644 index 28f0523e20..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/util/class-use/AnnotationLiteral.html +++ /dev/null @@ -1,399 +0,0 @@ - - - - - -Uses of Class jakarta.enterprise.util.AnnotationLiteral (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Class
jakarta.enterprise.util.AnnotationLiteral

-
-
- -
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/util/class-use/Nonbinding.Literal.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/util/class-use/Nonbinding.Literal.html deleted file mode 100644 index 1d56db04cd..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/util/class-use/Nonbinding.Literal.html +++ /dev/null @@ -1,199 +0,0 @@ - - - - - -Uses of Class jakarta.enterprise.util.Nonbinding.Literal (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Class
jakarta.enterprise.util.Nonbinding.Literal

-
-
- -
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/util/class-use/Nonbinding.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/util/class-use/Nonbinding.html deleted file mode 100644 index 87fdc4a92b..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/util/class-use/Nonbinding.html +++ /dev/null @@ -1,153 +0,0 @@ - - - - - -Uses of Class jakarta.enterprise.util.Nonbinding (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Class
jakarta.enterprise.util.Nonbinding

-
-
No usage of jakarta.enterprise.util.Nonbinding
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/util/class-use/TypeLiteral.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/util/class-use/TypeLiteral.html deleted file mode 100644 index 11744ff9b1..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/util/class-use/TypeLiteral.html +++ /dev/null @@ -1,268 +0,0 @@ - - - - - -Uses of Class jakarta.enterprise.util.TypeLiteral (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Class
jakarta.enterprise.util.TypeLiteral

-
-
- -
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/util/package-summary.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/util/package-summary.html deleted file mode 100644 index 7025308691..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/util/package-summary.html +++ /dev/null @@ -1,213 +0,0 @@ - - - - - -jakarta.enterprise.util (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-
Module jakarta.cdi
-

Package jakarta.enterprise.util

-
-
-
- - -
Contains shared, general-purpose helper classes and annotations.
-
-
    -
  • - - - - - - - - - - - - - - - - - - - - -
    Class Summary 
    ClassDescription
    AnnotationLiteral<T extends java.lang.annotation.Annotation> -
    - Supports inline instantiation of annotation type instances.
    -
    Nonbinding.Literal -
    Supports inline instantiation of the Nonbinding annotation.
    -
    TypeLiteral<T> -
    - Supports inline instantiation of objects that represent parameterized types with actual type parameters.
    -
    -
  • -
  • - - - - - - - - - - - - -
    Annotation Types Summary 
    Annotation TypeDescription
    Nonbinding -
    - Excludes a member of an annotation type (such as a qualifier type or - interceptor binding type) from consideration when the container compares two annotation - instances.
    -
    -
  • -
-
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/util/package-tree.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/util/package-tree.html deleted file mode 100644 index 87bf69026f..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/util/package-tree.html +++ /dev/null @@ -1,179 +0,0 @@ - - - - - -jakarta.enterprise.util Class Hierarchy (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Hierarchy For Package jakarta.enterprise.util

-Package Hierarchies: - -
-
-
-

Class Hierarchy

-
    -
  • java.lang.Object -
      -
    • jakarta.enterprise.util.AnnotationLiteral<T> (implements java.lang.annotation.Annotation, java.io.Serializable) - -
    • -
    • jakarta.enterprise.util.TypeLiteral<T> (implements java.io.Serializable)
    • -
    -
  • -
-
-
-

Annotation Type Hierarchy

-
    -
  • jakarta.enterprise.util.Nonbinding (implements java.lang.annotation.Annotation)
  • -
-
-
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/util/package-use.html b/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/util/package-use.html deleted file mode 100644 index 9af015aec4..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/jakarta/enterprise/util/package-use.html +++ /dev/null @@ -1,330 +0,0 @@ - - - - - -Uses of Package jakarta.enterprise.util (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Uses of Package
jakarta.enterprise.util

-
-
- -
-
- - - diff --git a/cdi/4.1/apidocs/jakarta.cdi/module-summary.html b/cdi/4.1/apidocs/jakarta.cdi/module-summary.html deleted file mode 100644 index c0bd083ce9..0000000000 --- a/cdi/4.1/apidocs/jakarta.cdi/module-summary.html +++ /dev/null @@ -1,260 +0,0 @@ - - - - - -jakarta.cdi (Jakarta Contexts and Dependency Injection API) - - - - - - - - - - - - - - -
- -
-
-
-

Module jakarta.cdi

-
-
- -
-
-
- -

Comments to: cdi-dev@eclipse.org.
Copyright © 2018,2023 Eclipse Foundation.
Use is subject to license terms.

-
- - diff --git a/cdi/4.1/apidocs/jakarta/decorator/Decorator.html b/cdi/4.1/apidocs/jakarta/decorator/Decorator.html new file mode 100644 index 0000000000..7856800baa --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/decorator/Decorator.html @@ -0,0 +1,133 @@ + + + + +Decorator (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Annotation Interface Decorator

+
+
+
+
@Target(TYPE) +@Retention(RUNTIME) +@Documented +@Stereotype +public @interface Decorator
+

+ Specifies that a class is a decorator. May be applied to a managed bean class. +

+ +
+ @Decorator
+ class TimestampLogger implements Logger { ... }
+ 
+ +

+ Decorators of a session bean must comply with the bean provider programming restrictions defined by the EJB specification. + Decorators of a stateful session bean must comply with the rules for instance passivation and conversational state defined by + the EJB specification. +

+ +

+ CDI Lite implementations are not required to provide support for decorators. +

+
+
Author:
+
Gavin King, Pete Muir
+
See Also:
+
+ +
+
+
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/decorator/Delegate.html b/cdi/4.1/apidocs/jakarta/decorator/Delegate.html new file mode 100644 index 0000000000..c8c4fd0bbc --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/decorator/Delegate.html @@ -0,0 +1,167 @@ + + + + +Delegate (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Annotation Interface Delegate

+
+
+
+
@Target({FIELD,PARAMETER}) +@Retention(RUNTIME) +@Documented +public @interface Delegate
+

+ Identifies the delegate injection point of a decorator. May be applied to a field, bean constructor parameter or initializer + method parameter of a decorator bean class. +

+ +
+ @Decorator
+ class TimestampLogger implements Logger {
+    @Inject @Delegate @Any Logger logger;
+    ...
+ }
+ 
+ +
+ @Decorator
+ class TimestampLogger implements Logger {
+    private Logger logger;
+
+    @Inject
+    public TimestampLogger(@Delegate @Debug Logger logger) {
+       this.logger=logger;
+    }
+    ...
+ }
+ 
+ +

+ A decorator must have exactly one delegate injection point. The delegate injection point must be an injected field, + initializer method parameter or bean constructor method parameter. +

+ +

+ The container injects a delegate object to the delegate injection point. The delegate object implements the delegate type and + delegates method invocations along the decorator stack. When the container calls a decorator during business method + interception, the decorator may invoke any method of the delegate object. If a decorator invokes the delegate object at any + other time, the invoked method throws an IllegalStateException. +

+ +
+ @Decorator
+ class TimestampLogger implements Logger {
+    @Inject @Delegate @Any Logger logger;
+
+    void log(String message) {
+       logger.log( timestamp() + ": " + message );
+    }
+    ...
+ }
+ 
+ +

+ CDI Lite implementations are not required to provide support for decorators. +

+
+
Author:
+
Gavin King, Pete Muir
+
See Also:
+
+ +
+
+
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/decorator/class-use/Decorator.html b/cdi/4.1/apidocs/jakarta/decorator/class-use/Decorator.html new file mode 100644 index 0000000000..e2179e2382 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/decorator/class-use/Decorator.html @@ -0,0 +1,64 @@ + + + + +Uses of Annotation Interface jakarta.decorator.Decorator (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Annotation Interface
jakarta.decorator.Decorator

+
+No usage of jakarta.decorator.Decorator
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/decorator/class-use/Delegate.html b/cdi/4.1/apidocs/jakarta/decorator/class-use/Delegate.html new file mode 100644 index 0000000000..c3e246ce2f --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/decorator/class-use/Delegate.html @@ -0,0 +1,64 @@ + + + + +Uses of Annotation Interface jakarta.decorator.Delegate (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Annotation Interface
jakarta.decorator.Delegate

+
+No usage of jakarta.decorator.Delegate
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/decorator/package-summary.html b/cdi/4.1/apidocs/jakarta/decorator/package-summary.html new file mode 100644 index 0000000000..1c583bac5e --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/decorator/package-summary.html @@ -0,0 +1,214 @@ + + + + +jakarta.decorator (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Package jakarta.decorator

+
+
+
package jakarta.decorator
+
+

+ Annotations relating to decorators. +

+ +

+ A decorator implements one or more bean types and + intercepts business method invocations of + beans which + implement those bean types. These bean types are called + decorated types. +

+ +

+ A decorator is a managed bean annotated @Decorator. +

+ +

+ Decorators are superficially similar to interceptors, + but because they directly implement operations with business + semantics, they are able to implement business logic and, + conversely, unable to implement the cross-cutting concerns + for which interceptors are optimized. Decorators are called + after interceptors. +

+ +

Decorated types

+ +

+ The set of decorated types of a decorator includes all + bean types of the managed bean that are Java interfaces, + except for Serializable. The decorator bean + class and its superclasses are not decorated types of the + decorator. The decorator class may be abstract. +

+ +

+ A decorator intercepts every method: +

+
    +
  • declared by a decorated type of the decorator
  • +
  • that is implemented by the bean class of the decorator.
  • +
+ +

+ A decorator may be an abstract class, and is not required to + implement every method of every decorated type. +

+ +

Delegate injection points

+ +

+ All decorators have a + delegate injection point. + A delegate injection point is an injection point of the bean + class annotated @Delegate. +

+ +

+ The type of the delegate injection point must implement or + extend every decorated type. A decorator is not required to + implement the type of the delegate injection point. +

+ +

Enabled decorators

+ +

+ By default, a bean archive has no enabled decorators. A + decorator must be explicitly enabled by listing its bean class + under the <decorators> element of the + beans.xml file of the bean archive. The order of the + decorator declarations determines the decorator ordering. + Decorators which occur earlier in the list are called first. +

+ +

+ A decorator is bound to a bean if: +

+ +
    +
  • The bean is eligible for injection + to the delegate injection point of the decorator.
  • +
  • The decorator is enabled in the bean archive of the bean.
  • +
+ +

+ If a managed bean class is declared final, it may not have + decorators. If a managed bean has a non-static, non-private, + final method, it may not have any decorator which implements + that method. +

+ +

+ A decorator instance is a + dependent object + of the object it decorates. +

+
+
See Also:
+
+ +
+
+
+
+
    +
  • +
    +
    Annotation Interfaces
    +
    +
    Class
    +
    Description
    + +
    +
    + Specifies that a class is a decorator.
    +
    + +
    +
    + Identifies the delegate injection point of a decorator.
    +
    +
    +
    +
  • +
+
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/decorator/package-tree.html b/cdi/4.1/apidocs/jakarta/decorator/package-tree.html new file mode 100644 index 0000000000..9f10c5767d --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/decorator/package-tree.html @@ -0,0 +1,75 @@ + + + + +jakarta.decorator Class Hierarchy (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Hierarchy For Package jakarta.decorator

+
+Package Hierarchies: + +
+

Annotation Interface Hierarchy

+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/decorator/package-use.html b/cdi/4.1/apidocs/jakarta/decorator/package-use.html new file mode 100644 index 0000000000..e72e6a0d79 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/decorator/package-use.html @@ -0,0 +1,64 @@ + + + + +Uses of Package jakarta.decorator (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Package
jakarta.decorator

+
+No usage of jakarta.decorator
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/context/ApplicationScoped.Literal.html b/cdi/4.1/apidocs/jakarta/enterprise/context/ApplicationScoped.Literal.html new file mode 100644 index 0000000000..3860c5ae9a --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/context/ApplicationScoped.Literal.html @@ -0,0 +1,220 @@ + + + + +ApplicationScoped.Literal (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Class ApplicationScoped.Literal

+
+
java.lang.Object +
jakarta.enterprise.util.AnnotationLiteral<ApplicationScoped> +
jakarta.enterprise.context.ApplicationScoped.Literal
+
+
+
+
+
All Implemented Interfaces:
+
Annotation
+
+
+
Enclosing class:
+
ApplicationScoped
+
+
+
public static final class ApplicationScoped.Literal +extends AnnotationLiteral<ApplicationScoped> +implements ApplicationScoped
+
Supports inline instantiation of the ApplicationScoped annotation.
+
+
Since:
+
2.0
+
Author:
+
Martin Kouba
+
See Also:
+
+ +
+
+
+
+ +
+
+
    + +
  • +
    +

    Field Details

    + +
    +
  • + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      Literal

      +
      public Literal()
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/context/ApplicationScoped.html b/cdi/4.1/apidocs/jakarta/enterprise/context/ApplicationScoped.html new file mode 100644 index 0000000000..9b2b64ca0f --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/context/ApplicationScoped.html @@ -0,0 +1,175 @@ + + + + +ApplicationScoped (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Annotation Interface ApplicationScoped

+
+
+
+
@Target({TYPE,METHOD,FIELD}) +@Retention(RUNTIME) +@Documented +@NormalScope +@Inherited +public @interface ApplicationScoped
+

+ Specifies that a bean is application scoped. +

+

+ While ApplicationScoped must be associated with the built-in application context required by the specification, + third-party extensions are allowed to also associate it with their own context. Behavior described below is only related to + the built-in application context. +

+ +

+ The application scope is active: +

+ +
    +
  • during the service() method of any servlet in the web application, during the doFilter() method + of any servlet filter and when the container calls any ServletContextListener, HttpSessionListener, + AsyncListener or ServletRequestListener,
  • +
  • during any Java EE web service invocation,
  • +
  • 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,
  • +
  • when the disposer method or @PreDestroy callback of any bean with any normal scope other than + @ApplicationScoped is called, and
  • +
  • during @PostConstruct callback of any bean.
  • +
+ +

+ 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 + application. +

+

+ The application context is destroyed when the application is shut down. +

+ +

+ An event with qualifier @Initialized(ApplicationScoped.class) is fired when the application context is + initialized and an event with qualifier @Destroyed(ApplicationScoped.class) when the application context is + destroyed. The event payload is: +

+ +
    +
  • the ServletContext if the application is a web application deployed to a Servlet container, or
  • +
  • any java.lang.Object for other types of application.
  • +
+
+
Author:
+
Gavin King, Pete Muir, Antoine Sabot-Durand
+
+
+
+
    + +
  • +
    +

    Nested Class Summary

    +
    Nested Classes
    +
    +
    Modifier and Type
    +
    Class
    +
    Description
    +
    static final class 
    + +
    +
    Supports inline instantiation of the ApplicationScoped annotation.
    +
    +
    +
    +
  • +
+
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/context/BeforeDestroyed.Literal.html b/cdi/4.1/apidocs/jakarta/enterprise/context/BeforeDestroyed.Literal.html new file mode 100644 index 0000000000..aec143b57b --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/context/BeforeDestroyed.Literal.html @@ -0,0 +1,270 @@ + + + + +BeforeDestroyed.Literal (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Class BeforeDestroyed.Literal

+
+
java.lang.Object +
jakarta.enterprise.util.AnnotationLiteral<BeforeDestroyed> +
jakarta.enterprise.context.BeforeDestroyed.Literal
+
+
+
+
+
All Implemented Interfaces:
+
Annotation
+
+
+
Enclosing class:
+
BeforeDestroyed
+
+
+
public static final class BeforeDestroyed.Literal +extends AnnotationLiteral<BeforeDestroyed> +implements BeforeDestroyed
+
Supports inline instantiation of the BeforeDestroyed qualifier.
+
+
See Also:
+
+ +
+
+
+
+ +
+
+
    + +
  • +
    +

    Field Details

    +
      +
    • +
      +

      REQUEST

      +
      public static final BeforeDestroyed.Literal REQUEST
      +
      Default BeforeDestroyed literal for the RequestScoped scope
      +
      +
    • +
    • +
      +

      CONVERSATION

      +
      public static final BeforeDestroyed.Literal CONVERSATION
      +
      Default BeforeDestroyed literal for the ConversationScoped scope
      +
      +
    • +
    • +
      +

      SESSION

      +
      public static final BeforeDestroyed.Literal SESSION
      +
      Default BeforeDestroyed literal for the SessionScoped scope
      +
      +
    • +
    • +
      +

      APPLICATION

      +
      public static final BeforeDestroyed.Literal APPLICATION
      +
      Default BeforeDestroyed literal for the ApplicationScoped scope
      +
      +
    • +
    +
    +
  • + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      of

      +
      public static BeforeDestroyed.Literal of(Class<? extends Annotation> value)
      +
      Obtain the literal for the provided scope annotation
      +
      +
      Parameters:
      +
      value - the scope annotation
      +
      Returns:
      +
      a new literal value for the provided scope annotation
      +
      +
      +
    • +
    • +
      +

      value

      +
      public Class<? extends Annotation> value()
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/context/BeforeDestroyed.html b/cdi/4.1/apidocs/jakarta/enterprise/context/BeforeDestroyed.html new file mode 100644 index 0000000000..41ecaaff54 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/context/BeforeDestroyed.html @@ -0,0 +1,179 @@ + + + + +BeforeDestroyed (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Annotation Interface BeforeDestroyed

+
+
+
+
@Qualifier +@Target({TYPE,METHOD,PARAMETER,FIELD}) +@Retention(RUNTIME) +@Documented +public @interface BeforeDestroyed
+
An event with this qualifier is fired when a context is about to be destroyed, i.e. before the actual destruction.
+
+
Since:
+
2.0
+
Author:
+
Pete Muir, Martin Kouba
+
See Also:
+
+ +
+
+
+
+
    + +
  • +
    +

    Nested Class Summary

    +
    Nested Classes
    +
    +
    Modifier and Type
    +
    Class
    +
    Description
    +
    static final class 
    + +
    +
    Supports inline instantiation of the BeforeDestroyed qualifier.
    +
    +
    +
    +
  • + +
  • +
    +

    Required Element Summary

    +
    Required Elements
    +
    +
    Modifier and Type
    +
    Required Element
    +
    Description
    +
    Class<? extends Annotation>
    + +
    +
    The scope for which to observe destruction
    +
    +
    +
    +
  • +
+
+
+
    + +
  • +
    +

    Element Details

    +
      +
    • +
      +

      value

      +
      Class<? extends Annotation> value
      +
      The scope for which to observe destruction
      +
      +
      Returns:
      +
      the scope type class
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/context/BusyConversationException.html b/cdi/4.1/apidocs/jakarta/enterprise/context/BusyConversationException.html new file mode 100644 index 0000000000..4405da1a08 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/context/BusyConversationException.html @@ -0,0 +1,244 @@ + + + + +BusyConversationException (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Class BusyConversationException

+
+ +
+
+
All Implemented Interfaces:
+
Serializable
+
+
+
public class BusyConversationException +extends ContextException
+

+ Indicates that the container has rejected a request because a concurrent request is associated with the same conversation + context. +

+ +

+ The container ensures that a long-running conversation may be associated with at most one request at a time, by blocking or + rejecting concurrent requests. If the container rejects a request, it must associate the request with a new transient + conversation and throw an exception of type BusyConversationException from the restore view phase of the JSF + lifecycle. +

+ +

+ CDI Lite implementations are not required to provide support for conversations. +

+
+
Author:
+
Pete Muir, Gavin King
+
See Also:
+
+ +
+
+
+
+ +
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      BusyConversationException

      +
      public BusyConversationException()
      +
      Creates the exception with no detail message or cause.
      +
      +
    • +
    • +
      +

      BusyConversationException

      +
      public BusyConversationException(String message)
      +
      Creates the exception with given detail message.
      +
      +
      Parameters:
      +
      message - the detail message
      +
      +
      +
    • +
    • +
      +

      BusyConversationException

      +
      public BusyConversationException(Throwable cause)
      +
      Creates the exception with given cause.
      +
      +
      Parameters:
      +
      cause - the cause
      +
      +
      +
    • +
    • +
      +

      BusyConversationException

      +
      public BusyConversationException(String message, + Throwable cause)
      +
      Creates the exception with given detail message and cause.
      +
      +
      Parameters:
      +
      message - the detail message
      +
      cause - the cause
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/context/ContextException.html b/cdi/4.1/apidocs/jakarta/enterprise/context/ContextException.html new file mode 100644 index 0000000000..e077804550 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/context/ContextException.html @@ -0,0 +1,233 @@ + + + + +ContextException (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Class ContextException

+
+
java.lang.Object +
java.lang.Throwable +
java.lang.Exception +
java.lang.RuntimeException +
jakarta.enterprise.context.ContextException
+
+
+
+
+
+
+
All Implemented Interfaces:
+
Serializable
+
+
+
Direct Known Subclasses:
+
BusyConversationException, ContextNotActiveException, NonexistentConversationException
+
+
+
public class ContextException +extends RuntimeException
+

+ Indicates a problem relating to context management. +

+
+
Author:
+
Pete Muir, Shane Bryzak
+
See Also:
+
+ +
+
+
+
+ +
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      ContextException

      +
      public ContextException()
      +
      Creates the exception with no detail message or cause.
      +
      +
    • +
    • +
      +

      ContextException

      +
      public ContextException(String message)
      +
      Creates the exception with given detail message.
      +
      +
      Parameters:
      +
      message - the detail message
      +
      +
      +
    • +
    • +
      +

      ContextException

      +
      public ContextException(Throwable cause)
      +
      Creates the exception with given cause.
      +
      +
      Parameters:
      +
      cause - the cause
      +
      +
      +
    • +
    • +
      +

      ContextException

      +
      public ContextException(String message, + Throwable cause)
      +
      Creates the exception with given detail message and cause.
      +
      +
      Parameters:
      +
      message - the detail message
      +
      cause - the cause
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/context/ContextNotActiveException.html b/cdi/4.1/apidocs/jakarta/enterprise/context/ContextNotActiveException.html new file mode 100644 index 0000000000..ec6a0ae9eb --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/context/ContextNotActiveException.html @@ -0,0 +1,232 @@ + + + + +ContextNotActiveException (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Class ContextNotActiveException

+
+ +
+
+
All Implemented Interfaces:
+
Serializable
+
+
+
public class ContextNotActiveException +extends ContextException
+

+ Indicates that a context is not active. +

+
+
Author:
+
Pete Muir, Shane Bryzak, Gavin King
+
See Also:
+
+ +
+
+
+
+ +
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      ContextNotActiveException

      +
      public ContextNotActiveException()
      +
      Creates the exception with no detail message or cause.
      +
      +
    • +
    • +
      +

      ContextNotActiveException

      +
      public ContextNotActiveException(String message)
      +
      Creates the exception with given detail message.
      +
      +
      Parameters:
      +
      message - the detail message
      +
      +
      +
    • +
    • +
      +

      ContextNotActiveException

      +
      public ContextNotActiveException(Throwable cause)
      +
      Creates the exception with given cause.
      +
      +
      Parameters:
      +
      cause - the cause
      +
      +
      +
    • +
    • +
      +

      ContextNotActiveException

      +
      public ContextNotActiveException(String message, + Throwable cause)
      +
      Creates the exception with given detail message and cause.
      +
      +
      Parameters:
      +
      message - the detail message
      +
      cause - the cause
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/context/Conversation.html b/cdi/4.1/apidocs/jakarta/enterprise/context/Conversation.html new file mode 100644 index 0000000000..c9abd95e2f --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/context/Conversation.html @@ -0,0 +1,306 @@ + + + + +Conversation (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface Conversation

+
+
+
+
public interface Conversation
+

+ Allows the application to manage the conversation context by marking + the current conversation as transient or long-running, specifying a conversation identifier, or setting the conversation + timeout. +

+ +

+ An instance may be injected: +

+ +
+ @Inject
+ Conversation conversation;
+ 
+ +

+ 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. +

+ +

+ CDI Lite implementations are not required to provide support for conversations. +

+
+
Author:
+
Pete Muir, Gavin King
+
See Also:
+
+ +
+
+
+
+
    + +
  • +
    +

    Method Summary

    +
    +
    +
    +
    +
    Modifier and Type
    +
    Method
    +
    Description
    +
    void
    + +
    +
    + Mark the current transient conversation long-running.
    +
    +
    void
    + +
    +
    + Mark the current transient conversation long-running, with a specified identifier.
    +
    +
    void
    +
    end()
    +
    +
    + Marks the current long-running conversation transient.
    +
    + + +
    +
    + Get the identifier of the current long-running conversation.
    +
    +
    long
    + +
    +
    + Get the timeout of the current conversation.
    +
    +
    boolean
    + +
    +
    + Determine if the conversation is marked transient or long-running.
    +
    +
    void
    +
    setTimeout(long milliseconds)
    +
    +
    + Set the timeout of the current conversation.
    +
    +
    +
    +
    +
    +
  • +
+
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      begin

      +
      void begin()
      +

      + Mark the current transient conversation long-running. A conversation identifier is generated by the container. +

      +
      +
      Throws:
      +
      IllegalStateException - if the current conversation is already marked long-running.
      +
      +
      +
    • +
    • +
      +

      begin

      +
      void begin(String id)
      +

      + Mark the current transient conversation long-running, with a specified identifier. +

      +
      +
      Parameters:
      +
      id - conversation id
      +
      Throws:
      +
      IllegalStateException - if the current conversation is already marked long-running.
      +
      IllegalArgumentException - if a conversation with the specified identifier already exists.
      +
      +
      +
    • +
    • +
      +

      end

      +
      void end()
      +

      + Marks the current long-running conversation transient. +

      +
      +
      Throws:
      +
      IllegalStateException - if the current conversation is already marked transient.
      +
      +
      +
    • +
    • +
      +

      getId

      +
      String getId()
      +

      + Get the identifier of the current long-running conversation. +

      +
      +
      Returns:
      +
      the identifier of the current long-running conversation, or a null value if the current conversation is + transient.
      +
      +
      +
    • +
    • +
      +

      getTimeout

      +
      long getTimeout()
      +

      + Get the timeout of the current conversation. +

      +
      +
      Returns:
      +
      the current timeout in milliseconds.
      +
      +
      +
    • +
    • +
      +

      setTimeout

      +
      void setTimeout(long milliseconds)
      +

      + Set the timeout of the current conversation. +

      +
      +
      Parameters:
      +
      milliseconds - the new timeout in milliseconds.
      +
      +
      +
    • +
    • +
      +

      isTransient

      +
      boolean isTransient()
      +

      + Determine if the conversation is marked transient or long-running. +

      +
      +
      Returns:
      +
      true if the conversation is marked transient, or falseif it is marked long-running.
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/context/ConversationScoped.Literal.html b/cdi/4.1/apidocs/jakarta/enterprise/context/ConversationScoped.Literal.html new file mode 100644 index 0000000000..7a99188db9 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/context/ConversationScoped.Literal.html @@ -0,0 +1,220 @@ + + + + +ConversationScoped.Literal (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Class ConversationScoped.Literal

+
+
java.lang.Object +
jakarta.enterprise.util.AnnotationLiteral<ConversationScoped> +
jakarta.enterprise.context.ConversationScoped.Literal
+
+
+
+
+
All Implemented Interfaces:
+
Annotation
+
+
+
Enclosing class:
+
ConversationScoped
+
+
+
public static final class ConversationScoped.Literal +extends AnnotationLiteral<ConversationScoped> +implements ConversationScoped
+
Supports inline instantiation of the ConversationScoped annotation.
+
+
Since:
+
2.0
+
Author:
+
Martin Kouba
+
See Also:
+
+ +
+
+
+
+ +
+
+
    + +
  • +
    +

    Field Details

    + +
    +
  • + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      Literal

      +
      public Literal()
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/context/ConversationScoped.html b/cdi/4.1/apidocs/jakarta/enterprise/context/ConversationScoped.html new file mode 100644 index 0000000000..82c88fc910 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/context/ConversationScoped.html @@ -0,0 +1,239 @@ + + + + +ConversationScoped (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Annotation Interface ConversationScoped

+
+
+
+
@Target({TYPE,METHOD,FIELD}) +@Retention(RUNTIME) +@Documented +@NormalScope(passivating=true) +@Inherited +public @interface ConversationScoped
+

+ Specifies that a bean is conversation scoped. +

+

+ While ConversationScoped must be associated with the built-in conversation context required by the + specification, third-party extensions are allowed to also associate it with their own context. Behavior described below is + only related to the built-in conversation context. +

+

+ The conversation scope is active: +

+
    +
  • during all Servlet requests.
  • +
+

+ An event with qualifier @Initialized(ConversationScoped.class) is fired when the conversation context is + initialized and an event with qualifier @Destroyed(ConversationScoped.class) is fired when the conversation is + destroyed. The event payload is: +

+
    +
  • the conversation id if the conversation context is destroyed and is not associated with a current Servlet request, + or
  • +
  • the ServletRequest if the application is a web application deployed to a Servlet container, or
  • +
  • any java.lang.Object for other types of application.
  • +
+ +

+ The conversation context provides access to state associated with a particular conversation. Every Servlet request + has an associated conversation. This association is managed automatically by the container according to the following rules: +

+ +
    +
  • Any Servlet request has exactly one associated conversation.
  • +
  • The container provides a filter with the name "CDI Conversation Filter", which may be mapped in web.xml, + allowing the user alter when the conversation is associated with the servlet request. If this filter is not mapped in any + web.xml in the application, the conversation associated with a Servlet request is determined at the beginning of + the request before calling any service() method of any servlet in the web application, calling the + doFilter() method of any servlet filter in the web application and before the container calls any + ServletRequestListener or AsyncListener in the web application.
  • +
+ + +

+ Any conversation is in one of two states: transient or long-running. +

+ +
    +
  • By default, a conversation is transient
  • +
  • A transient conversation may be marked long-running by calling Conversation.begin()
  • +
  • A long-running conversation may be marked transient by calling Conversation.end()
  • +
+ +

+ All long-running conversations have a string-valued unique identifier, which may be set by the application when the + conversation is marked long-running, or generated by the container. +

+ +

+ If the conversation associated with the current Servlet request is in the transient state at the end of a Servlet + request, it is destroyed, and the conversation context is also destroyed. +

+ +

+ If the conversation associated with the current Servlet request is in the long-running state at the end of a Servlet + request, it is not destroyed. The long-running conversation associated with a request may be propagated to any Servlet + request via use of a request parameter named cid containing the unique identifier of the conversation. In this + case, the application must manage this request parameter. +

+ +

+ If the current Servlet request is a JSF request, and the conversation is in long-running state, it is propagated + according to the following rules: +

+ +
    +
  • The long-running conversation context associated with a request that renders a JSF view is automatically propagated to + any faces request (JSF form submission) that originates from that rendered page.
  • +
  • The long-running conversation context associated with a request that results in a JSF redirect (a redirect resulting from + a navigation rule or JSF NavigationHandler) is automatically propagated to the resulting non-faces request, and + to any other subsequent request to the same URL. This is accomplished via use of a request parameter named cid + containing the unique identifier of the conversation.
  • +
+ +

+ When no conversation is propagated to a Servlet request, or if a request parameter named conversationPropagation + has the value none the request is associated with a new transient conversation. + All long-running conversations are scoped to a particular HTTP servlet session and may not cross session boundaries. + In the following cases, a propagated long-running conversation cannot be restored and re-associated with the request: +

+ +
    +
  • When the HTTP servlet session is invalidated, all long-running conversation contexts created during the current session + are destroyed, after the servlet service() method completes.
  • +
  • The container is permitted to arbitrarily destroy any long-running conversation that is associated with no current + Servlet request, in order to conserve resources.
  • +
+ +

+ CDI Lite implementations are not required to provide support for conversations. +

+
+
Author:
+
Gavin King, Pete Muir, Antoine Sabot-Durand
+
See Also:
+
+ +
+
+
+
+ +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/context/Dependent.Literal.html b/cdi/4.1/apidocs/jakarta/enterprise/context/Dependent.Literal.html new file mode 100644 index 0000000000..25cb1a47bf --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/context/Dependent.Literal.html @@ -0,0 +1,220 @@ + + + + +Dependent.Literal (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Class Dependent.Literal

+
+
java.lang.Object +
jakarta.enterprise.util.AnnotationLiteral<Dependent> +
jakarta.enterprise.context.Dependent.Literal
+
+
+
+
+
All Implemented Interfaces:
+
Annotation
+
+
+
Enclosing class:
+
Dependent
+
+
+
public static final class Dependent.Literal +extends AnnotationLiteral<Dependent> +implements Dependent
+
Supports inline instantiation of the Dependent annotation.
+
+
Since:
+
2.0
+
Author:
+
Martin Kouba
+
See Also:
+
+ +
+
+
+
+ +
+
+
    + +
  • +
    +

    Field Details

    +
      +
    • +
      +

      INSTANCE

      +
      public static final Dependent.Literal INSTANCE
      +
      Default Dependent literal
      +
      +
    • +
    +
    +
  • + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      Literal

      +
      public Literal()
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/context/Dependent.html b/cdi/4.1/apidocs/jakarta/enterprise/context/Dependent.html new file mode 100644 index 0000000000..70bb722a70 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/context/Dependent.html @@ -0,0 +1,188 @@ + + + + +Dependent (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Annotation Interface Dependent

+
+
+
+
@Target({METHOD,TYPE,FIELD}) +@Retention(RUNTIME) +@Documented +@Scope +@Inherited +public @interface Dependent
+

+ Specifies that a bean belongs to the dependent pseudo-scope. +

+ +

+ Beans declared with scope @Dependent behave differently to beans with other built-in scope types. When a bean is + declared to have scope @Dependent: +

+ +
    +
  • No injected instance of the bean is ever shared between multiple injection points.
  • +
  • Any instance of the bean injected into an object that is being created by the container is bound to the lifecycle of the + newly created object.
  • +
  • When a Unified EL expression in a JSF or JSP page that refers to the bean by its EL name is evaluated, at most one + instance of the bean is instantiated. This instance exists to service just a single evaluation of the EL expression. It is + reused if the bean EL name appears multiple times in the EL expression, but is never reused when the EL expression is + evaluated again, or when another EL expression is evaluated.
  • +
  • Any instance of the bean that receives a producer method, producer field, disposer method or observer method invocation + exists to service that invocation only.
  • +
  • Any instance of the bean injected into method parameters of a disposer method or observer method exists to service the + method invocation only.
  • +
+ +

+ Every invocation of the Context.get(Contextual, CreationalContext) operation of the context object for the + @Dependent scope returns a new instance of the given bean. +

+ +

+ Every invocation of the Context.get(Contextual) operation of the context object for the @Dependent scope + returns a null value. +

+ +

+ The @Dependent scope is always active. +

+ +

+ Many instances of beans with scope @Dependent belong to some other bean or Java EE component class instance and + are called dependent objects. +

+ +
    +
  • Instances of decorators and interceptors are dependent objects of the bean instance they decorate.
  • +
  • An instance of a bean with scope @Dependent 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.
  • +
  • An instance of a bean with scope @Dependent injected into a producer method is a dependent object of the + producer method bean instance that is being produced.
  • +
  • An instance of a bean with scope @Dependent obtained by direct invocation of an Instance is a + dependent object of the instance of Instance.
  • +
+ +

+ When the container destroys an instance of a bean or of any Java EE component class supporting injection, the container + destroys all its dependent objects, after the @PreDestroy callback completes and after the servlet + destroy() method is called. +

+
+
Author:
+
Gavin King, Pete Muir
+
+
+
+
    + +
  • +
    +

    Nested Class Summary

    +
    Nested Classes
    +
    +
    Modifier and Type
    +
    Class
    +
    Description
    +
    static final class 
    + +
    +
    Supports inline instantiation of the Dependent annotation.
    +
    +
    +
    +
  • +
+
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/context/Destroyed.Literal.html b/cdi/4.1/apidocs/jakarta/enterprise/context/Destroyed.Literal.html new file mode 100644 index 0000000000..e4823846f5 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/context/Destroyed.Literal.html @@ -0,0 +1,272 @@ + + + + +Destroyed.Literal (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Class Destroyed.Literal

+
+
java.lang.Object +
jakarta.enterprise.util.AnnotationLiteral<Destroyed> +
jakarta.enterprise.context.Destroyed.Literal
+
+
+
+
+
All Implemented Interfaces:
+
Annotation
+
+
+
Enclosing class:
+
Destroyed
+
+
+
public static final class Destroyed.Literal +extends AnnotationLiteral<Destroyed> +implements Destroyed
+
Supports inline instantiation of the Destroyed qualifier.
+
+
Author:
+
Martin Kouba
+
See Also:
+
+ +
+
+
+
+ +
+
+
    + +
  • +
    +

    Field Details

    +
      +
    • +
      +

      REQUEST

      +
      public static final Destroyed.Literal REQUEST
      +
      Default Destroyed literal for the RequestScoped scope
      +
      +
    • +
    • +
      +

      CONVERSATION

      +
      public static final Destroyed.Literal CONVERSATION
      +
      Default Destroyed literal for the ConversationScoped scope
      +
      +
    • +
    • +
      +

      SESSION

      +
      public static final Destroyed.Literal SESSION
      +
      Default Destroyed literal for the SessionScoped scope
      +
      +
    • +
    • +
      +

      APPLICATION

      +
      public static final Destroyed.Literal APPLICATION
      +
      Default Destroyed literal for the ApplicationScoped scope
      +
      +
    • +
    +
    +
  • + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      of

      +
      public static Destroyed.Literal of(Class<? extends Annotation> value)
      +
      Obtain the literal of the provided scope annotation
      +
      +
      Parameters:
      +
      value - the scope annotation
      +
      Returns:
      +
      a new Literal value for the provided scope annotation
      +
      +
      +
    • +
    • +
      +

      value

      +
      public Class<? extends Annotation> value()
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/context/Destroyed.html b/cdi/4.1/apidocs/jakarta/enterprise/context/Destroyed.html new file mode 100644 index 0000000000..6fd09117e0 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/context/Destroyed.html @@ -0,0 +1,179 @@ + + + + +Destroyed (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Annotation Interface Destroyed

+
+
+
+
@Qualifier +@Target({TYPE,METHOD,PARAMETER,FIELD}) +@Retention(RUNTIME) +@Documented +public @interface Destroyed
+
An event with this qualifier is fired when a context is destroyed, i.e. after the actual destruction.
+
+
Since:
+
1.1
+
Author:
+
Pete Muir
+
See Also:
+
+ +
+
+
+
+
    + +
  • +
    +

    Nested Class Summary

    +
    Nested Classes
    +
    +
    Modifier and Type
    +
    Class
    +
    Description
    +
    static final class 
    + +
    +
    Supports inline instantiation of the Destroyed qualifier.
    +
    +
    +
    +
  • + +
  • +
    +

    Required Element Summary

    +
    Required Elements
    +
    +
    Modifier and Type
    +
    Required Element
    +
    Description
    +
    Class<? extends Annotation>
    + +
    +
    The scope for which to observe destruction
    +
    +
    +
    +
  • +
+
+
+
    + +
  • +
    +

    Element Details

    +
      +
    • +
      +

      value

      +
      Class<? extends Annotation> value
      +
      The scope for which to observe destruction
      +
      +
      Returns:
      +
      the scope type class
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/context/Initialized.Literal.html b/cdi/4.1/apidocs/jakarta/enterprise/context/Initialized.Literal.html new file mode 100644 index 0000000000..fa1e139609 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/context/Initialized.Literal.html @@ -0,0 +1,272 @@ + + + + +Initialized.Literal (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Class Initialized.Literal

+
+
java.lang.Object +
jakarta.enterprise.util.AnnotationLiteral<Initialized> +
jakarta.enterprise.context.Initialized.Literal
+
+
+
+
+
All Implemented Interfaces:
+
Annotation
+
+
+
Enclosing class:
+
Initialized
+
+
+
public static final class Initialized.Literal +extends AnnotationLiteral<Initialized> +implements Initialized
+
Supports inline instantiation of the Initialized qualifier.
+
+
Author:
+
Martin Kouba
+
See Also:
+
+ +
+
+
+
+ +
+
+
    + +
  • +
    +

    Field Details

    +
      +
    • +
      +

      REQUEST

      +
      public static final Initialized.Literal REQUEST
      +
      Default Initialized literal for the RequestScoped scope
      +
      +
    • +
    • +
      +

      CONVERSATION

      +
      public static final Initialized.Literal CONVERSATION
      +
      Default Initialized literal for the ConversationScoped scope
      +
      +
    • +
    • +
      +

      SESSION

      +
      public static final Initialized.Literal SESSION
      +
      Default Initialized literal for the SessionScoped scope
      +
      +
    • +
    • +
      +

      APPLICATION

      +
      public static final Initialized.Literal APPLICATION
      +
      Default Initialized literal for the ApplicationScoped scope
      +
      +
    • +
    +
    +
  • + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      of

      +
      public static Initialized.Literal of(Class<? extends Annotation> value)
      +
      Obtain the literal of the provided scope annotation
      +
      +
      Parameters:
      +
      value - the scope annotation
      +
      Returns:
      +
      a new Literal value for the provided scope annotation
      +
      +
      +
    • +
    • +
      +

      value

      +
      public Class<? extends Annotation> value()
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/context/Initialized.html b/cdi/4.1/apidocs/jakarta/enterprise/context/Initialized.html new file mode 100644 index 0000000000..9aa2420dff --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/context/Initialized.html @@ -0,0 +1,179 @@ + + + + +Initialized (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Annotation Interface Initialized

+
+
+
+
@Qualifier +@Target({TYPE,METHOD,PARAMETER,FIELD}) +@Retention(RUNTIME) +@Documented +public @interface Initialized
+
An event with this qualifier is fired when a context is initialized, i.e. ready for use.
+
+
Since:
+
1.1
+
Author:
+
Pete Muir
+
See Also:
+
+ +
+
+
+
+
    + +
  • +
    +

    Nested Class Summary

    +
    Nested Classes
    +
    +
    Modifier and Type
    +
    Class
    +
    Description
    +
    static final class 
    + +
    +
    Supports inline instantiation of the Initialized qualifier.
    +
    +
    +
    +
  • + +
  • +
    +

    Required Element Summary

    +
    Required Elements
    +
    +
    Modifier and Type
    +
    Required Element
    +
    Description
    +
    Class<? extends Annotation>
    + +
    +
    The scope for which to observe initialization
    +
    +
    +
    +
  • +
+
+
+
    + +
  • +
    +

    Element Details

    +
      +
    • +
      +

      value

      +
      Class<? extends Annotation> value
      +
      The scope for which to observe initialization
      +
      +
      Returns:
      +
      the scope type class
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/context/NonexistentConversationException.html b/cdi/4.1/apidocs/jakarta/enterprise/context/NonexistentConversationException.html new file mode 100644 index 0000000000..74e21ae3bf --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/context/NonexistentConversationException.html @@ -0,0 +1,241 @@ + + + + +NonexistentConversationException (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Class NonexistentConversationException

+
+ +
+
+
All Implemented Interfaces:
+
Serializable
+
+
+
public class NonexistentConversationException +extends ContextException
+

+ Indicates that the conversation context could not be restored. +

+ +

+ If the propagated conversation cannot be restored, the container must associate the request with a new transient conversation + and throw an exception of type NonexistentConversationException. +

+ +

+ CDI Lite implementations are not required to provide support for conversations. +

+
+
Author:
+
Pete Muir, Gavin King
+
See Also:
+
+ +
+
+
+
+ +
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      NonexistentConversationException

      +
      public NonexistentConversationException()
      +
      Creates the exception with no detail message or cause.
      +
      +
    • +
    • +
      +

      NonexistentConversationException

      +
      public NonexistentConversationException(String message)
      +
      Creates the exception with given detail message.
      +
      +
      Parameters:
      +
      message - the detail message
      +
      +
      +
    • +
    • +
      +

      NonexistentConversationException

      +
      public NonexistentConversationException(Throwable cause)
      +
      Creates the exception with given cause.
      +
      +
      Parameters:
      +
      cause - the cause
      +
      +
      +
    • +
    • +
      +

      NonexistentConversationException

      +
      public NonexistentConversationException(String message, + Throwable cause)
      +
      Creates the exception with given detail message and cause.
      +
      +
      Parameters:
      +
      message - the detail message
      +
      cause - the cause
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/context/NormalScope.html b/cdi/4.1/apidocs/jakarta/enterprise/context/NormalScope.html new file mode 100644 index 0000000000..83b8895ab4 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/context/NormalScope.html @@ -0,0 +1,172 @@ + + + + +NormalScope (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Annotation Interface NormalScope

+
+
+
+
@Target(ANNOTATION_TYPE) +@Retention(RUNTIME) +@Documented +public @interface NormalScope
+

+ Specifies that an annotation type is a normal scope type. +

+
+
Author:
+
Gavin King, Pete Muir
+
See Also:
+
+
    +
  • @Scope is used to declare pseudo-scopes.
  • +
+
+
+
+
+
    + +
  • +
    +

    Optional Element Summary

    +
    Optional Elements
    +
    +
    Modifier and Type
    +
    Optional Element
    +
    Description
    +
    boolean
    + +
    +
    + Determines whether the normal scope type is a passivating scope.
    +
    +
    +
    +
  • +
+
+
+
    + +
  • +
    +

    Element Details

    +
      +
    • +
      +

      passivating

      +
      boolean passivating
      +

      + Determines whether the normal scope type is a passivating scope. +

      + +

      + A bean is called passivation capable if the container is able to temporarily transfer the state of any idle instance to + secondary storage. A passivating scope requires that beans with the scope are passivation capable. +

      +
      +
      Returns:
      +
      true if the scope type is a passivating scope type
      +
      +
      +
      Default:
      +
      false
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/context/RequestScoped.Literal.html b/cdi/4.1/apidocs/jakarta/enterprise/context/RequestScoped.Literal.html new file mode 100644 index 0000000000..f62843121c --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/context/RequestScoped.Literal.html @@ -0,0 +1,220 @@ + + + + +RequestScoped.Literal (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Class RequestScoped.Literal

+
+
java.lang.Object +
jakarta.enterprise.util.AnnotationLiteral<RequestScoped> +
jakarta.enterprise.context.RequestScoped.Literal
+
+
+
+
+
All Implemented Interfaces:
+
Annotation
+
+
+
Enclosing class:
+
RequestScoped
+
+
+
public static final class RequestScoped.Literal +extends AnnotationLiteral<RequestScoped> +implements RequestScoped
+
Supports inline instantiation of the RequestScoped annotation.
+
+
Since:
+
2.0
+
Author:
+
Martin Kouba
+
See Also:
+
+ +
+
+
+
+ +
+
+
    + +
  • +
    +

    Field Details

    +
      +
    • +
      +

      INSTANCE

      +
      public static final RequestScoped.Literal INSTANCE
      +
      Default RequestScoped literal
      +
      +
    • +
    +
    +
  • + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      Literal

      +
      public Literal()
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/context/RequestScoped.html b/cdi/4.1/apidocs/jakarta/enterprise/context/RequestScoped.html new file mode 100644 index 0000000000..5a1806a041 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/context/RequestScoped.html @@ -0,0 +1,179 @@ + + + + +RequestScoped (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Annotation Interface RequestScoped

+
+
+
+
@Target({TYPE,METHOD,FIELD}) +@Retention(RUNTIME) +@Documented +@NormalScope +@Inherited +public @interface RequestScoped
+

+ Specifies that a bean is request scoped. +

+

+ While RequestScoped must be associated with the built-in request context required by the specification, + third-party extensions are allowed to also associate it with their own context. Behavior described below is only related to + the built-in request context. +

+ +

+ The request scope is active: +

+ +
    +
  • during the service() method of any servlet in the web application, during the doFilter() method + of any servlet filter and when the container calls any ServletRequestListener or + AsyncListener,
  • +
  • during any Java EE web service invocation,
  • +
  • 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
  • +
  • during @PostConstruct callback of any bean.
  • +
+ +

+ The request context is destroyed: +

+ +
    +
  • at the end of the servlet request, after the service() method, all doFilter() methods, and all + requestDestroyed() and onComplete() notifications return,
  • +
  • after the web service invocation completes,
  • +
  • after the EJB remote method invocation, asynchronous method invocation, timeout or message delivery completes if it did + not already exist when the invocation occurred, or
  • +
  • after the @PostConstruct callback completes, if it did not already exist when the + @PostConstruct callback occurred.
  • +
+ +

+ An event with qualifier @Initialized(RequestScoped.class) is fired when the request context is initialized and + an event with qualifier @Destroyed(RequestScoped.class) when the request context is destroyed. The event payload + is: +

+ +
    +
  • the ServletRequest if the context is initialized or destroyed due to a servlet request, or
  • +
  • the ServletRequest if the context is initialized or destroyed due to a web service invocation, or
  • +
  • any java.lang.Object for other types of request.
  • +
+
+
Author:
+
Gavin King, Pete Muir, Antoine Sabot-Durand
+
+
+
+
    + +
  • +
    +

    Nested Class Summary

    +
    Nested Classes
    +
    +
    Modifier and Type
    +
    Class
    +
    Description
    +
    static final class 
    + +
    +
    Supports inline instantiation of the RequestScoped annotation.
    +
    +
    +
    +
  • +
+
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/context/SessionScoped.Literal.html b/cdi/4.1/apidocs/jakarta/enterprise/context/SessionScoped.Literal.html new file mode 100644 index 0000000000..c10f5c57a8 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/context/SessionScoped.Literal.html @@ -0,0 +1,220 @@ + + + + +SessionScoped.Literal (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Class SessionScoped.Literal

+
+
java.lang.Object +
jakarta.enterprise.util.AnnotationLiteral<SessionScoped> +
jakarta.enterprise.context.SessionScoped.Literal
+
+
+
+
+
All Implemented Interfaces:
+
Annotation
+
+
+
Enclosing class:
+
SessionScoped
+
+
+
public static final class SessionScoped.Literal +extends AnnotationLiteral<SessionScoped> +implements SessionScoped
+
Supports inline instantiation of the SessionScoped annotation.
+
+
Since:
+
2.0
+
Author:
+
Martin Kouba
+
See Also:
+
+ +
+
+
+
+ +
+
+
    + +
  • +
    +

    Field Details

    +
      +
    • +
      +

      INSTANCE

      +
      public static final SessionScoped.Literal INSTANCE
      +
      Default SessionScoped literal
      +
      +
    • +
    +
    +
  • + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      Literal

      +
      public Literal()
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/context/SessionScoped.html b/cdi/4.1/apidocs/jakarta/enterprise/context/SessionScoped.html new file mode 100644 index 0000000000..44750f5f8c --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/context/SessionScoped.html @@ -0,0 +1,171 @@ + + + + +SessionScoped (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Annotation Interface SessionScoped

+
+
+
+
@Target({TYPE,METHOD,FIELD}) +@Retention(RUNTIME) +@Documented +@NormalScope(passivating=true) +@Inherited +public @interface SessionScoped
+

+ Specifies that a bean is session scoped. +

+

+ While SessionScoped must be associated with the built-in session context required by the specification, + third-party extensions are allowed to also associate it with their own context. Behavior described below is only related to + the built-in session context. +

+

+ The session scope is active: +

+ +
    +
  • during the service() method of any servlet in the web application, +
  • during the doFilter() method of any servlet filter, and
  • +
  • when the container calls any HttpSessionListener, AsyncListener or + ServletRequestListener.
  • +
+ +

+ The session context is shared between all servlet requests that occur in the same HTTP session. +

+

+ The session context is destroyed: +

+ +
    +
  • when the HTTPSession times out, after all HttpSessionListeners have been called, or
  • +
  • at the very end of any request in which invalidate() was called, after all filters and + ServletRequestListeners have been called.
  • +
+ +

+ An event with qualifier @Initialized(SessionScoped.class) is fired when the session context is initialized and + an event with qualifier @Destroyed(SessionScoped.class) when the session context is destroyed. The event payload + is the HttpSession + +

+ CDI Lite implementations are not required to provide support for the session scope. +

+
+
Author:
+
Gavin King, Pete Muir, Antoine Sabot-Durand
+
+
+
+
    + +
  • +
    +

    Nested Class Summary

    +
    Nested Classes
    +
    +
    Modifier and Type
    +
    Class
    +
    Description
    +
    static final class 
    + +
    +
    Supports inline instantiation of the SessionScoped annotation.
    +
    +
    +
    +
  • +
+
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/context/class-use/ApplicationScoped.Literal.html b/cdi/4.1/apidocs/jakarta/enterprise/context/class-use/ApplicationScoped.Literal.html new file mode 100644 index 0000000000..e3e8396254 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/context/class-use/ApplicationScoped.Literal.html @@ -0,0 +1,94 @@ + + + + +Uses of Class jakarta.enterprise.context.ApplicationScoped.Literal (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
jakarta.enterprise.context.ApplicationScoped.Literal

+
+
Packages that use ApplicationScoped.Literal
+
+
Package
+
Description
+ +
+
+ Annotations and interfaces relating to scopes and contexts.
+
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/context/class-use/ApplicationScoped.html b/cdi/4.1/apidocs/jakarta/enterprise/context/class-use/ApplicationScoped.html new file mode 100644 index 0000000000..9bf21349b3 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/context/class-use/ApplicationScoped.html @@ -0,0 +1,64 @@ + + + + +Uses of Annotation Interface jakarta.enterprise.context.ApplicationScoped (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Annotation Interface
jakarta.enterprise.context.ApplicationScoped

+
+No usage of jakarta.enterprise.context.ApplicationScoped
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/context/class-use/BeforeDestroyed.Literal.html b/cdi/4.1/apidocs/jakarta/enterprise/context/class-use/BeforeDestroyed.Literal.html new file mode 100644 index 0000000000..d0028ad70b --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/context/class-use/BeforeDestroyed.Literal.html @@ -0,0 +1,120 @@ + + + + +Uses of Class jakarta.enterprise.context.BeforeDestroyed.Literal (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
jakarta.enterprise.context.BeforeDestroyed.Literal

+
+
Packages that use BeforeDestroyed.Literal
+
+
Package
+
Description
+ +
+
+ Annotations and interfaces relating to scopes and contexts.
+
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/context/class-use/BeforeDestroyed.html b/cdi/4.1/apidocs/jakarta/enterprise/context/class-use/BeforeDestroyed.html new file mode 100644 index 0000000000..4059931ec4 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/context/class-use/BeforeDestroyed.html @@ -0,0 +1,64 @@ + + + + +Uses of Annotation Interface jakarta.enterprise.context.BeforeDestroyed (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Annotation Interface
jakarta.enterprise.context.BeforeDestroyed

+
+No usage of jakarta.enterprise.context.BeforeDestroyed
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/context/class-use/BusyConversationException.html b/cdi/4.1/apidocs/jakarta/enterprise/context/class-use/BusyConversationException.html new file mode 100644 index 0000000000..e35d86c6bd --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/context/class-use/BusyConversationException.html @@ -0,0 +1,64 @@ + + + + +Uses of Class jakarta.enterprise.context.BusyConversationException (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
jakarta.enterprise.context.BusyConversationException

+
+No usage of jakarta.enterprise.context.BusyConversationException
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/context/class-use/ContextException.html b/cdi/4.1/apidocs/jakarta/enterprise/context/class-use/ContextException.html new file mode 100644 index 0000000000..8932a27fd6 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/context/class-use/ContextException.html @@ -0,0 +1,108 @@ + + + + +Uses of Class jakarta.enterprise.context.ContextException (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
jakarta.enterprise.context.ContextException

+
+
Packages that use ContextException
+
+
Package
+
Description
+ +
+
+ Annotations and interfaces relating to scopes and contexts.
+
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/context/class-use/ContextNotActiveException.html b/cdi/4.1/apidocs/jakarta/enterprise/context/class-use/ContextNotActiveException.html new file mode 100644 index 0000000000..e58993599f --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/context/class-use/ContextNotActiveException.html @@ -0,0 +1,91 @@ + + + + +Uses of Class jakarta.enterprise.context.ContextNotActiveException (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
jakarta.enterprise.context.ContextNotActiveException

+
+
Packages that use ContextNotActiveException
+
+
Package
+
Description
+ +
 
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/context/class-use/Conversation.html b/cdi/4.1/apidocs/jakarta/enterprise/context/class-use/Conversation.html new file mode 100644 index 0000000000..7ec64beb0b --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/context/class-use/Conversation.html @@ -0,0 +1,64 @@ + + + + +Uses of Interface jakarta.enterprise.context.Conversation (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.enterprise.context.Conversation

+
+No usage of jakarta.enterprise.context.Conversation
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/context/class-use/ConversationScoped.Literal.html b/cdi/4.1/apidocs/jakarta/enterprise/context/class-use/ConversationScoped.Literal.html new file mode 100644 index 0000000000..3bfea300fa --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/context/class-use/ConversationScoped.Literal.html @@ -0,0 +1,94 @@ + + + + +Uses of Class jakarta.enterprise.context.ConversationScoped.Literal (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
jakarta.enterprise.context.ConversationScoped.Literal

+
+
Packages that use ConversationScoped.Literal
+
+
Package
+
Description
+ +
+
+ Annotations and interfaces relating to scopes and contexts.
+
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/context/class-use/ConversationScoped.html b/cdi/4.1/apidocs/jakarta/enterprise/context/class-use/ConversationScoped.html new file mode 100644 index 0000000000..e0613ed2df --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/context/class-use/ConversationScoped.html @@ -0,0 +1,64 @@ + + + + +Uses of Annotation Interface jakarta.enterprise.context.ConversationScoped (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Annotation Interface
jakarta.enterprise.context.ConversationScoped

+
+No usage of jakarta.enterprise.context.ConversationScoped
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/context/class-use/Dependent.Literal.html b/cdi/4.1/apidocs/jakarta/enterprise/context/class-use/Dependent.Literal.html new file mode 100644 index 0000000000..d5c0130438 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/context/class-use/Dependent.Literal.html @@ -0,0 +1,94 @@ + + + + +Uses of Class jakarta.enterprise.context.Dependent.Literal (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
jakarta.enterprise.context.Dependent.Literal

+
+
Packages that use Dependent.Literal
+
+
Package
+
Description
+ +
+
+ Annotations and interfaces relating to scopes and contexts.
+
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/context/class-use/Dependent.html b/cdi/4.1/apidocs/jakarta/enterprise/context/class-use/Dependent.html new file mode 100644 index 0000000000..bc56d11322 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/context/class-use/Dependent.html @@ -0,0 +1,64 @@ + + + + +Uses of Annotation Interface jakarta.enterprise.context.Dependent (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Annotation Interface
jakarta.enterprise.context.Dependent

+
+No usage of jakarta.enterprise.context.Dependent
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/context/class-use/Destroyed.Literal.html b/cdi/4.1/apidocs/jakarta/enterprise/context/class-use/Destroyed.Literal.html new file mode 100644 index 0000000000..a8999cc18d --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/context/class-use/Destroyed.Literal.html @@ -0,0 +1,120 @@ + + + + +Uses of Class jakarta.enterprise.context.Destroyed.Literal (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
jakarta.enterprise.context.Destroyed.Literal

+
+
Packages that use Destroyed.Literal
+
+
Package
+
Description
+ +
+
+ Annotations and interfaces relating to scopes and contexts.
+
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/context/class-use/Destroyed.html b/cdi/4.1/apidocs/jakarta/enterprise/context/class-use/Destroyed.html new file mode 100644 index 0000000000..d1d52b8787 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/context/class-use/Destroyed.html @@ -0,0 +1,64 @@ + + + + +Uses of Annotation Interface jakarta.enterprise.context.Destroyed (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Annotation Interface
jakarta.enterprise.context.Destroyed

+
+No usage of jakarta.enterprise.context.Destroyed
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/context/class-use/Initialized.Literal.html b/cdi/4.1/apidocs/jakarta/enterprise/context/class-use/Initialized.Literal.html new file mode 100644 index 0000000000..61e997c505 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/context/class-use/Initialized.Literal.html @@ -0,0 +1,120 @@ + + + + +Uses of Class jakarta.enterprise.context.Initialized.Literal (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
jakarta.enterprise.context.Initialized.Literal

+
+
Packages that use Initialized.Literal
+
+
Package
+
Description
+ +
+
+ Annotations and interfaces relating to scopes and contexts.
+
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/context/class-use/Initialized.html b/cdi/4.1/apidocs/jakarta/enterprise/context/class-use/Initialized.html new file mode 100644 index 0000000000..0b1a188805 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/context/class-use/Initialized.html @@ -0,0 +1,64 @@ + + + + +Uses of Annotation Interface jakarta.enterprise.context.Initialized (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Annotation Interface
jakarta.enterprise.context.Initialized

+
+No usage of jakarta.enterprise.context.Initialized
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/context/class-use/NonexistentConversationException.html b/cdi/4.1/apidocs/jakarta/enterprise/context/class-use/NonexistentConversationException.html new file mode 100644 index 0000000000..5da55a36dd --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/context/class-use/NonexistentConversationException.html @@ -0,0 +1,64 @@ + + + + +Uses of Class jakarta.enterprise.context.NonexistentConversationException (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
jakarta.enterprise.context.NonexistentConversationException

+
+No usage of jakarta.enterprise.context.NonexistentConversationException
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/context/class-use/NormalScope.html b/cdi/4.1/apidocs/jakarta/enterprise/context/class-use/NormalScope.html new file mode 100644 index 0000000000..8ce43a18e1 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/context/class-use/NormalScope.html @@ -0,0 +1,113 @@ + + + + +Uses of Annotation Interface jakarta.enterprise.context.NormalScope (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Annotation Interface
jakarta.enterprise.context.NormalScope

+
+
Packages that use NormalScope
+
+
Package
+
Description
+ +
+
+ Annotations and interfaces relating to scopes and contexts.
+
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/context/class-use/RequestScoped.Literal.html b/cdi/4.1/apidocs/jakarta/enterprise/context/class-use/RequestScoped.Literal.html new file mode 100644 index 0000000000..bfdeb438d8 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/context/class-use/RequestScoped.Literal.html @@ -0,0 +1,94 @@ + + + + +Uses of Class jakarta.enterprise.context.RequestScoped.Literal (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
jakarta.enterprise.context.RequestScoped.Literal

+
+
Packages that use RequestScoped.Literal
+
+
Package
+
Description
+ +
+
+ Annotations and interfaces relating to scopes and contexts.
+
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/context/class-use/RequestScoped.html b/cdi/4.1/apidocs/jakarta/enterprise/context/class-use/RequestScoped.html new file mode 100644 index 0000000000..b959aaad8d --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/context/class-use/RequestScoped.html @@ -0,0 +1,93 @@ + + + + +Uses of Annotation Interface jakarta.enterprise.context.RequestScoped (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Annotation Interface
jakarta.enterprise.context.RequestScoped

+
+
Packages that use RequestScoped
+
+
Package
+
Description
+ +
 
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/context/class-use/SessionScoped.Literal.html b/cdi/4.1/apidocs/jakarta/enterprise/context/class-use/SessionScoped.Literal.html new file mode 100644 index 0000000000..0be6d121c1 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/context/class-use/SessionScoped.Literal.html @@ -0,0 +1,94 @@ + + + + +Uses of Class jakarta.enterprise.context.SessionScoped.Literal (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
jakarta.enterprise.context.SessionScoped.Literal

+
+
Packages that use SessionScoped.Literal
+
+
Package
+
Description
+ +
+
+ Annotations and interfaces relating to scopes and contexts.
+
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/context/class-use/SessionScoped.html b/cdi/4.1/apidocs/jakarta/enterprise/context/class-use/SessionScoped.html new file mode 100644 index 0000000000..0c362b3ff3 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/context/class-use/SessionScoped.html @@ -0,0 +1,64 @@ + + + + +Uses of Annotation Interface jakarta.enterprise.context.SessionScoped (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Annotation Interface
jakarta.enterprise.context.SessionScoped

+
+No usage of jakarta.enterprise.context.SessionScoped
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/context/control/ActivateRequestContext.html b/cdi/4.1/apidocs/jakarta/enterprise/context/control/ActivateRequestContext.html new file mode 100644 index 0000000000..3c36de5e4b --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/context/control/ActivateRequestContext.html @@ -0,0 +1,117 @@ + + + + +ActivateRequestContext (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Annotation Interface ActivateRequestContext

+
+
+
+
@InterceptorBinding +@Target({METHOD,TYPE}) +@Retention(RUNTIME) +@Documented +public @interface ActivateRequestContext
+
The container provides a built in interceptor that may be used to annotate classes and methods to indicate + that a request context should be activated when this method is invoked. + + The request context will be activated before the method is called, and deactivated when the method invocation is + complete (regardless of any exceptions being thrown). If the context is already active, it is ignored, neither + activated nor deactivated.
+
+
Since:
+
2.0
+
Author:
+
John D. Ament
+
+
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/context/control/RequestContextController.html b/cdi/4.1/apidocs/jakarta/enterprise/context/control/RequestContextController.html new file mode 100644 index 0000000000..459086637d --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/context/control/RequestContextController.html @@ -0,0 +1,200 @@ + + + + +RequestContextController (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface RequestContextController

+
+
+
+
public interface RequestContextController
+
The CDI container provides a built in instance of RequestContextController that is dependent scoped for the purposes + of activating and deactivating. For example: + +
+ @Inject
+ private RequestContextController requestContextController;
+
+ public void doRequest(String body) {
+     // activate request context
+     requestContextController.activate();
+
+     // do work in a request context.
+
+     // deactivate the request context
+     requestContextController.deactivate();
+ }
+ 
+ + Once the request context has been deactivated, you may activate it once again, creating a brand new request context. + The activated request context is bound to the current thread, any injection points targeting a request scoped bean + will be satisfied with the same request scoped objects.
+
+
Since:
+
2.0
+
Author:
+
John D. Ament
+
+
+
+
    + +
  • +
    +

    Method Summary

    +
    +
    +
    +
    +
    Modifier and Type
    +
    Method
    +
    Description
    +
    boolean
    + +
    +
    Activates a RequestContext for the current thread if one is not already active.
    +
    +
    void
    + +
    +
    Deactivates the current Request Context if it was activated by this context controller.
    +
    +
    +
    +
    +
    +
  • +
+
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      activate

      +
      boolean activate()
      +
      Activates a RequestContext for the current thread if one is not already active.
      +
      +
      Returns:
      +
      true if the context was activated by this invocation, false if not.
      +
      +
      +
    • +
    • +
      +

      deactivate

      +
      void deactivate() + throws ContextNotActiveException
      +
      Deactivates the current Request Context if it was activated by this context controller. If the context is active + but was not activated by this controller, then it may not be deactivated by this controller, + meaning this method will do nothing. + + If the context is not active, a ContextNotActiveException is thrown.
      +
      +
      Throws:
      +
      ContextNotActiveException - if the context is not active
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/context/control/class-use/ActivateRequestContext.html b/cdi/4.1/apidocs/jakarta/enterprise/context/control/class-use/ActivateRequestContext.html new file mode 100644 index 0000000000..5b17df7b5e --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/context/control/class-use/ActivateRequestContext.html @@ -0,0 +1,64 @@ + + + + +Uses of Annotation Interface jakarta.enterprise.context.control.ActivateRequestContext (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Annotation Interface
jakarta.enterprise.context.control.ActivateRequestContext

+
+No usage of jakarta.enterprise.context.control.ActivateRequestContext
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/context/control/class-use/RequestContextController.html b/cdi/4.1/apidocs/jakarta/enterprise/context/control/class-use/RequestContextController.html new file mode 100644 index 0000000000..6c0784a17c --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/context/control/class-use/RequestContextController.html @@ -0,0 +1,64 @@ + + + + +Uses of Interface jakarta.enterprise.context.control.RequestContextController (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.enterprise.context.control.RequestContextController

+
+No usage of jakarta.enterprise.context.control.RequestContextController
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/context/control/package-summary.html b/cdi/4.1/apidocs/jakarta/enterprise/context/control/package-summary.html new file mode 100644 index 0000000000..753ea1d10d --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/context/control/package-summary.html @@ -0,0 +1,127 @@ + + + + +jakarta.enterprise.context.control (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Package jakarta.enterprise.context.control

+
+
+
package jakarta.enterprise.context.control
+
+
    +
  • + +
  • +
  • +
    +
    +
    +
    +
    Class
    +
    Description
    + +
    +
    The container provides a built in interceptor that may be used to annotate classes and methods to indicate + that a request context should be activated when this method is invoked.
    +
    + +
    +
    The CDI container provides a built in instance of RequestContextController that is dependent scoped for the purposes + of activating and deactivating.
    +
    +
    +
    +
    +
  • +
+
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/context/control/package-tree.html b/cdi/4.1/apidocs/jakarta/enterprise/context/control/package-tree.html new file mode 100644 index 0000000000..75a48465a1 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/context/control/package-tree.html @@ -0,0 +1,80 @@ + + + + +jakarta.enterprise.context.control Class Hierarchy (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Hierarchy For Package jakarta.enterprise.context.control

+
+Package Hierarchies: + +
+

Interface Hierarchy

+ +
+
+

Annotation Interface Hierarchy

+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/context/control/package-use.html b/cdi/4.1/apidocs/jakarta/enterprise/context/control/package-use.html new file mode 100644 index 0000000000..12bad88a7e --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/context/control/package-use.html @@ -0,0 +1,64 @@ + + + + +Uses of Package jakarta.enterprise.context.control (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Package
jakarta.enterprise.context.control

+
+No usage of jakarta.enterprise.context.control
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/context/package-summary.html b/cdi/4.1/apidocs/jakarta/enterprise/context/package-summary.html new file mode 100644 index 0000000000..51974be60d --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/context/package-summary.html @@ -0,0 +1,356 @@ + + + + +jakarta.enterprise.context (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Package jakarta.enterprise.context

+
+
+
package jakarta.enterprise.context
+
+

+ Annotations and interfaces relating to scopes and contexts. +

+ +

+ A scope type is a Java annotation annotated + @Scope or + @NormalScope. + The scope of a bean determines the lifecycle and visibility of + its instances. In particular, the scope determines: +

+ +
    +
  • When a new instance of the bean is created
  • +
  • When an existing instance of the bean is destroyed
  • +
  • Which injected references refer to any instance of the + bean
  • +
+ +

Built-in scopes

+ +

+ The following built-in scopes are provided: + @Dependent, + @RequestScoped, + @ConversationScoped, + @SessionScoped, + @ApplicationScoped, + @Singleton. +

+ +

+ The container provides an implementation of the Context + 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 + JSF requests. +

+ +

+ For other kinds of invocations, a portable extension may define a + custom context object + for any or all of the built-in scopes. For example, a third-party web + application framework might provide a conversation context object for + the built-in conversation scope. +

+ +

+ The context associated with a built-in scope propagates across + local, synchronous Java method calls, including invocation of EJB + 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. +

+ +

Normal scopes and pseudo-scopes

+ +

+ Most scopes are normal scopes. Normal scopes are declared + using @NormalScope. + If a bean has a normal scope, every client executing in a certain + thread sees the same contextual instance of the bean. This instance is + called the current instance of the bean. The operation + Context.get(Contextual) of the + context object for a normal scope type always returns the current + instance of the given bean. +

+ +

+ Any scope that is not a normal scope is called a pseudo-scope. + Pseudo-scopes are declared using @Scope. + The concept of a current instance is not well-defined in the case of + a pseudo-scope. Different clients executing in the same thread may + see different instances of the bean. In the extreme case of the + @Dependent pseudo-scope, + every client has its own private instance of the bean. +

+ +

+ All built-in scopes are normal scopes, except for the + @Dependent and + @Singleton pseudo-scopes. +

+ +

Contextual and injected reference validity

+ +

+ A reference to a bean obtained from the container via programmatic lookup is called a + contextual reference. A contextual reference for a bean with a normal + scope refers to the current instance of the bean. A contextual + reference for a bean are valid only for a certain period of time. The + application should not invoke a method of an invalid reference. +

+ +

+ The validity of a contextual reference for a bean depends upon + whether the scope of the bean is a normal scope or a pseudo-scope: +

+ +
    +
  • Any reference to a bean with a normal scope is valid as long as + the application maintains a hard reference to it. However, it may + only be invoked when the context associated with the normal scope is + active. If it is invoked when the context is inactive, a + ContextNotActiveException is thrown + by the container.
  • +
  • Any reference to a bean with a pseudo-scope is valid until the + bean instance to which it refers is destroyed. It may be invoked + even if the context associated with the pseudo-scope is not active. + If the application invokes a method of a reference to an instance + that has already been destroyed, the behavior is undefined.
  • +
+ +

+ A reference to a bean obtained from the container via dependency injection is a special kind of + contextual reference, called an injected reference. Additional + restrictions apply to the validity of an injected reference: +

+ +
    +
  • A reference to a bean injected into a field, bean constructor or + initializer method is only valid until the object into which it was + injected is destroyed.
  • +
  • A reference to a bean injected into a producer method is only + valid until the producer method bean instance that is being produced + is destroyed. +
  • +
  • A reference to a bean injected into a disposer method or observer + method is only valid until the invocation of the method completes.
  • +
+
+
See Also:
+
+ +
+
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/context/package-tree.html b/cdi/4.1/apidocs/jakarta/enterprise/context/package-tree.html new file mode 100644 index 0000000000..279ee923ea --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/context/package-tree.html @@ -0,0 +1,128 @@ + + + + +jakarta.enterprise.context Class Hierarchy (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Hierarchy For Package jakarta.enterprise.context

+
+Package Hierarchies: + +
+

Class Hierarchy

+ +
+
+

Interface Hierarchy

+ +
+
+

Annotation Interface Hierarchy

+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/context/package-use.html b/cdi/4.1/apidocs/jakarta/enterprise/context/package-use.html new file mode 100644 index 0000000000..59d7a619e5 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/context/package-use.html @@ -0,0 +1,161 @@ + + + + +Uses of Package jakarta.enterprise.context (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Package
jakarta.enterprise.context

+
+
Packages that use jakarta.enterprise.context
+
+
Package
+
Description
+ +
+
+ Annotations and interfaces relating to scopes and contexts.
+
+ +
 
+ +
 
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/context/spi/AlterableContext.html b/cdi/4.1/apidocs/jakarta/enterprise/context/spi/AlterableContext.html new file mode 100644 index 0000000000..6eef2c24d9 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/context/spi/AlterableContext.html @@ -0,0 +1,195 @@ + + + + +AlterableContext (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface AlterableContext

+
+
+
+
All Superinterfaces:
+
Context
+
+
+
public interface AlterableContext +extends Context
+

+ Provides an operation for obtaining and destroying contextual instances with a particular scope of any contextual type. Any + instance of Context is called a context object. +

+ +

+ AlterableContext was introduced in CDI 1.1 to allow bean instances to be destroyed by the application. Extensions + should implement AlterableContext instead of Context. +

+ +

+ The context object is responsible for creating and destroying contextual instances by calling operations of + Contextual. In particular, the context object is responsible for destroying any + contextual instance it creates by passing the instance to + Contextual.destroy(Object, CreationalContext) . A destroyed instance must not + subsequently be returned by get(). The context object must pass the same instance of + CreationalContext to Contextual.destroy() that it passed to + Contextual.create() when it created the instance. +

+ +

+ A custom context object may be registered with the container using + AfterBeanDiscovery.addContext(Context). +

+
+
Since:
+
1.1
+
Author:
+
Pete Muir
+
+
+
+
    + +
  • +
    +

    Method Summary

    +
    +
    +
    +
    +
    Modifier and Type
    +
    Method
    +
    Description
    +
    void
    +
    destroy(Contextual<?> contextual)
    +
    +
    + Destroy the existing contextual instance.
    +
    +
    +
    +
    +
    +

    Methods inherited from interface jakarta.enterprise.context.spi.Context

    +get, get, getScope, isActive
    +
    +
  • +
+
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      destroy

      +
      void destroy(Contextual<?> contextual)
      +

      + Destroy the existing contextual instance. If there is no existing instance, no action is taken. +

      +
      +
      Parameters:
      +
      contextual - the contextual type
      +
      Throws:
      +
      ContextNotActiveException - if the context is not active
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/context/spi/Context.html b/cdi/4.1/apidocs/jakarta/enterprise/context/spi/Context.html new file mode 100644 index 0000000000..00f61a18a6 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/context/spi/Context.html @@ -0,0 +1,249 @@ + + + + +Context (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface Context

+
+
+
+
All Known Subinterfaces:
+
AlterableContext
+
+
+
public interface Context
+

+ Provides an operation for obtaining contextual instances with a particular scope of any contextual type. Any instance of + Context is called a context object. +

+ +

+ AlterableContext was introduced in CDI 1.1 to allow bean instances to be destroyed by the application. Extensions + should implement AlterableContext instead of Context. +

+ +

+ The context object is responsible for creating and destroying contextual instances by calling operations of + Contextual. In particular, the context object is responsible for destroying any + contextual instance it creates by passing the instance to + Contextual.destroy(Object, CreationalContext) . A destroyed instance must not + subsequently be returned by get(). The context object must pass the same instance of + CreationalContext to Contextual.destroy() that it passed to + Contextual.create() when it created the instance. +

+ +

+ A custom context object may be registered with the container using + AfterBeanDiscovery.addContext(Context). +

+
+
Author:
+
Gavin King, Pete Muir
+
+
+
+
    + +
  • +
    +

    Method Summary

    +
    +
    +
    +
    +
    Modifier and Type
    +
    Method
    +
    Description
    +
    <T> T
    +
    get(Contextual<T> contextual)
    +
    +
    Return an existing instance of a certain contextual type or a null value.
    +
    +
    <T> T
    +
    get(Contextual<T> contextual, + CreationalContext<T> creationalContext)
    +
    +
    Return an existing instance of certain contextual type or create a new instance by calling + Contextual.create(CreationalContext) and return the new instance.
    +
    +
    Class<? extends Annotation>
    + +
    +
    Get the scope type of the context object.
    +
    +
    boolean
    + +
    +
    Determines if the context object is active.
    +
    +
    +
    +
    +
    +
  • +
+
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      getScope

      +
      Class<? extends Annotation> getScope()
      +
      Get the scope type of the context object.
      +
      +
      Returns:
      +
      the scope
      +
      +
      +
    • +
    • +
      +

      get

      +
      <T> T get(Contextual<T> contextual, + CreationalContext<T> creationalContext)
      +
      Return an existing instance of certain contextual type or create a new instance by calling + Contextual.create(CreationalContext) and return the new instance.
      +
      +
      Type Parameters:
      +
      T - the type of contextual type
      +
      Parameters:
      +
      contextual - the contextual type
      +
      creationalContext - the context in which the new instance will be created
      +
      Returns:
      +
      the contextual instance
      +
      Throws:
      +
      ContextNotActiveException - if the context is not active
      +
      +
      +
    • +
    • +
      +

      get

      +
      <T> T get(Contextual<T> contextual)
      +
      Return an existing instance of a certain contextual type or a null value.
      +
      +
      Type Parameters:
      +
      T - the type of the contextual type
      +
      Parameters:
      +
      contextual - the contextual type
      +
      Returns:
      +
      the contextual instance, or a null value
      +
      Throws:
      +
      ContextNotActiveException - if the context is not active
      +
      +
      +
    • +
    • +
      +

      isActive

      +
      boolean isActive()
      +
      Determines if the context object is active.
      +
      +
      Returns:
      +
      true if the context is active, or false otherwise.
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/context/spi/Contextual.html b/cdi/4.1/apidocs/jakarta/enterprise/context/spi/Contextual.html new file mode 100644 index 0000000000..2ee6a16e16 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/context/spi/Contextual.html @@ -0,0 +1,203 @@ + + + + +Contextual (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface Contextual<T>

+
+
+
+
Type Parameters:
+
T - type of the instance
+
+
+
All Known Subinterfaces:
+
Bean<T>, Decorator<T>, Interceptor<T>
+
+
+
public interface Contextual<T>
+

+ Defines operations to create and destroy contextual instances of a certain type. Any implementation of Contextual is + called a contextual type. In particular, all beans are contextual types. +

+
+
Author:
+
Gavin King, Nicklas Karlsson, Pete Muir
+
See Also:
+
+ +
+
+
+
+
    + +
  • +
    +

    Method Summary

    +
    +
    +
    +
    +
    Modifier and Type
    +
    Method
    +
    Description
    + +
    create(CreationalContext<T> creationalContext)
    +
    +
    Create a new instance of the contextual type.
    +
    +
    void
    +
    destroy(T instance, + CreationalContext<T> creationalContext)
    +
    +
    Destroy an instance of the contextual type.
    +
    +
    +
    +
    +
    +
  • +
+
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      create

      +
      T create(CreationalContext<T> creationalContext)
      +
      Create a new instance of the contextual type. Instances should use the given + CreationalContext when obtaining contextual references to inject, in order to ensure + that any dependent objects are associated with the contextual instance that is being created. An implementation may call + CreationalContext.push(Object) between instantiation and injection to help the + container minimize the use of client proxy objects.
      +
      +
      Parameters:
      +
      creationalContext - the context in which this instance is being created
      +
      Returns:
      +
      the contextual instance
      +
      Throws:
      +
      CreationException - if a checked exception occurs while creating the instance
      +
      +
      +
    • +
    • +
      +

      destroy

      +
      void destroy(T instance, + CreationalContext<T> creationalContext)
      +
      Destroy an instance of the contextual type. Implementations should call + CreationalContext.release() to allow the container to destroy dependent objects of + the contextual instance.
      +
      +
      Parameters:
      +
      instance - the contextual instance to destroy
      +
      creationalContext - the context in which this instance was created
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/context/spi/CreationalContext.html b/cdi/4.1/apidocs/jakarta/enterprise/context/spi/CreationalContext.html new file mode 100644 index 0000000000..6252375792 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/context/spi/CreationalContext.html @@ -0,0 +1,180 @@ + + + + +CreationalContext (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface CreationalContext<T>

+
+
+
+
Type Parameters:
+
T - type of the instances on which this CreationalContext operates
+
+
+
public interface CreationalContext<T>
+

+ Provides operations that are used by the Contextual implementation during instance + creation and destruction. +

+
+
Author:
+
Gavin King, Pete Muir
+
+
+
+
    + +
  • +
    +

    Method Summary

    +
    +
    +
    +
    +
    Modifier and Type
    +
    Method
    +
    Description
    +
    void
    +
    push(T incompleteInstance)
    +
    +
    Registers an incompletely initialized contextual instance the with the container.
    +
    +
    void
    + +
    +
    Destroys all dependent objects of the instance which is being destroyed, by passing each dependent object to + Contextual.destroy(Object, CreationalContext) .
    +
    +
    +
    +
    +
    +
  • +
+
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      push

      +
      void push(T incompleteInstance)
      +
      Registers an incompletely initialized contextual instance the with the container. A contextual instance is considered + incompletely initialized until it is returned by + Contextual.create(CreationalContext) .
      +
      +
      Parameters:
      +
      incompleteInstance - the incompletely initialized instance
      +
      +
      +
    • +
    • +
      +

      release

      +
      void release()
      +
      Destroys all dependent objects of the instance which is being destroyed, by passing each dependent object to + Contextual.destroy(Object, CreationalContext) .
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/context/spi/class-use/AlterableContext.html b/cdi/4.1/apidocs/jakarta/enterprise/context/spi/class-use/AlterableContext.html new file mode 100644 index 0000000000..243ca567bb --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/context/spi/class-use/AlterableContext.html @@ -0,0 +1,64 @@ + + + + +Uses of Interface jakarta.enterprise.context.spi.AlterableContext (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.enterprise.context.spi.AlterableContext

+
+No usage of jakarta.enterprise.context.spi.AlterableContext
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/context/spi/class-use/Context.html b/cdi/4.1/apidocs/jakarta/enterprise/context/spi/class-use/Context.html new file mode 100644 index 0000000000..7692abf5af --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/context/spi/class-use/Context.html @@ -0,0 +1,140 @@ + + + + +Uses of Interface jakarta.enterprise.context.spi.Context (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.enterprise.context.spi.Context

+
+
Packages that use Context
+
+
Package
+
Description
+ +
+
+ The custom context SPI.
+
+ +
+
+ The portable extension integration SPI.
+
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/context/spi/class-use/Contextual.html b/cdi/4.1/apidocs/jakarta/enterprise/context/spi/class-use/Contextual.html new file mode 100644 index 0000000000..86d56f187c --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/context/spi/class-use/Contextual.html @@ -0,0 +1,153 @@ + + + + +Uses of Interface jakarta.enterprise.context.spi.Contextual (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.enterprise.context.spi.Contextual

+
+
Packages that use Contextual
+
+
Package
+
Description
+ +
+
+ The custom context SPI.
+
+ +
+
+ The portable extension integration SPI.
+
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/context/spi/class-use/CreationalContext.html b/cdi/4.1/apidocs/jakarta/enterprise/context/spi/class-use/CreationalContext.html new file mode 100644 index 0000000000..f0ff00ac03 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/context/spi/class-use/CreationalContext.html @@ -0,0 +1,197 @@ + + + + +Uses of Interface jakarta.enterprise.context.spi.CreationalContext (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.enterprise.context.spi.CreationalContext

+
+
Packages that use CreationalContext
+
+
Package
+
Description
+ +
+
+ The custom context SPI.
+
+ +
+
+ The portable extension integration SPI.
+
+ +
 
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/context/spi/package-summary.html b/cdi/4.1/apidocs/jakarta/enterprise/context/spi/package-summary.html new file mode 100644 index 0000000000..44df1b7f29 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/context/spi/package-summary.html @@ -0,0 +1,161 @@ + + + + +jakarta.enterprise.context.spi (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Package jakarta.enterprise.context.spi

+
+
+
package jakarta.enterprise.context.spi
+
+

+ The custom context SPI. +

+ +

+ Associated with every + scope type is a + context object. + The context object implements the semantics of the scope type. +

+ +

+ The context implementation collaborates with the container via + the Context and + Contextual + interfaces to create and destroy contextual instances. +

+
+
See Also:
+
+ +
+
+
+
+
    +
  • + +
  • +
  • +
    +
    Interfaces
    +
    +
    Class
    +
    Description
    + +
    +
    + Provides an operation for obtaining and destroying contextual instances with a particular scope of any contextual type.
    +
    + +
    +
    + Provides an operation for obtaining contextual instances with a particular scope of any contextual type.
    +
    + +
    +
    + Defines operations to create and destroy contextual instances of a certain type.
    +
    + +
    +
    + Provides operations that are used by the Contextual implementation during instance + creation and destruction.
    +
    +
    +
    +
  • +
+
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/context/spi/package-tree.html b/cdi/4.1/apidocs/jakarta/enterprise/context/spi/package-tree.html new file mode 100644 index 0000000000..cbebc20a09 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/context/spi/package-tree.html @@ -0,0 +1,80 @@ + + + + +jakarta.enterprise.context.spi Class Hierarchy (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Hierarchy For Package jakarta.enterprise.context.spi

+
+Package Hierarchies: + +
+

Interface Hierarchy

+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/context/spi/package-use.html b/cdi/4.1/apidocs/jakarta/enterprise/context/spi/package-use.html new file mode 100644 index 0000000000..cf7fbce280 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/context/spi/package-use.html @@ -0,0 +1,150 @@ + + + + +Uses of Package jakarta.enterprise.context.spi (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Package
jakarta.enterprise.context.spi

+
+ +
+
Package
+
Description
+ +
+
+ The custom context SPI.
+
+ +
+
+ The portable extension integration SPI.
+
+ +
 
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/event/Event.html b/cdi/4.1/apidocs/jakarta/enterprise/event/Event.html new file mode 100644 index 0000000000..6235b8210a --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/event/Event.html @@ -0,0 +1,383 @@ + + + + +Event (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface Event<T>

+
+
+
+
Type Parameters:
+
T - the type of the event object
+
+
+
public interface Event<T>
+

+ Allows the application to fire events of a particular type. +

+ +

+ Beans fire events via an instance of the Event interface, which may be injected: +

+ +
+ @Inject
+ @Any
+ Event<LoggedInEvent> loggedInEvent;
+ 
+ +

+ The fire() method accepts an event object: +

+ +
+ public void login() {
+    ...
+    loggedInEvent.fire( new LoggedInEvent(user) );
+ }
+ 
+ +

+ Any combination of qualifiers may be specified at the injection point: +

+ +
+ @Inject
+ @Admin
+ Event<LoggedInEvent> adminLoggedInEvent;
+ 
+ +

+ Or, the @Any qualifier may be used, allowing the application to specify qualifiers + dynamically: +

+ +
+ @Inject
+ @Any
+ Event<LoggedInEvent> loggedInEvent;
+ 
+ +

+ For an injected Event: +

+ +
    +
  • the specified type is the type parameter specified at the injection point, and
  • +
  • the specified qualifiers are the qualifiers specified at the injection point.
  • +
+ +

+ Events may also be fired asynchronously with fireAsync(Object) and fireAsync(Object, NotificationOptions) + methods +

+
+
Author:
+
Gavin King, Pete Muir, David Allen, Antoine Sabot-Durand
+
+
+
+
    + +
  • +
    +

    Method Summary

    +
    +
    +
    +
    +
    Modifier and Type
    +
    Method
    +
    Description
    +
    void
    +
    fire(T event)
    +
    +
    + Fires an event with the specified qualifiers and notifies observers.
    +
    +
    <U extends T>
    CompletionStage<U>
    +
    fireAsync(U event)
    +
    +
    + Fires an event asynchronously with the specified qualifiers and notifies asynchronous observers.
    +
    +
    <U extends T>
    CompletionStage<U>
    +
    fireAsync(U event, + NotificationOptions options)
    +
    +
    + Fires an event asynchronously with the specified qualifiers and notifies asynchronous observers.
    +
    +
    <U extends T>
    Event<U>
    +
    select(TypeLiteral<U> subtype, + Annotation... qualifiers)
    +
    +
    + Obtains a child Event for the given required type and additional required qualifiers.
    +
    + +
    select(Annotation... qualifiers)
    +
    +
    + Obtains a child Event for the given additional required qualifiers.
    +
    +
    <U extends T>
    Event<U>
    +
    select(Class<U> subtype, + Annotation... qualifiers)
    +
    +
    + Obtains a child Event for the given required type and additional required qualifiers.
    +
    +
    +
    +
    +
    +
  • +
+
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      fire

      +
      void fire(T event)
      +

      + Fires an event with the specified qualifiers and notifies observers. +

      +
      +
      Parameters:
      +
      event - the event object
      +
      Throws:
      +
      IllegalArgumentException - if the runtime type of the event object contains a type variable
      +
      ObserverException - if a notified observer throws a checked exception, it will be wrapped and rethrown as an + (unchecked) ObserverException
      +
      +
      +
    • +
    • +
      +

      fireAsync

      +
      <U extends T> CompletionStage<U> fireAsync(U event)
      +

      + Fires an event asynchronously with the specified qualifiers and notifies asynchronous observers. +

      +
      +
      Type Parameters:
      +
      U - event type
      +
      Parameters:
      +
      event - the event object
      +
      Returns:
      +
      a CompletionStage allowing further pipeline composition on the asynchronous operation. + Default asynchronous execution facility is container specific. + If any observer notified by this event throws an exception + then the resulting CompletionStage is completed exceptionally with + CompletionException + that wraps all the exceptions raised by observers as suppressed exception. + If no exception is thrown by observers then the resulting CompletionStage is completed normally with the event + payload.
      +
      Throws:
      +
      IllegalArgumentException - if the runtime type of the event object contains a type variable
      +
      Since:
      +
      2.0
      +
      +
      +
    • +
    • +
      +

      fireAsync

      +
      <U extends T> CompletionStage<U> fireAsync(U event, + NotificationOptions options)
      +

      + Fires an event asynchronously with the specified qualifiers and notifies asynchronous observers. + A custom Executor will be used to make asynchronous calls +

      +
      +
      Type Parameters:
      +
      U - event type
      +
      Parameters:
      +
      event - the event object
      +
      options - the notification options
      +
      Returns:
      +
      a CompletionStage allowing further pipeline composition on the asynchronous operation. + Default asynchronous execution facility is container specific. + If any observer notified by this event throws an exception + then the resulting CompletionStage is completed exceptionally with + CompletionException + that wraps all the exceptions raised by observers as suppressed exception. + If no exception is thrown by observers then the resulting CompletionStage is completed normally with the event + payload.
      +
      Throws:
      +
      IllegalArgumentException - if the runtime type of the event object contains a type variable
      +
      Since:
      +
      2.0
      +
      +
      +
    • +
    • +
      +

      select

      +
      Event<T> select(Annotation... qualifiers)
      +

      + Obtains a child Event for the given additional required qualifiers. +

      +
      +
      Parameters:
      +
      qualifiers - the additional specified qualifiers
      +
      Returns:
      +
      the child Event
      +
      Throws:
      +
      IllegalArgumentException - if passed two instances of the same non repeating qualifier type, or an instance of an + annotation that + is not a qualifier type
      +
      +
      +
    • +
    • +
      +

      select

      +
      <U extends T> Event<U> select(Class<U> subtype, + Annotation... qualifiers)
      +

      + Obtains a child Event for the given required type and additional required qualifiers. +

      +
      +
      Type Parameters:
      +
      U - the specified type
      +
      Parameters:
      +
      subtype - a Class representing the specified type
      +
      qualifiers - the additional specified qualifiers
      +
      Returns:
      +
      the child Event
      +
      Throws:
      +
      IllegalArgumentException - if passed two instances of the same non repeating qualifier type, or an instance of an + annotation that + is not a qualifier type
      +
      +
      +
    • +
    • +
      +

      select

      +
      <U extends T> Event<U> select(TypeLiteral<U> subtype, + Annotation... qualifiers)
      +

      + Obtains a child Event for the given required type and additional required qualifiers. +

      +
      +
      Type Parameters:
      +
      U - the specified type
      +
      Parameters:
      +
      subtype - a TypeLiteral representing the specified type
      +
      qualifiers - the additional specified qualifiers
      +
      Returns:
      +
      the child Event
      +
      Throws:
      +
      IllegalArgumentException - if passed two instances of the same non repeating qualifier type, or an instance of an + annotation that + is not a qualifier type
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/event/NotificationOptions.Builder.html b/cdi/4.1/apidocs/jakarta/enterprise/event/NotificationOptions.Builder.html new file mode 100644 index 0000000000..dbe6b2b0a8 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/event/NotificationOptions.Builder.html @@ -0,0 +1,202 @@ + + + + +NotificationOptions.Builder (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface NotificationOptions.Builder

+
+
+
+
Enclosing interface:
+
NotificationOptions
+
+
+
public static interface NotificationOptions.Builder
+
Notification options builder.
+
+
Since:
+
2.0
+
Author:
+
Martin Kouba
+
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    + +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/event/NotificationOptions.html b/cdi/4.1/apidocs/jakarta/enterprise/event/NotificationOptions.html new file mode 100644 index 0000000000..4b831b4654 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/event/NotificationOptions.html @@ -0,0 +1,240 @@ + + + + +NotificationOptions (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface NotificationOptions

+
+
+
+
public interface NotificationOptions
+
Notification options are used to configure observer notification.
+
+
Since:
+
2.0
+
Author:
+
Martin Kouba
+
See Also:
+
+ +
+
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      getExecutor

      +
      Executor getExecutor()
      +
      +
      Returns:
      +
      the executor used to execute an asynchronous event
      +
      +
      +
    • +
    • +
      +

      get

      +
      Object get(String optionName)
      +
      +
      Parameters:
      +
      optionName - name of the option to get value of
      +
      Returns:
      +
      the value of an option or null if no option for the given name exists
      +
      +
      +
    • +
    • +
      +

      ofExecutor

      +
      static NotificationOptions ofExecutor(Executor executor)
      +
      +
      Parameters:
      +
      executor - a specific Executor to handle observer notification
      +
      Returns:
      +
      an immutable holder of an executor
      +
      +
      +
    • +
    • +
      +

      of

      +
      static NotificationOptions of(String optionName, + Object optionValue)
      +
      +
      Parameters:
      +
      optionName - name of the option to set
      +
      optionValue - value for the option
      +
      Returns:
      +
      an immutable holder of a single option
      +
      +
      +
    • +
    • +
      +

      builder

      +
      static NotificationOptions.Builder builder()
      +
      +
      Returns:
      +
      the options builder
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/event/ObserverException.html b/cdi/4.1/apidocs/jakarta/enterprise/event/ObserverException.html new file mode 100644 index 0000000000..dded7ff781 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/event/ObserverException.html @@ -0,0 +1,229 @@ + + + + +ObserverException (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Class ObserverException

+
+
java.lang.Object +
java.lang.Throwable +
java.lang.Exception +
java.lang.RuntimeException +
jakarta.enterprise.event.ObserverException
+
+
+
+
+
+
+
All Implemented Interfaces:
+
Serializable
+
+
+
public class ObserverException +extends RuntimeException
+

+ Indicates that a checked exception was thrown by an observer method during event notification. +

+
+
Author:
+
Pete Muir, Gavin King
+
See Also:
+
+ +
+
+
+
+ +
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      ObserverException

      +
      public ObserverException()
      +
      Creates the exception with no detail message or cause.
      +
      +
    • +
    • +
      +

      ObserverException

      +
      public ObserverException(String message)
      +
      Creates the exception with given detail message.
      +
      +
      Parameters:
      +
      message - the detail message
      +
      +
      +
    • +
    • +
      +

      ObserverException

      +
      public ObserverException(Throwable cause)
      +
      Creates the exception with given cause.
      +
      +
      Parameters:
      +
      cause - the cause
      +
      +
      +
    • +
    • +
      +

      ObserverException

      +
      public ObserverException(String message, + Throwable cause)
      +
      Creates the exception with given detail message and cause.
      +
      +
      Parameters:
      +
      message - the detail message
      +
      cause - the cause
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/event/Observes.html b/cdi/4.1/apidocs/jakarta/enterprise/event/Observes.html new file mode 100644 index 0000000000..9954afdc1a --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/event/Observes.html @@ -0,0 +1,239 @@ + + + + +Observes (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Annotation Interface Observes

+
+
+
+
@Target(PARAMETER) +@Retention(RUNTIME) +@Documented +public @interface Observes
+

+ Identifies the event parameter of an observer method. May be applied to a parameter of a method of a bean class or + extension. +

+ +
+ public void afterLogin(@Observes LoggedInEvent event) { ... }
+ 
+ +

+ 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. +

+ +

+ Each observer method must have exactly one event parameter, of the same type as the event type it observes. Event qualifiers + may be declared by annotating the event parameter. When searching for observer methods for an event, the container considers + the type and qualifiers of the event parameter. +

+ +

+ If the event parameter does not explicitly declare any qualifier, the observer method observes events with no qualifier. +

+ +

+ The event parameter type may contain a type variable or wildcard. +

+ +

+ In addition to the event parameter, observer methods may declare additional parameters, which may declare qualifiers. These + additional parameters are injection points. +

+ +
+ public void afterLogin(@Observes LoggedInEvent event, @Manager User user, Logger log) { ... }
+ 
+ +

+ A bean (or extension) may declare multiple observer methods. +

+ +

+ Observer methods are inherited by bean subclasses. +

+ +

+ Interceptors and decorators may not declare observer methods. +

+
+
Author:
+
Gavin King, Pete Muir, David Allen
+
+
+
+ +
+
+
    + +
  • +
    +

    Element Details

    + +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/event/ObservesAsync.html b/cdi/4.1/apidocs/jakarta/enterprise/event/ObservesAsync.html new file mode 100644 index 0000000000..9255001a25 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/event/ObservesAsync.html @@ -0,0 +1,211 @@ + + + + +ObservesAsync (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Annotation Interface ObservesAsync

+
+
+
+
@Target(PARAMETER) +@Retention(RUNTIME) +@Documented +public @interface ObservesAsync
+

+ Identifies the event parameter of an asynchronous observer method. May be applied to a parameter of a method of a bean class +

+ +
+ public void afterLogin(@ObservesAsync LoggedInEvent event) { ... }
+ 
+ +

+ 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. +

+ +

+ Each observer method must have exactly one event parameter, of the same type as the event type it observes. Event qualifiers + may be declared by annotating the event parameter. When searching for observer methods for an event, the container considers + the type and qualifiers of the event parameter. +

+ +

+ If the event parameter does not explicitly declare any qualifier, the observer method observes events with no qualifier. +

+ +

+ The event parameter type may contain a type variable or wildcard. +

+ +

+ In addition to the event parameter, observer methods may declare additional parameters, which may declare qualifiers. These + additional parameters are injection points. +

+ +
+ public void afterLogin(@ObservesAsync LoggedInEvent event, @Manager User user, Logger log) { ... }
+ 
+ +

+ A bean (or extension) may declare multiple observer methods. +

+ +

+ Observer methods are inherited by bean subclasses. +

+ +

+ Interceptors and decorators may not declare observer methods. +

+
+
Author:
+
Gavin King, Pete Muir, David Allen
+
+
+
+ +
+
+
    + +
  • +
    +

    Element Details

    +
      +
    • +
      +

      notifyObserver

      +
      Reception notifyObserver
      +

      + Specifies under what conditions the observer method is notified. +

      + +

      + By default, the observer method is notified even if no instance of the bean that defines the observer method already + exists in the current context. +

      +
      +
      Returns:
      +
      conditional observer type
      +
      +
      +
      Default:
      +
      ALWAYS
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/event/Reception.html b/cdi/4.1/apidocs/jakarta/enterprise/event/Reception.html new file mode 100644 index 0000000000..4d6ea4d7ee --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/event/Reception.html @@ -0,0 +1,270 @@ + + + + +Reception (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Enum Class Reception

+
+
java.lang.Object +
java.lang.Enum<Reception> +
jakarta.enterprise.event.Reception
+
+
+
+
+
All Implemented Interfaces:
+
Serializable, Comparable<Reception>, Constable
+
+
+
public enum Reception +extends Enum<Reception>
+

+ Distinguishes conditional observer methods from observer methods which are + always notified. +

+ +

+ A conditional observer method is an observer method which is notified of an event only if an instance of the bean that + defines the observer method already exists in the current context. +

+ +

+ Beans with scope @Dependent may not have conditional observer methods. +

+
+
Author:
+
Gavin King, Dan Allen, David Allen
+
+
+
+ +
+
+
    + +
  • +
    +

    Enum Constant Details

    +
      +
    • +
      +

      IF_EXISTS

      +
      public static final Reception IF_EXISTS
      +

      + Specifies that an observer method is only called if the current instance of the bean declaring the observer method + already exists. +

      +

      + If there is no active context for the scope to which the bean declaring this observer method belongs, then the observer + method is not called. +

      +
      +
    • +
    • +
      +

      ALWAYS

      +
      public static final Reception ALWAYS
      +
      Specifies that an observer method always receives event notifications.
      +
      +
    • +
    +
    +
  • + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      values

      +
      public static Reception[] values()
      +
      Returns an array containing the constants of this enum class, in +the order they are declared.
      +
      +
      Returns:
      +
      an array containing the constants of this enum class, in the order they are declared
      +
      +
      +
    • +
    • +
      +

      valueOf

      +
      public static Reception valueOf(String name)
      +
      Returns the enum constant of this class with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this class. (Extraneous whitespace characters are +not permitted.)
      +
      +
      Parameters:
      +
      name - the name of the enum constant to be returned.
      +
      Returns:
      +
      the enum constant with the specified name
      +
      Throws:
      +
      IllegalArgumentException - if this enum class has no constant with the specified name
      +
      NullPointerException - if the argument is null
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/event/Shutdown.html b/cdi/4.1/apidocs/jakarta/enterprise/event/Shutdown.html new file mode 100644 index 0000000000..b5522a2887 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/event/Shutdown.html @@ -0,0 +1,173 @@ + + + + +Shutdown (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Class Shutdown

+
+
java.lang.Object +
jakarta.enterprise.event.Shutdown
+
+
+
+
public class Shutdown +extends Object
+

+ A CDI event with payload of type Shutdown and qualifier Any is + synchronously fired by CDI container during application shutdown. + Applications must never manually fire any events with Shutdown as payload. +

+ +

+ Implementations have to fire this event during CDI container shutdown, but not later than the event with qualifier + @BeforeDestroyed(ApplicationScoped.class). +

+ +

+ This event can be observed by integrators and libraries to perform any kind of pre-shutdown operation as well as by + users as a reliable entry point for when the CDI container is about to shut down. +

+ +

+ Observers are encouraged to specify @Priority to determine ordering with lower priority numbers being + recommended for user applications and higher numbers for platform/framework/library integration. +

+ See also Interceptor.Priority
+
+
+ +
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      Shutdown

      +
      public Shutdown()
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/event/Startup.html b/cdi/4.1/apidocs/jakarta/enterprise/event/Startup.html new file mode 100644 index 0000000000..072e090f45 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/event/Startup.html @@ -0,0 +1,173 @@ + + + + +Startup (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Class Startup

+
+
java.lang.Object +
jakarta.enterprise.event.Startup
+
+
+
+
public class Startup +extends Object
+

+ A CDI event with payload of type Startup and qualifier Any is + synchronously fired by CDI container during application initialization. + Applications must never manually fire any events with Startup as payload. +

+ +

+ Implementations have to fire this event after the event with qualifier @Initialized(ApplicationScope.class) + but before processing requests. +

+ +

+ This event can be observed by integrators and libraries to perform any kind of early initialization as well as by + users as a reliable entry point for when the CDI container is ready. +

+ +

+ Observers are encouraged to specify @Priority to determine ordering with lower priority numbers being + recommended for platform/framework/library integration and higher numbers for user applications. +

+ See also Interceptor.Priority
+
+
+ +
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      Startup

      +
      public Startup()
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/event/TransactionPhase.html b/cdi/4.1/apidocs/jakarta/enterprise/event/TransactionPhase.html new file mode 100644 index 0000000000..3b47f5204c --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/event/TransactionPhase.html @@ -0,0 +1,331 @@ + + + + +TransactionPhase (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Enum Class TransactionPhase

+
+
java.lang.Object +
java.lang.Enum<TransactionPhase> +
jakarta.enterprise.event.TransactionPhase
+
+
+
+
+
All Implemented Interfaces:
+
Serializable, Comparable<TransactionPhase>, Constable
+
+
+
public enum TransactionPhase +extends Enum<TransactionPhase>
+

+ Distinguishes the various kinds of transactional observer methods from regular + observer methods which are notified immediately. +

+

+ Transactional observer methods are observer methods which receive event notifications during the before or after completion + phase of the transaction in which the event was fired. If no transaction is in progress when the event is fired, they are + notified at the same time as other observers. + If the transaction is in progress, but jakarta.transaction.Synchronization callback cannot be registered due to the + transaction being already + marked for rollback or in state where jakarta.transaction.Synchronization callbacks cannot be registered, the + BEFORE_COMPLETION, + AFTER_COMPLETION and AFTER_FAILURE observer methods are notified at the same time as other observers, + but AFTER_SUCCESS observer methods get skipped. +

+
+
Author:
+
Pete Muir, Gavin King
+
+
+
+
    + +
  • +
    +

    Nested Class Summary

    +
    +

    Nested classes/interfaces inherited from class java.lang.Enum

    +Enum.EnumDesc<E extends Enum<E>>
    +
    +
  • + +
  • +
    +

    Enum Constant Summary

    +
    Enum Constants
    +
    +
    Enum Constant
    +
    Description
    + +
    +
    + Identifies an after completion observer method, called during the after completion phase of the transaction.
    +
    + +
    +
    + Identifies an after failure observer method, called during the after completion phase of the transaction, only when the + transaction fails.
    +
    + +
    +
    + Identifies an after success observer method, called during the after completion phase of the transaction, only when the + transaction completes successfully.
    +
    + +
    +
    + Identifies a before completion observer method, called during the before completion phase of the transaction.
    +
    + +
    +
    + Identifies a regular observer method, called when the event is fired.
    +
    +
    +
    +
  • + +
  • +
    +

    Method Summary

    +
    +
    +
    +
    +
    Modifier and Type
    +
    Method
    +
    Description
    + + +
    +
    Returns the enum constant of this class with the specified name.
    +
    + + +
    +
    Returns an array containing the constants of this enum class, in +the order they are declared.
    +
    +
    +
    +
    + +
    +

    Methods inherited from class java.lang.Object

    +getClass, notify, notifyAll, wait, wait, wait
    +
    +
  • +
+
+
+
    + +
  • +
    +

    Enum Constant Details

    +
      +
    • +
      +

      IN_PROGRESS

      +
      public static final TransactionPhase IN_PROGRESS
      +

      + Identifies a regular observer method, called when the event is fired. +

      +
      +
    • +
    • +
      +

      BEFORE_COMPLETION

      +
      public static final TransactionPhase BEFORE_COMPLETION
      +

      + Identifies a before completion observer method, called during the before completion phase of the transaction. +

      +

      + Transactional observer will be notified if there is no transaction in progress, or the transaction is in progress, + but jakarta.transaction.Synchronization callback cannot be registered due to the transaction being already + marked for rollback or in state where jakarta.transaction.Synchronization callbacks cannot be registered. +

      +
      +
    • +
    • +
      +

      AFTER_COMPLETION

      +
      public static final TransactionPhase AFTER_COMPLETION
      +

      + Identifies an after completion observer method, called during the after completion phase of the transaction. +

      +

      + Transactional observer will be notified if there is no transaction in progress, or the transaction is in progress, + but jakarta.transaction.Synchronization callback cannot be registered due to the transaction being already + marked for rollback or in state where jakarta.transaction.Synchronization callbacks cannot be registered. +

      +
      +
    • +
    • +
      +

      AFTER_FAILURE

      +
      public static final TransactionPhase AFTER_FAILURE
      +

      + Identifies an after failure observer method, called during the after completion phase of the transaction, only when the + transaction fails. +

      +

      + Transactional observer will be notified will also get invoked if there is no transaction in progress, or the transaction + is in progress, but jakarta.transaction.Synchronization callback cannot be registered due to the transaction + being already marked for rollback or in state where jakarta.transaction.Synchronization callbacks cannot be + registered. +

      +
      +
    • +
    • +
      +

      AFTER_SUCCESS

      +
      public static final TransactionPhase AFTER_SUCCESS
      +

      + Identifies an after success observer method, called during the after completion phase of the transaction, only when the + transaction completes successfully. +

      +
      +
    • +
    +
    +
  • + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      values

      +
      public static TransactionPhase[] values()
      +
      Returns an array containing the constants of this enum class, in +the order they are declared.
      +
      +
      Returns:
      +
      an array containing the constants of this enum class, in the order they are declared
      +
      +
      +
    • +
    • +
      +

      valueOf

      +
      public static TransactionPhase valueOf(String name)
      +
      Returns the enum constant of this class with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this class. (Extraneous whitespace characters are +not permitted.)
      +
      +
      Parameters:
      +
      name - the name of the enum constant to be returned.
      +
      Returns:
      +
      the enum constant with the specified name
      +
      Throws:
      +
      IllegalArgumentException - if this enum class has no constant with the specified name
      +
      NullPointerException - if the argument is null
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/event/class-use/Event.html b/cdi/4.1/apidocs/jakarta/enterprise/event/class-use/Event.html new file mode 100644 index 0000000000..340dfaa63d --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/event/class-use/Event.html @@ -0,0 +1,132 @@ + + + + +Uses of Interface jakarta.enterprise.event.Event (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.enterprise.event.Event

+
+
Packages that use Event
+
+
Package
+
Description
+ +
+
+ Annotations and interfaces relating to events.
+
+ +
+
+ The portable extension integration SPI.
+
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/event/class-use/NotificationOptions.Builder.html b/cdi/4.1/apidocs/jakarta/enterprise/event/class-use/NotificationOptions.Builder.html new file mode 100644 index 0000000000..ff486be405 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/event/class-use/NotificationOptions.Builder.html @@ -0,0 +1,103 @@ + + + + +Uses of Interface jakarta.enterprise.event.NotificationOptions.Builder (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.enterprise.event.NotificationOptions.Builder

+
+
Packages that use NotificationOptions.Builder
+
+
Package
+
Description
+ +
+
+ Annotations and interfaces relating to events.
+
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/event/class-use/NotificationOptions.html b/cdi/4.1/apidocs/jakarta/enterprise/event/class-use/NotificationOptions.html new file mode 100644 index 0000000000..e649806da8 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/event/class-use/NotificationOptions.html @@ -0,0 +1,114 @@ + + + + +Uses of Interface jakarta.enterprise.event.NotificationOptions (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.enterprise.event.NotificationOptions

+
+
Packages that use NotificationOptions
+
+
Package
+
Description
+ +
+
+ Annotations and interfaces relating to events.
+
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/event/class-use/ObserverException.html b/cdi/4.1/apidocs/jakarta/enterprise/event/class-use/ObserverException.html new file mode 100644 index 0000000000..9a58b75662 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/event/class-use/ObserverException.html @@ -0,0 +1,64 @@ + + + + +Uses of Class jakarta.enterprise.event.ObserverException (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
jakarta.enterprise.event.ObserverException

+
+No usage of jakarta.enterprise.event.ObserverException
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/event/class-use/Observes.html b/cdi/4.1/apidocs/jakarta/enterprise/event/class-use/Observes.html new file mode 100644 index 0000000000..0a7a22451c --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/event/class-use/Observes.html @@ -0,0 +1,64 @@ + + + + +Uses of Annotation Interface jakarta.enterprise.event.Observes (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Annotation Interface
jakarta.enterprise.event.Observes

+
+No usage of jakarta.enterprise.event.Observes
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/event/class-use/ObservesAsync.html b/cdi/4.1/apidocs/jakarta/enterprise/event/class-use/ObservesAsync.html new file mode 100644 index 0000000000..2cb348efd7 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/event/class-use/ObservesAsync.html @@ -0,0 +1,64 @@ + + + + +Uses of Annotation Interface jakarta.enterprise.event.ObservesAsync (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Annotation Interface
jakarta.enterprise.event.ObservesAsync

+
+No usage of jakarta.enterprise.event.ObservesAsync
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/event/class-use/Reception.html b/cdi/4.1/apidocs/jakarta/enterprise/event/class-use/Reception.html new file mode 100644 index 0000000000..57c4cb0602 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/event/class-use/Reception.html @@ -0,0 +1,160 @@ + + + + +Uses of Enum Class jakarta.enterprise.event.Reception (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Enum Class
jakarta.enterprise.event.Reception

+
+
Packages that use Reception
+
+
Package
+
Description
+ +
+
+ Annotations and interfaces relating to events.
+
+ +
+
+ The build compatible extension SPI.
+
+ +
+
+ The portable extension integration SPI.
+
+ +
 
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/event/class-use/Shutdown.html b/cdi/4.1/apidocs/jakarta/enterprise/event/class-use/Shutdown.html new file mode 100644 index 0000000000..84465ebeec --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/event/class-use/Shutdown.html @@ -0,0 +1,64 @@ + + + + +Uses of Class jakarta.enterprise.event.Shutdown (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
jakarta.enterprise.event.Shutdown

+
+No usage of jakarta.enterprise.event.Shutdown
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/event/class-use/Startup.html b/cdi/4.1/apidocs/jakarta/enterprise/event/class-use/Startup.html new file mode 100644 index 0000000000..a17bb706c4 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/event/class-use/Startup.html @@ -0,0 +1,64 @@ + + + + +Uses of Class jakarta.enterprise.event.Startup (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
jakarta.enterprise.event.Startup

+
+No usage of jakarta.enterprise.event.Startup
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/event/class-use/TransactionPhase.html b/cdi/4.1/apidocs/jakarta/enterprise/event/class-use/TransactionPhase.html new file mode 100644 index 0000000000..af946d8a80 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/event/class-use/TransactionPhase.html @@ -0,0 +1,171 @@ + + + + +Uses of Enum Class jakarta.enterprise.event.TransactionPhase (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Enum Class
jakarta.enterprise.event.TransactionPhase

+
+
Packages that use TransactionPhase
+
+
Package
+
Description
+ +
+
+ Annotations and interfaces relating to events.
+
+ +
+
+ The build compatible extension SPI.
+
+ +
+
+ The portable extension integration SPI.
+
+ +
 
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/event/package-summary.html b/cdi/4.1/apidocs/jakarta/enterprise/event/package-summary.html new file mode 100644 index 0000000000..897ccdc219 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/event/package-summary.html @@ -0,0 +1,287 @@ + + + + +jakarta.enterprise.event (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Package jakarta.enterprise.event

+
+
+
package jakarta.enterprise.event
+
+

+ Annotations and interfaces relating to events. +

+ +

+ Beans may produce and + consume events. Events allows beans to interact in a completely + decoupled fashion, with no compile-time dependency between the + interacting beans. Most importantly, it allows stateful beans + in one architectural tier of the application to synchronize + their internal state with state changes that occur in a + different tier. +

+ +

+ Events may be fired synchronously or asynchronously. +

+ +

+ An event comprises: +

+ +
    +
  • A Java object, called the event object
  • +
  • A (possibly empty) set of instances of qualifier types, called + the event qualifiers
  • +
+ +

+ The Event interface is used to + fire events. +

+ +

Event objects and event types

+ +

+ The event object acts as a payload, to propagate state from + producer to consumer. An event object is an instance of a concrete + Java class with no type variables. +

+ +

+ The event types of the event include all superclasses and + interfaces of the runtime class of the event object. An event type + may not contain a type variable. +

+ +

Event qualifiers

+ +

+ The event qualifiers act as topic selectors, allowing the consumer + to narrow the set of events it observes. An event qualifier may be an + instance of any qualifier type. +

+ +

Observer methods

+ +

+ An observer method + allows the application to receive and respond synchronously to event notifications. + And an async observer method + allows the application to receive and respond asynchronously to event notifications. + they both act as event consumers, observing events of a specific type, with a + specific set of qualifiers. Any Java type may be observed by an + observer method. +

+ +

+ An observer method is a method of a bean class or + extension with a + parameter annotated @Observes + or @ObservesAsync. +

+ +

+ An observer method will be notified of an event if: +

+ +
    +
  • the event object is assignable to the type observed by the observer + method,
  • +
  • the observer method has all the event qualifiers of the event, and
  • +
  • either the event is not a + container lifecycle event, or + the observer method belongs to an + extension. +
+ +

+ If a synchronous observer method is a + transactional + observer method and there is a JTA transaction in progress when the + event is fired, the observer method is notified during the appropriate + transaction completion phase. Otherwise, the observer is notified when + the event is fired. +

+ +

+ The order in which observer methods are called depends on the value of + the @Priority applied to the observer. +

+

+ If no priority is defined on a observer, its priority is jakarta.interceptor.Interceptor.Priority.APPLICATION+500. +

+

+ If two observer have the same priority their relative order is undefined. +

+ +

+ Observer methods may throw exceptions: +

+ +
    +
  • If the observer method is a + transactional + observer method, any exception is caught and logged by the container.
  • +
  • If the observer method is asynchronous, any exception is caught by the container and added as a suppressed exception + to a CompletionException that could be handle by the application
  • +
  • Otherwise, the exception aborts processing of the event. + No other observer methods of that event will be called. The + exception is rethrown. If the exception is a checked exception, + it is wrapped and rethrown as an (unchecked) + ObserverException.
  • +
+
+
See Also:
+
+ +
+
+
+
+
    +
  • +
    +
    +
    +
    +
    Class
    +
    Description
    + +
    +
    + Allows the application to fire events of a particular type.
    +
    + +
    +
    Notification options are used to configure observer notification.
    +
    + +
    +
    Notification options builder.
    +
    + +
    +
    + Indicates that a checked exception was thrown by an observer method during event notification.
    +
    + +
    +
    + Identifies the event parameter of an observer method.
    +
    + +
    +
    + Identifies the event parameter of an asynchronous observer method.
    +
    + +
    +
    + Distinguishes conditional observer methods from observer methods which are + always notified.
    +
    + +
    +
    + A CDI event with payload of type Shutdown and qualifier Any is + synchronously fired by CDI container during application shutdown.
    +
    + +
    +
    + A CDI event with payload of type Startup and qualifier Any is + synchronously fired by CDI container during application initialization.
    +
    + +
    +
    + Distinguishes the various kinds of transactional observer methods from regular + observer methods which are notified immediately.
    +
    +
    +
    +
    +
  • +
+
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/event/package-tree.html b/cdi/4.1/apidocs/jakarta/enterprise/event/package-tree.html new file mode 100644 index 0000000000..912c1b0043 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/event/package-tree.html @@ -0,0 +1,122 @@ + + + + +jakarta.enterprise.event Class Hierarchy (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Hierarchy For Package jakarta.enterprise.event

+
+Package Hierarchies: + +
+

Class Hierarchy

+ +
+
+

Interface Hierarchy

+ +
+
+

Annotation Interface Hierarchy

+ +
+
+

Enum Class Hierarchy

+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/event/package-use.html b/cdi/4.1/apidocs/jakarta/enterprise/event/package-use.html new file mode 100644 index 0000000000..ed4967bfc6 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/event/package-use.html @@ -0,0 +1,192 @@ + + + + +Uses of Package jakarta.enterprise.event (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Package
jakarta.enterprise.event

+
+
Packages that use jakarta.enterprise.event
+
+
Package
+
Description
+ +
+
+ Annotations and interfaces relating to events.
+
+ +
+
+ The build compatible extension SPI.
+
+ +
+
+ The portable extension integration SPI.
+
+ +
 
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/Alternative.Literal.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/Alternative.Literal.html new file mode 100644 index 0000000000..09bca6d0dc --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/Alternative.Literal.html @@ -0,0 +1,220 @@ + + + + +Alternative.Literal (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Class Alternative.Literal

+
+
java.lang.Object +
jakarta.enterprise.util.AnnotationLiteral<Alternative> +
jakarta.enterprise.inject.Alternative.Literal
+
+
+
+
+
All Implemented Interfaces:
+
Annotation
+
+
+
Enclosing class:
+
Alternative
+
+
+
public static final class Alternative.Literal +extends AnnotationLiteral<Alternative> +implements Alternative
+
Supports inline instantiation of the Alternative annotation.
+
+
Since:
+
2.0
+
Author:
+
Martin Kouba
+
See Also:
+
+ +
+
+
+
+ +
+
+
    + +
  • +
    +

    Field Details

    +
      +
    • +
      +

      INSTANCE

      +
      public static final Alternative.Literal INSTANCE
      +
      Default Alternative literal
      +
      +
    • +
    +
    +
  • + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      Literal

      +
      public Literal()
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/Alternative.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/Alternative.html new file mode 100644 index 0000000000..593f3c1026 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/Alternative.html @@ -0,0 +1,158 @@ + + + + +Alternative (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Annotation Interface Alternative

+
+
+
+
@Target({TYPE,METHOD,FIELD}) +@Retention(RUNTIME) +@Documented +public @interface Alternative
+

+ Specifies that a bean is an alternative. May be applied to a bean class, producer method or field or + stereotype. +

+ +
+ @Alternative
+ public class MockOrder extends Order { ... }
+ 
+ +

+ An alternative is not available for injection, lookup or EL resolution to classes or JSP/JSF pages in a module unless the + module is a bean archive and the alternative is explicitly selected in that bean archive. An alternative is never + available for injection, lookup or EL resolution in a module that is not a bean archive. +

+ +

+ By default, a bean archive has no selected alternatives. An alternative must be explicitly declared using the + <alternatives> element of the beans.xml file of the bean archive. The + <alternatives> element contains a list of bean classes and stereotypes. An alternative is selected for the + bean archive if either: +

+ +
    +
  • the alternative is a managed bean or session bean and the bean class of the bean is listed,
  • +
  • the alternative is a producer method, field or resource, and the bean class that declares the method or field is listed, + or
  • +
  • any @Alternative stereotype of the alternative is listed.
  • +
+
+
Author:
+
Gavin King, Pete Muir
+
+
+
+
    + +
  • +
    +

    Nested Class Summary

    +
    Nested Classes
    +
    +
    Modifier and Type
    +
    Class
    +
    Description
    +
    static final class 
    + +
    +
    Supports inline instantiation of the Alternative annotation.
    +
    +
    +
    +
  • +
+
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/AmbiguousResolutionException.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/AmbiguousResolutionException.html new file mode 100644 index 0000000000..32087f6d73 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/AmbiguousResolutionException.html @@ -0,0 +1,234 @@ + + + + +AmbiguousResolutionException (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Class AmbiguousResolutionException

+
+ +
+
+
All Implemented Interfaces:
+
Serializable
+
+
+
public class AmbiguousResolutionException +extends ResolutionException
+

+ Indicates that multiple beans match a certain combination of required type and required qualifiers and are eligible for + injection into a certain class. +

+
+
Author:
+
Pete Muir, Gavin King
+
See Also:
+
+ +
+
+
+
+ +
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      AmbiguousResolutionException

      +
      public AmbiguousResolutionException()
      +
      Creates the exception with no detail message or cause.
      +
      +
    • +
    • +
      +

      AmbiguousResolutionException

      +
      public AmbiguousResolutionException(String message, + Throwable cause)
      +
      Creates the exception with given detail message and cause.
      +
      +
      Parameters:
      +
      message - the detail message
      +
      cause - the cause
      +
      +
      +
    • +
    • +
      +

      AmbiguousResolutionException

      +
      public AmbiguousResolutionException(String message)
      +
      Creates the exception with given detail message.
      +
      +
      Parameters:
      +
      message - the detail message
      +
      +
      +
    • +
    • +
      +

      AmbiguousResolutionException

      +
      public AmbiguousResolutionException(Throwable cause)
      +
      Creates the exception with given cause.
      +
      +
      Parameters:
      +
      cause - the cause
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/Any.Literal.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/Any.Literal.html new file mode 100644 index 0000000000..993026904e --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/Any.Literal.html @@ -0,0 +1,222 @@ + + + + +Any.Literal (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Class Any.Literal

+
+
java.lang.Object +
jakarta.enterprise.util.AnnotationLiteral<Any> +
jakarta.enterprise.inject.Any.Literal
+
+
+
+
+
All Implemented Interfaces:
+
Annotation
+
+
+
Enclosing class:
+
Any
+
+
+
public static final class Any.Literal +extends AnnotationLiteral<Any> +implements Any
+
Supports inline instantiation of the Any qualifier.
+
+
Since:
+
2.0
+
Author:
+
Martin Kouba
+
See Also:
+
+ +
+
+
+
+ +
+
+
    + +
  • +
    +

    Field Details

    +
      +
    • +
      +

      INSTANCE

      +
      public static final Any.Literal INSTANCE
      +
      Default Any literal
      +
      +
    • +
    +
    +
  • + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      Literal

      +
      public Literal()
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/Any.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/Any.html new file mode 100644 index 0000000000..dba8a1e88d --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/Any.html @@ -0,0 +1,164 @@ + + + + +Any (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Annotation Interface Any

+
+
+
+
@Qualifier +@Retention(RUNTIME) +@Target({TYPE,METHOD,FIELD,PARAMETER}) +@Documented +public @interface Any
+

+ The built-in qualifier type. +

+ +

+ Every bean has the qualifier @Any, even if it does not explicitly declare this qualifier. +

+ +

+ Every event has the qualifier @Any, even if it was raised without explicitly declaration of this qualifier. +

+ +

+ The @Any qualifier allows an injection point to refer to all beans or all events of a certain bean type. +

+ +
+ @Inject
+ @Any
+ Instance<PaymentProcessor> anyPaymentProcessor;
+ 
+ +
+ @Inject
+ @Any
+ Event<User> anyUserEvent;
+ 
+ +
+ @Inject
+ @Delegate
+ @Any
+ Logger logger;
+ 
+
+
Author:
+
Gavin King, David Allen
+
+
+
+
    + +
  • +
    +

    Nested Class Summary

    +
    Nested Classes
    +
    +
    Modifier and Type
    +
    Class
    +
    Description
    +
    static final class 
    + +
    +
    Supports inline instantiation of the Any qualifier.
    +
    +
    +
    +
  • +
+
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/CreationException.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/CreationException.html new file mode 100644 index 0000000000..10848ca043 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/CreationException.html @@ -0,0 +1,231 @@ + + + + +CreationException (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Class CreationException

+
+ +
+
+
All Implemented Interfaces:
+
Serializable
+
+
+
public class CreationException +extends InjectionException
+

+ Indicates that a checked exception was thrown during creation of a bean. +

+
+
Author:
+
Pete Muir, Gavin King
+
See Also:
+
+ +
+
+
+
+ +
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      CreationException

      +
      public CreationException()
      +
      Creates the exception with no detail message or cause.
      +
      +
    • +
    • +
      +

      CreationException

      +
      public CreationException(String message)
      +
      Creates the exception with given detail message.
      +
      +
      Parameters:
      +
      message - the detail message
      +
      +
      +
    • +
    • +
      +

      CreationException

      +
      public CreationException(Throwable cause)
      +
      Creates the exception with given cause.
      +
      +
      Parameters:
      +
      cause - the cause
      +
      +
      +
    • +
    • +
      +

      CreationException

      +
      public CreationException(String message, + Throwable cause)
      +
      Creates the exception with given detail message and cause.
      +
      +
      Parameters:
      +
      message - the detail message
      +
      cause - the cause
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/Decorated.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/Decorated.html new file mode 100644 index 0000000000..57e741d713 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/Decorated.html @@ -0,0 +1,136 @@ + + + + +Decorated (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Annotation Interface Decorated

+
+
+
+
@Target({PARAMETER,FIELD}) +@Retention(RUNTIME) +@Documented +@Qualifier +public @interface Decorated
+

+ A decorator may inject metadata about the bean it is decorating +

+ +
+ @Decorator
+ class TimestampLogger implements Logger {
+     @Inject
+     @Delegate
+     @Any
+     Logger logger;
+
+     @Inject
+     @Decorated
+     Bean<Logger> bean;
+
+     void log(String message) {
+       ...
+    }
+ }
+ 
+ +

+ CDI Lite implementations are not required to provide support for decorators. +

+
+
Since:
+
1.1
+
Author:
+
Pete Muir
+
+
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/Default.Literal.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/Default.Literal.html new file mode 100644 index 0000000000..43763606aa --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/Default.Literal.html @@ -0,0 +1,222 @@ + + + + +Default.Literal (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Class Default.Literal

+
+
java.lang.Object +
jakarta.enterprise.util.AnnotationLiteral<Default> +
jakarta.enterprise.inject.Default.Literal
+
+
+
+
+
All Implemented Interfaces:
+
Annotation
+
+
+
Enclosing class:
+
Default
+
+
+
public static final class Default.Literal +extends AnnotationLiteral<Default> +implements Default
+
Supports inline instantiation of the Default qualifier.
+
+
Since:
+
2.0
+
Author:
+
Martin Kouba
+
See Also:
+
+ +
+
+
+
+ +
+
+
    + +
  • +
    +

    Field Details

    +
      +
    • +
      +

      INSTANCE

      +
      public static final Default.Literal INSTANCE
      +
      The default Default literal
      +
      +
    • +
    +
    +
  • + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      Literal

      +
      public Literal()
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/Default.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/Default.html new file mode 100644 index 0000000000..a18f3841d1 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/Default.html @@ -0,0 +1,180 @@ + + + + +Default (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Annotation Interface Default

+
+
+
+
@Target({TYPE,METHOD,PARAMETER,FIELD}) +@Retention(RUNTIME) +@Documented +@Qualifier +public @interface Default
+

+ The default qualifier type. +

+ +

+ If a bean does not explicitly declare a qualifier other than @Named, the bean has the + qualifier @Default. +

+ +

+ If an injection point declares no qualifier, the injection point has exactly one qualifier, the default qualifier + @Default. +

+ +

+ The following are equivalent: +

+ +
+ @ConversationScoped
+ public class Order {
+
+     private Product product;
+     private User customer;
+
+     @Inject
+     public void init(@Selected Product product, User customer) {
+         this.product = product;
+         this.customer = customer;
+     }
+
+ }
+ 
+ +
+ @Default
+ @ConversationScoped
+ public class Order {
+
+     private Product product;
+     private User customer;
+
+     @Inject
+     public void init(@Selected Product product, @Default User customer) {
+         this.product = product;
+         this.customer = customer;
+     }
+
+ }
+ 
+
+
Author:
+
Pete Muir, Gavin King
+
+
+
+
    + +
  • +
    +

    Nested Class Summary

    +
    Nested Classes
    +
    +
    Modifier and Type
    +
    Class
    +
    Description
    +
    static final class 
    + +
    +
    Supports inline instantiation of the Default qualifier.
    +
    +
    +
    +
  • +
+
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/Disposes.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/Disposes.html new file mode 100644 index 0000000000..791d643a6d --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/Disposes.html @@ -0,0 +1,194 @@ + + + + +Disposes (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Annotation Interface Disposes

+
+
+
+
@Target(PARAMETER) +@Retention(RUNTIME) +@Documented +public @interface Disposes
+

+ Identifies the disposed parameter of a disposer method. May be applied to a parameter of a method of a bean class. +

+ +
+ public class UserDatabaseEntityManager {
+
+     @Produces
+     @ConversationScoped
+     @UserDatabase
+     public EntityManager create(EntityManagerFactory emf) {
+         return emf.createEntityManager();
+     }
+
+     public void close(@Disposes @UserDatabase EntityManager em) {
+         em.close();
+     }
+
+ }
+ 
+ +
+ public class Resources {
+
+     @PersistenceContext
+     @Produces
+     @UserDatabase
+     private EntityManager em;
+
+     public void close(@Disposes @UserDatabase EntityManager em) {
+         em.close();
+     }
+
+ }
+ 
+ +

+ A disposer method allows the application to perform customized cleanup of an object returned by a + producer method or producer field. +

+ +

+ 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 + static method of the bean class. +

+ +

+ A bean may declare multiple disposer methods. +

+ +

+ Each disposer method must have exactly one disposed parameter, of the same type as the corresponding producer method or + producer field return type. When searching for disposer methods for a producer method or producer field, the container + considers the type and qualifiers of the disposed parameter. If a disposed parameter resolves to a producer method or + producer field declared by the same bean class, the container must call this method when destroying any instance returned by + that producer method or producer field. +

+ +

+ In addition to the disposed parameter, a disposer method may declare additional parameters, which may also specify + qualifiers. These additional parameters are injection points. +

+ +
+ public void close(@Disposes @UserDatabase EntityManager em, Logger log) { ... }
+ 
+ +

+ A disposer method may resolve to multiple producer methods or producer fields declared by the bean class, in which case the + container must call it when destroying any instance returned by any of these producer methods or producer fields. +

+ +

+ Disposer methods are not inherited by bean subclasses. +

+ +

+ Interceptors and decorators may not declare disposer methods. +

+
+
Author:
+
Gavin King, Pete Muir
+
See Also:
+
+ +
+
+
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/IllegalProductException.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/IllegalProductException.html new file mode 100644 index 0000000000..4b78a99ef6 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/IllegalProductException.html @@ -0,0 +1,230 @@ + + + + +IllegalProductException (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Class IllegalProductException

+
+ +
+
+
All Implemented Interfaces:
+
Serializable
+
+
+
public class IllegalProductException +extends InjectionException
+

+ Indicates that a producer method returned a null value or a producer field contained a null value, and the scope of the + producer method or field was not Dependent. +

+
+
See Also:
+
+ +
+
+
+
+ +
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      IllegalProductException

      +
      public IllegalProductException()
      +
      Creates the exception with no detail message or cause.
      +
      +
    • +
    • +
      +

      IllegalProductException

      +
      public IllegalProductException(String message, + Throwable cause)
      +
      Creates the exception with given detail message and cause.
      +
      +
      Parameters:
      +
      message - the detail message
      +
      cause - the cause
      +
      +
      +
    • +
    • +
      +

      IllegalProductException

      +
      public IllegalProductException(String message)
      +
      Creates the exception with given detail message.
      +
      +
      Parameters:
      +
      message - the detail message
      +
      +
      +
    • +
    • +
      +

      IllegalProductException

      +
      public IllegalProductException(Throwable cause)
      +
      Creates the exception with given cause.
      +
      +
      Parameters:
      +
      cause - the cause
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/InjectionException.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/InjectionException.html new file mode 100644 index 0000000000..2c15836f41 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/InjectionException.html @@ -0,0 +1,231 @@ + + + + +InjectionException (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Class InjectionException

+
+
java.lang.Object +
java.lang.Throwable +
java.lang.Exception +
java.lang.RuntimeException +
jakarta.enterprise.inject.InjectionException
+
+
+
+
+
+
+
All Implemented Interfaces:
+
Serializable
+
+
+
Direct Known Subclasses:
+
CreationException, IllegalProductException, ResolutionException
+
+
+
public class InjectionException +extends RuntimeException
+
Indicates a problem relating to dependency injection.
+
+
Author:
+
Pete Muir
+
See Also:
+
+ +
+
+
+
+ +
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      InjectionException

      +
      public InjectionException()
      +
      Creates the exception with no detail message or cause.
      +
      +
    • +
    • +
      +

      InjectionException

      +
      public InjectionException(String message, + Throwable cause)
      +
      Creates the exception with given detail message and cause.
      +
      +
      Parameters:
      +
      message - the detail message
      +
      cause - the cause
      +
      +
      +
    • +
    • +
      +

      InjectionException

      +
      public InjectionException(String message)
      +
      Creates the exception with given detail message.
      +
      +
      Parameters:
      +
      message - the detail message
      +
      +
      +
    • +
    • +
      +

      InjectionException

      +
      public InjectionException(Throwable cause)
      +
      Creates the exception with given cause.
      +
      +
      Parameters:
      +
      cause - the cause
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/Instance.Handle.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/Instance.Handle.html new file mode 100644 index 0000000000..d0e9533f14 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/Instance.Handle.html @@ -0,0 +1,240 @@ + + + + +Instance.Handle (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface Instance.Handle<T>

+
+
+
+
Type Parameters:
+
T - the required bean type
+
+
+
All Superinterfaces:
+
AutoCloseable
+
+
+
Enclosing interface:
+
Instance<T>
+
+
+
public static interface Instance.Handle<T> +extends AutoCloseable
+
This interface represents a contextual reference handle. +

+ Allows to inspect the metadata of the relevant bean before resolving its contextual reference and also to destroy the + underlying contextual instance. +

+
+
Author:
+
Matej Novotny
+
+
+
+
    + +
  • +
    +

    Method Summary

    +
    +
    +
    +
    +
    Modifier and Type
    +
    Method
    +
    Description
    +
    void
    + +
    +
    Delegates to destroy().
    +
    +
    void
    + +
    +
    Destroy the contextual instance.
    +
    + +
    get()
    +
    +
    The contextual reference is obtained lazily, i.e.
    +
    + + +
     
    +
    +
    +
    +
    +
  • +
+
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      get

      +
      T get()
      +
      The contextual reference is obtained lazily, i.e. when first needed.
      +
      +
      Returns:
      +
      the contextual reference
      +
      Throws:
      +
      IllegalStateException - If the producing Instance does not exist
      +
      IllegalStateException - If invoked on Instance.Handle that previously successfully destroyed its underlying + contextual reference
      +
      See Also:
      +
      +
        +
      • Provider.get()
      • +
      +
      +
      +
      +
    • +
    • +
      +

      getBean

      +
      Bean<T> getBean()
      +
      +
      Returns:
      +
      the bean metadata
      +
      +
      +
    • +
    • +
      +

      destroy

      +
      void destroy()
      +
      Destroy the contextual instance. + + It's a no-op if: +
        +
      • called multiple times
      • +
      • if the producing Instance does not exist
      • +
      • if the handle does not hold a contextual reference, i.e. get() was never called
      • +
      +
      +
      See Also:
      +
      + +
      +
      +
      +
    • +
    • +
      +

      close

      +
      void close()
      +
      Delegates to destroy().
      +
      +
      Specified by:
      +
      close in interface AutoCloseable
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/Instance.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/Instance.html new file mode 100644 index 0000000000..413d4fb468 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/Instance.html @@ -0,0 +1,535 @@ + + + + +Instance (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface Instance<T>

+
+
+
+
Type Parameters:
+
T - the required bean type
+
+
+
All Superinterfaces:
+
Iterable<T>, jakarta.inject.Provider<T>
+
+
+
All Known Subinterfaces:
+
SeContainer
+
+
+
All Known Implementing Classes:
+
CDI
+
+
+
public interface Instance<T> +extends Iterable<T>, jakarta.inject.Provider<T>
+

+ Allows the application to dynamically obtain instances of beans with a specified combination of required type and qualifiers. +

+ +

+ In certain situations, injection is not the most convenient way to obtain a contextual reference. For example, it may not be + used when: +

+ +
    +
  • the bean type or qualifiers vary dynamically at runtime, or
  • +
  • depending upon the deployment, there may be no bean which satisfies the type and qualifiers, or
  • +
  • we would like to iterate over all beans of a certain type.
  • +
+ +

+ In these situations, an instance of the Instance may be injected: +

+ +
+ @Inject
+ Instance<PaymentProcessor> paymentProcessor;
+ 
+ +

+ Any combination of qualifiers may be specified at the injection point: +

+ +
+ @Inject
+ @PayBy(CHEQUE)
+ Instance<PaymentProcessor> chequePaymentProcessor;
+ 
+ +

+ Or, the @Any qualifier may be used, allowing the application to specify qualifiers dynamically: +

+ +
+ @Inject
+ @Any
+ Instance<PaymentProcessor> anyPaymentProcessor;
+ 
+ +

+ For an injected Instance: +

+ +
    +
  • the required type is the type parameter specified at the injection point, and
  • +
  • the required qualifiers are the qualifiers specified at the injection point.
  • +
+ +

+ The inherited Provider.get() method returns a contextual references for the unique bean that matches + the required type and required qualifiers and is eligible for injection into the class into which the parent + Instance was injected, or throws an UnsatisfiedResolutionException or + AmbiguousResolutionException. +

+ +
+ PaymentProcessor pp = chequePaymentProcessor.get();
+ 
+ +

+ The inherited Iterable.iterator() method returns an iterator over contextual references for beans that + match the required type and required qualifiers and are eligible for injection into the class into which the parent + Instance was injected. +

+ +
+ for (PaymentProcessor pp : anyPaymentProcessor)
+     pp.test();
+ 
+
+
Author:
+
Gavin King, John Ament, Martin Kouba
+
See Also:
+
+ +
+
+
+
+
    + +
  • +
    +

    Nested Class Summary

    +
    Nested Classes
    +
    +
    Modifier and Type
    +
    Interface
    +
    Description
    +
    static interface 
    + +
    +
    This interface represents a contextual reference handle.
    +
    +
    +
    +
  • + +
  • +
    +

    Method Summary

    +
    +
    +
    +
    +
    Modifier and Type
    +
    Method
    +
    Description
    +
    void
    +
    destroy(T instance)
    +
    +
    + When called, the container destroys the instance if the active context object for the scope type of the bean supports + destroying bean instances.
    +
    + + +
    +
    Obtains an initialized contextual reference handle for a bean that has the required type and qualifiers and is eligible + for injection.
    +
    + + +
    +
    Allows iterating over contextual reference handles for all beans that have the required type and required qualifiers and + are eligible for injection.
    +
    +
    default Stream<? extends Instance.Handle<T>>
    + +
    +
    Returns stream of Instance.Handle objects.
    +
    +
    boolean
    + +
    +
    + Determines if there is more than one bean that matches the required type and qualifiers and is eligible for injection + into the class into which the parent Instance was injected.
    +
    +
    default boolean
    + +
    +
    + Determines if there is exactly one bean that matches the required type and qualifiers and is eligible for injection into + the class into which the parent Instance was injected.
    +
    +
    boolean
    + +
    +
    + Determines if there is no bean that matches the required type and qualifiers and is eligible for injection into the class + into which the parent Instance was injected.
    +
    +
    <U extends T>
    Instance<U>
    +
    select(TypeLiteral<U> subtype, + Annotation... qualifiers)
    +
    +
    + Obtains a child Instance for the given required type and additional required qualifiers.
    +
    + +
    select(Annotation... qualifiers)
    +
    +
    + Obtains a child Instance for the given additional required qualifiers.
    +
    +
    <U extends T>
    Instance<U>
    +
    select(Class<U> subtype, + Annotation... qualifiers)
    +
    +
    + Obtains a child Instance for the given required type and additional required qualifiers.
    +
    +
    default Stream<T>
    + +
    +
    + When called, provides back a Stream of the beans available in this Instance.
    +
    +
    +
    +
    +
    +

    Methods inherited from interface java.lang.Iterable

    +forEach, iterator, spliterator
    +
    +

    Methods inherited from interface jakarta.inject.Provider

    +get
    +
    +
  • +
+
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      select

      +
      Instance<T> select(Annotation... qualifiers)
      +

      + Obtains a child Instance for the given additional required qualifiers. +

      +
      +
      Parameters:
      +
      qualifiers - the additional required qualifiers
      +
      Returns:
      +
      the child Instance
      +
      Throws:
      +
      IllegalArgumentException - if passed two instances of the same non repeating qualifier type, or an instance of an + annotation that is not a qualifier type
      +
      IllegalStateException - if the container is already shutdown
      +
      +
      +
    • +
    • +
      +

      select

      +
      <U extends T> Instance<U> select(Class<U> subtype, + Annotation... qualifiers)
      +

      + Obtains a child Instance for the given required type and additional required qualifiers. +

      +
      +
      Type Parameters:
      +
      U - the required type
      +
      Parameters:
      +
      subtype - a Class representing the required type
      +
      qualifiers - the additional required qualifiers
      +
      Returns:
      +
      the child Instance
      +
      Throws:
      +
      IllegalArgumentException - if passed two instances of the same non repeating qualifier type, or an instance of an + annotation that is not a qualifier type
      +
      IllegalStateException - if the container is already shutdown
      +
      +
      +
    • +
    • +
      +

      select

      +
      <U extends T> Instance<U> select(TypeLiteral<U> subtype, + Annotation... qualifiers)
      +

      + Obtains a child Instance for the given required type and additional required qualifiers. +

      +
      +
      Type Parameters:
      +
      U - the required type
      +
      Parameters:
      +
      subtype - a TypeLiteral representing the required type
      +
      qualifiers - the additional required qualifiers
      +
      Returns:
      +
      the child Instance
      +
      Throws:
      +
      IllegalArgumentException - if passed two instances of the same non repeating qualifier type, or an instance of an + annotation that is not a qualifier type
      +
      IllegalStateException - if the container is already shutdown
      +
      +
      +
    • +
    • +
      +

      stream

      +
      default Stream<T> stream()
      +

      + When called, provides back a Stream of the beans available in this Instance. If no beans are found, it returns an empty + stream. +

      +
      +
      Returns:
      +
      a Stream representing the beans associated with this Instance object
      +
      Since:
      +
      2.0
      +
      +
      +
    • +
    • +
      +

      isUnsatisfied

      +
      boolean isUnsatisfied()
      +

      + Determines if there is no bean that matches the required type and qualifiers and is eligible for injection into the class + into which the parent Instance was injected. +

      +
      +
      Returns:
      +
      true if there is no bean that matches the required type and qualifiers and is eligible for injection + into the class into which the parent Instance was injected, or false otherwise.
      +
      +
      +
    • +
    • +
      +

      isAmbiguous

      +
      boolean isAmbiguous()
      +

      + Determines if there is more than one bean that matches the required type and qualifiers and is eligible for injection + into the class into which the parent Instance was injected. +

      +
      +
      Returns:
      +
      true if there is more than one bean that matches the required type and qualifiers and is eligible + for injection into the class into which the parent Instance was injected, or false + otherwise.
      +
      +
      +
    • +
    • +
      +

      isResolvable

      +
      default boolean isResolvable()
      +

      + Determines if there is exactly one bean that matches the required type and qualifiers and is eligible for injection into + the class into which the parent Instance was injected. +

      +
      +
      Returns:
      +
      true if there is exactly one bean that matches the required type and qualifiers and is eligible for + injection into the class into which the parent Instance was injected, or false + otherwise.
      +
      Since:
      +
      2.0
      +
      +
      +
    • +
    • +
      +

      destroy

      +
      void destroy(T instance)
      +

      + When called, the container destroys the instance if the active context object for the scope type of the bean supports + destroying bean instances. All normal scoped built-in contexts support destroying bean instances. +

      + +

      + The instance passed should either be a dependent scoped bean instance obtained from the same Instance object, or + the client proxy for a normal scoped bean instance. +

      +
      +
      Parameters:
      +
      instance - the instance to destroy
      +
      Throws:
      +
      UnsupportedOperationException - if the active context object for the scope type of the bean does not support + destroying bean instances
      +
      Since:
      +
      1.1
      +
      +
      +
    • +
    • +
      +

      getHandle

      +
      Instance.Handle<T> getHandle()
      +
      Obtains an initialized contextual reference handle for a bean that has the required type and qualifiers and is eligible + for injection. Throws exceptions if there is no such bean or more than one. + +

      + The contextual reference is obtained lazily, i.e. when first needed. +

      +
      +
      Returns:
      +
      a new Instance.Handle instnace
      +
      Throws:
      +
      UnsatisfiedResolutionException - if there is no bean with given type and qualifiers
      +
      AmbiguousResolutionException - if there is more than one bean given type and qualifiers
      +
      +
      +
    • +
    • +
      +

      handles

      +
      Iterable<? extends Instance.Handle<T>> handles()
      +
      Allows iterating over contextual reference handles for all beans that have the required type and required qualifiers and + are eligible for injection. + +

      + Note that the returned Iterable is stateless. Therefore, each Iterable.iterator() produces a new set of + handles. +

      +
      +
      Returns:
      +
      a new iterable
      +
      +
      +
    • +
    • +
      +

      handlesStream

      +
      default Stream<? extends Instance.Handle<T>> handlesStream()
      +
      Returns stream of Instance.Handle objects.
      +
      +
      Returns:
      +
      a new stream of contextual reference handles
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/Intercepted.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/Intercepted.html new file mode 100644 index 0000000000..1b9ba6d23e --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/Intercepted.html @@ -0,0 +1,126 @@ + + + + +Intercepted (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Annotation Interface Intercepted

+
+
+
+
@Target({PARAMETER,FIELD}) +@Retention(RUNTIME) +@Documented +@Qualifier +public @interface Intercepted
+

+ An interceptor may inject metadata about the bean it is intercepting. +

+ +
+ @Transactional @Interceptor
+ public class TransactionInterceptor {
+
+    @Inject @Intercepted Bean<?> bean;
+
+    @AroundInvoke
+    public Object manageTransaction(InvocationContext ctx) throws Exception { ... }
+
+ }
+ 
+
+
Since:
+
1.1
+
Author:
+
Pete Muir
+
+
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/Model.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/Model.html new file mode 100644 index 0000000000..e2770941ad --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/Model.html @@ -0,0 +1,121 @@ + + + + +Model (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Annotation Interface Model

+
+
+
+ +

+ The built-in stereotype intended for use with beans that define the model layer of an MVC web application architecture such + as JSF. +

+
+
Author:
+
Gavin King
+
See Also:
+
+ +
+
+
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/Produces.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/Produces.html new file mode 100644 index 0000000000..40f029d085 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/Produces.html @@ -0,0 +1,194 @@ + + + + +Produces (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Annotation Interface Produces

+
+
+
+
@Target({METHOD,FIELD}) +@Retention(RUNTIME) +@Documented +public @interface Produces
+

+ Identifies a producer method or field. May be applied to a method or field of a bean class. +

+ +

+ 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 + or a static method of the bean class. +

+ +
+ public class Shop {
+    @Produces @ApplicationScoped
+    @Catalog @Named("catalog")
+    List<Product> getProducts() { ... }
+    ...
+ }
+ 
+ +

+ A producer field must be a field of a managed bean class or session bean class. A producer field may be either static or + non-static. If the bean is a session bean, the producer field must be a static field of the bean class. +

+ +
+ public class Shop {
+    @Produces @ApplicationScoped
+    @Catalog @Named("catalog")
+    List<Product> products = ...;
+    ...
+ }
+ 
+ +

+ If a producer method sometimes returns a null value, or if a producer field sometimes contains a null value when accessed, + then the producer method or field must have scope @Dependent. +

+ +

+ A producer method return type or producer field type may not be a type variable. +

+ +

+ If the producer method return type or producer field type is a parameterized type, it must specify an actual type parameter + or type variable for each type parameter. +

+ +

+ If the producer method return type or producer field type is a parameterized type with a type variable, it must have scope + @Dependent. +

+ +

+ A producer method may have any number of parameters. All producer method parameters are injection points. +

+ +
+ public class OrderFactory {
+
+     @Produces
+     @ConversationScoped
+     public Order createCurrentOrder(Shop shop, @Selected Product product) {
+         Order order = new Order(product, shop);
+         return order;
+     }
+
+ }
+ 
+ +

+ A bean may declare multiple producer methods or fields. +

+ +

+ Producer methods and fields are not inherited by bean subclasses. +

+ +

+ Interceptors and decorators may not declare producer methods or fields. +

+
+
Author:
+
Gavin King, Pete Muir
+
See Also:
+
+ +
+
+
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/ResolutionException.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/ResolutionException.html new file mode 100644 index 0000000000..d7781a0add --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/ResolutionException.html @@ -0,0 +1,233 @@ + + + + +ResolutionException (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Class ResolutionException

+
+ +
+
+
All Implemented Interfaces:
+
Serializable
+
+
+
Direct Known Subclasses:
+
AmbiguousResolutionException, UnproxyableResolutionException, UnsatisfiedResolutionException
+
+
+
public class ResolutionException +extends InjectionException
+
Indicates a problem relating to typesafe resolution.
+
+
Author:
+
Gavin King
+
See Also:
+
+ +
+
+
+
+ +
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      ResolutionException

      +
      public ResolutionException()
      +
      Creates the exception with no detail message or cause.
      +
      +
    • +
    • +
      +

      ResolutionException

      +
      public ResolutionException(String message, + Throwable cause)
      +
      Creates the exception with given detail message and cause.
      +
      +
      Parameters:
      +
      message - the detail message
      +
      cause - the cause
      +
      +
      +
    • +
    • +
      +

      ResolutionException

      +
      public ResolutionException(String message)
      +
      Creates the exception with given detail message.
      +
      +
      Parameters:
      +
      message - the detail message
      +
      +
      +
    • +
    • +
      +

      ResolutionException

      +
      public ResolutionException(Throwable cause)
      +
      Creates the exception with given cause.
      +
      +
      Parameters:
      +
      cause - the cause
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/Specializes.Literal.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/Specializes.Literal.html new file mode 100644 index 0000000000..1b399d548f --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/Specializes.Literal.html @@ -0,0 +1,222 @@ + + + + +Specializes.Literal (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Class Specializes.Literal

+
+
java.lang.Object +
jakarta.enterprise.util.AnnotationLiteral<Specializes> +
jakarta.enterprise.inject.Specializes.Literal
+
+
+
+
+
All Implemented Interfaces:
+
Annotation
+
+
+
Enclosing class:
+
Specializes
+
+
+
public static final class Specializes.Literal +extends AnnotationLiteral<Specializes> +implements Specializes
+
Supports inline instantiation of the Specializes annotation.
+
+
Since:
+
2.0
+
Author:
+
Martin Kouba
+
See Also:
+
+ +
+
+
+
+ +
+
+
    + +
  • +
    +

    Field Details

    +
      +
    • +
      +

      INSTANCE

      +
      public static final Specializes.Literal INSTANCE
      +
      Default Specializes literal
      +
      +
    • +
    +
    +
  • + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      Literal

      +
      public Literal()
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/Specializes.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/Specializes.html new file mode 100644 index 0000000000..75334848ba --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/Specializes.html @@ -0,0 +1,165 @@ + + + + +Specializes (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Annotation Interface Specializes

+
+
+
+
@Target({TYPE,METHOD}) +@Retention(RUNTIME) +@Documented +public @interface Specializes
+

+ Indicates that a bean directly specializes another bean. May be applied to a bean class or producer method. +

+ +

+ If a bean directly specializes a second bean, it inherits: +

+ +
    +
  • all qualifiers of the second bean, and
  • +
  • the name, if any, of the second bean.
  • +
+ +

+ If the second bean has a name, the bean may not declare a name using @Named. Furthermore, + the bean must have all the bean types of the second bean. +

+ +
    +
  • If a bean class of a managed bean is annotated @Specializes , then the bean class must directly extend + the bean class of a second managed bean. Then the first managed bean directly specializes the second managed bean.
  • + +
  • If a bean class of a session bean is annotated @Specializes , then the bean class must directly extend + the bean class of a second session bean. Then the first session bean directly specializes the second session bean.
  • + +
  • If a producer method is annotated @Specializes, then it must be non-static and directly override + another producer method. Then the first producer method directly specializes the second producer method.
  • +
+ +

+ If a bean is specialized by any enabled bean, the first bean is disabled. +

+ +

+ CDI Lite implementations are not required to provide support for specialization. +

+
+
Author:
+
Gavin King, Pete Muir
+
+
+
+
    + +
  • +
    +

    Nested Class Summary

    +
    Nested Classes
    +
    +
    Modifier and Type
    +
    Class
    +
    Description
    +
    static final class 
    + +
    +
    Supports inline instantiation of the Specializes annotation.
    +
    +
    +
    +
  • +
+
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/Stereotype.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/Stereotype.html new file mode 100644 index 0000000000..3776c9b227 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/Stereotype.html @@ -0,0 +1,228 @@ + + + + +Stereotype (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Annotation Interface Stereotype

+
+
+
+
@Retention(RUNTIME) +@Target(ANNOTATION_TYPE) +@Documented +public @interface Stereotype
+

+ Specifies that an annotation type is a stereotype. +

+ +

+ In many systems, use of architectural patterns produces a set of recurring bean roles. A stereotype allows a framework + developer to identify such a role and declare some common metadata for beans with that role in a central place. +

+ +

+ A bean may declare zero, one or multiple stereotypes, by applying the stereotype annotation to the bean class or producer + method or field. +

+ +

+ A stereotype encapsulates any combination of: +

+ +
    +
  • a default scope, and
  • +
  • a set of interceptor bindings.
  • +
+ +

+ The default scope of a stereotype is defined by annotating the stereotype with a scope type. A stereotype may declare at most + one scope. If a bean explicitly declares a scope, any default scopes declared by its stereotypes are ignored. +

+ +
+ @RequestScoped
+ @Stereotype
+ @Target(TYPE)
+ @Retention(RUNTIME)
+ public @interface Action {
+ }
+ 
+ +

+ The interceptor bindings of a stereotype are defined by annotating the stereotype with the interceptor binding types. A + stereotype may declare zero, one or multiple interceptor bindings. An interceptor binding declared by a stereotype is + inherited by any bean that declares that stereotype. +

+ +
+ @RequestScoped
+ @Secure
+ @Transactional
+ @Stereotype
+ @Target(TYPE)
+ @Retention(RUNTIME)
+ public @interface Action {
+ }
+ 
+ +

+ A stereotype may also specify that: +

+ +
    +
  • all beans with the stereotype have defaulted bean EL names, or that
  • +
  • all beans with the stereotype are alternatives, or that
  • +
  • all beans with the stereotype have predefined @Priority.
  • +
+ +

+ A stereotype may declare an empty @Named annotation, which specifies that every bean with + the stereotype has a defaulted name when a name is not explicitly specified by the bean. +

+ +
+ @RequestScoped
+ @Named
+ @Secure
+ @Transactional
+ @Stereotype
+ @Target(TYPE)
+ @Retention(RUNTIME)
+ public @interface Action {
+ }
+ 
+ +

+ A stereotype may declare an @Alternative annotation, which specifies that every bean with the + stereotype is an alternative. +

+ +
+ @Alternative
+ @Stereotype
+ @Target(TYPE)
+ @Retention(RUNTIME)
+ public @interface Mock {
+ }
+ 
+ +

+ A stereotype may declare a @Priority annotation, which specifies that every bean + with the stereotype is enabled and has given priority. +

+ +
+ @Alternative
+ @Priority(1)
+ @Stereotype
+ @Target(TYPE)
+ @Retention(RUNTIME)
+ public @interface Mock {
+ }
+ 
+ +

+ A stereotype may declare other stereotypes. Stereotype declarations are transitive. A stereotype declared by a second + stereotype is inherited by all beans and other stereotypes that declare the second stereotype. +

+
+
Author:
+
Pete Muir, Gavin King
+
See Also:
+
+ +
+
+
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/TransientReference.Literal.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/TransientReference.Literal.html new file mode 100644 index 0000000000..273d48e0ff --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/TransientReference.Literal.html @@ -0,0 +1,222 @@ + + + + +TransientReference.Literal (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Class TransientReference.Literal

+
+
java.lang.Object +
jakarta.enterprise.util.AnnotationLiteral<TransientReference> +
jakarta.enterprise.inject.TransientReference.Literal
+
+
+
+
+
All Implemented Interfaces:
+
Annotation
+
+
+
Enclosing class:
+
TransientReference
+
+
+
public static final class TransientReference.Literal +extends AnnotationLiteral<TransientReference> +implements TransientReference
+
Supports inline instantiation of the TransientReference annotation.
+
+
Since:
+
2.0
+
Author:
+
Martin Kouba
+
See Also:
+
+ +
+
+
+
+ +
+
+
    + +
  • +
    +

    Field Details

    + +
    +
  • + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      Literal

      +
      public Literal()
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/TransientReference.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/TransientReference.html new file mode 100644 index 0000000000..2b7d116b0f --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/TransientReference.html @@ -0,0 +1,147 @@ + + + + +TransientReference (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Annotation Interface TransientReference

+
+
+
+
@Target(PARAMETER) +@Retention(RUNTIME) +@Documented +public @interface TransientReference
+

+ If a parameter annotated with @TransientReference resolves to a dependent scoped bean, then the bean will + be + destroyed after the invocation completes. +

+ +
+ public class OrderManager {
+
+     @Inject
+     public OrderManager(@TransientReference Order order) {
+        ...
+
+     }
+ }
+ 
+
+
Since:
+
1.1
+
Author:
+
Pete Muir
+
+
+
+ +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/Typed.Literal.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/Typed.Literal.html new file mode 100644 index 0000000000..9eab53d07a --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/Typed.Literal.html @@ -0,0 +1,242 @@ + + + + +Typed.Literal (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Class Typed.Literal

+
+
java.lang.Object +
jakarta.enterprise.util.AnnotationLiteral<Typed> +
jakarta.enterprise.inject.Typed.Literal
+
+
+
+
+
All Implemented Interfaces:
+
Annotation
+
+
+
Enclosing class:
+
Typed
+
+
+
public static final class Typed.Literal +extends AnnotationLiteral<Typed> +implements Typed
+
Supports inline instantiation of the Typed annotation.
+
+
Since:
+
2.0
+
Author:
+
Martin Kouba
+
See Also:
+
+ +
+
+
+
+ +
+
+
    + +
  • +
    +

    Field Details

    +
      +
    • +
      +

      INSTANCE

      +
      public static final Typed.Literal INSTANCE
      +
      Default Typed literal
      +
      +
    • +
    +
    +
  • + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      of

      +
      public static Typed.Literal of(Class<?>[] value)
      +
      Obtain the Typed literal for the provided bean types
      +
      +
      Parameters:
      +
      value - the classes corresponding to the bean types of the bean
      +
      Returns:
      +
      a new Literal value for the provided classes
      +
      +
      +
    • +
    • +
      +

      value

      +
      public Class<?>[] value()
      +
      +
      Returns:
      +
      the classes corresponding to the bean types of the bean
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/Typed.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/Typed.html new file mode 100644 index 0000000000..695672b2d6 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/Typed.html @@ -0,0 +1,193 @@ + + + + +Typed (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Annotation Interface Typed

+
+
+
+
@Target({FIELD,METHOD,TYPE}) +@Retention(RUNTIME) +@Documented +public @interface Typed
+

+ Restricts the bean types of a bean. May be applied to a bean class or producer method or field. +

+ +
+ @Typed(Shop.class)
+ public class BookShop
+       extends Business
+       implements Shop<Book> {
+    ...
+ }
+ 
+ +

+ When a @Typed annotation is specified, only the types whose classes are explicitly listed using the + value member, along with Object, are bean types of the bean. +

+
+
Author:
+
Pete Muir, Gavin King
+
+
+
+
    + +
  • +
    +

    Nested Class Summary

    +
    Nested Classes
    +
    +
    Modifier and Type
    +
    Class
    +
    Description
    +
    static final class 
    + +
    +
    Supports inline instantiation of the Typed annotation.
    +
    +
    +
    +
  • + +
  • +
    +

    Optional Element Summary

    +
    Optional Elements
    +
    +
    Modifier and Type
    +
    Optional Element
    +
    Description
    +
    Class<?>[]
    + +
    +
    + Selects the bean types of the bean.
    +
    +
    +
    +
  • +
+
+
+
    + +
  • +
    +

    Element Details

    +
      +
    • +
      +

      value

      +
      Class<?>[] value
      +

      + Selects the bean types of the bean. Every class must correspond to a type in the unrestricted set of bean types + of a bean. +

      +
      +
      Returns:
      +
      the classes corresponding to the bean types of the bean
      +
      +
      +
      Default:
      +
      {}
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/UnproxyableResolutionException.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/UnproxyableResolutionException.html new file mode 100644 index 0000000000..6ebc81075e --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/UnproxyableResolutionException.html @@ -0,0 +1,234 @@ + + + + +UnproxyableResolutionException (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Class UnproxyableResolutionException

+
+ +
+
+
All Implemented Interfaces:
+
Serializable
+
+
+
public class UnproxyableResolutionException +extends ResolutionException
+

+ Indicates that a contextual reference for a bean with a normal scope and a certain bean type cannot be obtained because the + bean type cannot be proxied by the container. +

+
+
Author:
+
Pete Muir, Gavin King
+
See Also:
+
+ +
+
+
+
+ +
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      UnproxyableResolutionException

      +
      public UnproxyableResolutionException()
      +
      Creates the exception with no detail message or cause.
      +
      +
    • +
    • +
      +

      UnproxyableResolutionException

      +
      public UnproxyableResolutionException(String message, + Throwable cause)
      +
      Creates the exception with given detail message and cause.
      +
      +
      Parameters:
      +
      message - the detail message
      +
      cause - the cause
      +
      +
      +
    • +
    • +
      +

      UnproxyableResolutionException

      +
      public UnproxyableResolutionException(String message)
      +
      Creates the exception with given detail message.
      +
      +
      Parameters:
      +
      message - the detail message
      +
      +
      +
    • +
    • +
      +

      UnproxyableResolutionException

      +
      public UnproxyableResolutionException(Throwable cause)
      +
      Creates the exception with given cause.
      +
      +
      Parameters:
      +
      cause - the cause
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/UnsatisfiedResolutionException.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/UnsatisfiedResolutionException.html new file mode 100644 index 0000000000..f006eb0881 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/UnsatisfiedResolutionException.html @@ -0,0 +1,234 @@ + + + + +UnsatisfiedResolutionException (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Class UnsatisfiedResolutionException

+
+ +
+
+
All Implemented Interfaces:
+
Serializable
+
+
+
public class UnsatisfiedResolutionException +extends ResolutionException
+

+ Indicates that no bean matches a certain combination of required type and required qualifiers and is eligible for injection + into a certain class. +

+
+
Author:
+
Pete Muir, Gavin King
+
See Also:
+
+ +
+
+
+
+ +
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      UnsatisfiedResolutionException

      +
      public UnsatisfiedResolutionException()
      +
      Creates the exception with no detail message or cause.
      +
      +
    • +
    • +
      +

      UnsatisfiedResolutionException

      +
      public UnsatisfiedResolutionException(String message, + Throwable cause)
      +
      Creates the exception with given detail message and cause.
      +
      +
      Parameters:
      +
      message - the detail message
      +
      cause - the cause
      +
      +
      +
    • +
    • +
      +

      UnsatisfiedResolutionException

      +
      public UnsatisfiedResolutionException(String message)
      +
      Creates the exception with given detail message.
      +
      +
      Parameters:
      +
      message - the detail message
      +
      +
      +
    • +
    • +
      +

      UnsatisfiedResolutionException

      +
      public UnsatisfiedResolutionException(Throwable cause)
      +
      Creates the exception with given cause.
      +
      +
      Parameters:
      +
      cause - the cause
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/Vetoed.Literal.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/Vetoed.Literal.html new file mode 100644 index 0000000000..daff93ef7d --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/Vetoed.Literal.html @@ -0,0 +1,222 @@ + + + + +Vetoed.Literal (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Class Vetoed.Literal

+
+
java.lang.Object +
jakarta.enterprise.util.AnnotationLiteral<Vetoed> +
jakarta.enterprise.inject.Vetoed.Literal
+
+
+
+
+
All Implemented Interfaces:
+
Annotation
+
+
+
Enclosing class:
+
Vetoed
+
+
+
public static final class Vetoed.Literal +extends AnnotationLiteral<Vetoed> +implements Vetoed
+
Supports inline instantiation of the Vetoed annotation.
+
+
Since:
+
2.0
+
Author:
+
Martin Kouba
+
See Also:
+
+ +
+
+
+
+ +
+
+
    + +
  • +
    +

    Field Details

    +
      +
    • +
      +

      INSTANCE

      +
      public static final Vetoed.Literal INSTANCE
      +
      Default Vetoed literal
      +
      +
    • +
    +
    +
  • + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      Literal

      +
      public Literal()
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/Vetoed.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/Vetoed.html new file mode 100644 index 0000000000..6de0d7f01b --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/Vetoed.html @@ -0,0 +1,149 @@ + + + + +Vetoed (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Annotation Interface Vetoed

+
+
+
+
@Target({TYPE,PACKAGE}) +@Retention(RUNTIME) +@Documented +public @interface Vetoed
+

+ Veto the processing of the class. Any beans or observer methods defined by this class will not be installed. +

+ +

+ When placed on package, all beans in the package are prevented from being installed. If packages are split across jars, + non-portable behavior results. An application can prevent packages being split across jars by sealing the package. +

+ +

+ No container lifecycle events are fired for classes annotated Vetoed. +

+
+
Since:
+
1.1
+
Author:
+
Stuart Douglas
+
See Also:
+
+ +
+
+
+
+
    + +
  • +
    +

    Nested Class Summary

    +
    Nested Classes
    +
    +
    Modifier and Type
    +
    Class
    +
    Description
    +
    static final class 
    + +
    +
    Supports inline instantiation of the Vetoed annotation.
    +
    +
    +
    +
  • +
+
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/AnnotationBuilder.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/AnnotationBuilder.html new file mode 100644 index 0000000000..3c45fff193 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/AnnotationBuilder.html @@ -0,0 +1,1649 @@ + + + + +AnnotationBuilder (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface AnnotationBuilder

+
+
+
+
public interface AnnotationBuilder
+
Builder for annotations of given type. + Expected usage is: +
    +
  1. create the builder using of(Class) or of(ClassInfo);
  2. +
  3. use the value() and member() methods to define annotation members;
  4. +
  5. call build() to create an AnnotationInfo.
  6. +
+ One builder instance should not be used to create multiple annotations. +

+ Note that values of all members of given annotation type must be defined before + calling build(), except of annotation members that declare a default value. + If a value is not defined for an annotation member that does not have a default value, + build() will throw an exception. +

+ Defining values of members that do not exist on given annotation type is possible, + and such members will be retained in the resulting AnnotationInfo. However, + if that AnnotationInfo is later transformed to an instance of the annotation + type, the non-existing members will disappear.

+
+
Since:
+
4.0
+
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      of

      +
      static AnnotationBuilder of(Class<? extends Annotation> annotationType)
      +
      Returns a new AnnotationBuilder that builds an annotation of given type.
      +
      +
      Parameters:
      +
      annotationType - the annotation type, must not be null
      +
      Returns:
      +
      a new AnnotationBuilder, never null
      +
      +
      +
    • +
    • +
      +

      of

      +
      static AnnotationBuilder of(ClassInfo annotationType)
      +
      Returns a new AnnotationBuilder that builds an annotation of given type.
      +
      +
      Parameters:
      +
      annotationType - the annotation type, must not be null
      +
      Returns:
      +
      a new AnnotationBuilder
      +
      +
      +
    • +
    • +
      +

      value

      +
      default AnnotationBuilder value(AnnotationMember value)
      +
      Adds an annotation member called value, whose value is given value.
      +
      +
      Parameters:
      +
      value - value of the annotation member
      +
      Returns:
      +
      this AnnotationBuilder
      +
      +
      +
    • +
    • +
      +

      value

      +
      default AnnotationBuilder value(boolean value)
      +
      Adds a boolean-valued annotation member called value.
      +
      +
      Parameters:
      +
      value - the boolean value
      +
      Returns:
      +
      this AnnotationBuilder
      +
      +
      +
    • +
    • +
      +

      value

      +
      default AnnotationBuilder value(boolean[] values)
      +
      Adds a boolean array-valued annotation member called value.
      +
      +
      Parameters:
      +
      values - the boolean array, must not be null
      +
      Returns:
      +
      this AnnotationBuilder
      +
      +
      +
    • +
    • +
      +

      value

      +
      default AnnotationBuilder value(byte value)
      +
      Adds a byte-valued annotation member called value.
      +
      +
      Parameters:
      +
      value - the byte value
      +
      Returns:
      +
      this AnnotationBuilder
      +
      +
      +
    • +
    • +
      +

      value

      +
      default AnnotationBuilder value(byte[] values)
      +
      Adds a byte array-valued annotation member called value.
      +
      +
      Parameters:
      +
      values - the byte array, must not be null
      +
      Returns:
      +
      this AnnotationBuilder
      +
      +
      +
    • +
    • +
      +

      value

      +
      default AnnotationBuilder value(short value)
      +
      Adds a short-valued annotation member called value.
      +
      +
      Parameters:
      +
      value - the short value
      +
      Returns:
      +
      this AnnotationBuilder
      +
      +
      +
    • +
    • +
      +

      value

      +
      default AnnotationBuilder value(short[] values)
      +
      Adds a short array-valued annotation member called value.
      +
      +
      Parameters:
      +
      values - the short array, must not be null
      +
      Returns:
      +
      this AnnotationBuilder
      +
      +
      +
    • +
    • +
      +

      value

      +
      default AnnotationBuilder value(int value)
      +
      Adds an int-valued annotation member called value.
      +
      +
      Parameters:
      +
      value - the int value
      +
      Returns:
      +
      this AnnotationBuilder
      +
      +
      +
    • +
    • +
      +

      value

      +
      default AnnotationBuilder value(int[] values)
      +
      Adds an int array-valued annotation member called value.
      +
      +
      Parameters:
      +
      values - the int array, must not be null
      +
      Returns:
      +
      this AnnotationBuilder
      +
      +
      +
    • +
    • +
      +

      value

      +
      default AnnotationBuilder value(long value)
      +
      Adds a long-valued annotation member called value.
      +
      +
      Parameters:
      +
      value - the long value
      +
      Returns:
      +
      this AnnotationBuilder
      +
      +
      +
    • +
    • +
      +

      value

      +
      default AnnotationBuilder value(long[] values)
      +
      Adds a long array-valued annotation member called value.
      +
      +
      Parameters:
      +
      values - the long array, must not be null
      +
      Returns:
      +
      this AnnotationBuilder
      +
      +
      +
    • +
    • +
      +

      value

      +
      default AnnotationBuilder value(float value)
      +
      Adds a float-valued annotation member called value.
      +
      +
      Parameters:
      +
      value - the float value
      +
      Returns:
      +
      this AnnotationBuilder
      +
      +
      +
    • +
    • +
      +

      value

      +
      default AnnotationBuilder value(float[] values)
      +
      Adds a float array-valued annotation member called value.
      +
      +
      Parameters:
      +
      values - the float array, must not be null
      +
      Returns:
      +
      this AnnotationBuilder
      +
      +
      +
    • +
    • +
      +

      value

      +
      default AnnotationBuilder value(double value)
      +
      Adds a double-valued annotation member called value.
      +
      +
      Parameters:
      +
      value - the double value
      +
      Returns:
      +
      this AnnotationBuilder
      +
      +
      +
    • +
    • +
      +

      value

      +
      default AnnotationBuilder value(double[] values)
      +
      Adds a double array-valued annotation member called value.
      +
      +
      Parameters:
      +
      values - the double array, must not be null
      +
      Returns:
      +
      this AnnotationBuilder
      +
      +
      +
    • +
    • +
      +

      value

      +
      default AnnotationBuilder value(char value)
      +
      Adds a char-valued annotation member called value.
      +
      +
      Parameters:
      +
      value - the char value
      +
      Returns:
      +
      this AnnotationBuilder
      +
      +
      +
    • +
    • +
      +

      value

      +
      default AnnotationBuilder value(char[] values)
      +
      Adds a char array-valued annotation member called value.
      +
      +
      Parameters:
      +
      values - the char array, must not be null
      +
      Returns:
      +
      this AnnotationBuilder
      +
      +
      +
    • +
    • +
      +

      value

      +
      default AnnotationBuilder value(String value)
      +
      Adds a String-valued annotation member called value.
      +
      +
      Parameters:
      +
      value - the String value, must not be null
      +
      Returns:
      +
      this AnnotationBuilder
      +
      +
      +
    • +
    • +
      +

      value

      +
      default AnnotationBuilder value(String[] values)
      +
      Adds a String array-valued annotation member called value.
      +
      +
      Parameters:
      +
      values - the String array, must not be null or contain null
      +
      Returns:
      +
      this AnnotationBuilder
      +
      +
      +
    • +
    • +
      +

      value

      +
      default AnnotationBuilder value(Enum<?> value)
      +
      Adds an enum-valued annotation member called value.
      +
      +
      Parameters:
      +
      value - the enum value, must not be null
      +
      Returns:
      +
      this AnnotationBuilder
      +
      +
      +
    • +
    • +
      +

      value

      +
      default AnnotationBuilder value(Enum<?>[] values)
      +
      Adds an enum array-valued annotation member called value.
      +
      +
      Parameters:
      +
      values - the enum array, must not be null or contain null
      +
      Returns:
      +
      this AnnotationBuilder
      +
      +
      +
    • +
    • +
      +

      value

      +
      default AnnotationBuilder value(Class<? extends Enum<?>> enumType, + String enumValue)
      +
      Adds an enum-valued annotation member called value.
      +
      +
      Parameters:
      +
      enumType - the enum type, must not be null
      +
      enumValue - name of the enum constant, must not be null
      +
      Returns:
      +
      this AnnotationBuilder
      +
      +
      +
    • +
    • +
      +

      value

      +
      default AnnotationBuilder value(Class<? extends Enum<?>> enumType, + String[] enumValues)
      +
      Adds an enum array-valued annotation member called value.
      +
      +
      Parameters:
      +
      enumType - the enum type, must not be null
      +
      enumValues - names of the enum constants, must not be null or contain null
      +
      Returns:
      +
      this AnnotationBuilder
      +
      +
      +
    • +
    • +
      +

      value

      +
      default AnnotationBuilder value(ClassInfo enumType, + String enumValue)
      +
      Adds an enum-valued annotation member called value.
      +
      +
      Parameters:
      +
      enumType - the enum type, must not be null
      +
      enumValue - name of the enum constant, must not be null
      +
      Returns:
      +
      this AnnotationBuilder
      +
      +
      +
    • +
    • +
      +

      value

      +
      default AnnotationBuilder value(ClassInfo enumType, + String[] enumValues)
      +
      Adds an enum array-valued annotation member called value.
      +
      +
      Parameters:
      +
      enumType - the enum type, must not be null
      +
      enumValues - names of the enum constants, must not be null or contain null
      +
      Returns:
      +
      this AnnotationBuilder
      +
      +
      +
    • +
    • +
      +

      value

      +
      default AnnotationBuilder value(Class<?> value)
      +
      Adds a class-valued annotation member called value.
      +
      +
      Parameters:
      +
      value - the class value, must not be null
      +
      Returns:
      +
      this AnnotationBuilder
      +
      +
      +
    • +
    • +
      +

      value

      +
      default AnnotationBuilder value(Class<?>[] values)
      +
      Adds a class array-valued annotation member called value.
      +
      +
      Parameters:
      +
      values - the class array, must not be null or contain null
      +
      Returns:
      +
      this AnnotationBuilder
      +
      +
      +
    • +
    • +
      +

      value

      +
      default AnnotationBuilder value(ClassInfo value)
      +
      Adds a class-valued annotation member called value.
      +
      +
      Parameters:
      +
      value - the class value, must not be null
      +
      Returns:
      +
      this AnnotationBuilder
      +
      +
      +
    • +
    • +
      +

      value

      +
      default AnnotationBuilder value(ClassInfo[] values)
      +
      Adds a class array-valued annotation member called value.
      +
      +
      Parameters:
      +
      values - the class array, must not be null or contain null
      +
      Returns:
      +
      this AnnotationBuilder
      +
      +
      +
    • +
    • +
      +

      value

      +
      default AnnotationBuilder value(Type value)
      +
      Adds a class-valued annotation member called value. + The value parameter may only be: +
      +
      +
      Parameters:
      +
      value - the class value, must not be null
      +
      Returns:
      +
      this AnnotationBuilder
      +
      Throws:
      +
      IllegalArgumentException - if given type is invalid, as described above
      +
      +
      +
    • +
    • +
      +

      value

      +
      default AnnotationBuilder value(Type[] values)
      +
      Adds a class array-valued annotation member called value. + The values parameter may only contain: +
      +
      +
      Parameters:
      +
      values - the class array, must not be null or contain null
      +
      Returns:
      +
      this AnnotationBuilder
      +
      Throws:
      +
      IllegalArgumentException - if any given type is invalid, as described above
      +
      +
      +
    • +
    • +
      +

      value

      +
      default AnnotationBuilder value(AnnotationInfo value)
      +
      Adds an annotation-valued annotation member called value.
      +
      +
      Parameters:
      +
      value - the annotation value, must not be null
      +
      Returns:
      +
      this AnnotationBuilder
      +
      +
      +
    • +
    • +
      +

      value

      +
      default AnnotationBuilder value(AnnotationInfo[] values)
      +
      Adds an annotation array-valued annotation member called value.
      +
      +
      Parameters:
      +
      values - the annotation array, must not be null or contain null
      +
      Returns:
      +
      this AnnotationBuilder
      +
      +
      +
    • +
    • +
      +

      value

      +
      default AnnotationBuilder value(Annotation value)
      +
      Adds an annotation-valued annotation member called value.
      +
      +
      Parameters:
      +
      value - the annotation value, must not be null
      +
      Returns:
      +
      this AnnotationBuilder
      +
      +
      +
    • +
    • +
      +

      value

      +
      default AnnotationBuilder value(Annotation[] values)
      +
      Adds an annotation array-valued annotation member called value.
      +
      +
      Parameters:
      +
      values - the annotation array, must not be null or contain null
      +
      Returns:
      +
      this AnnotationBuilder
      +
      +
      +
    • +
    • +
      +

      member

      +
      AnnotationBuilder member(String name, + AnnotationMember value)
      +
      Adds an annotation member with given name, whose value is given value.
      +
      +
      Parameters:
      +
      name - name of the annotation member, must not be null
      +
      value - value of the annotation member, must not be null
      +
      Returns:
      +
      this AnnotationBuilder
      +
      +
      +
    • +
    • +
      +

      member

      +
      AnnotationBuilder member(String name, + boolean value)
      +
      Adds a boolean-valued annotation member with given name.
      +
      +
      Parameters:
      +
      name - the member name, must not be null
      +
      value - the boolean value
      +
      Returns:
      +
      this AnnotationBuilder
      +
      +
      +
    • +
    • +
      +

      member

      +
      AnnotationBuilder member(String name, + boolean[] values)
      +
      Adds a boolean array-valued annotation member with given name.
      +
      +
      Parameters:
      +
      name - the member name, must not be null
      +
      values - the boolean array, must not be null
      +
      Returns:
      +
      this AnnotationBuilder
      +
      +
      +
    • +
    • +
      +

      member

      +
      AnnotationBuilder member(String name, + byte value)
      +
      Adds a byte-valued annotation member with given name.
      +
      +
      Parameters:
      +
      name - the member name, must not be null
      +
      value - the byte value
      +
      Returns:
      +
      this AnnotationBuilder
      +
      +
      +
    • +
    • +
      +

      member

      +
      AnnotationBuilder member(String name, + byte[] values)
      +
      Adds a byte array-valued annotation member with given name.
      +
      +
      Parameters:
      +
      name - the member name, must not be null
      +
      values - the byte array, must not be null
      +
      Returns:
      +
      this AnnotationBuilder
      +
      +
      +
    • +
    • +
      +

      member

      +
      AnnotationBuilder member(String name, + short value)
      +
      Adds a short-valued annotation member with given name.
      +
      +
      Parameters:
      +
      name - the member name, must not be null
      +
      value - the short value
      +
      Returns:
      +
      this AnnotationBuilder
      +
      +
      +
    • +
    • +
      +

      member

      +
      AnnotationBuilder member(String name, + short[] values)
      +
      Adds a short array-valued annotation member with given name.
      +
      +
      Parameters:
      +
      name - the member name, must not be null
      +
      values - the short array, must not be null
      +
      Returns:
      +
      this AnnotationBuilder
      +
      +
      +
    • +
    • +
      +

      member

      +
      AnnotationBuilder member(String name, + int value)
      +
      Adds an int-valued annotation member with given name.
      +
      +
      Parameters:
      +
      name - the member name, must not be null
      +
      value - the int value
      +
      Returns:
      +
      this AnnotationBuilder
      +
      +
      +
    • +
    • +
      +

      member

      +
      AnnotationBuilder member(String name, + int[] values)
      +
      Adds an int array-valued annotation member with given name.
      +
      +
      Parameters:
      +
      name - the member name, must not be null
      +
      values - the int array, must not be null
      +
      Returns:
      +
      this AnnotationBuilder
      +
      +
      +
    • +
    • +
      +

      member

      +
      AnnotationBuilder member(String name, + long value)
      +
      Adds a long-valued annotation member with given name.
      +
      +
      Parameters:
      +
      name - the member name, must not be null
      +
      value - the long value
      +
      Returns:
      +
      this AnnotationBuilder
      +
      +
      +
    • +
    • +
      +

      member

      +
      AnnotationBuilder member(String name, + long[] values)
      +
      Adds a long array-valued annotation member with given name.
      +
      +
      Parameters:
      +
      name - the member name, must not be null
      +
      values - the long array, must not be null
      +
      Returns:
      +
      this AnnotationBuilder
      +
      +
      +
    • +
    • +
      +

      member

      +
      AnnotationBuilder member(String name, + float value)
      +
      Adds a float-valued annotation member with given name.
      +
      +
      Parameters:
      +
      name - the member name, must not be null
      +
      value - the float value
      +
      Returns:
      +
      this AnnotationBuilder
      +
      +
      +
    • +
    • +
      +

      member

      +
      AnnotationBuilder member(String name, + float[] values)
      +
      Adds a float array-valued annotation member with given name.
      +
      +
      Parameters:
      +
      name - the member name, must not be null
      +
      values - the float array, must not be null
      +
      Returns:
      +
      this AnnotationBuilder
      +
      +
      +
    • +
    • +
      +

      member

      +
      AnnotationBuilder member(String name, + double value)
      +
      Adds a double-valued annotation member with given name.
      +
      +
      Parameters:
      +
      name - the member name, must not be null
      +
      value - the double value
      +
      Returns:
      +
      this AnnotationBuilder
      +
      +
      +
    • +
    • +
      +

      member

      +
      AnnotationBuilder member(String name, + double[] values)
      +
      Adds a double array-valued annotation member with given name.
      +
      +
      Parameters:
      +
      name - the member name, must not be null
      +
      values - the double array, must not be null
      +
      Returns:
      +
      this AnnotationBuilder
      +
      +
      +
    • +
    • +
      +

      member

      +
      AnnotationBuilder member(String name, + char value)
      +
      Adds a char-valued annotation member with given name.
      +
      +
      Parameters:
      +
      name - the member name, must not be null
      +
      value - the char value
      +
      Returns:
      +
      this AnnotationBuilder
      +
      +
      +
    • +
    • +
      +

      member

      +
      AnnotationBuilder member(String name, + char[] values)
      +
      Adds a char array-valued annotation member with given name.
      +
      +
      Parameters:
      +
      name - the member name, must not be null
      +
      values - the char array, must not be null
      +
      Returns:
      +
      this AnnotationBuilder
      +
      +
      +
    • +
    • +
      +

      member

      +
      AnnotationBuilder member(String name, + String value)
      +
      Adds a String-valued annotation member with given name.
      +
      +
      Parameters:
      +
      name - the member name, must not be null
      +
      value - the String value, must not be null
      +
      Returns:
      +
      this AnnotationBuilder
      +
      +
      +
    • +
    • +
      +

      member

      +
      AnnotationBuilder member(String name, + String[] values)
      +
      Adds a String array-valued annotation member with given name.
      +
      +
      Parameters:
      +
      name - the member name, must not be null
      +
      values - the String array, must not be null or contain null
      +
      Returns:
      +
      this AnnotationBuilder
      +
      +
      +
    • +
    • +
      +

      member

      +
      AnnotationBuilder member(String name, + Enum<?> value)
      +
      Adds an enum-valued annotation member with given name.
      +
      +
      Parameters:
      +
      name - the member name, must not be null
      +
      value - the enum value, must not be null
      +
      Returns:
      +
      this AnnotationBuilder
      +
      +
      +
    • +
    • +
      +

      member

      +
      AnnotationBuilder member(String name, + Enum<?>[] values)
      +
      Adds an enum array-valued annotation member with given name.
      +
      +
      Parameters:
      +
      name - the member name, must not be null
      +
      values - the enum array, must not be null or contain null
      +
      Returns:
      +
      this AnnotationBuilder
      +
      +
      +
    • +
    • +
      +

      member

      +
      AnnotationBuilder member(String name, + Class<? extends Enum<?>> enumType, + String enumValue)
      +
      Adds an enum-valued annotation member with given name.
      +
      +
      Parameters:
      +
      name - the member name, must not be null
      +
      enumType - the enum type, must not be null
      +
      enumValue - name of the enum constant, must not be null
      +
      Returns:
      +
      this AnnotationBuilder
      +
      +
      +
    • +
    • +
      +

      member

      +
      AnnotationBuilder member(String name, + Class<? extends Enum<?>> enumType, + String[] enumValues)
      +
      Adds an enum array-valued annotation member with given name.
      +
      +
      Parameters:
      +
      name - the member name, must not be null
      +
      enumType - the enum type, must not be null
      +
      enumValues - names of the enum constants, must not be null or contain null
      +
      Returns:
      +
      this AnnotationBuilder
      +
      +
      +
    • +
    • +
      +

      member

      +
      AnnotationBuilder member(String name, + ClassInfo enumType, + String enumValue)
      +
      Adds an enum-valued annotation member with given name.
      +
      +
      Parameters:
      +
      name - the member name, must not be null
      +
      enumType - the enum type, must not be null
      +
      enumValue - name of the enum constant, must not be null
      +
      Returns:
      +
      this AnnotationBuilder
      +
      +
      +
    • +
    • +
      +

      member

      +
      AnnotationBuilder member(String name, + ClassInfo enumType, + String[] enumValues)
      +
      Adds an enum array-valued annotation member with given name.
      +
      +
      Parameters:
      +
      name - the member name, must not be null
      +
      enumType - the enum type, must not be null
      +
      enumValues - names of the enum constants, must not be null or contain null
      +
      Returns:
      +
      this AnnotationBuilder
      +
      +
      +
    • +
    • +
      +

      member

      +
      AnnotationBuilder member(String name, + Class<?> value)
      +
      Adds a class-valued annotation member with given name.
      +
      +
      Parameters:
      +
      name - the member name, must not be null
      +
      value - the class value, must not be null
      +
      Returns:
      +
      this AnnotationBuilder
      +
      +
      +
    • +
    • +
      +

      member

      +
      AnnotationBuilder member(String name, + Class<?>[] values)
      +
      Adds a class array-valued annotation member with given name.
      +
      +
      Parameters:
      +
      name - the member name, must not be null
      +
      values - the class array, must not be null or contain null
      +
      Returns:
      +
      this AnnotationBuilder
      +
      +
      +
    • +
    • +
      +

      member

      +
      AnnotationBuilder member(String name, + ClassInfo value)
      +
      Adds a class-valued annotation member with given name.
      +
      +
      Parameters:
      +
      name - the member name, must not be null
      +
      value - the class value, must not be null
      +
      Returns:
      +
      this AnnotationBuilder
      +
      +
      +
    • +
    • +
      +

      member

      +
      AnnotationBuilder member(String name, + ClassInfo[] values)
      +
      Adds a class array-valued annotation member with given name.
      +
      +
      Parameters:
      +
      name - the member name, must not be null
      +
      values - the class array, must not be null or contain null
      +
      Returns:
      +
      this AnnotationBuilder
      +
      +
      +
    • +
    • +
      +

      member

      +
      AnnotationBuilder member(String name, + Type value)
      +
      Adds a class-valued annotation member with given name. + The value parameter may only be: + + Any other value results in an exception.
      +
      +
      Parameters:
      +
      name - the member name, must not be null
      +
      value - the class value, must not be null
      +
      Returns:
      +
      this AnnotationBuilder
      +
      Throws:
      +
      IllegalArgumentException - if given type is invalid, as described above
      +
      +
      +
    • +
    • +
      +

      member

      +
      AnnotationBuilder member(String name, + Type[] values)
      +
      Adds a class array-valued annotation member with given name. + The values parameter may only include: +
      +
      +
      Parameters:
      +
      name - the member name, must not be null
      +
      values - the class array, must not be null or contain null
      +
      Returns:
      +
      this AnnotationBuilder
      +
      Throws:
      +
      IllegalArgumentException - if any given type is invalid, as described above
      +
      +
      +
    • +
    • +
      +

      member

      +
      AnnotationBuilder member(String name, + AnnotationInfo value)
      +
      Adds an annotation-valued annotation member with given name.
      +
      +
      Parameters:
      +
      name - the member name, must not be null
      +
      value - the annotation value, must not be null
      +
      Returns:
      +
      this AnnotationBuilder
      +
      +
      +
    • +
    • +
      +

      member

      +
      AnnotationBuilder member(String name, + AnnotationInfo[] values)
      +
      Adds an annotation array-valued annotation member with given name.
      +
      +
      Parameters:
      +
      name - the member name, must not be null
      +
      values - the annotation array, must not be null or contain null
      +
      Returns:
      +
      this AnnotationBuilder
      +
      +
      +
    • +
    • +
      +

      member

      +
      AnnotationBuilder member(String name, + Annotation value)
      +
      Adds an annotation-valued annotation member with given name.
      +
      +
      Parameters:
      +
      name - the member name, must not be null
      +
      value - the annotation value, must not be null
      +
      Returns:
      +
      this AnnotationBuilder
      +
      +
      +
    • +
    • +
      +

      member

      +
      AnnotationBuilder member(String name, + Annotation[] values)
      +
      Adds an annotation array-valued annotation member with given name.
      +
      +
      Parameters:
      +
      name - the member name, must not be null
      +
      values - the annotation array, must not be null or contain null
      +
      Returns:
      +
      this AnnotationBuilder
      +
      +
      +
    • +
    • +
      +

      build

      + +
      Returns an AnnotationInfo that includes all annotation members defined by previous method calls + on this builder. After build() is called, this builder instance should be discarded.
      +
      +
      Returns:
      +
      the built AnnotationInfo, never null
      +
      Throws:
      +
      IllegalStateException - if a value of some annotation member was not set, and that member + does not declare a default value
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/AnnotationBuilderFactory.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/AnnotationBuilderFactory.html new file mode 100644 index 0000000000..2fc1c497e4 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/AnnotationBuilderFactory.html @@ -0,0 +1,178 @@ + + + + +AnnotationBuilderFactory (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface AnnotationBuilderFactory

+
+
+
+
public interface AnnotationBuilderFactory
+
Supports instantiating AnnotationBuilder. + Should not be called directly by users; the static methods on AnnotationBuilder are preferred.
+
+
Since:
+
4.0
+
+
+
+ +
+
+ +
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/BeanInfo.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/BeanInfo.html new file mode 100644 index 0000000000..b3a348ead3 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/BeanInfo.html @@ -0,0 +1,463 @@ + + + + +BeanInfo (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface BeanInfo

+
+
+
+
All Known Subinterfaces:
+
InterceptorInfo
+
+
+
public interface BeanInfo
+
Beans are: + +
    +
  • managed beans
  • +
  • beans defined by producer methods
  • +
  • beans defined by producer fields
  • +
  • synthetic beans
  • +
+ + Managed beans are also known as class-based beans, while beans defined by producer methods + and producer fields are together also known as producer-based beans. +

+ Class-based and producer-based beans directly correspond to a declaration in program source code. + Synthetic beans don't and are instead defined through other mechanisms, such as + extensions.

+
+
Since:
+
4.0
+
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      scope

      +
      ScopeInfo scope()
      +
      Returns the scope of this bean.
      +
      +
      Returns:
      +
      the scope of this bean, never null
      +
      +
      +
    • +
    • +
      +

      types

      +
      Collection<Type> types()
      +
      Returns a collection of all types of this bean.
      +
      +
      Returns:
      +
      immutable collection of bean types, never null
      +
      +
      +
    • +
    • +
      +

      qualifiers

      +
      Collection<AnnotationInfo> qualifiers()
      +
      Returns a collection of this bean's qualifiers, represented as AnnotationInfo.
      +
      +
      Returns:
      +
      immutable collection of qualifiers, never null
      +
      +
      +
    • +
    • +
      +

      declaringClass

      +
      ClassInfo declaringClass()
      +
      Returns the class that declares this bean. + In case of a managed bean, also known as class-based bean, that is the bean class directly. + In case of a producer method or field, that is the class that declares the producer method or field. + Returns null if this bean is synthetic.
      +
      +
      Returns:
      +
      ClassInfo for the class that declares this bean, or null if this bean is synthetic
      +
      +
      +
    • +
    • +
      +

      isClassBean

      +
      boolean isClassBean()
      +
      Returns whether this bean is a managed bean, also known as class-based bean.
      +
      +
      Returns:
      +
      whether this bean is a managed bean
      +
      +
      +
    • +
    • +
      +

      isProducerMethod

      +
      boolean isProducerMethod()
      +
      Returns whether this bean is defined by a producer method.
      +
      +
      Returns:
      +
      whether this bean is defined by a producer method
      +
      +
      +
    • +
    • +
      +

      isProducerField

      +
      boolean isProducerField()
      +
      Returns whether this bean is defined by a producer field.
      +
      +
      Returns:
      +
      whether this bean is defined by a producer field
      +
      +
      +
    • +
    • +
      +

      isSynthetic

      +
      boolean isSynthetic()
      +
      Returns whether this bean is synthetic. In other words, whether this bean + does not correspond to a declaration in program source code and was created + through other means (e.g. using an extension).
      +
      +
      Returns:
      +
      whether this bean is synthetic
      +
      +
      +
    • +
    • +
      +

      producerMethod

      +
      MethodInfo producerMethod()
      +
      Returns the producer method that defines this bean. + Returns null if this bean is not defined by a producer method.
      +
      +
      Returns:
      +
      producer method that defines this bean, or null if this bean is not defined by a producer method
      +
      +
      +
    • +
    • +
      +

      producerField

      +
      FieldInfo producerField()
      +
      Returns the producer field that defines this bean. + Returns null if this bean is not defined by a producer field.
      +
      +
      Returns:
      +
      producer field that defines this bean, or null if this bean is not defined by a producer field
      +
      +
      +
    • +
    • +
      +

      isAlternative

      +
      boolean isAlternative()
      +
      Returns whether this bean is an alternative.
      +
      +
      Returns:
      +
      whether this bean is an alternative
      +
      +
      +
    • +
    • +
      +

      priority

      +
      Integer priority()
      +
      Returns the priority declared on this bean, or null + if this bean does not declare a priority. Declaring a priority on an alternative bean makes it an enabled + alternative. Similarly, declaring a priority on an interceptor makes it an enabled interceptor.
      +
      +
      Returns:
      +
      the priority of this bean, or null if this bean does not declare a priority
      +
      +
      +
    • +
    • +
      +

      name

      +
      String name()
      +
      Returns the bean name of this bean. A bean name is usually defined + using the @Named annotation. + Returns null if the bean does not have a name.
      +
      +
      Returns:
      +
      the bean name, or null if the bean does not have a name
      +
      +
      +
    • +
    • +
      +

      disposer

      +
      DisposerInfo disposer()
      +
      Returns the disposer method of this producer-based bean. + Returns null if this bean is not a defined by a producer method or a producer field, + or if this producer-based bean does not have a corresponding disposer method.
      +
      +
      Returns:
      +
      the disposer, or null if this bean does not have a disposer
      +
      +
      +
    • +
    • +
      +

      stereotypes

      +
      Collection<StereotypeInfo> stereotypes()
      +
      Returns a collection of this bean's stereotypes.
      +
      +
      Returns:
      +
      immutable collection of stereotypes, never null
      +
      +
      +
    • +
    • +
      +

      injectionPoints

      +
      Collection<InjectionPointInfo> injectionPoints()
      +
      Returns a collection of this bean's injection points.
      +
      +
      Returns:
      +
      immutable collection of injection points, never null
      +
      +
      +
    • +
    • +
      +

      isInterceptor

      +
      default boolean isInterceptor()
      +
      Returns whether this bean is an interceptor.
      +
      +
      Returns:
      +
      whether this bean is an interceptor
      +
      +
      +
    • +
    • +
      +

      asInterceptor

      +
      default InterceptorInfo asInterceptor()
      +
      Returns this bean as an interceptor.
      +
      +
      Returns:
      +
      this interceptor, never null
      +
      Throws:
      +
      IllegalStateException - if isInterceptor() returns false
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/BuildCompatibleExtension.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/BuildCompatibleExtension.html new file mode 100644 index 0000000000..c8a8673414 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/BuildCompatibleExtension.html @@ -0,0 +1,153 @@ + + + + +BuildCompatibleExtension (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface BuildCompatibleExtension

+
+
+
+
public interface BuildCompatibleExtension
+
Build compatible extensions are service providers for this interface, as defined in ServiceLoader. + This means: they are classes that implement this interface, provide a META-INF/services file, + and satisfy all other service provider constraints. Additionally, build compatible extensions must not be beans + and must not be referred to by application code. +

+ Build compatible extensions may define arbitrary public, non-static, void-returning methods + without type parameters, annotated with one of the extension annotations. Such methods are called extension methods. +

+ Extension methods are executed in 5 phases, corresponding to 5 extension annotations: +

+

+ Extension methods may declare arbitrary number of parameters. In each execution phase, different types + of parameters may be declared, as documented in the corresponding extension annotation. All the parameters + will be provided by the container when the extension method is invoked. If an extension method declares + a parameter of a type unsupported in the execution phase, the container treats it as a deployment problem. +

+ Extension methods may be assigned a priority using @Priority. + Extension methods with smaller priority values are invoked first. Extension methods without specified priority + have a default priority of Priority.APPLICATION + 500. + If two extension methods have equal priority, the ordering between them is undefined. Note that priority + only affects order of extension methods in a single phase. +

+ For each build compatible extension, the container creates a single instance. All extension methods + are invoked on the same instance. +

+ When extension methods are invoked, a CDI container does not have to be running, so calling CDI.current() + from an extension method, or attempting to access a running CDI container in any other way, results in + non-portable behavior. +

+ Build compatible extensions may be annotated @SkipIfPortableExtensionPresent + when they are supposed to be ignored in presence of a given portable extension. +

+ CDI implementations are not required to accept custom implementations of any jakarta.enterprise.lang.model, + jakarta.enterprise.invoke or jakarta.enterprise.inject.build.compatible.spi interface + on the API boundary of build compatible extensions. In other words, users may only use instances of these + interfaces that they previously obtained from the corresponding API. If not, non-portable behavior results. +

+ In build compatible extensions, implementations of AnnotationTarget + only return annotations with the runtime retention policy.

+
+
Since:
+
4.0
+
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/BuildServices.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/BuildServices.html new file mode 100644 index 0000000000..fc101e486c --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/BuildServices.html @@ -0,0 +1,162 @@ + + + + +BuildServices (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface BuildServices

+
+
+
+
All Superinterfaces:
+
Prioritized
+
+
+
public interface BuildServices +extends Prioritized
+
Service provider interface for various services needed by BuildCompatibleExtension implementations.
+
+
Since:
+
4.0
+
+
+
+ +
+
+ +
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/BuildServicesResolver.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/BuildServicesResolver.html new file mode 100644 index 0000000000..4eb9a4276e --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/BuildServicesResolver.html @@ -0,0 +1,197 @@ + + + + +BuildServicesResolver (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Class BuildServicesResolver

+
+
java.lang.Object +
jakarta.enterprise.inject.build.compatible.spi.BuildServicesResolver
+
+
+
+
public final class BuildServicesResolver +extends Object
+
An internal helper to resolve BuildServices implementations. + This class is public only for integrators and should not be used by applications.
+
+
Since:
+
4.0
+
+
+
+ +
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      BuildServicesResolver

      +
      public BuildServicesResolver()
      +
      +
    • +
    +
    +
  • + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      setBuildServices

      +
      public static void setBuildServices(BuildServices instance)
      +
      This method should not be used by applications. It is only exposed for integrators + with complex classloading architectures, where service loader lookup doesn't work out of the box. + With this method, an integrator may manually provide an instance of BuildServices and + this class will no longer attempt to look it up using service loader.
      +
      +
      Parameters:
      +
      instance - a BuildServices instance that should be used, must not be null
      +
      Throws:
      +
      IllegalArgumentException - if the provided argument is null
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/ClassConfig.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/ClassConfig.html new file mode 100644 index 0000000000..d1aedf0e17 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/ClassConfig.html @@ -0,0 +1,327 @@ + + + + +ClassConfig (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface ClassConfig

+
+
+
+
All Superinterfaces:
+
DeclarationConfig
+
+
+
public interface ClassConfig +extends DeclarationConfig
+
Allows adding annotations to and removing annotations from a class. + Note that the class is not physically altered, the modifications + are only seen by the CDI container.
+
+
Since:
+
4.0
+
See Also:
+
+ +
+
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    + +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/DeclarationConfig.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/DeclarationConfig.html new file mode 100644 index 0000000000..f72a7cdd67 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/DeclarationConfig.html @@ -0,0 +1,260 @@ + + + + +DeclarationConfig (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface DeclarationConfig

+
+
+
+
All Known Subinterfaces:
+
ClassConfig, FieldConfig, MethodConfig, ParameterConfig
+
+
+
public interface DeclarationConfig
+
Allows adding annotations to and removing annotations from a declaration. + Note that the declaration is not physically altered, the modifications + are only seen by the CDI container.
+
+
Since:
+
4.0
+
See Also:
+
+ +
+
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      info

      + +
      Returns the DeclarationInfo corresponding to this transformed declaration.
      +
      +
      Returns:
      +
      the DeclarationInfo corresponding to this transformed declaration, never null
      +
      +
      +
    • +
    • +
      +

      addAnnotation

      +
      DeclarationConfig addAnnotation(Class<? extends Annotation> annotationType)
      +
      Adds a marker annotation of given type to this declaration. + Does not allow configuring annotation members.
      +
      +
      Parameters:
      +
      annotationType - the annotation type, must not be null
      +
      Returns:
      +
      this configurator object, to allow fluent usage
      +
      +
      +
    • +
    • +
      +

      addAnnotation

      +
      DeclarationConfig addAnnotation(AnnotationInfo annotation)
      +
      Adds given annotation to this declaration. The AnnotationInfo can be obtained + from an annotation target, or constructed from scratch using AnnotationBuilder.
      +
      +
      Parameters:
      +
      annotation - the annotation to add to this declaration, must not be null
      +
      Returns:
      +
      this configurator object, to allow fluent usage
      +
      +
      +
    • +
    • +
      +

      addAnnotation

      +
      DeclarationConfig addAnnotation(Annotation annotation)
      +
      Adds given annotation to this declaration. The annotation instance is typically + a subclass of AnnotationLiteral.
      +
      +
      Parameters:
      +
      annotation - the annotation to add to this declaration, must not be null
      +
      Returns:
      +
      this configurator object, to allow fluent usage
      +
      +
      +
    • +
    • +
      +

      removeAnnotation

      +
      DeclarationConfig removeAnnotation(Predicate<AnnotationInfo> predicate)
      +
      Removes all annotations matching given predicate from this declaration.
      +
      +
      Parameters:
      +
      predicate - an annotation predicate, must not be null
      +
      Returns:
      +
      this configurator object, to allow fluent usage
      +
      +
      +
    • +
    • +
      +

      removeAllAnnotations

      +
      DeclarationConfig removeAllAnnotations()
      +
      Removes all annotations from this declaration.
      +
      +
      Returns:
      +
      this configurator object, to allow fluent usage
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/Discovery.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/Discovery.html new file mode 100644 index 0000000000..1e769eb9e1 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/Discovery.html @@ -0,0 +1,117 @@ + + + + +Discovery (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Annotation Interface Discovery

+
+
+
+
@Target(METHOD) +@Retention(RUNTIME) +public @interface Discovery
+
1st phase of build compatible extension execution. + Allow adding additional classes to the set of types discovered during type discovery. + Also allows registering custom CDI meta-annotations. +

+ Methods annotated @Discovery may declare parameters of these types: +

+
+
Since:
+
4.0
+
+
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/DisposerInfo.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/DisposerInfo.html new file mode 100644 index 0000000000..112daf88ba --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/DisposerInfo.html @@ -0,0 +1,174 @@ + + + + +DisposerInfo (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface DisposerInfo

+
+
+
+
public interface DisposerInfo
+
Disposer methods may exist for producer-based beans. Each disposer method + has a disposed parameter.
+
+
Since:
+
4.0
+
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      disposerMethod

      +
      MethodInfo disposerMethod()
      +
      Returns the declaration of this disposer method.
      +
      +
      Returns:
      +
      the declaration of this disposer method, never null
      +
      +
      +
    • +
    • +
      +

      disposedParameter

      +
      ParameterInfo disposedParameter()
      +
      Returns the declaration of the disposed parameter of this disposer method.
      +
      +
      Returns:
      +
      the declaration of the disposed parameter of this disposer method, never null
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/Enhancement.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/Enhancement.html new file mode 100644 index 0000000000..432c0e41d4 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/Enhancement.html @@ -0,0 +1,256 @@ + + + + +Enhancement (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Annotation Interface Enhancement

+
+
+
+
@Target(METHOD) +@Retention(RUNTIME) +public @interface Enhancement
+
2nd phase of build compatible extension execution. + Allows transforming annotations. +

+ In the following text, the term expected types denotes the set of types defined by + the types, withSubtypes and withAnnotations + members of the @Enhancement annotation. The term discovered types denotes + the subset of expected types that were discovered during type discovery. +

+ Methods annotated @Enhancement must declare exactly one parameter of one of these types: +

+ If an @Enhancement method has a parameter of type ClassConfig or ClassInfo, + the method is called once for each discovered type. +

+ If an @Enhancement method has a parameter of type MethodConfig or MethodInfo, + the method is called once for each constructor or method that is declared on each discovered type, + as defined in ClassInfo.constructors + and ClassInfo.methods. +

+ If an @Enhancement method has a parameter of type FieldConfig or FieldInfo, + the method is called once for each field that is declared on each discovered type, as defined + in ClassInfo.fields. +

+ If the @Enhancement method doesn't declare any parameter of one of these types, + or if it declares more than one, the container treats it as a definition error. +

+ Additionally, methods annotated @Enhancement may declare parameters of these types: +

+

+ Finally, AnnotationBuilder may be used to create instances + of AnnotationInfo.

+
+
Since:
+
4.0
+
+
+
+
    + +
  • +
    +

    Required Element Summary

    +
    Required Elements
    +
    +
    Modifier and Type
    +
    Required Element
    +
    Description
    +
    Class<?>[]
    + +
    +
    Defines the set of expected types.
    +
    +
    +
    +
  • + +
  • +
    +

    Optional Element Summary

    +
    Optional Elements
    +
    +
    Modifier and Type
    +
    Optional Element
    +
    Description
    +
    Class<? extends Annotation>[]
    + +
    +
    Narrows down the set of expected types, defined by types + and withSubtypes, to types that use any of given annotations.
    +
    +
    boolean
    + +
    +
    If true, the set of expected types includes all direct and + indirect subtypes of given types.
    +
    +
    +
    +
  • +
+
+
+
    + +
  • +
    +

    Element Details

    +
      +
    • +
      +

      types

      +
      Class<?>[] types
      +
      Defines the set of expected types. If withSubtypes + is true, the set of expected types includes all direct and indirect + subtypes of these types. If withAnnotations is defined, + the set of expected types only includes types that use given annotations.
      +
      +
      Returns:
      +
      the set of expected types
      +
      +
      +
    • +
    • +
      +

      withSubtypes

      +
      boolean withSubtypes
      +
      If true, the set of expected types includes all direct and + indirect subtypes of given types.
      +
      +
      Returns:
      +
      whether subtypes should be included in the set of expected types
      +
      +
      +
      Default:
      +
      false
      +
      +
      +
    • +
    • +
      +

      withAnnotations

      +
      Class<? extends Annotation>[] withAnnotations
      +
      Narrows down the set of expected types, defined by types + and withSubtypes, to types that use any of given annotations. + The annotation can appear on the type, or on any member of the type, or on any + parameter of any member of the type, or as a meta-annotation on any annotation + that is considered by these rules. +

      + If empty, the set of expected types is not narrowed down in any way. + If java.lang.Annotation is present, the set of expected types + is narrowed down to types that use any annotation. +

      + Defaults to an empty array, so that the set of expected types is not + narrowed down in any way.

      +
      +
      Returns:
      +
      types of annotations that must be present on the expected types
      +
      +
      +
      Default:
      +
      {}
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/FieldConfig.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/FieldConfig.html new file mode 100644 index 0000000000..7ccf92047c --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/FieldConfig.html @@ -0,0 +1,273 @@ + + + + +FieldConfig (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface FieldConfig

+
+
+
+
All Superinterfaces:
+
DeclarationConfig
+
+
+
public interface FieldConfig +extends DeclarationConfig
+
Allows adding annotations to and removing annotations from a field. + Note that the field is not physically altered, the modifications + are only seen by the CDI container.
+
+
Since:
+
4.0
+
See Also:
+
+ +
+
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      info

      +
      FieldInfo info()
      +
      Returns the FieldInfo corresponding to this transformed field.
      +
      +
      Specified by:
      +
      info in interface DeclarationConfig
      +
      Returns:
      +
      the FieldInfo corresponding to this transformed field, never null
      +
      +
      +
    • +
    • +
      +

      addAnnotation

      +
      FieldConfig addAnnotation(Class<? extends Annotation> annotationType)
      +
      Adds a marker annotation of given type to this field. + Does not allow configuring annotation members.
      +
      +
      Specified by:
      +
      addAnnotation in interface DeclarationConfig
      +
      Parameters:
      +
      annotationType - the annotation type, must not be null
      +
      Returns:
      +
      this configurator object, to allow fluent usage
      +
      +
      +
    • +
    • +
      +

      addAnnotation

      +
      FieldConfig addAnnotation(AnnotationInfo annotation)
      +
      Adds given annotation to this field. The AnnotationInfo can be obtained + from an annotation target, or constructed from scratch using AnnotationBuilder.
      +
      +
      Specified by:
      +
      addAnnotation in interface DeclarationConfig
      +
      Parameters:
      +
      annotation - the annotation to add to this field, must not be null
      +
      Returns:
      +
      this configurator object, to allow fluent usage
      +
      +
      +
    • +
    • +
      +

      addAnnotation

      +
      FieldConfig addAnnotation(Annotation annotation)
      +
      Adds given annotation to this field. The annotation instance is typically + a subclass of AnnotationLiteral.
      +
      +
      Specified by:
      +
      addAnnotation in interface DeclarationConfig
      +
      Parameters:
      +
      annotation - the annotation to add to this field, must not be null
      +
      Returns:
      +
      this configurator object, to allow fluent usage
      +
      +
      +
    • +
    • +
      +

      removeAnnotation

      +
      FieldConfig removeAnnotation(Predicate<AnnotationInfo> predicate)
      +
      Removes all annotations matching given predicate from this field.
      +
      +
      Specified by:
      +
      removeAnnotation in interface DeclarationConfig
      +
      Parameters:
      +
      predicate - an annotation predicate, must not be null
      +
      Returns:
      +
      this configurator object, to allow fluent usage
      +
      +
      +
    • +
    • +
      +

      removeAllAnnotations

      +
      FieldConfig removeAllAnnotations()
      +
      Removes all annotations from this field.
      +
      +
      Specified by:
      +
      removeAllAnnotations in interface DeclarationConfig
      +
      Returns:
      +
      this configurator object, to allow fluent usage
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/InjectionPointInfo.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/InjectionPointInfo.html new file mode 100644 index 0000000000..2f3f70f62b --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/InjectionPointInfo.html @@ -0,0 +1,199 @@ + + + + +InjectionPointInfo (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface InjectionPointInfo

+
+
+
+
public interface InjectionPointInfo
+
An injection point defined on some bean. Injection points may be fields + or method parameters.
+
+
Since:
+
4.0
+
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      type

      +
      Type type()
      +
      Returns the type of this injection point.
      +
      +
      Returns:
      +
      the type of this injection point, never null
      +
      +
      +
    • +
    • +
      +

      qualifiers

      +
      Collection<AnnotationInfo> qualifiers()
      +
      Returns a collection of qualifiers declared on this injection point, represented as AnnotationInfo.
      +
      +
      Returns:
      +
      collection of qualifiers, never null
      +
      +
      +
    • +
    • +
      +

      declaration

      +
      DeclarationInfo declaration()
      +
      Returns the declaration of this injection point. + That is a FieldInfo for field injection, + or ParameterInfo for: +
        +
      • constructor injection,
      • +
      • initializer method,
      • +
      • disposer method,
      • +
      • producer method,
      • +
      • observer method.
      • +
      +
      +
      Returns:
      +
      the declaration of this injection point, never null
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/InterceptorInfo.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/InterceptorInfo.html new file mode 100644 index 0000000000..f635281808 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/InterceptorInfo.html @@ -0,0 +1,239 @@ + + + + +InterceptorInfo (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface InterceptorInfo

+
+
+
+
All Superinterfaces:
+
BeanInfo
+
+
+
public interface InterceptorInfo +extends BeanInfo
+
Interceptors are managed beans annotated @Interceptor. + An interceptor declares a set of interceptor binding annotations, + used to associate the interceptor with target beans. It also declares at most one interceptor method + for each interception type. Interception types are: +
    +
  • @AroundInvoke: intercept business method invocations,
  • +
  • @AroundConstruct: intercept constructor invocations,
  • +
  • @PostConstruct: called after the container creates the target instance + and completes dependency injection,
  • +
  • @PreDestroy: called before the container destroys the target instance.
  • +
+ Finally, an interceptor also needs to declare a @Priority to become enabled. +

+ Note that this description applies to CDI Lite. There are more ways to declare an interceptor, + but those are only present in CDI Full.

+
+
Since:
+
4.0
+
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      interceptorBindings

      +
      Collection<AnnotationInfo> interceptorBindings()
      +
      Returns the set of interceptor binding annotations + declared on this interceptor.
      +
      +
      Returns:
      +
      immutable set of interceptor binding annotations, never null
      +
      +
      +
    • +
    • +
      +

      intercepts

      +
      boolean intercepts(InterceptionType interceptionType)
      +
      Returns whether this interceptor declares an interceptor method for given + interception type.
      +
      +
      Parameters:
      +
      interceptionType - the type of interception
      +
      Returns:
      +
      whether this interceptor declares an interceptor method for given interception type
      +
      +
      +
    • +
    • +
      +

      isInterceptor

      +
      default boolean isInterceptor()
      +
      Description copied from interface: BeanInfo
      +
      Returns whether this bean is an interceptor.
      +
      +
      Specified by:
      +
      isInterceptor in interface BeanInfo
      +
      Returns:
      +
      whether this bean is an interceptor
      +
      +
      +
    • +
    • +
      +

      asInterceptor

      +
      default InterceptorInfo asInterceptor()
      +
      Description copied from interface: BeanInfo
      +
      Returns this bean as an interceptor.
      +
      +
      Specified by:
      +
      asInterceptor in interface BeanInfo
      +
      Returns:
      +
      this interceptor, never null
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/InvokerFactory.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/InvokerFactory.html new file mode 100644 index 0000000000..6d60161cfd --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/InvokerFactory.html @@ -0,0 +1,166 @@ + + + + +InvokerFactory (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface InvokerFactory

+
+
+
+
public interface InvokerFactory
+
Factory for InvokerBuilders.
+
+
Since:
+
4.1
+
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      createInvoker

      +
      InvokerBuilder<InvokerInfo> createInvoker(BeanInfo bean, + MethodInfo method)
      +
      Returns a new InvokerBuilder for given method of given bean. The builder + eventually produces an opaque representation of the generated invoker. +

      + If an invoker may not be built for given bean or for given method, + an exception is thrown.

      +
      +
      Parameters:
      +
      bean - target bean of the invoker, must not be null
      +
      method - target method of the invoker, must not be null
      +
      Returns:
      +
      the invoker builder, never null
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/InvokerInfo.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/InvokerInfo.html new file mode 100644 index 0000000000..003869c797 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/InvokerInfo.html @@ -0,0 +1,112 @@ + + + + +InvokerInfo (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface InvokerInfo

+
+
+
+
public interface InvokerInfo
+
Opaque token that stands in for an invoker registered using InvokerFactory.createInvoker(BeanInfo, MethodInfo) + and InvokerBuilder.build(). It can only be used to materialize an Invoker in a synthetic component; + see SyntheticBeanBuilder.withParam() or + SyntheticObserverBuilder.withParam().
+
+
Since:
+
4.1
+
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/Messages.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/Messages.html new file mode 100644 index 0000000000..b3ba44e213 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/Messages.html @@ -0,0 +1,384 @@ + + + + +Messages (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface Messages

+
+
+
+
public interface Messages
+
Allows logging and producing errors during build compatible extension + execution. If an error is produced, using any of the error methods, the container treats it + as a deployment problem.
+
+
Since:
+
4.0
+
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      info

      +
      void info(String message)
      +
      Add a generic information message that is not related to any particular element, or that information is not known.
      +
      +
      Parameters:
      +
      message - information message
      +
      +
      +
    • +
    • +
      +

      info

      +
      void info(String message, + AnnotationTarget relatedTo)
      +
      Add an information message which is related to given AnnotationTarget (which is most likely + a DeclarationInfo).
      +
      +
      Parameters:
      +
      message - information message
      +
      relatedTo - annotation target to which the message is related
      +
      +
      +
    • +
    • +
      +

      info

      +
      void info(String message, + BeanInfo relatedTo)
      +
      Add an information message which is related to given BeanInfo.
      +
      +
      Parameters:
      +
      message - information message
      +
      relatedTo - bean to which the message is related
      +
      +
      +
    • +
    • +
      +

      info

      +
      void info(String message, + ObserverInfo relatedTo)
      +
      Add an information message which is related to given ObserverInfo.
      +
      +
      Parameters:
      +
      message - information message
      +
      relatedTo - observer to which the message is related
      +
      +
      +
    • +
    • +
      +

      warn

      +
      void warn(String message)
      +
      Add a generic warning that is not related to any particular element, or that information is not known.
      +
      +
      Parameters:
      +
      message - warning message
      +
      +
      +
    • +
    • +
      +

      warn

      +
      void warn(String message, + AnnotationTarget relatedTo)
      +
      Add a warning which is related to given AnnotationTarget (which is most likely + a DeclarationInfo).
      +
      +
      Parameters:
      +
      message - warning message
      +
      relatedTo - annotation target to which the message is related
      +
      +
      +
    • +
    • +
      +

      warn

      +
      void warn(String message, + BeanInfo relatedTo)
      +
      Add a warning which is related to given BeanInfo.
      +
      +
      Parameters:
      +
      message - warning message
      +
      relatedTo - bean to which the message is related
      +
      +
      +
    • +
    • +
      +

      warn

      +
      void warn(String message, + ObserverInfo relatedTo)
      +
      Add a warning which is related to given ObserverInfo.
      +
      +
      Parameters:
      +
      message - warning message
      +
      relatedTo - observer to which the message is related
      +
      +
      +
    • +
    • +
      +

      error

      +
      void error(String message)
      +
      Add a generic error that is not related to any particular element, or that information is not known.
      +
      +
      Parameters:
      +
      message - error message
      +
      +
      +
    • +
    • +
      +

      error

      +
      void error(String message, + AnnotationTarget relatedTo)
      +
      Add an error which is related to given AnnotationTarget (which is most likely + a DeclarationInfo).
      +
      +
      Parameters:
      +
      message - error message
      +
      relatedTo - annotation target to which the message is related
      +
      +
      +
    • +
    • +
      +

      error

      +
      void error(String message, + BeanInfo relatedTo)
      +
      Add an error which is related to given BeanInfo.
      +
      +
      Parameters:
      +
      message - error message
      +
      relatedTo - bean to which the message is related
      +
      +
      +
    • +
    • +
      +

      error

      +
      void error(String message, + ObserverInfo relatedTo)
      +
      Add an error which is related to given ObserverInfo.
      +
      +
      Parameters:
      +
      message - error message
      +
      relatedTo - observer to which the message is related
      +
      +
      +
    • +
    • +
      +

      error

      +
      void error(Exception exception)
      +
      Add a generic error that is represented by an exception.
      +
      +
      Parameters:
      +
      exception - error, represented by an exception
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/MetaAnnotations.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/MetaAnnotations.html new file mode 100644 index 0000000000..861482baa1 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/MetaAnnotations.html @@ -0,0 +1,265 @@ + + + + +MetaAnnotations (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface MetaAnnotations

+
+
+
+
public interface MetaAnnotations
+
Allows registering custom CDI meta-annotations: qualifiers, interceptor bindings, + stereotypes, and scopes. When registering a custom scope, a context class must + also be provided.
+
+
Since:
+
4.0
+
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      addQualifier

      +
      ClassConfig addQualifier(Class<? extends Annotation> annotation)
      +
      Registers annotation as a qualifier annotation. Only makes sense if the annotation + is not meta-annotated @Qualifier. +

      + Returns a class configurator object that allows transforming meta-annotations + on the annotation.

      +
      +
      Parameters:
      +
      annotation - annotation type
      +
      Returns:
      +
      the class configurator, never null
      +
      +
      +
    • +
    • +
      +

      addInterceptorBinding

      +
      ClassConfig addInterceptorBinding(Class<? extends Annotation> annotation)
      +
      Registers annotation as an interceptor binding annotation. Only makes sense if the annotation + is not meta-annotated @InterceptorBinding. +

      + Returns a class configurator object that allows transforming meta-annotations + on the annotation.

      +
      +
      Parameters:
      +
      annotation - annotation type
      +
      Returns:
      +
      the class configurator, never null
      +
      +
      +
    • +
    • +
      +

      addStereotype

      +
      ClassConfig addStereotype(Class<? extends Annotation> annotation)
      +
      Registers annotation as a stereotype annotation. Only makes sense if the annotation + is not meta-annotated @Stereotype. +

      + Returns a class configurator object that allows transforming meta-annotations + on the annotation.

      +
      +
      Parameters:
      +
      annotation - annotation type
      +
      Returns:
      +
      the class configurator, never null
      +
      +
      +
    • +
    • +
      +

      addContext

      +
      void addContext(Class<? extends Annotation> scopeAnnotation, + Class<? extends AlterableContext> contextClass)
      +
      Registers custom context for given scopeAnnotation and given contextClass. + CDI container will create an instance of the context class once to obtain the context object. + The context class must be public and have a public zero-parameter constructor; + it must not be a bean. +

      + Whether the scope is normal is discovered from the scope annotation. This means that the scope + annotation must be meta-annotated either @NormalScope + or @Scope.

      +
      +
      Parameters:
      +
      scopeAnnotation - the scope annotation type, must not be null
      +
      contextClass - the context class, must not be null
      +
      Throws:
      +
      IllegalArgumentException - if the scopeAnnotation is not meta-annotated @NormalScope + or @Scope
      +
      +
      +
    • +
    • +
      +

      addContext

      +
      void addContext(Class<? extends Annotation> scopeAnnotation, + boolean isNormal, + Class<? extends AlterableContext> contextClass)
      +
      Registers custom context for given scopeAnnotation and given contextClass. + CDI container will create an instance of the context class once to obtain the context object. + The context class must be public and have a public zero-parameter constructor; + it must not be a bean. +

      + The isNormal parameter determines whether the scope is a normal scope or a pseudo-scope.

      +
      +
      Parameters:
      +
      scopeAnnotation - the scope annotation type, must not be null
      +
      isNormal - whether the scope is normal
      +
      contextClass - the context class, must not be null
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/MethodConfig.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/MethodConfig.html new file mode 100644 index 0000000000..2c452561df --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/MethodConfig.html @@ -0,0 +1,289 @@ + + + + +MethodConfig (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface MethodConfig

+
+
+
+
All Superinterfaces:
+
DeclarationConfig
+
+
+
public interface MethodConfig +extends DeclarationConfig
+
Allows adding annotations to and removing annotations from a method. + Note that the method is not physically altered, the modifications + are only seen by the CDI container.
+
+
Since:
+
4.0
+
See Also:
+
+ +
+
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      info

      +
      MethodInfo info()
      +
      Returns the MethodInfo corresponding to this transformed method.
      +
      +
      Specified by:
      +
      info in interface DeclarationConfig
      +
      Returns:
      +
      the MethodInfo corresponding to this transformed method, never null
      +
      +
      +
    • +
    • +
      +

      addAnnotation

      +
      MethodConfig addAnnotation(Class<? extends Annotation> annotationType)
      +
      Adds a marker annotation of given type to this method. + Does not allow configuring annotation members.
      +
      +
      Specified by:
      +
      addAnnotation in interface DeclarationConfig
      +
      Parameters:
      +
      annotationType - the annotation type, must not be null
      +
      Returns:
      +
      this configurator object, to allow fluent usage
      +
      +
      +
    • +
    • +
      +

      addAnnotation

      +
      MethodConfig addAnnotation(AnnotationInfo annotation)
      +
      Adds given annotation to this method. The AnnotationInfo can be obtained + from an annotation target, or constructed from scratch using AnnotationBuilder.
      +
      +
      Specified by:
      +
      addAnnotation in interface DeclarationConfig
      +
      Parameters:
      +
      annotation - the annotation to add to this method, must not be null
      +
      Returns:
      +
      this configurator object, to allow fluent usage
      +
      +
      +
    • +
    • +
      +

      addAnnotation

      +
      MethodConfig addAnnotation(Annotation annotation)
      +
      Adds given annotation to this method. The annotation instance is typically + a subclass of AnnotationLiteral.
      +
      +
      Specified by:
      +
      addAnnotation in interface DeclarationConfig
      +
      Parameters:
      +
      annotation - the annotation to add to this method, must not be null
      +
      Returns:
      +
      this configurator object, to allow fluent usage
      +
      +
      +
    • +
    • +
      +

      removeAnnotation

      +
      MethodConfig removeAnnotation(Predicate<AnnotationInfo> predicate)
      +
      Removes all annotations matching given predicate from this method.
      +
      +
      Specified by:
      +
      removeAnnotation in interface DeclarationConfig
      +
      Parameters:
      +
      predicate - an annotation predicate, must not be null
      +
      Returns:
      +
      this configurator object, to allow fluent usage
      +
      +
      +
    • +
    • +
      +

      removeAllAnnotations

      +
      MethodConfig removeAllAnnotations()
      +
      Removes all annotations from this method.
      +
      +
      Specified by:
      +
      removeAllAnnotations in interface DeclarationConfig
      +
      Returns:
      +
      this configurator object, to allow fluent usage
      +
      +
      +
    • +
    • +
      +

      parameters

      +
      List<ParameterConfig> parameters()
      +
      Returns a list of ParameterConfig objects for each parameter of this method.
      +
      +
      Returns:
      +
      immutable list of ParameterConfig objects, never null
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/ObserverInfo.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/ObserverInfo.html new file mode 100644 index 0000000000..9f7d35a1a3 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/ObserverInfo.html @@ -0,0 +1,338 @@ + + + + +ObserverInfo (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface ObserverInfo

+
+
+
+
public interface ObserverInfo
+
Observers are: + +
    +
  • observer methods
  • +
  • synthetic observers
  • +
+ + Observer methods directly correspond to a method declaration in program source code. + Synthetic observers don't and are instead defined through other mechanisms, such as + extensions.
+
+
Since:
+
4.0
+
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      eventType

      +
      Type eventType()
      +
      Returns the observed event type of this observer.
      +
      +
      Returns:
      +
      the observed event type of this observer, never null
      +
      +
      +
    • +
    • +
      +

      qualifiers

      +
      Collection<AnnotationInfo> qualifiers()
      +
      Returns a collection of observed event qualifiers, represented as AnnotationInfo.
      +
      +
      Returns:
      +
      immutable collection of observed event qualifiers, never null
      +
      +
      +
    • +
    • +
      +

      declaringClass

      +
      ClassInfo declaringClass()
      +
      Returns the class that declares this observer. + In case of synthetic observers, returns the class that was designated + as a declaring class during synthetic observer registration.
      +
      +
      Returns:
      +
      the class that declares this observer, never null
      +
      +
      +
    • +
    • +
      +

      observerMethod

      +
      MethodInfo observerMethod()
      +
      Returns the declaration of this observer method. + Returns null if this is a synthetic observer.
      +
      +
      Returns:
      +
      this observer method, or null if this is a synthetic observer
      +
      +
      +
    • +
    • +
      +

      eventParameter

      +
      ParameterInfo eventParameter()
      +
      Returns the event parameter of this observer method. + Returns null if this is a synthetic observer.
      +
      +
      Returns:
      +
      the event parameter of this observer method, or null if this is a synthetic observer
      +
      +
      +
    • +
    • +
      +

      bean

      +
      BeanInfo bean()
      +
      Returns the bean that declares this observer method. + Returns null if this is a synthetic observer.
      +
      +
      Returns:
      +
      the bean declaring this observer method, or null if this is a synthetic observer
      +
      +
      +
    • +
    • +
      +

      isSynthetic

      +
      boolean isSynthetic()
      +
      Returns whether this observer is synthetic.
      +
      +
      Returns:
      +
      whether this observer is synthetic
      +
      +
      +
    • +
    • +
      +

      priority

      +
      int priority()
      +
      Returns the priority of this observer. This is typically defined by adding + the @Priority annotation to the event parameter of the observer method. + If the annotation is not used, the default priority, as defined by the CDI specification, is returned,
      +
      +
      Returns:
      +
      the priority of this observer
      +
      +
      +
    • +
    • +
      +

      isAsync

      +
      boolean isAsync()
      +
      Returns whether this observer is asynchronous. For observer methods, this means whether + this observer method uses @ObservesAsync.
      +
      +
      Returns:
      +
      whether this observer is asynchronous
      +
      +
      +
    • +
    • +
      +

      reception

      +
      Reception reception()
      +
      Returns the reception type of this observer. Allows distinguishing + conditional observer methods from always notified observer methods. + Returns Reception.ALWAYS if this is a synthetic observer.
      +
      +
      Returns:
      +
      the reception type of this observer, never null
      +
      +
      +
    • +
    • +
      +

      transactionPhase

      +
      TransactionPhase transactionPhase()
      +
      Returns the transaction phase of this transactional observer. + Returns TransactionPhase.IN_PROGRESS if this is a regular synchronous observer. + Returns null if this is an asynchronous observer.
      +
      +
      Returns:
      +
      the transaction phase of this observer, or null if this is an asynchronous observer
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/ParameterConfig.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/ParameterConfig.html new file mode 100644 index 0000000000..b5af4eca92 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/ParameterConfig.html @@ -0,0 +1,273 @@ + + + + +ParameterConfig (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface ParameterConfig

+
+
+
+
All Superinterfaces:
+
DeclarationConfig
+
+
+
public interface ParameterConfig +extends DeclarationConfig
+
Allows adding annotations to and removing annotations from a method parameter. + Note that the method parameter is not physically altered, the modifications + are only seen by the CDI container.
+
+
Since:
+
4.0
+
See Also:
+
+ +
+
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      info

      + +
      Returns the ParameterInfo corresponding to this transformed method parameter.
      +
      +
      Specified by:
      +
      info in interface DeclarationConfig
      +
      Returns:
      +
      the ParameterInfo corresponding to this transformed method parameter, never null
      +
      +
      +
    • +
    • +
      +

      addAnnotation

      +
      ParameterConfig addAnnotation(Class<? extends Annotation> annotationType)
      +
      Adds a marker annotation of given type to this method parameter. + Does not allow configuring annotation members.
      +
      +
      Specified by:
      +
      addAnnotation in interface DeclarationConfig
      +
      Parameters:
      +
      annotationType - the annotation type, must not be null
      +
      Returns:
      +
      this configurator object, to allow fluent usage
      +
      +
      +
    • +
    • +
      +

      addAnnotation

      +
      ParameterConfig addAnnotation(AnnotationInfo annotation)
      +
      Adds given annotation to this method parameter. The AnnotationInfo can be obtained + from an annotation target, or constructed from scratch using AnnotationBuilder.
      +
      +
      Specified by:
      +
      addAnnotation in interface DeclarationConfig
      +
      Parameters:
      +
      annotation - the annotation to add to this method parameter, must not be null
      +
      Returns:
      +
      this configurator object, to allow fluent usage
      +
      +
      +
    • +
    • +
      +

      addAnnotation

      +
      ParameterConfig addAnnotation(Annotation annotation)
      +
      Adds given annotation to this method parameter. The annotation instance is typically + a subclass of AnnotationLiteral.
      +
      +
      Specified by:
      +
      addAnnotation in interface DeclarationConfig
      +
      Parameters:
      +
      annotation - the annotation to add to this method parameter, must not be null
      +
      Returns:
      +
      this configurator object, to allow fluent usage
      +
      +
      +
    • +
    • +
      +

      removeAnnotation

      +
      ParameterConfig removeAnnotation(Predicate<AnnotationInfo> predicate)
      +
      Removes all annotations matching given predicate from this method parameter.
      +
      +
      Specified by:
      +
      removeAnnotation in interface DeclarationConfig
      +
      Parameters:
      +
      predicate - an annotation predicate, must not be null
      +
      Returns:
      +
      this configurator object, to allow fluent usage
      +
      +
      +
    • +
    • +
      +

      removeAllAnnotations

      +
      ParameterConfig removeAllAnnotations()
      +
      Removes all annotations from this method parameter.
      +
      +
      Specified by:
      +
      removeAllAnnotations in interface DeclarationConfig
      +
      Returns:
      +
      this configurator object, to allow fluent usage
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/Parameters.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/Parameters.html new file mode 100644 index 0000000000..303732e124 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/Parameters.html @@ -0,0 +1,222 @@ + + + + +Parameters (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface Parameters

+
+
+
+
public interface Parameters
+
A String-keyed parameter map. The parameter mappings are defined + by a synthetic component builder. The CDI container passes the parameter map + to functions defined by the same synthetic component builder, whenever + it needs to invoke those functions. That is: + + + + Parameter values are transferred from the builder to the Parameters-accepting + function without a change. For example, if the builder defines an int parameter, + it must be looked up as int and cannot be looked up as long. +

+ Values of primitive types may be looked up either using the primitive type (such as + int.class), or using the corresponding wrapper type (Integer.class). + The return value is always of the wrapper type, so that null can be returned + when the parameter does not exist. Note that this does not apply to arrays + of primitive types; an int[] cannot be looked up as Integer[]. + This is because arrays are reference types and so null can be returned. +

+ Class-typed parameters are available as instances of Class, even if an instance + of ClassInfo was passed to the builder. +

+ Annotation-typed parameters are available as instances of the annotation type, + even if an instance of AnnotationInfo was passed to the builder. +

+ Invoker-typed parameters are available as instances of Invoker, even though + an instance of InvokerInfo was passed to the builder.

+
+
+
    + +
  • +
    +

    Method Summary

    +
    +
    +
    +
    +
    Modifier and Type
    +
    Method
    +
    Description
    +
    <T> T
    +
    get(String key, + Class<T> type)
    +
    +
    Returns the value of a parameter with given key.
    +
    +
    <T> T
    +
    get(String key, + Class<T> type, + T defaultValue)
    +
    +
    Returns the value of a parameter with given key.
    +
    +
    +
    +
    +
    +
  • +
+
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      get

      +
      <T> T get(String key, + Class<T> type)
      +
      Returns the value of a parameter with given key. The value is expected to be of given type.
      +
      +
      Type Parameters:
      +
      T - the parameter type
      +
      Parameters:
      +
      key - the parameter key, must not be null
      +
      type - the parameter type, must not be null
      +
      Returns:
      +
      the parameter value, or null if parameter with given key does not exist
      +
      Throws:
      +
      ClassCastException - if the parameter exists, but is of a different type
      +
      +
      +
    • +
    • +
      +

      get

      +
      <T> T get(String key, + Class<T> type, + T defaultValue)
      +
      Returns the value of a parameter with given key. The value is expected to be of given type. + If the parameter does not exist, returns defaultValue.
      +
      +
      Type Parameters:
      +
      T - the parameter type
      +
      Parameters:
      +
      key - the parameter key, must not be null
      +
      type - the parameter type, must not be null
      +
      defaultValue - the value to return if parameter with given key does not exist
      +
      Returns:
      +
      the parameter value, or defaultValue if parameter with given key does not exist
      +
      Throws:
      +
      ClassCastException - if the parameter exists, but is of a different type
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/Registration.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/Registration.html new file mode 100644 index 0000000000..6acdcb9488 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/Registration.html @@ -0,0 +1,187 @@ + + + + +Registration (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Annotation Interface Registration

+
+
+
+
@Target(METHOD) +@Retention(RUNTIME) +public @interface Registration
+
3rd phase of build compatible extension execution. + Allows observing registered beans and observers. +

+ This phase is executed twice. + For non-synthetic beans and observers, this phase is executed before synthesis. + For synthetic beans and observers, this phase is executed after synthesis. +

+ In the following text, the term expected types denotes the set of types defined by + the types member of the @Registration annotation. +

+ Methods annotated @Registration must declare exactly one parameter of one of these types: +

+ If a @Registration method has a parameter of type BeanInfo, the method is called once + for each bean whose set of bean types contains at least one expected type. +

+ If the @Registration method has a parameter of type InterceptorInfo, the method is called once + for each interceptor whose set of bean types contains at least one expected type. +

+ If the @Registration method has a parameter of type ObserverInfo, the method is called once + for each observer whose observed event type is assignable to at least one expected type. +

+ Note that InterceptorInfo is a subtype of BeanInfo, so if the method has a parameter + of type BeanInfo, it will be called for interceptors as well. +

+ If the @Registration method doesn't declare any parameter of one of these types, + or if it declares more than one, the container treats it as a definition error. +

+ Additionally, methods annotated @Registration may declare parameters of these types: +

+
+
Since:
+
4.0
+
+
+
+
    + +
  • +
    +

    Required Element Summary

    +
    Required Elements
    +
    +
    Modifier and Type
    +
    Required Element
    +
    Description
    +
    Class<?>[]
    + +
    +
    Defines the set of expected types.
    +
    +
    +
    +
  • +
+
+
+
    + +
  • +
    +

    Element Details

    +
      +
    • +
      +

      types

      +
      Class<?>[] types
      +
      Defines the set of expected types.
      +
      +
      Returns:
      +
      the set of expected types
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/ScannedClasses.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/ScannedClasses.html new file mode 100644 index 0000000000..a492e003e8 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/ScannedClasses.html @@ -0,0 +1,164 @@ + + + + +ScannedClasses (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface ScannedClasses

+
+
+
+
public interface ScannedClasses
+
Allows adding additional classes to the set of types discovered during type discovery. + Such classes will therefore be scanned during bean discovery. Annotations on these classes + can later be transformed using @Enhancement.
+
+
Since:
+
4.0
+
+
+
+
    + +
  • +
    +

    Method Summary

    +
    +
    +
    +
    +
    Modifier and Type
    +
    Method
    +
    Description
    +
    void
    +
    add(String className)
    +
    +
    Adds a class with given name to the set of types discovered during type discovery.
    +
    +
    +
    +
    +
    +
  • +
+
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      add

      +
      void add(String className)
      +
      Adds a class with given name to the set of types discovered during type discovery. + The class will therefore be scanned during bean discovery. +

      + Adding the same class multiple times, or adding a class that is automatically discovered + by the container, leads to non-portable behavior.

      +
      +
      Parameters:
      +
      className - binary name of the class, as defined by The Java™ Language Specification; + in other words, the class name as returned by Class.getName()
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/ScopeInfo.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/ScopeInfo.html new file mode 100644 index 0000000000..5288686290 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/ScopeInfo.html @@ -0,0 +1,195 @@ + + + + +ScopeInfo (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface ScopeInfo

+
+
+
+
public interface ScopeInfo
+
A scope of a bean. Scope type is an annotation, meta-annotated + @Scope or @NormalScope. + Lifecycle of beans with given scope is determined by a context.
+
+
Since:
+
4.0
+
+
+
+
    + +
  • +
    +

    Method Summary

    +
    +
    +
    +
    +
    Modifier and Type
    +
    Method
    +
    Description
    + + +
    +
    Returns the declaration of this scope annotation.
    +
    +
    boolean
    + +
    +
    Returns whether this scope type is normal.
    +
    +
    default String
    + +
    +
    Binary name of this scope annotation, as defined by The Java™ Language Specification; + in other words, the scope annotation name as returned by Class.getName().
    +
    +
    +
    +
    +
    +
  • +
+
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      annotation

      +
      ClassInfo annotation()
      +
      Returns the declaration of this scope annotation.
      +
      +
      Returns:
      +
      declaration of this scope annotation, never null
      +
      +
      +
    • +
    • +
      +

      name

      +
      default String name()
      +
      Binary name of this scope annotation, as defined by The Java™ Language Specification; + in other words, the scope annotation name as returned by Class.getName(). + Equivalent to annotation().name().
      +
      +
      Returns:
      +
      binary name of this scope annotation, never null
      +
      +
      +
    • +
    • +
      +

      isNormal

      +
      boolean isNormal()
      +
      Returns whether this scope type is normal. In other words, returns whether + this scope annotation is meta-annotated @NormalScope.
      +
      +
      Returns:
      +
      whether this scope type is normal
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/SkipIfPortableExtensionPresent.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/SkipIfPortableExtensionPresent.html new file mode 100644 index 0000000000..10b2b09ef0 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/SkipIfPortableExtensionPresent.html @@ -0,0 +1,160 @@ + + + + +SkipIfPortableExtensionPresent (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Annotation Interface SkipIfPortableExtensionPresent

+
+
+
+
@Target(TYPE) +@Retention(RUNTIME) +public @interface SkipIfPortableExtensionPresent
+
If a build compatible extension is annotated + @SkipIfPortableExtensionPresent, it is ignored when the CDI container + can execute portable extensions and determines that a portable extension + of given class is present. +

+ It is expected that the specified portable extension class will mirror the functionality + of the annotated build compatible extension. This allows portable extensions + and build compatible extensions to coexist.

+
+
Since:
+
4.0
+
+
+
+
    + +
  • +
    +

    Required Element Summary

    +
    Required Elements
    +
    +
    Modifier and Type
    +
    Required Element
    +
    Description
    +
    Class<? extends Extension>
    + +
    +
    A class implementing Extension that is expected to mirror the functionality of the annotated + build compatible extension.
    +
    +
    +
    +
  • +
+
+
+
    + +
  • +
    +

    Element Details

    +
      +
    • +
      +

      value

      +
      Class<? extends Extension> value
      +
      A class implementing Extension that is expected to mirror the functionality of the annotated + build compatible extension.
      +
      +
      Returns:
      +
      a portable extension class
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/StereotypeInfo.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/StereotypeInfo.html new file mode 100644 index 0000000000..7f9f7f8bbe --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/StereotypeInfo.html @@ -0,0 +1,235 @@ + + + + +StereotypeInfo (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface StereotypeInfo

+
+
+
+
public interface StereotypeInfo
+
A stereotype. May define default scope, + a set of interceptor bindings, + default priority, and whether all beans + with the stereotype are alternatives + or have default names.
+
+
Since:
+
4.0
+
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      defaultScope

      +
      ScopeInfo defaultScope()
      +
      Returns the default scope defined by this stereotype. + Returns null if this stereotype does not define a default scope.
      +
      +
      Returns:
      +
      the default scope or null
      +
      +
      +
    • +
    • +
      +

      interceptorBindings

      +
      Collection<AnnotationInfo> interceptorBindings()
      +
      Returns the set of interceptor binding annotations defined by this stereotype. + Returns an empty collection if this stereotype does not define any interceptor binding.
      +
      +
      Returns:
      +
      immutable collection of interceptor binding annotations, never null
      +
      +
      +
    • +
    • +
      +

      isAlternative

      +
      boolean isAlternative()
      +
      Returns whether this stereotype is meta-annotated @Alternative. + This means that all beans with this stereotype are alternatives.
      +
      +
      Returns:
      +
      whether this stereotype is meta-annotated @Alternative
      +
      +
      +
    • +
    • +
      +

      priority

      +
      Integer priority()
      +
      Returns the priority value this stereotype declares using the @Priority + meta-annotation. Beans with this stereotype will be enabled for the application and ordered using this priority + value (unless they declare priority explicitly). +

      + Returns null if this stereotype is not meta-annotated @Priority.

      +
      +
      Returns:
      +
      the @Priority value declared by this stereotype, or null + if this stereotype is not meta-annotated @Priority
      +
      +
      +
    • +
    • +
      +

      isNamed

      +
      boolean isNamed()
      +
      Returns whether this stereotype is meta-annotated @Named. + This means that all beans with this stereotype have default bean names.
      +
      +
      Returns:
      +
      whether this stereotype is meta-annotated @Named
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/Synthesis.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/Synthesis.html new file mode 100644 index 0000000000..737185224a --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/Synthesis.html @@ -0,0 +1,116 @@ + + + + +Synthesis (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Annotation Interface Synthesis

+
+
+
+
@Target(METHOD) +@Retention(RUNTIME) +public @interface Synthesis
+
4th phase of build compatible extension execution. + Allows registering synthetic beans and observers. +

+ Methods annotated @Synthesis may declare parameters of these types: +

+
+
Since:
+
4.0
+
+
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/SyntheticBeanBuilder.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/SyntheticBeanBuilder.html new file mode 100644 index 0000000000..88c9341a52 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/SyntheticBeanBuilder.html @@ -0,0 +1,997 @@ + + + + +SyntheticBeanBuilder (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface SyntheticBeanBuilder<T>

+
+
+
+
Type Parameters:
+
T - the bean class of this synthetic bean
+
+
+
public interface SyntheticBeanBuilder<T>
+
Builder for synthetic beans. + Instances are not reusable. For each synthetic bean, new instance + must be created by SyntheticComponents.addBean(Class).
+
+
Since:
+
4.0
+
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      type

      +
      SyntheticBeanBuilder<T> type(Class<?> type)
      +
      Adds type to the set of bean types of this synthetic bean. This method may be called + multiple times to add multiple bean types. +

      + If not called, the set of bean types of this synthetic bean will be a singleton set + containing java.lang.Object.

      +
      +
      Parameters:
      +
      type - the bean type, must not be null
      +
      Returns:
      +
      this SyntheticBeanBuilder
      +
      +
      +
    • +
    • +
      +

      type

      + +
      Adds type to the set of bean types of this synthetic bean. This method may be called + multiple times to add multiple bean types. +

      + If not called, the set of bean types of this synthetic bean will be a singleton set + containing java.lang.Object.

      +
      +
      Parameters:
      +
      type - the bean type, must not be null
      +
      Returns:
      +
      this SyntheticBeanBuilder
      +
      +
      +
    • +
    • +
      +

      type

      + +
      Adds type to the set of bean types of this synthetic bean. This method may be called + multiple times to add multiple bean types. +

      + If not called, the set of bean types of this synthetic bean will be a singleton set + containing java.lang.Object.

      +
      +
      Parameters:
      +
      type - the bean type, must not be null
      +
      Returns:
      +
      this SyntheticBeanBuilder
      +
      +
      +
    • +
    • +
      +

      qualifier

      +
      SyntheticBeanBuilder<T> qualifier(Class<? extends Annotation> annotationType)
      +
      Adds a marker annotation of given type to the set of qualifiers of this synthetic bean. + This method may be called multiple times to add multiple qualifiers. +

      + If not called, this synthetic bean will have the @Default qualifier + (and the @Any qualifier that all beans have).

      +
      +
      Parameters:
      +
      annotationType - the type of the marker annotation, must not be null
      +
      Returns:
      +
      this SyntheticBeanBuilder
      +
      +
      +
    • +
    • +
      +

      qualifier

      +
      SyntheticBeanBuilder<T> qualifier(AnnotationInfo qualifierAnnotation)
      +
      Adds given annotation to the set of qualifiers of this synthetic bean. + This method may be called multiple times to add multiple qualifiers. +

      + If not called, this synthetic bean will have the @Default qualifier + (and the @Any qualifier that all beans have).

      +
      +
      Parameters:
      +
      qualifierAnnotation - the annotation, must not be null
      +
      Returns:
      +
      this SyntheticBeanBuilder
      +
      +
      +
    • +
    • +
      +

      qualifier

      +
      SyntheticBeanBuilder<T> qualifier(Annotation qualifierAnnotation)
      +
      Adds given annotation to the set of qualifiers of this synthetic bean. + This method may be called multiple times to add multiple qualifiers. +

      + If not called, this synthetic bean will have the @Default qualifier + (and the @Any qualifier that all beans have).

      +
      +
      Parameters:
      +
      qualifierAnnotation - the annotation, must not be null
      +
      Returns:
      +
      this SyntheticBeanBuilder
      +
      +
      +
    • +
    • +
      +

      scope

      +
      SyntheticBeanBuilder<T> scope(Class<? extends Annotation> scopeAnnotation)
      +
      Sets the scope of this synthetic bean to given scope type. +

      + If not called, and if no stereotype is added that defines a scope, + this synthetic bean will be @Dependent.

      +
      +
      Parameters:
      +
      scopeAnnotation - the scope type, must not be null
      +
      Returns:
      +
      this SyntheticBeanBuilder
      +
      Throws:
      +
      IllegalStateException - if this method is called multiple times
      +
      +
      +
    • +
    • +
      +

      alternative

      +
      SyntheticBeanBuilder<T> alternative(boolean isAlternative)
      +
      Marks this synthetic bean as an alternative if desired. To make this synthetic bean + an enabled alternative, call both alternative(true) and priority(some priority). +

      + If this synthetic bean is an alternative, not setting a priority means + that it is not enabled, which is equivalent to not registering it at all. +

      + If not called, this synthetic bean will not be an alternative.

      +
      +
      Parameters:
      +
      isAlternative - whether this synthetic bean should be an alternative
      +
      Returns:
      +
      this SyntheticBeanBuilder
      +
      Throws:
      +
      IllegalStateException - if this method is called multiple times
      +
      +
      +
    • +
    • +
      +

      priority

      +
      SyntheticBeanBuilder<T> priority(int priority)
      +
      Sets a priority of this synthetic bean. To make this synthetic bean an enabled alternative, + call both alternative(true) and priority(some priority). +

      + If this synthetic bean is an alternative, not setting a priority means + that it is not enabled, which is equivalent to not registering it at all. +

      + If not called, this synthetic bean will not have a priority.

      +
      +
      Parameters:
      +
      priority - the priority of this synthetic bean
      +
      Returns:
      +
      this SyntheticBeanBuilder
      +
      Throws:
      +
      IllegalStateException - if this method is called multiple times
      +
      +
      +
    • +
    • +
      +

      name

      +
      SyntheticBeanBuilder<T> name(String beanName)
      +
      Sets the bean name of this synthetic bean. If beanName is null, + this synthetic bean will not have a name. +

      + If not called, this synthetic bean will not have a name.

      +
      +
      Parameters:
      +
      beanName - the bean name of this synthetic bean
      +
      Returns:
      +
      this SyntheticBeanBuilder
      +
      Throws:
      +
      IllegalStateException - if this method is called multiple times
      +
      +
      +
    • +
    • +
      +

      stereotype

      +
      SyntheticBeanBuilder<T> stereotype(Class<? extends Annotation> stereotypeAnnotation)
      +
      Adds stereotypeAnnotation to the set of stereotypes of this synthetic bean. + This method may be called multiple times to add multiple stereotypes. +

      + If not called, this synthetic bean will have no stereotype.

      +
      +
      Parameters:
      +
      stereotypeAnnotation - the stereotype, must not be null
      +
      Returns:
      +
      this SyntheticBeanBuilder
      +
      +
      +
    • +
    • +
      +

      stereotype

      +
      SyntheticBeanBuilder<T> stereotype(ClassInfo stereotypeAnnotation)
      +
      Adds stereotypeAnnotation to the set of stereotypes of this synthetic bean. + This method may be called multiple times to add multiple stereotypes. +

      + If not called, this synthetic bean will have no stereotype.

      +
      +
      Parameters:
      +
      stereotypeAnnotation - the stereotype, must not be null
      +
      Returns:
      +
      this SyntheticBeanBuilder
      +
      +
      +
    • +
    • +
      +

      withParam

      +
      SyntheticBeanBuilder<T> withParam(String key, + boolean value)
      +
      Adds a boolean-valued parameter to the parameter map. The parameter map is passed + to the creation and destruction + functions when a bean instance is created/destroyed.
      +
      +
      Parameters:
      +
      key - the parameter key, must not be null
      +
      value - the parameter value
      +
      Returns:
      +
      this SyntheticBeanBuilder
      +
      +
      +
    • +
    • +
      +

      withParam

      +
      SyntheticBeanBuilder<T> withParam(String key, + boolean[] value)
      +
      Adds a boolean array-valued parameter to the parameter map. The parameter map is passed + to the creation and destruction + functions when a bean instance is created/destroyed.
      +
      +
      Parameters:
      +
      key - the parameter key, must not be null
      +
      value - the parameter value
      +
      Returns:
      +
      this SyntheticBeanBuilder
      +
      +
      +
    • +
    • +
      +

      withParam

      +
      SyntheticBeanBuilder<T> withParam(String key, + int value)
      +
      Adds an int-valued parameter to the parameter map. The parameter map is passed + to the creation and destruction + functions when a bean instance is created/destroyed.
      +
      +
      Parameters:
      +
      key - the parameter key, must not be null
      +
      value - the parameter value
      +
      Returns:
      +
      this SyntheticBeanBuilder
      +
      +
      +
    • +
    • +
      +

      withParam

      +
      SyntheticBeanBuilder<T> withParam(String key, + int[] value)
      +
      Adds an int array-valued parameter to the parameter map. The parameter map is passed + to the creation and destruction + functions when a bean instance is created/destroyed.
      +
      +
      Parameters:
      +
      key - the parameter key, must not be null
      +
      value - the parameter value
      +
      Returns:
      +
      this SyntheticBeanBuilder
      +
      +
      +
    • +
    • +
      +

      withParam

      +
      SyntheticBeanBuilder<T> withParam(String key, + long value)
      +
      Adds a long-valued parameter to the parameter map. The parameter map is passed + to the creation and destruction + functions when a bean instance is created/destroyed.
      +
      +
      Parameters:
      +
      key - the parameter key, must not be null
      +
      value - the parameter value
      +
      Returns:
      +
      this SyntheticBeanBuilder
      +
      +
      +
    • +
    • +
      +

      withParam

      +
      SyntheticBeanBuilder<T> withParam(String key, + long[] value)
      +
      Adds a long array-valued parameter to the parameter map. The parameter map is passed + to the creation and destruction + functions when a bean instance is created/destroyed.
      +
      +
      Parameters:
      +
      key - the parameter key, must not be null
      +
      value - the parameter value
      +
      Returns:
      +
      this SyntheticBeanBuilder
      +
      +
      +
    • +
    • +
      +

      withParam

      +
      SyntheticBeanBuilder<T> withParam(String key, + double value)
      +
      Adds a double-valued parameter to the parameter map. The parameter map is passed + to the creation and destruction + functions when a bean instance is created/destroyed.
      +
      +
      Parameters:
      +
      key - the parameter key, must not be null
      +
      value - the parameter value
      +
      Returns:
      +
      this SyntheticBeanBuilder
      +
      +
      +
    • +
    • +
      +

      withParam

      +
      SyntheticBeanBuilder<T> withParam(String key, + double[] value)
      +
      Adds a double array-valued parameter to the parameter map. The parameter map is passed + to the creation and destruction + functions when a bean instance is created/destroyed.
      +
      +
      Parameters:
      +
      key - the parameter key, must not be null
      +
      value - the parameter value
      +
      Returns:
      +
      this SyntheticBeanBuilder
      +
      +
      +
    • +
    • +
      +

      withParam

      +
      SyntheticBeanBuilder<T> withParam(String key, + String value)
      +
      Adds a String-valued parameter to the parameter map. The parameter map is passed + to the creation and destruction + functions when a bean instance is created/destroyed.
      +
      +
      Parameters:
      +
      key - the parameter key, must not be null
      +
      value - the parameter value
      +
      Returns:
      +
      this SyntheticBeanBuilder
      +
      +
      +
    • +
    • +
      +

      withParam

      +
      SyntheticBeanBuilder<T> withParam(String key, + String[] value)
      +
      Adds a String array-valued parameter to the parameter map. The parameter map is passed + to the creation and destruction + functions when a bean instance is created/destroyed.
      +
      +
      Parameters:
      +
      key - the parameter key, must not be null
      +
      value - the parameter value
      +
      Returns:
      +
      this SyntheticBeanBuilder
      +
      +
      +
    • +
    • +
      +

      withParam

      +
      SyntheticBeanBuilder<T> withParam(String key, + Enum<?> value)
      +
      Adds an enum-valued parameter to the parameter map. The parameter map is passed + to the creation and destruction + functions when a bean instance is created/destroyed.
      +
      +
      Parameters:
      +
      key - the parameter key, must not be null
      +
      value - the parameter value
      +
      Returns:
      +
      this SyntheticBeanBuilder
      +
      +
      +
    • +
    • +
      +

      withParam

      +
      SyntheticBeanBuilder<T> withParam(String key, + Enum<?>[] value)
      +
      Adds an enum array-valued parameter to the parameter map. The parameter map is passed + to the creation and destruction + functions when a bean instance is created/destroyed.
      +
      +
      Parameters:
      +
      key - the parameter key, must not be null
      +
      value - the parameter value
      +
      Returns:
      +
      this SyntheticBeanBuilder
      +
      +
      +
    • +
    • +
      +

      withParam

      +
      SyntheticBeanBuilder<T> withParam(String key, + Class<?> value)
      +
      Adds a Class-valued parameter to the parameter map. The parameter map is passed + to the creation and destruction + functions when a bean instance is created/destroyed.
      +
      +
      Parameters:
      +
      key - the parameter key, must not be null
      +
      value - the parameter value
      +
      Returns:
      +
      this SyntheticBeanBuilder
      +
      +
      +
    • +
    • +
      +

      withParam

      +
      SyntheticBeanBuilder<T> withParam(String key, + ClassInfo value)
      +
      Adds a Class-valued parameter to the parameter map. The parameter map is passed + to the creation and destruction + functions when a bean instance is created/destroyed. +

      + When looked up from the parameter map in the creation/destruction function, the value will be + an instance of Class, not a ClassInfo.

      +
      +
      Parameters:
      +
      key - the parameter key, must not be null
      +
      value - the parameter value
      +
      Returns:
      +
      this SyntheticBeanBuilder
      +
      +
      +
    • +
    • +
      +

      withParam

      +
      SyntheticBeanBuilder<T> withParam(String key, + Class<?>[] value)
      +
      Adds a Class array-valued parameter to the parameter map. The parameter map is passed + to the creation and destruction + functions when a bean instance is created/destroyed.
      +
      +
      Parameters:
      +
      key - the parameter key, must not be null
      +
      value - the parameter value
      +
      Returns:
      +
      this SyntheticBeanBuilder
      +
      +
      +
    • +
    • +
      +

      withParam

      +
      SyntheticBeanBuilder<T> withParam(String key, + ClassInfo[] value)
      +
      Adds a Class array-valued parameter to the parameter map. The parameter map is passed + to the creation and destruction + functions when a bean instance is created/destroyed. +

      + When looked up from the parameter map in the creation/destruction function, the values will be + instances of Class, not ClassInfo.

      +
      +
      Parameters:
      +
      key - the parameter key, must not be null
      +
      value - the parameter value
      +
      Returns:
      +
      this SyntheticBeanBuilder
      +
      +
      +
    • +
    • +
      +

      withParam

      +
      SyntheticBeanBuilder<T> withParam(String key, + AnnotationInfo value)
      +
      Adds an annotation-valued parameter to the parameter map. The parameter map is passed + to the creation and destruction + functions when a bean instance is created/destroyed. +

      + When looked up from the parameter map in the creation/destruction function, the value will be + an instance of the annotation type, not an AnnotationInfo.

      +
      +
      Parameters:
      +
      key - the parameter key, must not be null
      +
      value - the parameter value
      +
      Returns:
      +
      this SyntheticBeanBuilder
      +
      +
      +
    • +
    • +
      +

      withParam

      +
      SyntheticBeanBuilder<T> withParam(String key, + Annotation value)
      +
      Adds an annotation-valued parameter to the parameter map. The parameter map is passed + to the creation and destruction + functions when a bean instance is created/destroyed.
      +
      +
      Parameters:
      +
      key - the parameter key, must not be null
      +
      value - the parameter value
      +
      Returns:
      +
      this SyntheticBeanBuilder
      +
      +
      +
    • +
    • +
      +

      withParam

      +
      SyntheticBeanBuilder<T> withParam(String key, + AnnotationInfo[] value)
      +
      Adds an annotation array-valued parameter to the parameter map. The parameter map is passed + to the creation and destruction + functions when a bean instance is created/destroyed. +

      + When looked up from the parameter map in the creation/destruction function, the values will be + instances of the corresponding annotation types, not AnnotationInfo.

      +
      +
      Parameters:
      +
      key - the parameter key, must not be null
      +
      value - the parameter value
      +
      Returns:
      +
      this SyntheticBeanBuilder
      +
      +
      +
    • +
    • +
      +

      withParam

      +
      SyntheticBeanBuilder<T> withParam(String key, + Annotation[] value)
      +
      Adds an annotation array-valued parameter to the parameter map. The parameter map is passed + to the creation and destruction + functions when a bean instance is created/destroyed.
      +
      +
      Parameters:
      +
      key - the parameter key, must not be null
      +
      value - the parameter value
      +
      Returns:
      +
      this SyntheticBeanBuilder
      +
      +
      +
    • +
    • +
      +

      withParam

      +
      SyntheticBeanBuilder<T> withParam(String key, + InvokerInfo value)
      +
      Adds an invoker-valued parameter to the parameter map. The parameter map is passed + to the creation and destruction + functions when a bean instance is created/destroyed. +

      + When looked up from the parameter map in the creation/destruction function, the value will be + an instance of Invoker, not an InvokerInfo.

      +
      +
      Parameters:
      +
      key - the parameter key, must not be null
      +
      value - the parameter value
      +
      Returns:
      +
      this SyntheticBeanBuilder
      +
      Since:
      +
      4.1
      +
      +
      +
    • +
    • +
      +

      withParam

      +
      SyntheticBeanBuilder<T> withParam(String key, + InvokerInfo[] value)
      +
      Adds an invoker array-valued parameter to the parameter map. The parameter map is passed + to the creation and destruction + functions when a bean instance is created/destroyed. +

      + When looked up from the parameter map in the creation/destruction function, the values will be + instances of Invoker, not InvokerInfo.

      +
      +
      Parameters:
      +
      key - the parameter key, must not be null
      +
      value - the parameter value
      +
      Returns:
      +
      this SyntheticBeanBuilder
      +
      Since:
      +
      4.1
      +
      +
      +
    • +
    • +
      +

      createWith

      +
      SyntheticBeanBuilder<T> createWith(Class<? extends SyntheticBeanCreator<T>> creatorClass)
      +
      Sets the class of the synthetic bean creation function. + CDI container will create an instance of the creation function every time when it needs + to obtain an instance of the synthetic bean. The class must be public and have + a public zero-parameter constructor; it must not be a bean. +

      + If not called, the synthetic bean registration will fail.

      +
      +
      Parameters:
      +
      creatorClass - the creation function class, must not be null
      +
      Returns:
      +
      this SyntheticBeanBuilder
      +
      Throws:
      +
      IllegalStateException - if this method is called multiple times
      +
      +
      +
    • +
    • +
      +

      disposeWith

      +
      SyntheticBeanBuilder<T> disposeWith(Class<? extends SyntheticBeanDisposer<T>> disposerClass)
      +
      Sets the class of the synthetic bean destruction function. + CDI container will create an instance of the destruction function every time when it needs + to destruction an instance of the synthetic bean. The class must be public and have + a public zero-parameter constructor; it must not be a bean. +

      + If not called, a noop destruction function will be used.

      +
      +
      Parameters:
      +
      disposerClass - the destruction function class, must not be null
      +
      Returns:
      +
      this SyntheticBeanBuilder
      +
      Throws:
      +
      IllegalStateException - if this method is called multiple times
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/SyntheticBeanCreator.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/SyntheticBeanCreator.html new file mode 100644 index 0000000000..a4d9bd833b --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/SyntheticBeanCreator.html @@ -0,0 +1,181 @@ + + + + +SyntheticBeanCreator (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface SyntheticBeanCreator<T>

+
+
+
+
Type Parameters:
+
T - the bean class of the synthetic bean
+
+
+
public interface SyntheticBeanCreator<T>
+
Creation function for a synthetic bean defined by SyntheticBeanBuilder. + CDI container will create an instance of the creation function every time when it needs + to obtain an instance of the synthetic bean. Implementations must be public + classes with a public zero-parameter constructor; they must not be beans.
+
+
Since:
+
4.0
+
+
+
+
    + +
  • +
    +

    Method Summary

    +
    +
    +
    +
    +
    Modifier and Type
    +
    Method
    +
    Description
    + +
    create(Instance<Object> lookup, + Parameters params)
    +
    +
    Creates an instance of the synthetic bean.
    +
    +
    +
    +
    +
    +
  • +
+
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      create

      +
      T create(Instance<Object> lookup, + Parameters params)
      +
      Creates an instance of the synthetic bean. + May only return null if the synthetic bean is @Dependent. +

      + The Instance parameter may be used to simulate producer method parameter injection. + However, @Dependent bean instances obtained from the Instance during execution + remain managed until the synthetic bean instance is destroyed. Therefore, implementations + are encouraged to destroy unneeded @Dependent bean instances obtained from the Instance. +

      + If the synthetic bean is @Dependent, the InjectionPoint to which it is injected + may be looked up from the Instance parameter. +

      + The parameter map contains the same values that were passed to the SyntheticBeanBuilder + that defined the synthetic bean.

      +
      +
      Parameters:
      +
      lookup - an Instance that can be used to lookup other beans, never null
      +
      params - the parameter map, never null
      +
      Returns:
      +
      an instance of the bean, may only be null if the synthetic bean is @Dependent
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/SyntheticBeanDisposer.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/SyntheticBeanDisposer.html new file mode 100644 index 0000000000..6222123d9a --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/SyntheticBeanDisposer.html @@ -0,0 +1,179 @@ + + + + +SyntheticBeanDisposer (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface SyntheticBeanDisposer<T>

+
+
+
+
Type Parameters:
+
T - the bean class of the synthetic bean
+
+
+
public interface SyntheticBeanDisposer<T>
+
Destruction function for a synthetic bean defined by SyntheticBeanBuilder. + CDI container will create an instance of the destruction function every time when it needs + to destroy an instance of the synthetic bean. Implementations must be public + classes with a public zero-parameter constructor; they must not be beans.
+
+
Since:
+
4.0
+
+
+
+
    + +
  • +
    +

    Method Summary

    +
    +
    +
    +
    +
    Modifier and Type
    +
    Method
    +
    Description
    +
    void
    +
    dispose(T instance, + Instance<Object> lookup, + Parameters params)
    +
    +
    Destroys an instance of the synthetic bean.
    +
    +
    +
    +
    +
    +
  • +
+
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      dispose

      +
      void dispose(T instance, + Instance<Object> lookup, + Parameters params)
      +
      Destroys an instance of the synthetic bean. +

      + The Instance parameter may be used to simulate disposer method parameter injection. + All @Dependent bean instances obtained from the Instance during execution + are destroyed when execution completes. +

      + Trying to look up InjectionPoint from the Instance parameter is invalid. +

      + The parameter map contains the same values that were passed to the SyntheticBeanBuilder + that defined the synthetic bean.

      +
      +
      Parameters:
      +
      instance - the synthetic bean instance, never null
      +
      lookup - an Instance that can be used to lookup other beans, never null
      +
      params - the parameter map, never null
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/SyntheticComponents.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/SyntheticComponents.html new file mode 100644 index 0000000000..1ac0355f91 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/SyntheticComponents.html @@ -0,0 +1,220 @@ + + + + +SyntheticComponents (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface SyntheticComponents

+
+
+
+
public interface SyntheticComponents
+
Allows registering synthetic beans and observers.
+
+
Since:
+
4.0
+
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      addBean

      +
      <T> SyntheticBeanBuilder<T> addBean(Class<T> implementationClass)
      +
      Creates a SyntheticBeanBuilder that allows configuring a new synthetic bean + of given implementationClass. The synthetic bean will be registered at the end of + the @Synthesis method.
      +
      +
      Type Parameters:
      +
      T - the implementation class of the new synthetic bean
      +
      Parameters:
      +
      implementationClass - the implementation class of the new synthetic bean, must not be null
      +
      Returns:
      +
      a new SyntheticBeanBuilder, never null
      +
      +
      +
    • +
    • +
      +

      addObserver

      +
      <T> SyntheticObserverBuilder<T> addObserver(Class<T> eventType)
      +
      Creates a SyntheticObserverBuilder that allows configuring a new synthetic observer + for given eventType. The synthetic observer will be registered at the end of + the @Synthesis method.
      +
      +
      Type Parameters:
      +
      T - the observed event type of the new synthetic observer
      +
      Parameters:
      +
      eventType - the observed event type of the new synthetic observer, must not be null
      +
      Returns:
      +
      a new SyntheticObserverBuilder, never null
      +
      +
      +
    • +
    • +
      +

      addObserver

      +
      <T> SyntheticObserverBuilder<T> addObserver(Type eventType)
      +
      Creates a SyntheticObserverBuilder that allows configuring a new synthetic observer + for given eventType. The synthetic observer will be registered at the end of + the @Synthesis method. +

      + This method is supposed to be called with explicitly provided type arguments. For example, + to define a synthetic observer of event type List<String>, one would call: + +

      
      + // types is of type Types
      + // syntheticComponents is of type SyntheticComponents
      + syntheticComponents.<List<String>>addObserver(types.parameterized(List.class, String.class))
      +     ...
      + 
      +
      +
      Type Parameters:
      +
      T - the observed event type of the new synthetic observer
      +
      Parameters:
      +
      eventType - the observed event type of the new synthetic observer, must not be null
      +
      Returns:
      +
      a new SyntheticObserverBuilder, never null
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/SyntheticObserver.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/SyntheticObserver.html new file mode 100644 index 0000000000..cab9958c2a --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/SyntheticObserver.html @@ -0,0 +1,174 @@ + + + + +SyntheticObserver (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface SyntheticObserver<T>

+
+
+
+
Type Parameters:
+
T - the observed event type of the synthetic observer
+
+
+
public interface SyntheticObserver<T>
+
The event notification function for a synthetic observer defined by SyntheticObserverBuilder. + CDI container will create an instance of the event notification function every time when it needs + to notify the synthetic observer. Implementations must be public classes with a public + zero-parameter constructor; they must not be beans.
+
+
Since:
+
4.0
+
+
+
+
    + +
  • +
    +

    Method Summary

    +
    +
    +
    +
    +
    Modifier and Type
    +
    Method
    +
    Description
    +
    void
    +
    observe(EventContext<T> event, + Parameters params)
    +
    +
    Consumes an event.
    +
    +
    +
    +
    +
    +
  • +
+
+
+
    + +
  • +
    +

    Method Details

    + +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/SyntheticObserverBuilder.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/SyntheticObserverBuilder.html new file mode 100644 index 0000000000..d3cabec174 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/SyntheticObserverBuilder.html @@ -0,0 +1,859 @@ + + + + +SyntheticObserverBuilder (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface SyntheticObserverBuilder<T>

+
+
+
+
Type Parameters:
+
T - the observed event type of this synthetic observer
+
+
+
public interface SyntheticObserverBuilder<T>
+
Builder for synthetic observers. + Instances are not reusable. For each synthetic observer, new instance + must be created by SyntheticComponents.addObserver(Class) + or SyntheticComponents.addObserver(Type).
+
+
Since:
+
4.0
+
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      declaringClass

      +
      SyntheticObserverBuilder<T> declaringClass(Class<?> declaringClass)
      +
      Sets the bean class that "declares" this synthetic observer. +

      + If not called, the class declaring the extension which creates this synthetic observer is used.

      +
      +
      Parameters:
      +
      declaringClass - bean class that "declares" this synthetic observer, must not be null
      +
      Returns:
      +
      this SyntheticObserverBuilder
      +
      Throws:
      +
      IllegalStateException - if this method is called multiple times
      +
      +
      +
    • +
    • +
      +

      declaringClass

      +
      SyntheticObserverBuilder<T> declaringClass(ClassInfo declaringClass)
      +
      Sets the bean class that "declares" this synthetic observer. +

      + If not called, the class declaring the extension which creates this synthetic observer is used.

      +
      +
      Parameters:
      +
      declaringClass - bean class that "declares" this synthetic observer, must not be null
      +
      Returns:
      +
      this SyntheticObserverBuilder
      +
      Throws:
      +
      IllegalStateException - if this method is called multiple times
      +
      +
      +
    • +
    • +
      +

      qualifier

      +
      SyntheticObserverBuilder<T> qualifier(Class<? extends Annotation> annotationType)
      +
      Adds a marker annotation of given type to the set of qualifiers of this synthetic observer. + This method may be called multiple times to add multiple qualifiers. +

      + If not called, this synthetic observer will have no qualifier.

      +
      +
      Parameters:
      +
      annotationType - the type of the marker annotation, must not be null
      +
      Returns:
      +
      this SyntheticObserverBuilder
      +
      +
      +
    • +
    • +
      +

      qualifier

      +
      SyntheticObserverBuilder<T> qualifier(AnnotationInfo qualifierAnnotation)
      +
      Adds given annotation to the set of qualifiers of this synthetic observer. + This method may be called multiple times to add multiple qualifiers. +

      + If not called, this synthetic observer will have no qualifier.

      +
      +
      Parameters:
      +
      qualifierAnnotation - the annotation, must not be null
      +
      Returns:
      +
      this SyntheticObserverBuilder
      +
      +
      +
    • +
    • +
      +

      qualifier

      +
      SyntheticObserverBuilder<T> qualifier(Annotation qualifierAnnotation)
      +
      Adds given annotation to the set of qualifiers of this synthetic observer. + This method may be called multiple times to add multiple qualifiers. +

      + If not called, this synthetic observer will have no qualifier.

      +
      +
      Parameters:
      +
      qualifierAnnotation - the annotation, must not be null
      +
      Returns:
      +
      this SyntheticObserverBuilder
      +
      +
      +
    • +
    • +
      +

      priority

      +
      SyntheticObserverBuilder<T> priority(int priority)
      +
      Sets a priority of this synthetic observer. +

      + If not called, this synthetic observer will have a default priority + of Priority.APPLICATION + 500.

      +
      +
      Parameters:
      +
      priority - the priority of this synthetic observer
      +
      Returns:
      +
      this SyntheticObserverBuilder
      +
      Throws:
      +
      IllegalStateException - if this method is called multiple times
      +
      +
      +
    • +
    • +
      +

      async

      +
      SyntheticObserverBuilder<T> async(boolean isAsync)
      +
      Marks this synthetic observer as asynchronous if desired. +

      + If not called, this synthetic observer will not be asynchronous.

      +
      +
      Parameters:
      +
      isAsync - whether this synthetic observer should be asynchronous
      +
      Returns:
      +
      this SyntheticObserverBuilder
      +
      Throws:
      +
      IllegalStateException - if this method is called multiple times
      +
      +
      +
    • +
    • +
      +

      transactionPhase

      +
      SyntheticObserverBuilder<T> transactionPhase(TransactionPhase transactionPhase)
      +
      Sets the TransactionPhase during which this synthetic observer should be notified. + If anything else than TransactionPhase.IN_PROGRESS is passed, this synthetic observer + will be a transactional observer. +

      + If not called, this synthetic observer will not be a transactional observer. + In other words, the default is TransactionPhase.IN_PROGRESS. +

      + Note that transactional observers cannot be asynchronous. If this synthetic observer + is configured to be both transactional and asynchronous, its registration will fail.

      +
      +
      Parameters:
      +
      transactionPhase - the TransactionPhase, must not be null
      +
      Returns:
      +
      this SyntheticObserverBuilder
      +
      Throws:
      +
      IllegalStateException - if this method is called multiple times
      +
      +
      +
    • +
    • +
      +

      withParam

      +
      SyntheticObserverBuilder<T> withParam(String key, + boolean value)
      +
      Adds a boolean-valued parameter to the parameter map. The parameter map is passed + to the event notification function when the event is fired.
      +
      +
      Parameters:
      +
      key - the parameter key, must not be null
      +
      value - the parameter value
      +
      Returns:
      +
      this SyntheticObserverBuilder
      +
      +
      +
    • +
    • +
      +

      withParam

      +
      SyntheticObserverBuilder<T> withParam(String key, + boolean[] value)
      +
      Adds a boolean array-valued parameter to the parameter map. The parameter map is passed + to the event notification function when the event is fired.
      +
      +
      Parameters:
      +
      key - the parameter key, must not be null
      +
      value - the parameter value
      +
      Returns:
      +
      this SyntheticObserverBuilder
      +
      +
      +
    • +
    • +
      +

      withParam

      +
      SyntheticObserverBuilder<T> withParam(String key, + int value)
      +
      Adds an int-valued parameter to the parameter map. The parameter map is passed + to the event notification function when the event is fired.
      +
      +
      Parameters:
      +
      key - the parameter key, must not be null
      +
      value - the parameter value
      +
      Returns:
      +
      this SyntheticObserverBuilder
      +
      +
      +
    • +
    • +
      +

      withParam

      +
      SyntheticObserverBuilder<T> withParam(String key, + int[] value)
      +
      Adds an int array-valued parameter to the parameter map. The parameter map is passed + to the event notification function when the event is fired.
      +
      +
      Parameters:
      +
      key - the parameter key, must not be null
      +
      value - the parameter value
      +
      Returns:
      +
      this SyntheticObserverBuilder
      +
      +
      +
    • +
    • +
      +

      withParam

      +
      SyntheticObserverBuilder<T> withParam(String key, + long value)
      +
      Adds a long-valued parameter to the parameter map. The parameter map is passed + to the event notification function when the event is fired.
      +
      +
      Parameters:
      +
      key - the parameter key, must not be null
      +
      value - the parameter value
      +
      Returns:
      +
      this SyntheticObserverBuilder
      +
      +
      +
    • +
    • +
      +

      withParam

      +
      SyntheticObserverBuilder<T> withParam(String key, + long[] value)
      +
      Adds a long array-valued parameter to the parameter map. The parameter map is passed + to the event notification function when the event is fired.
      +
      +
      Parameters:
      +
      key - the parameter key, must not be null
      +
      value - the parameter value
      +
      Returns:
      +
      this SyntheticObserverBuilder
      +
      +
      +
    • +
    • +
      +

      withParam

      +
      SyntheticObserverBuilder<T> withParam(String key, + double value)
      +
      Adds a double-valued parameter to the parameter map. The parameter map is passed + to the event notification function when the event is fired.
      +
      +
      Parameters:
      +
      key - the parameter key, must not be null
      +
      value - the parameter value
      +
      Returns:
      +
      this SyntheticObserverBuilder
      +
      +
      +
    • +
    • +
      +

      withParam

      +
      SyntheticObserverBuilder<T> withParam(String key, + double[] value)
      +
      Adds a double array-valued parameter to the parameter map. The parameter map is passed + to the event notification function when the event is fired.
      +
      +
      Parameters:
      +
      key - the parameter key, must not be null
      +
      value - the parameter value
      +
      Returns:
      +
      this SyntheticObserverBuilder
      +
      +
      +
    • +
    • +
      +

      withParam

      +
      SyntheticObserverBuilder<T> withParam(String key, + String value)
      +
      Adds a String-valued parameter to the parameter map. The parameter map is passed + to the event notification function when the event is fired.
      +
      +
      Parameters:
      +
      key - the parameter key, must not be null
      +
      value - the parameter value
      +
      Returns:
      +
      this SyntheticObserverBuilder
      +
      +
      +
    • +
    • +
      +

      withParam

      +
      SyntheticObserverBuilder<T> withParam(String key, + String[] value)
      +
      Adds a String array-valued parameter to the parameter map. The parameter map is passed + to the event notification function when the event is fired.
      +
      +
      Parameters:
      +
      key - the parameter key, must not be null
      +
      value - the parameter value
      +
      Returns:
      +
      this SyntheticObserverBuilder
      +
      +
      +
    • +
    • +
      +

      withParam

      +
      SyntheticObserverBuilder<T> withParam(String key, + Enum<?> value)
      +
      Adds an enum-valued parameter to the parameter map. The parameter map is passed + to the event notification function when the event is fired.
      +
      +
      Parameters:
      +
      key - the parameter key, must not be null
      +
      value - the parameter value
      +
      Returns:
      +
      this SyntheticObserverBuilder
      +
      +
      +
    • +
    • +
      +

      withParam

      +
      SyntheticObserverBuilder<T> withParam(String key, + Enum<?>[] value)
      +
      Adds an enum array-valued parameter to the parameter map. The parameter map is passed + to the event notification function when the event is fired.
      +
      +
      Parameters:
      +
      key - the parameter key, must not be null
      +
      value - the parameter value
      +
      Returns:
      +
      this SyntheticObserverBuilder
      +
      +
      +
    • +
    • +
      +

      withParam

      +
      SyntheticObserverBuilder<T> withParam(String key, + Class<?> value)
      +
      Adds a Class-valued parameter to the parameter map. The parameter map is passed + to the event notification function when the event is fired.
      +
      +
      Parameters:
      +
      key - the parameter key, must not be null
      +
      value - the parameter value
      +
      Returns:
      +
      this SyntheticObserverBuilder
      +
      +
      +
    • +
    • +
      +

      withParam

      +
      SyntheticObserverBuilder<T> withParam(String key, + ClassInfo value)
      +
      Adds a Class-valued parameter to the parameter map. The parameter map is passed + to the event notification function when the event is fired. +

      + When looked up from the parameter map in the event notification function, the value will be + an instance of Class, not a ClassInfo.

      +
      +
      Parameters:
      +
      key - the parameter key, must not be null
      +
      value - the parameter value
      +
      Returns:
      +
      this SyntheticObserverBuilder
      +
      +
      +
    • +
    • +
      +

      withParam

      +
      SyntheticObserverBuilder<T> withParam(String key, + Class<?>[] value)
      +
      Adds a Class array-valued parameter to the parameter map. The parameter map is passed + to the event notification function when the event is fired.
      +
      +
      Parameters:
      +
      key - the parameter key, must not be null
      +
      value - the parameter value
      +
      Returns:
      +
      this SyntheticObserverBuilder
      +
      +
      +
    • +
    • +
      +

      withParam

      +
      SyntheticObserverBuilder<T> withParam(String key, + ClassInfo[] value)
      +
      Adds a Class array-valued parameter to the parameter map. The parameter map is passed + to the event notification function when the event is fired. +

      + When looked up from the parameter map in the event notification function, the values will be + instances of Class, not ClassInfo.

      +
      +
      Parameters:
      +
      key - the parameter key, must not be null
      +
      value - the parameter value
      +
      Returns:
      +
      this SyntheticObserverBuilder
      +
      +
      +
    • +
    • +
      +

      withParam

      +
      SyntheticObserverBuilder<T> withParam(String key, + AnnotationInfo value)
      +
      Adds an annotation-valued parameter to the parameter map. The parameter map is passed + to the event notification function when the event is fired. +

      + When looked up from the parameter map in the event notification function, the value will be + an instance of the annotation type, not an AnnotationInfo.

      +
      +
      Parameters:
      +
      key - the parameter key, must not be null
      +
      value - the parameter value
      +
      Returns:
      +
      this SyntheticObserverBuilder
      +
      +
      +
    • +
    • +
      +

      withParam

      +
      SyntheticObserverBuilder<T> withParam(String key, + Annotation value)
      +
      Adds an annotation-valued parameter to the parameter map. The parameter map is passed + to the event notification function when the event is fired.
      +
      +
      Parameters:
      +
      key - the parameter key, must not be null
      +
      value - the parameter value
      +
      Returns:
      +
      this SyntheticObserverBuilder
      +
      +
      +
    • +
    • +
      +

      withParam

      +
      SyntheticObserverBuilder<T> withParam(String key, + AnnotationInfo[] value)
      +
      Adds an annotation array-valued parameter to the parameter map. The parameter map is passed + to the event notification function when the event is fired. +

      + When looked up from the parameter map in the event notification function, the values will be + instances of the corresponding annotation types, not AnnotationInfo.

      +
      +
      Parameters:
      +
      key - the parameter key, must not be null
      +
      value - the parameter value
      +
      Returns:
      +
      this SyntheticObserverBuilder
      +
      +
      +
    • +
    • +
      +

      withParam

      +
      SyntheticObserverBuilder<T> withParam(String key, + Annotation[] value)
      +
      Adds an annotation array-valued parameter to the parameter map. The parameter map is passed + to the event notification function when the event is fired.
      +
      +
      Parameters:
      +
      key - the parameter key, must not be null
      +
      value - the parameter value
      +
      Returns:
      +
      this SyntheticObserverBuilder
      +
      +
      +
    • +
    • +
      +

      withParam

      +
      SyntheticObserverBuilder<T> withParam(String key, + InvokerInfo value)
      +
      Adds an invoker-valued parameter to the parameter map. The parameter map is passed + to the event notification function when the event is fired. +

      + When looked up from the parameter map in the event notification function, the value will be + an instance of Invoker, not an InvokerInfo.

      +
      +
      Parameters:
      +
      key - the parameter key, must not be null
      +
      value - the parameter value
      +
      Returns:
      +
      this SyntheticBeanBuilder
      +
      Since:
      +
      4.1
      +
      +
      +
    • +
    • +
      +

      withParam

      +
      SyntheticObserverBuilder<T> withParam(String key, + InvokerInfo[] value)
      +
      Adds an invoker array-valued parameter to the parameter map. The parameter map is passed + to the event notification function when the event is fired. +

      + When looked up from the parameter map in the event notification function, the values will be + instances of Invoker, not InvokerInfo.

      +
      +
      Parameters:
      +
      key - the parameter key, must not be null
      +
      value - the parameter value
      +
      Returns:
      +
      this SyntheticBeanBuilder
      +
      Since:
      +
      4.1
      +
      +
      +
    • +
    • +
      +

      observeWith

      +
      SyntheticObserverBuilder<T> observeWith(Class<? extends SyntheticObserver<T>> observerClass)
      +
      Sets the class of the synthetic observer event notification function. + CDI container will create an instance of the event notification function every time when it needs + to notify the synthetic observer. The class must be public and have a public + zero-parameter constructor; it must not be a bean. +

      + If not called, the synthetic observer registration will fail.

      +
      +
      Parameters:
      +
      observerClass - the event notification function class, must not be null
      +
      Returns:
      +
      this SyntheticObserverBuilder
      +
      Throws:
      +
      IllegalStateException - if this method is called multiple times
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/Types.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/Types.html new file mode 100644 index 0000000000..f7b04fc091 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/Types.html @@ -0,0 +1,402 @@ + + + + +Types (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ + +
+
+
public interface Types
+
Factory for types. Allows creating representations of the void pseudo-type, + primitive types, class types, array types, parameterized types and wildcard types.
+
+
Since:
+
4.0
+
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      of

      +
      Type of(Class<?> clazz)
      +
      Returns a type from given class literal. + For example: +
        +
      • of(void.class): same as ofVoid()
      • +
      • of(int.class): same as ofPrimitive(PrimitiveKind.INT)
      • +
      • of(String.class): same as ofClass(... ClassInfo for String ...)
      • +
      • of(int[].class): same as ofArray(ofPrimitive(PrimitiveKind.INT), 1)
      • +
      • of(String[][].class): same as ofArray(ofClass(... ClassInfo for String ...), 2)
      • +
      +
      +
      Parameters:
      +
      clazz - the class literal, must not be null
      +
      Returns:
      +
      Type object representing the given class literal
      +
      +
      +
    • +
    • +
      +

      ofVoid

      +
      VoidType ofVoid()
      +
      Returns a VoidType, representing the void pseudo-type.
      +
      +
      Returns:
      +
      the VoidType, never null
      +
      +
      +
    • +
    • +
      +

      ofPrimitive

      + +
      Returns a PrimitiveType for the given kind of primitive type.
      +
      +
      Parameters:
      +
      kind - the primitive type kind, must not be null
      +
      Returns:
      +
      the PrimitiveType, never null
      +
      +
      +
    • +
    • +
      +

      ofClass

      +
      ClassType ofClass(String name)
      +
      Returns a ClassType for the given binary name, as defined by The Java™ Language Specification; + in other words, the class name as returned by Class.getName(). +

      + Note that this method returns ClassType, so name may only be a name of a class. + For primitives, use ofPrimitive(PrimitiveType.PrimitiveKind). For arrays, use ofArray(Type, int).

      +
      +
      Parameters:
      +
      name - the binary name of the class, must not be null
      +
      Returns:
      +
      the ClassType or null if the class is not present in any bean archive
      +
      +
      +
    • +
    • +
      +

      ofClass

      +
      ClassType ofClass(ClassInfo clazz)
      +
      Returns a ClassType for the given class declaration.
      +
      +
      Parameters:
      +
      clazz - the ClassInfo, must not be null
      +
      Returns:
      +
      the ClassType, never null
      +
      +
      +
    • +
    • +
      +

      ofArray

      +
      ArrayType ofArray(Type elementType, + int dimensions)
      +
      Returns an ArrayType for the given element type and number of dimensions. +

      + Note that this method accepts the element type of an array, even though ArrayType + uses a component type representation. For example, the component type of String[][] + is String[], while the element type is String.

      +
      +
      Parameters:
      +
      elementType - the element Type, must not be null
      +
      dimensions - the number of dimensions
      +
      Returns:
      +
      the ArrayType, never null
      +
      Throws:
      +
      IllegalArgumentException - if the element type is an array type, a wildcard type, or the void pseudo-type
      +
      +
      +
    • +
    • +
      +

      parameterized

      +
      ParameterizedType parameterized(Class<?> genericType, + Class<?>... typeArguments)
      +
      Returns a ParameterizedType for the given generic type and type arguments. + The array of type arguments must have the same shape as the generic type's + list of type parameters.
      +
      +
      Parameters:
      +
      genericType - the type to parameterize, must not be null
      +
      typeArguments - one or more type arguments
      +
      Returns:
      +
      the parameterized type, never null
      +
      Throws:
      +
      IllegalArgumentException - if given genericType is not generic or if the number of type arguments + does not match the number of type parameters declared by genericType
      +
      +
      +
    • +
    • +
      +

      parameterized

      +
      ParameterizedType parameterized(Class<?> genericType, + Type... typeArguments)
      +
      Returns a ParameterizedType for the given generic type and type arguments. + The array of type arguments must have the same shape as the generic type's + list of type parameters.
      +
      +
      Parameters:
      +
      genericType - the type to parameterize, must not be null
      +
      typeArguments - one or more type arguments
      +
      Returns:
      +
      the parameterized type, never null
      +
      Throws:
      +
      IllegalArgumentException - if given genericType is not generic or if the number of type arguments + does not match the number of type parameters declared by genericType
      +
      +
      +
    • +
    • +
      +

      parameterized

      +
      ParameterizedType parameterized(ClassType genericType, + Type... typeArguments)
      +
      Returns a ParameterizedType for the given generic type and type arguments. + The array of type arguments must have the same shape as the generic type's + list of type parameters.
      +
      +
      Parameters:
      +
      genericType - the type to parameterize, must not be null
      +
      typeArguments - one or more type arguments
      +
      Returns:
      +
      the parameterized type, never null
      +
      Throws:
      +
      IllegalArgumentException - if given genericType is not generic or if the number of type arguments + does not match the number of type parameters declared by genericType
      +
      +
      +
    • +
    • +
      +

      wildcardWithUpperBound

      +
      WildcardType wildcardWithUpperBound(Type upperBound)
      +
      Returns a WildcardType that represents an equivalent of ? extends upperBound. + Note that if upperBound represents the java.lang.Object type, then the result + is equivalent to wildcardUnbounded().
      +
      +
      Parameters:
      +
      upperBound - upper bound type, must not be null
      +
      Returns:
      +
      a WildcardType object representing a wildcard type with given upper bound
      +
      +
      +
    • +
    • +
      +

      wildcardWithLowerBound

      +
      WildcardType wildcardWithLowerBound(Type lowerBound)
      +
      Returns a WildcardType that represents an equivalent of ? super lowerBound.
      +
      +
      Parameters:
      +
      lowerBound - lower bound type, must not be null
      +
      Returns:
      +
      a WildcardType object representing a wildcard type with given upper bound
      +
      +
      +
    • +
    • +
      +

      wildcardUnbounded

      +
      WildcardType wildcardUnbounded()
      +
      Returns a WildcardType that represents an equivalent of ?.
      +
      +
      Returns:
      +
      a WildcardType object representing an unbounded wildcard type
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/Validation.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/Validation.html new file mode 100644 index 0000000000..df56d83687 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/Validation.html @@ -0,0 +1,115 @@ + + + + +Validation (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Annotation Interface Validation

+
+
+
+
@Target(METHOD) +@Retention(RUNTIME) +public @interface Validation
+
5th phase of build compatible extension execution. + Allows custom validation. +

+ Methods annotated @Validation may declare parameters of these types: +

+
+
Since:
+
4.0
+
+
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/class-use/AnnotationBuilder.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/class-use/AnnotationBuilder.html new file mode 100644 index 0000000000..5c625e5fc2 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/class-use/AnnotationBuilder.html @@ -0,0 +1,502 @@ + + + + +Uses of Interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilder

+
+
Packages that use AnnotationBuilder
+
+
Package
+
Description
+ +
+
+ The build compatible extension SPI.
+
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/class-use/AnnotationBuilderFactory.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/class-use/AnnotationBuilderFactory.html new file mode 100644 index 0000000000..c9a9353a0e --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/class-use/AnnotationBuilderFactory.html @@ -0,0 +1,92 @@ + + + + +Uses of Interface jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilderFactory (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.enterprise.inject.build.compatible.spi.AnnotationBuilderFactory

+
+
Packages that use AnnotationBuilderFactory
+
+
Package
+
Description
+ +
+
+ The build compatible extension SPI.
+
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/class-use/BeanInfo.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/class-use/BeanInfo.html new file mode 100644 index 0000000000..a74918f87d --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/class-use/BeanInfo.html @@ -0,0 +1,135 @@ + + + + +Uses of Interface jakarta.enterprise.inject.build.compatible.spi.BeanInfo (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.enterprise.inject.build.compatible.spi.BeanInfo

+
+
Packages that use BeanInfo
+
+
Package
+
Description
+ +
+
+ The build compatible extension SPI.
+
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/class-use/BuildCompatibleExtension.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/class-use/BuildCompatibleExtension.html new file mode 100644 index 0000000000..b9823ea2b3 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/class-use/BuildCompatibleExtension.html @@ -0,0 +1,64 @@ + + + + +Uses of Interface jakarta.enterprise.inject.build.compatible.spi.BuildCompatibleExtension (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.enterprise.inject.build.compatible.spi.BuildCompatibleExtension

+
+No usage of jakarta.enterprise.inject.build.compatible.spi.BuildCompatibleExtension
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/class-use/BuildServices.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/class-use/BuildServices.html new file mode 100644 index 0000000000..c754354467 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/class-use/BuildServices.html @@ -0,0 +1,94 @@ + + + + +Uses of Interface jakarta.enterprise.inject.build.compatible.spi.BuildServices (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.enterprise.inject.build.compatible.spi.BuildServices

+
+
Packages that use BuildServices
+
+
Package
+
Description
+ +
+
+ The build compatible extension SPI.
+
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/class-use/BuildServicesResolver.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/class-use/BuildServicesResolver.html new file mode 100644 index 0000000000..0174f5fa9a --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/class-use/BuildServicesResolver.html @@ -0,0 +1,64 @@ + + + + +Uses of Class jakarta.enterprise.inject.build.compatible.spi.BuildServicesResolver (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
jakarta.enterprise.inject.build.compatible.spi.BuildServicesResolver

+
+No usage of jakarta.enterprise.inject.build.compatible.spi.BuildServicesResolver
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/class-use/ClassConfig.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/class-use/ClassConfig.html new file mode 100644 index 0000000000..bcf9d86e64 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/class-use/ClassConfig.html @@ -0,0 +1,129 @@ + + + + +Uses of Interface jakarta.enterprise.inject.build.compatible.spi.ClassConfig (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.enterprise.inject.build.compatible.spi.ClassConfig

+
+
Packages that use ClassConfig
+
+
Package
+
Description
+ +
+
+ The build compatible extension SPI.
+
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/class-use/DeclarationConfig.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/class-use/DeclarationConfig.html new file mode 100644 index 0000000000..8825237df6 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/class-use/DeclarationConfig.html @@ -0,0 +1,140 @@ + + + + +Uses of Interface jakarta.enterprise.inject.build.compatible.spi.DeclarationConfig (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.enterprise.inject.build.compatible.spi.DeclarationConfig

+
+
Packages that use DeclarationConfig
+
+
Package
+
Description
+ +
+
+ The build compatible extension SPI.
+
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/class-use/Discovery.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/class-use/Discovery.html new file mode 100644 index 0000000000..cf0cd89aad --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/class-use/Discovery.html @@ -0,0 +1,64 @@ + + + + +Uses of Annotation Interface jakarta.enterprise.inject.build.compatible.spi.Discovery (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Annotation Interface
jakarta.enterprise.inject.build.compatible.spi.Discovery

+
+No usage of jakarta.enterprise.inject.build.compatible.spi.Discovery
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/class-use/DisposerInfo.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/class-use/DisposerInfo.html new file mode 100644 index 0000000000..214746267b --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/class-use/DisposerInfo.html @@ -0,0 +1,94 @@ + + + + +Uses of Interface jakarta.enterprise.inject.build.compatible.spi.DisposerInfo (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.enterprise.inject.build.compatible.spi.DisposerInfo

+
+
Packages that use DisposerInfo
+
+
Package
+
Description
+ +
+
+ The build compatible extension SPI.
+
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/class-use/Enhancement.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/class-use/Enhancement.html new file mode 100644 index 0000000000..1ffad48513 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/class-use/Enhancement.html @@ -0,0 +1,64 @@ + + + + +Uses of Annotation Interface jakarta.enterprise.inject.build.compatible.spi.Enhancement (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Annotation Interface
jakarta.enterprise.inject.build.compatible.spi.Enhancement

+
+No usage of jakarta.enterprise.inject.build.compatible.spi.Enhancement
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/class-use/FieldConfig.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/class-use/FieldConfig.html new file mode 100644 index 0000000000..3d74db5fed --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/class-use/FieldConfig.html @@ -0,0 +1,126 @@ + + + + +Uses of Interface jakarta.enterprise.inject.build.compatible.spi.FieldConfig (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.enterprise.inject.build.compatible.spi.FieldConfig

+
+
Packages that use FieldConfig
+
+
Package
+
Description
+ +
+
+ The build compatible extension SPI.
+
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/class-use/InjectionPointInfo.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/class-use/InjectionPointInfo.html new file mode 100644 index 0000000000..44bae9f57e --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/class-use/InjectionPointInfo.html @@ -0,0 +1,94 @@ + + + + +Uses of Interface jakarta.enterprise.inject.build.compatible.spi.InjectionPointInfo (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.enterprise.inject.build.compatible.spi.InjectionPointInfo

+
+
Packages that use InjectionPointInfo
+
+
Package
+
Description
+ +
+
+ The build compatible extension SPI.
+
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/class-use/InterceptorInfo.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/class-use/InterceptorInfo.html new file mode 100644 index 0000000000..05c8689627 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/class-use/InterceptorInfo.html @@ -0,0 +1,97 @@ + + + + +Uses of Interface jakarta.enterprise.inject.build.compatible.spi.InterceptorInfo (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.enterprise.inject.build.compatible.spi.InterceptorInfo

+
+
Packages that use InterceptorInfo
+
+
Package
+
Description
+ +
+
+ The build compatible extension SPI.
+
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/class-use/InvokerFactory.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/class-use/InvokerFactory.html new file mode 100644 index 0000000000..7801971ae6 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/class-use/InvokerFactory.html @@ -0,0 +1,64 @@ + + + + +Uses of Interface jakarta.enterprise.inject.build.compatible.spi.InvokerFactory (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.enterprise.inject.build.compatible.spi.InvokerFactory

+
+No usage of jakarta.enterprise.inject.build.compatible.spi.InvokerFactory
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/class-use/InvokerInfo.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/class-use/InvokerInfo.html new file mode 100644 index 0000000000..70df040caf --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/class-use/InvokerInfo.html @@ -0,0 +1,125 @@ + + + + +Uses of Interface jakarta.enterprise.inject.build.compatible.spi.InvokerInfo (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.enterprise.inject.build.compatible.spi.InvokerInfo

+
+
Packages that use InvokerInfo
+
+
Package
+
Description
+ +
+
+ The build compatible extension SPI.
+
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/class-use/Messages.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/class-use/Messages.html new file mode 100644 index 0000000000..41d38895fa --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/class-use/Messages.html @@ -0,0 +1,64 @@ + + + + +Uses of Interface jakarta.enterprise.inject.build.compatible.spi.Messages (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.enterprise.inject.build.compatible.spi.Messages

+
+No usage of jakarta.enterprise.inject.build.compatible.spi.Messages
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/class-use/MetaAnnotations.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/class-use/MetaAnnotations.html new file mode 100644 index 0000000000..c66f923919 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/class-use/MetaAnnotations.html @@ -0,0 +1,64 @@ + + + + +Uses of Interface jakarta.enterprise.inject.build.compatible.spi.MetaAnnotations (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.enterprise.inject.build.compatible.spi.MetaAnnotations

+
+No usage of jakarta.enterprise.inject.build.compatible.spi.MetaAnnotations
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/class-use/MethodConfig.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/class-use/MethodConfig.html new file mode 100644 index 0000000000..c402dce564 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/class-use/MethodConfig.html @@ -0,0 +1,132 @@ + + + + +Uses of Interface jakarta.enterprise.inject.build.compatible.spi.MethodConfig (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.enterprise.inject.build.compatible.spi.MethodConfig

+
+
Packages that use MethodConfig
+
+
Package
+
Description
+ +
+
+ The build compatible extension SPI.
+
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/class-use/ObserverInfo.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/class-use/ObserverInfo.html new file mode 100644 index 0000000000..ecc9b31323 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/class-use/ObserverInfo.html @@ -0,0 +1,107 @@ + + + + +Uses of Interface jakarta.enterprise.inject.build.compatible.spi.ObserverInfo (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.enterprise.inject.build.compatible.spi.ObserverInfo

+
+
Packages that use ObserverInfo
+
+
Package
+
Description
+ +
+
+ The build compatible extension SPI.
+
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/class-use/ParameterConfig.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/class-use/ParameterConfig.html new file mode 100644 index 0000000000..0879357714 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/class-use/ParameterConfig.html @@ -0,0 +1,125 @@ + + + + +Uses of Interface jakarta.enterprise.inject.build.compatible.spi.ParameterConfig (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.enterprise.inject.build.compatible.spi.ParameterConfig

+
+
Packages that use ParameterConfig
+
+
Package
+
Description
+ +
+
+ The build compatible extension SPI.
+
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/class-use/Parameters.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/class-use/Parameters.html new file mode 100644 index 0000000000..f42ccbdc4a --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/class-use/Parameters.html @@ -0,0 +1,108 @@ + + + + +Uses of Interface jakarta.enterprise.inject.build.compatible.spi.Parameters (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.enterprise.inject.build.compatible.spi.Parameters

+
+
Packages that use Parameters
+
+
Package
+
Description
+ +
+
+ The build compatible extension SPI.
+
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/class-use/Registration.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/class-use/Registration.html new file mode 100644 index 0000000000..46722f8fcb --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/class-use/Registration.html @@ -0,0 +1,64 @@ + + + + +Uses of Annotation Interface jakarta.enterprise.inject.build.compatible.spi.Registration (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Annotation Interface
jakarta.enterprise.inject.build.compatible.spi.Registration

+
+No usage of jakarta.enterprise.inject.build.compatible.spi.Registration
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/class-use/ScannedClasses.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/class-use/ScannedClasses.html new file mode 100644 index 0000000000..3a83bb52af --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/class-use/ScannedClasses.html @@ -0,0 +1,64 @@ + + + + +Uses of Interface jakarta.enterprise.inject.build.compatible.spi.ScannedClasses (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.enterprise.inject.build.compatible.spi.ScannedClasses

+
+No usage of jakarta.enterprise.inject.build.compatible.spi.ScannedClasses
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/class-use/ScopeInfo.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/class-use/ScopeInfo.html new file mode 100644 index 0000000000..9df9240264 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/class-use/ScopeInfo.html @@ -0,0 +1,99 @@ + + + + +Uses of Interface jakarta.enterprise.inject.build.compatible.spi.ScopeInfo (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.enterprise.inject.build.compatible.spi.ScopeInfo

+
+
Packages that use ScopeInfo
+
+
Package
+
Description
+ +
+
+ The build compatible extension SPI.
+
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/class-use/SkipIfPortableExtensionPresent.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/class-use/SkipIfPortableExtensionPresent.html new file mode 100644 index 0000000000..86fe56ba6a --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/class-use/SkipIfPortableExtensionPresent.html @@ -0,0 +1,64 @@ + + + + +Uses of Annotation Interface jakarta.enterprise.inject.build.compatible.spi.SkipIfPortableExtensionPresent (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Annotation Interface
jakarta.enterprise.inject.build.compatible.spi.SkipIfPortableExtensionPresent

+
+No usage of jakarta.enterprise.inject.build.compatible.spi.SkipIfPortableExtensionPresent
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/class-use/StereotypeInfo.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/class-use/StereotypeInfo.html new file mode 100644 index 0000000000..d3f5e1be68 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/class-use/StereotypeInfo.html @@ -0,0 +1,94 @@ + + + + +Uses of Interface jakarta.enterprise.inject.build.compatible.spi.StereotypeInfo (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.enterprise.inject.build.compatible.spi.StereotypeInfo

+
+
Packages that use StereotypeInfo
+
+
Package
+
Description
+ +
+
+ The build compatible extension SPI.
+
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/class-use/Synthesis.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/class-use/Synthesis.html new file mode 100644 index 0000000000..4f27ae4ccf --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/class-use/Synthesis.html @@ -0,0 +1,64 @@ + + + + +Uses of Annotation Interface jakarta.enterprise.inject.build.compatible.spi.Synthesis (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Annotation Interface
jakarta.enterprise.inject.build.compatible.spi.Synthesis

+
+No usage of jakarta.enterprise.inject.build.compatible.spi.Synthesis
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/class-use/SyntheticBeanBuilder.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/class-use/SyntheticBeanBuilder.html new file mode 100644 index 0000000000..dc4c78ddf6 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/class-use/SyntheticBeanBuilder.html @@ -0,0 +1,297 @@ + + + + +Uses of Interface jakarta.enterprise.inject.build.compatible.spi.SyntheticBeanBuilder (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.enterprise.inject.build.compatible.spi.SyntheticBeanBuilder

+
+
Packages that use SyntheticBeanBuilder
+
+
Package
+
Description
+ +
+
+ The build compatible extension SPI.
+
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/class-use/SyntheticBeanCreator.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/class-use/SyntheticBeanCreator.html new file mode 100644 index 0000000000..bf5c0a8b98 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/class-use/SyntheticBeanCreator.html @@ -0,0 +1,94 @@ + + + + +Uses of Interface jakarta.enterprise.inject.build.compatible.spi.SyntheticBeanCreator (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.enterprise.inject.build.compatible.spi.SyntheticBeanCreator

+
+
Packages that use SyntheticBeanCreator
+
+
Package
+
Description
+ +
+
+ The build compatible extension SPI.
+
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/class-use/SyntheticBeanDisposer.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/class-use/SyntheticBeanDisposer.html new file mode 100644 index 0000000000..b2ff2bd721 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/class-use/SyntheticBeanDisposer.html @@ -0,0 +1,94 @@ + + + + +Uses of Interface jakarta.enterprise.inject.build.compatible.spi.SyntheticBeanDisposer (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.enterprise.inject.build.compatible.spi.SyntheticBeanDisposer

+
+
Packages that use SyntheticBeanDisposer
+
+
Package
+
Description
+ +
+
+ The build compatible extension SPI.
+
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/class-use/SyntheticComponents.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/class-use/SyntheticComponents.html new file mode 100644 index 0000000000..71cff07b85 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/class-use/SyntheticComponents.html @@ -0,0 +1,64 @@ + + + + +Uses of Interface jakarta.enterprise.inject.build.compatible.spi.SyntheticComponents (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.enterprise.inject.build.compatible.spi.SyntheticComponents

+
+No usage of jakarta.enterprise.inject.build.compatible.spi.SyntheticComponents
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/class-use/SyntheticObserver.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/class-use/SyntheticObserver.html new file mode 100644 index 0000000000..26dadafbc1 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/class-use/SyntheticObserver.html @@ -0,0 +1,94 @@ + + + + +Uses of Interface jakarta.enterprise.inject.build.compatible.spi.SyntheticObserver (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.enterprise.inject.build.compatible.spi.SyntheticObserver

+
+
Packages that use SyntheticObserver
+
+
Package
+
Description
+ +
+
+ The build compatible extension SPI.
+
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/class-use/SyntheticObserverBuilder.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/class-use/SyntheticObserverBuilder.html new file mode 100644 index 0000000000..2bb3237642 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/class-use/SyntheticObserverBuilder.html @@ -0,0 +1,278 @@ + + + + +Uses of Interface jakarta.enterprise.inject.build.compatible.spi.SyntheticObserverBuilder (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.enterprise.inject.build.compatible.spi.SyntheticObserverBuilder

+
+
Packages that use SyntheticObserverBuilder
+
+
Package
+
Description
+ +
+
+ The build compatible extension SPI.
+
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/class-use/Types.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/class-use/Types.html new file mode 100644 index 0000000000..8a75cbc119 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/class-use/Types.html @@ -0,0 +1,64 @@ + + + + +Uses of Interface jakarta.enterprise.inject.build.compatible.spi.Types (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.enterprise.inject.build.compatible.spi.Types

+
+No usage of jakarta.enterprise.inject.build.compatible.spi.Types
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/class-use/Validation.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/class-use/Validation.html new file mode 100644 index 0000000000..76cd6edb03 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/class-use/Validation.html @@ -0,0 +1,64 @@ + + + + +Uses of Annotation Interface jakarta.enterprise.inject.build.compatible.spi.Validation (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Annotation Interface
jakarta.enterprise.inject.build.compatible.spi.Validation

+
+No usage of jakarta.enterprise.inject.build.compatible.spi.Validation
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/package-summary.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/package-summary.html new file mode 100644 index 0000000000..dc3c6b7e5d --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/package-summary.html @@ -0,0 +1,279 @@ + + + + +jakarta.enterprise.inject.build.compatible.spi (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Package jakarta.enterprise.inject.build.compatible.spi

+
+
+
package jakarta.enterprise.inject.build.compatible.spi
+
+

+ The build compatible extension SPI. See: +

+ +
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/package-tree.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/package-tree.html new file mode 100644 index 0000000000..eb3c61875f --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/package-tree.html @@ -0,0 +1,133 @@ + + + + +jakarta.enterprise.inject.build.compatible.spi Class Hierarchy (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Hierarchy For Package jakarta.enterprise.inject.build.compatible.spi

+
+Package Hierarchies: + +
+

Class Hierarchy

+ +
+
+

Interface Hierarchy

+ +
+
+

Annotation Interface Hierarchy

+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/package-use.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/package-use.html new file mode 100644 index 0000000000..f0af7909c3 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/build/compatible/spi/package-use.html @@ -0,0 +1,193 @@ + + + + +Uses of Package jakarta.enterprise.inject.build.compatible.spi (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Package
jakarta.enterprise.inject.build.compatible.spi

+
+ +
+
Package
+
Description
+ +
+
+ The build compatible extension SPI.
+
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/class-use/Alternative.Literal.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/class-use/Alternative.Literal.html new file mode 100644 index 0000000000..4917d5f161 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/class-use/Alternative.Literal.html @@ -0,0 +1,91 @@ + + + + +Uses of Class jakarta.enterprise.inject.Alternative.Literal (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
jakarta.enterprise.inject.Alternative.Literal

+
+
Packages that use Alternative.Literal
+
+
Package
+
Description
+ +
 
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/class-use/Alternative.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/class-use/Alternative.html new file mode 100644 index 0000000000..17bc308ed5 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/class-use/Alternative.html @@ -0,0 +1,64 @@ + + + + +Uses of Annotation Interface jakarta.enterprise.inject.Alternative (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Annotation Interface
jakarta.enterprise.inject.Alternative

+
+No usage of jakarta.enterprise.inject.Alternative
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/class-use/AmbiguousResolutionException.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/class-use/AmbiguousResolutionException.html new file mode 100644 index 0000000000..61dd49fe63 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/class-use/AmbiguousResolutionException.html @@ -0,0 +1,64 @@ + + + + +Uses of Class jakarta.enterprise.inject.AmbiguousResolutionException (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
jakarta.enterprise.inject.AmbiguousResolutionException

+
+No usage of jakarta.enterprise.inject.AmbiguousResolutionException
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/class-use/Any.Literal.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/class-use/Any.Literal.html new file mode 100644 index 0000000000..af8de55dcd --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/class-use/Any.Literal.html @@ -0,0 +1,91 @@ + + + + +Uses of Class jakarta.enterprise.inject.Any.Literal (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
jakarta.enterprise.inject.Any.Literal

+
+
Packages that use Any.Literal
+
+
Package
+
Description
+ +
 
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/class-use/Any.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/class-use/Any.html new file mode 100644 index 0000000000..36a417b05b --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/class-use/Any.html @@ -0,0 +1,64 @@ + + + + +Uses of Annotation Interface jakarta.enterprise.inject.Any (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Annotation Interface
jakarta.enterprise.inject.Any

+
+No usage of jakarta.enterprise.inject.Any
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/class-use/CreationException.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/class-use/CreationException.html new file mode 100644 index 0000000000..cc69aec327 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/class-use/CreationException.html @@ -0,0 +1,64 @@ + + + + +Uses of Class jakarta.enterprise.inject.CreationException (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
jakarta.enterprise.inject.CreationException

+
+No usage of jakarta.enterprise.inject.CreationException
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/class-use/Decorated.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/class-use/Decorated.html new file mode 100644 index 0000000000..86ee162eb3 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/class-use/Decorated.html @@ -0,0 +1,64 @@ + + + + +Uses of Annotation Interface jakarta.enterprise.inject.Decorated (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Annotation Interface
jakarta.enterprise.inject.Decorated

+
+No usage of jakarta.enterprise.inject.Decorated
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/class-use/Default.Literal.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/class-use/Default.Literal.html new file mode 100644 index 0000000000..cf5c9443f8 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/class-use/Default.Literal.html @@ -0,0 +1,91 @@ + + + + +Uses of Class jakarta.enterprise.inject.Default.Literal (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
jakarta.enterprise.inject.Default.Literal

+
+
Packages that use Default.Literal
+
+
Package
+
Description
+ +
 
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/class-use/Default.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/class-use/Default.html new file mode 100644 index 0000000000..dbd516d283 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/class-use/Default.html @@ -0,0 +1,64 @@ + + + + +Uses of Annotation Interface jakarta.enterprise.inject.Default (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Annotation Interface
jakarta.enterprise.inject.Default

+
+No usage of jakarta.enterprise.inject.Default
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/class-use/Disposes.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/class-use/Disposes.html new file mode 100644 index 0000000000..de66ee5c8f --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/class-use/Disposes.html @@ -0,0 +1,64 @@ + + + + +Uses of Annotation Interface jakarta.enterprise.inject.Disposes (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Annotation Interface
jakarta.enterprise.inject.Disposes

+
+No usage of jakarta.enterprise.inject.Disposes
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/class-use/IllegalProductException.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/class-use/IllegalProductException.html new file mode 100644 index 0000000000..de34c1f687 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/class-use/IllegalProductException.html @@ -0,0 +1,64 @@ + + + + +Uses of Class jakarta.enterprise.inject.IllegalProductException (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
jakarta.enterprise.inject.IllegalProductException

+
+No usage of jakarta.enterprise.inject.IllegalProductException
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/class-use/InjectionException.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/class-use/InjectionException.html new file mode 100644 index 0000000000..fb6a4bb70d --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/class-use/InjectionException.html @@ -0,0 +1,125 @@ + + + + +Uses of Class jakarta.enterprise.inject.InjectionException (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
jakarta.enterprise.inject.InjectionException

+
+
Packages that use InjectionException
+
+
Package
+
Description
+ +
 
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/class-use/Instance.Handle.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/class-use/Instance.Handle.html new file mode 100644 index 0000000000..30b9965c9f --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/class-use/Instance.Handle.html @@ -0,0 +1,109 @@ + + + + +Uses of Interface jakarta.enterprise.inject.Instance.Handle (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.enterprise.inject.Instance.Handle

+
+
Packages that use Instance.Handle
+
+
Package
+
Description
+ +
 
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/class-use/Instance.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/class-use/Instance.html new file mode 100644 index 0000000000..945bbd55c4 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/class-use/Instance.html @@ -0,0 +1,208 @@ + + + + +Uses of Interface jakarta.enterprise.inject.Instance (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.enterprise.inject.Instance

+
+
Packages that use Instance
+
+
Package
+
Description
+ +
 
+ +
+
+ The build compatible extension SPI.
+
+ +
 
+ +
+
+ The portable extension integration SPI.
+
+ +
 
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/class-use/Intercepted.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/class-use/Intercepted.html new file mode 100644 index 0000000000..948355ebf3 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/class-use/Intercepted.html @@ -0,0 +1,64 @@ + + + + +Uses of Annotation Interface jakarta.enterprise.inject.Intercepted (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Annotation Interface
jakarta.enterprise.inject.Intercepted

+
+No usage of jakarta.enterprise.inject.Intercepted
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/class-use/Model.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/class-use/Model.html new file mode 100644 index 0000000000..0b22258204 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/class-use/Model.html @@ -0,0 +1,64 @@ + + + + +Uses of Annotation Interface jakarta.enterprise.inject.Model (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Annotation Interface
jakarta.enterprise.inject.Model

+
+No usage of jakarta.enterprise.inject.Model
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/class-use/Produces.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/class-use/Produces.html new file mode 100644 index 0000000000..8825897bd1 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/class-use/Produces.html @@ -0,0 +1,64 @@ + + + + +Uses of Annotation Interface jakarta.enterprise.inject.Produces (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Annotation Interface
jakarta.enterprise.inject.Produces

+
+No usage of jakarta.enterprise.inject.Produces
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/class-use/ResolutionException.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/class-use/ResolutionException.html new file mode 100644 index 0000000000..ef3ce3fdc0 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/class-use/ResolutionException.html @@ -0,0 +1,107 @@ + + + + +Uses of Class jakarta.enterprise.inject.ResolutionException (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
jakarta.enterprise.inject.ResolutionException

+
+
Packages that use ResolutionException
+
+
Package
+
Description
+ +
 
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/class-use/Specializes.Literal.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/class-use/Specializes.Literal.html new file mode 100644 index 0000000000..3771399b0e --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/class-use/Specializes.Literal.html @@ -0,0 +1,91 @@ + + + + +Uses of Class jakarta.enterprise.inject.Specializes.Literal (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
jakarta.enterprise.inject.Specializes.Literal

+
+
Packages that use Specializes.Literal
+
+
Package
+
Description
+ +
 
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/class-use/Specializes.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/class-use/Specializes.html new file mode 100644 index 0000000000..1e9d4d2fe4 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/class-use/Specializes.html @@ -0,0 +1,64 @@ + + + + +Uses of Annotation Interface jakarta.enterprise.inject.Specializes (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Annotation Interface
jakarta.enterprise.inject.Specializes

+
+No usage of jakarta.enterprise.inject.Specializes
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/class-use/Stereotype.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/class-use/Stereotype.html new file mode 100644 index 0000000000..2aa96737ec --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/class-use/Stereotype.html @@ -0,0 +1,115 @@ + + + + +Uses of Annotation Interface jakarta.enterprise.inject.Stereotype (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Annotation Interface
jakarta.enterprise.inject.Stereotype

+
+
Packages that use Stereotype
+
+
Package
+
Description
+ +
+
+ Annotations relating to decorators.
+
+ +
 
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/class-use/TransientReference.Literal.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/class-use/TransientReference.Literal.html new file mode 100644 index 0000000000..1671983807 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/class-use/TransientReference.Literal.html @@ -0,0 +1,91 @@ + + + + +Uses of Class jakarta.enterprise.inject.TransientReference.Literal (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
jakarta.enterprise.inject.TransientReference.Literal

+
+
Packages that use TransientReference.Literal
+
+
Package
+
Description
+ +
 
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/class-use/TransientReference.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/class-use/TransientReference.html new file mode 100644 index 0000000000..8a1c7dfbe9 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/class-use/TransientReference.html @@ -0,0 +1,64 @@ + + + + +Uses of Annotation Interface jakarta.enterprise.inject.TransientReference (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Annotation Interface
jakarta.enterprise.inject.TransientReference

+
+No usage of jakarta.enterprise.inject.TransientReference
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/class-use/Typed.Literal.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/class-use/Typed.Literal.html new file mode 100644 index 0000000000..e58b024138 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/class-use/Typed.Literal.html @@ -0,0 +1,102 @@ + + + + +Uses of Class jakarta.enterprise.inject.Typed.Literal (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
jakarta.enterprise.inject.Typed.Literal

+
+
Packages that use Typed.Literal
+
+
Package
+
Description
+ +
 
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/class-use/Typed.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/class-use/Typed.html new file mode 100644 index 0000000000..6ea232369e --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/class-use/Typed.html @@ -0,0 +1,64 @@ + + + + +Uses of Annotation Interface jakarta.enterprise.inject.Typed (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Annotation Interface
jakarta.enterprise.inject.Typed

+
+No usage of jakarta.enterprise.inject.Typed
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/class-use/UnproxyableResolutionException.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/class-use/UnproxyableResolutionException.html new file mode 100644 index 0000000000..97c9b4a8d4 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/class-use/UnproxyableResolutionException.html @@ -0,0 +1,64 @@ + + + + +Uses of Class jakarta.enterprise.inject.UnproxyableResolutionException (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
jakarta.enterprise.inject.UnproxyableResolutionException

+
+No usage of jakarta.enterprise.inject.UnproxyableResolutionException
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/class-use/UnsatisfiedResolutionException.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/class-use/UnsatisfiedResolutionException.html new file mode 100644 index 0000000000..74286366ff --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/class-use/UnsatisfiedResolutionException.html @@ -0,0 +1,64 @@ + + + + +Uses of Class jakarta.enterprise.inject.UnsatisfiedResolutionException (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
jakarta.enterprise.inject.UnsatisfiedResolutionException

+
+No usage of jakarta.enterprise.inject.UnsatisfiedResolutionException
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/class-use/Vetoed.Literal.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/class-use/Vetoed.Literal.html new file mode 100644 index 0000000000..02fa5b7e7b --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/class-use/Vetoed.Literal.html @@ -0,0 +1,91 @@ + + + + +Uses of Class jakarta.enterprise.inject.Vetoed.Literal (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
jakarta.enterprise.inject.Vetoed.Literal

+
+
Packages that use Vetoed.Literal
+
+
Package
+
Description
+ +
 
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/class-use/Vetoed.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/class-use/Vetoed.html new file mode 100644 index 0000000000..7033e38433 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/class-use/Vetoed.html @@ -0,0 +1,64 @@ + + + + +Uses of Annotation Interface jakarta.enterprise.inject.Vetoed (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Annotation Interface
jakarta.enterprise.inject.Vetoed

+
+No usage of jakarta.enterprise.inject.Vetoed
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/literal/InjectLiteral.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/literal/InjectLiteral.html new file mode 100644 index 0000000000..3a6be2f3e3 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/literal/InjectLiteral.html @@ -0,0 +1,207 @@ + + + + +InjectLiteral (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Class InjectLiteral

+
+
java.lang.Object +
jakarta.enterprise.util.AnnotationLiteral<jakarta.inject.Inject> +
jakarta.enterprise.inject.literal.InjectLiteral
+
+
+
+
+
All Implemented Interfaces:
+
Annotation
+
+
+
public final class InjectLiteral +extends AnnotationLiteral<jakarta.inject.Inject> +implements jakarta.inject.Inject
+
Supports inline instantiation of the Inject annotation.
+
+
Since:
+
2.0
+
Author:
+
Martin Kouba
+
See Also:
+
+ +
+
+
+
+ +
+
+
    + +
  • +
    +

    Field Details

    +
      +
    • +
      +

      INSTANCE

      +
      public static final InjectLiteral INSTANCE
      +
      Default Inject literal
      +
      +
    • +
    +
    +
  • + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      InjectLiteral

      +
      public InjectLiteral()
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/literal/NamedLiteral.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/literal/NamedLiteral.html new file mode 100644 index 0000000000..35750b855d --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/literal/NamedLiteral.html @@ -0,0 +1,225 @@ + + + + +NamedLiteral (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Class NamedLiteral

+
+
java.lang.Object +
jakarta.enterprise.util.AnnotationLiteral<jakarta.inject.Named> +
jakarta.enterprise.inject.literal.NamedLiteral
+
+
+
+
+
All Implemented Interfaces:
+
Annotation
+
+
+
public final class NamedLiteral +extends AnnotationLiteral<jakarta.inject.Named> +implements jakarta.inject.Named
+
Supports inline instantiation of the Named qualifier.
+
+
Since:
+
2.0
+
Author:
+
Pete Muir, Jozef Hartinger
+
See Also:
+
+ +
+
+
+
+ +
+
+
    + +
  • +
    +

    Field Details

    +
      +
    • +
      +

      INSTANCE

      +
      public static final jakarta.inject.Named INSTANCE
      +
      Default Named literal
      +
      +
    • +
    +
    +
  • + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      of

      +
      public static NamedLiteral of(String value)
      +
      Create a new NamedLiteral for the given name value
      +
      +
      Parameters:
      +
      value - the name
      +
      Returns:
      +
      new NamedLiteral
      +
      +
      +
    • +
    • +
      +

      value

      +
      public String value()
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/literal/QualifierLiteral.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/literal/QualifierLiteral.html new file mode 100644 index 0000000000..dd5e5880f8 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/literal/QualifierLiteral.html @@ -0,0 +1,207 @@ + + + + +QualifierLiteral (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Class QualifierLiteral

+
+
java.lang.Object +
jakarta.enterprise.util.AnnotationLiteral<jakarta.inject.Qualifier> +
jakarta.enterprise.inject.literal.QualifierLiteral
+
+
+
+
+
All Implemented Interfaces:
+
Annotation
+
+
+
public final class QualifierLiteral +extends AnnotationLiteral<jakarta.inject.Qualifier> +implements jakarta.inject.Qualifier
+
Supports inline instantiation of the Qualifier annotation.
+
+
Since:
+
2.0
+
Author:
+
Martin Kouba
+
See Also:
+
+ +
+
+
+
+ +
+
+
    + +
  • +
    +

    Field Details

    +
      +
    • +
      +

      INSTANCE

      +
      public static final QualifierLiteral INSTANCE
      +
      Default Qualifier literal
      +
      +
    • +
    +
    +
  • + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      QualifierLiteral

      +
      public QualifierLiteral()
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/literal/SingletonLiteral.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/literal/SingletonLiteral.html new file mode 100644 index 0000000000..8c3fbc9b70 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/literal/SingletonLiteral.html @@ -0,0 +1,207 @@ + + + + +SingletonLiteral (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Class SingletonLiteral

+
+
java.lang.Object +
jakarta.enterprise.util.AnnotationLiteral<jakarta.inject.Singleton> +
jakarta.enterprise.inject.literal.SingletonLiteral
+
+
+
+
+
All Implemented Interfaces:
+
Annotation
+
+
+
public final class SingletonLiteral +extends AnnotationLiteral<jakarta.inject.Singleton> +implements jakarta.inject.Singleton
+
Supports inline instantiation of the Singleton annotation.
+
+
Since:
+
2.0
+
Author:
+
Martin Kouba
+
See Also:
+
+ +
+
+
+
+ +
+
+
    + +
  • +
    +

    Field Details

    +
      +
    • +
      +

      INSTANCE

      +
      public static final SingletonLiteral INSTANCE
      +
      Default Singleton literal
      +
      +
    • +
    +
    +
  • + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      SingletonLiteral

      +
      public SingletonLiteral()
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/literal/class-use/InjectLiteral.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/literal/class-use/InjectLiteral.html new file mode 100644 index 0000000000..974ae6ac53 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/literal/class-use/InjectLiteral.html @@ -0,0 +1,91 @@ + + + + +Uses of Class jakarta.enterprise.inject.literal.InjectLiteral (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
jakarta.enterprise.inject.literal.InjectLiteral

+
+
Packages that use InjectLiteral
+
+
Package
+
Description
+ +
 
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/literal/class-use/NamedLiteral.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/literal/class-use/NamedLiteral.html new file mode 100644 index 0000000000..34a286fc88 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/literal/class-use/NamedLiteral.html @@ -0,0 +1,91 @@ + + + + +Uses of Class jakarta.enterprise.inject.literal.NamedLiteral (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
jakarta.enterprise.inject.literal.NamedLiteral

+
+
Packages that use NamedLiteral
+
+
Package
+
Description
+ +
 
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/literal/class-use/QualifierLiteral.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/literal/class-use/QualifierLiteral.html new file mode 100644 index 0000000000..99d0801879 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/literal/class-use/QualifierLiteral.html @@ -0,0 +1,91 @@ + + + + +Uses of Class jakarta.enterprise.inject.literal.QualifierLiteral (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
jakarta.enterprise.inject.literal.QualifierLiteral

+
+
Packages that use QualifierLiteral
+
+
Package
+
Description
+ +
 
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/literal/class-use/SingletonLiteral.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/literal/class-use/SingletonLiteral.html new file mode 100644 index 0000000000..5d715d3da6 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/literal/class-use/SingletonLiteral.html @@ -0,0 +1,91 @@ + + + + +Uses of Class jakarta.enterprise.inject.literal.SingletonLiteral (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
jakarta.enterprise.inject.literal.SingletonLiteral

+
+
Packages that use SingletonLiteral
+
+
Package
+
Description
+ +
 
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/literal/package-summary.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/literal/package-summary.html new file mode 100644 index 0000000000..8dbaf8dbb1 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/literal/package-summary.html @@ -0,0 +1,130 @@ + + + + +jakarta.enterprise.inject.literal (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Package jakarta.enterprise.inject.literal

+
+
+
package jakarta.enterprise.inject.literal
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/literal/package-tree.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/literal/package-tree.html new file mode 100644 index 0000000000..82702bc553 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/literal/package-tree.html @@ -0,0 +1,85 @@ + + + + +jakarta.enterprise.inject.literal Class Hierarchy (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Hierarchy For Package jakarta.enterprise.inject.literal

+
+Package Hierarchies: + +
+

Class Hierarchy

+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/literal/package-use.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/literal/package-use.html new file mode 100644 index 0000000000..4052eead48 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/literal/package-use.html @@ -0,0 +1,100 @@ + + + + +Uses of Package jakarta.enterprise.inject.literal (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Package
jakarta.enterprise.inject.literal

+
+ +
+
Package
+
Description
+ +
 
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/package-summary.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/package-summary.html new file mode 100644 index 0000000000..7ea5130107 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/package-summary.html @@ -0,0 +1,258 @@ + + + + +jakarta.enterprise.inject (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Package jakarta.enterprise.inject

+
+
+
package jakarta.enterprise.inject
+
+
    +
  • + +
  • +
  • +
    +
    +
    +
    +
    Class
    +
    Description
    + +
    +
    + Specifies that a bean is an alternative.
    +
    + +
    +
    Supports inline instantiation of the Alternative annotation.
    +
    + +
    +
    + Indicates that multiple beans match a certain combination of required type and required qualifiers and are eligible for + injection into a certain class.
    +
    + +
    +
    + The built-in qualifier type.
    +
    + +
    +
    Supports inline instantiation of the Any qualifier.
    +
    + +
    +
    + Indicates that a checked exception was thrown during creation of a bean.
    +
    + +
    +
    + A decorator may inject metadata about the bean it is decorating
    +
    + +
    +
    + The default qualifier type.
    +
    + +
    +
    Supports inline instantiation of the Default qualifier.
    +
    + +
    +
    + Identifies the disposed parameter of a disposer method.
    +
    + +
    +
    + Indicates that a producer method returned a null value or a producer field contained a null value, and the scope of the + producer method or field was not Dependent.
    +
    + +
    +
    Indicates a problem relating to dependency injection.
    +
    + +
    +
    + Allows the application to dynamically obtain instances of beans with a specified combination of required type and qualifiers.
    +
    + +
    +
    This interface represents a contextual reference handle.
    +
    + +
    +
    + An interceptor may inject metadata about the bean it is intercepting.
    +
    + +
    +
    + The built-in stereotype intended for use with beans that define the model layer of an MVC web application architecture such + as JSF.
    +
    + +
    +
    + Identifies a producer method or field.
    +
    + +
    +
    Indicates a problem relating to typesafe resolution.
    +
    + +
    +
    + Indicates that a bean directly specializes another bean.
    +
    + +
    +
    Supports inline instantiation of the Specializes annotation.
    +
    + +
    +
    + Specifies that an annotation type is a stereotype.
    +
    + +
    +
    + If a parameter annotated with @TransientReference resolves to a dependent scoped bean, then the bean will + be + destroyed after the invocation completes.
    +
    + +
    +
    Supports inline instantiation of the TransientReference annotation.
    +
    + +
    +
    + Restricts the bean types of a bean.
    +
    + +
    +
    Supports inline instantiation of the Typed annotation.
    +
    + +
    +
    + Indicates that a contextual reference for a bean with a normal scope and a certain bean type cannot be obtained because the + bean type cannot be proxied by the container.
    +
    + +
    +
    + Indicates that no bean matches a certain combination of required type and required qualifiers and is eligible for injection + into a certain class.
    +
    + +
    +
    + Veto the processing of the class.
    +
    + +
    +
    Supports inline instantiation of the Vetoed annotation.
    +
    +
    +
    +
    +
  • +
+
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/package-tree.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/package-tree.html new file mode 100644 index 0000000000..a905f6d6e8 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/package-tree.html @@ -0,0 +1,151 @@ + + + + +jakarta.enterprise.inject Class Hierarchy (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Hierarchy For Package jakarta.enterprise.inject

+
+Package Hierarchies: + +
+

Class Hierarchy

+ +
+
+

Interface Hierarchy

+ +
+
+

Annotation Interface Hierarchy

+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/package-use.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/package-use.html new file mode 100644 index 0000000000..7a03966d2d --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/package-use.html @@ -0,0 +1,223 @@ + + + + +Uses of Package jakarta.enterprise.inject (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Package
jakarta.enterprise.inject

+
+
Packages that use jakarta.enterprise.inject
+
+
Package
+
Description
+ +
+
+ Annotations relating to decorators.
+
+ +
 
+ +
+
+ The build compatible extension SPI.
+
+ +
 
+ +
+
+ The portable extension integration SPI.
+
+ +
 
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/se/SeContainer.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/se/SeContainer.html new file mode 100644 index 0000000000..9fccbe0500 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/se/SeContainer.html @@ -0,0 +1,250 @@ + + + + +SeContainer (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface SeContainer

+
+
+
+
All Superinterfaces:
+
AutoCloseable, Instance<Object>, Iterable<Object>, jakarta.inject.Provider<Object>
+
+
+
public interface SeContainer +extends Instance<Object>, AutoCloseable
+
Provides access to the current container in Java SE. + +

+ SeContainer implements Instance and therefore might be used to perform programmatic lookup. + If no qualifier is passed to Instance.select(java.lang.annotation.Annotation...) method, the @Default qualifier is assumed. +

+ +

+ CDI Lite implementations are not required to provide support for CDI in Java SE. +

+
+
Since:
+
2.0
+
Author:
+
Antoine Sabot-Durand, John D. Ament, Graeme Rocher
+
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      close

      +
      void close()
      +

      + Shuts down this SeContainer instance when it is no longer in scope. Implemented from AutoCloseable, +

      +
      +
      Specified by:
      +
      close in interface AutoCloseable
      +
      Throws:
      +
      IllegalStateException - if the container is already shutdown
      +
      +
      +
    • +
    • +
      +

      isRunning

      +
      boolean isRunning()
      +
      Check if the container is running or was shut down
      +
      +
      Returns:
      +
      true if called before container shutdown
      +
      +
      +
    • +
    • +
      +

      getBeanManager

      +
      BeanManager getBeanManager()
      +
      Get the CDI BeanManager for this container
      +
      +
      Returns:
      +
      the BeanManager
      +
      Throws:
      +
      IllegalStateException - if called when the container is already shutdown
      +
      +
      +
    • +
    • +
      +

      getBeanContainer

      +
      default BeanContainer getBeanContainer()
      +
      Get the CDI BeanContainer for this container. + + Default implementation just forwards the call to getBeanManager().
      +
      +
      Returns:
      +
      the BeanContainer
      +
      Since:
      +
      4.0
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/se/SeContainerInitializer.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/se/SeContainerInitializer.html new file mode 100644 index 0000000000..2b24c48b0e --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/se/SeContainerInitializer.html @@ -0,0 +1,600 @@ + + + + +SeContainerInitializer (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Class SeContainerInitializer

+
+
java.lang.Object +
jakarta.enterprise.inject.se.SeContainerInitializer
+
+
+
+
public abstract class SeContainerInitializer +extends Object
+
A CDI container initializer for Java SE. An instance may be obtained by calling newInstance() + static method. +

+ Typical usage looks like this: +

+ +
+ SeContainer container = SeContainerInitializer.newInstance().initialize();
+ container.select(Foo.class).get();
+ container.close();
+ 
+ +

+ Since SeContainer interface implements AutoCloseable: +

+ +
+ try (SeContainer container = SeContainerInitializer.newInstance().initialize()) {
+     container.select(Foo.class).get();
+ }
+ 
+ +

+ By default, the discovery is enabled so that all beans from all discovered bean archives are considered. However, it's + possible to define a "synthetic" bean archive, or the set of bean classes and enablement respectively: +

+ +
+ SeContainer container = SeContainerInitializer.newInstance().addBeanClasses(Foo.class, Bar.class).selectAlternatives(Bar.class).initialize());
+ 
+ +

+ Moreover, it's also possible to disable the discovery completely so that only the "synthetic" bean archive is considered: +

+ +
+ SeContainer container = SeContainerInitializer.newInstance().disableDiscovery().addBeanClasses(Foo.class, Bar.class).initialize());
+ 
+ +

+ In the same manner, it is possible to explicitly declare interceptors, decorators, extensions and implementation specific + options using the builder. +

+ +
+ SeContainerInitializer containerInitializer = SeContainerInitializer.newInstance()
+         .disableDiscovery()
+         .addPackages(Main.class, Utils.class)
+         .enableInterceptors(TransactionalInterceptor.class)
+         .addProperty("property", true);
+ SeContainer container = container.initialize();
+ 
+ +

+ CDI Lite implementations are not required to provide support for CDI in Java SE. +

+
+
Since:
+
2.0
+
Author:
+
Antoine Sabot-Durand, Martin Kouba, John D. Ament
+
+
+
+ +
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      SeContainerInitializer

      +
      public SeContainerInitializer()
      +
      +
    • +
    +
    +
  • + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      newInstance

      +
      public static SeContainerInitializer newInstance()
      +
      Returns an instance of SeContainerInitializer + Each call returns a new instance
      +
      +
      Returns:
      +
      a new SeContainerInitializer instance.
      +
      Throws:
      +
      IllegalStateException - if called in a Java EE container
      +
      +
      +
    • +
    • +
      +

      addBeanClasses

      +
      public abstract SeContainerInitializer addBeanClasses(Class<?>... classes)
      +
      Add provided bean classes to the synthetic bean archive.
      +
      +
      Parameters:
      +
      classes - classes to add to the synthetic bean archive
      +
      Returns:
      +
      self
      +
      +
      +
    • +
    • +
      +

      addPackages

      +
      public abstract SeContainerInitializer addPackages(Class<?>... packageClasses)
      +
      All classes from the packages of the specified classes will be added to the set of bean classes for the synthetic bean + archive. +

      + Note that the scanning possibilities are limited. Therefore, only directories and jar files from the filesystem are + supported. +

      +

      + Scanning may also have negative impact on SE performance. +

      +
      +
      Parameters:
      +
      packageClasses - classes whose packages will be added to the synthetic bean archive
      +
      Returns:
      +
      self
      +
      +
      +
    • +
    • +
      +

      addPackages

      +
      public abstract SeContainerInitializer addPackages(boolean scanRecursively, + Class<?>... packageClasses)
      +
      Packages of the specified classes will be scanned and found classes will be added to the set of bean classes for the + synthetic bean archive.* +

      + Note that the scanning possibilities are limited. Therefore, only directories and jar files from the filesystem are + supported. +

      +

      + Scanning may also have negative impact on SE performance. +

      +
      +
      Parameters:
      +
      scanRecursively - should subpackages be scanned or not
      +
      packageClasses - classes whose packages will be scanned
      +
      Returns:
      +
      self
      +
      +
      +
    • +
    • +
      +

      addPackages

      +
      public abstract SeContainerInitializer addPackages(Package... packages)
      +
      All classes from the specified packages will be added to the set of bean classes for the synthetic bean archive. +

      + Note that the scanning possibilities are limited. Therefore, only directories and jar files from the filesystem are + supported. +

      +

      + Scanning may also have negative impact on SE performance. +

      +
      +
      Parameters:
      +
      packages - packages that will be added to the synthetic bean archive
      +
      Returns:
      +
      self
      +
      +
      +
    • +
    • +
      +

      addPackages

      +
      public abstract SeContainerInitializer addPackages(boolean scanRecursively, + Package... packages)
      +
      All classes from the specified packages will be added to the set of bean classes for the synthetic bean archive. +

      + Note that the scanning possibilities are limited. Therefore, only directories and jar files from the filesystem are + supported. +

      +

      + Scanning may also have negative impact on SE performance. +

      +
      +
      Parameters:
      +
      scanRecursively - should subpackages be scanned or not
      +
      packages - packages that will be added to the synthetic bean archive
      +
      Returns:
      +
      self
      +
      +
      +
    • +
    • +
      +

      addExtensions

      +
      public abstract SeContainerInitializer addExtensions(Extension... extensions)
      +
      Add extensions to the set of extensions.
      +
      +
      Parameters:
      +
      extensions - extensions to use in the container
      +
      Returns:
      +
      self
      +
      +
      +
    • +
    • +
      +

      addExtensions

      +
      public abstract SeContainerInitializer addExtensions(Class<? extends Extension>... extensions)
      +
      Add extensions to the set of extensions.
      +
      +
      Parameters:
      +
      extensions - extensions class to use in the container
      +
      Returns:
      +
      self
      +
      +
      +
    • +
    • +
      +

      enableInterceptors

      +
      public abstract SeContainerInitializer enableInterceptors(Class<?>... interceptorClasses)
      +
      Add interceptor classes to the list of enabled interceptors for the synthetic bean archive. +

      + This method does not add any class to the set of bean classes of the synthetic bean archive. +

      +
      +
      Parameters:
      +
      interceptorClasses - classes of the interceptors to enable.
      +
      Returns:
      +
      self
      +
      +
      +
    • +
    • +
      +

      enableDecorators

      +
      public abstract SeContainerInitializer enableDecorators(Class<?>... decoratorClasses)
      +
      Add decorator classes to the list of enabled decorators for the synthetic bean archive. +

      + This method does not add any class to the set of bean classes of the synthetic bean archive. +

      +
      +
      Parameters:
      +
      decoratorClasses - classes of the decorators to enable.
      +
      Returns:
      +
      self
      +
      +
      +
    • +
    • +
      +

      selectAlternatives

      +
      public abstract SeContainerInitializer selectAlternatives(Class<?>... alternativeClasses)
      +
      Add alternatives classes to the list of selected alternatives for the synthetic bean archive. +

      + This method does not add any class to the set of bean classes of the synthetic bean archive. +

      +
      +
      Parameters:
      +
      alternativeClasses - classes of the alternatives to select
      +
      Returns:
      +
      self
      +
      +
      +
    • +
    • +
      +

      selectAlternativeStereotypes

      +
      public abstract SeContainerInitializer selectAlternativeStereotypes(Class<? extends Annotation>... alternativeStereotypeClasses)
      +
      Add alternative stereotype classes to the list of selected alternative stereotypes for the synthetic bean archive. +

      + This method does not add any class to the set of bean classes of the synthetic bean archive. +

      +
      +
      Parameters:
      +
      alternativeStereotypeClasses - alternatives stereotypes to select
      +
      Returns:
      +
      self
      +
      +
      +
    • +
    • +
      +

      addProperty

      +
      public abstract SeContainerInitializer addProperty(String key, + Object value)
      +
      Add a configuration property to the container
      +
      +
      Parameters:
      +
      key - property name
      +
      value - property value
      +
      Returns:
      +
      self
      +
      +
      +
    • +
    • +
      +

      setProperties

      +
      public abstract SeContainerInitializer setProperties(Map<String,Object> properties)
      +
      Set all the configuration properties. + Erase previous properties set
      +
      +
      Parameters:
      +
      properties - a map containing properties to add
      +
      Returns:
      +
      self
      +
      +
      +
    • +
    • +
      +

      disableDiscovery

      +
      public abstract SeContainerInitializer disableDiscovery()
      +
      By default, the discovery is enabled. However, it's possible to disable the discovery completely so that only the + "synthetic" bean archive is considered.
      +
      +
      Returns:
      +
      self
      +
      +
      +
    • +
    • +
      +

      setClassLoader

      +
      public abstract SeContainerInitializer setClassLoader(ClassLoader classLoader)
      +
      Set a ClassLoader. The given ClassLoader will be scanned automatically for bean archives if scanning is + enabled.
      +
      +
      Parameters:
      +
      classLoader - the class loader to use
      +
      Returns:
      +
      self
      +
      +
      +
    • +
    • +
      +

      initialize

      +
      public abstract SeContainer initialize()
      +

      + Initializes a CDI SeContainerInitializer. +

      +

      + Cannot be called within an application server. +

      +
      +
      Returns:
      +
      the SeContainer instance associated with the container.
      +
      Throws:
      +
      UnsupportedOperationException - if called within an application server
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/se/class-use/SeContainer.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/se/class-use/SeContainer.html new file mode 100644 index 0000000000..e204221960 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/se/class-use/SeContainer.html @@ -0,0 +1,92 @@ + + + + +Uses of Interface jakarta.enterprise.inject.se.SeContainer (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.enterprise.inject.se.SeContainer

+
+
Packages that use SeContainer
+
+
Package
+
Description
+ +
 
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/se/class-use/SeContainerInitializer.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/se/class-use/SeContainerInitializer.html new file mode 100644 index 0000000000..5a28bbfda5 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/se/class-use/SeContainerInitializer.html @@ -0,0 +1,172 @@ + + + + +Uses of Class jakarta.enterprise.inject.se.SeContainerInitializer (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
jakarta.enterprise.inject.se.SeContainerInitializer

+
+
Packages that use SeContainerInitializer
+
+
Package
+
Description
+ +
 
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/se/package-summary.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/se/package-summary.html new file mode 100644 index 0000000000..292eea3cd2 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/se/package-summary.html @@ -0,0 +1,124 @@ + + + + +jakarta.enterprise.inject.se (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Package jakarta.enterprise.inject.se

+
+
+
package jakarta.enterprise.inject.se
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/se/package-tree.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/se/package-tree.html new file mode 100644 index 0000000000..d118b4578d --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/se/package-tree.html @@ -0,0 +1,106 @@ + + + + +jakarta.enterprise.inject.se Class Hierarchy (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Hierarchy For Package jakarta.enterprise.inject.se

+
+Package Hierarchies: + +
+

Class Hierarchy

+ +
+
+

Interface Hierarchy

+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/se/package-use.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/se/package-use.html new file mode 100644 index 0000000000..0b4de02f90 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/se/package-use.html @@ -0,0 +1,92 @@ + + + + +Uses of Package jakarta.enterprise.inject.se (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Package
jakarta.enterprise.inject.se

+
+ +
+
Package
+
Description
+ +
 
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/AfterBeanDiscovery.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/AfterBeanDiscovery.html new file mode 100644 index 0000000000..db5929b3c4 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/AfterBeanDiscovery.html @@ -0,0 +1,361 @@ + + + + +AfterBeanDiscovery (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface AfterBeanDiscovery

+
+
+
+
public interface AfterBeanDiscovery
+

+ The event type of the second event fired by the container when it has fully completed the bean discovery process, validated + that there are no definition errors relating to the discovered beans, and registered Bean + and ObserverMethod objects for the discovered beans, but before detecting deployment + problems. +

+

+ A portable extension may take advantage of this event to register beans, + interceptors, decorators, + observer methods and custom context + objects with the container. +

+ +
+     void afterBeanDiscovery(@Observes AfterBeanDiscovery event, BeanManager manager) { ... }
+ 
+

+ If any observer method of the AfterBeanDiscovery event throws an exception, the exception is treated as a definition + error by the container. +

+ +

+ CDI Lite implementations are not required to provide support for Portable Extensions. +

+
+
Author:
+
David Allen, Antoine Sabot-Durand
+
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      addDefinitionError

      +
      void addDefinitionError(Throwable t)
      +
      Registers a definition error with the container, causing the container to abort deployment after all observers have been + notified.
      +
      +
      Parameters:
      +
      t - The definition error as a Throwable
      +
      Throws:
      +
      IllegalStateException - if called outside of the observer method invocation
      +
      +
      +
    • +
    • +
      +

      addBean

      +
      void addBean(Bean<?> bean)
      +
      Fires an event of type ProcessBean containing the given + Bean and then registers the Bean with the + container, thereby making a bean which is not an interceptor nor a decorator available for injection into other beans. + The given Bean may implement Interceptor or Decorator.
      +
      +
      Parameters:
      +
      bean - The bean to add to the deployment
      +
      Throws:
      +
      IllegalStateException - if called outside of the observer method invocation
      +
      +
      +
    • +
    • +
      +

      addBean

      +
      <T> BeanConfigurator<T> addBean()
      +
      Obtains a new BeanConfigurator to configure a new Bean and add it at the end of the observer invocation. + It will then fire an event of type ProcessBean containing the built + Bean from this configuration and then register it with the + container, thereby making it available for injection into other beans. + + Each call returns a new BeanConfigurator.
      +
      +
      Type Parameters:
      +
      T - type of bean
      +
      Returns:
      +
      a non reusable BeanConfigurator to configure the bean to add
      +
      Throws:
      +
      IllegalStateException - if called outside of the observer method invocation
      +
      Since:
      +
      2.0
      +
      +
      +
    • +
    • +
      +

      addObserverMethod

      +
      void addObserverMethod(ObserverMethod<?> observerMethod)
      +
      Fires an event of type ProcessObserverMethod containing the given + ObserverMethod and then registers the + ObserverMethod with the container, thereby making it available for event + notifications.
      +
      +
      Parameters:
      +
      observerMethod - The custom observer method to add to the deployment
      +
      Throws:
      +
      IllegalStateException - if called outside of the observer method invocation
      +
      +
      +
    • +
    • +
      +

      addObserverMethod

      +
      <T> ObserverMethodConfigurator<T> addObserverMethod()
      +
      obtains a new ObserverMethodConfigurator to configure a new ObserverMethod and add it at the end of the + observer invocation. + It will then fire an event of type ProcessObserverMethod containing the built + ObserverMethod from this configuration and then registers the + ObserverMethod with the container, thereby making it available for event + notifications. + + Each call returns a new ObserverMethodConfigurator.
      +
      +
      Type Parameters:
      +
      T - type of the event the configured ObserverMethod will observe
      +
      Returns:
      +
      a non reusable ObserverMethodConfigurator instance
      +
      Throws:
      +
      IllegalStateException - if called outside of the observer method invocation
      +
      Since:
      +
      2.0
      +
      +
      +
    • +
    • +
      +

      addContext

      +
      void addContext(Context context)
      +
      Registers a custom Context object with the container.
      +
      +
      Parameters:
      +
      context - The custom context to add to the deployment
      +
      Throws:
      +
      IllegalStateException - if called outside of the observer method invocation
      +
      +
      +
    • +
    • +
      +

      getAnnotatedType

      +
      <T> AnnotatedType<T> getAnnotatedType(Class<T> type, + String id)
      +
      Obtain the AnnotatedType that may be used to read the annotations of the given class or interface as defined + during container initialization.
      +
      +
      Type Parameters:
      +
      T - the class or interface
      +
      Parameters:
      +
      type - the Class object
      +
      id - the type identifier. If null, the fully qualifier class name of type is used
      +
      Returns:
      +
      the AnnotatedType
      +
      Throws:
      +
      IllegalStateException - if called outside of the observer method invocation
      +
      Since:
      +
      1.1
      +
      +
      +
    • +
    • +
      +

      getAnnotatedTypes

      +
      <T> Iterable<AnnotatedType<T>> getAnnotatedTypes(Class<T> type)
      +
      Obtain the AnnotatedTypes that may be used to read the annotations of the given class or interface as defined + during container initialization.
      +
      +
      Type Parameters:
      +
      T - the class or interface
      +
      Parameters:
      +
      type - the Class object
      +
      Returns:
      +
      the AnnotatedTypes
      +
      Throws:
      +
      IllegalStateException - if called outside of the observer method invocation
      +
      Since:
      +
      1.1
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/AfterDeploymentValidation.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/AfterDeploymentValidation.html new file mode 100644 index 0000000000..de11f10d75 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/AfterDeploymentValidation.html @@ -0,0 +1,172 @@ + + + + +AfterDeploymentValidation (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface AfterDeploymentValidation

+
+
+
+
public interface AfterDeploymentValidation
+

+ The event type of the third event fired by the container after it has validated that there are no deployment problems and + before creating contexts or processing requests. If any observer method of the AfterDeploymentValidation event throws + an exception, the exception is treated as a deployment problem by the container. +

+

+ No requests will be processed by the deployment until all observers of this event return. +

+ +

+ CDI Lite implementations are not required to provide support for Portable Extensions. +

+
+
Author:
+
David Allen
+
+
+
+
    + +
  • +
    +

    Method Summary

    +
    +
    +
    +
    +
    Modifier and Type
    +
    Method
    +
    Description
    +
    void
    + +
    +
    Registers a deployment problem with the container, causing the container to abort deployment after all observers have + been notified.
    +
    +
    +
    +
    +
    +
  • +
+
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      addDeploymentProblem

      +
      void addDeploymentProblem(Throwable t)
      +
      Registers a deployment problem with the container, causing the container to abort deployment after all observers have + been notified.
      +
      +
      Parameters:
      +
      t - The deployment problem as a Throwable
      +
      Throws:
      +
      IllegalStateException - if called outside of the observer method invocation
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/AfterTypeDiscovery.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/AfterTypeDiscovery.html new file mode 100644 index 0000000000..b053db11ac --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/AfterTypeDiscovery.html @@ -0,0 +1,285 @@ + + + + +AfterTypeDiscovery (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface AfterTypeDiscovery

+
+
+
+
public interface AfterTypeDiscovery
+

+ This event type is thrown by the container after type discovery is complete. If any observer method of the + AfterTypeDiscovery event throws an exception, the exception is treated as a definition error by the container. +

+

+ Any observer of this event is permitted to add classes to, or remove classes from, the list of alternatives, list of + interceptors or list of decorators. The container will use the final values of these lists, after all observers have been + called, to determine the enabled alternatives, interceptors, and decorators for application. + Changes made to these lists after the invocation of the last observer method of the AfterTypeDiscovery are ignored. +

+ +

+ CDI Lite implementations are not required to provide support for Portable Extensions. +

+
+
Since:
+
1.1
+
Author:
+
Pete Muir, Antoine Sabot-Durand
+
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      getAlternatives

      +
      List<Class<?>> getAlternatives()
      +
      +
      Returns:
      +
      the list of enabled alternatives for the application, sorted by priority in ascending order. Alternatives enabled + for a bean archive are not included.
      +
      Throws:
      +
      IllegalStateException - if called outside of the observer method invocation
      +
      +
      +
    • +
    • +
      +

      getInterceptors

      +
      List<Class<?>> getInterceptors()
      +
      +
      Returns:
      +
      the list of enabled interceptors for the application, sorted by priority in ascending order. Interceptors enabled + for a bean archive are not included.
      +
      Throws:
      +
      IllegalStateException - if called outside of the observer method invocation
      +
      +
      +
    • +
    • +
      +

      getDecorators

      +
      List<Class<?>> getDecorators()
      +
      +
      Returns:
      +
      the list of enabled decorators for the application, sorted by priority in ascending order. Decorators enabled for + a bean archive are not included.
      +
      Throws:
      +
      IllegalStateException - if called outside of the observer method invocation
      +
      +
      +
    • +
    • +
      +

      addAnnotatedType

      +
      void addAnnotatedType(AnnotatedType<?> type, + String id)
      +

      + Adds a given AnnotatedType to the set of types which will be scanned during bean discovery. +

      + +

      + Thanks to the id parameter, this method allows multiple annotated types, based on the same underlying type, to be + defined. AnnotatedTypes discovered by the container use the fully qualified class name of + AnnotatedType.getJavaClass() to identify the type. +

      + +

      + AfterBeanDiscovery.getAnnotatedType(Class, String) and AfterBeanDiscovery.getAnnotatedTypes(Class) allows + annotated types to be obtained by identifier. +

      +
      +
      Parameters:
      +
      type - The AnnotatedType to add for later scanning
      +
      id - the identifier used to distinguish this AnnotatedType from an other one based on the same underlying type
      +
      Throws:
      +
      IllegalStateException - if called outside of the observer method invocation
      +
      +
      +
    • +
    • +
      +

      addAnnotatedType

      +
      <T> AnnotatedTypeConfigurator<T> addAnnotatedType(Class<T> type, + String id)
      +

      + Obtains a new AnnotatedTypeConfigurator to configure a new AnnotatedType and add it to the set of types + which will be scanned during bean discovery at the end of the observer invocation. Calling this method multiple times + will return a new AnnotatedTypeConfigurator. +

      + +

      + Thanks to the id parameter, this method allows multiple annotated types, based on the same underlying type, to be + defined. AnnotatedTypes discovered by the container use the fully qualified class name of + AnnotatedType.getJavaClass() to identify the type. +

      + +

      + AfterBeanDiscovery.getAnnotatedType(Class, String) and AfterBeanDiscovery.getAnnotatedTypes(Class) allows + annotated types to be obtained by identifier. +

      + + Each call returns a new AnnotatedTypeConfigurator.
      +
      +
      Type Parameters:
      +
      T - annotatated instance type
      +
      Parameters:
      +
      type - class used to initialized the type and annotations on the AnnotatedTypeConfigurator
      +
      id - the identifier used to distinguish this AnnotatedType from an other one based on the same underlying type
      +
      Returns:
      +
      a non reusable AnnotatedTypeConfigurator to configure the new AnnotatedType
      +
      Throws:
      +
      IllegalStateException - if called outside of the observer method invocation
      +
      Since:
      +
      2.0
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/Annotated.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/Annotated.html new file mode 100644 index 0000000000..7b89248094 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/Annotated.html @@ -0,0 +1,288 @@ + + + + +Annotated (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface Annotated

+
+
+
+
All Known Subinterfaces:
+
AnnotatedCallable<X>, AnnotatedConstructor<X>, AnnotatedField<X>, AnnotatedMember<X>, AnnotatedMethod<X>, AnnotatedParameter<X>, AnnotatedType<X>
+
+
+
public interface Annotated
+

+ Represents a Java program element that can be annotated. +

+
+
Author:
+
Gavin King, Pete Muir, Clint Popetz, John D. Ament
+
See Also:
+
+ +
+
+
+
+
    + +
  • +
    +

    Method Summary

    +
    +
    +
    +
    +
    Modifier and Type
    +
    Method
    +
    Description
    +
    <T extends Annotation>
    T
    +
    getAnnotation(Class<T> annotationType)
    +
    +
    + Get program element annotation of a certain annotation type.
    +
    + + +
    +
    + Get all annotations of the program element.
    +
    +
    <T extends Annotation>
    Set<T>
    +
    getAnnotations(Class<T> annotationType)
    +
    +
    + Get program element annotations of a certain annotation type.
    +
    + + +
    +
    + Get the type of the annotated program element.
    +
    + + +
    +
    + Get all types to which the base type should be considered assignable.
    +
    +
    boolean
    +
    isAnnotationPresent(Class<? extends Annotation> annotationType)
    +
    +
    + Determine if the program element has an annotation of a certain annotation type.
    +
    +
    +
    +
    +
    +
  • +
+
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      getBaseType

      +
      Type getBaseType()
      +

      + Get the type of the annotated program element. +

      +
      +
      Returns:
      +
      the type of the annotated program element
      +
      +
      +
    • +
    • +
      +

      getTypeClosure

      +
      Set<Type> getTypeClosure()
      +

      + Get all types to which the base type should be considered assignable. +

      +
      +
      Returns:
      +
      a set of all types to which the base type should be considered assignable
      +
      +
      +
    • +
    • +
      +

      getAnnotation

      +
      <T extends Annotation> T getAnnotation(Class<T> annotationType)
      +

      + Get program element annotation of a certain annotation type. + + The behavior of this method is intended to be the same behavior as AnnotatedElement.getAnnotation(Class), + where repeatable annotations are not supported. +

      +
      +
      Type Parameters:
      +
      T - the type of the annotation
      +
      Parameters:
      +
      annotationType - the class of the annotation type
      +
      Returns:
      +
      the first program element annotation of the given annotation type, or a null value
      +
      +
      +
    • +
    • +
      +

      getAnnotations

      +
      <T extends Annotation> Set<T> getAnnotations(Class<T> annotationType)
      +

      + Get program element annotations of a certain annotation type. +

      + This method returns back all annotations, including repeatable annotations of this type. + + The behavior of this method is intended to be the same behavior as AnnotatedElement.getAnnotationsByType(Class), + where repeatable annotations are supported. +

      +
      +
      Type Parameters:
      +
      T - the type of the annotation
      +
      Parameters:
      +
      annotationType - the class of the annotation type
      +
      Returns:
      +
      the program element annotations of the given annotation type, or an empty collection
      +
      +
      +
    • +
    • +
      +

      getAnnotations

      +
      Set<Annotation> getAnnotations()
      +

      + Get all annotations of the program element. +

      +
      +
      Returns:
      +
      all annotations of the program element, or an empty set if no annotations are present
      +
      +
      +
    • +
    • +
      +

      isAnnotationPresent

      +
      boolean isAnnotationPresent(Class<? extends Annotation> annotationType)
      +

      + Determine if the program element has an annotation of a certain annotation type. + + The behavior of this method is similar to AnnotatedElement.isAnnotationPresent(Class) for the underlying + program element.

      +
      +
      Parameters:
      +
      annotationType - the annotation type to check for
      +
      Returns:
      +
      true if the program element has an annotation of the given annotation type, or false + otherwise
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/AnnotatedCallable.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/AnnotatedCallable.html new file mode 100644 index 0000000000..59ced4e3ae --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/AnnotatedCallable.html @@ -0,0 +1,181 @@ + + + + +AnnotatedCallable (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface AnnotatedCallable<X>

+
+
+
+
Type Parameters:
+
X - the declaring type
+
+
+
All Superinterfaces:
+
Annotated, AnnotatedMember<X>
+
+
+
All Known Subinterfaces:
+
AnnotatedConstructor<X>, AnnotatedMethod<X>
+
+
+
public interface AnnotatedCallable<X> +extends AnnotatedMember<X>
+

+ Represents a callable member of a Java type. +

+
+
Author:
+
Gavin King, Pete Muir
+
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      getParameters

      +
      List<AnnotatedParameter<X>> getParameters()
      +

      + Get the parameters of the callable member. +

      +
      +
      Returns:
      +
      the parameters
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/AnnotatedConstructor.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/AnnotatedConstructor.html new file mode 100644 index 0000000000..554714e9cf --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/AnnotatedConstructor.html @@ -0,0 +1,219 @@ + + + + +AnnotatedConstructor (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface AnnotatedConstructor<X>

+
+
+
+
Type Parameters:
+
X - the declaring class
+
+
+
All Superinterfaces:
+
Annotated, AnnotatedCallable<X>, AnnotatedMember<X>
+
+
+
public interface AnnotatedConstructor<X> +extends AnnotatedCallable<X>
+

+ Represents a constructor of a Java class. +

+
+
Author:
+
Gavin King, Pete Muir
+
See Also:
+
+ +
+
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      getJavaMember

      +
      Constructor<X> getJavaMember()
      +

      + Get the underlying Constructor. +

      +
      +
      Specified by:
      +
      getJavaMember in interface AnnotatedMember<X>
      +
      Returns:
      +
      the constructor
      +
      +
      +
    • +
    • +
      +

      getAnnotations

      +
      default <T extends Annotation> Set<T> getAnnotations(Class<T> annotationType)
      +
      Description copied from interface: Annotated
      +

      + Get program element annotations of a certain annotation type. +

      + This method returns back all annotations, including repeatable annotations of this type. + + The behavior of this method is intended to be the same behavior as AnnotatedElement.getAnnotationsByType(Class), + where repeatable annotations are supported. +

      +
      +
      Specified by:
      +
      getAnnotations in interface Annotated
      +
      Type Parameters:
      +
      T - the type of the annotation
      +
      Parameters:
      +
      annotationType - the class of the annotation type
      +
      Returns:
      +
      the program element annotations of the given annotation type, or an empty collection
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/AnnotatedField.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/AnnotatedField.html new file mode 100644 index 0000000000..cf26079798 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/AnnotatedField.html @@ -0,0 +1,216 @@ + + + + +AnnotatedField (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface AnnotatedField<X>

+
+
+
+
Type Parameters:
+
X - the declaring type
+
+
+
All Superinterfaces:
+
Annotated, AnnotatedMember<X>
+
+
+
public interface AnnotatedField<X> +extends AnnotatedMember<X>
+

+ Represents a field of a Java class. +

+
+
Author:
+
Gavin King, Pete Muir
+
See Also:
+
+ +
+
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      getJavaMember

      +
      Field getJavaMember()
      +

      + Get the underlying Field. +

      +
      +
      Specified by:
      +
      getJavaMember in interface AnnotatedMember<X>
      +
      Returns:
      +
      the Field
      +
      +
      +
    • +
    • +
      +

      getAnnotations

      +
      default <T extends Annotation> Set<T> getAnnotations(Class<T> annotationType)
      +
      Description copied from interface: Annotated
      +

      + Get program element annotations of a certain annotation type. +

      + This method returns back all annotations, including repeatable annotations of this type. + + The behavior of this method is intended to be the same behavior as AnnotatedElement.getAnnotationsByType(Class), + where repeatable annotations are supported. +

      +
      +
      Specified by:
      +
      getAnnotations in interface Annotated
      +
      Type Parameters:
      +
      T - the type of the annotation
      +
      Parameters:
      +
      annotationType - the class of the annotation type
      +
      Returns:
      +
      the program element annotations of the given annotation type, or an empty collection
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/AnnotatedMember.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/AnnotatedMember.html new file mode 100644 index 0000000000..8c5aa02d79 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/AnnotatedMember.html @@ -0,0 +1,222 @@ + + + + +AnnotatedMember (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface AnnotatedMember<X>

+
+
+
+
Type Parameters:
+
X - the declaring type
+
+
+
All Superinterfaces:
+
Annotated
+
+
+
All Known Subinterfaces:
+
AnnotatedCallable<X>, AnnotatedConstructor<X>, AnnotatedField<X>, AnnotatedMethod<X>
+
+
+
public interface AnnotatedMember<X> +extends Annotated
+

+ Represents a member of a Java type. +

+
+
Author:
+
Gavin King, Pete Muir
+
See Also:
+
+ +
+
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      getJavaMember

      +
      Member getJavaMember()
      +

      + Get the underlying Member. +

      +
      +
      Returns:
      +
      the Member
      +
      +
      +
    • +
    • +
      +

      isStatic

      +
      boolean isStatic()
      +

      + Determines if the member is static. +

      +
      +
      Returns:
      +
      true if the member is static
      +
      +
      +
    • +
    • +
      +

      getDeclaringType

      +
      AnnotatedType<X> getDeclaringType()
      +

      + Get the type which defines this member. +

      +
      +
      Returns:
      +
      the type which defines this member
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/AnnotatedMethod.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/AnnotatedMethod.html new file mode 100644 index 0000000000..55692a41a5 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/AnnotatedMethod.html @@ -0,0 +1,219 @@ + + + + +AnnotatedMethod (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface AnnotatedMethod<X>

+
+
+
+
Type Parameters:
+
X - the declaring type
+
+
+
All Superinterfaces:
+
Annotated, AnnotatedCallable<X>, AnnotatedMember<X>
+
+
+
public interface AnnotatedMethod<X> +extends AnnotatedCallable<X>
+

+ Represents a method of a Java type. +

+
+
Author:
+
Gavin King, Pete Muir
+
See Also:
+
+ +
+
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      getJavaMember

      +
      Method getJavaMember()
      +

      + Get the underlying Method. +

      +
      +
      Specified by:
      +
      getJavaMember in interface AnnotatedMember<X>
      +
      Returns:
      +
      the Method
      +
      +
      +
    • +
    • +
      +

      getAnnotations

      +
      default <T extends Annotation> Set<T> getAnnotations(Class<T> annotationType)
      +
      Description copied from interface: Annotated
      +

      + Get program element annotations of a certain annotation type. +

      + This method returns back all annotations, including repeatable annotations of this type. + + The behavior of this method is intended to be the same behavior as AnnotatedElement.getAnnotationsByType(Class), + where repeatable annotations are supported. +

      +
      +
      Specified by:
      +
      getAnnotations in interface Annotated
      +
      Type Parameters:
      +
      T - the type of the annotation
      +
      Parameters:
      +
      annotationType - the class of the annotation type
      +
      Returns:
      +
      the program element annotations of the given annotation type, or an empty collection
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/AnnotatedParameter.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/AnnotatedParameter.html new file mode 100644 index 0000000000..e76661e425 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/AnnotatedParameter.html @@ -0,0 +1,240 @@ + + + + +AnnotatedParameter (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface AnnotatedParameter<X>

+
+
+
+
Type Parameters:
+
X - the type that declares the method or constructor
+
+
+
All Superinterfaces:
+
Annotated
+
+
+
public interface AnnotatedParameter<X> +extends Annotated
+

+ Represents a parameter of a method or constructor. +

+
+
Author:
+
Gavin King, Pete Muir, Jozef Hartinger
+
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      getPosition

      +
      int getPosition()
      +

      + Get the position of the parameter in the method or constructor argument list. +

      +
      +
      Returns:
      +
      the position of the parameter
      +
      +
      +
    • +
    • +
      +

      getDeclaringCallable

      +
      AnnotatedCallable<X> getDeclaringCallable()
      +

      + Get the declaring method or constructor. +

      +
      +
      Returns:
      +
      the declaring callable
      +
      +
      +
    • +
    • +
      +

      getJavaParameter

      +
      default Parameter getJavaParameter()
      +
      Get the underlying Parameter.
      +
      +
      Returns:
      +
      the Parameter
      +
      +
      +
    • +
    • +
      +

      getAnnotations

      +
      default <T extends Annotation> Set<T> getAnnotations(Class<T> annotationType)
      +
      Description copied from interface: Annotated
      +

      + Get program element annotations of a certain annotation type. +

      + This method returns back all annotations, including repeatable annotations of this type. + + The behavior of this method is intended to be the same behavior as AnnotatedElement.getAnnotationsByType(Class), + where repeatable annotations are supported. +

      +
      +
      Specified by:
      +
      getAnnotations in interface Annotated
      +
      Type Parameters:
      +
      T - the type of the annotation
      +
      Parameters:
      +
      annotationType - the class of the annotation type
      +
      Returns:
      +
      the program element annotations of the given annotation type, or an empty collection
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/AnnotatedType.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/AnnotatedType.html new file mode 100644 index 0000000000..995163cbd2 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/AnnotatedType.html @@ -0,0 +1,269 @@ + + + + +AnnotatedType (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface AnnotatedType<X>

+
+
+
+
Type Parameters:
+
X - the type
+
+
+
All Superinterfaces:
+
Annotated
+
+
+
public interface AnnotatedType<X> +extends Annotated
+

+ Represents a Java class or interface. +

+
+
Author:
+
Gavin King, Pete Muir
+
See Also:
+
+ +
+
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      getJavaClass

      +
      Class<X> getJavaClass()
      +

      + Get the underlying Class. +

      +
      +
      Returns:
      +
      the Class
      +
      +
      +
    • +
    • +
      +

      getConstructors

      +
      Set<AnnotatedConstructor<X>> getConstructors()
      +

      + Get the constructors of the type. If an empty set is returned, a default constructor + with no parameters will be assumed. +

      +
      +
      Returns:
      +
      the constructors, or an empty set if none are defined
      +
      +
      +
    • +
    • +
      +

      getMethods

      +
      Set<AnnotatedMethod<? super X>> getMethods()
      +

      + Get the methods of the type. +

      +
      +
      Returns:
      +
      the methods, or an empty set if none are defined
      +
      +
      +
    • +
    • +
      +

      getFields

      +
      Set<AnnotatedField<? super X>> getFields()
      +

      + Get the fields of the type. +

      +
      +
      Returns:
      +
      the fields, or an empty set if none are defined
      +
      +
      +
    • +
    • +
      +

      getAnnotations

      +
      default <T extends Annotation> Set<T> getAnnotations(Class<T> annotationType)
      +
      Description copied from interface: Annotated
      +

      + Get program element annotations of a certain annotation type. +

      + This method returns back all annotations, including repeatable annotations of this type. + + The behavior of this method is intended to be the same behavior as AnnotatedElement.getAnnotationsByType(Class), + where repeatable annotations are supported. +

      +
      +
      Specified by:
      +
      getAnnotations in interface Annotated
      +
      Type Parameters:
      +
      T - the type of the annotation
      +
      Parameters:
      +
      annotationType - the class of the annotation type
      +
      Returns:
      +
      the program element annotations of the given annotation type, or an empty collection
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/Bean.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/Bean.html new file mode 100644 index 0000000000..94306cd26a --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/Bean.html @@ -0,0 +1,199 @@ + + + + +Bean (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface Bean<T>

+
+
+
+
Type Parameters:
+
T - the class of the bean instance
+
+
+
All Superinterfaces:
+
BeanAttributes<T>, Contextual<T>
+
+
+
All Known Subinterfaces:
+
Decorator<T>, Interceptor<T>
+
+
+
public interface Bean<T> +extends Contextual<T>, BeanAttributes<T>
+

+ Represents an enabled bean. This interface defines everything the container needs to + manage instances of the bean. +

+
+
Author:
+
Gavin King, David Allen
+
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      getBeanClass

      +
      Class<?> getBeanClass()
      +
      The bean class of the managed bean or session bean or of the bean that declares the producer method or + field.
      +
      +
      Returns:
      +
      the bean class
      +
      +
      +
    • +
    • +
      +

      getInjectionPoints

      +
      Set<InjectionPoint> getInjectionPoints()
      +
      Obtains the InjectionPoint objects representing injection points of the bean, that + will be validated by the container at initialization time.
      +
      +
      Returns:
      +
      the set of injection points of the bean
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/BeanAttributes.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/BeanAttributes.html new file mode 100644 index 0000000000..53b630017f --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/BeanAttributes.html @@ -0,0 +1,251 @@ + + + + +BeanAttributes (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface BeanAttributes<T>

+
+
+
+
Type Parameters:
+
T - the class of the bean instance
+
+
+
All Known Subinterfaces:
+
Bean<T>, Decorator<T>, Interceptor<T>
+
+
+
public interface BeanAttributes<T>
+
The BeanAttributes interface exposes the basic attributes of a bean.
+
+
Since:
+
1.1
+
Author:
+
Pete Muir
+
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      getTypes

      +
      Set<Type> getTypes()
      +
      Obtains the bean types of the bean.
      +
      +
      Returns:
      +
      the bean types
      +
      +
      +
    • +
    • +
      +

      getQualifiers

      +
      Set<Annotation> getQualifiers()
      +
      Obtains the qualifiers of the bean.
      +
      +
      Returns:
      +
      the qualifiers
      +
      +
      +
    • +
    • +
      +

      getScope

      +
      Class<? extends Annotation> getScope()
      +
      Obtains the scope of the bean.
      +
      +
      Returns:
      +
      the scope
      +
      +
      +
    • +
    • +
      +

      getName

      +
      String getName()
      +
      Obtains the EL name of a bean, if it has one.
      +
      +
      Returns:
      +
      the EL name
      +
      +
      +
    • +
    • +
      +

      getStereotypes

      +
      Set<Class<? extends Annotation>> getStereotypes()
      +
      Obtains the stereotypes of the bean.
      +
      +
      Returns:
      +
      the set of stereotypes
      +
      +
      +
    • +
    • +
      +

      isAlternative

      +
      boolean isAlternative()
      +
      Determines if the bean is an alternative. + + A custom implementation of Bean may implement Prioritized in order to be selected for the application. + Prioritized.getPriority() determines the priority used to resolve ambiguities.
      +
      +
      Returns:
      +
      true if the bean is an alternative, and false + otherwise.
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/BeanContainer.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/BeanContainer.html new file mode 100644 index 0000000000..76a055998f --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/BeanContainer.html @@ -0,0 +1,659 @@ + + + + +BeanContainer (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface BeanContainer

+
+
+
+
All Known Subinterfaces:
+
BeanManager, ELAwareBeanManager
+
+
+
public interface BeanContainer
+

+ BeanContainer is a superclass of BeanManager containing capabilities that are portable across + all CDI environments. +

+ +

+ Provides operations for obtaining contextual references for beans, along with many other operations of use to + CDI applications. +

+ +

+ Any bean may obtain an instance of BeanContainer by injecting it: +

+ +
+ @Inject
+ BeanContainer container;
+ 
+
+
Since:
+
4.0
+
Author:
+
Matej Novotny
+
+
+
+
    + +
  • +
    +

    Method Summary

    +
    +
    +
    +
    +
    Modifier and Type
    +
    Method
    +
    Description
    + + +
    +
    Obtain an instance of a CreationalContext for the given + contextual type, or for a non-contextual object.
    +
    + + +
    +
    Obtains an Instance object to access to beans instances.
    +
    +
    Set<Bean<?>>
    +
    getBeans(Type beanType, + Annotation... qualifiers)
    +
    +
    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 BeanManager/BeanContainer was injected or, + in the Jakarta EE environment, the Jakarta EE component from whose JNDI environment namespace the + BeanManager/BeanContainer was obtained, according to the rules of typesafe resolution.
    +
    +
    Set<Bean<?>>
    + +
    +
    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 BeanManager/BeanContainer was injected or, in the Jakarta EE + environment, the Jakarta EE component from whose JNDI environment namespace the + BeanManager/BeanContainer was obtained, according to the rules of EL name resolution.
    +
    + +
    getContext(Class<? extends Annotation> scopeType)
    +
    +
    Obtains an active context object for the given + scope .
    +
    + +
    getContexts(Class<? extends Annotation> scopeType)
    +
    +
    Obtains all context objects, active and inactive, for the given + scope.
    +
    + + +
    +
    Returns an instance of Event with specified type java.lang.Object and specified qualifier + @Default + It allows typesafe synchronous or asynchronous event firing without injection of Event built-in bean requirement.
    +
    + +
    getReference(Bean<?> bean, + Type beanType, + CreationalContext<?> ctx)
    +
    +
    + Obtains a contextual reference for a certain bean and a certain bean type of the bean.
    +
    +
    boolean
    +
    isInterceptorBinding(Class<? extends Annotation> annotationType)
    +
    +
    Test the given annotation type to determine if it is an interceptor + binding type .
    +
    +
    boolean
    +
    isMatchingBean(Set<Type> beanTypes, + Set<Annotation> beanQualifiers, + Type requiredType, + Set<Annotation> requiredQualifiers)
    +
    +
    Returns true if a bean with given bean types and qualifiers would be assignable + to an injection point with given required type and required qualifiers, false otherwise.
    +
    +
    boolean
    +
    isMatchingEvent(Type specifiedType, + Set<Annotation> specifiedQualifiers, + Type observedEventType, + Set<Annotation> observedEventQualifiers)
    +
    +
    Returns true if an event with given specified type and specified qualifiers would + match an observer method with given observed event type and observed event qualifiers, + false otherwise.
    +
    +
    boolean
    +
    isNormalScope(Class<? extends Annotation> annotationType)
    +
    +
    Test the given annotation type to determine if it is a normal scope type.
    +
    +
    boolean
    +
    isQualifier(Class<? extends Annotation> annotationType)
    +
    +
    Test the given annotation type to determine if it is a qualifier type.
    +
    +
    boolean
    +
    isScope(Class<? extends Annotation> annotationType)
    +
    +
    Test the given annotation type to determine if it is a scope type.
    +
    +
    boolean
    +
    isStereotype(Class<? extends Annotation> annotationType)
    +
    +
    Test the given annotation type to determine if it is a stereotype.
    +
    +
    <X> Bean<? extends X>
    +
    resolve(Set<Bean<? extends X>> beans)
    +
    +
    Apply the ambiguous dependency resolution rules to a set of beans.
    +
    + +
    resolveInterceptors(InterceptionType type, + Annotation... interceptorBindings)
    +
    +
    Return an ordered list of enabled 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 + BeanManager/BeanContainer was injected or, in the Jakarta EE environment, + the Jakarta EE component from whose JNDI environment namespace the + BeanManager/BeanContainer was obtained.
    +
    +
    <T> Set<ObserverMethod<? super T>>
    +
    resolveObserverMethods(T event, + Annotation... qualifiers)
    +
    +
    Return an ordered set of observer methods for an event.
    +
    +
    +
    +
    +
    +
  • +
+
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      getReference

      +
      Object getReference(Bean<?> bean, + Type beanType, + CreationalContext<?> ctx)
      +

      + Obtains a contextual reference for a certain bean and a certain bean type of the bean. +

      +
      +
      Parameters:
      +
      bean - the Bean object representing the bean
      +
      beanType - a bean type that must be implemented by any client proxy that is returned
      +
      ctx - a CreationalContext that may be used to destroy any object with scope + Dependent that is created
      +
      Returns:
      +
      a contextual reference representing the bean
      +
      Throws:
      +
      IllegalArgumentException - if the given type is not a bean type of the given bean
      +
      IllegalStateException - if called during application initialization, before the AfterDeploymentValidation + event is fired.
      +
      +
      +
    • +
    • +
      +

      createCreationalContext

      +
      <T> CreationalContext<T> createCreationalContext(Contextual<T> contextual)
      +
      Obtain an instance of a CreationalContext for the given + contextual type, or for a non-contextual object.
      +
      +
      Type Parameters:
      +
      T - type of the instance
      +
      Parameters:
      +
      contextual - the Contextual, or a null value in the case of a non-contextual + object
      +
      Returns:
      +
      the new CreationalContext
      +
      +
      +
    • +
    • +
      +

      getBeans

      +
      Set<Bean<?>> getBeans(Type beanType, + Annotation... qualifiers)
      +
      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 BeanManager/BeanContainer was injected or, + in the Jakarta EE environment, the Jakarta EE component from whose JNDI environment namespace the + BeanManager/BeanContainer was obtained, according to the rules of typesafe resolution. + If no qualifiers are given, the default qualifier is assumed. +

      + Note that when called during invocation of an AfterBeanDiscovery event observer, + this method will only return beans discovered by the container before the AfterBeanDiscovery event is fired.

      +
      +
      Parameters:
      +
      beanType - the required bean type
      +
      qualifiers - the required qualifiers
      +
      Returns:
      +
      the resulting set of beans
      +
      Throws:
      +
      IllegalArgumentException - if the given type represents a type variable
      +
      IllegalArgumentException - if two instances of the same non repeating qualifier type are given
      +
      IllegalArgumentException - if an instance of an annotation that is not a qualifier type is given
      +
      IllegalStateException - if called during application initialization, before the AfterBeanDiscovery + event is fired.
      +
      +
      +
    • +
    • +
      +

      getBeans

      +
      Set<Bean<?>> getBeans(String name)
      +
      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 BeanManager/BeanContainer was injected or, in the Jakarta EE + environment, the Jakarta EE component from whose JNDI environment namespace the + BeanManager/BeanContainer was obtained, according to the rules of EL name resolution. +

      + Note that when called during invocation of an AfterBeanDiscovery event observer, + this method will only return beans discovered by the container before the AfterBeanDiscovery event is fired.

      +
      +
      Parameters:
      +
      name - the EL name
      +
      Returns:
      +
      the resulting set of beans
      +
      Throws:
      +
      IllegalStateException - if called during application initialization, before the AfterBeanDiscovery + event is fired.
      +
      +
      +
    • +
    • +
      +

      resolve

      +
      <X> Bean<? extends X> resolve(Set<Bean<? extends X>> beans)
      +
      Apply the ambiguous dependency resolution rules to a set of beans. +

      + Note that when called during invocation of an AfterBeanDiscovery event observer, + this method will only return beans discovered by the container before the AfterBeanDiscovery event is fired.

      +
      +
      Type Parameters:
      +
      X - a common type of the beans
      +
      Parameters:
      +
      beans - a set of beans of the given type
      +
      Returns:
      +
      the resolved bean, or null if null or an empty set is passed
      +
      Throws:
      +
      AmbiguousResolutionException - if the ambiguous dependency resolution rules fail
      +
      IllegalStateException - if called during application initialization, before the AfterBeanDiscovery + event is fired.
      +
      +
      +
    • +
    • +
      +

      resolveObserverMethods

      +
      <T> Set<ObserverMethod<? super T>> resolveObserverMethods(T event, + Annotation... qualifiers)
      +
      Return an ordered set of observer methods for an event. +

      + Note that when called during invocation of an AfterBeanDiscovery event observer, + this method will only return observers discovered by the container before the AfterBeanDiscovery event is fired.

      +
      +
      Type Parameters:
      +
      T - the type of the event
      +
      Parameters:
      +
      event - the event object
      +
      qualifiers - the event qualifiers
      +
      Returns:
      +
      the resulting set of observer methods
      +
      Throws:
      +
      IllegalArgumentException - if the runtime type of the event object contains a type variable
      +
      IllegalArgumentException - if two instances of the same non repeating qualifier type are given
      +
      IllegalArgumentException - if an instance of an annotation that is not a qualifier type is given
      +
      IllegalStateException - if called during application initialization, before the AfterBeanDiscovery + event is fired.
      +
      +
      +
    • +
    • +
      +

      resolveInterceptors

      +
      List<Interceptor<?>> resolveInterceptors(InterceptionType type, + Annotation... interceptorBindings)
      +
      Return an ordered list of enabled 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 + BeanManager/BeanContainer was injected or, in the Jakarta EE environment, + the Jakarta EE component from whose JNDI environment namespace the + BeanManager/BeanContainer was obtained. +

      + Note that when called during invocation of an AfterBeanDiscovery event observer, + this method will only return interceptors discovered by the container before the AfterBeanDiscovery event is + fired.

      +
      +
      Parameters:
      +
      type - the type of the interception
      +
      interceptorBindings - the interceptor bindings
      +
      Returns:
      +
      the resulting set of interceptors
      +
      Throws:
      +
      IllegalArgumentException - if no interceptor binding type is given
      +
      IllegalArgumentException - if two instances of the same interceptor binding type are given
      +
      IllegalArgumentException - if an instance of an annotation that is not an interceptor binding type is given
      +
      IllegalStateException - if called during application initialization, before the AfterBeanDiscovery + event is fired.
      +
      +
      +
    • +
    • +
      +

      isScope

      +
      boolean isScope(Class<? extends Annotation> annotationType)
      +
      Test the given annotation type to determine if it is a scope type.
      +
      +
      Parameters:
      +
      annotationType - the annotation type
      +
      Returns:
      +
      true if the annotation type is a scope type
      +
      +
      +
    • +
    • +
      +

      isNormalScope

      +
      boolean isNormalScope(Class<? extends Annotation> annotationType)
      +
      Test the given annotation type to determine if it is a normal scope type.
      +
      +
      Parameters:
      +
      annotationType - the annotation type
      +
      Returns:
      +
      true if the annotation type is a normal scope type
      +
      +
      +
    • +
    • +
      +

      isQualifier

      +
      boolean isQualifier(Class<? extends Annotation> annotationType)
      +
      Test the given annotation type to determine if it is a qualifier type.
      +
      +
      Parameters:
      +
      annotationType - the annotation type
      +
      Returns:
      +
      true if the annotation type is a qualifier type
      +
      +
      +
    • +
    • +
      +

      isStereotype

      +
      boolean isStereotype(Class<? extends Annotation> annotationType)
      +
      Test the given annotation type to determine if it is a stereotype.
      +
      +
      Parameters:
      +
      annotationType - the annotation type
      +
      Returns:
      +
      true if the annotation type is a stereotype
      +
      +
      +
    • +
    • +
      +

      isInterceptorBinding

      +
      boolean isInterceptorBinding(Class<? extends Annotation> annotationType)
      +
      Test the given annotation type to determine if it is an interceptor + binding type .
      +
      +
      Parameters:
      +
      annotationType - the annotation to test
      +
      Returns:
      +
      true if the annotation type is a interceptor + binding + type
      +
      +
      +
    • +
    • +
      +

      getContext

      +
      Context getContext(Class<? extends Annotation> scopeType)
      +
      Obtains an active context object for the given + scope .
      +
      +
      Parameters:
      +
      scopeType - the scope
      +
      Returns:
      +
      the context object
      +
      Throws:
      +
      ContextNotActiveException - if there is no active context object for the given scope
      +
      IllegalArgumentException - if there is more than one active context object for the given scope
      +
      +
      +
    • +
    • +
      +

      getContexts

      +
      Collection<Context> getContexts(Class<? extends Annotation> scopeType)
      +
      Obtains all context objects, active and inactive, for the given + scope.
      +
      +
      Parameters:
      +
      scopeType - the scope; must not be null
      +
      Returns:
      +
      immutable collection of context objects; never null, but may be empty
      +
      +
      +
    • +
    • +
      +

      getEvent

      +
      Event<Object> getEvent()
      +
      Returns an instance of Event with specified type java.lang.Object and specified qualifier + @Default + It allows typesafe synchronous or asynchronous event firing without injection of Event built-in bean requirement.
      +
      +
      Returns:
      +
      a new Event object whose event type is Object and qualifier @Default
      +
      Since:
      +
      2.0
      +
      +
      +
    • +
    • +
      +

      createInstance

      +
      Instance<Object> createInstance()
      +
      Obtains an Instance object to access to beans instances. +

      + The returned Instance object can only access instances of beans that are available for injection in the + module or library containing the class into which the BeanManager/BeanContainer was injected + or, in the Jakarta EE environment, the Jakarta EE component from whose JNDI environment namespace the + BeanContainer was obtained, according to the rules of typesafe resolution. +

      + Instances of dependent scoped beans obtained with this Instance must be explicitly destroyed by calling + Instance.destroy(Object) +

      + If no qualifier is passed to Instance.select(java.lang.annotation.Annotation...) method, the @Default qualifier is assumed.

      +
      +
      Returns:
      +
      an Instance object to request beans instances
      +
      Throws:
      +
      IllegalStateException - if called during application initialization, before the AfterDeploymentValidation + event is fired.
      +
      Since:
      +
      2.0
      +
      +
      +
    • +
    • +
      +

      isMatchingBean

      +
      boolean isMatchingBean(Set<Type> beanTypes, + Set<Annotation> beanQualifiers, + Type requiredType, + Set<Annotation> requiredQualifiers)
      +
      Returns true if a bean with given bean types and qualifiers would be assignable + to an injection point with given required type and required qualifiers, false otherwise. +

      + In line with the specification for beans and typesafe resolution, the set of + beanTypes is considered to always include java.lang.Object. + Types in beanTypes that are not legal bean types are ignored. + The set of beanQualifiers is considered to always include @Any and + also include @Default when it contains no other qualifier but @Any + and @Named. The set of requiredQualifiers is considered to include + @Default when it is empty. +

      + Throws IllegalArgumentException if any of the arguments is null + or if any of the beanQualifiers or requiredQualifiers is not + a qualifier annotation.

      +
      +
      Parameters:
      +
      beanTypes - bean types of a bean; must not be null
      +
      beanQualifiers - qualifiers of a bean; must not be null
      +
      requiredType - required type of an injection point; must not be null
      +
      requiredQualifiers - required qualifiers of an injection point; must not be null
      +
      Returns:
      +
      true if a bean with given bean types and qualifiers would be assignable + to an injection point with given required type and required qualifiers, false otherwise
      +
      +
      +
    • +
    • +
      +

      isMatchingEvent

      +
      boolean isMatchingEvent(Type specifiedType, + Set<Annotation> specifiedQualifiers, + Type observedEventType, + Set<Annotation> observedEventQualifiers)
      +
      Returns true if an event with given specified type and specified qualifiers would + match an observer method with given observed event type and observed event qualifiers, + false otherwise. +

      + For the purpose of observer resolution, the specifiedType is used as the event type + directly (because there is no event object in this API) and specifiedQualifiers are + used as event qualifiers. In line with the specification for events and observer resolution, + the set of event qualifiers is considered to always include @Any. Further, an empty + set of specifiedQualifiers is considered to match the set of observedEventQualifiers + which contains @Default. +

      + Throws IllegalArgumentException if any of the arguments is null, + if the specifiedType contains a type variable, or if any of the specifiedQualifiers + or observedEventQualifiers is not a qualifier annotation.

      +
      +
      Parameters:
      +
      specifiedType - specified type of an event; must not be null
      +
      specifiedQualifiers - specified qualifiers of an event; must not be null
      +
      observedEventType - observed event type of an observer method; must not be null
      +
      observedEventQualifiers - observed event qualifiers on an observer method; must not be null
      +
      Returns:
      +
      true if an event object with given type and qualifiers would result in notifying + an observer method with given observed event type and observed event qualifiers, false otherwise
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/BeanManager.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/BeanManager.html new file mode 100644 index 0000000000..9f5f95b6c4 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/BeanManager.html @@ -0,0 +1,857 @@ + + + + +BeanManager (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface BeanManager

+
+
+
+
All Superinterfaces:
+
BeanContainer
+
+
+
All Known Subinterfaces:
+
ELAwareBeanManager
+
+
+
public interface BeanManager +extends BeanContainer
+

+ Allows a portable extension to interact directly with the container. Provides operations for obtaining contextual references + for beans, along with many other operations of use to portable extensions. +

+ +

+ In CDI Lite environment, applications may obtain a BeanManager, but invoking methods that are not inherited from + BeanContainer results in non-portable behavior. +

+ +

+ Any bean may obtain an instance of BeanManager by injecting it: +

+ +
+ @Inject
+ BeanManager manager;
+ 
+ +

+ Java EE components may obtain an instance of BeanManager from JNDI by looking up the + name java:comp/BeanManager. +

+ +

+ Most operations of BeanManager may be called at any time during the execution of the application. +

+

+ However, the following operations must not be called before the AfterBeanDiscovery event is fired: +

+ +

+ and the following operations must not be called before the AfterDeploymentValidation event is fired: +

+ +

+ or the container will throw an Exception. +

+
+
Author:
+
Gavin King, Pete Muir, Clint Popetz, David Allen, Antoine Sabot-Durand
+
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      getInjectableReference

      +
      Object getInjectableReference(InjectionPoint ij, + CreationalContext<?> ctx)
      +

      + Obtains an injectable reference for a certain injection point. +

      +
      +
      Parameters:
      +
      ij - the target injection point
      +
      ctx - a CreationalContext that may be used to destroy any object with scope + Dependent that is created
      +
      Returns:
      +
      the injectable reference
      +
      Throws:
      +
      UnsatisfiedResolutionException - if typesafe resolution results in an unsatisfied dependency
      +
      AmbiguousResolutionException - typesafe resolution results in an unresolvable ambiguous dependency
      +
      IllegalStateException - if called during application initialization, before the AfterDeploymentValidation + event is fired.
      +
      +
      +
    • +
    • +
      +

      getPassivationCapableBean

      +
      Bean<?> getPassivationCapableBean(String id)
      +
      Returns the PassivationCapable bean with the given identifier. + + Note that when called during invocation of an AfterBeanDiscovery event observer, + this method will only return beans discovered by the container before the AfterBeanDiscovery event is fired.
      +
      +
      Parameters:
      +
      id - the identifier
      +
      Returns:
      +
      a Bean that implements PassivationCapable and has the given + identifier, or a null value if there is no such bean
      +
      Throws:
      +
      IllegalStateException - if called during application initialization, before the AfterBeanDiscovery + event is fired.
      +
      +
      +
    • +
    • +
      +

      validate

      +
      void validate(InjectionPoint injectionPoint)
      +
      Validate a certain injection point. + + Note that when called during invocation of an AfterBeanDiscovery event observer, + this method will only validate injection points discovered by the container before the AfterBeanDiscovery + event is fired.
      +
      +
      Parameters:
      +
      injectionPoint - the injection point to validate
      +
      Throws:
      +
      InjectionException - if there is a deployment problem (for example, an unsatisfied or unresolvable ambiguous + dependency) associated with the injection point
      +
      IllegalStateException - if called during application initialization, before the AfterBeanDiscovery + event is fired.
      +
      +
      +
    • +
    • +
      +

      resolveDecorators

      +
      List<Decorator<?>> resolveDecorators(Set<Type> types, + Annotation... qualifiers)
      +
      Return an ordered list of 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 BeanManager was injected or the Java EE + component from whose JNDI environment namespace the BeanManager was obtained. + + Note that when called during invocation of an AfterBeanDiscovery event observer, + this method will only return decorators discovered by the container before the AfterBeanDiscovery event is fired.
      +
      +
      Parameters:
      +
      types - the set of bean types of the decorated bean
      +
      qualifiers - the qualifiers declared by the decorated bean
      +
      Returns:
      +
      the resulting set of decorators
      +
      Throws:
      +
      IllegalArgumentException - if the set of bean types is empty
      +
      IllegalArgumentException - if an annotation which is not a binding type is passed
      +
      IllegalArgumentException - if two instances of the same binding type are passed
      +
      IllegalStateException - if called during application initialization, before the AfterBeanDiscovery + event is fired.
      +
      +
      +
    • +
    • +
      +

      isPassivatingScope

      +
      boolean isPassivatingScope(Class<? extends Annotation> annotationType)
      +
      Test the given annotation type to determine if it is a passivating scope type.
      +
      +
      Parameters:
      +
      annotationType - the annotation type
      +
      Returns:
      +
      true if the annotation type is a passivating scope type
      +
      +
      +
    • +
    • +
      +

      getInterceptorBindingDefinition

      +
      Set<Annotation> getInterceptorBindingDefinition(Class<? extends Annotation> bindingType)
      +
      Obtains the set of meta-annotations for a certain interceptor binding + type .
      +
      +
      Parameters:
      +
      bindingType - the interceptor binding type
      +
      Returns:
      +
      the set of meta-annotations
      +
      +
      +
    • +
    • +
      +

      getStereotypeDefinition

      +
      Set<Annotation> getStereotypeDefinition(Class<? extends Annotation> stereotype)
      +
      Obtains meta-annotations for a certain stereotype.
      +
      +
      Parameters:
      +
      stereotype - the stereotype
      +
      Returns:
      +
      the set of meta-annotations
      +
      +
      +
    • +
    • +
      +

      areQualifiersEquivalent

      +
      boolean areQualifiersEquivalent(Annotation qualifier1, + Annotation qualifier2)
      +
      Determine if two qualifiers are considered equivalent for the purposes of typesafe resolution, taking into account any + members annotated with Nonbinding.
      +
      +
      Parameters:
      +
      qualifier1 - a qualifier to check
      +
      qualifier2 - a qualifier to check
      +
      Returns:
      +
      true if the two qualifiers are equivalent, otherwise false
      +
      Since:
      +
      1.1
      +
      +
      +
    • +
    • +
      +

      areInterceptorBindingsEquivalent

      +
      boolean areInterceptorBindingsEquivalent(Annotation interceptorBinding1, + Annotation interceptorBinding2)
      +
      Determine if two interceptor bindings are considered equivalent for the purposes of typesafe resolution, taking into + account any members annotated with Nonbinding.
      +
      +
      Parameters:
      +
      interceptorBinding1 - an interceptor binding to check
      +
      interceptorBinding2 - an interceptor binding to check
      +
      Returns:
      +
      true if the two interceptor bindings are equivalent, otherwise false
      +
      Since:
      +
      1.1
      +
      +
      +
    • +
    • +
      +

      getQualifierHashCode

      +
      int getQualifierHashCode(Annotation qualifier)
      +
      Determine the hash code of a qualifier, using the JDK algorithm for determining an annotation hash code, ignoring any + members annotated with Nonbinding.
      +
      +
      Parameters:
      +
      qualifier - the qualifier to consider
      +
      Returns:
      +
      the hashCode for the qualifier
      +
      Since:
      +
      1.1
      +
      +
      +
    • +
    • +
      +

      getInterceptorBindingHashCode

      +
      int getInterceptorBindingHashCode(Annotation interceptorBinding)
      +
      Determine the hash code of an interceptor binding, using the JDK algorithm for determining an annotation hash code, + ignoring any members annotated with Nonbinding.
      +
      +
      Parameters:
      +
      interceptorBinding - the interceptor binding to consider
      +
      Returns:
      +
      the hashCode for the interceptor binding
      +
      Since:
      +
      1.1
      +
      +
      +
    • +
    • +
      +

      getELResolver

      +
      @Deprecated(since="4.1", + forRemoval=true) +jakarta.el.ELResolver getELResolver()
      +
      Deprecated, for removal: This API element is subject to removal in a future version. +
      use ELAwareBeanManager, this method will be removed in CDI 5.0
      +
      +
      Returns a ELResolver that resolves beans by EL name.
      +
      +
      Returns:
      +
      the ELResolver
      +
      +
      +
    • +
    • +
      +

      wrapExpressionFactory

      +
      @Deprecated(since="4.1", + forRemoval=true) +jakarta.el.ExpressionFactory wrapExpressionFactory(jakarta.el.ExpressionFactory expressionFactory)
      +
      Deprecated, for removal: This API element is subject to removal in a future version. +
      use ELAwareBeanManager, this method will be removed in CDI 5.0
      +
      +
      Returns a wrapper ExpressionFactory that delegates MethodExpression and + ValueExpression creation to the given ExpressionFactory. When a Unified EL + expression is evaluated using a MethodExpression or ValueExpression returned by the + wrapper ExpressionFactory, the container handles destruction of objects with scope Dependent.
      +
      +
      Parameters:
      +
      expressionFactory - the ExpressionFactory to wrap
      +
      Returns:
      +
      the wrapped ExpressionFactory
      +
      +
      +
    • +
    • +
      +

      createAnnotatedType

      +
      <T> AnnotatedType<T> createAnnotatedType(Class<T> type)
      +
      Obtain an AnnotatedType that may be used to read the annotations of the given class or interface.
      +
      +
      Type Parameters:
      +
      T - the class or interface
      +
      Parameters:
      +
      type - the Class object
      +
      Returns:
      +
      the AnnotatedType
      +
      +
      +
    • +
    • +
      +

      getInjectionTargetFactory

      +
      <T> InjectionTargetFactory<T> getInjectionTargetFactory(AnnotatedType<T> annotatedType)
      +

      + An implementation of InjectionTargetFactory that provides container created InjectionTarget instances. +

      + +

      + This factory can be wrapped to add behavior to container created injection targets. +

      +
      +
      Type Parameters:
      +
      T - the type
      +
      Parameters:
      +
      annotatedType - the annotated type to create the injection target factory for
      +
      Returns:
      +
      an InjectionTargetFactory
      +
      Since:
      +
      1.1
      +
      +
      +
    • +
    • +
      +

      getProducerFactory

      +
      <X> ProducerFactory<X> getProducerFactory(AnnotatedField<? super X> field, + Bean<X> declaringBean)
      +

      + An implementation of ProducerFactory that provides container created Producer instances for the given + field. +

      + +

      + This factory can be wrapped to add behavior to container created producers. +

      +
      +
      Type Parameters:
      +
      X - the declaring type
      +
      Parameters:
      +
      field - the field to create the producer factory for
      +
      declaringBean - the bean declaring the producer. May be null if the producer is static or the declaring object is + non-contextual
      +
      Returns:
      +
      the producer factory for the field
      +
      Since:
      +
      1.1
      +
      +
      +
    • +
    • +
      +

      getProducerFactory

      +
      <X> ProducerFactory<X> getProducerFactory(AnnotatedMethod<? super X> method, + Bean<X> declaringBean)
      +

      + An implementation of ProducerFactory that provides container created Producer instances for the given + method. +

      + +

      + This factory can be wrapped to add behavior to container created producers. +

      +
      +
      Type Parameters:
      +
      X - bean type
      +
      Parameters:
      +
      method - the method to create the producer factory for
      +
      declaringBean - the bean declaring the producer. May be null if the producer is static or the declaring object is + non-contextual
      +
      Returns:
      +
      the producer factory for the method
      +
      Since:
      +
      1.1
      +
      +
      +
    • +
    • +
      +

      createBeanAttributes

      +
      <T> BeanAttributes<T> createBeanAttributes(AnnotatedType<T> type)
      +
      Obtains a BeanAttributes for the given AnnotatedType. The container ignores the annotations and types + declared by the elements of the actual Java class and uses the metadata provided via the Annotated interface + instead.
      +
      +
      Type Parameters:
      +
      T - the type
      +
      Parameters:
      +
      type - the AnnotatedType
      +
      Returns:
      +
      a container provided implementation of InjectionTarget
      +
      Since:
      +
      1.1
      +
      +
      +
    • +
    • +
      +

      createBeanAttributes

      +
      BeanAttributes<?> createBeanAttributes(AnnotatedMember<?> type)
      +
      Obtains a BeanAttributes for the given AnnotatedType. The container ignores the annotations and types + declared by the elements of the actual Java class and uses the metadata provided via the Annotated interface + instead.
      +
      +
      Parameters:
      +
      type - the AnnotatedType
      +
      Returns:
      +
      a container provided implementation of InjectionTarget
      +
      Since:
      +
      1.1
      +
      +
      +
    • +
    • +
      +

      createBean

      +
      <T> Bean<T> createBean(BeanAttributes<T> attributes, + Class<T> beanClass, + InjectionTargetFactory<T> injectionTargetFactory)
      +

      + Obtains a Bean for the given BeanAttributes, bean class and InjectionTarget. +

      + +

      + The InjectionTarget creates and destroys instances of the bean, performs dependency injection and lifecycle + callbacks, and determines the return value of Bean.getInjectionPoints(). The InjectionTarget is obtained + from the InjectionTargetFactory. getInjectionTargetFactory(AnnotatedType) allows use of a container + created InjectionTarget. +

      +
      +
      Type Parameters:
      +
      T - the type
      +
      Parameters:
      +
      attributes - a BeanAttributes which determines the bean types, qualifiers, scope, name and stereotypes of + the returned Bean, and the return value of BeanAttributes.isAlternative()
      +
      beanClass - a class, which determines the return value of Bean.getBeanClass()
      +
      injectionTargetFactory - an InjectionTargetFactory, used to obtain an InjectionTarget
      +
      Returns:
      +
      a container provided implementation of Bean
      +
      Since:
      +
      1.1
      +
      +
      +
    • +
    • +
      +

      createBean

      +
      <T, +X> Bean<T> createBean(BeanAttributes<T> attributes, + Class<X> beanClass, + ProducerFactory<X> producerFactory)
      +

      + Obtains a Bean for the given BeanAttributes, bean class and Producer. +

      + +

      + The Producer creates and destroys instances of the decorator, and determines the return value of + Bean.getInjectionPoints(). The Producer is obtained from the ProducerFactory. + getProducerFactory(AnnotatedMethod, Bean) or getProducerFactory(AnnotatedField, Bean) allows use of a + container created Producer. +

      +
      +
      Type Parameters:
      +
      T - the type
      +
      X - the type of the declaring bean
      +
      Parameters:
      +
      attributes - a BeanAttributes which determines the bean types, qualifiers, scope, name and stereotypes of + the returned Bean, and the return value of BeanAttributes.isAlternative()
      +
      beanClass - a class, which determines the return value of Bean.getClass()
      +
      producerFactory - a ProducerFactory, used to obtain a Producer
      +
      Returns:
      +
      a container provided implementation of Bean
      +
      Since:
      +
      1.1
      +
      +
      +
    • +
    • +
      +

      createInjectionPoint

      +
      InjectionPoint createInjectionPoint(AnnotatedField<?> field)
      +
      Obtains a container provided implementation of InjectionPoint for the given AnnotatedField.
      +
      +
      Parameters:
      +
      field - the AnnotatedField defining the injection point
      +
      Returns:
      +
      the container provided InjectionPoint
      +
      Throws:
      +
      IllegalArgumentException - if there is a definition error associated with the injection point
      +
      Since:
      +
      1.1
      +
      +
      +
    • +
    • +
      +

      createInjectionPoint

      +
      InjectionPoint createInjectionPoint(AnnotatedParameter<?> parameter)
      +
      Obtains a container provided implementation of InjectionPoint for the given AnnotatedParameter.
      +
      +
      Parameters:
      +
      parameter - the AnnotatedParameter defining the injection point
      +
      Returns:
      +
      the container provided InjectionPoint
      +
      Throws:
      +
      IllegalArgumentException - if there is a definition error associated with the injection point
      +
      Since:
      +
      1.1
      +
      +
      +
    • +
    • +
      +

      getExtension

      +
      <T extends Extension> T getExtension(Class<T> extensionClass)
      +
      Obtains the container's instance of an Extension class declared in META-INF/services.
      +
      +
      Type Parameters:
      +
      T - the type of the extension
      +
      Parameters:
      +
      extensionClass - the type of the extension class
      +
      Returns:
      +
      the extension instance
      +
      Throws:
      +
      IllegalArgumentException - if the container has no instance of the given class
      +
      Since:
      +
      1.1
      +
      +
      +
    • +
    • +
      +

      createInterceptionFactory

      +
      <T> InterceptionFactory<T> createInterceptionFactory(CreationalContext<T> ctx, + Class<T> clazz)
      +
      Create an InterceptionFactory for the given CreationalContext and type.
      +
      +
      Type Parameters:
      +
      T - type of the instance this factory will work on
      +
      Parameters:
      +
      ctx - CreationalContext for the InterceptionFactory to create
      +
      clazz - class of the instance this factory will work on
      +
      Returns:
      +
      a new InterceptionFactory to add services on on instances of T
      +
      Since:
      +
      2.0
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/BeforeBeanDiscovery.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/BeforeBeanDiscovery.html new file mode 100644 index 0000000000..241be5eef0 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/BeforeBeanDiscovery.html @@ -0,0 +1,479 @@ + + + + +BeforeBeanDiscovery (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface BeforeBeanDiscovery

+
+
+
+
public interface BeforeBeanDiscovery
+

+ This event type is thrown by the container before the bean discovery process begins. If any observer method of the + BeforeBeanDiscovery event throws an exception, the exception is treated as a definition error by the container. +

+ +

+ CDI Lite implementations are not required to provide support for Portable Extensions. +

+
+
Author:
+
Pete Muir, David Allen, Antoine Sabot-Durand
+
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      addQualifier

      +
      void addQualifier(Class<? extends Annotation> qualifier)
      +

      + Declares an annotation type as a Qualifier qualifier type. +

      + +

      + This is only required if you wish to make an annotation a qualifier without adding Qualifier to it. +

      +
      +
      Parameters:
      +
      qualifier - The annotation to treat as a qualifier
      +
      Throws:
      +
      IllegalStateException - if called outside of the observer method invocation
      +
      +
      +
    • +
    • +
      +

      addQualifier

      +
      void addQualifier(AnnotatedType<? extends Annotation> qualifier)
      +

      + Declares an annotation type as a Qualifier qualifier type. +

      + +

      + This is only required if you wish to make an annotation a qualifier without adding Qualifier to it. +

      +
      +
      Parameters:
      +
      qualifier - The annotation to treat as a qualifier
      +
      Throws:
      +
      IllegalStateException - if called outside of the observer method invocation
      +
      Since:
      +
      1.1
      +
      +
      +
    • +
    • +
      +

      addScope

      +
      void addScope(Class<? extends Annotation> scopeType, + boolean normal, + boolean passivating)
      +

      + Declares an annotation type as a scope type. +

      + +

      + This is only required if you wish to make an annotation a scope type without adding the NormalScope or + Scope annotations to it. You can also use this method to override an existing normal scope definition. +

      +
      +
      Parameters:
      +
      scopeType - The annotation type to treat as a scope type
      +
      normal - Indicates if the scope is normal
      +
      passivating - Indicates if the scope is passivation + capable
      +
      Throws:
      +
      IllegalStateException - if called outside of the observer method invocation
      +
      See Also:
      +
      + +
      +
      +
      +
    • +
    • +
      +

      addStereotype

      +
      void addStereotype(Class<? extends Annotation> stereotype, + Annotation... stereotypeDef)
      +

      + Declares an annotation type as a stereotype, and specifies its + meta-annotations. +

      + +

      + This is only required if you wish to make an annotation a stereotype without adding Stereotype to it. You can + also use this method to override an existing stereotype definition. +

      +
      +
      Parameters:
      +
      stereotype - The annotation type to treat as a stereotype
      +
      stereotypeDef - An optional list of annotations defining the stereotype
      +
      Throws:
      +
      IllegalStateException - if called outside of the observer method invocation
      +
      +
      +
    • +
    • +
      +

      addInterceptorBinding

      +
      void addInterceptorBinding(AnnotatedType<? extends Annotation> bindingType)
      +

      + Declares an annotation type as an interceptor binding type. +

      + +

      + This is only required if you wish to make an annotation an interceptor binding type without adding + InterceptorBinding to it. +

      +
      +
      Parameters:
      +
      bindingType - The annotation type to treat as an interceptor binding type
      +
      Throws:
      +
      IllegalStateException - if called outside of the observer method invocation
      +
      +
      +
    • +
    • +
      +

      addInterceptorBinding

      +
      void addInterceptorBinding(Class<? extends Annotation> bindingType, + Annotation... bindingTypeDef)
      +

      + Declares an annotation type as an interceptor binding type, and specifies its meta-annotations. +

      + +

      + This is only required if you wish to make an annotation an interceptor binding type without adding + InterceptorBinding to it. +

      +
      +
      Parameters:
      +
      bindingType - The annotation type to treat as an interceptor binding type
      +
      bindingTypeDef - An optional list of annotations defining the interceptor
      +
      Throws:
      +
      IllegalStateException - if called outside of the observer method invocation
      +
      Since:
      +
      1.1
      +
      +
      +
    • +
    • +
      +

      addAnnotatedType

      +
      void addAnnotatedType(AnnotatedType<?> type, + String id)
      +

      + Adds a given AnnotatedType to the set of types which will be scanned during bean discovery. +

      + +

      + Thanks to the id parameter, this method allows multiple annotated types, based on the same underlying type, to be + defined. AnnotatedTypes discovered by the container use the fully qualified class name of + AnnotatedType.getJavaClass() to identify the type. +

      + +

      + AfterBeanDiscovery.getAnnotatedType(Class, String) and AfterBeanDiscovery.getAnnotatedTypes(Class) allows + annotated types to be obtained by identifier. +

      +
      +
      Parameters:
      +
      type - The AnnotatedType to add for later scanning
      +
      id - the identifier used to distinguish this AnnotatedType from an other one based on the same underlying type
      +
      Throws:
      +
      IllegalStateException - if called outside of the observer method invocation
      +
      Since:
      +
      1.1
      +
      +
      +
    • +
    • +
      +

      addAnnotatedType

      +
      <T> AnnotatedTypeConfigurator<T> addAnnotatedType(Class<T> type, + String id)
      +

      + Obtains a new AnnotatedTypeConfigurator to configure a new AnnotatedType and + add it to the set of types which will be scanned during bean discovery at the end of the observer invocation +

      + +

      + Thanks to the id parameter, this method allows multiple annotated types, based on the same underlying type, to be defined + with a builder. + AnnotatedTypes discovered by the container use the fully qualified class name of + AnnotatedType.getJavaClass() to identify the type. +

      + +

      + AfterBeanDiscovery.getAnnotatedType(Class, String) and AfterBeanDiscovery.getAnnotatedTypes(Class) allows + annotated types to be obtained by identifier. +

      + + Each call returns a new AnnotatedTypeConfigurator
      +
      +
      Type Parameters:
      +
      T - class type
      +
      Parameters:
      +
      type - class used to initialized the type and annotations on the AnnotatedTypeConfigurator
      +
      id - the identifier used to distinguish this AnnotatedType from an other one based on the same underlying type
      +
      Returns:
      +
      a non reusable AnnotatedTypeConfigurator to configure the new AnnotatedType
      +
      Throws:
      +
      IllegalStateException - if called outside of the observer method invocation
      +
      Since:
      +
      2.0
      +
      +
      +
    • +
    • +
      +

      configureQualifier

      +
      <T extends Annotation> AnnotatedTypeConfigurator<T> configureQualifier(Class<T> qualifier)
      +

      + Obtains a new AnnotatedTypeConfigurator to configure a new AnnotatedType + and declares it as a Qualifier qualifier type. +

      + +

      + This is only required if you wish to make an annotation a qualifier without adding Qualifier to it and need to + easily add other annotations (like Nonbinding on its members. +

      +
      +
      Type Parameters:
      +
      T - qualifier type
      +
      Parameters:
      +
      qualifier - The annotation class used to initialized the configurator
      +
      Returns:
      +
      a non reusable AnnotatedTypeConfigurator to configure the qualifier
      +
      Throws:
      +
      IllegalStateException - if called outside of the observer method invocation
      +
      Since:
      +
      2.0
      +
      +
      +
    • +
    • +
      +

      configureInterceptorBinding

      +
      <T extends Annotation> AnnotatedTypeConfigurator<T> configureInterceptorBinding(Class<T> bindingType)
      +

      + Obtains a new AnnotatedTypeConfigurator to configure a new AnnotatedType + and declares it as an interceptor binding type. +

      + +

      + This is only required if you wish to make an annotation an interceptor binding type without adding + InterceptorBinding to it and need to easily add other annotations + (like Nonbinding on its members. +

      +
      +
      Type Parameters:
      +
      T - binding class type
      +
      Parameters:
      +
      bindingType - The annotation class used to initialized the configurator
      +
      Returns:
      +
      a non reusable AnnotatedTypeConfigurator to configure the interceptor binding
      +
      Throws:
      +
      IllegalStateException - if called outside of the observer method invocation
      +
      Since:
      +
      2.0
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/BeforeShutdown.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/BeforeShutdown.html new file mode 100644 index 0000000000..33fbe49f0c --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/BeforeShutdown.html @@ -0,0 +1,116 @@ + + + + +BeforeShutdown (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface BeforeShutdown

+
+
+
+
public interface BeforeShutdown
+

+ 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 BeforeShutdown event throws an exception, the exception is ignored by the container. +

+ +

+ CDI Lite implementations are not required to provide support for Portable Extensions. +

+
+
Author:
+
David Allen
+
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/CDI.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/CDI.html new file mode 100644 index 0000000000..9684443d55 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/CDI.html @@ -0,0 +1,338 @@ + + + + +CDI (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Class CDI<T>

+
+
java.lang.Object +
jakarta.enterprise.inject.spi.CDI<T>
+
+
+
+
Type Parameters:
+
T - type inherited from Instance. Always Object for CDI
+
+
+
All Implemented Interfaces:
+
Instance<T>, jakarta.inject.Provider<T>, Iterable<T>
+
+
+
public abstract class CDI<T> +extends Object +implements Instance<T>
+
Provides access to the current container. + +

+ CDI implements Instance and therefore might be used to perform programmatic lookup. + If no qualifier is passed to Instance.select(java.lang.annotation.Annotation...) method, the @Default qualifier is assumed. +

+
+
Since:
+
1.1
+
Author:
+
Pete Muir, Antoine Sabot-Durand, John D. Ament
+
+
+
+ +
+
+
    + +
  • +
    +

    Field Details

    +
      +
    • +
      +

      discoveredProviders

      +
      protected static volatile Set<CDIProvider> discoveredProviders
      +
      The set of discovered CDIProviders
      +
      +
    • +
    • +
      +

      configuredProvider

      +
      protected static volatile CDIProvider configuredProvider
      +
      CDIProvider set by user or retrieved by service loader
      +
      +
    • +
    +
    +
  • + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      CDI

      +
      public CDI()
      +
      +
    • +
    +
    +
  • + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      current

      +
      public static CDI<Object> current()
      +

      + Get the CDI instance that provides access to the current container. +

      + +

      + If there are no providers available, an IllegalStateException is thrown, otherwise the first provider which can + access the container is used. +

      +
      +
      Returns:
      +
      the CDI instance
      +
      Throws:
      +
      IllegalStateException - if no CDIProvider is available
      +
      +
      +
    • +
    • +
      +

      setCDIProvider

      +
      public static void setCDIProvider(CDIProvider provider)
      +

      + Set the CDIProvider to use. +

      + +

      + If a CDIProvider is set using this method, any provider specified as a service provider will not be used. +

      +
      +
      Parameters:
      +
      provider - the provider to use
      +
      Throws:
      +
      IllegalArgumentException - if the provided argument is null
      +
      +
      +
    • +
    • +
      +

      getBeanManager

      +
      public abstract BeanManager getBeanManager()
      +
      Get the CDI BeanManager for the current context
      +
      +
      Returns:
      +
      the BeanManager
      +
      +
      +
    • +
    • +
      +

      getBeanContainer

      +
      public BeanContainer getBeanContainer()
      +
      Get the CDI BeanContainer for the current context. + + Default implementation just forwards the call to getBeanManager().
      +
      +
      Returns:
      +
      the BeanContainer
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/CDIProvider.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/CDIProvider.html new file mode 100644 index 0000000000..17e0e223ad --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/CDIProvider.html @@ -0,0 +1,228 @@ + + + + +CDIProvider (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface CDIProvider

+
+
+
+
All Superinterfaces:
+
Prioritized
+
+
+
public interface CDIProvider +extends Prioritized
+
Interface implemented by a CDI provider to provide access to the current container
+
+
Since:
+
1.1
+
Author:
+
Pete Muir
+
+
+
+
    + +
  • +
    +

    Field Summary

    +
    Fields
    +
    +
    Modifier and Type
    +
    Field
    +
    Description
    +
    static final int
    + +
    +
    The default value for getPriority()
    +
    +
    +
    +
  • + +
  • +
    +

    Method Summary

    +
    +
    +
    +
    +
    Modifier and Type
    +
    Method
    +
    Description
    + + +
    +
    Provides access to the current container
    +
    +
    default int
    + +
    +
    + Returns the priority for this SPI element.
    +
    +
    +
    +
    +
    +
  • +
+
+
+
    + +
  • +
    +

    Field Details

    +
      +
    • +
      +

      DEFAULT_CDI_PROVIDER_PRIORITY

      +
      static final int DEFAULT_CDI_PROVIDER_PRIORITY
      +
      The default value for getPriority()
      +
      +
      See Also:
      +
      + +
      +
      +
      +
    • +
    +
    +
  • + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      getCDI

      +
      CDI<Object> getCDI()
      +
      Provides access to the current container
      +
      +
      Returns:
      +
      the CDI instance for the current container
      +
      Throws:
      +
      IllegalStateException - if no CDI container is available
      +
      +
      +
    • +
    • +
      +

      getPriority

      +
      default int getPriority()
      +
      Description copied from interface: Prioritized
      +

      + Returns the priority for this SPI element. +

      +
      +
      Specified by:
      +
      getPriority in interface Prioritized
      +
      Returns:
      +
      the priority value
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/Decorator.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/Decorator.html new file mode 100644 index 0000000000..c3c2f57811 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/Decorator.html @@ -0,0 +1,228 @@ + + + + +Decorator (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface Decorator<T>

+
+
+
+
Type Parameters:
+
T - the decorator bean class
+
+
+
All Superinterfaces:
+
Bean<T>, BeanAttributes<T>, Contextual<T>
+
+
+
public interface Decorator<T> +extends Bean<T>
+

+ Represents an enabled decorator. +

+

+ Since CDI 2.0, an implementation of this interface may implement Prioritized in order to enable the decorator with + given priority value for entire application. +

+ +

+ CDI Lite implementations are not required to provide support for decorators. +

+
+
Author:
+
Gavin King, Pete Muir
+
+
+
+ +
+
+ +
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/DefinitionException.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/DefinitionException.html new file mode 100644 index 0000000000..8ffbd0fc57 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/DefinitionException.html @@ -0,0 +1,235 @@ + + + + +DefinitionException (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Class DefinitionException

+
+
java.lang.Object +
java.lang.Throwable +
java.lang.Exception +
java.lang.RuntimeException +
jakarta.enterprise.inject.spi.DefinitionException
+
+
+
+
+
+
+
All Implemented Interfaces:
+
Serializable
+
+
+
public class DefinitionException +extends RuntimeException
+

+ Thrown when a definition error occurs. +

+ +

+ Definition errors are developer errors. They may be detected by tooling at development time, and are also detected by the + container at initialization time. If a definition error exists in a deployment, initialization will be aborted by the + container. +

+ +

+ The container is permitted to define a non-portable mode, for use at development time, in which some definition errors do not + cause application initialization to abort. +

+ +

+ An implementation is permitted to throw a subclass of DefinitionException for any definition error which exists. +

+
+
Since:
+
1.1
+
Author:
+
Pete Muir
+
See Also:
+
+ +
+
+
+
+ +
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      DefinitionException

      +
      public DefinitionException(String message, + Throwable cause)
      +
      Creates the exception with given detail message and cause.
      +
      +
      Parameters:
      +
      message - the detail message
      +
      cause - the cause
      +
      +
      +
    • +
    • +
      +

      DefinitionException

      +
      public DefinitionException(String message)
      +
      Creates the exception with given detail message.
      +
      +
      Parameters:
      +
      message - the detail message
      +
      +
      +
    • +
    • +
      +

      DefinitionException

      +
      public DefinitionException(Throwable cause)
      +
      Creates the exception with given cause.
      +
      +
      Parameters:
      +
      cause - the cause
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/DeploymentException.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/DeploymentException.html new file mode 100644 index 0000000000..581940e373 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/DeploymentException.html @@ -0,0 +1,234 @@ + + + + +DeploymentException (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Class DeploymentException

+
+
java.lang.Object +
java.lang.Throwable +
java.lang.Exception +
java.lang.RuntimeException +
jakarta.enterprise.inject.spi.DeploymentException
+
+
+
+
+
+
+
All Implemented Interfaces:
+
Serializable
+
+
+
public class DeploymentException +extends RuntimeException
+

+ Thrown when a deployment problem occurs. +

+ +

+ Deployment problems are detected by the container at initialization time. If a deployment problem exists in a deployment, + initialization will be aborted by the container. +

+ +

+ The container is permitted to define a non-portable mode, for use at development time, in which some deployment problems do + not cause application initialization to abort. +

+ +

+ An implementation is permitted to throw a subclass of DeploymentException for any deployment problem. +

+
+
Since:
+
1.1
+
Author:
+
Pete Muir
+
See Also:
+
+ +
+
+
+
+ +
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      DeploymentException

      +
      public DeploymentException(String message, + Throwable cause)
      +
      Creates the exception with given detail message and cause.
      +
      +
      Parameters:
      +
      message - the detail message
      +
      cause - the cause
      +
      +
      +
    • +
    • +
      +

      DeploymentException

      +
      public DeploymentException(String message)
      +
      Creates the exception with given detail message.
      +
      +
      Parameters:
      +
      message - the detail message
      +
      +
      +
    • +
    • +
      +

      DeploymentException

      +
      public DeploymentException(Throwable cause)
      +
      Creates the exception with given cause.
      +
      +
      Parameters:
      +
      cause - the cause
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/EventContext.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/EventContext.html new file mode 100644 index 0000000000..deba56fbf2 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/EventContext.html @@ -0,0 +1,180 @@ + + + + +EventContext (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface EventContext<T>

+
+
+
+
Type Parameters:
+
T - type of event object
+
+
+
public interface EventContext<T>
+
Represents a context of a fired event. Provides access to an event object and corresponding metadata.
+
+
Since:
+
2.0
+
Author:
+
Martin Kouba
+
See Also:
+
+ +
+
+
+
+
    + +
  • +
    +

    Method Summary

    +
    +
    +
    +
    +
    Modifier and Type
    +
    Method
    +
    Description
    + + +
     
    + + +
     
    +
    +
    +
    +
    +
  • +
+
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      getEvent

      +
      T getEvent()
      +
      +
      Returns:
      +
      the event object, aka the payload
      +
      +
      +
    • +
    • +
      +

      getMetadata

      +
      EventMetadata getMetadata()
      +
      +
      Returns:
      +
      the event metadata
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/EventMetadata.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/EventMetadata.html new file mode 100644 index 0000000000..42e8194698 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/EventMetadata.html @@ -0,0 +1,203 @@ + + + + +EventMetadata (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface EventMetadata

+
+
+
+
public interface EventMetadata
+

+ Provides access to metadata about an observed event payload. +

+

+ EventMetadata may only be injected into an observer method. For example: +

+ +
+ public void afterLogin(@Observes LoggedInEvent event, EventMetadata eventMetadata) { ... }
+ 
+
+
Since:
+
1.1
+
Author:
+
Lincoln Baxter, III, Pete Muir, Antoine Sabot-Durand
+
See Also:
+
+ +
+
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      getQualifiers

      +
      Set<Annotation> getQualifiers()
      +
      +
      Returns:
      +
      the qualifiers for which event payload was fired.
      +
      +
      +
    • +
    • +
      +

      getInjectionPoint

      +
      InjectionPoint getInjectionPoint()
      +
      Get the InjectionPoint representing the injected Event instance which fired the event
      +
      +
      Returns:
      +
      InjectionPoint of the Event
      +
      +
      +
    • +
    • +
      +

      getType

      +
      Type getType()
      +
      Get the type representing runtime class of the event object with type variables resolved.
      +
      +
      Returns:
      +
      the runtime type of the event object
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/Extension.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/Extension.html new file mode 100644 index 0000000000..6cbe0a5bb8 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/Extension.html @@ -0,0 +1,131 @@ + + + + +Extension (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface Extension

+
+
+
+
public interface Extension
+

+ Service interface implemented by extensions. An extension is a service provider declared in META-INF/services. +

+ +

+ Service providers may have observer methods, which may observe any event, + including any container lifecycle event, and obtain an injected + BeanManager. +

+ +

+ The container instantiates a single instance of each extension at the beginning of the application initialization process and + maintains a reference to it until the application shuts down. The container delivers event notifications to this instance by + calling its observer methods. +

+ +

+ Service providers are made available for injection as beans with the qualifier @Default. +

+ +

+ CDI Lite implementations are not required to provide support for Portable Extensions. +

+
+
Author:
+
Gavin King, Pete Muir
+
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/InjectionPoint.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/InjectionPoint.html new file mode 100644 index 0000000000..de314c9649 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/InjectionPoint.html @@ -0,0 +1,294 @@ + + + + +InjectionPoint (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface InjectionPoint

+
+
+
+
public interface InjectionPoint
+

+ Provides access to metadata about an injection point. May represent an injected field or a + parameter of a bean constructor, initializer method, + producer method, disposer method or observer method. +

+ +

+ If the injection point is a dynamically selected reference obtained then the metadata obtain reflects the injection point of + the Instance, with the required type and any additional required qualifiers defined by Instance.select(). +

+ +

+ Occasionally, a bean with scope @Dependent needs to access metadata relating to the object to which it + belongs. The bean may inject an InjectionPoint representing the injection point into which the bean was injected. +

+ +

+ For example, the following producer method creates injectable Logger s. The log category of a + Logger depends upon the class of the object into which it is injected. +

+ +
+ @Produces
+ Logger createLogger(InjectionPoint injectionPoint) {
+     return Logger.getLogger(injectionPoint.getMember().getDeclaringClass().getName());
+ }
+ 
+ +

+ Only dependent objects, may obtain information about the injection point to which they belong. +

+
+
Author:
+
Gavin King, Pete Muir
+
+
+
+
    + +
  • +
    +

    Method Summary

    +
    +
    +
    +
    +
    Modifier and Type
    +
    Method
    +
    Description
    + + +
    +
    Obtain an instance of AnnotatedField or + AnnotatedParameter, depending upon whether the injection point is an injected field + or a constructor/method parameter.
    +
    +
    Bean<?>
    + +
    +
    Get the Bean object representing the bean that defines the injection point.
    +
    + + +
    +
    Get the Field object in the case of field injection, the Method + object in the case of method parameter injection or the Constructor object in the case of + constructor parameter injection.
    +
    + + +
    +
    Get the required qualifiers of the injection point.
    +
    + + +
    +
    Get the required type of injection point.
    +
    +
    boolean
    + +
    +
    Determines if the injection point is a decorator delegate injection point.
    +
    +
    boolean
    + +
    +
    Determines if the injection is a transient field.
    +
    +
    +
    +
    +
    +
  • +
+
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      getType

      +
      Type getType()
      +
      Get the required type of injection point.
      +
      +
      Returns:
      +
      the required type
      +
      +
      +
    • +
    • +
      +

      getQualifiers

      +
      Set<Annotation> getQualifiers()
      +
      Get the required qualifiers of the injection point.
      +
      +
      Returns:
      +
      the required qualifiers
      +
      +
      +
    • +
    • +
      +

      getBean

      +
      Bean<?> getBean()
      +
      Get the Bean object representing the bean that defines the injection point. If the + injection point does not belong to a bean, return a null value.
      +
      +
      Returns:
      +
      the Bean object representing bean that defines the injection point, of null + if the injection point does not belong to a bean
      +
      +
      +
    • +
    • +
      +

      getMember

      +
      Member getMember()
      +
      Get the Field object in the case of field injection, the Method + object in the case of method parameter injection or the Constructor object in the case of + constructor parameter injection.
      +
      +
      Returns:
      +
      the member
      +
      +
      +
    • +
    • +
      +

      getAnnotated

      +
      Annotated getAnnotated()
      +
      Obtain an instance of AnnotatedField or + AnnotatedParameter, depending upon whether the injection point is an injected field + or a constructor/method parameter.
      +
      +
      Returns:
      +
      an AnnotatedField or AnnotatedParameter
      +
      +
      +
    • +
    • +
      +

      isDelegate

      +
      boolean isDelegate()
      +
      Determines if the injection point is a decorator delegate injection point.
      +
      +
      Returns:
      +
      true if the injection point is a decorator delegate injection point, and false + otherwise
      +
      +
      +
    • +
    • +
      +

      isTransient

      +
      boolean isTransient()
      +
      Determines if the injection is a transient field.
      +
      +
      Returns:
      +
      true if the injection point is a transient field, and false otherwise
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/InjectionTarget.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/InjectionTarget.html new file mode 100644 index 0000000000..bfd9985de8 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/InjectionTarget.html @@ -0,0 +1,232 @@ + + + + +InjectionTarget (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface InjectionTarget<T>

+
+
+
+
Type Parameters:
+
T - The class of the instance
+
+
+
All Superinterfaces:
+
Producer<T>
+
+
+
public interface InjectionTarget<T> +extends Producer<T>
+

+ Provides operations for performing dependency injection and lifecycle callbacks on an + instance of a type. +

+ +

+ CDI Lite implementations are not required to provide support for InjectionTarget. +

+
+
Author:
+
Pete Muir, David Allen
+
See Also:
+
+
    +
  • PostConstruct
  • +
  • PreDestroy
  • +
+
+
+
+
+
    + +
  • +
    +

    Method Summary

    +
    +
    +
    +
    +
    Modifier and Type
    +
    Method
    +
    Description
    +
    void
    +
    inject(T instance, + CreationalContext<T> ctx)
    +
    +
    + Performs dependency injection upon the given object.
    +
    +
    void
    +
    postConstruct(T instance)
    +
    +
    + Calls the PostConstruct callback, if it exists, according to the semantics required by the + Java EE platform specification.
    +
    +
    void
    +
    preDestroy(T instance)
    +
    +
    + Calls the PreDestroy callback, if it exists, according to the semantics required by the Java + EE platform specification.
    +
    +
    +
    +
    +
    +

    Methods inherited from interface jakarta.enterprise.inject.spi.Producer

    +dispose, getInjectionPoints, produce
    +
    +
  • +
+
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      inject

      +
      void inject(T instance, + CreationalContext<T> ctx)
      +

      + Performs dependency injection upon the given object. Performs Java EE component environment injection, sets the value of + all injected fields, and calls all initializer methods. +

      +
      +
      Parameters:
      +
      instance - The instance upon which to perform injection
      +
      ctx - The CreationalContext to use for creating new instances
      +
      +
      +
    • +
    • +
      +

      postConstruct

      +
      void postConstruct(T instance)
      +

      + Calls the PostConstruct callback, if it exists, according to the semantics required by the + Java EE platform specification. +

      +
      +
      Parameters:
      +
      instance - The instance on which to invoke the PostConstruct method
      +
      +
      +
    • +
    • +
      +

      preDestroy

      +
      void preDestroy(T instance)
      +

      + Calls the PreDestroy callback, if it exists, according to the semantics required by the Java + EE platform specification. +

      +
      +
      Parameters:
      +
      instance - The instance on which to invoke the PreDestroy method
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/InjectionTargetFactory.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/InjectionTargetFactory.html new file mode 100644 index 0000000000..041094e2f9 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/InjectionTargetFactory.html @@ -0,0 +1,217 @@ + + + + +InjectionTargetFactory (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface InjectionTargetFactory<T>

+
+
+
+
Type Parameters:
+
T - type on which this InjectionTarget operates
+
+
+
public interface InjectionTargetFactory<T>
+

+ An InjectionTargetFactory can create an InjectionTarget for a given bean. +

+ +

+ The InjectionTargetFactory obtained from BeanManager.getInjectionTargetFactory(AnnotatedType) is capable of + providing container created injection targets. This factory can be wrapped to add behavior to container created injection + targets. +

+ +

+ For example: +

+ +
+ BeanAttributes<MyBean> myBeanAttributes = beanManager.createBeanAttributes(myBeanAnnotatedType);
+ beanManager.createBean(myBeanAttributes, MyBean.class, new InjectionTargetFactory() {
+
+     public <T> InjectionTarget<T> createInjectionTarget(Bean<T> bean) {
+         return new WrappingInjectionTarget<T>(
+                 beanManager.getInjectionTargetFactory(myBeanAnnotatedType)
+                         .createInjectionTarget(bean));
+     }
+ });
+ 
+ +

+ CDI Lite implementations are not required to provide support for InjectionTargetFactory. +

+
+
Since:
+
1.1
+
Author:
+
Pete Muir, Antoine Sabot-Durand
+
+
+
+ +
+
+ +
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/InterceptionFactory.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/InterceptionFactory.html new file mode 100644 index 0000000000..1524fb3d79 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/InterceptionFactory.html @@ -0,0 +1,287 @@ + + + + +InterceptionFactory (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface InterceptionFactory<T>

+
+
+
+
Type Parameters:
+
T - type for which the wrapper is created
+
+
+
public interface InterceptionFactory<T>
+
InterceptionFactory allows to create a wrapper instance whose method invocations are intercepted by method + interceptors and forwarded to a provided instance. + +

+ An implementation of InterceptionFactory may be obtained by calling + BeanManager.createInterceptionFactory(CreationalContext, Class) to be used in the create method of a custom bean for + example. +

+ +
+ public class MyCustomBean implements Bean<MyClass> {
+
+     BeanManager bm;
+
+     public MyCustomBean(BeanManager bm) {
+         this.bm = bm;
+     }
+
+     public MyClass create(CreationalContext<MyClass> creationalContext) {
+
+         InterceptionFactory<MyClass> factory = bm.createInterceptionFactory(creationalContext, MyClass.class);
+
+         factory.configure().filterMethods(m -> m.getJavaMember().getName().equals("shouldBeTransactional")).findFirst()
+                 .ifPresent(m -> m.add(new AnnotationLiteral<Transactional>() {
+                 }));
+
+         return factory.createInterceptedInstance(new MyClass());
+     }
+ }
+ 
+ +

+ The container must also provide a built-in bean with scope Dependent, bean type InterceptionFactory and + qualifier Default that can be injected in a producer method parameter. +

+ +
+ @Produces
+ @RequestScoped
+ public MyClass produceMyClass(InterceptionFactory<MyClass> factory) {
+     factory.configure().add(new AnnotationLiteral<Transactional>() {
+     });
+     return factory.createInterceptedInstance(new MyClass());
+ }
+ 
+ +

+ Instances of this class are neither reusable nor suitable for sharing between threads. +

+ +

+ CDI Lite implementations are not required to provide support for InterceptionFactory. +

+
+
Since:
+
2.0
+
Author:
+
Antoine Sabot-Durand
+
+
+
+ +
+
+ +
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/InterceptionType.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/InterceptionType.html new file mode 100644 index 0000000000..6b3f6905cb --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/InterceptionType.html @@ -0,0 +1,306 @@ + + + + +InterceptionType (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Enum Class InterceptionType

+
+
java.lang.Object +
java.lang.Enum<InterceptionType> +
jakarta.enterprise.inject.spi.InterceptionType
+
+
+
+
+
All Implemented Interfaces:
+
Serializable, Comparable<InterceptionType>, Constable
+
+
+
public enum InterceptionType +extends Enum<InterceptionType>
+

+ Identifies the kind of lifecycle callback, EJB timeout method or business method interception. +

+
+
Author:
+
Gavin King, Pete Muir
+
+
+
+ +
+
+
    + +
  • +
    +

    Enum Constant Details

    +
      +
    • +
      +

      AROUND_INVOKE

      +
      public static final InterceptionType AROUND_INVOKE
      +
      Intercepts method invocation
      +
      +
    • +
    • +
      +

      AROUND_TIMEOUT

      +
      public static final InterceptionType AROUND_TIMEOUT
      +
      Intercepts a timeout
      +
      +
    • +
    • +
      +

      AROUND_CONSTRUCT

      +
      public static final InterceptionType AROUND_CONSTRUCT
      +
      Intercepts a constructor invocation
      +
      +
    • +
    • +
      +

      POST_CONSTRUCT

      +
      public static final InterceptionType POST_CONSTRUCT
      +
      Intercepts bean construction
      +
      +
    • +
    • +
      +

      PRE_DESTROY

      +
      public static final InterceptionType PRE_DESTROY
      +
      Intercepts bean destruction
      +
      +
    • +
    • +
      +

      PRE_PASSIVATE

      +
      public static final InterceptionType PRE_PASSIVATE
      +
      Intercepts bean passivation, only called for EJBs
      +
      +
    • +
    • +
      +

      POST_ACTIVATE

      +
      public static final InterceptionType POST_ACTIVATE
      +
      Intercepts bean activation, only called for EJBs
      +
      +
    • +
    +
    +
  • + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      values

      +
      public static InterceptionType[] values()
      +
      Returns an array containing the constants of this enum class, in +the order they are declared.
      +
      +
      Returns:
      +
      an array containing the constants of this enum class, in the order they are declared
      +
      +
      +
    • +
    • +
      +

      valueOf

      +
      public static InterceptionType valueOf(String name)
      +
      Returns the enum constant of this class with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this class. (Extraneous whitespace characters are +not permitted.)
      +
      +
      Parameters:
      +
      name - the name of the enum constant to be returned.
      +
      Returns:
      +
      the enum constant with the specified name
      +
      Throws:
      +
      IllegalArgumentException - if this enum class has no constant with the specified name
      +
      NullPointerException - if the argument is null
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/Interceptor.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/Interceptor.html new file mode 100644 index 0000000000..36b5763946 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/Interceptor.html @@ -0,0 +1,240 @@ + + + + +Interceptor (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface Interceptor<T>

+
+
+
+
Type Parameters:
+
T - the interceptor bean class
+
+
+
All Superinterfaces:
+
Bean<T>, BeanAttributes<T>, Contextual<T>
+
+
+
public interface Interceptor<T> +extends Bean<T>
+

+ Represents an enabled interceptor. +

+

+ Since CDI 2.0, an implementation of this interface may implement Prioritized in order to enable the interceptor with + given priority value for entire application. +

+
+
Author:
+
Gavin King, Pete Muir, David Allen
+
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    + +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/ObserverMethod.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/ObserverMethod.html new file mode 100644 index 0000000000..0b07df8cdb --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/ObserverMethod.html @@ -0,0 +1,396 @@ + + + + +ObserverMethod (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface ObserverMethod<T>

+
+
+
+
Type Parameters:
+
T - the event type
+
+
+
All Superinterfaces:
+
Prioritized
+
+
+
public interface ObserverMethod<T> +extends Prioritized
+

+ Represents an observer method of an enabled + bean. Defines everything the container needs to know about an observer method. +

+ +

+ If a custom implementation of this interface does not override either notify(Object) or + notify(EventContext), the container automatically detects the problem and treats it as a definition error. +

+
+
Author:
+
Gavin King, David Allen, Mark Paluch, Antoine Sabot-Durand
+
+
+
+ +
+
+
    + +
  • +
    +

    Field Details

    +
      +
    • +
      +

      DEFAULT_PRIORITY

      +
      static final int DEFAULT_PRIORITY
      +
      The default observer priority
      +
      +
      See Also:
      +
      + +
      +
      +
      +
    • +
    +
    +
  • + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      getBeanClass

      +
      Class<?> getBeanClass()
      +

      + Obtains the class of the type that declares the observer method. +

      +
      +
      Returns:
      +
      the defining class
      +
      +
      +
    • +
    • +
      +

      getDeclaringBean

      +
      default Bean<?> getDeclaringBean()
      +

      + Obtains the bean that declares the observer method. + For synthetic observers, the return value is undefined. +

      + +

      + For the sake of compatibility with existing custom ObserverMethod implementations, this method by default + returns null. +

      +
      +
      Returns:
      +
      the declaring bean
      +
      Since:
      +
      4.0
      +
      +
      +
    • +
    • +
      +

      getObservedType

      +
      Type getObservedType()
      +
      Obtains the observed event type.
      +
      +
      Returns:
      +
      the observed event type
      +
      +
      +
    • +
    • +
      +

      getObservedQualifiers

      +
      Set<Annotation> getObservedQualifiers()
      +
      Obtains the set of observed event qualifiers.
      +
      +
      Returns:
      +
      the observed event qualifiers
      +
      +
      +
    • +
    • +
      +

      getReception

      +
      Reception getReception()
      +
      Obtains the specified Reception for the observer method. This indicates if the observer is conditional or not.
      +
      +
      Returns:
      +
      the Reception
      +
      +
      +
    • +
    • +
      +

      getTransactionPhase

      +
      TransactionPhase getTransactionPhase()
      +
      Obtains the specified TransactionPhase for the observer method.
      +
      +
      Returns:
      +
      the TransactionPhase
      +
      +
      +
    • +
    • +
      +

      getPriority

      +
      default int getPriority()
      +
      The priority that will be used by the container to determine the notification order in which event observer + methods are invoked.
      +
      +
      Specified by:
      +
      getPriority in interface Prioritized
      +
      Returns:
      +
      The priority that will be used by the container to determine the notification order in which event + observer methods are invoked.
      +
      Since:
      +
      2.0
      +
      +
      +
    • +
    • +
      +

      notify

      +
      default void notify(T event)
      +

      + Calls the observer method, passing the given event object. +

      + +

      + The implementation of this method for a custom observer method is responsible for deciding whether to call + the method if the getReception() returns Reception.IF_EXISTS. +

      +
      +
      Parameters:
      +
      event - the event object
      +
      +
      +
    • +
    • +
      +

      notify

      +
      default void notify(EventContext<T> eventContext)
      +
      Calls the observer method, passing the given event context. +

      + The container should always call this method, but the default implementation delegates to notify(Object). +

      + The implementation of this method for a custom observer method is responsible for deciding whether to call the method if + the getReception() returns Reception.IF_EXISTS.

      +
      +
      Parameters:
      +
      eventContext - EventContext used to notify observers
      +
      +
      +
    • +
    • +
      +

      isAsync

      +
      default boolean isAsync()
      +

      + Determines if this observer method is asynchronous +

      +
      +
      Returns:
      +
      returns true if the method is an asynchronous observer method (i.e. defined with + ObservesAsync), otherwise returns false
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/PassivationCapable.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/PassivationCapable.html new file mode 100644 index 0000000000..1e241e6dfd --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/PassivationCapable.html @@ -0,0 +1,166 @@ + + + + +PassivationCapable (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface PassivationCapable

+
+
+
+
public interface PassivationCapable
+
Indicates that a custom implementation of Bean or + Contextual is passivation capable. + +

+ CDI Lite implementations are not required to provide support for passivation. +

+
+
Author:
+
Gavin King, David Allen
+
+
+
+
    + +
  • +
    +

    Method Summary

    +
    +
    +
    +
    +
    Modifier and Type
    +
    Method
    +
    Description
    + + +
    +
    A string that uniquely identifies the instance of Bean or + Contextual.
    +
    +
    +
    +
    +
    +
  • +
+
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      getId

      +
      String getId()
      +
      A string that uniquely identifies the instance of Bean or + Contextual. It is recommended that the string contain the package name of the class + that implements Bean or Contextual.
      +
      +
      Returns:
      +
      a unique identifier for the Bean or + Contextual
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/Prioritized.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/Prioritized.html new file mode 100644 index 0000000000..361e15b9ed --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/Prioritized.html @@ -0,0 +1,182 @@ + + + + +Prioritized (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface Prioritized

+
+
+
+
All Known Subinterfaces:
+
BuildServices, CDIProvider, ObserverMethod<T>
+
+
+
public interface Prioritized
+

+ This interface allows some SPI implementation to change their priority programmatically. +

+ +

+ For instance ObserverMethod extends this interface to set the observer priority. + + A custom alternative Bean, Interceptor or Decorator may implement this interface to be activated + with a given priority + +

+
+
Since:
+
2.0
+
Author:
+
Mark Paluch, Antoine Sabot-Durand
+
See Also:
+
+ +
+
+
+
+
    + +
  • +
    +

    Method Summary

    +
    +
    +
    +
    +
    Modifier and Type
    +
    Method
    +
    Description
    +
    int
    + +
    +
    + Returns the priority for this SPI element.
    +
    +
    +
    +
    +
    +
  • +
+
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      getPriority

      +
      int getPriority()
      +

      + Returns the priority for this SPI element. +

      +
      +
      Returns:
      +
      the priority value
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/ProcessAnnotatedType.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/ProcessAnnotatedType.html new file mode 100644 index 0000000000..5bdfc5cc7d --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/ProcessAnnotatedType.html @@ -0,0 +1,261 @@ + + + + +ProcessAnnotatedType (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface ProcessAnnotatedType<X>

+
+
+
+
Type Parameters:
+
X - The class being annotated
+
+
+
All Known Subinterfaces:
+
ProcessSyntheticAnnotatedType<X>
+
+
+
public interface ProcessAnnotatedType<X>
+

+ The container fires an event of this type for each Java class or interface it discovers in a bean archive, before it reads + the declared annotations. +

+

+ Any observer of this event is permitted to wrap and/or replace the AnnotatedType by calling either + setAnnotatedType(AnnotatedType) or configureAnnotatedType(). + If both methods are called within an observer notification an IllegalStateException is thrown. + The container must use the final value of this property, after all observers have been called, to discover the types and read + the annotations of the program elements. +

+

+ For example, the following observer decorates the AnnotatedType for every class that is + discovered by the container. +

+ +
+ public <T> void decorateAnnotatedType(@Observes ProcessAnnotatedType<T> pat) {
+     pat.setAnnotatedType(decorate(pat.getAnnotatedType()));
+ }
+ 
+

+ If any observer method of a ProcessAnnotatedType event throws an exception, the exception is treated as a definition + error by the container. +

+ +

+ CDI Lite implementations are not required to provide support for Portable Extensions. +

+
+
Author:
+
David Allen, Antoine Sabot-Durand
+
See Also:
+
+ +
+
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      getAnnotatedType

      +
      AnnotatedType<X> getAnnotatedType()
      +
      Returns the AnnotatedType object that will be used by the container to read the + declared annotations.
      +
      +
      Returns:
      +
      the AnnotatedType object
      +
      Throws:
      +
      IllegalStateException - if called outside of the observer method invocation
      +
      +
      +
    • +
    • +
      +

      setAnnotatedType

      +
      void setAnnotatedType(AnnotatedType<X> type)
      +
      Replaces the AnnotatedType.
      +
      +
      Parameters:
      +
      type - the new AnnotatedType object to use
      +
      Throws:
      +
      IllegalStateException - if called outside of the observer method invocation
      +
      +
      +
    • +
    • +
      +

      configureAnnotatedType

      +
      AnnotatedTypeConfigurator<X> configureAnnotatedType()
      +
      Returns an AnnotatedTypeConfigurator initialized with the AnnotatedType processed by this event + to configure a new AnnotatedType that will replace the original one at the end of the observer invocation. + + Each call returns the same AnnotatedTypeConfigurator.
      +
      +
      Returns:
      +
      a non reusable AnnotatedTypeConfigurator to configure the replacing AnnotatedType
      +
      Throws:
      +
      IllegalStateException - if called outside of the observer method invocation
      +
      Since:
      +
      2.0
      +
      +
      +
    • +
    • +
      +

      veto

      +
      void veto()
      +
      Forces the container to ignore this type.
      +
      +
      Throws:
      +
      IllegalStateException - if called outside of the observer method invocation
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/ProcessBean.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/ProcessBean.html new file mode 100644 index 0000000000..a52a65bb28 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/ProcessBean.html @@ -0,0 +1,250 @@ + + + + +ProcessBean (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface ProcessBean<X>

+
+
+
+
Type Parameters:
+
X - The class of the bean
+
+
+
All Known Subinterfaces:
+
ProcessManagedBean<X>, ProcessProducerField<T,X>, ProcessProducerMethod<T,X>, ProcessSessionBean<X>, ProcessSyntheticBean<X>
+
+
+
public interface ProcessBean<X>
+

+ The container fires an event of this type for each enabled bean, interceptor or decorator deployed in a bean archive, before + registering the Bean object. +

+

+ The event object type depends upon what kind of bean was discovered: +

+
    +
  • For a managed bean with bean class X, the container must raise an event of type + ProcessManagedBean.
  • +
  • For a session bean with bean class X, the container must raise an event of type + ProcessSessionBean.
  • +
  • For a producer method with method return type X of a bean with bean class T, the container must raise an event of type + ProcessProducerMethod.
  • +
  • For a producer field with field type X of a bean with bean class T, the container must raise an event of type + ProcessProducerField.
  • +
  • For a custom implementation of Bean, the container must raise an event of type ProcessSyntheticBean.
  • +
+

+ Resources are considered to be producer fields. +

+

+ If any observer method of a ProcessBean event throws an exception, the exception is treated as a definition error by + the container. +

+ +

+ CDI Lite implementations are not required to provide support for Portable Extensions. +

+
+
Author:
+
David Allen
+
See Also:
+
+ +
+
+
+
+
    + +
  • +
    +

    Method Summary

    +
    +
    +
    +
    +
    Modifier and Type
    +
    Method
    +
    Description
    +
    void
    + +
    +
    Registers a definition error with the container, causing the container to abort deployment after bean discovery is + complete.
    +
    + + +
    +
    Returns the AnnotatedType representing the bean class, the + AnnotatedMethod representing the producer method, or the + AnnotatedField representing the producer field.
    +
    + + +
    +
    Returns the Bean object that is about to be registered.
    +
    +
    +
    +
    +
    +
  • +
+
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      getAnnotated

      +
      Annotated getAnnotated()
      +
      Returns the AnnotatedType representing the bean class, the + AnnotatedMethod representing the producer method, or the + AnnotatedField representing the producer field. + +

      + If invoked upon a ProcessSyntheticBean event, non-portable behavior results and the returned value should be + ignored. +

      +
      +
      Returns:
      +
      the Annotated for the bean being registered
      +
      Throws:
      +
      IllegalStateException - if called outside of the observer method invocation
      +
      +
      +
    • +
    • +
      +

      getBean

      +
      Bean<X> getBean()
      +
      Returns the Bean object that is about to be registered. The + Bean may implement Interceptor or + Decorator.
      +
      +
      Returns:
      +
      the Bean object about to be registered
      +
      Throws:
      +
      IllegalStateException - if called outside of the observer method invocation
      +
      +
      +
    • +
    • +
      +

      addDefinitionError

      +
      void addDefinitionError(Throwable t)
      +
      Registers a definition error with the container, causing the container to abort deployment after bean discovery is + complete.
      +
      +
      Parameters:
      +
      t - The definition error to register as a Throwable
      +
      Throws:
      +
      IllegalStateException - if called outside of the observer method invocation
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/ProcessBeanAttributes.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/ProcessBeanAttributes.html new file mode 100644 index 0000000000..cef43bf28f --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/ProcessBeanAttributes.html @@ -0,0 +1,301 @@ + + + + +ProcessBeanAttributes (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface ProcessBeanAttributes<T>

+
+
+
+
Type Parameters:
+
T - The class of the bean
+
+
+
public interface ProcessBeanAttributes<T>
+

+ The container fires an event of this type for each enabled bean, interceptor or decorator deployed in a bean archive before + registering the Bean object. +

+

+ Any observer of this event is permitted to wrap and/or replace the BeanAttributes by calling either + setBeanAttributes(BeanAttributes) or configureBeanAttributes(). + If both methods are called within an observer notification an IllegalStateException is thrown. + The container must use the final value of this property, after all observers have been called, to manage instances of the + bean. +

+

+ If any observer method of a ProcessBeanAttributes event throws an exception, the exception is treated as a definition + error by the container. +

+ +

+ CDI Lite implementations are not required to provide support for Portable Extensions. +

+
+
Since:
+
1.1
+
Author:
+
Pete Muir, Antoine Sabot-Durand
+
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      getAnnotated

      +
      Annotated getAnnotated()
      +
      +
      Returns:
      +
      the AnnotatedType representing the managed bean class or session bean class, the AnnotatedMethod + representing the producer field, or the AnnotatedField representing the producer field
      +
      Throws:
      +
      IllegalStateException - if called outside of the observer method invocation
      +
      +
      +
    • +
    • +
      +

      getBeanAttributes

      +
      BeanAttributes<T> getBeanAttributes()
      +
      +
      Returns:
      +
      the BeanAttributes object that will be used by the container to manage instances of the bean
      +
      Throws:
      +
      IllegalStateException - if called outside of the observer method invocation
      +
      +
      +
    • +
    • +
      +

      setBeanAttributes

      +
      void setBeanAttributes(BeanAttributes<T> beanAttributes)
      +
      Replaces the BeanAttributes.
      +
      +
      Parameters:
      +
      beanAttributes - the new BeanAttributes to use
      +
      Throws:
      +
      IllegalStateException - if called outside of the observer method invocation
      +
      +
      +
    • +
    • +
      +

      configureBeanAttributes

      +
      BeanAttributesConfigurator<T> configureBeanAttributes()
      +
      returns a BeanAttributesConfigurator initialized with the BeanAttributes processed by this event + to configure a new BeanAttributes that will replace the original one at the end of the observer invocation. + + Each call returns the same BeanAttributesConfigurator.
      +
      +
      Returns:
      +
      a non reusable BeanAttributesConfigurator to configure the replacing BeanAttributes
      +
      Throws:
      +
      IllegalStateException - if called outside of the observer method invocation
      +
      Since:
      +
      2.0
      +
      +
      +
    • +
    • +
      +

      addDefinitionError

      +
      void addDefinitionError(Throwable t)
      +
      Registers a definition error with the container, causing the container to abort deployment after bean discovery is + complete.
      +
      +
      Parameters:
      +
      t - the error to add
      +
      Throws:
      +
      IllegalStateException - if called outside of the observer method invocation
      +
      +
      +
    • +
    • +
      +

      veto

      +
      void veto()
      +
      Forces the container to ignore the bean.
      +
      +
      Throws:
      +
      IllegalStateException - if called outside of the observer method invocation
      +
      +
      +
    • +
    • +
      +

      ignoreFinalMethods

      +
      void ignoreFinalMethods()
      +

      + Instructs the container to ignore all non-static, final methods with public, protected or default visibility + declared on any bean type of the specific bean during validation of injection points that require proxyable bean type. +

      + +

      + These method should never be invoked upon bean instances. Otherwise, unpredictable behavior results. +

      +
      +
      Throws:
      +
      IllegalStateException - if called outside of the observer method invocation
      +
      Since:
      +
      2.0
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/ProcessInjectionPoint.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/ProcessInjectionPoint.html new file mode 100644 index 0000000000..f3460b173e --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/ProcessInjectionPoint.html @@ -0,0 +1,248 @@ + + + + +ProcessInjectionPoint (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface ProcessInjectionPoint<T,X>

+
+
+
+
Type Parameters:
+
T - the bean class of the bean that declares the injection point
+
X - the declared type of the injection point.
+
+
+
public interface ProcessInjectionPoint<T,X>
+

+ The container fires an event of this type for every injection point of every Java EE component class supporting injection + that may be instantiated by the container at runtime, including every EJB session or message-driven bean, enabled + bean, enabled interceptor or enabled decorator. +

+

+ Any observer of this event is permitted to wrap and/or replace the InjectionPoint by calling either + setInjectionPoint(InjectionPoint) or configureInjectionPoint(). + If both methods are called within an observer notification an IllegalStateException is thrown. + The container must use the final value of this property, after all observers have been called, he container must use the + final value of this property, after all observers have been called, whenever it performs injection upon the injection point. +

+

+ If any observer method of a ProcessInjectionPoint event throws an exception, the exception is treated as a definition + error by the container. +

+ +

+ CDI Lite implementations are not required to provide support for Portable Extensions. +

+
+
Author:
+
Pete Muir, Antoine Sabot-Durand
+
See Also:
+
+ +
+
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      getInjectionPoint

      +
      InjectionPoint getInjectionPoint()
      +
      +
      Returns:
      +
      the InjectionPoint object that will be used by the container to perform injection
      +
      Throws:
      +
      IllegalStateException - if called outside of the observer method invocation
      +
      +
      +
    • +
    • +
      +

      setInjectionPoint

      +
      void setInjectionPoint(InjectionPoint injectionPoint)
      +
      Replaces the InjectionPoint.
      +
      +
      Parameters:
      +
      injectionPoint - the new injection point
      +
      Throws:
      +
      IllegalStateException - if called outside of the observer method invocation
      +
      +
      +
    • +
    • +
      +

      configureInjectionPoint

      +
      InjectionPointConfigurator configureInjectionPoint()
      +
      Returns an InjectionPointConfigurator initialized with the InjectionPoint processed by this event + to configure a new InjectionPoint that will replace the original one at the end of the observer invocation. + + Each call returns the same InjectionPointConfigurator
      +
      +
      Returns:
      +
      a non reusable InjectionPointConfigurator to configure the replacing InjectionPoint
      +
      Throws:
      +
      IllegalStateException - if called outside of the observer method invocation
      +
      Since:
      +
      2.0
      +
      +
      +
    • +
    • +
      +

      addDefinitionError

      +
      void addDefinitionError(Throwable t)
      +
      Registers a definition error with the container, causing the container to abort deployment after bean discovery is + complete.
      +
      +
      Parameters:
      +
      t - the definition error
      +
      Throws:
      +
      IllegalStateException - if called outside of the observer method invocation
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/ProcessInjectionTarget.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/ProcessInjectionTarget.html new file mode 100644 index 0000000000..823c7b1824 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/ProcessInjectionTarget.html @@ -0,0 +1,255 @@ + + + + +ProcessInjectionTarget (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface ProcessInjectionTarget<X>

+
+
+
+
Type Parameters:
+
X - The managed bean class, session bean class or Java EE component class supporting injection
+
+
+
public interface ProcessInjectionTarget<X>
+

+ 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 EJB session or message-driven bean, enabled bean, enabled interceptor or + enabled decorator. +

+

+ Any observer of this event is permitted to wrap and/or replace the 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. +

+

+ For example, this observer decorates the InjectionTarget for all servlets. +

+ +
+ public <T extends Servlet> void decorateServlet(@Observes ProcessInjectionTarget<T> pit) {
+     pit.setInjectionTarget(decorate(pit.getInjectionTarget()));
+ }
+ 
+

+ If any observer method of a ProcessInjectionTarget event throws an exception, the exception is treated as a + definition error by the container. +

+ +

+ CDI Lite implementations are not required to provide support for Portable Extensions. +

+
+
Author:
+
David Allen
+
See Also:
+
+ +
+
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      getAnnotatedType

      +
      AnnotatedType<X> getAnnotatedType()
      +
      Returns the AnnotatedType representing the managed bean class, session bean class or + other Java EE component class supporting injection.
      +
      +
      Returns:
      +
      the AnnotatedType of the bean with an injection target
      +
      Throws:
      +
      IllegalStateException - if called outside of the observer method invocation
      +
      +
      +
    • +
    • +
      +

      getInjectionTarget

      +
      InjectionTarget<X> getInjectionTarget()
      +
      Returns the InjectionTarget object that will be used by the container to perform + injection.
      +
      +
      Returns:
      +
      the InjectionTarget object which performs the injection
      +
      Throws:
      +
      IllegalStateException - if called outside of the observer method invocation
      +
      +
      +
    • +
    • +
      +

      setInjectionTarget

      +
      void setInjectionTarget(InjectionTarget<X> injectionTarget)
      +
      Replaces the InjectionTarget which performs injection for this target.
      +
      +
      Parameters:
      +
      injectionTarget - The new InjectionTarget to use
      +
      Throws:
      +
      IllegalStateException - if called outside of the observer method invocation
      +
      +
      +
    • +
    • +
      +

      addDefinitionError

      +
      void addDefinitionError(Throwable t)
      +
      Registers a definition error with the container, causing the container to abort deployment after bean discovery is + complete.
      +
      +
      Parameters:
      +
      t - A Throwable representing the definition error
      +
      Throws:
      +
      IllegalStateException - if called outside of the observer method invocation
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/ProcessManagedBean.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/ProcessManagedBean.html new file mode 100644 index 0000000000..df9df744e1 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/ProcessManagedBean.html @@ -0,0 +1,210 @@ + + + + +ProcessManagedBean (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface ProcessManagedBean<X>

+
+
+
+
Type Parameters:
+
X - The class of the bean
+
+
+
All Superinterfaces:
+
ProcessBean<X>
+
+
+
All Known Subinterfaces:
+
ProcessSessionBean<X>
+
+
+
public interface ProcessManagedBean<X> +extends ProcessBean<X>
+

+ The container fires an event of this type for each enabled managed bean, before registering the + Bean object. +

+

+ If any observer method of a ProcessManagedBean event throws an exception, the exception is treated as a definition + error by the container. +

+ +

+ CDI Lite implementations are not required to provide support for Portable Extensions. +

+
+
Author:
+
David Allen
+
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      getAnnotatedBeanClass

      +
      AnnotatedType<X> getAnnotatedBeanClass()
      +
      Returns the AnnotatedType representing the bean class.
      +
      +
      Returns:
      +
      the AnnotatedType for the bean being registered
      +
      Throws:
      +
      IllegalStateException - if called outside of the observer method invocation
      +
      +
      +
    • +
    • +
      +

      createInvoker

      +
      InvokerBuilder<Invoker<X,?>> createInvoker(AnnotatedMethod<? super X> method)
      +
      Returns a new InvokerBuilder for given method. The builder eventually produces an invoker + for the given method. +

      + The method must be declared on the bean class or inherited from a supertype + of the bean class of the bean being registered, otherwise an exception is thrown.

      +
      +
      Parameters:
      +
      method - method of the bean being registered, must not be null
      +
      Returns:
      +
      the invoker builder, never null
      +
      Since:
      +
      4.1
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/ProcessObserverMethod.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/ProcessObserverMethod.html new file mode 100644 index 0000000000..2b72ef92d2 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/ProcessObserverMethod.html @@ -0,0 +1,304 @@ + + + + +ProcessObserverMethod (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface ProcessObserverMethod<T,X>

+
+
+
+
Type Parameters:
+
T - The type of the event being observed
+
X - The bean type containing the observer method
+
+
+
All Known Subinterfaces:
+
ProcessSyntheticObserverMethod<T,X>
+
+
+
public interface ProcessObserverMethod<T,X>
+

+ The container fires an event of this type for each observer method of each + enabled bean, before registering the ObserverMethod object. +

+

+ For a custom implementation of ObserverMethod, the container must raise an event of type + ProcessSyntheticObserverMethod. +

+

+ Any observer of this event is permitted to wrap and/or replace the ObserverMethod by calling either + setObserverMethod(ObserverMethod) or configureObserverMethod(). + If both methods are called within an observer notification an IllegalStateException is thrown. + The container must use the final value of this property, after all observers have been called, he container must use the + final value of this property, after all observers have been called, whenever it performs observer resolution. +

+

+ If any observer method of a ProcessObserverMethod event throws an exception, the exception is treated as a definition + error by the container. +

+ +

+ CDI Lite implementations are not required to provide support for Portable Extensions. +

+
+
Author:
+
Gavin King, David Allen, Antoine Sabot-Durand
+
See Also:
+
+ +
+
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      getAnnotatedMethod

      +
      AnnotatedMethod<X> getAnnotatedMethod()
      +
      The AnnotatedMethod representing the observer method. + +

      + If invoked upon a ProcessSyntheticObserverMethod event, non-portable behavior results and the returned value + should be ignored. +

      +
      +
      Returns:
      +
      the AnnotatedMethod representing the observer method
      +
      Throws:
      +
      IllegalStateException - if called outside of the observer method invocation
      +
      +
      +
    • +
    • +
      +

      getObserverMethod

      +
      ObserverMethod<T> getObserverMethod()
      +
      The ObserverMethod object that will be used by the container to invoke the observer + when a matching event is fired.
      +
      +
      Returns:
      +
      the ObserverMethod object that will be used by the container to call the + observer method
      +
      Throws:
      +
      IllegalStateException - if called outside of the observer method invocation
      +
      +
      +
    • +
    • +
      +

      addDefinitionError

      +
      void addDefinitionError(Throwable t)
      +
      Registers a definition error with the container, causing the container to abort deployment after bean discovery is + complete.
      +
      +
      Parameters:
      +
      t - A Throwable representing the definition error
      +
      Throws:
      +
      IllegalStateException - if called outside of the observer method invocation
      +
      +
      +
    • +
    • +
      +

      setObserverMethod

      +
      void setObserverMethod(ObserverMethod<T> observerMethod)
      +
      Replaces the ObserverMethod.
      +
      +
      Parameters:
      +
      observerMethod - the new ObserverMethod object to use
      +
      Throws:
      +
      IllegalStateException - if called outside of the observer method invocation
      +
      Since:
      +
      2.0
      +
      +
      +
    • +
    • +
      +

      configureObserverMethod

      +
      ObserverMethodConfigurator<T> configureObserverMethod()
      +
      Returns a ObserverMethodConfigurator initialized with the ObserverMethod processed by this event, + to configure a new ObserverMethod that will replace the original one at the end of the observer invocation. + + Each call returns the same ObserverMethodConfigurator
      +
      +
      Returns:
      +
      a non reusable ObserverMethodConfigurator to configure the replacing ObserverMethod
      +
      Throws:
      +
      IllegalStateException - if called outside of the observer method invocation
      +
      Since:
      +
      2.0
      +
      +
      +
    • +
    • +
      +

      veto

      +
      void veto()
      +
      Forces the container to ignore the observer method.
      +
      +
      Throws:
      +
      IllegalStateException - if called outside of the observer method invocation
      +
      Since:
      +
      2.0
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/ProcessProducer.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/ProcessProducer.html new file mode 100644 index 0000000000..f949ef2efe --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/ProcessProducer.html @@ -0,0 +1,286 @@ + + + + +ProcessProducer (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface ProcessProducer<T,X>

+
+
+
+
Type Parameters:
+
T - The bean class of the bean that declares the producer method or field
+
X - The return type of the producer method or the type of the producer field
+
+
+
public interface ProcessProducer<T,X>
+

+ The container fires an event of this type for each producer method or field of + each enabled bean, including resources. +

+

+ Any observer of this event is permitted to wrap and/or replace the Producer by calling either + setProducer(Producer) or configureProducer(). If both methods are called within an observer notification an + IllegalStateException is thrown. The container must use the final value of this property, after all observers have + been called, whenever it calls the producer or disposer. +

+

+ For example, this observer decorates the Producer for the all producer methods and field of type + EntityManager. +

+ +
+ void decorateEntityManager(@Observes ProcessProducer<?, EntityManager> pp) {
+     pit.setProducer(decorate(pp.getProducer()));
+ }
+ 
+

+ If any observer method of a ProcessProducer event throws an exception, the exception is treated as a definition error + by the container. +

+ +

+ CDI Lite implementations are not required to provide support for Portable Extensions. +

+
+
Author:
+
David Allen
+
See Also:
+
+ +
+
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      getAnnotatedMember

      +
      AnnotatedMember<T> getAnnotatedMember()
      +
      Returns the AnnotatedField representing the producer field or the + AnnotatedMethod representing the producer method.
      +
      +
      Returns:
      +
      the AnnotatedMember representing the producer
      +
      Throws:
      +
      IllegalStateException - if called outside of the observer method invocation
      +
      +
      +
    • +
    • +
      +

      getProducer

      +
      Producer<X> getProducer()
      +
      Returns the Producer object that will be used by the container to call the producer + method or read the producer field.
      +
      +
      Returns:
      +
      the Producer invoker object used by the container
      +
      Throws:
      +
      IllegalStateException - if called outside of the observer method invocation
      +
      +
      +
    • +
    • +
      +

      setProducer

      +
      void setProducer(Producer<X> producer)
      +
      Replaces the Producer object that will be used by the container to call the producer + method or read the producer field.
      +
      +
      Parameters:
      +
      producer - the new Producer object to use
      +
      Throws:
      +
      IllegalStateException - if called outside of the observer method invocation
      +
      +
      +
    • +
    • +
      +

      configureProducer

      +
      ProducerConfigurator<X> configureProducer()
      +
      Returns a ProducerConfigurator initialized with the Producer processed by this event, to configure a new + Producer that will replace the original one at the end of the observer invocation. + +

      + Each call returns the same configurator instance within an observer notification. +

      +
      +
      Returns:
      +
      a non reusable ProducerConfigurator to configure the original + Producer.
      +
      Throws:
      +
      IllegalStateException - if called outside of the observer method invocation
      +
      Since:
      +
      2.0
      +
      +
      +
    • +
    • +
      +

      addDefinitionError

      +
      void addDefinitionError(Throwable t)
      +
      Registers a definition error with the container, causing the container to abort deployment after bean discovery is + complete.
      +
      +
      Parameters:
      +
      t - The definition error to register as a Throwable
      +
      Throws:
      +
      IllegalStateException - if called outside of the observer method invocation
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/ProcessProducerField.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/ProcessProducerField.html new file mode 100644 index 0000000000..f6f9da16fd --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/ProcessProducerField.html @@ -0,0 +1,205 @@ + + + + +ProcessProducerField (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface ProcessProducerField<T,X>

+
+
+
+
Type Parameters:
+
T - The type of the producer field
+
X - The class of the bean declaring the producer field
+
+
+
All Superinterfaces:
+
ProcessBean<X>
+
+
+
public interface ProcessProducerField<T,X> +extends ProcessBean<X>
+

+ The container fires an event of this type for each enabled producer field, before registering the + Bean object. Resources are considered to be producer fields. +

+

+ If any observer method of a ProcessProducerField event throws an exception, the exception is treated as a definition + error by the container. +

+ +

+ CDI Lite implementations are not required to provide support for Portable Extensions. +

+
+
Author:
+
David Allen
+
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      getAnnotatedProducerField

      +
      AnnotatedField<T> getAnnotatedProducerField()
      +
      Returns the AnnotatedField representing the producer field.
      +
      +
      Returns:
      +
      the AnnotatedField for the producer field being registered
      +
      Throws:
      +
      IllegalStateException - if called outside of the observer method invocation
      +
      +
      +
    • +
    • +
      +

      getAnnotatedDisposedParameter

      +
      AnnotatedParameter<T> getAnnotatedDisposedParameter()
      +
      Returns the AnnotatedParameter for any matching injection point of the same type as + the producer field return type found on a disposal method.
      +
      +
      Returns:
      +
      the disposal method's AnnotatedParameter
      +
      Throws:
      +
      IllegalStateException - if called outside of the observer method invocation
      +
      Since:
      +
      1.1
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/ProcessProducerMethod.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/ProcessProducerMethod.html new file mode 100644 index 0000000000..99e1db27ec --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/ProcessProducerMethod.html @@ -0,0 +1,203 @@ + + + + +ProcessProducerMethod (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface ProcessProducerMethod<T,X>

+
+
+
+
Type Parameters:
+
T - The return type of the producer method
+
X - The class of the bean declaring the producer method
+
+
+
All Superinterfaces:
+
ProcessBean<X>
+
+
+
public interface ProcessProducerMethod<T,X> +extends ProcessBean<X>
+

+ The container fires an event of this type for each enabled producer method, before registering the + Bean object. +

+

+ If any observer method of a ProcessProducerMethod event throws an exception, the exception is treated as a definition + error by the container. +

+ +

+ CDI Lite implementations are not required to provide support for Portable Extensions. +

+
+
Author:
+
David Allen
+
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    + +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/ProcessSessionBean.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/ProcessSessionBean.html new file mode 100644 index 0000000000..d6e8ad2567 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/ProcessSessionBean.html @@ -0,0 +1,210 @@ + + + + +ProcessSessionBean (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface ProcessSessionBean<X>

+
+
+
+
Type Parameters:
+
X - session bean type
+
+
+
All Superinterfaces:
+
ProcessBean<Object>, ProcessManagedBean<Object>
+
+
+
public interface ProcessSessionBean<X> +extends ProcessManagedBean<Object>
+

+ The container fires an event of this type for each enabled session bean, before registering the + Bean object. +

+ +

+ If any observer method of a ProcessSessionBean event throws an exception, the exception is treated as a definition + error by the container. +

+ +

+ Note that the type parameter of the super-interface of ProcessSessionBean is Object as ProcessBean + allows you access to the Bean, which in turn allows you to instantiate an instance, which, for interface-view EJBs + will not be an instance of X. +

+ +

+ CDI Lite implementations are not required to provide support for Portable Extensions. +

+
+
Author:
+
David Allen
+
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    + +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/ProcessSyntheticAnnotatedType.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/ProcessSyntheticAnnotatedType.html new file mode 100644 index 0000000000..589cb4a3c4 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/ProcessSyntheticAnnotatedType.html @@ -0,0 +1,207 @@ + + + + +ProcessSyntheticAnnotatedType (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface ProcessSyntheticAnnotatedType<X>

+
+
+
+
Type Parameters:
+
X - The class being annotated
+
+
+
All Superinterfaces:
+
ProcessAnnotatedType<X>
+
+
+
public interface ProcessSyntheticAnnotatedType<X> +extends ProcessAnnotatedType<X>
+

+ The container fires an event of this type for each Java class or interface added by + BeforeBeanDiscovery.addAnnotatedType(AnnotatedType, String) or + AfterTypeDiscovery.addAnnotatedType(AnnotatedType, String) +

+

+ Any observer of this event is permitted to wrap and/or replace the AnnotatedType. The + container must use the final value of this property, after all observers have been called, to discover the types and read the + annotations of the program elements. +

+

+ For example, the following observer decorates the AnnotatedType for every class that is + added by BeforeBeanDiscovery.addAnnotatedType(AnnotatedType, String). +

+ +
+ public <T> void decorateAnnotatedType(@Observes ProcessSyntheticAnnotatedType<T> pat) {
+     pat.setAnnotatedType(decorate(pat.getAnnotatedType()));
+ }
+ 
+

+ If any observer method of a ProcessSyntheticAnnotatedType event throws an exception, the exception is treated as a + definition error by the container. +

+ +

+ CDI Lite implementations are not required to provide support for Portable Extensions. +

+
+
Since:
+
1.1
+
Author:
+
David Allen, Pete Muir
+
See Also:
+
+ +
+
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      getSource

      +
      Extension getSource()
      +
      Get the extension instance which added the AnnotatedType for which this event is being fired.
      +
      +
      Returns:
      +
      the extension instance
      +
      Throws:
      +
      IllegalStateException - if called outside of the observer method invocation
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/ProcessSyntheticBean.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/ProcessSyntheticBean.html new file mode 100644 index 0000000000..afdab0aaf3 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/ProcessSyntheticBean.html @@ -0,0 +1,185 @@ + + + + +ProcessSyntheticBean (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface ProcessSyntheticBean<X>

+
+
+
+
Type Parameters:
+
X - The class of the bean
+
+
+
All Superinterfaces:
+
ProcessBean<X>
+
+
+
public interface ProcessSyntheticBean<X> +extends ProcessBean<X>
+

+ The container fires an event of this type for each custom bean implementation added through + AfterBeanDiscovery.addBean() or AfterBeanDiscovery.addBean(Bean), before registering the + Bean object. +

+

+ If any observer method of a ProcessSyntheticBean event throws an exception, the exception is treated as a definition + error by the container. +

+ +

+ CDI Lite implementations are not required to provide support for Portable Extensions. +

+
+
Since:
+
2.0
+
Author:
+
Martin Kouba
+
+
+
+
    + +
  • +
    +

    Method Summary

    +
    +
    +
    +
    +
    Modifier and Type
    +
    Method
    +
    Description
    + + +
    +
    Get the extension instance which added the Bean for which this event is being fired.
    +
    +
    +
    +
    +
    +

    Methods inherited from interface jakarta.enterprise.inject.spi.ProcessBean

    +addDefinitionError, getAnnotated, getBean
    +
    +
  • +
+
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      getSource

      +
      Extension getSource()
      +
      Get the extension instance which added the Bean for which this event is being fired.
      +
      +
      Returns:
      +
      the extension instance
      +
      Throws:
      +
      IllegalStateException - if called outside of the observer method invocation
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/ProcessSyntheticObserverMethod.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/ProcessSyntheticObserverMethod.html new file mode 100644 index 0000000000..f1da6b0287 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/ProcessSyntheticObserverMethod.html @@ -0,0 +1,192 @@ + + + + +ProcessSyntheticObserverMethod (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface ProcessSyntheticObserverMethod<T,X>

+
+
+
+
Type Parameters:
+
T - The type of the event being observed
+
X - The bean type containing the observer method, i.e. ObserverMethod.getBeanClass()
+
+
+
All Superinterfaces:
+
ProcessObserverMethod<T,X>
+
+
+
public interface ProcessSyntheticObserverMethod<T,X> +extends ProcessObserverMethod<T,X>
+

+ The container fires an event of this type for each custom implementation of ObserverMethod added through + AfterBeanDiscovery.addObserverMethod(ObserverMethod) or AfterBeanDiscovery.addObserverMethod(), before + registering the ObserverMethod object. +

+

+ If any observer method of a ProcessSyntheticObserverMethod event throws an exception, the exception is treated as a + definition error by the container. +

+ +

+ CDI Lite implementations are not required to provide support for Portable Extensions. +

+
+
Since:
+
2.0
+
Author:
+
Martin Kouba
+
See Also:
+
+ +
+
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      getSource

      +
      Extension getSource()
      +
      Get the extension instance which added the ObserverMethod for which this event is being fired.
      +
      +
      Returns:
      +
      the extension instance
      +
      Throws:
      +
      IllegalStateException - if called outside of the observer method invocation
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/Producer.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/Producer.html new file mode 100644 index 0000000000..33343a71b1 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/Producer.html @@ -0,0 +1,234 @@ + + + + +Producer (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface Producer<T>

+
+
+
+
Type Parameters:
+
T - The class of object produced by the producer
+
+
+
All Known Subinterfaces:
+
InjectionTarget<T>
+
+
+
public interface Producer<T>
+

+ Provides a generic operation for producing an instance of a type. +

+ +

+ CDI Lite implementations are not required to provide support for Producer. +

+
+
Author:
+
Pete Muir, David Allen
+
+
+
+
    + +
  • +
    +

    Method Summary

    +
    +
    +
    +
    +
    Modifier and Type
    +
    Method
    +
    Description
    +
    void
    +
    dispose(T instance)
    +
    +
    + Destroys the instance.
    +
    + + +
    +
    + Returns the set of all InjectionPoints.
    +
    + + +
    +
    + Causes an instance to be produced via the Producer.
    +
    +
    +
    +
    +
    +
  • +
+
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      produce

      +
      T produce(CreationalContext<T> ctx)
      +

      + Causes an instance to be produced via the Producer. +

      +

      + If the Producer represents a class, this will invoke the constructor annotated Inject if + it exists, or the constructor with no parameters otherwise. If the class has interceptors, produce() is + responsible for building the interceptors and decorators of the instance. +

      +

      + If the Producer represents a producer field or method, this will invoke the producer method on, or access the + producer field of, a contextual instance of the bean that declares the producer. +

      +
      +
      Parameters:
      +
      ctx - The CreationalContext to use for the produced object
      +
      Returns:
      +
      the instance produced
      +
      +
      +
    • +
    • +
      +

      dispose

      +
      void dispose(T instance)
      +

      + Destroys the instance. +

      +

      + If the Producer represents a class, then this operation does nothing. +

      +

      + If the Producer represents a producer field or method, this calls the disposer method, if any, on a contextual + instance of the bean that declares the disposer method or performs any additional required cleanup, if any, to destroy + state associated with a resource. +

      +
      +
      Parameters:
      +
      instance - The instance to dispose
      +
      +
      +
    • +
    • +
      +

      getInjectionPoints

      +
      Set<InjectionPoint> getInjectionPoints()
      +

      + Returns the set of all InjectionPoints. If the Producer represents a class, then this returns returns the + set of InjectionPoint objects representing all injected fields, bean constructor parameters and initializer + method parameters. For a producer method, this returns the set of InjectionPoint objects representing all + parameters of the producer method. +

      +
      +
      Returns:
      +
      the set of all injection points for the producer
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/ProducerFactory.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/ProducerFactory.html new file mode 100644 index 0000000000..c8e1a2962e --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/ProducerFactory.html @@ -0,0 +1,193 @@ + + + + +ProducerFactory (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface ProducerFactory<X>

+
+
+
+
Type Parameters:
+
X - type of the bean containing the producer
+
+
+
public interface ProducerFactory<X>
+

+ An ProducerFactory can create an Producer for a given bean. +

+ +

+ The ProducerFactory obtained from BeanManager.getProducerFactory(AnnotatedMethod, Bean) or + BeanManager.getProducerFactory(AnnotatedField, Bean) is capable of providing container created + producers. This factory can be wrapped to add behavior to container created producers. +

+ +

+ For example: +

+ +
+ BeanAttributes<MyBean> myBeanAttributes = beanManager.createBeanAttributes(myBeanAnnotatedFieldField);
+ beanManager.createBean(myBeanAttributes, MyBean.class, new ProducerFactory() {
+
+     public <T> Producer<T> createProducer(Bean<T> bean) {
+         return new WrappingProducer<T>(beanManager.getProducerFactory(myBeanAnnotatedField).createProducer(bean));
+     }
+ });
+ 
+ +

+ CDI Lite implementations are not required to provide support for ProducerFactory. +

+
+
Since:
+
1.1
+
Author:
+
Pete Muir
+
+
+
+
    + +
  • +
    +

    Method Summary

    +
    +
    +
    +
    +
    Modifier and Type
    +
    Method
    +
    Description
    +
    <T> Producer<T>
    + +
    +
    Create a new producer for a bean.
    +
    +
    +
    +
    +
    +
  • +
+
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      createProducer

      +
      <T> Producer<T> createProducer(Bean<T> bean)
      +
      Create a new producer for a bean.
      +
      +
      Type Parameters:
      +
      T - bean type
      +
      Parameters:
      +
      bean - the bean to create the producer for, or null if creating a non-contextual object
      +
      Returns:
      +
      the producer
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/SessionBeanType.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/SessionBeanType.html new file mode 100644 index 0000000000..c264ff0ad3 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/SessionBeanType.html @@ -0,0 +1,260 @@ + + + + +SessionBeanType (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Enum Class SessionBeanType

+
+
java.lang.Object +
java.lang.Enum<SessionBeanType> +
jakarta.enterprise.inject.spi.SessionBeanType
+
+
+
+
+
All Implemented Interfaces:
+
Serializable, Comparable<SessionBeanType>, Constable
+
+
+
public enum SessionBeanType +extends Enum<SessionBeanType>
+
Identifies the kind of EJB session bean.
+
+
Author:
+
Gavin King
+
+
+
+ +
+
+
    + +
  • +
    +

    Enum Constant Details

    +
      +
    • +
      +

      STATELESS

      +
      public static final SessionBeanType STATELESS
      +
      A stateless (jakarta.ejb.Stateless) session bean
      +
      +
    • +
    • +
      +

      STATEFUL

      +
      public static final SessionBeanType STATEFUL
      +
      A stateful (jakarta.ejb.Stateful) session bean
      +
      +
    • +
    • +
      +

      SINGLETON

      +
      public static final SessionBeanType SINGLETON
      +
      A singleton (jakarta.ejb.Singleton) session bean
      +
      +
    • +
    +
    +
  • + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      values

      +
      public static SessionBeanType[] values()
      +
      Returns an array containing the constants of this enum class, in +the order they are declared.
      +
      +
      Returns:
      +
      an array containing the constants of this enum class, in the order they are declared
      +
      +
      +
    • +
    • +
      +

      valueOf

      +
      public static SessionBeanType valueOf(String name)
      +
      Returns the enum constant of this class with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this class. (Extraneous whitespace characters are +not permitted.)
      +
      +
      Parameters:
      +
      name - the name of the enum constant to be returned.
      +
      Returns:
      +
      the enum constant with the specified name
      +
      Throws:
      +
      IllegalArgumentException - if this enum class has no constant with the specified name
      +
      NullPointerException - if the argument is null
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/Unmanaged.UnmanagedInstance.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/Unmanaged.UnmanagedInstance.html new file mode 100644 index 0000000000..83671c4898 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/Unmanaged.UnmanagedInstance.html @@ -0,0 +1,267 @@ + + + + +Unmanaged.UnmanagedInstance (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Class Unmanaged.UnmanagedInstance<T>

+
+
java.lang.Object +
jakarta.enterprise.inject.spi.Unmanaged.UnmanagedInstance<T>
+
+
+
+
Enclosing class:
+
Unmanaged<T>
+
+
+
public static class Unmanaged.UnmanagedInstance<T> +extends Object
+
Represents a non-contextual instance.
+
+
See Also:
+
+ +
+
+
+
+ +
+
+ +
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/Unmanaged.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/Unmanaged.html new file mode 100644 index 0000000000..143502d8c8 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/Unmanaged.html @@ -0,0 +1,261 @@ + + + + +Unmanaged (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Class Unmanaged<T>

+
+
java.lang.Object +
jakarta.enterprise.inject.spi.Unmanaged<T>
+
+
+
+
Type Parameters:
+
T - type of unmanaged instances
+
+
+
public class Unmanaged<T> +extends Object
+

+ Helper class for injecting and calling lifecycle callbacks unmanaged instances for use by framework and library integrators. +

+ +
+ Unmanaged<Foo> unmanagedFoo = new Unmanaged<Foo>(Foo.class);
+ UnmanagedInstance<Foo> fooInstance = unmanagedFoo.newInstance();
+ Foo foo = fooInstance.produce().inject().postConstruct().get();
+ ... // Use the foo instance
+ fooInstance.preDestroy().dispose();
+ 
+ +

+ An instance of this class can be safely held for the lifetime of the application. +

+ +

+ Unmanaged.UnmanagedInstances created by this class are not suitable for sharing between threads. +

+ +

+ CDI Lite implementations are not required to provide support for Unmanaged. +

+
+
Since:
+
1.1
+
Author:
+
Pete Muir
+
+
+
+ +
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      Unmanaged

      +
      public Unmanaged(BeanManager manager, + Class<T> clazz)
      +
      Create an injector for the given class
      +
      +
      Parameters:
      +
      manager - the BeanManager
      +
      clazz - class of the unmanaged instances
      +
      +
      +
    • +
    • +
      +

      Unmanaged

      +
      public Unmanaged(Class<T> clazz)
      +
      Create an injector for the given class, using the current bean manager
      +
      +
      Parameters:
      +
      clazz - class of the unmanaged instances
      +
      +
      +
    • +
    +
    +
  • + +
  • +
    +

    Method Details

    + +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/WithAnnotations.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/WithAnnotations.html new file mode 100644 index 0000000000..00b2c555bb --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/WithAnnotations.html @@ -0,0 +1,169 @@ + + + + +WithAnnotations (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Annotation Interface WithAnnotations

+
+
+
+
@Retention(RUNTIME) +@Target(PARAMETER) +public @interface WithAnnotations
+

+ WithAnnotations may be applied to any portable extension observer method with an event parameter type of + ProcessAnnotatedType to filter the events delivered. +

+ +

+ If the WithAnnotations annotation is applied to a portable extension observer method, then only + ProcessAnnotatedType events for types which have at least one of the annotations specified are observed. The + annotation can appear on the annotated type, or on any member, or any parameter of any member of the annotated type, as + defined in section 11.4 Alternative + metadata sources. The annotation may be applied as a meta-annotation on any annotation considered. + +

+ CDI Lite implementations are not required to provide support for Portable Extensions. +

+
+
Since:
+
1.1
+
Author:
+
Pete Muir
+
+
+
+
    + +
  • +
    +

    Required Element Summary

    +
    Required Elements
    +
    +
    Modifier and Type
    +
    Required Element
    +
    Description
    +
    Class<? extends Annotation>[]
    + +
    +
    The annotation types that must be present on the AnnotatedType + for the ProcessAnnotatedType observer to be notified.
    +
    +
    +
    +
  • +
+
+
+
    + +
  • +
    +

    Element Details

    +
      +
    • +
      +

      value

      +
      Class<? extends Annotation>[] value
      +
      The annotation types that must be present on the AnnotatedType + for the ProcessAnnotatedType observer to be notified.
      +
      +
      Returns:
      +
      required annotation types
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/AfterBeanDiscovery.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/AfterBeanDiscovery.html new file mode 100644 index 0000000000..c553acf712 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/AfterBeanDiscovery.html @@ -0,0 +1,64 @@ + + + + +Uses of Interface jakarta.enterprise.inject.spi.AfterBeanDiscovery (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.enterprise.inject.spi.AfterBeanDiscovery

+
+No usage of jakarta.enterprise.inject.spi.AfterBeanDiscovery
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/AfterDeploymentValidation.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/AfterDeploymentValidation.html new file mode 100644 index 0000000000..039c717782 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/AfterDeploymentValidation.html @@ -0,0 +1,64 @@ + + + + +Uses of Interface jakarta.enterprise.inject.spi.AfterDeploymentValidation (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.enterprise.inject.spi.AfterDeploymentValidation

+
+No usage of jakarta.enterprise.inject.spi.AfterDeploymentValidation
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/AfterTypeDiscovery.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/AfterTypeDiscovery.html new file mode 100644 index 0000000000..0864c658a8 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/AfterTypeDiscovery.html @@ -0,0 +1,64 @@ + + + + +Uses of Interface jakarta.enterprise.inject.spi.AfterTypeDiscovery (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.enterprise.inject.spi.AfterTypeDiscovery

+
+No usage of jakarta.enterprise.inject.spi.AfterTypeDiscovery
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/Annotated.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/Annotated.html new file mode 100644 index 0000000000..90e20153d3 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/Annotated.html @@ -0,0 +1,154 @@ + + + + +Uses of Interface jakarta.enterprise.inject.spi.Annotated (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.enterprise.inject.spi.Annotated

+
+
Packages that use Annotated
+
+
Package
+
Description
+ +
+
+ The portable extension integration SPI.
+
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/AnnotatedCallable.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/AnnotatedCallable.html new file mode 100644 index 0000000000..95221c1692 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/AnnotatedCallable.html @@ -0,0 +1,113 @@ + + + + +Uses of Interface jakarta.enterprise.inject.spi.AnnotatedCallable (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.enterprise.inject.spi.AnnotatedCallable

+
+
Packages that use AnnotatedCallable
+
+
Package
+
Description
+ +
+
+ The portable extension integration SPI.
+
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/AnnotatedConstructor.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/AnnotatedConstructor.html new file mode 100644 index 0000000000..5a057c4412 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/AnnotatedConstructor.html @@ -0,0 +1,120 @@ + + + + +Uses of Interface jakarta.enterprise.inject.spi.AnnotatedConstructor (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.enterprise.inject.spi.AnnotatedConstructor

+
+
Packages that use AnnotatedConstructor
+
+
Package
+
Description
+ +
+
+ The portable extension integration SPI.
+
+ +
 
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/AnnotatedField.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/AnnotatedField.html new file mode 100644 index 0000000000..06dac2b1c9 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/AnnotatedField.html @@ -0,0 +1,150 @@ + + + + +Uses of Interface jakarta.enterprise.inject.spi.AnnotatedField (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.enterprise.inject.spi.AnnotatedField

+
+
Packages that use AnnotatedField
+
+
Package
+
Description
+ +
+
+ The portable extension integration SPI.
+
+ +
 
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/AnnotatedMember.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/AnnotatedMember.html new file mode 100644 index 0000000000..91d9715e33 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/AnnotatedMember.html @@ -0,0 +1,136 @@ + + + + +Uses of Interface jakarta.enterprise.inject.spi.AnnotatedMember (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.enterprise.inject.spi.AnnotatedMember

+
+
Packages that use AnnotatedMember
+
+
Package
+
Description
+ +
+
+ The portable extension integration SPI.
+
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/AnnotatedMethod.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/AnnotatedMethod.html new file mode 100644 index 0000000000..89f9c8cd71 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/AnnotatedMethod.html @@ -0,0 +1,166 @@ + + + + +Uses of Interface jakarta.enterprise.inject.spi.AnnotatedMethod (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.enterprise.inject.spi.AnnotatedMethod

+
+
Packages that use AnnotatedMethod
+
+
Package
+
Description
+ +
+
+ The portable extension integration SPI.
+
+ +
 
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/AnnotatedParameter.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/AnnotatedParameter.html new file mode 100644 index 0000000000..bd783082e3 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/AnnotatedParameter.html @@ -0,0 +1,152 @@ + + + + +Uses of Interface jakarta.enterprise.inject.spi.AnnotatedParameter (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.enterprise.inject.spi.AnnotatedParameter

+
+
Packages that use AnnotatedParameter
+
+
Package
+
Description
+ +
+
+ The portable extension integration SPI.
+
+ +
 
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/AnnotatedType.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/AnnotatedType.html new file mode 100644 index 0000000000..cf9edadba2 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/AnnotatedType.html @@ -0,0 +1,211 @@ + + + + +Uses of Interface jakarta.enterprise.inject.spi.AnnotatedType (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.enterprise.inject.spi.AnnotatedType

+
+
Packages that use AnnotatedType
+
+
Package
+
Description
+ +
+
+ The portable extension integration SPI.
+
+ +
 
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/Bean.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/Bean.html new file mode 100644 index 0000000000..a16d7eb6f4 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/Bean.html @@ -0,0 +1,247 @@ + + + + +Uses of Interface jakarta.enterprise.inject.spi.Bean (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.enterprise.inject.spi.Bean

+
+
Packages that use Bean
+
+
Package
+
Description
+ +
 
+ +
+
+ The portable extension integration SPI.
+
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/BeanAttributes.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/BeanAttributes.html new file mode 100644 index 0000000000..3bff4692c4 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/BeanAttributes.html @@ -0,0 +1,172 @@ + + + + +Uses of Interface jakarta.enterprise.inject.spi.BeanAttributes (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.enterprise.inject.spi.BeanAttributes

+
+
Packages that use BeanAttributes
+
+
Package
+
Description
+ +
+
+ The portable extension integration SPI.
+
+ +
 
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/BeanContainer.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/BeanContainer.html new file mode 100644 index 0000000000..fcda1ed9da --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/BeanContainer.html @@ -0,0 +1,143 @@ + + + + +Uses of Interface jakarta.enterprise.inject.spi.BeanContainer (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.enterprise.inject.spi.BeanContainer

+
+
Packages that use BeanContainer
+
+
Package
+
Description
+ +
 
+ +
+
+ The portable extension integration SPI.
+
+ +
 
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/BeanManager.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/BeanManager.html new file mode 100644 index 0000000000..6ba219f04c --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/BeanManager.html @@ -0,0 +1,143 @@ + + + + +Uses of Interface jakarta.enterprise.inject.spi.BeanManager (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.enterprise.inject.spi.BeanManager

+
+
Packages that use BeanManager
+
+
Package
+
Description
+ +
 
+ +
+
+ The portable extension integration SPI.
+
+ +
 
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/BeforeBeanDiscovery.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/BeforeBeanDiscovery.html new file mode 100644 index 0000000000..a6d896c490 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/BeforeBeanDiscovery.html @@ -0,0 +1,64 @@ + + + + +Uses of Interface jakarta.enterprise.inject.spi.BeforeBeanDiscovery (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.enterprise.inject.spi.BeforeBeanDiscovery

+
+No usage of jakarta.enterprise.inject.spi.BeforeBeanDiscovery
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/BeforeShutdown.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/BeforeShutdown.html new file mode 100644 index 0000000000..020ceead3e --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/BeforeShutdown.html @@ -0,0 +1,64 @@ + + + + +Uses of Interface jakarta.enterprise.inject.spi.BeforeShutdown (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.enterprise.inject.spi.BeforeShutdown

+
+No usage of jakarta.enterprise.inject.spi.BeforeShutdown
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/CDI.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/CDI.html new file mode 100644 index 0000000000..1d88299096 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/CDI.html @@ -0,0 +1,100 @@ + + + + +Uses of Class jakarta.enterprise.inject.spi.CDI (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
jakarta.enterprise.inject.spi.CDI

+
+
Packages that use CDI
+
+
Package
+
Description
+ +
+
+ The portable extension integration SPI.
+
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/CDIProvider.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/CDIProvider.html new file mode 100644 index 0000000000..19cb68e12f --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/CDIProvider.html @@ -0,0 +1,117 @@ + + + + +Uses of Interface jakarta.enterprise.inject.spi.CDIProvider (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.enterprise.inject.spi.CDIProvider

+
+
Packages that use CDIProvider
+
+
Package
+
Description
+ +
+
+ The portable extension integration SPI.
+
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/Decorator.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/Decorator.html new file mode 100644 index 0000000000..61b9073076 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/Decorator.html @@ -0,0 +1,97 @@ + + + + +Uses of Interface jakarta.enterprise.inject.spi.Decorator (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.enterprise.inject.spi.Decorator

+
+
Packages that use Decorator
+
+
Package
+
Description
+ +
+
+ The portable extension integration SPI.
+
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/DefinitionException.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/DefinitionException.html new file mode 100644 index 0000000000..14d0ddac98 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/DefinitionException.html @@ -0,0 +1,64 @@ + + + + +Uses of Class jakarta.enterprise.inject.spi.DefinitionException (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
jakarta.enterprise.inject.spi.DefinitionException

+
+No usage of jakarta.enterprise.inject.spi.DefinitionException
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/DeploymentException.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/DeploymentException.html new file mode 100644 index 0000000000..08a7db6755 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/DeploymentException.html @@ -0,0 +1,64 @@ + + + + +Uses of Class jakarta.enterprise.inject.spi.DeploymentException (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
jakarta.enterprise.inject.spi.DeploymentException

+
+No usage of jakarta.enterprise.inject.spi.DeploymentException
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/EventContext.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/EventContext.html new file mode 100644 index 0000000000..3271c6e2e2 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/EventContext.html @@ -0,0 +1,132 @@ + + + + +Uses of Interface jakarta.enterprise.inject.spi.EventContext (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.enterprise.inject.spi.EventContext

+
+
Packages that use EventContext
+
+
Package
+
Description
+ +
+
+ The build compatible extension SPI.
+
+ +
+
+ The portable extension integration SPI.
+
+ +
 
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/EventMetadata.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/EventMetadata.html new file mode 100644 index 0000000000..2bb1a173af --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/EventMetadata.html @@ -0,0 +1,92 @@ + + + + +Uses of Interface jakarta.enterprise.inject.spi.EventMetadata (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.enterprise.inject.spi.EventMetadata

+
+
Packages that use EventMetadata
+
+
Package
+
Description
+ +
+
+ The portable extension integration SPI.
+
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/Extension.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/Extension.html new file mode 100644 index 0000000000..3d0ca7235f --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/Extension.html @@ -0,0 +1,133 @@ + + + + +Uses of Interface jakarta.enterprise.inject.spi.Extension (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.enterprise.inject.spi.Extension

+
+
Packages that use Extension
+
+
Package
+
Description
+ +
 
+ +
+
+ The portable extension integration SPI.
+
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/InjectionPoint.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/InjectionPoint.html new file mode 100644 index 0000000000..c6509d3d9a --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/InjectionPoint.html @@ -0,0 +1,192 @@ + + + + +Uses of Interface jakarta.enterprise.inject.spi.InjectionPoint (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.enterprise.inject.spi.InjectionPoint

+
+
Packages that use InjectionPoint
+
+
Package
+
Description
+ +
+
+ The portable extension integration SPI.
+
+ +
 
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/InjectionTarget.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/InjectionTarget.html new file mode 100644 index 0000000000..bf861dd7da --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/InjectionTarget.html @@ -0,0 +1,111 @@ + + + + +Uses of Interface jakarta.enterprise.inject.spi.InjectionTarget (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.enterprise.inject.spi.InjectionTarget

+
+
Packages that use InjectionTarget
+
+
Package
+
Description
+ +
+
+ The portable extension integration SPI.
+
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/InjectionTargetFactory.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/InjectionTargetFactory.html new file mode 100644 index 0000000000..36d9683aef --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/InjectionTargetFactory.html @@ -0,0 +1,109 @@ + + + + +Uses of Interface jakarta.enterprise.inject.spi.InjectionTargetFactory (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.enterprise.inject.spi.InjectionTargetFactory

+
+
Packages that use InjectionTargetFactory
+
+
Package
+
Description
+ +
+
+ The portable extension integration SPI.
+
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/InterceptionFactory.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/InterceptionFactory.html new file mode 100644 index 0000000000..698b161ba4 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/InterceptionFactory.html @@ -0,0 +1,102 @@ + + + + +Uses of Interface jakarta.enterprise.inject.spi.InterceptionFactory (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.enterprise.inject.spi.InterceptionFactory

+
+
Packages that use InterceptionFactory
+
+
Package
+
Description
+ +
+
+ The portable extension integration SPI.
+
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/InterceptionType.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/InterceptionType.html new file mode 100644 index 0000000000..e19670ba4b --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/InterceptionType.html @@ -0,0 +1,154 @@ + + + + +Uses of Enum Class jakarta.enterprise.inject.spi.InterceptionType (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Enum Class
jakarta.enterprise.inject.spi.InterceptionType

+
+
Packages that use InterceptionType
+
+
Package
+
Description
+ +
+
+ The build compatible extension SPI.
+
+ +
+
+ The portable extension integration SPI.
+
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/Interceptor.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/Interceptor.html new file mode 100644 index 0000000000..3f796f02b9 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/Interceptor.html @@ -0,0 +1,99 @@ + + + + +Uses of Interface jakarta.enterprise.inject.spi.Interceptor (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.enterprise.inject.spi.Interceptor

+
+
Packages that use Interceptor
+
+
Package
+
Description
+ +
+
+ The portable extension integration SPI.
+
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/ObserverMethod.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/ObserverMethod.html new file mode 100644 index 0000000000..bd25b593e9 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/ObserverMethod.html @@ -0,0 +1,144 @@ + + + + +Uses of Interface jakarta.enterprise.inject.spi.ObserverMethod (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.enterprise.inject.spi.ObserverMethod

+
+
Packages that use ObserverMethod
+
+
Package
+
Description
+ +
+
+ The portable extension integration SPI.
+
+ +
 
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/PassivationCapable.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/PassivationCapable.html new file mode 100644 index 0000000000..77bc63071f --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/PassivationCapable.html @@ -0,0 +1,64 @@ + + + + +Uses of Interface jakarta.enterprise.inject.spi.PassivationCapable (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.enterprise.inject.spi.PassivationCapable

+
+No usage of jakarta.enterprise.inject.spi.PassivationCapable
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/Prioritized.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/Prioritized.html new file mode 100644 index 0000000000..dc383c020e --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/Prioritized.html @@ -0,0 +1,122 @@ + + + + +Uses of Interface jakarta.enterprise.inject.spi.Prioritized (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.enterprise.inject.spi.Prioritized

+
+
Packages that use Prioritized
+
+
Package
+
Description
+ +
+
+ The build compatible extension SPI.
+
+ +
+
+ The portable extension integration SPI.
+
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/ProcessAnnotatedType.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/ProcessAnnotatedType.html new file mode 100644 index 0000000000..e84cc669ea --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/ProcessAnnotatedType.html @@ -0,0 +1,97 @@ + + + + +Uses of Interface jakarta.enterprise.inject.spi.ProcessAnnotatedType (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.enterprise.inject.spi.ProcessAnnotatedType

+
+
Packages that use ProcessAnnotatedType
+
+
Package
+
Description
+ +
+
+ The portable extension integration SPI.
+
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/ProcessBean.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/ProcessBean.html new file mode 100644 index 0000000000..7c704c429a --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/ProcessBean.html @@ -0,0 +1,125 @@ + + + + +Uses of Interface jakarta.enterprise.inject.spi.ProcessBean (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.enterprise.inject.spi.ProcessBean

+
+
Packages that use ProcessBean
+
+
Package
+
Description
+ +
+
+ The portable extension integration SPI.
+
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/ProcessBeanAttributes.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/ProcessBeanAttributes.html new file mode 100644 index 0000000000..71cc540e86 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/ProcessBeanAttributes.html @@ -0,0 +1,64 @@ + + + + +Uses of Interface jakarta.enterprise.inject.spi.ProcessBeanAttributes (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.enterprise.inject.spi.ProcessBeanAttributes

+
+No usage of jakarta.enterprise.inject.spi.ProcessBeanAttributes
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/ProcessInjectionPoint.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/ProcessInjectionPoint.html new file mode 100644 index 0000000000..f720a5a9d5 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/ProcessInjectionPoint.html @@ -0,0 +1,64 @@ + + + + +Uses of Interface jakarta.enterprise.inject.spi.ProcessInjectionPoint (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.enterprise.inject.spi.ProcessInjectionPoint

+
+No usage of jakarta.enterprise.inject.spi.ProcessInjectionPoint
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/ProcessInjectionTarget.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/ProcessInjectionTarget.html new file mode 100644 index 0000000000..0bddab4d0b --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/ProcessInjectionTarget.html @@ -0,0 +1,64 @@ + + + + +Uses of Interface jakarta.enterprise.inject.spi.ProcessInjectionTarget (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.enterprise.inject.spi.ProcessInjectionTarget

+
+No usage of jakarta.enterprise.inject.spi.ProcessInjectionTarget
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/ProcessManagedBean.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/ProcessManagedBean.html new file mode 100644 index 0000000000..728a2d9242 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/ProcessManagedBean.html @@ -0,0 +1,96 @@ + + + + +Uses of Interface jakarta.enterprise.inject.spi.ProcessManagedBean (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.enterprise.inject.spi.ProcessManagedBean

+
+
Packages that use ProcessManagedBean
+
+
Package
+
Description
+ +
+
+ The portable extension integration SPI.
+
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/ProcessObserverMethod.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/ProcessObserverMethod.html new file mode 100644 index 0000000000..6ce2983480 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/ProcessObserverMethod.html @@ -0,0 +1,97 @@ + + + + +Uses of Interface jakarta.enterprise.inject.spi.ProcessObserverMethod (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.enterprise.inject.spi.ProcessObserverMethod

+
+
Packages that use ProcessObserverMethod
+
+
Package
+
Description
+ +
+
+ The portable extension integration SPI.
+
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/ProcessProducer.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/ProcessProducer.html new file mode 100644 index 0000000000..9d01750c33 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/ProcessProducer.html @@ -0,0 +1,64 @@ + + + + +Uses of Interface jakarta.enterprise.inject.spi.ProcessProducer (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.enterprise.inject.spi.ProcessProducer

+
+No usage of jakarta.enterprise.inject.spi.ProcessProducer
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/ProcessProducerField.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/ProcessProducerField.html new file mode 100644 index 0000000000..ee9f366c0e --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/ProcessProducerField.html @@ -0,0 +1,64 @@ + + + + +Uses of Interface jakarta.enterprise.inject.spi.ProcessProducerField (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.enterprise.inject.spi.ProcessProducerField

+
+No usage of jakarta.enterprise.inject.spi.ProcessProducerField
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/ProcessProducerMethod.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/ProcessProducerMethod.html new file mode 100644 index 0000000000..9545e0df39 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/ProcessProducerMethod.html @@ -0,0 +1,64 @@ + + + + +Uses of Interface jakarta.enterprise.inject.spi.ProcessProducerMethod (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.enterprise.inject.spi.ProcessProducerMethod

+
+No usage of jakarta.enterprise.inject.spi.ProcessProducerMethod
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/ProcessSessionBean.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/ProcessSessionBean.html new file mode 100644 index 0000000000..c551c14e59 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/ProcessSessionBean.html @@ -0,0 +1,64 @@ + + + + +Uses of Interface jakarta.enterprise.inject.spi.ProcessSessionBean (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.enterprise.inject.spi.ProcessSessionBean

+
+No usage of jakarta.enterprise.inject.spi.ProcessSessionBean
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/ProcessSyntheticAnnotatedType.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/ProcessSyntheticAnnotatedType.html new file mode 100644 index 0000000000..8b5381d00b --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/ProcessSyntheticAnnotatedType.html @@ -0,0 +1,64 @@ + + + + +Uses of Interface jakarta.enterprise.inject.spi.ProcessSyntheticAnnotatedType (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.enterprise.inject.spi.ProcessSyntheticAnnotatedType

+
+No usage of jakarta.enterprise.inject.spi.ProcessSyntheticAnnotatedType
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/ProcessSyntheticBean.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/ProcessSyntheticBean.html new file mode 100644 index 0000000000..fe73541b66 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/ProcessSyntheticBean.html @@ -0,0 +1,64 @@ + + + + +Uses of Interface jakarta.enterprise.inject.spi.ProcessSyntheticBean (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.enterprise.inject.spi.ProcessSyntheticBean

+
+No usage of jakarta.enterprise.inject.spi.ProcessSyntheticBean
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/ProcessSyntheticObserverMethod.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/ProcessSyntheticObserverMethod.html new file mode 100644 index 0000000000..1b121b7d5d --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/ProcessSyntheticObserverMethod.html @@ -0,0 +1,64 @@ + + + + +Uses of Interface jakarta.enterprise.inject.spi.ProcessSyntheticObserverMethod (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.enterprise.inject.spi.ProcessSyntheticObserverMethod

+
+No usage of jakarta.enterprise.inject.spi.ProcessSyntheticObserverMethod
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/Producer.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/Producer.html new file mode 100644 index 0000000000..62a3f9fac7 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/Producer.html @@ -0,0 +1,125 @@ + + + + +Uses of Interface jakarta.enterprise.inject.spi.Producer (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.enterprise.inject.spi.Producer

+
+
Packages that use Producer
+
+
Package
+
Description
+ +
+
+ The portable extension integration SPI.
+
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/ProducerFactory.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/ProducerFactory.html new file mode 100644 index 0000000000..602b59e057 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/ProducerFactory.html @@ -0,0 +1,120 @@ + + + + +Uses of Interface jakarta.enterprise.inject.spi.ProducerFactory (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.enterprise.inject.spi.ProducerFactory

+
+
Packages that use ProducerFactory
+
+
Package
+
Description
+ +
+
+ The portable extension integration SPI.
+
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/SessionBeanType.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/SessionBeanType.html new file mode 100644 index 0000000000..e6a7ca1cd2 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/SessionBeanType.html @@ -0,0 +1,105 @@ + + + + +Uses of Enum Class jakarta.enterprise.inject.spi.SessionBeanType (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Enum Class
jakarta.enterprise.inject.spi.SessionBeanType

+
+
Packages that use SessionBeanType
+
+
Package
+
Description
+ +
+
+ The portable extension integration SPI.
+
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/Unmanaged.UnmanagedInstance.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/Unmanaged.UnmanagedInstance.html new file mode 100644 index 0000000000..92533f936c --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/Unmanaged.UnmanagedInstance.html @@ -0,0 +1,119 @@ + + + + +Uses of Class jakarta.enterprise.inject.spi.Unmanaged.UnmanagedInstance (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
jakarta.enterprise.inject.spi.Unmanaged.UnmanagedInstance

+
+
Packages that use Unmanaged.UnmanagedInstance
+
+
Package
+
Description
+ +
+
+ The portable extension integration SPI.
+
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/Unmanaged.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/Unmanaged.html new file mode 100644 index 0000000000..adc739b502 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/Unmanaged.html @@ -0,0 +1,64 @@ + + + + +Uses of Class jakarta.enterprise.inject.spi.Unmanaged (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
jakarta.enterprise.inject.spi.Unmanaged

+
+No usage of jakarta.enterprise.inject.spi.Unmanaged
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/WithAnnotations.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/WithAnnotations.html new file mode 100644 index 0000000000..1d0bc8d37f --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/class-use/WithAnnotations.html @@ -0,0 +1,64 @@ + + + + +Uses of Annotation Interface jakarta.enterprise.inject.spi.WithAnnotations (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Annotation Interface
jakarta.enterprise.inject.spi.WithAnnotations

+
+No usage of jakarta.enterprise.inject.spi.WithAnnotations
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/configurator/AnnotatedConstructorConfigurator.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/configurator/AnnotatedConstructorConfigurator.html new file mode 100644 index 0000000000..0b9c68e96c --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/configurator/AnnotatedConstructorConfigurator.html @@ -0,0 +1,272 @@ + + + + +AnnotatedConstructorConfigurator (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface AnnotatedConstructorConfigurator<T>

+
+
+
+
Type Parameters:
+
T - the class declaring the constructor
+
+
+
public interface AnnotatedConstructorConfigurator<T>
+
This interface is part of the AnnotatedTypeConfigurator SPI and helps defining an AnnotatedConstructor + +

+ CDI Lite implementations are not required to provide support for Portable Extensions. +

+
+
Since:
+
2.0
+
Author:
+
Martin Kouba, Antoine Sabot-Durand
+
+
+
+ +
+
+ +
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/configurator/AnnotatedFieldConfigurator.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/configurator/AnnotatedFieldConfigurator.html new file mode 100644 index 0000000000..92627958f2 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/configurator/AnnotatedFieldConfigurator.html @@ -0,0 +1,237 @@ + + + + +AnnotatedFieldConfigurator (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface AnnotatedFieldConfigurator<T>

+
+
+
+
Type Parameters:
+
T - the class declaring the field
+
+
+
public interface AnnotatedFieldConfigurator<T>
+
This interface is part of the AnnotatedTypeConfigurator SPI and helps defining an AnnotatedField + +

+ CDI Lite implementations are not required to provide support for Portable Extensions. +

+
+
Since:
+
2.0
+
Author:
+
Martin Kouba, Antoine Sabot-Durand
+
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      getAnnotated

      +
      AnnotatedField<T> getAnnotated()
      +
      +
      Returns:
      +
      the original AnnotatedField
      +
      +
      +
    • +
    • +
      +

      add

      + +
      Add an annotation to the field.
      +
      +
      Parameters:
      +
      annotation - the annotation to add
      +
      Returns:
      +
      self
      +
      +
      +
    • +
    • +
      +

      remove

      + +
      Remove annotations that match the specified predicate. + +

      + Example predicates: +

      + +
      +  
      + // To remove all the annotations:
      + (a) -> true
      +
      + // To remove annotations with a concrete annotation type:
      + (a) -> a.annotationType().equals(Foo.class)
      +
      + // To remove annotation equal to a specified object:
      + (a) -> a.equals(fooAnnotation)
      +
      + // To remove annotations that are considered equivalent for the purposes of typesafe resolution:
      + (a) -> beanManager.areQualifiersEquivalent(a, fooQualifier)
      + (a) -> beanManager.areInterceptorBindingsEquivalent(a, fooInterceptorBinding)
      + 
      + 
      +
      +
      Parameters:
      +
      predicate - Predicate used to filter annotations to remove
      +
      Returns:
      +
      self
      +
      +
      +
    • +
    • +
      +

      removeAll

      +
      default AnnotatedFieldConfigurator<T> removeAll()
      +
      Remove all the annotations.
      +
      +
      Returns:
      +
      self
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/configurator/AnnotatedMethodConfigurator.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/configurator/AnnotatedMethodConfigurator.html new file mode 100644 index 0000000000..33f7715b28 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/configurator/AnnotatedMethodConfigurator.html @@ -0,0 +1,272 @@ + + + + +AnnotatedMethodConfigurator (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface AnnotatedMethodConfigurator<T>

+
+
+
+
Type Parameters:
+
T - the class declaring the method
+
+
+
public interface AnnotatedMethodConfigurator<T>
+
This interface is part of the AnnotatedTypeConfigurator SPI and helps defining an AnnotatedMethod + +

+ CDI Lite implementations are not required to provide support for Portable Extensions. +

+
+
Since:
+
2.0
+
Author:
+
Martin Kouba, Antoine Sabot-Durand
+
+
+
+ +
+
+ +
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/configurator/AnnotatedParameterConfigurator.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/configurator/AnnotatedParameterConfigurator.html new file mode 100644 index 0000000000..f744750b7e --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/configurator/AnnotatedParameterConfigurator.html @@ -0,0 +1,237 @@ + + + + +AnnotatedParameterConfigurator (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface AnnotatedParameterConfigurator<T>

+
+
+
+
Type Parameters:
+
T - the class containing the method declaring the parameter
+
+
+
public interface AnnotatedParameterConfigurator<T>
+
This interface is part of the AnnotatedTypeConfigurator SPI and helps defining an AnnotatedParameter + +

+ CDI Lite implementations are not required to provide support for Portable Extensions. +

+
+
Since:
+
2.0
+
Author:
+
Martin Kouba, Antoine Sabot-Durand
+
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      getAnnotated

      +
      AnnotatedParameter<T> getAnnotated()
      +
      +
      Returns:
      +
      the original AnnotatedParameter
      +
      +
      +
    • +
    • +
      +

      add

      + +
      Add an annotation to the parameter.
      +
      +
      Parameters:
      +
      annotation - the annotation to add
      +
      Returns:
      +
      self
      +
      +
      +
    • +
    • +
      +

      remove

      + +
      Remove annotations that match the specified predicate. + +

      + Example predicates: +

      + +
      +  
      + // To remove all the annotations:
      + (a) -> true
      +
      + // To remove annotations with a concrete annotation type:
      + (a) -> a.annotationType().equals(Foo.class)
      +
      + // To remove annotation equal to a specified object:
      + (a) -> a.equals(fooAnnotation)
      +
      + // To remove annotations that are considered equivalent for the purposes of typesafe resolution:
      + (a) -> beanManager.areQualifiersEquivalent(a, fooQualifier)
      + (a) -> beanManager.areInterceptorBindingsEquivalent(a, fooInterceptorBinding)
      + 
      + 
      +
      +
      Parameters:
      +
      predicate - Predicate used to filter annotations to remove
      +
      Returns:
      +
      self
      +
      +
      +
    • +
    • +
      +

      removeAll

      +
      default AnnotatedParameterConfigurator<T> removeAll()
      +
      Remove all the annotations.
      +
      +
      Returns:
      +
      self
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/configurator/AnnotatedTypeConfigurator.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/configurator/AnnotatedTypeConfigurator.html new file mode 100644 index 0000000000..e58e647d1b --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/configurator/AnnotatedTypeConfigurator.html @@ -0,0 +1,359 @@ + + + + +AnnotatedTypeConfigurator (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface AnnotatedTypeConfigurator<T>

+
+
+
+
Type Parameters:
+
T - the class represented by the configured AnnotatedType
+
+
+
public interface AnnotatedTypeConfigurator<T>
+

+ This API is a helper to configure a new AnnotatedType instance. The container must provide an implementation of + this interface. +

+ +

+ AnnotatedTypeConfigurator is not reusable. +

+ +

+ This configurator is not thread safe and shall not be used concurrently. +

+ +

+ CDI Lite implementations are not required to provide support for Portable Extensions. +

+
+
Since:
+
2.0
+
Author:
+
Martin Kouba, Antoine Sabot-Durand
+
See Also:
+
+ +
+
+
+
+ +
+
+ +
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/configurator/BeanAttributesConfigurator.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/configurator/BeanAttributesConfigurator.html new file mode 100644 index 0000000000..5f2d86d20a --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/configurator/BeanAttributesConfigurator.html @@ -0,0 +1,486 @@ + + + + +BeanAttributesConfigurator (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface BeanAttributesConfigurator<T>

+
+
+
+
Type Parameters:
+
T - the class of the bean instance
+
+
+
public interface BeanAttributesConfigurator<T>
+
This API is an helper to configure a new BeanAttributes instance. + CDI container must provides an implementation of this interface. + + This configurator is not thread safe and shall not be used concurrently. + +

+ CDI Lite implementations are not required to provide support for Portable Extensions. +

+
+
Since:
+
2.0
+
Author:
+
Antoine Sabot-Durand
+
See Also:
+
+ +
+
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      addType

      + +
      Add a type to the bean types
      +
      +
      Parameters:
      +
      type - the type to add
      +
      Returns:
      +
      self
      +
      +
      +
    • +
    • +
      +

      addType

      +
      BeanAttributesConfigurator<T> addType(TypeLiteral<?> typeLiteral)
      +
      Add a type to the bean types
      +
      +
      Parameters:
      +
      typeLiteral - the type to add
      +
      Returns:
      +
      self
      +
      +
      +
    • +
    • +
      +

      addTypes

      +
      BeanAttributesConfigurator<T> addTypes(Type... types)
      +
      Add types to the bean types
      +
      +
      Parameters:
      +
      types - types to add
      +
      Returns:
      +
      self
      +
      +
      +
    • +
    • +
      +

      addTypes

      +
      BeanAttributesConfigurator<T> addTypes(Set<Type> types)
      +
      Add types to the bean types
      +
      +
      Parameters:
      +
      types - types to add
      +
      Returns:
      +
      self
      +
      +
      +
    • +
    • +
      +

      addTransitiveTypeClosure

      +
      BeanAttributesConfigurator<T> addTransitiveTypeClosure(Type type)
      +
      Adds an unrestricted set of bean types for the given type as if it represented a bean class of a managed bean. + Illegal bean types are omitted.
      +
      +
      Parameters:
      +
      type - to build the closure from
      +
      Returns:
      +
      self
      +
      +
      +
    • +
    • +
      +

      types

      +
      BeanAttributesConfigurator<T> types(Type... types)
      +
      Replace bean types
      +
      +
      Parameters:
      +
      types - the types of the configured bean
      +
      Returns:
      +
      self
      +
      +
      +
    • +
    • +
      +

      types

      + +
      Replace bean types
      +
      +
      Parameters:
      +
      types - the types of the configured bean
      +
      Returns:
      +
      self
      +
      +
      +
    • +
    • +
      +

      scope

      +
      BeanAttributesConfigurator<T> scope(Class<? extends Annotation> scope)
      +
      Replace Bean scope
      +
      +
      Parameters:
      +
      scope - new scope for the configured bean
      +
      Returns:
      +
      self
      +
      +
      +
    • +
    • +
      +

      addQualifier

      +
      BeanAttributesConfigurator<T> addQualifier(Annotation qualifier)
      +
      Add a qualifier to the configured bean
      +
      +
      Parameters:
      +
      qualifier - qualifier to add
      +
      Returns:
      +
      self
      +
      +
      +
    • +
    • +
      +

      addQualifiers

      +
      BeanAttributesConfigurator<T> addQualifiers(Annotation... qualifiers)
      +
      Add qualifiers to the bean.
      +
      +
      Parameters:
      +
      qualifiers - qualifiers to add
      +
      Returns:
      +
      self
      +
      +
      +
    • +
    • +
      +

      addQualifiers

      +
      BeanAttributesConfigurator<T> addQualifiers(Set<Annotation> qualifiers)
      +
      Add qualifiers to the bean.
      +
      +
      Parameters:
      +
      qualifiers - qualifiers to add
      +
      Returns:
      +
      self
      +
      +
      +
    • +
    • +
      +

      qualifiers

      +
      BeanAttributesConfigurator<T> qualifiers(Annotation... qualifiers)
      +
      Replace all qualifiers.
      +
      +
      Parameters:
      +
      qualifiers - qualifiers for the build bean
      +
      Returns:
      +
      self
      +
      +
      +
    • +
    • +
      +

      qualifiers

      +
      BeanAttributesConfigurator<T> qualifiers(Set<Annotation> qualifiers)
      +
      Replace all qualifiers.
      +
      +
      Parameters:
      +
      qualifiers - for the configured bean
      +
      Returns:
      +
      self
      +
      +
      +
    • +
    • +
      +

      addStereotype

      +
      BeanAttributesConfigurator<T> addStereotype(Class<? extends Annotation> stereotype)
      +
      Add a stereotype to the configured bean
      +
      +
      Parameters:
      +
      stereotype - stereotype to add
      +
      Returns:
      +
      self
      +
      +
      +
    • +
    • +
      +

      addStereotypes

      +
      BeanAttributesConfigurator<T> addStereotypes(Set<Class<? extends Annotation>> stereotypes)
      +
      Add stereotypes to the configured bean
      +
      +
      Parameters:
      +
      stereotypes - stereotypes to add
      +
      Returns:
      +
      self
      +
      +
      +
    • +
    • +
      +

      stereotypes

      +
      BeanAttributesConfigurator<T> stereotypes(Set<Class<? extends Annotation>> stereotypes)
      +
      Replace stereotypes on the configured bean
      +
      +
      Parameters:
      +
      stereotypes - for the configured bean
      +
      Returns:
      +
      self
      +
      +
      +
    • +
    • +
      +

      name

      + +
      Set the name of the configured bean
      +
      +
      Parameters:
      +
      name - name for the configured bean
      +
      Returns:
      +
      self
      +
      +
      +
    • +
    • +
      +

      alternative

      +
      BeanAttributesConfigurator<T> alternative(boolean value)
      +
      Change the alternative status of the configured bean. + By default the configured bean is not an alternative.
      +
      +
      Parameters:
      +
      value - value for alternative property
      +
      Returns:
      +
      self
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/configurator/BeanConfigurator.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/configurator/BeanConfigurator.html new file mode 100644 index 0000000000..aa466bfb54 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/configurator/BeanConfigurator.html @@ -0,0 +1,777 @@ + + + + +BeanConfigurator (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface BeanConfigurator<T>

+
+
+
+
Type Parameters:
+
T - the class of the bean instance
+
+
+
public interface BeanConfigurator<T>
+
This API is an helper to configure a new Bean instance. + CDI container must provides an implementation of this interface. + + This builder is not thread safe and shall not be used concurrently. + +

+ CDI Lite implementations are not required to provide support for Portable Extensions. +

+
+
Since:
+
2.0
+
Author:
+
Martin Kouba, Antoine Sabot-Durand
+
See Also:
+
+ +
+
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      beanClass

      +
      BeanConfigurator<T> beanClass(Class<?> beanClass)
      +
      Set the class of the configured Bean. + If not set, the extension class is used.
      +
      +
      Parameters:
      +
      beanClass - class of the configured bean
      +
      Returns:
      +
      self
      +
      +
      +
    • +
    • +
      +

      addInjectionPoint

      +
      BeanConfigurator<T> addInjectionPoint(InjectionPoint injectionPoint)
      +
      Add an InjectionPoint to the configured bean
      +
      +
      Parameters:
      +
      injectionPoint - the injectionPoint to add
      +
      Returns:
      +
      self
      +
      +
      +
    • +
    • +
      +

      addInjectionPoints

      +
      BeanConfigurator<T> addInjectionPoints(InjectionPoint... injectionPoints)
      +
      Add InjectionPoints to the configured bean
      +
      +
      Parameters:
      +
      injectionPoints - the injectionPoints to add
      +
      Returns:
      +
      self
      +
      +
      +
    • +
    • +
      +

      addInjectionPoints

      +
      BeanConfigurator<T> addInjectionPoints(Set<InjectionPoint> injectionPoints)
      +
      Add InjectionPoints to the configured bean
      +
      +
      Parameters:
      +
      injectionPoints - the injectionPoints to add
      +
      Returns:
      +
      self
      +
      +
      +
    • +
    • +
      +

      injectionPoints

      +
      BeanConfigurator<T> injectionPoints(InjectionPoint... injectionPoints)
      +
      Replace InjectionPoints for the configured bean
      +
      +
      Parameters:
      +
      injectionPoints - the injectionPoints for the configured bean
      +
      Returns:
      +
      self
      +
      +
      +
    • +
    • +
      +

      injectionPoints

      +
      BeanConfigurator<T> injectionPoints(Set<InjectionPoint> injectionPoints)
      +
      Replace InjectionPoints for the configured bean
      +
      +
      Parameters:
      +
      injectionPoints - the injectionPoints for the configured bean
      +
      Returns:
      +
      self
      +
      +
      +
    • +
    • +
      +

      id

      + +
      Make the configured bean implements PassivationCapable and its Id for passivation.
      +
      +
      Parameters:
      +
      id - for
      +
      Returns:
      +
      self
      +
      See Also:
      +
      + +
      +
      +
      +
    • +
    • +
      +

      createWith

      +
      <U extends T> BeanConfigurator<U> createWith(Function<CreationalContext<U>,U> callback)
      +
      Set a callback to create a bean instance.
      +
      +
      Type Parameters:
      +
      U - instance type
      +
      Parameters:
      +
      callback - the callback to create the instance
      +
      Returns:
      +
      self
      +
      See Also:
      +
      + +
      +
      +
      +
    • +
    • +
      +

      produceWith

      +
      <U extends T> BeanConfigurator<U> produceWith(Function<Instance<Object>,U> callback)
      +
      Set a callback to create a bean instance. +

      + The Instance argument might be used to simulate producer method parameter injection. However, dependent scoped + bean instances obtained from Instance during the callback execution remain managed until the produced bean + instance is destroyed. Therefore, applications are encouraged to always destroy unneeded dependent scoped bean instances + obtained from Instance.

      +
      +
      Type Parameters:
      +
      U - instance type
      +
      Parameters:
      +
      callback - the callback to create the instance
      +
      Returns:
      +
      self
      +
      +
      +
    • +
    • +
      +

      destroyWith

      +
      BeanConfigurator<T> destroyWith(BiConsumer<T,CreationalContext<T>> callback)
      +
      Set a callback to destroy a bean instance. +

      + If no destroy callback is specified, a NOOP callback is automatically set.

      +
      +
      Parameters:
      +
      callback - the callback to destroy the instance
      +
      Returns:
      +
      self
      +
      +
      +
    • +
    • +
      +

      disposeWith

      +
      BeanConfigurator<T> disposeWith(BiConsumer<T,Instance<Object>> callback)
      +
      Set a callback to destroy a bean instance. +

      + If no dispose callback is specified, a NOOP callback is automatically set. +

      + The Instance argument might be used to simulate disposer method parameter injection. All dependent scoped bean + instances obtained from Instance during the callback execution are destroyed when the execution completes.

      +
      +
      Parameters:
      +
      callback - the callback to dispose the instance
      +
      Returns:
      +
      self
      +
      +
      +
    • +
    • +
      +

      read

      +
      <U extends T> BeanConfigurator<U> read(AnnotatedType<U> type)
      +
      Read the information from the given annotated type. All relevant information is overwritten.
      +
      +
      Type Parameters:
      +
      U - instance type
      +
      Parameters:
      +
      type - class to read information from
      +
      Returns:
      +
      self
      +
      +
      +
    • +
    • +
      +

      read

      +
      BeanConfigurator<T> read(BeanAttributes<?> beanAttributes)
      +
      Read the information from the given bean attributes. All relevant information is overwritten.
      +
      +
      Parameters:
      +
      beanAttributes - beanAttributes to read information from
      +
      Returns:
      +
      self
      +
      +
      +
    • +
    • +
      +

      addType

      +
      BeanConfigurator<T> addType(Type type)
      +
      Add a type to the bean types
      +
      +
      Parameters:
      +
      type - the type to add
      +
      Returns:
      +
      self
      +
      +
      +
    • +
    • +
      +

      addType

      +
      BeanConfigurator<T> addType(TypeLiteral<?> typeLiteral)
      +
      Add a type to the bean types
      +
      +
      Parameters:
      +
      typeLiteral - the type to add
      +
      Returns:
      +
      self
      +
      +
      +
    • +
    • +
      +

      addTypes

      +
      BeanConfigurator<T> addTypes(Type... types)
      +
      Add types to the bean types
      +
      +
      Parameters:
      +
      types - types to add
      +
      Returns:
      +
      self
      +
      +
      +
    • +
    • +
      +

      addTypes

      +
      BeanConfigurator<T> addTypes(Set<Type> types)
      +
      Add types to the bean types
      +
      +
      Parameters:
      +
      types - types to add
      +
      Returns:
      +
      self
      +
      +
      +
    • +
    • +
      +

      addTransitiveTypeClosure

      +
      BeanConfigurator<T> addTransitiveTypeClosure(Type type)
      +
      Adds an unrestricted set of bean types for the given type as if it represented a bean class of a managed bean. + Illegal bean types are omitted.
      +
      +
      Parameters:
      +
      type - to build the closure from
      +
      Returns:
      +
      self
      +
      +
      +
    • +
    • +
      +

      types

      +
      BeanConfigurator<T> types(Type... types)
      +
      Replace bean types
      +
      +
      Parameters:
      +
      types - the types of the configured bean
      +
      Returns:
      +
      self
      +
      +
      +
    • +
    • +
      +

      types

      +
      BeanConfigurator<T> types(Set<Type> types)
      +
      Replace bean types
      +
      +
      Parameters:
      +
      types - the types of the configured bean
      +
      Returns:
      +
      self
      +
      +
      +
    • +
    • +
      +

      scope

      +
      BeanConfigurator<T> scope(Class<? extends Annotation> scope)
      +
      Replace Bean scope
      +
      +
      Parameters:
      +
      scope - new scope for the configured bean
      +
      Returns:
      +
      self
      +
      +
      +
    • +
    • +
      +

      addQualifier

      +
      BeanConfigurator<T> addQualifier(Annotation qualifier)
      +
      Add a qualifier to the configured bean
      +
      +
      Parameters:
      +
      qualifier - qualifier to add
      +
      Returns:
      +
      self
      +
      +
      +
    • +
    • +
      +

      addQualifiers

      +
      BeanConfigurator<T> addQualifiers(Annotation... qualifiers)
      +
      Add qualifiers to the bean.
      +
      +
      Parameters:
      +
      qualifiers - qualifiers to add
      +
      Returns:
      +
      self
      +
      +
      +
    • +
    • +
      +

      addQualifiers

      +
      BeanConfigurator<T> addQualifiers(Set<Annotation> qualifiers)
      +
      Add qualifiers to the bean.
      +
      +
      Parameters:
      +
      qualifiers - qualifiers to add
      +
      Returns:
      +
      self
      +
      +
      +
    • +
    • +
      +

      qualifiers

      +
      BeanConfigurator<T> qualifiers(Annotation... qualifiers)
      +
      Replace all qualifiers.
      +
      +
      Parameters:
      +
      qualifiers - qualifiers for the build bean
      +
      Returns:
      +
      self
      +
      +
      +
    • +
    • +
      +

      qualifiers

      +
      BeanConfigurator<T> qualifiers(Set<Annotation> qualifiers)
      +
      Replace all qualifiers.
      +
      +
      Parameters:
      +
      qualifiers - for the configured bean
      +
      Returns:
      +
      self
      +
      +
      +
    • +
    • +
      +

      addStereotype

      +
      BeanConfigurator<T> addStereotype(Class<? extends Annotation> stereotype)
      +
      Add a stereotype to the configured bean
      +
      +
      Parameters:
      +
      stereotype - stereotype to add
      +
      Returns:
      +
      self
      +
      +
      +
    • +
    • +
      +

      addStereotypes

      +
      BeanConfigurator<T> addStereotypes(Set<Class<? extends Annotation>> stereotypes)
      +
      Add stereotypes to the configured bean
      +
      +
      Parameters:
      +
      stereotypes - stereotypes to add
      +
      Returns:
      +
      self
      +
      +
      +
    • +
    • +
      +

      stereotypes

      +
      BeanConfigurator<T> stereotypes(Set<Class<? extends Annotation>> stereotypes)
      +
      Replace stereotypes on the configured bean
      +
      +
      Parameters:
      +
      stereotypes - for the configured bean
      +
      Returns:
      +
      self
      +
      +
      +
    • +
    • +
      +

      name

      +
      BeanConfigurator<T> name(String name)
      +
      Set the name of the configured bean
      +
      +
      Parameters:
      +
      name - name for the configured bean
      +
      Returns:
      +
      self
      +
      +
      +
    • +
    • +
      +

      alternative

      +
      BeanConfigurator<T> alternative(boolean value)
      +
      Change the alternative status of the configured bean. + By default the configured bean is not an alternative.
      +
      +
      Parameters:
      +
      value - value for alternative property
      +
      Returns:
      +
      self
      +
      +
      +
    • +
    • +
      +

      priority

      +
      BeanConfigurator<T> priority(int priority)
      +
      Set the priority of the configured bean. + By default, the configured bean does not have a priority. +

      + This is equivalent to putting the Priority + annotation to an actual bean class or making a custom + Bean class implement + Prioritized. +

      + This method has no effect if the configured bean is not an alternative.

      +
      +
      Parameters:
      +
      priority - the priority value
      +
      Returns:
      +
      self
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/configurator/InjectionPointConfigurator.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/configurator/InjectionPointConfigurator.html new file mode 100644 index 0000000000..f400a5cf3c --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/configurator/InjectionPointConfigurator.html @@ -0,0 +1,304 @@ + + + + +InjectionPointConfigurator (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface InjectionPointConfigurator

+
+
+
+
public interface InjectionPointConfigurator
+
This API is an helper to configure an existing InjectionPoint instance. + CDI container must provides an implementation of this interface. + + This builder is not thread safe and shall not be used concurrently. + +

+ CDI Lite implementations are not required to provide support for Portable Extensions. +

+
+
Since:
+
2.0
+
Author:
+
Antoine Sabot-Durand
+
See Also:
+
+ +
+
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      type

      +
      InjectionPointConfigurator type(Type requiredType)
      +
      Set the required Type (that will be used during typesafe resolution) + of the InjectionPoint to build.
      +
      +
      Parameters:
      +
      requiredType - for the InjectionPoint to build
      +
      Returns:
      +
      self
      +
      +
      +
    • +
    • +
      +

      addQualifier

      +
      InjectionPointConfigurator addQualifier(Annotation qualifier)
      +
      Add the qualifier to the InjectionPoint to build
      +
      +
      Parameters:
      +
      qualifier - the qualifier to add
      +
      Returns:
      +
      self
      +
      +
      +
    • +
    • +
      +

      addQualifiers

      +
      InjectionPointConfigurator addQualifiers(Annotation... qualifiers)
      +
      Add all the qualifiers to the InjectionPoint to build
      +
      +
      Parameters:
      +
      qualifiers - a varargs or array of qualifiers to add
      +
      Returns:
      +
      self
      +
      +
      +
    • +
    • +
      +

      addQualifiers

      +
      InjectionPointConfigurator addQualifiers(Set<Annotation> qualifiers)
      +
      Add all the qualifiers to the InjectionPoint to build
      +
      +
      Parameters:
      +
      qualifiers - a Set of qualifiers to add
      +
      Returns:
      +
      self
      +
      +
      +
    • +
    • +
      +

      qualifiers

      +
      InjectionPointConfigurator qualifiers(Annotation... qualifiers)
      +
      Replace all qualifiers.
      +
      +
      Parameters:
      +
      qualifiers - a varargs or array of qualifiers to replace to existing ones
      +
      Returns:
      +
      self
      +
      +
      +
    • +
    • +
      +

      qualifiers

      +
      InjectionPointConfigurator qualifiers(Set<Annotation> qualifiers)
      +
      Replace all qualifiers.
      +
      +
      Parameters:
      +
      qualifiers - a Set of qualifiers to replace to existing ones
      +
      Returns:
      +
      self
      +
      +
      +
    • +
    • +
      +

      delegate

      +
      InjectionPointConfigurator delegate(boolean delegate)
      +
      Change the delegate status of the built InjectionPoint. + By default the InjectionPoint is not a delegate one.
      +
      +
      Parameters:
      +
      delegate - boolean to define or undefine the delegate nature of the configured InjectionPoint
      +
      Returns:
      +
      self
      +
      +
      +
    • +
    • +
      +

      transientField

      +
      InjectionPointConfigurator transientField(boolean trans)
      +
      Change the transient status of the built InjectionPoint. + By default the InjectionPoint is not transient.
      +
      +
      Parameters:
      +
      trans - boolean to define or undefine the transient nature of the configured InjectionPoint
      +
      Returns:
      +
      self
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/configurator/ObserverMethodConfigurator.EventConsumer.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/configurator/ObserverMethodConfigurator.EventConsumer.html new file mode 100644 index 0000000000..9bfd1bf548 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/configurator/ObserverMethodConfigurator.EventConsumer.html @@ -0,0 +1,176 @@ + + + + +ObserverMethodConfigurator.EventConsumer (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface ObserverMethodConfigurator.EventConsumer<T>

+
+
+
+
Type Parameters:
+
T - event type
+
+
+
Enclosing interface:
+
ObserverMethodConfigurator<T>
+
+
+
Functional Interface:
+
This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
+
+
+
@FunctionalInterface +public static interface ObserverMethodConfigurator.EventConsumer<T>
+
Represents an operation that accepts a context of a fired event.
+
+
Author:
+
Martin Kouba
+
See Also:
+
+ +
+
+
+
+
    + +
  • +
    +

    Method Summary

    +
    +
    +
    +
    +
    Modifier and Type
    +
    Method
    +
    Description
    +
    void
    +
    accept(EventContext<T> eventContext)
    +
     
    +
    +
    +
    +
    +
  • +
+
+
+ +
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/configurator/ObserverMethodConfigurator.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/configurator/ObserverMethodConfigurator.html new file mode 100644 index 0000000000..8d1416f8b7 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/configurator/ObserverMethodConfigurator.html @@ -0,0 +1,452 @@ + + + + +ObserverMethodConfigurator (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface ObserverMethodConfigurator<T>

+
+
+
+
Type Parameters:
+
T - type of the event the configured ObserverMethod will observe
+
+
+
public interface ObserverMethodConfigurator<T>
+

+ An ObserverMethodConfigurator can configure an ObserverMethod. The container must provide an implementation + of this interface. +

+ +

+ This configurator is not thread safe and shall not be used concurrently. +

+ +

+ CDI Lite implementations are not required to provide support for Portable Extensions. +

+
+
Since:
+
2.0
+
Author:
+
Antoine Sabot-Durand
+
See Also:
+
+ +
+
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      read

      + +
      Read observer meta data from a existing Method
      +
      +
      Parameters:
      +
      method - to read meta data from
      +
      Returns:
      +
      self
      +
      +
      +
    • +
    • +
      +

      read

      + +
      Read observer meta data from a existing AnnotatedMethod
      +
      +
      Parameters:
      +
      method - to read meta data from
      +
      Returns:
      +
      self
      +
      +
      +
    • +
    • +
      +

      read

      + +
      Read observer meta data from a existing ObserverMethod
      +
      +
      Parameters:
      +
      method - to read meta data from
      +
      Returns:
      +
      self
      +
      +
      +
    • +
    • +
      +

      beanClass

      +
      ObserverMethodConfigurator<T> beanClass(Class<?> type)
      +
      Set the class of the Bean containing this observer. If not set, the extension class is used.
      +
      +
      Parameters:
      +
      type - the bean class containing this configurator.
      +
      Returns:
      +
      self
      +
      +
      +
    • +
    • +
      +

      observedType

      +
      ObserverMethodConfigurator<T> observedType(Type type)
      +
      Set the type of the observed event
      +
      +
      Parameters:
      +
      type - of the observed event
      +
      Returns:
      +
      self
      +
      +
      +
    • +
    • +
      +

      addQualifier

      +
      ObserverMethodConfigurator<T> addQualifier(Annotation qualifier)
      +
      Add the qualifier to the observed event
      +
      +
      Parameters:
      +
      qualifier - to add to event
      +
      Returns:
      +
      self
      +
      +
      +
    • +
    • +
      +

      addQualifiers

      +
      ObserverMethodConfigurator<T> addQualifiers(Annotation... qualifiers)
      +
      Add all the qualifiers to the Observed event
      +
      +
      Parameters:
      +
      qualifiers - to add to event
      +
      Returns:
      +
      self
      +
      +
      +
    • +
    • +
      +

      addQualifiers

      +
      ObserverMethodConfigurator<T> addQualifiers(Set<Annotation> qualifiers)
      +
      Add all the qualifiers to the Observed event
      +
      +
      Parameters:
      +
      qualifiers - to add to event
      +
      Returns:
      +
      self
      +
      +
      +
    • +
    • +
      +

      qualifiers

      +
      ObserverMethodConfigurator<T> qualifiers(Annotation... qualifiers)
      +
      Replace all qualifiers on the Observed event.
      +
      +
      Parameters:
      +
      qualifiers - to put on event
      +
      Returns:
      +
      self
      +
      +
      +
    • +
    • +
      +

      qualifiers

      +
      ObserverMethodConfigurator<T> qualifiers(Set<Annotation> qualifiers)
      +
      Replace all qualifiers on the Observed event.
      +
      +
      Parameters:
      +
      qualifiers - to put on event
      +
      Returns:
      +
      self
      +
      +
      +
    • +
    • +
      +

      reception

      +
      ObserverMethodConfigurator<T> reception(Reception reception)
      +
      Set the Reception mode for the observer to build
      +
      +
      Parameters:
      +
      reception - reception type
      +
      Returns:
      +
      self
      +
      +
      +
    • +
    • +
      +

      transactionPhase

      +
      ObserverMethodConfigurator<T> transactionPhase(TransactionPhase transactionPhase)
      +
      Set the TransactionPhase for the observer to build
      +
      +
      Parameters:
      +
      transactionPhase - phase for the observer
      +
      Returns:
      +
      self
      +
      +
      +
    • +
    • +
      +

      priority

      +
      ObserverMethodConfigurator<T> priority(int priority)
      +
      Set the priority for the observer to build
      +
      +
      Parameters:
      +
      priority - priority of the observer
      +
      Returns:
      +
      self
      +
      +
      +
    • +
    • +
      +

      notifyWith

      + +
      Define an operation that accepts a context of a fired event.
      +
      +
      Parameters:
      +
      callback - to call for the event notification
      +
      Returns:
      +
      self
      +
      +
      +
    • +
    • +
      +

      async

      +
      ObserverMethodConfigurator<T> async(boolean async)
      +
      Allows modification of the asynchronous status of the observer to build.
      +
      +
      Parameters:
      +
      async - async status
      +
      Returns:
      +
      self
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/configurator/ProducerConfigurator.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/configurator/ProducerConfigurator.html new file mode 100644 index 0000000000..04ef9b6511 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/configurator/ProducerConfigurator.html @@ -0,0 +1,214 @@ + + + + +ProducerConfigurator (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface ProducerConfigurator<T>

+
+
+
+
Type Parameters:
+
T - The return type of the producer method or the type of the producer field
+
+
+
public interface ProducerConfigurator<T>
+

+ A ProducerConfigurator can configure a Producer. The container must provide an implementation of this + interface. +

+ +

+ This configurator is not thread safe and shall not be used concurrently. +

+ +

+ CDI Lite implementations are not required to provide support for Portable Extensions. +

+
+
Since:
+
2.0
+
Author:
+
Martin Kouba
+
See Also:
+
+ +
+
+
+
+ +
+
+ +
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/configurator/class-use/AnnotatedConstructorConfigurator.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/configurator/class-use/AnnotatedConstructorConfigurator.html new file mode 100644 index 0000000000..3c23deacd0 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/configurator/class-use/AnnotatedConstructorConfigurator.html @@ -0,0 +1,113 @@ + + + + +Uses of Interface jakarta.enterprise.inject.spi.configurator.AnnotatedConstructorConfigurator (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.enterprise.inject.spi.configurator.AnnotatedConstructorConfigurator

+
+ +
+
Package
+
Description
+ +
 
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/configurator/class-use/AnnotatedFieldConfigurator.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/configurator/class-use/AnnotatedFieldConfigurator.html new file mode 100644 index 0000000000..238e2881db --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/configurator/class-use/AnnotatedFieldConfigurator.html @@ -0,0 +1,113 @@ + + + + +Uses of Interface jakarta.enterprise.inject.spi.configurator.AnnotatedFieldConfigurator (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.enterprise.inject.spi.configurator.AnnotatedFieldConfigurator

+
+
Packages that use AnnotatedFieldConfigurator
+
+
Package
+
Description
+ +
 
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/configurator/class-use/AnnotatedMethodConfigurator.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/configurator/class-use/AnnotatedMethodConfigurator.html new file mode 100644 index 0000000000..b551f2537a --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/configurator/class-use/AnnotatedMethodConfigurator.html @@ -0,0 +1,113 @@ + + + + +Uses of Interface jakarta.enterprise.inject.spi.configurator.AnnotatedMethodConfigurator (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.enterprise.inject.spi.configurator.AnnotatedMethodConfigurator

+
+
Packages that use AnnotatedMethodConfigurator
+
+
Package
+
Description
+ +
 
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/configurator/class-use/AnnotatedParameterConfigurator.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/configurator/class-use/AnnotatedParameterConfigurator.html new file mode 100644 index 0000000000..747fb8e8ca --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/configurator/class-use/AnnotatedParameterConfigurator.html @@ -0,0 +1,119 @@ + + + + +Uses of Interface jakarta.enterprise.inject.spi.configurator.AnnotatedParameterConfigurator (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.enterprise.inject.spi.configurator.AnnotatedParameterConfigurator

+
+ +
+
Package
+
Description
+ +
 
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/configurator/class-use/AnnotatedTypeConfigurator.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/configurator/class-use/AnnotatedTypeConfigurator.html new file mode 100644 index 0000000000..e040aeae36 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/configurator/class-use/AnnotatedTypeConfigurator.html @@ -0,0 +1,166 @@ + + + + +Uses of Interface jakarta.enterprise.inject.spi.configurator.AnnotatedTypeConfigurator (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.enterprise.inject.spi.configurator.AnnotatedTypeConfigurator

+
+
Packages that use AnnotatedTypeConfigurator
+
+
Package
+
Description
+ +
+
+ The portable extension integration SPI.
+
+ +
 
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/configurator/class-use/BeanAttributesConfigurator.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/configurator/class-use/BeanAttributesConfigurator.html new file mode 100644 index 0000000000..1ec6798829 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/configurator/class-use/BeanAttributesConfigurator.html @@ -0,0 +1,198 @@ + + + + +Uses of Interface jakarta.enterprise.inject.spi.configurator.BeanAttributesConfigurator (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.enterprise.inject.spi.configurator.BeanAttributesConfigurator

+
+
Packages that use BeanAttributesConfigurator
+
+
Package
+
Description
+ +
+
+ The portable extension integration SPI.
+
+ +
 
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/configurator/class-use/BeanConfigurator.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/configurator/class-use/BeanConfigurator.html new file mode 100644 index 0000000000..d9d13ae3ce --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/configurator/class-use/BeanConfigurator.html @@ -0,0 +1,267 @@ + + + + +Uses of Interface jakarta.enterprise.inject.spi.configurator.BeanConfigurator (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.enterprise.inject.spi.configurator.BeanConfigurator

+
+
Packages that use BeanConfigurator
+
+
Package
+
Description
+ +
+
+ The portable extension integration SPI.
+
+ +
 
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/configurator/class-use/InjectionPointConfigurator.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/configurator/class-use/InjectionPointConfigurator.html new file mode 100644 index 0000000000..aa8e4a0c8b --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/configurator/class-use/InjectionPointConfigurator.html @@ -0,0 +1,149 @@ + + + + +Uses of Interface jakarta.enterprise.inject.spi.configurator.InjectionPointConfigurator (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.enterprise.inject.spi.configurator.InjectionPointConfigurator

+
+
Packages that use InjectionPointConfigurator
+
+
Package
+
Description
+ +
+
+ The portable extension integration SPI.
+
+ +
 
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/configurator/class-use/ObserverMethodConfigurator.EventConsumer.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/configurator/class-use/ObserverMethodConfigurator.EventConsumer.html new file mode 100644 index 0000000000..e7151e4a15 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/configurator/class-use/ObserverMethodConfigurator.EventConsumer.html @@ -0,0 +1,91 @@ + + + + +Uses of Interface jakarta.enterprise.inject.spi.configurator.ObserverMethodConfigurator.EventConsumer (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.enterprise.inject.spi.configurator.ObserverMethodConfigurator.EventConsumer

+
+ +
+
Package
+
Description
+ +
 
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/configurator/class-use/ObserverMethodConfigurator.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/configurator/class-use/ObserverMethodConfigurator.html new file mode 100644 index 0000000000..ee784bd82e --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/configurator/class-use/ObserverMethodConfigurator.html @@ -0,0 +1,189 @@ + + + + +Uses of Interface jakarta.enterprise.inject.spi.configurator.ObserverMethodConfigurator (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.enterprise.inject.spi.configurator.ObserverMethodConfigurator

+
+
Packages that use ObserverMethodConfigurator
+
+
Package
+
Description
+ +
+
+ The portable extension integration SPI.
+
+ +
 
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/configurator/class-use/ProducerConfigurator.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/configurator/class-use/ProducerConfigurator.html new file mode 100644 index 0000000000..50559d67d5 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/configurator/class-use/ProducerConfigurator.html @@ -0,0 +1,118 @@ + + + + +Uses of Interface jakarta.enterprise.inject.spi.configurator.ProducerConfigurator (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.enterprise.inject.spi.configurator.ProducerConfigurator

+
+
Packages that use ProducerConfigurator
+
+
Package
+
Description
+ +
+
+ The portable extension integration SPI.
+
+ +
 
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/configurator/package-summary.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/configurator/package-summary.html new file mode 100644 index 0000000000..65dabe7628 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/configurator/package-summary.html @@ -0,0 +1,159 @@ + + + + +jakarta.enterprise.inject.spi.configurator (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Package jakarta.enterprise.inject.spi.configurator

+
+
+
package jakarta.enterprise.inject.spi.configurator
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/configurator/package-tree.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/configurator/package-tree.html new file mode 100644 index 0000000000..29b4c207f7 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/configurator/package-tree.html @@ -0,0 +1,84 @@ + + + + +jakarta.enterprise.inject.spi.configurator Class Hierarchy (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Hierarchy For Package jakarta.enterprise.inject.spi.configurator

+
+Package Hierarchies: + +
+

Interface Hierarchy

+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/configurator/package-use.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/configurator/package-use.html new file mode 100644 index 0000000000..f8a7bfb380 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/configurator/package-use.html @@ -0,0 +1,172 @@ + + + + +Uses of Package jakarta.enterprise.inject.spi.configurator (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Package
jakarta.enterprise.inject.spi.configurator

+
+ +
+
Package
+
Description
+ +
+
+ The portable extension integration SPI.
+
+ +
 
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/el/ELAwareBeanManager.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/el/ELAwareBeanManager.html new file mode 100644 index 0000000000..6cf7185fa3 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/el/ELAwareBeanManager.html @@ -0,0 +1,195 @@ + + + + +ELAwareBeanManager (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface ELAwareBeanManager

+
+
+
+
All Superinterfaces:
+
BeanContainer, BeanManager
+
+
+
public interface ELAwareBeanManager +extends BeanManager
+
A BeanManager that allows integrators to obtain Unified EL objects that are + integrated with the CDI container as described in the Jakarta EE Platform specification.
+
+
Since:
+
4.1
+
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      getELResolver

      +
      jakarta.el.ELResolver getELResolver()
      +
      Returns a ELResolver that resolves beans by EL name.
      +
      +
      Specified by:
      +
      getELResolver in interface BeanManager
      +
      Returns:
      +
      the ELResolver
      +
      +
      +
    • +
    • +
      +

      wrapExpressionFactory

      +
      jakarta.el.ExpressionFactory wrapExpressionFactory(jakarta.el.ExpressionFactory expressionFactory)
      +
      Returns a wrapper ExpressionFactory that delegates MethodExpression and + ValueExpression creation to the given ExpressionFactory. When a Unified EL + expression is evaluated using a MethodExpression or ValueExpression returned by the + wrapper ExpressionFactory, the container handles destruction of objects with scope Dependent.
      +
      +
      Specified by:
      +
      wrapExpressionFactory in interface BeanManager
      +
      Parameters:
      +
      expressionFactory - the ExpressionFactory to wrap
      +
      Returns:
      +
      the wrapped ExpressionFactory
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/el/class-use/ELAwareBeanManager.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/el/class-use/ELAwareBeanManager.html new file mode 100644 index 0000000000..b098a9881b --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/el/class-use/ELAwareBeanManager.html @@ -0,0 +1,64 @@ + + + + +Uses of Interface jakarta.enterprise.inject.spi.el.ELAwareBeanManager (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.enterprise.inject.spi.el.ELAwareBeanManager

+
+No usage of jakarta.enterprise.inject.spi.el.ELAwareBeanManager
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/el/package-summary.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/el/package-summary.html new file mode 100644 index 0000000000..cf0feb9ee9 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/el/package-summary.html @@ -0,0 +1,117 @@ + + + + +jakarta.enterprise.inject.spi.el (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Package jakarta.enterprise.inject.spi.el

+
+
+
package jakarta.enterprise.inject.spi.el
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/el/package-tree.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/el/package-tree.html new file mode 100644 index 0000000000..0d67a7c2b7 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/el/package-tree.html @@ -0,0 +1,82 @@ + + + + +jakarta.enterprise.inject.spi.el Class Hierarchy (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Hierarchy For Package jakarta.enterprise.inject.spi.el

+
+Package Hierarchies: + +
+

Interface Hierarchy

+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/el/package-use.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/el/package-use.html new file mode 100644 index 0000000000..79d131d9d9 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/el/package-use.html @@ -0,0 +1,64 @@ + + + + +Uses of Package jakarta.enterprise.inject.spi.el (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Package
jakarta.enterprise.inject.spi.el

+
+No usage of jakarta.enterprise.inject.spi.el
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/package-summary.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/package-summary.html new file mode 100644 index 0000000000..35565e0eef --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/package-summary.html @@ -0,0 +1,555 @@ + + + + +jakarta.enterprise.inject.spi (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Package jakarta.enterprise.inject.spi

+
+
+
package jakarta.enterprise.inject.spi
+
+

+ The portable extension integration SPI. +

+ +

+ A portable extension may integrate with the container by: +

+ +
    +
  • Providing its own beans, interceptors and decorators to the + container
  • +
  • Injecting dependencies into its own objects using the + dependency injection service
  • +
  • Providing a context implementation for a custom scope
  • +
  • Augmenting or overriding the annotation-based metadata with + metadata from some other source
  • +
+ +

The BeanManager object

+ +

+ Portable extensions sometimes interact directly with the container + via programmatic API call. The interface + BeanManager provides operations + for obtaining contextual references for beans, along with many other + operations of use to portable extensions. +

+ +

Container lifecycle events

+ +

+ During the application initialization process, the container fires + a series of events, allowing + portable extensions to integrate with the container initialization + process. Observer methods of these events must belong to + extensions declared + in META-INF/services. +

+ +

+ Lifecycle events include + BeforeBeanDiscovery, + AfterBeanDiscovery, + AfterDeploymentValidation and + BeforeShutdown. +

+ +

Interfaces representing enabled beans

+ +

+ The interfaces + Bean, + Decorator, + Interceptor and + ObserverMethod + define everything the container needs to manage instances of + a bean, interceptor, decorator or observer method. +

+ +

+ An instance of Bean exists for every + enabled bean. A portable + extension may add support for new kinds of beans by implementing + Bean, observing the event + AfterBeanDiscovery event + registering beans with the container. An instance of + ObserverMethod exists for every + observer method of every + enabled bean. A portable extension may add observers by implementing + ObserverMethod and + registering an instance with the container. +

+ +

+ A portable extension may be notified of the existence of an + enabled bean by observing the container lifecycle event type + ProcessBean or one of its + subtypes, + or of the existence of an observer method of an enabled bean by + observing the event type + ProcessObserverMethod. +

+ +

Alternate metadata sources

+ +

+ A portable extension may provide an alternative metadata + source, such as configuration by XML. +

+ +

+ Annotated + and its subtypes allow a portable extension to specify + metadata that overrides the annotations that exist on a + bean class. The portable extension is responsible for + implementing the interfaces, thereby exposing the metadata + to the container. The container must use the operations of + Annotated and its subinterfaces to discover program + element types and annotations, instead of directly calling the + Java Reflection API. +

+ +

+ A portable extension provides its metadata to the + container by observing the event + ProcessAnnotatedType and + wrapping the AnnotatedType. +

+ +

Producer and InjectionTarget

+ +

+ The interfaces Producer and + InjectionTarget abstract the + basic lifecycle of (contextual or non-contextual) container managed + objects, including instantiation and destruction, dependency injection + and lifecycle callbacks. +

+ +

+ An instance of InjectionTarget + may be product of + BeanManager.getInjectionTargetFactory(AnnotatedType) + obtained from the BeanManager, + allowing a portable extension to request these container services for + objects under the control of the portable extension. +

+ +

+ Furthermore, a portable extension may replace the implementation + of InjectionTarget or + Producer used by the container + with its own implementation by observing the events + ProcessInjectionTarget or + ProcessProducer. +

+
+
See Also:
+
+ +
+
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/package-tree.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/package-tree.html new file mode 100644 index 0000000000..e700e535dc --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/package-tree.html @@ -0,0 +1,212 @@ + + + + +jakarta.enterprise.inject.spi Class Hierarchy (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Hierarchy For Package jakarta.enterprise.inject.spi

+
+Package Hierarchies: + +
+

Class Hierarchy

+ +
+
+

Interface Hierarchy

+ +
+
+

Annotation Interface Hierarchy

+ +
+
+

Enum Class Hierarchy

+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/package-use.html b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/package-use.html new file mode 100644 index 0000000000..cd32d48a04 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/inject/spi/package-use.html @@ -0,0 +1,406 @@ + + + + +Uses of Package jakarta.enterprise.inject.spi (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Package
jakarta.enterprise.inject.spi

+
+ +
+
Package
+
Description
+ +
 
+ +
+
+ The build compatible extension SPI.
+
+ +
 
+ +
+
+ The portable extension integration SPI.
+
+ +
 
+ +
 
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/invoke/Invoker.html b/cdi/4.1/apidocs/jakarta/enterprise/invoke/Invoker.html new file mode 100644 index 0000000000..aed4e52145 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/invoke/Invoker.html @@ -0,0 +1,211 @@ + + + + +Invoker (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface Invoker<T,R>

+
+
+
+
Type Parameters:
+
T - type of the target bean
+
R - return type of the target method
+
+
+
public interface Invoker<T,R>
+
An invoker allows indirect invocation of its target method on an instance of its target + bean. +

+ CDI-based frameworks are expected to use invokers when they need to invoke application + methods. Applications are not supposed to use invokers, as they can invoke their own + methods directly. +

+ For example, assume the following managed bean exists: + +

+ @Dependent
+ public class MyService {
+     public String hello(String name) {
+         return "Hello " + name + "!";
+     }
+ }
+ 
+ + Further, assume that invoker is an invoker for the hello() method + of the MyService bean and myService is a contextual reference for the bean. + Then, to invoke the hello() method indirectly, a framework would call + +
+ invoker.invoke(myService, new Object[] { "world" })
+ 
+ + The return value would be "Hello world!".
+
+
Since:
+
4.1
+
See Also:
+
+ +
+
+
+
+
    + +
  • +
    +

    Method Summary

    +
    +
    +
    +
    +
    Modifier and Type
    +
    Method
    +
    Description
    + +
    invoke(T instance, + Object[] arguments)
    +
    +
    Invokes the target method on the given instance of the target bean, passing + given arguments.
    +
    +
    +
    +
    +
    +
  • +
+
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      invoke

      +
      R invoke(T instance, + Object[] arguments) + throws Exception
      +
      Invokes the target method on the given instance of the target bean, passing + given arguments. If the target method returns normally, this method returns + its return value, unless the target method is declared void, in which case + this method returns null. If the target method throws an exception, it is + rethrown directly.
      +
      +
      Parameters:
      +
      instance - the instance of the target bean on which the target method is to be invoked; + may only be null if the target method is static
      +
      arguments - arguments to be passed to the target method; may only be null + if the target method declares no parameter
      +
      Returns:
      +
      return value of the target method, or null if the target method + is declared void
      +
      Throws:
      +
      RuntimeException - when instance or arguments are incorrect
      +
      Exception - when the target method throws an exception
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/invoke/InvokerBuilder.html b/cdi/4.1/apidocs/jakarta/enterprise/invoke/InvokerBuilder.html new file mode 100644 index 0000000000..3be1874f30 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/invoke/InvokerBuilder.html @@ -0,0 +1,239 @@ + + + + +InvokerBuilder (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface InvokerBuilder<T>

+
+
+
+
Type Parameters:
+
T - type of outcome of this builder; always represents an Invoker, + but does not necessarily have to be an Invoker instance directly
+
+
+
public interface InvokerBuilder<T>
+
Builder of Invokers. Allows configuring additional behaviors on top of a plain + method invocation. + +

Lookups

+ + For the target bean instance (withInstanceLookup()) and for each target method + parameter (withArgumentLookup(int)), it is possible to specify that the corresponding + value passed to Invoker.invoke() shall be ignored and a value shall be looked up + from the CDI container instead. +

+ For example, assume the following managed bean exists: + +

+ @Dependent
+ public class MyService {
+     public String hello(String name) {
+         return "Hello " + name + "!";
+     }
+ }
+ 
+ + A CDI-based framework may want to build an invoker for the hello() method that + automatically looks up MyService from the CDI container, instead of having to + obtain a contextual reference manually. +

+ Assuming that builder is an InvokerBuilder for MyService.hello(), + such invoker can be built: + +

+ builder.withInstanceLookup().build();
+ 
+ + Later, to invoke the hello() method, a framework could pass null as the instance: + +
+ invoker.invoke(null, new Object[] { "world" })
+ 
+ + The invoker would look up the instance of the target bean automatically, so the method would be + invoked correctly and the return value would be "Hello world!".
+
+
Since:
+
4.1
+
+
+
+
    + +
  • +
    +

    Method Summary

    +
    +
    +
    +
    +
    Modifier and Type
    +
    Method
    +
    Description
    + + +
    +
    Returns the built Invoker or some representation of it.
    +
    + +
    withArgumentLookup(int position)
    +
    +
    Enables lookup of the argument on given position.
    +
    + + +
    +
    Enables lookup of the target bean instance.
    +
    +
    +
    +
    +
    +
  • +
+
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      withInstanceLookup

      +
      InvokerBuilder<T> withInstanceLookup()
      +
      Enables lookup of the target bean instance.
      +
      +
      Returns:
      +
      this builder
      +
      +
      +
    • +
    • +
      +

      withArgumentLookup

      +
      InvokerBuilder<T> withArgumentLookup(int position)
      +
      Enables lookup of the argument on given position.
      +
      +
      Parameters:
      +
      position - zero-based position of the target method parameter for which lookup should be enabled
      +
      Returns:
      +
      this builder
      +
      Throws:
      +
      IllegalArgumentException - if position is less than 0 or greater than + or equal to the number of parameters declared by the target method
      +
      +
      +
    • +
    • +
      +

      build

      +
      T build()
      +
      Returns the built Invoker or some representation of it. Implementations are allowed + but not required to reuse already built invokers when possible.
      +
      +
      Returns:
      +
      the built invoker
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/invoke/class-use/Invoker.html b/cdi/4.1/apidocs/jakarta/enterprise/invoke/class-use/Invoker.html new file mode 100644 index 0000000000..c029777448 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/invoke/class-use/Invoker.html @@ -0,0 +1,94 @@ + + + + +Uses of Interface jakarta.enterprise.invoke.Invoker (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.enterprise.invoke.Invoker

+
+
Packages that use Invoker
+
+
Package
+
Description
+ +
+
+ The portable extension integration SPI.
+
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/invoke/class-use/InvokerBuilder.html b/cdi/4.1/apidocs/jakarta/enterprise/invoke/class-use/InvokerBuilder.html new file mode 100644 index 0000000000..6b756126c3 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/invoke/class-use/InvokerBuilder.html @@ -0,0 +1,139 @@ + + + + +Uses of Interface jakarta.enterprise.invoke.InvokerBuilder (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.enterprise.invoke.InvokerBuilder

+
+
Packages that use InvokerBuilder
+
+
Package
+
Description
+ +
+
+ The build compatible extension SPI.
+
+ +
+
+ The portable extension integration SPI.
+
+ +
 
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/invoke/package-summary.html b/cdi/4.1/apidocs/jakarta/enterprise/invoke/package-summary.html new file mode 100644 index 0000000000..59932043eb --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/invoke/package-summary.html @@ -0,0 +1,105 @@ + + + + +jakarta.enterprise.invoke (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Package jakarta.enterprise.invoke

+
+
+
package jakarta.enterprise.invoke
+
+
    +
  • +
    +
    Interfaces
    +
    +
    Class
    +
    Description
    +
    Invoker<T,R>
    +
    +
    An invoker allows indirect invocation of its target method on an instance of its target + bean.
    +
    + +
    +
    Builder of Invokers.
    +
    +
    +
    +
  • +
+
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/invoke/package-tree.html b/cdi/4.1/apidocs/jakarta/enterprise/invoke/package-tree.html new file mode 100644 index 0000000000..3f5be94960 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/invoke/package-tree.html @@ -0,0 +1,75 @@ + + + + +jakarta.enterprise.invoke Class Hierarchy (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Hierarchy For Package jakarta.enterprise.invoke

+
+Package Hierarchies: + +
+

Interface Hierarchy

+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/invoke/package-use.html b/cdi/4.1/apidocs/jakarta/enterprise/invoke/package-use.html new file mode 100644 index 0000000000..c550c65beb --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/invoke/package-use.html @@ -0,0 +1,129 @@ + + + + +Uses of Package jakarta.enterprise.invoke (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Package
jakarta.enterprise.invoke

+
+
Packages that use jakarta.enterprise.invoke
+
+
Package
+
Description
+ +
+
+ The build compatible extension SPI.
+
+ +
+
+ The portable extension integration SPI.
+
+ +
 
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/lang/model/AnnotationInfo.html b/cdi/4.1/apidocs/jakarta/enterprise/lang/model/AnnotationInfo.html new file mode 100644 index 0000000000..22f66d2e68 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/lang/model/AnnotationInfo.html @@ -0,0 +1,289 @@ + + + + +AnnotationInfo (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface AnnotationInfo

+
+
+
+
public interface AnnotationInfo
+
An annotation instance, typically obtained from an AnnotationTarget. + Provides access to annotation members and their values. +

+ Implementations of this interface are required to define the equals and hashCode methods. + Implementations of this interface are encouraged to define the toString method such that + it returns a text resembling the corresponding Java™ syntax. +

+ There is no guarantee that any particular annotation instance, represented by an implementation of this interface, + will always be represented by the same object. That includes natural singletons such as the jakarta.inject.Singleton + annotation. Instances should always be compared using equals.

+
+
Since:
+
4.0
+
+
+
+
    + +
  • +
    +

    Method Summary

    +
    +
    +
    +
    +
    Modifier and Type
    +
    Method
    +
    Description
    + + +
    +
    Returns the declaration of this annotation's type.
    +
    +
    boolean
    + +
    +
    Returns whether this annotation has a member with given name.
    +
    +
    default boolean
    + +
    +
    Returns whether this annotation has the value member.
    +
    +
    default boolean
    + +
    +
    Returns whether this annotation is repeatable.
    +
    + +
    member(String name)
    +
    +
    Returns the value of this annotation's member with given name.
    +
    + + +
    +
    Returns all members of this annotation as a map, where the key is the member name + and the value is the member value.
    +
    +
    default String
    + +
    +
    Binary name of this annotation's type, as defined by The Java™ Language Specification; + in other words, the annotation type name as returned by Class.getName().
    +
    + + +
    +
    Returns the value of this annotation's value member.
    +
    +
    +
    +
    +
    +
  • +
+
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      declaration

      +
      ClassInfo declaration()
      +
      Returns the declaration of this annotation's type.
      +
      +
      Returns:
      +
      the declaration of this annotation's type, never null
      +
      +
      +
    • +
    • +
      +

      name

      +
      default String name()
      +
      Binary name of this annotation's type, as defined by The Java™ Language Specification; + in other words, the annotation type name as returned by Class.getName(). + Equivalent to declaration().name().
      +
      +
      Returns:
      +
      binary name of this annotation's type, never null
      +
      +
      +
    • +
    • +
      +

      isRepeatable

      +
      default boolean isRepeatable()
      +
      Returns whether this annotation is repeatable. In other words, returns whether + this annotation's type is meta-annotated @Repeatable.
      +
      +
      Returns:
      +
      whether this annotation is repeatable
      +
      +
      +
    • +
    • +
      +

      hasMember

      +
      boolean hasMember(String name)
      +
      Returns whether this annotation has a member with given name.
      +
      +
      Parameters:
      +
      name - member name, must not be null
      +
      Returns:
      +
      true if this annotation has a member with given name, false otherwise
      +
      +
      +
    • +
    • +
      +

      member

      +
      AnnotationMember member(String name)
      +
      Returns the value of this annotation's member with given name.
      +
      +
      Parameters:
      +
      name - member name, must not be null
      +
      Returns:
      +
      value of this annotation's member with given name or null if such member does not exist
      +
      +
      +
    • +
    • +
      +

      hasValue

      +
      default boolean hasValue()
      +
      Returns whether this annotation has the value member.
      +
      +
      Returns:
      +
      true if this annotation has the value member, false otherwise
      +
      +
      +
    • +
    • +
      +

      value

      +
      default AnnotationMember value()
      +
      Returns the value of this annotation's value member.
      +
      +
      Returns:
      +
      value of this annotation's value member or null if the member does not + exist
      +
      +
      +
    • +
    • +
      +

      members

      + +
      Returns all members of this annotation as a map, where the key is the member name + and the value is the member value. Returns an empty map if this annotation has no members.
      +
      +
      Returns:
      +
      an immutable map of all members of this annotation, never null
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/lang/model/AnnotationMember.Kind.html b/cdi/4.1/apidocs/jakarta/enterprise/lang/model/AnnotationMember.Kind.html new file mode 100644 index 0000000000..68d7c00a6a --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/lang/model/AnnotationMember.Kind.html @@ -0,0 +1,371 @@ + + + + +AnnotationMember.Kind (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Enum Class AnnotationMember.Kind

+
+
java.lang.Object +
java.lang.Enum<AnnotationMember.Kind> +
jakarta.enterprise.lang.model.AnnotationMember.Kind
+
+
+
+
+
All Implemented Interfaces:
+
Serializable, Comparable<AnnotationMember.Kind>, Constable
+
+
+
Enclosing interface:
+
AnnotationMember
+
+
+
public static enum AnnotationMember.Kind +extends Enum<AnnotationMember.Kind>
+
The kind of the annotation member value.
+
+
+ +
+
+
    + +
  • +
    +

    Enum Constant Details

    + +
    +
  • + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      values

      +
      public static AnnotationMember.Kind[] values()
      +
      Returns an array containing the constants of this enum class, in +the order they are declared.
      +
      +
      Returns:
      +
      an array containing the constants of this enum class, in the order they are declared
      +
      +
      +
    • +
    • +
      +

      valueOf

      +
      public static AnnotationMember.Kind valueOf(String name)
      +
      Returns the enum constant of this class with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this class. (Extraneous whitespace characters are +not permitted.)
      +
      +
      Parameters:
      +
      name - the name of the enum constant to be returned.
      +
      Returns:
      +
      the enum constant with the specified name
      +
      Throws:
      +
      IllegalArgumentException - if this enum class has no constant with the specified name
      +
      NullPointerException - if the argument is null
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/lang/model/AnnotationMember.html b/cdi/4.1/apidocs/jakarta/enterprise/lang/model/AnnotationMember.html new file mode 100644 index 0000000000..4f71be6de2 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/lang/model/AnnotationMember.html @@ -0,0 +1,689 @@ + + + + +AnnotationMember (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface AnnotationMember

+
+
+
+
public interface AnnotationMember
+
The value of an annotation member. Annotation member values are of several kinds: +
    +
  • primitive constants;
  • +
  • String constants;
  • +
  • Enum constants;
  • +
  • Class literals;
  • +
  • nested Annotations;
  • +
  • arrays of previously mentioned types.
  • +
+ The kind() method returns the kind of this annotation member value. The is* methods + (such as isBoolean()) allow checking if this annotation member value is of given kind. + The as* methods (such as asBoolean()) allow "unwrapping" this annotation member value, + if it is of the corresponding kind. +

+ Note that the as* methods do not perform type conversion, so if this annotation member value + is an int, calling asLong() will throw an exception. +

+ Implementations of this interface are required to define the equals and hashCode methods. + Implementations of this interface are encouraged to define the toString method such that + it returns a text resembling the corresponding Java™ syntax. +

+ There is no guarantee that any particular annotation member, represented by an implementation of this interface, + will always be represented by the same object. This includes natural singletons such as boolean values. + Instances should always be compared using equals.

+
+
Since:
+
4.0
+
+
+
+
    + +
  • +
    +

    Nested Class Summary

    +
    Nested Classes
    +
    +
    Modifier and Type
    +
    Interface
    +
    Description
    +
    static enum 
    + +
    +
    The kind of the annotation member value.
    +
    +
    +
    +
  • + +
  • +
    +

    Field Summary

    +
    Fields
    +
    +
    Modifier and Type
    +
    Field
    +
    Description
    +
    static final String
    + +
    +
    Name of the commonly used value() annotation member.
    +
    +
    +
    +
  • + +
  • +
    +

    Method Summary

    +
    +
    +
    +
    +
    Modifier and Type
    +
    Method
    +
    Description
    + + +
    +
    Returns this array value as an immutable List of AnnotationMembers.
    +
    +
    boolean
    + +
    +
    Returns this value as a boolean.
    +
    +
    byte
    + +
    +
    Returns this value as a byte.
    +
    +
    char
    + +
    +
    Returns this value as a char.
    +
    +
    double
    + +
    +
    Returns this value as a double.
    +
    +
    <E extends Enum<E>>
    E
    +
    asEnum(Class<E> enumType)
    +
    +
    Returns this enum value as an instance of the enum type.
    +
    + + +
    +
    Returns the type of this enum value.
    +
    + + +
    +
    Returns the name of this enum value.
    +
    +
    float
    + +
    +
    Returns this value as a float.
    +
    +
    int
    + +
    +
    Returns this value as an int.
    +
    +
    long
    + +
    +
    Returns this value as a long.
    +
    + + +
    +
    Returns this nested annotation value as an AnnotationInfo.
    +
    +
    short
    + +
    +
    Returns this value as a short.
    +
    + + +
    +
    Returns this value as a String.
    +
    + + +
    +
    Returns this class value as a Type.
    +
    +
    default boolean
    + +
     
    +
    default boolean
    + +
     
    +
    default boolean
    + +
     
    +
    default boolean
    + +
     
    +
    default boolean
    + +
     
    +
    default boolean
    + +
     
    +
    default boolean
    + +
     
    +
    default boolean
    + +
     
    +
    default boolean
    + +
     
    +
    default boolean
    + +
     
    +
    default boolean
    + +
     
    +
    default boolean
    + +
     
    +
    default boolean
    + +
     
    + + +
    +
    Returns the kind of this annotation member value.
    +
    +
    +
    +
    +
    +
  • +
+
+
+
    + +
  • +
    +

    Field Details

    +
      +
    • +
      +

      VALUE

      +
      static final String VALUE
      +
      Name of the commonly used value() annotation member.
      +
      +
      See Also:
      +
      + +
      +
      +
      +
    • +
    +
    +
  • + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      kind

      + +
      Returns the kind of this annotation member value.
      +
      +
      Returns:
      +
      the kind of this annotation member value, never null
      +
      +
      +
    • +
    • +
      +

      isBoolean

      +
      default boolean isBoolean()
      +
      +
      Returns:
      +
      true if the kind is a boolean, false otherwise
      +
      +
      +
    • +
    • +
      +

      isByte

      +
      default boolean isByte()
      +
      +
      Returns:
      +
      true if the kind is a byte, false otherwise
      +
      +
      +
    • +
    • +
      +

      isShort

      +
      default boolean isShort()
      +
      +
      Returns:
      +
      true if the kind is a short, false otherwise
      +
      +
      +
    • +
    • +
      +

      isInt

      +
      default boolean isInt()
      +
      +
      Returns:
      +
      true if the kind is an int, false otherwise
      +
      +
      +
    • +
    • +
      +

      isLong

      +
      default boolean isLong()
      +
      +
      Returns:
      +
      true if the kind is a long, false otherwise
      +
      +
      +
    • +
    • +
      +

      isFloat

      +
      default boolean isFloat()
      +
      +
      Returns:
      +
      true if the kind is a float, false otherwise
      +
      +
      +
    • +
    • +
      +

      isDouble

      +
      default boolean isDouble()
      +
      +
      Returns:
      +
      true if the kind is a double, false otherwise
      +
      +
      +
    • +
    • +
      +

      isChar

      +
      default boolean isChar()
      +
      +
      Returns:
      +
      true if the kind is a char, false otherwise
      +
      +
      +
    • +
    • +
      +

      isString

      +
      default boolean isString()
      +
      +
      Returns:
      +
      true if the kind is a String, false otherwise
      +
      +
      +
    • +
    • +
      +

      isEnum

      +
      default boolean isEnum()
      +
      +
      Returns:
      +
      true if the kind is an Enum, false otherwise
      +
      +
      +
    • +
    • +
      +

      isClass

      +
      default boolean isClass()
      +
      +
      Returns:
      +
      true if the kind is a Class, false otherwise
      +
      +
      +
    • +
    • +
      +

      isNestedAnnotation

      +
      default boolean isNestedAnnotation()
      +
      +
      Returns:
      +
      true if the kind is a nested Annotation, false otherwise
      +
      +
      +
    • +
    • +
      +

      isArray

      +
      default boolean isArray()
      +
      +
      Returns:
      +
      true if the kind is an array, false otherwise
      +
      +
      +
    • +
    • +
      +

      asBoolean

      +
      boolean asBoolean()
      +
      Returns this value as a boolean.
      +
      +
      Returns:
      +
      the boolean value
      +
      Throws:
      +
      IllegalStateException - if this annotation member value is not a boolean
      +
      +
      +
    • +
    • +
      +

      asByte

      +
      byte asByte()
      +
      Returns this value as a byte.
      +
      +
      Returns:
      +
      the byte value
      +
      Throws:
      +
      IllegalStateException - if this annotation member value is not a byte
      +
      +
      +
    • +
    • +
      +

      asShort

      +
      short asShort()
      +
      Returns this value as a short.
      +
      +
      Returns:
      +
      the short value
      +
      Throws:
      +
      IllegalStateException - if this annotation member value is not a short
      +
      +
      +
    • +
    • +
      +

      asInt

      +
      int asInt()
      +
      Returns this value as an int.
      +
      +
      Returns:
      +
      the int value
      +
      Throws:
      +
      IllegalStateException - if this annotation member value is not an int
      +
      +
      +
    • +
    • +
      +

      asLong

      +
      long asLong()
      +
      Returns this value as a long.
      +
      +
      Returns:
      +
      the long value
      +
      Throws:
      +
      IllegalStateException - if this annotation member value is not a long
      +
      +
      +
    • +
    • +
      +

      asFloat

      +
      float asFloat()
      +
      Returns this value as a float.
      +
      +
      Returns:
      +
      the float value
      +
      Throws:
      +
      IllegalStateException - if this annotation member value is not a float
      +
      +
      +
    • +
    • +
      +

      asDouble

      +
      double asDouble()
      +
      Returns this value as a double.
      +
      +
      Returns:
      +
      the double value
      +
      Throws:
      +
      IllegalStateException - if this annotation member value is not a double
      +
      +
      +
    • +
    • +
      +

      asChar

      +
      char asChar()
      +
      Returns this value as a char.
      +
      +
      Returns:
      +
      the char value
      +
      Throws:
      +
      IllegalStateException - if this annotation member value is not a char
      +
      +
      +
    • +
    • +
      +

      asString

      +
      String asString()
      +
      Returns this value as a String.
      +
      +
      Returns:
      +
      the String value
      +
      Throws:
      +
      IllegalStateException - if this annotation member value is not a String
      +
      +
      +
    • +
    • +
      +

      asEnum

      +
      <E extends Enum<E>> E asEnum(Class<E> enumType)
      +
      Returns this enum value as an instance of the enum type.
      +
      +
      Type Parameters:
      +
      E - the enum generic type
      +
      Parameters:
      +
      enumType - the enum type
      +
      Returns:
      +
      the enum instance
      +
      Throws:
      +
      IllegalArgumentException - if given enumType is not an enum type
      +
      IllegalStateException - if this annotation member value is not an enum value
      +
      +
      +
    • +
    • +
      +

      asEnumClass

      +
      ClassInfo asEnumClass()
      +
      Returns the type of this enum value.
      +
      +
      Returns:
      +
      a ClassInfo representing the enum type
      +
      Throws:
      +
      IllegalStateException - if this annotation member value is not an enum value
      +
      +
      +
    • +
    • +
      +

      asEnumConstant

      +
      String asEnumConstant()
      +
      Returns the name of this enum value.
      +
      +
      Returns:
      +
      the name of this enum value
      +
      Throws:
      +
      IllegalStateException - if this annotation member value is not an enum value
      +
      +
      +
    • +
    • +
      +

      asType

      +
      Type asType()
      +
      Returns this class value as a Type. It can be: +
        +
      • the void pseudo-type;
      • +
      • a primitive type;
      • +
      • a class type;
      • +
      • an array type, whose element type + is a primitive type or a class type.
      • +
      +
      +
      Returns:
      +
      the class value, as a Type
      +
      Throws:
      +
      IllegalStateException - if this annotation member value is not a class value
      +
      +
      +
    • +
    • +
      +

      asNestedAnnotation

      +
      AnnotationInfo asNestedAnnotation()
      +
      Returns this nested annotation value as an AnnotationInfo.
      +
      +
      Returns:
      +
      an AnnotationInfo instance
      +
      Throws:
      +
      IllegalStateException - if this annotation member value is not a nested annotation
      +
      +
      +
    • +
    • +
      +

      asArray

      + +
      Returns this array value as an immutable List of AnnotationMembers. + Returns an empty list if the array is empty.
      +
      +
      Returns:
      +
      an immutable list of AnnotationMembers
      +
      Throws:
      +
      IllegalStateException - if this annotation member value is not an array
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/lang/model/AnnotationTarget.html b/cdi/4.1/apidocs/jakarta/enterprise/lang/model/AnnotationTarget.html new file mode 100644 index 0000000000..4b2e64dee9 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/lang/model/AnnotationTarget.html @@ -0,0 +1,363 @@ + + + + +AnnotationTarget (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface AnnotationTarget

+
+
+
+
All Known Subinterfaces:
+
ArrayType, ClassInfo, ClassType, DeclarationInfo, FieldInfo, MethodInfo, PackageInfo, ParameterInfo, ParameterizedType, PrimitiveType, RecordComponentInfo, Type, TypeVariable, VoidType, WildcardType
+
+
+
public interface AnnotationTarget
+
An annotation target is anything that can be annotated. + That is: + +
    +
  • a declaration, such as a class, a method, a field, etc.
  • +
  • a type, such as the type of a method parameter, the type of a field, a type argument, + a type parameter, present in a declaration of a generic class or method, etc.
  • +
+ + The hasAnnotation, annotation, repeatableAnnotation and annotations methods + may be used to obtain information about annotations present on this annotation target. The phrase + "present on this annotation target" means: either the annotation is declared or implicitly declared + directly on this annotation target, or this annotation target is a class declaration and the annotation is + inherited from a superclass. +

+ Note that if more than one annotation of a repeatable annotation type + is declared on an annotation target, only an implicitly declared container annotation is present + on the annotation target; the originally declared annotations are not. If exactly one annotation of a repeatable + annotation type is declared on an annotation target, that annotation is present. +

+ Annotations are represented as AnnotationInfo, so that implementations of this interface are not required + to instantiate the annotation type. +

+ Implementations of this interface are required to define the equals and hashCode methods. + Implementations of this interface are encouraged to define the toString method such that + it returns a text resembling the corresponding Java™ syntax. +

+ There is no guarantee that any particular construct, represented by an implementation of this interface, + will always be represented by the same object. That includes natural singletons such as the java.lang.Object + class declaration, or the void pseudo-type. Instances should always be compared using equals.

+
+
Since:
+
4.0
+
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      isDeclaration

      +
      boolean isDeclaration()
      +
      Returns whether this annotation target is a declaration.
      +
      +
      Returns:
      +
      true if this is a declaration, false otherwise
      +
      +
      +
    • +
    • +
      +

      isType

      +
      boolean isType()
      +
      Returns whether this annotation target is a type.
      +
      +
      Returns:
      +
      true if this is a type, false otherwise
      +
      +
      +
    • +
    • +
      +

      asDeclaration

      +
      DeclarationInfo asDeclaration()
      +
      Returns this annotation target as a declaration.
      +
      +
      Returns:
      +
      this declaration, never null
      +
      Throws:
      +
      IllegalStateException - if isDeclaration() returns false
      +
      +
      +
    • +
    • +
      +

      asType

      +
      Type asType()
      +
      Returns this annotation target as a type.
      +
      +
      Returns:
      +
      this type, never null
      +
      Throws:
      +
      IllegalStateException - if isType() returns false
      +
      +
      +
    • +
    • +
      +

      hasAnnotation

      +
      boolean hasAnnotation(Class<? extends Annotation> annotationType)
      +
      Returns whether an annotation of given type is present on this annotation target.
      +
      +
      Parameters:
      +
      annotationType - the annotation type, must not be null
      +
      Returns:
      +
      true if given annotation type is present on this annotation target, false otherwise
      +
      +
      +
    • +
    • +
      +

      hasAnnotation

      +
      boolean hasAnnotation(Predicate<AnnotationInfo> predicate)
      +
      Returns whether given predicate matches any annotation present on this annotation target.
      +
      +
      Parameters:
      +
      predicate - annotation predicate, must not be null
      +
      Returns:
      +
      true if given predicate matches any annotation present on this annotation target, false + otherwise.
      +
      +
      +
    • +
    • +
      +

      annotation

      +
      <T extends Annotation> AnnotationInfo annotation(Class<T> annotationType)
      +
      Returns an annotation of given type, if it is present on this annotation target. + Returns null if no such annotation is present.
      +
      +
      Type Parameters:
      +
      T - the annotation generic type
      +
      Parameters:
      +
      annotationType - the annotation type, must not be null
      +
      Returns:
      +
      the AnnotationInfo or null if no such annotation is present
      +
      +
      +
    • +
    • +
      +

      repeatableAnnotation

      +
      <T extends Annotation> Collection<AnnotationInfo> repeatableAnnotation(Class<T> annotationType)
      +
      Returns a collection of annotations of given repeatable + annotationType that are present on this annotation target. Returns an empty collection if + no such annotation is present. +

      + For the purpose of this method, annotations in the value member of a container annotation, + as defined using @Repeatable, are considered to be present + on the annotation target on which the container annotation is present.

      +
      +
      Type Parameters:
      +
      T - the annotation generic type
      +
      Parameters:
      +
      annotationType - the @Repeatable annotation type, must not be null
      +
      Returns:
      +
      immutable collection of AnnotationInfo, never null
      +
      +
      +
    • +
    • +
      +

      annotations

      + +
      Returns a collection of all annotations present on this annotation target that match given predicate. + Returns an empty collection if no such annotation is present.
      +
      +
      Parameters:
      +
      predicate - annotation predicate, must not be null
      +
      Returns:
      +
      immutable collection of AnnotationInfo, never null
      +
      +
      +
    • +
    • +
      +

      annotations

      +
      Collection<AnnotationInfo> annotations()
      +
      Returns a collection of all annotations present on this annotation target. + Returns an empty collection if no annotation is present.
      +
      +
      Returns:
      +
      immutable collection of AnnotationInfo, never null
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/lang/model/class-use/AnnotationInfo.html b/cdi/4.1/apidocs/jakarta/enterprise/lang/model/class-use/AnnotationInfo.html new file mode 100644 index 0000000000..41833018f2 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/lang/model/class-use/AnnotationInfo.html @@ -0,0 +1,310 @@ + + + + +Uses of Interface jakarta.enterprise.lang.model.AnnotationInfo (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.enterprise.lang.model.AnnotationInfo

+
+
Packages that use AnnotationInfo
+
+
Package
+
Description
+ +
+
+ The build compatible extension SPI.
+
+ +
+
The core interfaces of the language model that represent + annotations and + annotation targets.
+
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/lang/model/class-use/AnnotationMember.Kind.html b/cdi/4.1/apidocs/jakarta/enterprise/lang/model/class-use/AnnotationMember.Kind.html new file mode 100644 index 0000000000..9c31af996c --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/lang/model/class-use/AnnotationMember.Kind.html @@ -0,0 +1,106 @@ + + + + +Uses of Enum Class jakarta.enterprise.lang.model.AnnotationMember.Kind (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Enum Class
jakarta.enterprise.lang.model.AnnotationMember.Kind

+
+
Packages that use AnnotationMember.Kind
+
+
Package
+
Description
+ +
+
The core interfaces of the language model that represent + annotations and + annotation targets.
+
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/lang/model/class-use/AnnotationMember.html b/cdi/4.1/apidocs/jakarta/enterprise/lang/model/class-use/AnnotationMember.html new file mode 100644 index 0000000000..c06657b94a --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/lang/model/class-use/AnnotationMember.html @@ -0,0 +1,144 @@ + + + + +Uses of Interface jakarta.enterprise.lang.model.AnnotationMember (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.enterprise.lang.model.AnnotationMember

+
+
Packages that use AnnotationMember
+
+
Package
+
Description
+ +
+
+ The build compatible extension SPI.
+
+ +
+
The core interfaces of the language model that represent + annotations and + annotation targets.
+
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/lang/model/class-use/AnnotationTarget.html b/cdi/4.1/apidocs/jakarta/enterprise/lang/model/class-use/AnnotationTarget.html new file mode 100644 index 0000000000..ebe206f969 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/lang/model/class-use/AnnotationTarget.html @@ -0,0 +1,227 @@ + + + + +Uses of Interface jakarta.enterprise.lang.model.AnnotationTarget (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.enterprise.lang.model.AnnotationTarget

+
+
Packages that use AnnotationTarget
+
+
Package
+
Description
+ +
+
+ The build compatible extension SPI.
+
+ +
+
Interfaces that represent declarations.
+
+ +
+
Interfaces that represent types.
+
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/lang/model/declarations/ClassInfo.html b/cdi/4.1/apidocs/jakarta/enterprise/lang/model/declarations/ClassInfo.html new file mode 100644 index 0000000000..ff0aaa7fc6 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/lang/model/declarations/ClassInfo.html @@ -0,0 +1,585 @@ + + + + +ClassInfo (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface ClassInfo

+
+
+
+
All Superinterfaces:
+
AnnotationTarget, DeclarationInfo
+
+
+
public interface ClassInfo +extends DeclarationInfo
+
A class. Five kinds of classes are distinguished: +
    +
  • plain classes
  • +
  • interfaces
  • +
  • enums (restricted kind of classes)
  • +
  • annotations (specialized kind of interfaces)
  • +
  • records (restricted kind of classes)
  • +
+ + Classes are represented as isolated units. That is, if this class is nested, it is not possible + to obtain the enclosing class. Similarly, it is not possible to obtain the set of classes + nested in this class. +

+ At the same time, it is possible to obtain the set of constructors, + methods and fields declared in this class, as well + as the set of record components if this class is a record. + It is also possible to obtain the package this class is declared in.

+
+
Since:
+
4.0
+
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      name

      +
      String name()
      +
      Returns the binary name of this class, as defined by The Java™ Language Specification; + in other words, the class name as returned by Class.getName().
      +
      +
      Returns:
      +
      binary name of this class, never null
      +
      +
      +
    • +
    • +
      +

      simpleName

      +
      String simpleName()
      +
      Returns the simple name of this class, as defined by The Java™ Language Specification; + in other words, the class name as returned by Class.getSimpleName().
      +
      +
      Returns:
      +
      simple name of this class, never null
      +
      +
      +
    • +
    • +
      +

      packageInfo

      +
      PackageInfo packageInfo()
      +
      Returns the package this class is part of. + Returns null if this class is part of an unnamed package.
      +
      +
      Returns:
      +
      this class's package, or null if this class is in an unnamed package
      +
      +
      +
    • +
    • +
      +

      typeParameters

      +
      List<TypeVariable> typeParameters()
      +
      Returns a list of type parameters declared on this class. + Returns an empty list if this class is not generic and so does not declare type parameters.
      +
      +
      Returns:
      +
      immutable list of this class's type parameters, never null
      +
      +
      +
    • +
    • +
      +

      superClass

      +
      Type superClass()
      +
      Returns the direct superclass type of this class. Returns null if this class + does not have a superclass; that is, if this class is java.lang.Object or an interface.
      +
      +
      Returns:
      +
      the direct superclass type of this class, or null if there's no superclass
      +
      +
      +
    • +
    • +
      +

      superClassDeclaration

      +
      ClassInfo superClassDeclaration()
      +
      Returns the direct superclass of this class. Returns null if this class + does not have a superclass; that is, if this class is java.lang.Object or an interface.
      +
      +
      Returns:
      +
      the direct superclass of this class, or null if there's no superclass
      +
      +
      +
    • +
    • +
      +

      superInterfaces

      +
      List<Type> superInterfaces()
      +
      Returns a list of direct superinterface types of this class. + Returns an empty list if this class has no direct superinterface.
      +
      +
      Returns:
      +
      immutable list of direct superinterface types of this class, never null
      +
      +
      +
    • +
    • +
      +

      superInterfacesDeclarations

      +
      List<ClassInfo> superInterfacesDeclarations()
      +
      Returns a list of direct superinterfaces of this class. + Returns an empty list if this class has no direct superinterface.
      +
      +
      Returns:
      +
      immutable list of direct superinterfaces of this class, never null
      +
      +
      +
    • +
    • +
      +

      isPlainClass

      +
      boolean isPlainClass()
      +
      Returns whether this class is a plain class. That is, not an interface, + not an enum, not an annotation, and not a record.
      +
      +
      Returns:
      +
      whether this class is a plain class
      +
      +
      +
    • +
    • +
      +

      isInterface

      +
      boolean isInterface()
      +
      Returns whether this class is an interface. + If this class is an annotation, returns false.
      +
      +
      Returns:
      +
      whether this class is an interface
      +
      +
      +
    • +
    • +
      +

      isEnum

      +
      boolean isEnum()
      +
      Returns whether this class is an enum.
      +
      +
      Returns:
      +
      whether this class is an enum
      +
      +
      +
    • +
    • +
      +

      isAnnotation

      +
      boolean isAnnotation()
      +
      Returns whether this class is an annotation.
      +
      +
      Returns:
      +
      whether this class is an annotation
      +
      +
      +
    • +
    • +
      +

      isRecord

      +
      boolean isRecord()
      +
      Returns whether this class is a record.
      +
      +
      Returns:
      +
      whether this class is a record
      +
      +
      +
    • +
    • +
      +

      isAbstract

      +
      boolean isAbstract()
      +
      Returns whether this class is abstract. +

      + A plain class is abstract if declared abstract. + An enum is abstract if it declares abstract methods. + An interface or an annotation is always abstract. + A record is never abstract.

      +
      +
      Returns:
      +
      whether this class is abstract
      +
      +
      +
    • +
    • +
      +

      isFinal

      +
      boolean isFinal()
      +
      Returns whether this class is final.
      +
      +
      Returns:
      +
      whether this class is final
      +
      +
      +
    • +
    • +
      +

      modifiers

      +
      int modifiers()
      +
      Returns the modifiers of this class as an int. + Use Modifier to inspect the value.
      +
      +
      Returns:
      +
      the modifiers of this class
      +
      +
      +
    • +
    • +
      +

      constructors

      +
      Collection<MethodInfo> constructors()
      +
      Returns a collection of constructors declared or implicitly declared + in this class. Constructors declared in direct or indirect superclasses are not included. +

      + If this class is an interface or an annotation, returns an empty collection.

      +
      +
      Returns:
      +
      immutable collection of constructors, never null
      +
      +
      +
    • +
    • +
      +

      methods

      + +
      Returns a collection of methods declared or implicitly declared + in this class and all its superclasses up to and excluding java.lang.Object, + as well as all direct and indirect superinterfaces. If this class is java.lang.Object, + its methods are not excluded. If this class is an interface, only superinterfaces + are considered. Implicitly declared methods corresponding to java.lang.Object + methods in interfaces are omitted. +

      + If the collection of methods described above contains multiple methods with the same signature, + all such methods are returned. MethodInfo.declaringClass + should be used to distinguish such methods. +

      + Iteration order of the resulting collection is not defined and does not have to correspond + to the inheritance hierarchy of this class.

      +
      +
      Returns:
      +
      immutable collection of methods, never null
      +
      +
      +
    • +
    • +
      +

      fields

      + +
      Returns a collection of fields declared or implicitly declared + in this class and all its superclasses up to and excluding java.lang.Object, + as well as all direct and indirect superinterfaces. If this class is java.lang.Object, + its fields are not excluded. If this class is an interface, only superinterfaces + are considered. +

      + If the collection of fields described above contains multiple fields with the same name, + all such fields are returned. FieldInfo.declaringClass + should be used to distinguish such fields +

      + Iteration order of the resulting collection is not defined and does not have to correspond + to the inheritance hierarchy of this class.

      +
      +
      Returns:
      +
      immutable collection of fields, never null
      +
      +
      +
    • +
    • +
      +

      recordComponents

      +
      Collection<RecordComponentInfo> recordComponents()
      +
      Returns a collection of record components declared in this class. + If this class is not a record, returns an empty collection.
      +
      +
      Returns:
      +
      immutable collection of record components, never nul
      +
      +
      +
    • +
    • +
      +

      kind

      +
      default DeclarationInfo.Kind kind()
      +
      Description copied from interface: DeclarationInfo
      +
      Returns the kind of this declaration.
      +
      +
      Specified by:
      +
      kind in interface DeclarationInfo
      +
      Returns:
      +
      the kind of this declaration
      +
      +
      +
    • +
    • +
      +

      asClass

      +
      default ClassInfo asClass()
      +
      Description copied from interface: DeclarationInfo
      +
      Returns this declaration as a class.
      +
      +
      Specified by:
      +
      asClass in interface DeclarationInfo
      +
      Returns:
      +
      this class, never null
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/lang/model/declarations/DeclarationInfo.Kind.html b/cdi/4.1/apidocs/jakarta/enterprise/lang/model/declarations/DeclarationInfo.Kind.html new file mode 100644 index 0000000000..635304bef9 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/lang/model/declarations/DeclarationInfo.Kind.html @@ -0,0 +1,293 @@ + + + + +DeclarationInfo.Kind (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Enum Class DeclarationInfo.Kind

+
+
java.lang.Object +
java.lang.Enum<DeclarationInfo.Kind> +
jakarta.enterprise.lang.model.declarations.DeclarationInfo.Kind
+
+
+
+
+
All Implemented Interfaces:
+
Serializable, Comparable<DeclarationInfo.Kind>, Constable
+
+
+
Enclosing interface:
+
DeclarationInfo
+
+
+
public static enum DeclarationInfo.Kind +extends Enum<DeclarationInfo.Kind>
+
The declaration kind: package, class, method, parameter, field, record component.
+
+
+ +
+
+
    + +
  • +
    +

    Enum Constant Details

    + +
    +
  • + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      values

      +
      public static DeclarationInfo.Kind[] values()
      +
      Returns an array containing the constants of this enum class, in +the order they are declared.
      +
      +
      Returns:
      +
      an array containing the constants of this enum class, in the order they are declared
      +
      +
      +
    • +
    • +
      +

      valueOf

      +
      public static DeclarationInfo.Kind valueOf(String name)
      +
      Returns the enum constant of this class with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this class. (Extraneous whitespace characters are +not permitted.)
      +
      +
      Parameters:
      +
      name - the name of the enum constant to be returned.
      +
      Returns:
      +
      the enum constant with the specified name
      +
      Throws:
      +
      IllegalArgumentException - if this enum class has no constant with the specified name
      +
      NullPointerException - if the argument is null
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/lang/model/declarations/DeclarationInfo.html b/cdi/4.1/apidocs/jakarta/enterprise/lang/model/declarations/DeclarationInfo.html new file mode 100644 index 0000000000..ea024dbd48 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/lang/model/declarations/DeclarationInfo.html @@ -0,0 +1,476 @@ + + + + +DeclarationInfo (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface DeclarationInfo

+
+
+
+
All Superinterfaces:
+
AnnotationTarget
+
+
+
All Known Subinterfaces:
+
ClassInfo, FieldInfo, MethodInfo, PackageInfo, ParameterInfo, RecordComponentInfo
+
+
+
public interface DeclarationInfo +extends AnnotationTarget
+
A declaration is an element of a program source code. + Declarations are: + +
+
+
Since:
+
4.0
+
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      isDeclaration

      +
      default boolean isDeclaration()
      +
      Description copied from interface: AnnotationTarget
      +
      Returns whether this annotation target is a declaration.
      +
      +
      Specified by:
      +
      isDeclaration in interface AnnotationTarget
      +
      Returns:
      +
      true if this is a declaration, false otherwise
      +
      +
      +
    • +
    • +
      +

      isType

      +
      default boolean isType()
      +
      Description copied from interface: AnnotationTarget
      +
      Returns whether this annotation target is a type.
      +
      +
      Specified by:
      +
      isType in interface AnnotationTarget
      +
      Returns:
      +
      true if this is a type, false otherwise
      +
      +
      +
    • +
    • +
      +

      asDeclaration

      +
      default DeclarationInfo asDeclaration()
      +
      Description copied from interface: AnnotationTarget
      +
      Returns this annotation target as a declaration.
      +
      +
      Specified by:
      +
      asDeclaration in interface AnnotationTarget
      +
      Returns:
      +
      this declaration, never null
      +
      +
      +
    • +
    • +
      +

      asType

      +
      default Type asType()
      +
      Description copied from interface: AnnotationTarget
      +
      Returns this annotation target as a type.
      +
      +
      Specified by:
      +
      asType in interface AnnotationTarget
      +
      Returns:
      +
      this type, never null
      +
      +
      +
    • +
    • +
      +

      kind

      + +
      Returns the kind of this declaration.
      +
      +
      Returns:
      +
      the kind of this declaration
      +
      +
      +
    • +
    • +
      +

      isPackage

      +
      default boolean isPackage()
      +
      Returns whether this declaration is a package.
      +
      +
      Returns:
      +
      true if this is a package, false otherwise
      +
      +
      +
    • +
    • +
      +

      isClass

      +
      default boolean isClass()
      +
      Returns whether this declaration is a class.
      +
      +
      Returns:
      +
      true if this is a class, false otherwise
      +
      +
      +
    • +
    • +
      +

      isMethod

      +
      default boolean isMethod()
      +
      Returns whether this declaration is a method.
      +
      +
      Returns:
      +
      true if this is a method, false otherwise
      +
      +
      +
    • +
    • +
      +

      isParameter

      +
      default boolean isParameter()
      +
      Returns whether this declaration is a method parameter.
      +
      +
      Returns:
      +
      true if this is a parameter, false otherwise
      +
      +
      +
    • +
    • +
      +

      isField

      +
      default boolean isField()
      +
      Returns whether this declaration is a field.
      +
      +
      Returns:
      +
      true if this is a field, false otherwise
      +
      +
      +
    • +
    • +
      +

      isRecordComponent

      +
      default boolean isRecordComponent()
      +
      Returns whether this declaration is a record component.
      +
      +
      Returns:
      +
      true if this is a record component, false otherwise
      +
      +
      +
    • +
    • +
      +

      asPackage

      +
      default PackageInfo asPackage()
      +
      Returns this declaration as a package.
      +
      +
      Returns:
      +
      this package, never null
      +
      Throws:
      +
      IllegalStateException - if isPackage() returns false
      +
      +
      +
    • +
    • +
      +

      asClass

      +
      default ClassInfo asClass()
      +
      Returns this declaration as a class.
      +
      +
      Returns:
      +
      this class, never null
      +
      Throws:
      +
      IllegalStateException - if isClass() returns false
      +
      +
      +
    • +
    • +
      +

      asMethod

      +
      default MethodInfo asMethod()
      +
      Returns this declaration as a method.
      +
      +
      Returns:
      +
      this method, never null
      +
      Throws:
      +
      IllegalStateException - if isMethod() returns false
      +
      +
      +
    • +
    • +
      +

      asParameter

      +
      default ParameterInfo asParameter()
      +
      Returns this declaration as a method parameter.
      +
      +
      Returns:
      +
      this parameter, never null
      +
      Throws:
      +
      IllegalStateException - if isParameter() returns false
      +
      +
      +
    • +
    • +
      +

      asField

      +
      default FieldInfo asField()
      +
      Returns this declaration as a field.
      +
      +
      Returns:
      +
      this field, never null
      +
      Throws:
      +
      IllegalStateException - if isField() returns false
      +
      +
      +
    • +
    • +
      +

      asRecordComponent

      +
      default RecordComponentInfo asRecordComponent()
      +
      Returns this declaration as a record component.
      +
      +
      Returns:
      +
      this record component, never null
      +
      Throws:
      +
      IllegalStateException - if isRecordComponent() returns false
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/lang/model/declarations/FieldInfo.html b/cdi/4.1/apidocs/jakarta/enterprise/lang/model/declarations/FieldInfo.html new file mode 100644 index 0000000000..c28290dbb9 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/lang/model/declarations/FieldInfo.html @@ -0,0 +1,296 @@ + + + + +FieldInfo (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface FieldInfo

+
+
+
+
All Superinterfaces:
+
AnnotationTarget, DeclarationInfo
+
+
+
public interface FieldInfo +extends DeclarationInfo
+
A field, declared in some class.
+
+
Since:
+
4.0
+
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      name

      +
      String name()
      +
      Returns the name of this field.
      +
      +
      Returns:
      +
      the name of this field, never null
      +
      +
      +
    • +
    • +
      +

      type

      +
      Type type()
      +
      Returns the type of this field.
      +
      +
      Returns:
      +
      the type of this field, never null
      +
      +
      +
    • +
    • +
      +

      isStatic

      +
      boolean isStatic()
      +
      Returns whether this field is static.
      +
      +
      Returns:
      +
      whether this field is static.
      +
      +
      +
    • +
    • +
      +

      isFinal

      +
      boolean isFinal()
      +
      Returns whether this field is final.
      +
      +
      Returns:
      +
      whether this field is final.
      +
      +
      +
    • +
    • +
      +

      modifiers

      +
      int modifiers()
      +
      Returns the modifiers of this field as an int. + Use Modifier to inspect the value.
      +
      +
      Returns:
      +
      the modifiers of this field
      +
      +
      +
    • +
    • +
      +

      declaringClass

      +
      ClassInfo declaringClass()
      +
      Returns the class that declares this field.
      +
      +
      Returns:
      +
      the class that declares this field, never null
      +
      +
      +
    • +
    • +
      +

      kind

      +
      default DeclarationInfo.Kind kind()
      +
      Description copied from interface: DeclarationInfo
      +
      Returns the kind of this declaration.
      +
      +
      Specified by:
      +
      kind in interface DeclarationInfo
      +
      Returns:
      +
      the kind of this declaration
      +
      +
      +
    • +
    • +
      +

      asField

      +
      default FieldInfo asField()
      +
      Description copied from interface: DeclarationInfo
      +
      Returns this declaration as a field.
      +
      +
      Specified by:
      +
      asField in interface DeclarationInfo
      +
      Returns:
      +
      this field, never null
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/lang/model/declarations/MethodInfo.html b/cdi/4.1/apidocs/jakarta/enterprise/lang/model/declarations/MethodInfo.html new file mode 100644 index 0000000000..76a4977abc --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/lang/model/declarations/MethodInfo.html @@ -0,0 +1,404 @@ + + + + +MethodInfo (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface MethodInfo

+
+
+
+
All Superinterfaces:
+
AnnotationTarget, DeclarationInfo
+
+
+
public interface MethodInfo +extends DeclarationInfo
+
A method or a constructor, declared in some class.
+
+
Since:
+
4.0
+
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      name

      +
      String name()
      +
      Returns the name of this method. In case of constructors, returns the binary name of the declaring class.
      +
      +
      Returns:
      +
      the name of this method, never null
      +
      +
      +
    • +
    • +
      +

      parameters

      +
      List<ParameterInfo> parameters()
      +
      Returns a list of parameters declared or implicitly declared on this method.
      +
      +
      Returns:
      +
      immutable list of parameters, never null
      +
      +
      +
    • +
    • +
      +

      returnType

      +
      Type returnType()
      +
      Returns the return type of this method. In case of constructors, returns the type of the declaring class.
      +
      +
      Returns:
      +
      the return type of this method, never null
      +
      +
      +
    • +
    • +
      +

      receiverType

      +
      Type receiverType()
      +
      Returns the type of the receiver parameter declared by this method. + Returns null if this method cannot declare a receiver parameter; that is, if this method + is static or is a constructor of a top-level class or a static nested class. + If this method may declare a receiver parameter but does not, returns a Type with no annotations.
      +
      +
      Returns:
      +
      the type of the receiver parameter declared by this method, with or without annotations, + or null if this method cannot declare a receiver parameter
      +
      +
      +
    • +
    • +
      +

      throwsTypes

      +
      List<Type> throwsTypes()
      +
      Returns a list of exception types that are declared to be thrown by this method. + Returns an empty list if this method does not declare any exception.
      +
      +
      Returns:
      +
      immutable list of exception types, never null
      +
      +
      +
    • +
    • +
      +

      typeParameters

      +
      List<TypeVariable> typeParameters()
      +
      Returns a list of type parameters declared on this method. + Returns an empty list if this method is not generic and so does not declare type parameters.
      +
      +
      Returns:
      +
      immutable list of type parameters, never null
      +
      +
      +
    • +
    • +
      +

      isConstructor

      +
      boolean isConstructor()
      +
      Returns whether this method is, in fact, a constructor.
      +
      +
      Returns:
      +
      whether this method is, in fact, a constructor
      +
      +
      +
    • +
    • +
      +

      isStatic

      +
      boolean isStatic()
      +
      Returns whether this method is static.
      +
      +
      Returns:
      +
      whether this method is static.
      +
      +
      +
    • +
    • +
      +

      isAbstract

      +
      boolean isAbstract()
      +
      Returns whether this method is abstract. +

      + A static method is never abstract. + An instance method declared on a plain class or an enum is abstract if declared abstract. + An instance method declared on an interface is abstract unless declared default. + An instance method declared on an annotation type is always abstract. + An instance method declared on a record type is never abstract.

      +
      +
      Returns:
      +
      whether this method is abstract.
      +
      +
      +
    • +
    • +
      +

      isFinal

      +
      boolean isFinal()
      +
      Returns whether this method is final.
      +
      +
      Returns:
      +
      whether this method is final.
      +
      +
      +
    • +
    • +
      +

      modifiers

      +
      int modifiers()
      +
      Returns the modifiers of this method as an int. + Use Modifier to inspect the value.
      +
      +
      Returns:
      +
      the modifiers of this method
      +
      +
      +
    • +
    • +
      +

      declaringClass

      +
      ClassInfo declaringClass()
      +
      Returns the class that declares this method.
      +
      +
      Returns:
      +
      the class that declares this method, never null
      +
      +
      +
    • +
    • +
      +

      kind

      +
      default DeclarationInfo.Kind kind()
      +
      Description copied from interface: DeclarationInfo
      +
      Returns the kind of this declaration.
      +
      +
      Specified by:
      +
      kind in interface DeclarationInfo
      +
      Returns:
      +
      the kind of this declaration
      +
      +
      +
    • +
    • +
      +

      asMethod

      +
      default MethodInfo asMethod()
      +
      Description copied from interface: DeclarationInfo
      +
      Returns this declaration as a method.
      +
      +
      Specified by:
      +
      asMethod in interface DeclarationInfo
      +
      Returns:
      +
      this method, never null
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/lang/model/declarations/PackageInfo.html b/cdi/4.1/apidocs/jakarta/enterprise/lang/model/declarations/PackageInfo.html new file mode 100644 index 0000000000..91fcfb8950 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/lang/model/declarations/PackageInfo.html @@ -0,0 +1,218 @@ + + + + +PackageInfo (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface PackageInfo

+
+
+
+
All Superinterfaces:
+
AnnotationTarget, DeclarationInfo
+
+
+
public interface PackageInfo +extends DeclarationInfo
+
A package, possibly annotated in package-info.java. + Obtaining the set of members present in this package is not possible.
+
+
Since:
+
4.0
+
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      name

      +
      String name()
      +
      Returns the fully qualified name of this package, as defined by The Java™ Language Specification; + in other words, the package name as returned by Package.getName().
      +
      +
      Returns:
      +
      fully qualified name of this package, never null
      +
      +
      +
    • +
    • +
      +

      kind

      +
      default DeclarationInfo.Kind kind()
      +
      Description copied from interface: DeclarationInfo
      +
      Returns the kind of this declaration.
      +
      +
      Specified by:
      +
      kind in interface DeclarationInfo
      +
      Returns:
      +
      the kind of this declaration
      +
      +
      +
    • +
    • +
      +

      asPackage

      +
      default PackageInfo asPackage()
      +
      Description copied from interface: DeclarationInfo
      +
      Returns this declaration as a package.
      +
      +
      Specified by:
      +
      asPackage in interface DeclarationInfo
      +
      Returns:
      +
      this package, never null
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/lang/model/declarations/ParameterInfo.html b/cdi/4.1/apidocs/jakarta/enterprise/lang/model/declarations/ParameterInfo.html new file mode 100644 index 0000000000..5318b8efba --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/lang/model/declarations/ParameterInfo.html @@ -0,0 +1,250 @@ + + + + +ParameterInfo (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface ParameterInfo

+
+
+
+
All Superinterfaces:
+
AnnotationTarget, DeclarationInfo
+
+
+
public interface ParameterInfo +extends DeclarationInfo
+
A method parameter or a constructor parameter, declared in some method + or constructor.
+
+
Since:
+
4.0
+
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      name

      +
      String name()
      +
      Returns the name of this parameter, if it is known. Method parameter names may not always be known, + in which case a synthetic name of the form argN, where N is zero-based parameter position + in the method declaration, is returned.
      +
      +
      Returns:
      +
      the name of this parameter, or a synthetic name, never null
      +
      +
      +
    • +
    • +
      +

      type

      +
      Type type()
      +
      Returns the type of this parameter.
      +
      +
      Returns:
      +
      the type of this parameter, never null
      +
      +
      +
    • +
    • +
      +

      declaringMethod

      +
      MethodInfo declaringMethod()
      +
      Returns the method that declares this parameter.
      +
      +
      Returns:
      +
      the method that declares this parameter, never null
      +
      +
      +
    • +
    • +
      +

      kind

      +
      default DeclarationInfo.Kind kind()
      +
      Description copied from interface: DeclarationInfo
      +
      Returns the kind of this declaration.
      +
      +
      Specified by:
      +
      kind in interface DeclarationInfo
      +
      Returns:
      +
      the kind of this declaration
      +
      +
      +
    • +
    • +
      +

      asParameter

      +
      default ParameterInfo asParameter()
      +
      Description copied from interface: DeclarationInfo
      +
      Returns this declaration as a method parameter.
      +
      +
      Specified by:
      +
      asParameter in interface DeclarationInfo
      +
      Returns:
      +
      this parameter, never null
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/lang/model/declarations/RecordComponentInfo.html b/cdi/4.1/apidocs/jakarta/enterprise/lang/model/declarations/RecordComponentInfo.html new file mode 100644 index 0000000000..5c82382121 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/lang/model/declarations/RecordComponentInfo.html @@ -0,0 +1,279 @@ + + + + +RecordComponentInfo (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface RecordComponentInfo

+
+
+
+
All Superinterfaces:
+
AnnotationTarget, DeclarationInfo
+
+
+
public interface RecordComponentInfo +extends DeclarationInfo
+
A record component, declared in some record.
+
+
Since:
+
4.0
+
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      name

      +
      String name()
      +
      Returns the name of this record component.
      +
      +
      Returns:
      +
      the name of this record component, never null
      +
      +
      +
    • +
    • +
      +

      type

      +
      Type type()
      +
      Returns the type of this record component.
      +
      +
      Returns:
      +
      the type of this record component, never null
      +
      +
      +
    • +
    • +
      +

      field

      +
      FieldInfo field()
      +
      Returns the field corresponding to this record component.
      +
      +
      Returns:
      +
      the field, never null
      +
      +
      +
    • +
    • +
      +

      accessor

      +
      MethodInfo accessor()
      +
      Returns the accessor method corresponding to this record component.
      +
      +
      Returns:
      +
      the accessor method, never null
      +
      +
      +
    • +
    • +
      +

      declaringRecord

      +
      ClassInfo declaringRecord()
      +
      Returns the record that declares this component.
      +
      +
      Returns:
      +
      the record that declares this component, never null
      +
      +
      +
    • +
    • +
      +

      kind

      +
      default DeclarationInfo.Kind kind()
      +
      Description copied from interface: DeclarationInfo
      +
      Returns the kind of this declaration.
      +
      +
      Specified by:
      +
      kind in interface DeclarationInfo
      +
      Returns:
      +
      the kind of this declaration
      +
      +
      +
    • +
    • +
      +

      asRecordComponent

      +
      default RecordComponentInfo asRecordComponent()
      +
      Description copied from interface: DeclarationInfo
      +
      Returns this declaration as a record component.
      +
      +
      Specified by:
      +
      asRecordComponent in interface DeclarationInfo
      +
      Returns:
      +
      this record component, never null
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/lang/model/declarations/class-use/ClassInfo.html b/cdi/4.1/apidocs/jakarta/enterprise/lang/model/declarations/class-use/ClassInfo.html new file mode 100644 index 0000000000..ce246346e0 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/lang/model/declarations/class-use/ClassInfo.html @@ -0,0 +1,324 @@ + + + + +Uses of Interface jakarta.enterprise.lang.model.declarations.ClassInfo (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.enterprise.lang.model.declarations.ClassInfo

+
+
Packages that use ClassInfo
+
+
Package
+
Description
+ +
+
+ The build compatible extension SPI.
+
+ +
+
The core interfaces of the language model that represent + annotations and + annotation targets.
+
+ +
+
Interfaces that represent declarations.
+
+ +
+
Interfaces that represent types.
+
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/lang/model/declarations/class-use/DeclarationInfo.Kind.html b/cdi/4.1/apidocs/jakarta/enterprise/lang/model/declarations/class-use/DeclarationInfo.Kind.html new file mode 100644 index 0000000000..981b767ad2 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/lang/model/declarations/class-use/DeclarationInfo.Kind.html @@ -0,0 +1,122 @@ + + + + +Uses of Enum Class jakarta.enterprise.lang.model.declarations.DeclarationInfo.Kind (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Enum Class
jakarta.enterprise.lang.model.declarations.DeclarationInfo.Kind

+
+
Packages that use DeclarationInfo.Kind
+
+
Package
+
Description
+ +
+
Interfaces that represent declarations.
+
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/lang/model/declarations/class-use/DeclarationInfo.html b/cdi/4.1/apidocs/jakarta/enterprise/lang/model/declarations/class-use/DeclarationInfo.html new file mode 100644 index 0000000000..1aae1eaca2 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/lang/model/declarations/class-use/DeclarationInfo.html @@ -0,0 +1,194 @@ + + + + +Uses of Interface jakarta.enterprise.lang.model.declarations.DeclarationInfo (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.enterprise.lang.model.declarations.DeclarationInfo

+
+
Packages that use DeclarationInfo
+
+
Package
+
Description
+ +
+
+ The build compatible extension SPI.
+
+ +
+
The core interfaces of the language model that represent + annotations and + annotation targets.
+
+ +
+
Interfaces that represent declarations.
+
+ +
+
Interfaces that represent types.
+
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/lang/model/declarations/class-use/FieldInfo.html b/cdi/4.1/apidocs/jakarta/enterprise/lang/model/declarations/class-use/FieldInfo.html new file mode 100644 index 0000000000..aa1af99b24 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/lang/model/declarations/class-use/FieldInfo.html @@ -0,0 +1,140 @@ + + + + +Uses of Interface jakarta.enterprise.lang.model.declarations.FieldInfo (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.enterprise.lang.model.declarations.FieldInfo

+
+
Packages that use FieldInfo
+
+
Package
+
Description
+ +
+
+ The build compatible extension SPI.
+
+ +
+
Interfaces that represent declarations.
+
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/lang/model/declarations/class-use/MethodInfo.html b/cdi/4.1/apidocs/jakarta/enterprise/lang/model/declarations/class-use/MethodInfo.html new file mode 100644 index 0000000000..bc36fd428a --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/lang/model/declarations/class-use/MethodInfo.html @@ -0,0 +1,173 @@ + + + + +Uses of Interface jakarta.enterprise.lang.model.declarations.MethodInfo (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.enterprise.lang.model.declarations.MethodInfo

+
+
Packages that use MethodInfo
+
+
Package
+
Description
+ +
+
+ The build compatible extension SPI.
+
+ +
+
Interfaces that represent declarations.
+
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/lang/model/declarations/class-use/PackageInfo.html b/cdi/4.1/apidocs/jakarta/enterprise/lang/model/declarations/class-use/PackageInfo.html new file mode 100644 index 0000000000..2946a46a90 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/lang/model/declarations/class-use/PackageInfo.html @@ -0,0 +1,101 @@ + + + + +Uses of Interface jakarta.enterprise.lang.model.declarations.PackageInfo (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.enterprise.lang.model.declarations.PackageInfo

+
+
Packages that use PackageInfo
+
+
Package
+
Description
+ +
+
Interfaces that represent declarations.
+
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/lang/model/declarations/class-use/ParameterInfo.html b/cdi/4.1/apidocs/jakarta/enterprise/lang/model/declarations/class-use/ParameterInfo.html new file mode 100644 index 0000000000..d6baba34c0 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/lang/model/declarations/class-use/ParameterInfo.html @@ -0,0 +1,138 @@ + + + + +Uses of Interface jakarta.enterprise.lang.model.declarations.ParameterInfo (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.enterprise.lang.model.declarations.ParameterInfo

+
+
Packages that use ParameterInfo
+
+
Package
+
Description
+ +
+
+ The build compatible extension SPI.
+
+ +
+
Interfaces that represent declarations.
+
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/lang/model/declarations/class-use/RecordComponentInfo.html b/cdi/4.1/apidocs/jakarta/enterprise/lang/model/declarations/class-use/RecordComponentInfo.html new file mode 100644 index 0000000000..b2acd611b5 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/lang/model/declarations/class-use/RecordComponentInfo.html @@ -0,0 +1,107 @@ + + + + +Uses of Interface jakarta.enterprise.lang.model.declarations.RecordComponentInfo (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.enterprise.lang.model.declarations.RecordComponentInfo

+
+
Packages that use RecordComponentInfo
+
+
Package
+
Description
+ +
+
Interfaces that represent declarations.
+
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/lang/model/declarations/package-summary.html b/cdi/4.1/apidocs/jakarta/enterprise/lang/model/declarations/package-summary.html new file mode 100644 index 0000000000..41d9753839 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/lang/model/declarations/package-summary.html @@ -0,0 +1,153 @@ + + + + +jakarta.enterprise.lang.model.declarations (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Package jakarta.enterprise.lang.model.declarations

+
+
+
package jakarta.enterprise.lang.model.declarations
+
+
Interfaces that represent declarations.
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/lang/model/declarations/package-tree.html b/cdi/4.1/apidocs/jakarta/enterprise/lang/model/declarations/package-tree.html new file mode 100644 index 0000000000..c633d30c90 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/lang/model/declarations/package-tree.html @@ -0,0 +1,101 @@ + + + + +jakarta.enterprise.lang.model.declarations Class Hierarchy (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Hierarchy For Package jakarta.enterprise.lang.model.declarations

+
+Package Hierarchies: + +
+

Interface Hierarchy

+ +
+
+

Enum Class Hierarchy

+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/lang/model/declarations/package-use.html b/cdi/4.1/apidocs/jakarta/enterprise/lang/model/declarations/package-use.html new file mode 100644 index 0000000000..edbcd02811 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/lang/model/declarations/package-use.html @@ -0,0 +1,198 @@ + + + + +Uses of Package jakarta.enterprise.lang.model.declarations (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Package
jakarta.enterprise.lang.model.declarations

+
+ +
+
Package
+
Description
+ +
+
+ The build compatible extension SPI.
+
+ +
+
The core interfaces of the language model that represent + annotations and + annotation targets.
+
+ +
+
Interfaces that represent declarations.
+
+ +
+
Interfaces that represent types.
+
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/lang/model/package-summary.html b/cdi/4.1/apidocs/jakarta/enterprise/lang/model/package-summary.html new file mode 100644 index 0000000000..38e828e146 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/lang/model/package-summary.html @@ -0,0 +1,136 @@ + + + + +jakarta.enterprise.lang.model (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Package jakarta.enterprise.lang.model

+
+
+
package jakarta.enterprise.lang.model
+
+
The core interfaces of the language model that represent + annotations and + annotation targets.
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/lang/model/package-tree.html b/cdi/4.1/apidocs/jakarta/enterprise/lang/model/package-tree.html new file mode 100644 index 0000000000..7b6e7671b4 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/lang/model/package-tree.html @@ -0,0 +1,90 @@ + + + + +jakarta.enterprise.lang.model Class Hierarchy (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Hierarchy For Package jakarta.enterprise.lang.model

+
+Package Hierarchies: + +
+

Interface Hierarchy

+ +
+
+

Enum Class Hierarchy

+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/lang/model/package-use.html b/cdi/4.1/apidocs/jakarta/enterprise/lang/model/package-use.html new file mode 100644 index 0000000000..343c11cbd8 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/lang/model/package-use.html @@ -0,0 +1,160 @@ + + + + +Uses of Package jakarta.enterprise.lang.model (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Package
jakarta.enterprise.lang.model

+
+ +
+
Package
+
Description
+ +
+
+ The build compatible extension SPI.
+
+ +
+
The core interfaces of the language model that represent + annotations and + annotation targets.
+
+ +
+
Interfaces that represent declarations.
+
+ +
+
Interfaces that represent types.
+
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/lang/model/types/ArrayType.html b/cdi/4.1/apidocs/jakarta/enterprise/lang/model/types/ArrayType.html new file mode 100644 index 0000000000..5330121735 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/lang/model/types/ArrayType.html @@ -0,0 +1,230 @@ + + + + +ArrayType (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface ArrayType

+
+
+
+
All Superinterfaces:
+
AnnotationTarget, Type
+
+
+
public interface ArrayType +extends Type
+
An array type is created from a component type. + For a component type T, the array type is written T[]. + A component type may itself be an array type. For a component type T[], + the array type is written T[][]. Such array type is also called + multi-dimensional array type. +

+ Array types also have an element type, which is obtained by repeatedly + asking for the component type until a non-array type is returned. For example, + the String[][] array type has an element type of String.

+
+
Since:
+
4.0
+
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      componentType

      +
      Type componentType()
      +
      Returns the component type of this array type, as defined by The Java™ Language Specification. + That is, in case of a single-dimensional array, the element type of the array, and in case of a multi-dimensional + array, an array type with one less dimension. +

      + For example, the component type of int[] is the int type. The component type + of String[][] is the String[] array type, whose component type is the String type. +

      + Each dimension of the array type may be annotated independently.

      +
      +
      Returns:
      +
      the component type, never null
      +
      +
      +
    • +
    • +
      +

      kind

      +
      default Type.Kind kind()
      +
      Description copied from interface: Type
      +
      Returns the kind of this type.
      +
      +
      Specified by:
      +
      kind in interface Type
      +
      Returns:
      +
      the kind of this type
      +
      +
      +
    • +
    • +
      +

      asArray

      +
      default ArrayType asArray()
      +
      Description copied from interface: Type
      +
      Returns this type as an array type.
      +
      +
      Specified by:
      +
      asArray in interface Type
      +
      Returns:
      +
      this array type, never null
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/lang/model/types/ClassType.html b/cdi/4.1/apidocs/jakarta/enterprise/lang/model/types/ClassType.html new file mode 100644 index 0000000000..03455c3acc --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/lang/model/types/ClassType.html @@ -0,0 +1,216 @@ + + + + +ClassType (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface ClassType

+
+
+
+
All Superinterfaces:
+
AnnotationTarget, Type
+
+
+
public interface ClassType +extends Type
+
A class type, including interface types, enum types, annotation types and record types. + Class types are introduced by class declarations.
+
+
Since:
+
4.0
+
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      declaration

      +
      ClassInfo declaration()
      +
      Returns the declaration of this class type.
      +
      +
      Returns:
      +
      the declaration of this class type
      +
      +
      +
    • +
    • +
      +

      kind

      +
      default Type.Kind kind()
      +
      Description copied from interface: Type
      +
      Returns the kind of this type.
      +
      +
      Specified by:
      +
      kind in interface Type
      +
      Returns:
      +
      the kind of this type
      +
      +
      +
    • +
    • +
      +

      asClass

      +
      default ClassType asClass()
      +
      Description copied from interface: Type
      +
      Returns this type as a class type.
      +
      +
      Specified by:
      +
      asClass in interface Type
      +
      Returns:
      +
      this class type, never null
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/lang/model/types/ParameterizedType.html b/cdi/4.1/apidocs/jakarta/enterprise/lang/model/types/ParameterizedType.html new file mode 100644 index 0000000000..5bbceecdd8 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/lang/model/types/ParameterizedType.html @@ -0,0 +1,253 @@ + + + + +ParameterizedType (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface ParameterizedType

+
+
+
+
All Superinterfaces:
+
AnnotationTarget, Type
+
+
+
public interface ParameterizedType +extends Type
+
A parameterized type. That is, a generic class together with + a list of type arguments. The list of type arguments + has the same shape as the class's list of type parameters.
+
+
Since:
+
4.0
+
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      genericClass

      +
      ClassType genericClass()
      +
      Returns the type of the generic class that was parameterized with a list + of type arguments to form this parameterized type.
      +
      +
      Returns:
      +
      the type of the generic class, never null
      +
      +
      +
    • +
    • +
      +

      typeArguments

      +
      List<Type> typeArguments()
      +
      Returns the list of type arguments that were applied to a generic class to form this parameterized type.
      +
      +
      Returns:
      +
      immutable list of type arguments, never null or empty
      +
      +
      +
    • +
    • +
      +

      declaration

      +
      default ClassInfo declaration()
      +
      Returns the declaration of the generic class + that was parameterized with a list of type arguments to form this parameterized type.
      +
      +
      Returns:
      +
      the declaration of the generic class, never null
      +
      +
      +
    • +
    • +
      +

      kind

      +
      default Type.Kind kind()
      +
      Description copied from interface: Type
      +
      Returns the kind of this type.
      +
      +
      Specified by:
      +
      kind in interface Type
      +
      Returns:
      +
      the kind of this type
      +
      +
      +
    • +
    • +
      +

      asParameterizedType

      +
      default ParameterizedType asParameterizedType()
      +
      Description copied from interface: Type
      +
      Returns this type as a parameterized type.
      +
      +
      Specified by:
      +
      asParameterizedType in interface Type
      +
      Returns:
      +
      this parameterized type, never null
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/lang/model/types/PrimitiveType.PrimitiveKind.html b/cdi/4.1/apidocs/jakarta/enterprise/lang/model/types/PrimitiveType.PrimitiveKind.html new file mode 100644 index 0000000000..451e07526b --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/lang/model/types/PrimitiveType.PrimitiveKind.html @@ -0,0 +1,315 @@ + + + + +PrimitiveType.PrimitiveKind (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Enum Class PrimitiveType.PrimitiveKind

+
+
java.lang.Object +
java.lang.Enum<PrimitiveType.PrimitiveKind> +
jakarta.enterprise.lang.model.types.PrimitiveType.PrimitiveKind
+
+
+
+
+
All Implemented Interfaces:
+
Serializable, Comparable<PrimitiveType.PrimitiveKind>, Constable
+
+
+
Enclosing interface:
+
PrimitiveType
+
+
+
public static enum PrimitiveType.PrimitiveKind +extends Enum<PrimitiveType.PrimitiveKind>
+
The primitive type kind: boolean, byte, short, int, long, float, double, char
+
+
+ +
+
+
    + +
  • +
    +

    Enum Constant Details

    + +
    +
  • + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      values

      +
      public static PrimitiveType.PrimitiveKind[] values()
      +
      Returns an array containing the constants of this enum class, in +the order they are declared.
      +
      +
      Returns:
      +
      an array containing the constants of this enum class, in the order they are declared
      +
      +
      +
    • +
    • +
      +

      valueOf

      +
      public static PrimitiveType.PrimitiveKind valueOf(String name)
      +
      Returns the enum constant of this class with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this class. (Extraneous whitespace characters are +not permitted.)
      +
      +
      Parameters:
      +
      name - the name of the enum constant to be returned.
      +
      Returns:
      +
      the enum constant with the specified name
      +
      Throws:
      +
      IllegalArgumentException - if this enum class has no constant with the specified name
      +
      NullPointerException - if the argument is null
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/lang/model/types/PrimitiveType.html b/cdi/4.1/apidocs/jakarta/enterprise/lang/model/types/PrimitiveType.html new file mode 100644 index 0000000000..2c0fb52193 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/lang/model/types/PrimitiveType.html @@ -0,0 +1,381 @@ + + + + +PrimitiveType (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface PrimitiveType

+
+
+
+
All Superinterfaces:
+
AnnotationTarget, Type
+
+
+
public interface PrimitiveType +extends Type
+
Primitive types are: + +
    +
  • boolean
  • +
  • byte
  • +
  • short
  • +
  • int
  • +
  • long
  • +
  • float
  • +
  • double
  • +
  • char
  • +
+
+
Since:
+
4.0
+
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      name

      +
      String name()
      +
      Returns the name of this primitive type.
      +
      +
      Returns:
      +
      the name of this primitive type
      +
      +
      +
    • +
    • +
      +

      primitiveKind

      + +
      Returns the kind of this primitive type.
      +
      +
      Returns:
      +
      the kind of this primitive type
      +
      +
      +
    • +
    • +
      +

      isBoolean

      +
      default boolean isBoolean()
      +
      Returns whether this primitive type is boolean.
      +
      +
      Returns:
      +
      whether this primitive type is boolean
      +
      +
      +
    • +
    • +
      +

      isByte

      +
      default boolean isByte()
      +
      Returns whether this primitive type is byte.
      +
      +
      Returns:
      +
      whether this primitive type is byte
      +
      +
      +
    • +
    • +
      +

      isShort

      +
      default boolean isShort()
      +
      Returns whether this primitive type is short.
      +
      +
      Returns:
      +
      whether this primitive type is short
      +
      +
      +
    • +
    • +
      +

      isInt

      +
      default boolean isInt()
      +
      Returns whether this primitive type is int.
      +
      +
      Returns:
      +
      whether this primitive type is int
      +
      +
      +
    • +
    • +
      +

      isLong

      +
      default boolean isLong()
      +
      Returns whether this primitive type is long.
      +
      +
      Returns:
      +
      whether this primitive type is long
      +
      +
      +
    • +
    • +
      +

      isFloat

      +
      default boolean isFloat()
      +
      Returns whether this primitive type is float.
      +
      +
      Returns:
      +
      whether this primitive type is float
      +
      +
      +
    • +
    • +
      +

      isDouble

      +
      default boolean isDouble()
      +
      Returns whether this primitive type is double.
      +
      +
      Returns:
      +
      whether this primitive type is double
      +
      +
      +
    • +
    • +
      +

      isChar

      +
      default boolean isChar()
      +
      Returns whether this primitive type is char.
      +
      +
      Returns:
      +
      whether this primitive type is char
      +
      +
      +
    • +
    • +
      +

      kind

      +
      default Type.Kind kind()
      +
      Description copied from interface: Type
      +
      Returns the kind of this type.
      +
      +
      Specified by:
      +
      kind in interface Type
      +
      Returns:
      +
      the kind of this type
      +
      +
      +
    • +
    • +
      +

      asPrimitive

      +
      default PrimitiveType asPrimitive()
      +
      Description copied from interface: Type
      +
      Returns this type as a primitive type.
      +
      +
      Specified by:
      +
      asPrimitive in interface Type
      +
      Returns:
      +
      this primitive type, never null
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/lang/model/types/Type.Kind.html b/cdi/4.1/apidocs/jakarta/enterprise/lang/model/types/Type.Kind.html new file mode 100644 index 0000000000..92203a9744 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/lang/model/types/Type.Kind.html @@ -0,0 +1,306 @@ + + + + +Type.Kind (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Enum Class Type.Kind

+
+
java.lang.Object +
java.lang.Enum<Type.Kind> +
jakarta.enterprise.lang.model.types.Type.Kind
+
+
+
+
+
All Implemented Interfaces:
+
Serializable, Comparable<Type.Kind>, Constable
+
+
+
Enclosing interface:
+
Type
+
+
+
public static enum Type.Kind +extends Enum<Type.Kind>
+
The type kind: void, primitive, class, array, parameterized type, type variable, wildcard type
+
+
+ +
+
+
    + +
  • +
    +

    Enum Constant Details

    +
      +
    • +
      +

      VOID

      +
      public static final Type.Kind VOID
      +
      The void pseudo-type, e.g. when method returns void.
      +
      +
    • +
    • +
      +

      PRIMITIVE

      +
      public static final Type.Kind PRIMITIVE
      +
      A primitive type, e.g. when method returns int.
      +
      +
    • +
    • +
      +

      CLASS

      +
      public static final Type.Kind CLASS
      +
      A class type, e.g. when method returns String.
      +
      +
    • +
    • +
      +

      ARRAY

      +
      public static final Type.Kind ARRAY
      +
      An array type, e.g. when method returns int[] or String[][].
      +
      +
    • +
    • +
      +

      PARAMETERIZED_TYPE

      +
      public static final Type.Kind PARAMETERIZED_TYPE
      +
      A parameterized type, e.g. when method returns List<String>.
      +
      +
    • +
    • +
      +

      TYPE_VARIABLE

      +
      public static final Type.Kind TYPE_VARIABLE
      +
      A type variable, e.g. when method returns T and T is a type parameter + of the declaring class.
      +
      +
    • +
    • +
      +

      WILDCARD_TYPE

      +
      public static final Type.Kind WILDCARD_TYPE
      +
      A wildcard type, e.g. when method returns List<? extends Number>. The kind of such type + is PARAMETERIZED_TYPE, but the first (and only) type argument is a WILDCARD_TYPE.
      +
      +
    • +
    +
    +
  • + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      values

      +
      public static Type.Kind[] values()
      +
      Returns an array containing the constants of this enum class, in +the order they are declared.
      +
      +
      Returns:
      +
      an array containing the constants of this enum class, in the order they are declared
      +
      +
      +
    • +
    • +
      +

      valueOf

      +
      public static Type.Kind valueOf(String name)
      +
      Returns the enum constant of this class with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this class. (Extraneous whitespace characters are +not permitted.)
      +
      +
      Parameters:
      +
      name - the name of the enum constant to be returned.
      +
      Returns:
      +
      the enum constant with the specified name
      +
      Throws:
      +
      IllegalArgumentException - if this enum class has no constant with the specified name
      +
      NullPointerException - if the argument is null
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/lang/model/types/Type.html b/cdi/4.1/apidocs/jakarta/enterprise/lang/model/types/Type.html new file mode 100644 index 0000000000..ae01f8bb4f --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/lang/model/types/Type.html @@ -0,0 +1,527 @@ + + + + +Type (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface Type

+
+
+
+
All Superinterfaces:
+
AnnotationTarget
+
+
+
All Known Subinterfaces:
+
ArrayType, ClassType, ParameterizedType, PrimitiveType, TypeVariable, VoidType, WildcardType
+
+
+
public interface Type +extends AnnotationTarget
+
A type is used in a program source code, but does not have to be declared anywhere. +

+ For example, the int type exists even if it is not declared in any Java source file, while + the java.lang.String type is declared by the class of the same name. Array types, + such as int[] or String[][], are not declared anywhere either, but their + element types may be. A generic class, such as java.util.List, declares a raw type + of the same name, but it does not declare the parameterized types, such as List<String>. + Parameterized types are created by applying type arguments to generic classes. For example, + the List<String> type is created by applying String to List<T>. +

+ Types occur on many places. A field has a type, a method has a return type, a method parameter + has a type, even the extends clause in a class declaration contains a type. + Occurences of types may be annotated. +

+ Types are: + +

    +
  • the void pseudo-type
  • +
  • a primitive type, such as int
  • +
  • a class type, such as String
  • +
  • an array type, such as int[] or String[][]
  • +
  • a parameterized type, such as List<String>
  • +
  • a type variable, such as T when used in a class that declares a type parameter + T
  • +
  • a wildcard type, such as the type argument in List<? extends Number>
  • +
+ + Class types and parameterized types allow obtaining their class declarations.
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      isDeclaration

      +
      default boolean isDeclaration()
      +
      Description copied from interface: AnnotationTarget
      +
      Returns whether this annotation target is a declaration.
      +
      +
      Specified by:
      +
      isDeclaration in interface AnnotationTarget
      +
      Returns:
      +
      true if this is a declaration, false otherwise
      +
      +
      +
    • +
    • +
      +

      isType

      +
      default boolean isType()
      +
      Description copied from interface: AnnotationTarget
      +
      Returns whether this annotation target is a type.
      +
      +
      Specified by:
      +
      isType in interface AnnotationTarget
      +
      Returns:
      +
      true if this is a type, false otherwise
      +
      +
      +
    • +
    • +
      +

      asDeclaration

      +
      default DeclarationInfo asDeclaration()
      +
      Description copied from interface: AnnotationTarget
      +
      Returns this annotation target as a declaration.
      +
      +
      Specified by:
      +
      asDeclaration in interface AnnotationTarget
      +
      Returns:
      +
      this declaration, never null
      +
      +
      +
    • +
    • +
      +

      asType

      +
      default Type asType()
      +
      Description copied from interface: AnnotationTarget
      +
      Returns this annotation target as a type.
      +
      +
      Specified by:
      +
      asType in interface AnnotationTarget
      +
      Returns:
      +
      this type, never null
      +
      +
      +
    • +
    • +
      +

      kind

      +
      Type.Kind kind()
      +
      Returns the kind of this type.
      +
      +
      Returns:
      +
      the kind of this type
      +
      +
      +
    • +
    • +
      +

      isVoid

      +
      default boolean isVoid()
      +
      Returns whether this type is the void pseudo-type.
      +
      +
      Returns:
      +
      true if this is void, false otherwise
      +
      +
      +
    • +
    • +
      +

      isPrimitive

      +
      default boolean isPrimitive()
      +
      Returns whether this type is a primitive type.
      +
      +
      Returns:
      +
      true if this is a primitive type, false otherwise
      +
      +
      +
    • +
    • +
      +

      isClass

      +
      default boolean isClass()
      +
      Returns whether this type is a class type.
      +
      +
      Returns:
      +
      true if this is a class type, false otherwise
      +
      +
      +
    • +
    • +
      +

      isArray

      +
      default boolean isArray()
      +
      Returns whether this type is an array type.
      +
      +
      Returns:
      +
      true if this is an array type, false otherwise
      +
      +
      +
    • +
    • +
      +

      isParameterizedType

      +
      default boolean isParameterizedType()
      +
      Returns whether this type is a parameterized type.
      +
      +
      Returns:
      +
      true if this is a parameterized type, false otherwise
      +
      +
      +
    • +
    • +
      +

      isTypeVariable

      +
      default boolean isTypeVariable()
      +
      Returns whether this type is a type variable. + Type variables are also used to represent type parameters in declarations + of parameterized types.
      +
      +
      Returns:
      +
      true if this is a primitive type, false otherwise
      +
      +
      +
    • +
    • +
      +

      isWildcardType

      +
      default boolean isWildcardType()
      +
      Returns whether this type is a wildcard type.
      +
      +
      Returns:
      +
      true if this is a wildcard type, false otherwise
      +
      +
      +
    • +
    • +
      +

      asVoid

      +
      default VoidType asVoid()
      +
      Returns this type as the void pseudo-type.
      +
      +
      Returns:
      +
      this void type, never null
      +
      Throws:
      +
      IllegalStateException - if isVoid() returns false
      +
      +
      +
    • +
    • +
      +

      asPrimitive

      +
      default PrimitiveType asPrimitive()
      +
      Returns this type as a primitive type.
      +
      +
      Returns:
      +
      this primitive type, never null
      +
      Throws:
      +
      IllegalStateException - if isPrimitive() returns false
      +
      +
      +
    • +
    • +
      +

      asClass

      +
      default ClassType asClass()
      +
      Returns this type as a class type.
      +
      +
      Returns:
      +
      this class type, never null
      +
      Throws:
      +
      IllegalStateException - if isClass() returns false
      +
      +
      +
    • +
    • +
      +

      asArray

      +
      default ArrayType asArray()
      +
      Returns this type as an array type.
      +
      +
      Returns:
      +
      this array type, never null
      +
      Throws:
      +
      IllegalStateException - if isArray() returns false
      +
      +
      +
    • +
    • +
      +

      asParameterizedType

      +
      default ParameterizedType asParameterizedType()
      +
      Returns this type as a parameterized type.
      +
      +
      Returns:
      +
      this parameterized type, never null
      +
      Throws:
      +
      IllegalStateException - if isParameterizedType() returns false
      +
      +
      +
    • +
    • +
      +

      asTypeVariable

      +
      default TypeVariable asTypeVariable()
      +
      Returns this type as a type variable. + Type variables are also used to represent type parameters in declarations + of parameterized types.
      +
      +
      Returns:
      +
      this type variable, never null
      +
      Throws:
      +
      IllegalStateException - if isTypeVariable() returns false
      +
      +
      +
    • +
    • +
      +

      asWildcardType

      +
      default WildcardType asWildcardType()
      +
      Returns this type as a wildcard type.
      +
      +
      Returns:
      +
      this wildcard type, never null
      +
      Throws:
      +
      IllegalStateException - if isWildcardType() returns false
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/lang/model/types/TypeVariable.html b/cdi/4.1/apidocs/jakarta/enterprise/lang/model/types/TypeVariable.html new file mode 100644 index 0000000000..5481064f2f --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/lang/model/types/TypeVariable.html @@ -0,0 +1,234 @@ + + + + +TypeVariable (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface TypeVariable

+
+
+
+
All Superinterfaces:
+
AnnotationTarget, Type
+
+
+
public interface TypeVariable +extends Type
+
Type variables represent type parameters declared on generic classes or methods. + All type variables have bounds. A type variable with no bound declared is equivalent to + a type variable with a single bound of java.lang.Object and is represented as such. + If one bound is declared, it is a type variable or a class type, possibly parameterized. + If more than one bound is declared, the first bound is a class type or an interface type, + possibly parameterized, and the following bounds are interface types, possibly parameterized.
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      name

      +
      String name()
      +
      Returns the name of this type variable.
      +
      +
      Returns:
      +
      the name of this type variable, never null
      +
      +
      +
    • +
    • +
      +

      bounds

      +
      List<Type> bounds()
      +
      Returns the bounds declared for this type variable.
      +
      +
      Returns:
      +
      the bounds declared for this type variable, never null or empty
      +
      +
      +
    • +
    • +
      +

      kind

      +
      default Type.Kind kind()
      +
      Description copied from interface: Type
      +
      Returns the kind of this type.
      +
      +
      Specified by:
      +
      kind in interface Type
      +
      Returns:
      +
      the kind of this type
      +
      +
      +
    • +
    • +
      +

      asTypeVariable

      +
      default TypeVariable asTypeVariable()
      +
      Description copied from interface: Type
      +
      Returns this type as a type variable. + Type variables are also used to represent type parameters in declarations + of parameterized types.
      +
      +
      Specified by:
      +
      asTypeVariable in interface Type
      +
      Returns:
      +
      this type variable, never null
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/lang/model/types/VoidType.html b/cdi/4.1/apidocs/jakarta/enterprise/lang/model/types/VoidType.html new file mode 100644 index 0000000000..ccac2fa031 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/lang/model/types/VoidType.html @@ -0,0 +1,211 @@ + + + + +VoidType (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface VoidType

+
+
+
+
All Superinterfaces:
+
AnnotationTarget, Type
+
+
+
public interface VoidType +extends Type
+
The void pseudo-type.
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      name

      +
      String name()
      +
      Returns the name of the void pseudo-type, that is, the string void.
      +
      +
      Returns:
      +
      the string void
      +
      +
      +
    • +
    • +
      +

      kind

      +
      default Type.Kind kind()
      +
      Description copied from interface: Type
      +
      Returns the kind of this type.
      +
      +
      Specified by:
      +
      kind in interface Type
      +
      Returns:
      +
      the kind of this type
      +
      +
      +
    • +
    • +
      +

      asVoid

      +
      default VoidType asVoid()
      +
      Description copied from interface: Type
      +
      Returns this type as the void pseudo-type.
      +
      +
      Specified by:
      +
      asVoid in interface Type
      +
      Returns:
      +
      this void type, never null
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/lang/model/types/WildcardType.html b/cdi/4.1/apidocs/jakarta/enterprise/lang/model/types/WildcardType.html new file mode 100644 index 0000000000..8c44a6e0f4 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/lang/model/types/WildcardType.html @@ -0,0 +1,236 @@ + + + + +WildcardType (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Interface WildcardType

+
+
+
+
All Superinterfaces:
+
AnnotationTarget, Type
+
+
+
public interface WildcardType +extends Type
+
A wildcard type. May have 3 forms: +
    +
  • ? extends Number: has an upper bound
  • +
  • ? super Number: has a lower bound
  • +
  • ?: unbounded, has an implicit upper bound of java.lang.Object
  • +
+ Note that ? is equivalent to ? extends Object and is represented as such. + Therefore, either upperBound() or lowerBound() always returns non-null.
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      upperBound

      +
      Type upperBound()
      +
      Returns the upper bound of this wildcard type. + Returns null if this wildcard type does not have an upper bound.
      +
      +
      Returns:
      +
      upper bound of this wildcard type, or null if this wildcard type does not have an upper bound
      +
      +
      +
    • +
    • +
      +

      lowerBound

      +
      Type lowerBound()
      +
      Returns the lower bound of this wildcard type. + Returns null if this wildcard type does not have a lower bound.
      +
      +
      Returns:
      +
      lower bound of this wildcard type, or null if this wildcard type does not have a lower bound
      +
      +
      +
    • +
    • +
      +

      kind

      +
      default Type.Kind kind()
      +
      Description copied from interface: Type
      +
      Returns the kind of this type.
      +
      +
      Specified by:
      +
      kind in interface Type
      +
      Returns:
      +
      the kind of this type
      +
      +
      +
    • +
    • +
      +

      asWildcardType

      +
      default WildcardType asWildcardType()
      +
      Description copied from interface: Type
      +
      Returns this type as a wildcard type.
      +
      +
      Specified by:
      +
      asWildcardType in interface Type
      +
      Returns:
      +
      this wildcard type, never null
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/lang/model/types/class-use/ArrayType.html b/cdi/4.1/apidocs/jakarta/enterprise/lang/model/types/class-use/ArrayType.html new file mode 100644 index 0000000000..3fbbaab740 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/lang/model/types/class-use/ArrayType.html @@ -0,0 +1,118 @@ + + + + +Uses of Interface jakarta.enterprise.lang.model.types.ArrayType (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.enterprise.lang.model.types.ArrayType

+
+
Packages that use ArrayType
+
+
Package
+
Description
+ +
+
+ The build compatible extension SPI.
+
+ +
+
Interfaces that represent types.
+
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/lang/model/types/class-use/ClassType.html b/cdi/4.1/apidocs/jakarta/enterprise/lang/model/types/class-use/ClassType.html new file mode 100644 index 0000000000..6aa6518c7b --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/lang/model/types/class-use/ClassType.html @@ -0,0 +1,141 @@ + + + + +Uses of Interface jakarta.enterprise.lang.model.types.ClassType (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.enterprise.lang.model.types.ClassType

+
+
Packages that use ClassType
+
+
Package
+
Description
+ +
+
+ The build compatible extension SPI.
+
+ +
+
Interfaces that represent types.
+
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/lang/model/types/class-use/ParameterizedType.html b/cdi/4.1/apidocs/jakarta/enterprise/lang/model/types/class-use/ParameterizedType.html new file mode 100644 index 0000000000..670f684ec4 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/lang/model/types/class-use/ParameterizedType.html @@ -0,0 +1,130 @@ + + + + +Uses of Interface jakarta.enterprise.lang.model.types.ParameterizedType (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.enterprise.lang.model.types.ParameterizedType

+
+
Packages that use ParameterizedType
+
+
Package
+
Description
+ +
+
+ The build compatible extension SPI.
+
+ +
+
Interfaces that represent types.
+
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/lang/model/types/class-use/PrimitiveType.PrimitiveKind.html b/cdi/4.1/apidocs/jakarta/enterprise/lang/model/types/class-use/PrimitiveType.PrimitiveKind.html new file mode 100644 index 0000000000..52c6ad06e6 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/lang/model/types/class-use/PrimitiveType.PrimitiveKind.html @@ -0,0 +1,125 @@ + + + + +Uses of Enum Class jakarta.enterprise.lang.model.types.PrimitiveType.PrimitiveKind (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Enum Class
jakarta.enterprise.lang.model.types.PrimitiveType.PrimitiveKind

+
+
Packages that use PrimitiveType.PrimitiveKind
+
+
Package
+
Description
+ +
+
+ The build compatible extension SPI.
+
+ +
+
Interfaces that represent types.
+
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/lang/model/types/class-use/PrimitiveType.html b/cdi/4.1/apidocs/jakarta/enterprise/lang/model/types/class-use/PrimitiveType.html new file mode 100644 index 0000000000..fa063bde88 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/lang/model/types/class-use/PrimitiveType.html @@ -0,0 +1,117 @@ + + + + +Uses of Interface jakarta.enterprise.lang.model.types.PrimitiveType (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.enterprise.lang.model.types.PrimitiveType

+
+
Packages that use PrimitiveType
+
+
Package
+
Description
+ +
+
+ The build compatible extension SPI.
+
+ +
+
Interfaces that represent types.
+
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/lang/model/types/class-use/Type.Kind.html b/cdi/4.1/apidocs/jakarta/enterprise/lang/model/types/class-use/Type.Kind.html new file mode 100644 index 0000000000..fdef6d607c --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/lang/model/types/class-use/Type.Kind.html @@ -0,0 +1,125 @@ + + + + +Uses of Enum Class jakarta.enterprise.lang.model.types.Type.Kind (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Enum Class
jakarta.enterprise.lang.model.types.Type.Kind

+
+
Packages that use Type.Kind
+
+
Package
+
Description
+ +
+
Interfaces that represent types.
+
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/lang/model/types/class-use/Type.html b/cdi/4.1/apidocs/jakarta/enterprise/lang/model/types/class-use/Type.html new file mode 100644 index 0000000000..74a545f869 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/lang/model/types/class-use/Type.html @@ -0,0 +1,374 @@ + + + + +Uses of Interface jakarta.enterprise.lang.model.types.Type (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.enterprise.lang.model.types.Type

+
+
Packages that use Type
+
+
Package
+
Description
+ +
+
+ The build compatible extension SPI.
+
+ +
+
The core interfaces of the language model that represent + annotations and + annotation targets.
+
+ +
+
Interfaces that represent declarations.
+
+ +
+
Interfaces that represent types.
+
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/lang/model/types/class-use/TypeVariable.html b/cdi/4.1/apidocs/jakarta/enterprise/lang/model/types/class-use/TypeVariable.html new file mode 100644 index 0000000000..69931d162f --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/lang/model/types/class-use/TypeVariable.html @@ -0,0 +1,121 @@ + + + + +Uses of Interface jakarta.enterprise.lang.model.types.TypeVariable (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.enterprise.lang.model.types.TypeVariable

+
+
Packages that use TypeVariable
+
+
Package
+
Description
+ +
+
Interfaces that represent declarations.
+
+ +
+
Interfaces that represent types.
+
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/lang/model/types/class-use/VoidType.html b/cdi/4.1/apidocs/jakarta/enterprise/lang/model/types/class-use/VoidType.html new file mode 100644 index 0000000000..f11d4e3947 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/lang/model/types/class-use/VoidType.html @@ -0,0 +1,117 @@ + + + + +Uses of Interface jakarta.enterprise.lang.model.types.VoidType (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.enterprise.lang.model.types.VoidType

+
+
Packages that use VoidType
+
+
Package
+
Description
+ +
+
+ The build compatible extension SPI.
+
+ +
+
Interfaces that represent types.
+
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/lang/model/types/class-use/WildcardType.html b/cdi/4.1/apidocs/jakarta/enterprise/lang/model/types/class-use/WildcardType.html new file mode 100644 index 0000000000..a1141088cb --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/lang/model/types/class-use/WildcardType.html @@ -0,0 +1,127 @@ + + + + +Uses of Interface jakarta.enterprise.lang.model.types.WildcardType (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.enterprise.lang.model.types.WildcardType

+
+
Packages that use WildcardType
+
+
Package
+
Description
+ +
+
+ The build compatible extension SPI.
+
+ +
+
Interfaces that represent types.
+
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/lang/model/types/package-summary.html b/cdi/4.1/apidocs/jakarta/enterprise/lang/model/types/package-summary.html new file mode 100644 index 0000000000..b2c4dc3eb7 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/lang/model/types/package-summary.html @@ -0,0 +1,171 @@ + + + + +jakarta.enterprise.lang.model.types (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Package jakarta.enterprise.lang.model.types

+
+
+
package jakarta.enterprise.lang.model.types
+
+
Interfaces that represent types.
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/lang/model/types/package-tree.html b/cdi/4.1/apidocs/jakarta/enterprise/lang/model/types/package-tree.html new file mode 100644 index 0000000000..af6fee4347 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/lang/model/types/package-tree.html @@ -0,0 +1,103 @@ + + + + +jakarta.enterprise.lang.model.types Class Hierarchy (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Hierarchy For Package jakarta.enterprise.lang.model.types

+
+Package Hierarchies: + +
+

Interface Hierarchy

+ +
+
+

Enum Class Hierarchy

+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/lang/model/types/package-use.html b/cdi/4.1/apidocs/jakarta/enterprise/lang/model/types/package-use.html new file mode 100644 index 0000000000..fce6cf09db --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/lang/model/types/package-use.html @@ -0,0 +1,234 @@ + + + + +Uses of Package jakarta.enterprise.lang.model.types (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Package
jakarta.enterprise.lang.model.types

+
+ +
+
Package
+
Description
+ +
+
+ The build compatible extension SPI.
+
+ +
+
The core interfaces of the language model that represent + annotations and + annotation targets.
+
+ +
+
Interfaces that represent declarations.
+
+ +
+
Interfaces that represent types.
+
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/util/AnnotationLiteral.html b/cdi/4.1/apidocs/jakarta/enterprise/util/AnnotationLiteral.html new file mode 100644 index 0000000000..c1120fb476 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/util/AnnotationLiteral.html @@ -0,0 +1,283 @@ + + + + +AnnotationLiteral (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Class AnnotationLiteral<T extends Annotation>

+
+
java.lang.Object +
jakarta.enterprise.util.AnnotationLiteral<T>
+
+
+
+
Type Parameters:
+
T - the annotation type
+
+
+
All Implemented Interfaces:
+
Serializable, Annotation
+
+
+
Direct Known Subclasses:
+
Alternative.Literal, Any.Literal, ApplicationScoped.Literal, BeforeDestroyed.Literal, ConversationScoped.Literal, Default.Literal, Dependent.Literal, Destroyed.Literal, Initialized.Literal, InjectLiteral, NamedLiteral, Nonbinding.Literal, QualifierLiteral, RequestScoped.Literal, SessionScoped.Literal, SingletonLiteral, Specializes.Literal, TransientReference.Literal, Typed.Literal, Vetoed.Literal
+
+
+
public abstract class AnnotationLiteral<T extends Annotation> +extends Object +implements Annotation, Serializable
+

+ Supports inline instantiation of annotation type instances. +

+ +

+ Reflection operations are using SecurityActions utility class to support security manager. +

+ +

+ An instance of an annotation type may be obtained by subclassing AnnotationLiteral. + The subclass must implement the annotation interface to satisfy the Annotation contract. +

+ +
+ public abstract class PayByQualifier extends AnnotationLiteral<PayBy> implements PayBy {
+ }
+ 
+ +
+ PayBy payByCheque = new PayByQualifier() {
+     public PaymentMethod value() {
+         return CHEQUE;
+     }
+ };
+ 
+
+
Author:
+
Pete Muir, Gavin King, Marko Luksa, Antoine Sabot-Durand
+
See Also:
+
+ +
+
+
+
+ +
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      AnnotationLiteral

      +
      protected AnnotationLiteral()
      +
      The literal constructor, only for subclasses.
      +
      +
    • +
    +
    +
  • + +
  • +
    +

    Method Details

    + +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/util/Nonbinding.Literal.html b/cdi/4.1/apidocs/jakarta/enterprise/util/Nonbinding.Literal.html new file mode 100644 index 0000000000..5a9ef87571 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/util/Nonbinding.Literal.html @@ -0,0 +1,220 @@ + + + + +Nonbinding.Literal (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Class Nonbinding.Literal

+
+
java.lang.Object +
jakarta.enterprise.util.AnnotationLiteral<Nonbinding> +
jakarta.enterprise.util.Nonbinding.Literal
+
+
+
+
+
All Implemented Interfaces:
+
Annotation
+
+
+
Enclosing class:
+
Nonbinding
+
+
+
public static final class Nonbinding.Literal +extends AnnotationLiteral<Nonbinding> +implements Nonbinding
+
Supports inline instantiation of the Nonbinding annotation.
+
+
Since:
+
2.0
+
Author:
+
Martin Kouba
+
See Also:
+
+ +
+
+
+
+ +
+
+
    + +
  • +
    +

    Field Details

    +
      +
    • +
      +

      INSTANCE

      +
      public static final Nonbinding.Literal INSTANCE
      +
      Default Nonbinding literal
      +
      +
    • +
    +
    +
  • + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      Literal

      +
      public Literal()
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/util/Nonbinding.html b/cdi/4.1/apidocs/jakarta/enterprise/util/Nonbinding.html new file mode 100644 index 0000000000..23f3dbdd03 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/util/Nonbinding.html @@ -0,0 +1,152 @@ + + + + +Nonbinding (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Annotation Interface Nonbinding

+
+
+
+
@Retention(RUNTIME) +@Target(METHOD) +public @interface Nonbinding
+

+ Excludes a member of an annotation type (such as a qualifier type or + interceptor binding type) from consideration when the container compares + two annotation instances. +

+ +
+ @Qualifier
+ @Retention(RUNTIME)
+ @Target({ METHOD, FIELD, PARAMETER, TYPE })
+ public @interface PayBy {
+     PaymentMethod value();
+
+     @Nonbinding
+     String comment();
+ }
+ 
+
+
Author:
+
Gavin King
+
See Also:
+
+
    +
  • @Qualifier
  • +
  • @InterceptorBinding
  • +
+
+
+
+
+
    + +
  • +
    +

    Nested Class Summary

    +
    Nested Classes
    +
    +
    Modifier and Type
    +
    Class
    +
    Description
    +
    static final class 
    + +
    +
    Supports inline instantiation of the Nonbinding annotation.
    +
    +
    +
    +
  • +
+
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/util/TypeLiteral.html b/cdi/4.1/apidocs/jakarta/enterprise/util/TypeLiteral.html new file mode 100644 index 0000000000..e27e0d6a10 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/util/TypeLiteral.html @@ -0,0 +1,273 @@ + + + + +TypeLiteral (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+ +
+ +

Class TypeLiteral<T>

+
+
java.lang.Object +
jakarta.enterprise.util.TypeLiteral<T>
+
+
+
+
Type Parameters:
+
T - the type, including all actual type parameters
+
+
+
All Implemented Interfaces:
+
Serializable
+
+
+
public abstract class TypeLiteral<T> +extends Object +implements Serializable
+

+ Supports inline instantiation of objects that represent parameterized types with actual type parameters. +

+ +

+ An object that represents any parameterized type may be obtained by subclassing TypeLiteral. +

+ +
+ TypeLiteral<List<String>> stringListType = new TypeLiteral<List<String>>() {
+ };
+ 
+
+
Author:
+
Gavin King, Pete Muir
+
See Also:
+
+ +
+
+
+
+ +
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      TypeLiteral

      +
      protected TypeLiteral()
      +
      The literal constructor, only for subclasses.
      +
      +
    • +
    +
    +
  • + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      getType

      +
      public final Type getType()
      +
      +
      Returns:
      +
      the actual type represented by this object
      +
      +
      +
    • +
    • +
      +

      getRawType

      +
      public final Class<T> getRawType()
      +
      +
      Returns:
      +
      the raw type represented by this object
      +
      +
      +
    • +
    • +
      +

      equals

      +
      public boolean equals(Object obj)
      +
      +
      Overrides:
      +
      equals in class Object
      +
      +
      +
    • +
    • +
      +

      hashCode

      +
      public int hashCode()
      +
      +
      Overrides:
      +
      hashCode in class Object
      +
      +
      +
    • +
    • +
      +

      toString

      +
      public String toString()
      +
      +
      Overrides:
      +
      toString in class Object
      +
      +
      +
    • +
    +
    +
  • +
+
+ +
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/util/class-use/AnnotationLiteral.html b/cdi/4.1/apidocs/jakarta/enterprise/util/class-use/AnnotationLiteral.html new file mode 100644 index 0000000000..08aaa10ee3 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/util/class-use/AnnotationLiteral.html @@ -0,0 +1,230 @@ + + + + +Uses of Class jakarta.enterprise.util.AnnotationLiteral (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
jakarta.enterprise.util.AnnotationLiteral

+
+
Packages that use AnnotationLiteral
+
+
Package
+
Description
+ +
+
+ Annotations and interfaces relating to scopes and contexts.
+
+ +
 
+ +
 
+ +
+
Contains shared, general-purpose helper classes and annotations.
+
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/util/class-use/Nonbinding.Literal.html b/cdi/4.1/apidocs/jakarta/enterprise/util/class-use/Nonbinding.Literal.html new file mode 100644 index 0000000000..1b77f84c2c --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/util/class-use/Nonbinding.Literal.html @@ -0,0 +1,93 @@ + + + + +Uses of Class jakarta.enterprise.util.Nonbinding.Literal (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
jakarta.enterprise.util.Nonbinding.Literal

+
+
Packages that use Nonbinding.Literal
+
+
Package
+
Description
+ +
+
Contains shared, general-purpose helper classes and annotations.
+
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/util/class-use/Nonbinding.html b/cdi/4.1/apidocs/jakarta/enterprise/util/class-use/Nonbinding.html new file mode 100644 index 0000000000..bb20f87ef4 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/util/class-use/Nonbinding.html @@ -0,0 +1,64 @@ + + + + +Uses of Annotation Interface jakarta.enterprise.util.Nonbinding (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Annotation Interface
jakarta.enterprise.util.Nonbinding

+
+No usage of jakarta.enterprise.util.Nonbinding
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/util/class-use/TypeLiteral.html b/cdi/4.1/apidocs/jakarta/enterprise/util/class-use/TypeLiteral.html new file mode 100644 index 0000000000..ad00be9ff2 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/util/class-use/TypeLiteral.html @@ -0,0 +1,139 @@ + + + + +Uses of Class jakarta.enterprise.util.TypeLiteral (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
jakarta.enterprise.util.TypeLiteral

+
+
Packages that use TypeLiteral
+
+
Package
+
Description
+ +
+
+ Annotations and interfaces relating to events.
+
+ +
 
+ +
 
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/util/package-summary.html b/cdi/4.1/apidocs/jakarta/enterprise/util/package-summary.html new file mode 100644 index 0000000000..1c009a87e8 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/util/package-summary.html @@ -0,0 +1,122 @@ + + + + +jakarta.enterprise.util (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Package jakarta.enterprise.util

+
+
+
package jakarta.enterprise.util
+
+
Contains shared, general-purpose helper classes and annotations.
+
+
+
    +
  • +
    +
    +
    +
    +
    Class
    +
    Description
    + +
    +
    + Supports inline instantiation of annotation type instances.
    +
    + +
    +
    + Excludes a member of an annotation type (such as a qualifier type or + interceptor binding type) from consideration when the container compares + two annotation instances.
    +
    + +
    +
    Supports inline instantiation of the Nonbinding annotation.
    +
    + +
    +
    + Supports inline instantiation of objects that represent parameterized types with actual type parameters.
    +
    +
    +
    +
    +
  • +
+
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/util/package-tree.html b/cdi/4.1/apidocs/jakarta/enterprise/util/package-tree.html new file mode 100644 index 0000000000..97652acd09 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/util/package-tree.html @@ -0,0 +1,89 @@ + + + + +jakarta.enterprise.util Class Hierarchy (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Hierarchy For Package jakarta.enterprise.util

+
+Package Hierarchies: + +
+

Class Hierarchy

+ +
+
+

Annotation Interface Hierarchy

+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jakarta/enterprise/util/package-use.html b/cdi/4.1/apidocs/jakarta/enterprise/util/package-use.html new file mode 100644 index 0000000000..f4ca50cff4 --- /dev/null +++ b/cdi/4.1/apidocs/jakarta/enterprise/util/package-use.html @@ -0,0 +1,186 @@ + + + + +Uses of Package jakarta.enterprise.util (Jakarta Contexts and Dependency Injection API) + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Package
jakarta.enterprise.util

+
+
Packages that use jakarta.enterprise.util
+
+
Package
+
Description
+ +
+
+ Annotations and interfaces relating to scopes and contexts.
+
+ +
+
+ Annotations and interfaces relating to events.
+
+ +
 
+ +
 
+ +
 
+ +
+
Contains shared, general-purpose helper classes and annotations.
+
+
+
+ +
+
+ +
+
+ + diff --git a/cdi/4.1/apidocs/jquery-ui.overrides.css b/cdi/4.1/apidocs/jquery-ui.overrides.css deleted file mode 100644 index facf852c27..0000000000 --- a/cdi/4.1/apidocs/jquery-ui.overrides.css +++ /dev/null @@ -1,35 +0,0 @@ -/* - * Copyright (c) 2020, 2022, Oracle and/or its affiliates. All rights reserved. - * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * - * This code is free software; you can redistribute it and/or modify it - * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. - * - * This code is distributed in the hope that it will be useful, but WITHOUT - * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or - * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License - * version 2 for more details (a copy is included in the LICENSE file that - * accompanied this code). - * - * You should have received a copy of the GNU General Public License version - * 2 along with this work; if not, write to the Free Software Foundation, - * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. - * - * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA - * or visit www.oracle.com if you need additional information or have any - * questions. - */ - -.ui-state-active, -.ui-widget-content .ui-state-active, -.ui-widget-header .ui-state-active, -a.ui-button:active, -.ui-button:active, -.ui-button.ui-state-active:hover { - /* Overrides the color of selection used in jQuery UI */ - background: #F8981D; - border: 1px solid #F8981D; -} diff --git a/cdi/4.1/apidocs/jquery/external/jquery/jquery.js b/cdi/4.1/apidocs/jquery/external/jquery/jquery.js deleted file mode 100644 index 50937333b9..0000000000 --- a/cdi/4.1/apidocs/jquery/external/jquery/jquery.js +++ /dev/null @@ -1,10872 +0,0 @@ -/*! - * jQuery JavaScript Library v3.5.1 - * https://jquery.com/ - * - * Includes Sizzle.js - * https://sizzlejs.com/ - * - * Copyright JS Foundation and other contributors - * Released under the MIT license - * https://jquery.org/license - * - * Date: 2020-05-04T22:49Z - */ -( function( global, factory ) { - - "use strict"; - - if ( typeof module === "object" && typeof module.exports === "object" ) { - - // For CommonJS and CommonJS-like environments where a proper `window` - // is present, execute the factory and get jQuery. - // For environments that do not have a `window` with a `document` - // (such as Node.js), expose a factory as module.exports. - // This accentuates the need for the creation of a real `window`. - // e.g. var jQuery = require("jquery")(window); - // See ticket #14549 for more info. - module.exports = global.document ? - factory( global, true ) : - function( w ) { - if ( !w.document ) { - throw new Error( "jQuery requires a window with a document" ); - } - return factory( w ); - }; - } else { - factory( global ); - } - -// Pass this if window is not defined yet -} )( typeof window !== "undefined" ? window : this, function( window, noGlobal ) { - -// Edge <= 12 - 13+, Firefox <=18 - 45+, IE 10 - 11, Safari 5.1 - 9+, iOS 6 - 9.1 -// throw exceptions when non-strict code (e.g., ASP.NET 4.5) accesses strict mode -// arguments.callee.caller (trac-13335). But as of jQuery 3.0 (2016), strict mode should be common -// enough that all such attempts are guarded in a try block. -"use strict"; - -var arr = []; - -var getProto = Object.getPrototypeOf; - -var slice = arr.slice; - -var flat = arr.flat ? function( array ) { - return arr.flat.call( array ); -} : function( array ) { - return arr.concat.apply( [], array ); -}; - - -var push = arr.push; - -var indexOf = arr.indexOf; - -var class2type = {}; - -var toString = class2type.toString; - -var hasOwn = class2type.hasOwnProperty; - -var fnToString = hasOwn.toString; - -var ObjectFunctionString = fnToString.call( Object ); - -var support = {}; - -var isFunction = function isFunction( obj ) { - - // Support: Chrome <=57, Firefox <=52 - // In some browsers, typeof returns "function" for HTML elements - // (i.e., `typeof document.createElement( "object" ) === "function"`). - // We don't want to classify *any* DOM node as a function. - return typeof obj === "function" && typeof obj.nodeType !== "number"; - }; - - -var isWindow = function isWindow( obj ) { - return obj != null && obj === obj.window; - }; - - -var document = window.document; - - - - var preservedScriptAttributes = { - type: true, - src: true, - nonce: true, - noModule: true - }; - - function DOMEval( code, node, doc ) { - doc = doc || document; - - var i, val, - script = doc.createElement( "script" ); - - script.text = code; - if ( node ) { - for ( i in preservedScriptAttributes ) { - - // Support: Firefox 64+, Edge 18+ - // Some browsers don't support the "nonce" property on scripts. - // On the other hand, just using `getAttribute` is not enough as - // the `nonce` attribute is reset to an empty string whenever it - // becomes browsing-context connected. - // See https://github.com/whatwg/html/issues/2369 - // See https://html.spec.whatwg.org/#nonce-attributes - // The `node.getAttribute` check was added for the sake of - // `jQuery.globalEval` so that it can fake a nonce-containing node - // via an object. - val = node[ i ] || node.getAttribute && node.getAttribute( i ); - if ( val ) { - script.setAttribute( i, val ); - } - } - } - doc.head.appendChild( script ).parentNode.removeChild( script ); - } - - -function toType( obj ) { - if ( obj == null ) { - return obj + ""; - } - - // Support: Android <=2.3 only (functionish RegExp) - return typeof obj === "object" || typeof obj === "function" ? - class2type[ toString.call( obj ) ] || "object" : - typeof obj; -} -/* global Symbol */ -// Defining this global in .eslintrc.json would create a danger of using the global -// unguarded in another place, it seems safer to define global only for this module - - - -var - version = "3.5.1", - - // Define a local copy of jQuery - jQuery = function( selector, context ) { - - // The jQuery object is actually just the init constructor 'enhanced' - // Need init if jQuery is called (just allow error to be thrown if not included) - return new jQuery.fn.init( selector, context ); - }; - -jQuery.fn = jQuery.prototype = { - - // The current version of jQuery being used - jquery: version, - - constructor: jQuery, - - // The default length of a jQuery object is 0 - length: 0, - - toArray: function() { - return slice.call( this ); - }, - - // Get the Nth element in the matched element set OR - // Get the whole matched element set as a clean array - get: function( num ) { - - // Return all the elements in a clean array - if ( num == null ) { - return slice.call( this ); - } - - // Return just the one element from the set - return num < 0 ? this[ num + this.length ] : this[ num ]; - }, - - // Take an array of elements and push it onto the stack - // (returning the new matched element set) - pushStack: function( elems ) { - - // Build a new jQuery matched element set - var ret = jQuery.merge( this.constructor(), elems ); - - // Add the old object onto the stack (as a reference) - ret.prevObject = this; - - // Return the newly-formed element set - return ret; - }, - - // Execute a callback for every element in the matched set. - each: function( callback ) { - return jQuery.each( this, callback ); - }, - - map: function( callback ) { - return this.pushStack( jQuery.map( this, function( elem, i ) { - return callback.call( elem, i, elem ); - } ) ); - }, - - slice: function() { - return this.pushStack( slice.apply( this, arguments ) ); - }, - - first: function() { - return this.eq( 0 ); - }, - - last: function() { - return this.eq( -1 ); - }, - - even: function() { - return this.pushStack( jQuery.grep( this, function( _elem, i ) { - return ( i + 1 ) % 2; - } ) ); - }, - - odd: function() { - return this.pushStack( jQuery.grep( this, function( _elem, i ) { - return i % 2; - } ) ); - }, - - eq: function( i ) { - var len = this.length, - j = +i + ( i < 0 ? len : 0 ); - return this.pushStack( j >= 0 && j < len ? [ this[ j ] ] : [] ); - }, - - end: function() { - return this.prevObject || this.constructor(); - }, - - // For internal use only. - // Behaves like an Array's method, not like a jQuery method. - push: push, - sort: arr.sort, - splice: arr.splice -}; - -jQuery.extend = jQuery.fn.extend = function() { - var options, name, src, copy, copyIsArray, clone, - target = arguments[ 0 ] || {}, - i = 1, - length = arguments.length, - deep = false; - - // Handle a deep copy situation - if ( typeof target === "boolean" ) { - deep = target; - - // Skip the boolean and the target - target = arguments[ i ] || {}; - i++; - } - - // Handle case when target is a string or something (possible in deep copy) - if ( typeof target !== "object" && !isFunction( target ) ) { - target = {}; - } - - // Extend jQuery itself if only one argument is passed - if ( i === length ) { - target = this; - i--; - } - - for ( ; i < length; i++ ) { - - // Only deal with non-null/undefined values - if ( ( options = arguments[ i ] ) != null ) { - - // Extend the base object - for ( name in options ) { - copy = options[ name ]; - - // Prevent Object.prototype pollution - // Prevent never-ending loop - if ( name === "__proto__" || target === copy ) { - continue; - } - - // Recurse if we're merging plain objects or arrays - if ( deep && copy && ( jQuery.isPlainObject( copy ) || - ( copyIsArray = Array.isArray( copy ) ) ) ) { - src = target[ name ]; - - // Ensure proper type for the source value - if ( copyIsArray && !Array.isArray( src ) ) { - clone = []; - } else if ( !copyIsArray && !jQuery.isPlainObject( src ) ) { - clone = {}; - } else { - clone = src; - } - copyIsArray = false; - - // Never move original objects, clone them - target[ name ] = jQuery.extend( deep, clone, copy ); - - // Don't bring in undefined values - } else if ( copy !== undefined ) { - target[ name ] = copy; - } - } - } - } - - // Return the modified object - return target; -}; - -jQuery.extend( { - - // Unique for each copy of jQuery on the page - expando: "jQuery" + ( version + Math.random() ).replace( /\D/g, "" ), - - // Assume jQuery is ready without the ready module - isReady: true, - - error: function( msg ) { - throw new Error( msg ); - }, - - noop: function() {}, - - isPlainObject: function( obj ) { - var proto, Ctor; - - // Detect obvious negatives - // Use toString instead of jQuery.type to catch host objects - if ( !obj || toString.call( obj ) !== "[object Object]" ) { - return false; - } - - proto = getProto( obj ); - - // Objects with no prototype (e.g., `Object.create( null )`) are plain - if ( !proto ) { - return true; - } - - // Objects with prototype are plain iff they were constructed by a global Object function - Ctor = hasOwn.call( proto, "constructor" ) && proto.constructor; - return typeof Ctor === "function" && fnToString.call( Ctor ) === ObjectFunctionString; - }, - - isEmptyObject: function( obj ) { - var name; - - for ( name in obj ) { - return false; - } - return true; - }, - - // Evaluates a script in a provided context; falls back to the global one - // if not specified. - globalEval: function( code, options, doc ) { - DOMEval( code, { nonce: options && options.nonce }, doc ); - }, - - each: function( obj, callback ) { - var length, i = 0; - - if ( isArrayLike( obj ) ) { - length = obj.length; - for ( ; i < length; i++ ) { - if ( callback.call( obj[ i ], i, obj[ i ] ) === false ) { - break; - } - } - } else { - for ( i in obj ) { - if ( callback.call( obj[ i ], i, obj[ i ] ) === false ) { - break; - } - } - } - - return obj; - }, - - // results is for internal usage only - makeArray: function( arr, results ) { - var ret = results || []; - - if ( arr != null ) { - if ( isArrayLike( Object( arr ) ) ) { - jQuery.merge( ret, - typeof arr === "string" ? - [ arr ] : arr - ); - } else { - push.call( ret, arr ); - } - } - - return ret; - }, - - inArray: function( elem, arr, i ) { - return arr == null ? -1 : indexOf.call( arr, elem, i ); - }, - - // Support: Android <=4.0 only, PhantomJS 1 only - // push.apply(_, arraylike) throws on ancient WebKit - merge: function( first, second ) { - var len = +second.length, - j = 0, - i = first.length; - - for ( ; j < len; j++ ) { - first[ i++ ] = second[ j ]; - } - - first.length = i; - - return first; - }, - - grep: function( elems, callback, invert ) { - var callbackInverse, - matches = [], - i = 0, - length = elems.length, - callbackExpect = !invert; - - // Go through the array, only saving the items - // that pass the validator function - for ( ; i < length; i++ ) { - callbackInverse = !callback( elems[ i ], i ); - if ( callbackInverse !== callbackExpect ) { - matches.push( elems[ i ] ); - } - } - - return matches; - }, - - // arg is for internal usage only - map: function( elems, callback, arg ) { - var length, value, - i = 0, - ret = []; - - // Go through the array, translating each of the items to their new values - if ( isArrayLike( elems ) ) { - length = elems.length; - for ( ; i < length; i++ ) { - value = callback( elems[ i ], i, arg ); - - if ( value != null ) { - ret.push( value ); - } - } - - // Go through every key on the object, - } else { - for ( i in elems ) { - value = callback( elems[ i ], i, arg ); - - if ( value != null ) { - ret.push( value ); - } - } - } - - // Flatten any nested arrays - return flat( ret ); - }, - - // A global GUID counter for objects - guid: 1, - - // jQuery.support is not used in Core but other projects attach their - // properties to it so it needs to exist. - support: support -} ); - -if ( typeof Symbol === "function" ) { - jQuery.fn[ Symbol.iterator ] = arr[ Symbol.iterator ]; -} - -// Populate the class2type map -jQuery.each( "Boolean Number String Function Array Date RegExp Object Error Symbol".split( " " ), -function( _i, name ) { - class2type[ "[object " + name + "]" ] = name.toLowerCase(); -} ); - -function isArrayLike( obj ) { - - // Support: real iOS 8.2 only (not reproducible in simulator) - // `in` check used to prevent JIT error (gh-2145) - // hasOwn isn't used here due to false negatives - // regarding Nodelist length in IE - var length = !!obj && "length" in obj && obj.length, - type = toType( obj ); - - if ( isFunction( obj ) || isWindow( obj ) ) { - return false; - } - - return type === "array" || length === 0 || - typeof length === "number" && length > 0 && ( length - 1 ) in obj; -} -var Sizzle = -/*! - * Sizzle CSS Selector Engine v2.3.5 - * https://sizzlejs.com/ - * - * Copyright JS Foundation and other contributors - * Released under the MIT license - * https://js.foundation/ - * - * Date: 2020-03-14 - */ -( function( window ) { -var i, - support, - Expr, - getText, - isXML, - tokenize, - compile, - select, - outermostContext, - sortInput, - hasDuplicate, - - // Local document vars - setDocument, - document, - docElem, - documentIsHTML, - rbuggyQSA, - rbuggyMatches, - matches, - contains, - - // Instance-specific data - expando = "sizzle" + 1 * new Date(), - preferredDoc = window.document, - dirruns = 0, - done = 0, - classCache = createCache(), - tokenCache = createCache(), - compilerCache = createCache(), - nonnativeSelectorCache = createCache(), - sortOrder = function( a, b ) { - if ( a === b ) { - hasDuplicate = true; - } - return 0; - }, - - // Instance methods - hasOwn = ( {} ).hasOwnProperty, - arr = [], - pop = arr.pop, - pushNative = arr.push, - push = arr.push, - slice = arr.slice, - - // Use a stripped-down indexOf as it's faster than native - // https://jsperf.com/thor-indexof-vs-for/5 - indexOf = function( list, elem ) { - var i = 0, - len = list.length; - for ( ; i < len; i++ ) { - if ( list[ i ] === elem ) { - return i; - } - } - return -1; - }, - - booleans = "checked|selected|async|autofocus|autoplay|controls|defer|disabled|hidden|" + - "ismap|loop|multiple|open|readonly|required|scoped", - - // Regular expressions - - // http://www.w3.org/TR/css3-selectors/#whitespace - whitespace = "[\\x20\\t\\r\\n\\f]", - - // https://www.w3.org/TR/css-syntax-3/#ident-token-diagram - identifier = "(?:\\\\[\\da-fA-F]{1,6}" + whitespace + - "?|\\\\[^\\r\\n\\f]|[\\w-]|[^\0-\\x7f])+", - - // Attribute selectors: http://www.w3.org/TR/selectors/#attribute-selectors - attributes = "\\[" + whitespace + "*(" + identifier + ")(?:" + whitespace + - - // Operator (capture 2) - "*([*^$|!~]?=)" + whitespace + - - // "Attribute values must be CSS identifiers [capture 5] - // or strings [capture 3 or capture 4]" - "*(?:'((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\"|(" + identifier + "))|)" + - whitespace + "*\\]", - - pseudos = ":(" + identifier + ")(?:\\((" + - - // To reduce the number of selectors needing tokenize in the preFilter, prefer arguments: - // 1. quoted (capture 3; capture 4 or capture 5) - "('((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\")|" + - - // 2. simple (capture 6) - "((?:\\\\.|[^\\\\()[\\]]|" + attributes + ")*)|" + - - // 3. anything else (capture 2) - ".*" + - ")\\)|)", - - // Leading and non-escaped trailing whitespace, capturing some non-whitespace characters preceding the latter - rwhitespace = new RegExp( whitespace + "+", "g" ), - rtrim = new RegExp( "^" + whitespace + "+|((?:^|[^\\\\])(?:\\\\.)*)" + - whitespace + "+$", "g" ), - - rcomma = new RegExp( "^" + whitespace + "*," + whitespace + "*" ), - rcombinators = new RegExp( "^" + whitespace + "*([>+~]|" + whitespace + ")" + whitespace + - "*" ), - rdescend = new RegExp( whitespace + "|>" ), - - rpseudo = new RegExp( pseudos ), - ridentifier = new RegExp( "^" + identifier + "$" ), - - matchExpr = { - "ID": new RegExp( "^#(" + identifier + ")" ), - "CLASS": new RegExp( "^\\.(" + identifier + ")" ), - "TAG": new RegExp( "^(" + identifier + "|[*])" ), - "ATTR": new RegExp( "^" + attributes ), - "PSEUDO": new RegExp( "^" + pseudos ), - "CHILD": new RegExp( "^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\(" + - whitespace + "*(even|odd|(([+-]|)(\\d*)n|)" + whitespace + "*(?:([+-]|)" + - whitespace + "*(\\d+)|))" + whitespace + "*\\)|)", "i" ), - "bool": new RegExp( "^(?:" + booleans + ")$", "i" ), - - // For use in libraries implementing .is() - // We use this for POS matching in `select` - "needsContext": new RegExp( "^" + whitespace + - "*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\(" + whitespace + - "*((?:-\\d)?\\d*)" + whitespace + "*\\)|)(?=[^-]|$)", "i" ) - }, - - rhtml = /HTML$/i, - rinputs = /^(?:input|select|textarea|button)$/i, - rheader = /^h\d$/i, - - rnative = /^[^{]+\{\s*\[native \w/, - - // Easily-parseable/retrievable ID or TAG or CLASS selectors - rquickExpr = /^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/, - - rsibling = /[+~]/, - - // CSS escapes - // http://www.w3.org/TR/CSS21/syndata.html#escaped-characters - runescape = new RegExp( "\\\\[\\da-fA-F]{1,6}" + whitespace + "?|\\\\([^\\r\\n\\f])", "g" ), - funescape = function( escape, nonHex ) { - var high = "0x" + escape.slice( 1 ) - 0x10000; - - return nonHex ? - - // Strip the backslash prefix from a non-hex escape sequence - nonHex : - - // Replace a hexadecimal escape sequence with the encoded Unicode code point - // Support: IE <=11+ - // For values outside the Basic Multilingual Plane (BMP), manually construct a - // surrogate pair - high < 0 ? - String.fromCharCode( high + 0x10000 ) : - String.fromCharCode( high >> 10 | 0xD800, high & 0x3FF | 0xDC00 ); - }, - - // CSS string/identifier serialization - // https://drafts.csswg.org/cssom/#common-serializing-idioms - rcssescape = /([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g, - fcssescape = function( ch, asCodePoint ) { - if ( asCodePoint ) { - - // U+0000 NULL becomes U+FFFD REPLACEMENT CHARACTER - if ( ch === "\0" ) { - return "\uFFFD"; - } - - // Control characters and (dependent upon position) numbers get escaped as code points - return ch.slice( 0, -1 ) + "\\" + - ch.charCodeAt( ch.length - 1 ).toString( 16 ) + " "; - } - - // Other potentially-special ASCII characters get backslash-escaped - return "\\" + ch; - }, - - // Used for iframes - // See setDocument() - // Removing the function wrapper causes a "Permission Denied" - // error in IE - unloadHandler = function() { - setDocument(); - }, - - inDisabledFieldset = addCombinator( - function( elem ) { - return elem.disabled === true && elem.nodeName.toLowerCase() === "fieldset"; - }, - { dir: "parentNode", next: "legend" } - ); - -// Optimize for push.apply( _, NodeList ) -try { - push.apply( - ( arr = slice.call( preferredDoc.childNodes ) ), - preferredDoc.childNodes - ); - - // Support: Android<4.0 - // Detect silently failing push.apply - // eslint-disable-next-line no-unused-expressions - arr[ preferredDoc.childNodes.length ].nodeType; -} catch ( e ) { - push = { apply: arr.length ? - - // Leverage slice if possible - function( target, els ) { - pushNative.apply( target, slice.call( els ) ); - } : - - // Support: IE<9 - // Otherwise append directly - function( target, els ) { - var j = target.length, - i = 0; - - // Can't trust NodeList.length - while ( ( target[ j++ ] = els[ i++ ] ) ) {} - target.length = j - 1; - } - }; -} - -function Sizzle( selector, context, results, seed ) { - var m, i, elem, nid, match, groups, newSelector, - newContext = context && context.ownerDocument, - - // nodeType defaults to 9, since context defaults to document - nodeType = context ? context.nodeType : 9; - - results = results || []; - - // Return early from calls with invalid selector or context - if ( typeof selector !== "string" || !selector || - nodeType !== 1 && nodeType !== 9 && nodeType !== 11 ) { - - return results; - } - - // Try to shortcut find operations (as opposed to filters) in HTML documents - if ( !seed ) { - setDocument( context ); - context = context || document; - - if ( documentIsHTML ) { - - // If the selector is sufficiently simple, try using a "get*By*" DOM method - // (excepting DocumentFragment context, where the methods don't exist) - if ( nodeType !== 11 && ( match = rquickExpr.exec( selector ) ) ) { - - // ID selector - if ( ( m = match[ 1 ] ) ) { - - // Document context - if ( nodeType === 9 ) { - if ( ( elem = context.getElementById( m ) ) ) { - - // Support: IE, Opera, Webkit - // TODO: identify versions - // getElementById can match elements by name instead of ID - if ( elem.id === m ) { - results.push( elem ); - return results; - } - } else { - return results; - } - - // Element context - } else { - - // Support: IE, Opera, Webkit - // TODO: identify versions - // getElementById can match elements by name instead of ID - if ( newContext && ( elem = newContext.getElementById( m ) ) && - contains( context, elem ) && - elem.id === m ) { - - results.push( elem ); - return results; - } - } - - // Type selector - } else if ( match[ 2 ] ) { - push.apply( results, context.getElementsByTagName( selector ) ); - return results; - - // Class selector - } else if ( ( m = match[ 3 ] ) && support.getElementsByClassName && - context.getElementsByClassName ) { - - push.apply( results, context.getElementsByClassName( m ) ); - return results; - } - } - - // Take advantage of querySelectorAll - if ( support.qsa && - !nonnativeSelectorCache[ selector + " " ] && - ( !rbuggyQSA || !rbuggyQSA.test( selector ) ) && - - // Support: IE 8 only - // Exclude object elements - ( nodeType !== 1 || context.nodeName.toLowerCase() !== "object" ) ) { - - newSelector = selector; - newContext = context; - - // qSA considers elements outside a scoping root when evaluating child or - // descendant combinators, which is not what we want. - // In such cases, we work around the behavior by prefixing every selector in the - // list with an ID selector referencing the scope context. - // The technique has to be used as well when a leading combinator is used - // as such selectors are not recognized by querySelectorAll. - // Thanks to Andrew Dupont for this technique. - if ( nodeType === 1 && - ( rdescend.test( selector ) || rcombinators.test( selector ) ) ) { - - // Expand context for sibling selectors - newContext = rsibling.test( selector ) && testContext( context.parentNode ) || - context; - - // We can use :scope instead of the ID hack if the browser - // supports it & if we're not changing the context. - if ( newContext !== context || !support.scope ) { - - // Capture the context ID, setting it first if necessary - if ( ( nid = context.getAttribute( "id" ) ) ) { - nid = nid.replace( rcssescape, fcssescape ); - } else { - context.setAttribute( "id", ( nid = expando ) ); - } - } - - // Prefix every selector in the list - groups = tokenize( selector ); - i = groups.length; - while ( i-- ) { - groups[ i ] = ( nid ? "#" + nid : ":scope" ) + " " + - toSelector( groups[ i ] ); - } - newSelector = groups.join( "," ); - } - - try { - push.apply( results, - newContext.querySelectorAll( newSelector ) - ); - return results; - } catch ( qsaError ) { - nonnativeSelectorCache( selector, true ); - } finally { - if ( nid === expando ) { - context.removeAttribute( "id" ); - } - } - } - } - } - - // All others - return select( selector.replace( rtrim, "$1" ), context, results, seed ); -} - -/** - * Create key-value caches of limited size - * @returns {function(string, object)} Returns the Object data after storing it on itself with - * property name the (space-suffixed) string and (if the cache is larger than Expr.cacheLength) - * deleting the oldest entry - */ -function createCache() { - var keys = []; - - function cache( key, value ) { - - // Use (key + " ") to avoid collision with native prototype properties (see Issue #157) - if ( keys.push( key + " " ) > Expr.cacheLength ) { - - // Only keep the most recent entries - delete cache[ keys.shift() ]; - } - return ( cache[ key + " " ] = value ); - } - return cache; -} - -/** - * Mark a function for special use by Sizzle - * @param {Function} fn The function to mark - */ -function markFunction( fn ) { - fn[ expando ] = true; - return fn; -} - -/** - * Support testing using an element - * @param {Function} fn Passed the created element and returns a boolean result - */ -function assert( fn ) { - var el = document.createElement( "fieldset" ); - - try { - return !!fn( el ); - } catch ( e ) { - return false; - } finally { - - // Remove from its parent by default - if ( el.parentNode ) { - el.parentNode.removeChild( el ); - } - - // release memory in IE - el = null; - } -} - -/** - * Adds the same handler for all of the specified attrs - * @param {String} attrs Pipe-separated list of attributes - * @param {Function} handler The method that will be applied - */ -function addHandle( attrs, handler ) { - var arr = attrs.split( "|" ), - i = arr.length; - - while ( i-- ) { - Expr.attrHandle[ arr[ i ] ] = handler; - } -} - -/** - * Checks document order of two siblings - * @param {Element} a - * @param {Element} b - * @returns {Number} Returns less than 0 if a precedes b, greater than 0 if a follows b - */ -function siblingCheck( a, b ) { - var cur = b && a, - diff = cur && a.nodeType === 1 && b.nodeType === 1 && - a.sourceIndex - b.sourceIndex; - - // Use IE sourceIndex if available on both nodes - if ( diff ) { - return diff; - } - - // Check if b follows a - if ( cur ) { - while ( ( cur = cur.nextSibling ) ) { - if ( cur === b ) { - return -1; - } - } - } - - return a ? 1 : -1; -} - -/** - * Returns a function to use in pseudos for input types - * @param {String} type - */ -function createInputPseudo( type ) { - return function( elem ) { - var name = elem.nodeName.toLowerCase(); - return name === "input" && elem.type === type; - }; -} - -/** - * Returns a function to use in pseudos for buttons - * @param {String} type - */ -function createButtonPseudo( type ) { - return function( elem ) { - var name = elem.nodeName.toLowerCase(); - return ( name === "input" || name === "button" ) && elem.type === type; - }; -} - -/** - * Returns a function to use in pseudos for :enabled/:disabled - * @param {Boolean} disabled true for :disabled; false for :enabled - */ -function createDisabledPseudo( disabled ) { - - // Known :disabled false positives: fieldset[disabled] > legend:nth-of-type(n+2) :can-disable - return function( elem ) { - - // Only certain elements can match :enabled or :disabled - // https://html.spec.whatwg.org/multipage/scripting.html#selector-enabled - // https://html.spec.whatwg.org/multipage/scripting.html#selector-disabled - if ( "form" in elem ) { - - // Check for inherited disabledness on relevant non-disabled elements: - // * listed form-associated elements in a disabled fieldset - // https://html.spec.whatwg.org/multipage/forms.html#category-listed - // https://html.spec.whatwg.org/multipage/forms.html#concept-fe-disabled - // * option elements in a disabled optgroup - // https://html.spec.whatwg.org/multipage/forms.html#concept-option-disabled - // All such elements have a "form" property. - if ( elem.parentNode && elem.disabled === false ) { - - // Option elements defer to a parent optgroup if present - if ( "label" in elem ) { - if ( "label" in elem.parentNode ) { - return elem.parentNode.disabled === disabled; - } else { - return elem.disabled === disabled; - } - } - - // Support: IE 6 - 11 - // Use the isDisabled shortcut property to check for disabled fieldset ancestors - return elem.isDisabled === disabled || - - // Where there is no isDisabled, check manually - /* jshint -W018 */ - elem.isDisabled !== !disabled && - inDisabledFieldset( elem ) === disabled; - } - - return elem.disabled === disabled; - - // Try to winnow out elements that can't be disabled before trusting the disabled property. - // Some victims get caught in our net (label, legend, menu, track), but it shouldn't - // even exist on them, let alone have a boolean value. - } else if ( "label" in elem ) { - return elem.disabled === disabled; - } - - // Remaining elements are neither :enabled nor :disabled - return false; - }; -} - -/** - * Returns a function to use in pseudos for positionals - * @param {Function} fn - */ -function createPositionalPseudo( fn ) { - return markFunction( function( argument ) { - argument = +argument; - return markFunction( function( seed, matches ) { - var j, - matchIndexes = fn( [], seed.length, argument ), - i = matchIndexes.length; - - // Match elements found at the specified indexes - while ( i-- ) { - if ( seed[ ( j = matchIndexes[ i ] ) ] ) { - seed[ j ] = !( matches[ j ] = seed[ j ] ); - } - } - } ); - } ); -} - -/** - * Checks a node for validity as a Sizzle context - * @param {Element|Object=} context - * @returns {Element|Object|Boolean} The input node if acceptable, otherwise a falsy value - */ -function testContext( context ) { - return context && typeof context.getElementsByTagName !== "undefined" && context; -} - -// Expose support vars for convenience -support = Sizzle.support = {}; - -/** - * Detects XML nodes - * @param {Element|Object} elem An element or a document - * @returns {Boolean} True iff elem is a non-HTML XML node - */ -isXML = Sizzle.isXML = function( elem ) { - var namespace = elem.namespaceURI, - docElem = ( elem.ownerDocument || elem ).documentElement; - - // Support: IE <=8 - // Assume HTML when documentElement doesn't yet exist, such as inside loading iframes - // https://bugs.jquery.com/ticket/4833 - return !rhtml.test( namespace || docElem && docElem.nodeName || "HTML" ); -}; - -/** - * Sets document-related variables once based on the current document - * @param {Element|Object} [doc] An element or document object to use to set the document - * @returns {Object} Returns the current document - */ -setDocument = Sizzle.setDocument = function( node ) { - var hasCompare, subWindow, - doc = node ? node.ownerDocument || node : preferredDoc; - - // Return early if doc is invalid or already selected - // Support: IE 11+, Edge 17 - 18+ - // IE/Edge sometimes throw a "Permission denied" error when strict-comparing - // two documents; shallow comparisons work. - // eslint-disable-next-line eqeqeq - if ( doc == document || doc.nodeType !== 9 || !doc.documentElement ) { - return document; - } - - // Update global variables - document = doc; - docElem = document.documentElement; - documentIsHTML = !isXML( document ); - - // Support: IE 9 - 11+, Edge 12 - 18+ - // Accessing iframe documents after unload throws "permission denied" errors (jQuery #13936) - // Support: IE 11+, Edge 17 - 18+ - // IE/Edge sometimes throw a "Permission denied" error when strict-comparing - // two documents; shallow comparisons work. - // eslint-disable-next-line eqeqeq - if ( preferredDoc != document && - ( subWindow = document.defaultView ) && subWindow.top !== subWindow ) { - - // Support: IE 11, Edge - if ( subWindow.addEventListener ) { - subWindow.addEventListener( "unload", unloadHandler, false ); - - // Support: IE 9 - 10 only - } else if ( subWindow.attachEvent ) { - subWindow.attachEvent( "onunload", unloadHandler ); - } - } - - // Support: IE 8 - 11+, Edge 12 - 18+, Chrome <=16 - 25 only, Firefox <=3.6 - 31 only, - // Safari 4 - 5 only, Opera <=11.6 - 12.x only - // IE/Edge & older browsers don't support the :scope pseudo-class. - // Support: Safari 6.0 only - // Safari 6.0 supports :scope but it's an alias of :root there. - support.scope = assert( function( el ) { - docElem.appendChild( el ).appendChild( document.createElement( "div" ) ); - return typeof el.querySelectorAll !== "undefined" && - !el.querySelectorAll( ":scope fieldset div" ).length; - } ); - - /* Attributes - ---------------------------------------------------------------------- */ - - // Support: IE<8 - // Verify that getAttribute really returns attributes and not properties - // (excepting IE8 booleans) - support.attributes = assert( function( el ) { - el.className = "i"; - return !el.getAttribute( "className" ); - } ); - - /* getElement(s)By* - ---------------------------------------------------------------------- */ - - // Check if getElementsByTagName("*") returns only elements - support.getElementsByTagName = assert( function( el ) { - el.appendChild( document.createComment( "" ) ); - return !el.getElementsByTagName( "*" ).length; - } ); - - // Support: IE<9 - support.getElementsByClassName = rnative.test( document.getElementsByClassName ); - - // Support: IE<10 - // Check if getElementById returns elements by name - // The broken getElementById methods don't pick up programmatically-set names, - // so use a roundabout getElementsByName test - support.getById = assert( function( el ) { - docElem.appendChild( el ).id = expando; - return !document.getElementsByName || !document.getElementsByName( expando ).length; - } ); - - // ID filter and find - if ( support.getById ) { - Expr.filter[ "ID" ] = function( id ) { - var attrId = id.replace( runescape, funescape ); - return function( elem ) { - return elem.getAttribute( "id" ) === attrId; - }; - }; - Expr.find[ "ID" ] = function( id, context ) { - if ( typeof context.getElementById !== "undefined" && documentIsHTML ) { - var elem = context.getElementById( id ); - return elem ? [ elem ] : []; - } - }; - } else { - Expr.filter[ "ID" ] = function( id ) { - var attrId = id.replace( runescape, funescape ); - return function( elem ) { - var node = typeof elem.getAttributeNode !== "undefined" && - elem.getAttributeNode( "id" ); - return node && node.value === attrId; - }; - }; - - // Support: IE 6 - 7 only - // getElementById is not reliable as a find shortcut - Expr.find[ "ID" ] = function( id, context ) { - if ( typeof context.getElementById !== "undefined" && documentIsHTML ) { - var node, i, elems, - elem = context.getElementById( id ); - - if ( elem ) { - - // Verify the id attribute - node = elem.getAttributeNode( "id" ); - if ( node && node.value === id ) { - return [ elem ]; - } - - // Fall back on getElementsByName - elems = context.getElementsByName( id ); - i = 0; - while ( ( elem = elems[ i++ ] ) ) { - node = elem.getAttributeNode( "id" ); - if ( node && node.value === id ) { - return [ elem ]; - } - } - } - - return []; - } - }; - } - - // Tag - Expr.find[ "TAG" ] = support.getElementsByTagName ? - function( tag, context ) { - if ( typeof context.getElementsByTagName !== "undefined" ) { - return context.getElementsByTagName( tag ); - - // DocumentFragment nodes don't have gEBTN - } else if ( support.qsa ) { - return context.querySelectorAll( tag ); - } - } : - - function( tag, context ) { - var elem, - tmp = [], - i = 0, - - // By happy coincidence, a (broken) gEBTN appears on DocumentFragment nodes too - results = context.getElementsByTagName( tag ); - - // Filter out possible comments - if ( tag === "*" ) { - while ( ( elem = results[ i++ ] ) ) { - if ( elem.nodeType === 1 ) { - tmp.push( elem ); - } - } - - return tmp; - } - return results; - }; - - // Class - Expr.find[ "CLASS" ] = support.getElementsByClassName && function( className, context ) { - if ( typeof context.getElementsByClassName !== "undefined" && documentIsHTML ) { - return context.getElementsByClassName( className ); - } - }; - - /* QSA/matchesSelector - ---------------------------------------------------------------------- */ - - // QSA and matchesSelector support - - // matchesSelector(:active) reports false when true (IE9/Opera 11.5) - rbuggyMatches = []; - - // qSa(:focus) reports false when true (Chrome 21) - // We allow this because of a bug in IE8/9 that throws an error - // whenever `document.activeElement` is accessed on an iframe - // So, we allow :focus to pass through QSA all the time to avoid the IE error - // See https://bugs.jquery.com/ticket/13378 - rbuggyQSA = []; - - if ( ( support.qsa = rnative.test( document.querySelectorAll ) ) ) { - - // Build QSA regex - // Regex strategy adopted from Diego Perini - assert( function( el ) { - - var input; - - // Select is set to empty string on purpose - // This is to test IE's treatment of not explicitly - // setting a boolean content attribute, - // since its presence should be enough - // https://bugs.jquery.com/ticket/12359 - docElem.appendChild( el ).innerHTML = "" + - ""; - - // Support: IE8, Opera 11-12.16 - // Nothing should be selected when empty strings follow ^= or $= or *= - // The test attribute must be unknown in Opera but "safe" for WinRT - // https://msdn.microsoft.com/en-us/library/ie/hh465388.aspx#attribute_section - if ( el.querySelectorAll( "[msallowcapture^='']" ).length ) { - rbuggyQSA.push( "[*^$]=" + whitespace + "*(?:''|\"\")" ); - } - - // Support: IE8 - // Boolean attributes and "value" are not treated correctly - if ( !el.querySelectorAll( "[selected]" ).length ) { - rbuggyQSA.push( "\\[" + whitespace + "*(?:value|" + booleans + ")" ); - } - - // Support: Chrome<29, Android<4.4, Safari<7.0+, iOS<7.0+, PhantomJS<1.9.8+ - if ( !el.querySelectorAll( "[id~=" + expando + "-]" ).length ) { - rbuggyQSA.push( "~=" ); - } - - // Support: IE 11+, Edge 15 - 18+ - // IE 11/Edge don't find elements on a `[name='']` query in some cases. - // Adding a temporary attribute to the document before the selection works - // around the issue. - // Interestingly, IE 10 & older don't seem to have the issue. - input = document.createElement( "input" ); - input.setAttribute( "name", "" ); - el.appendChild( input ); - if ( !el.querySelectorAll( "[name='']" ).length ) { - rbuggyQSA.push( "\\[" + whitespace + "*name" + whitespace + "*=" + - whitespace + "*(?:''|\"\")" ); - } - - // Webkit/Opera - :checked should return selected option elements - // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked - // IE8 throws error here and will not see later tests - if ( !el.querySelectorAll( ":checked" ).length ) { - rbuggyQSA.push( ":checked" ); - } - - // Support: Safari 8+, iOS 8+ - // https://bugs.webkit.org/show_bug.cgi?id=136851 - // In-page `selector#id sibling-combinator selector` fails - if ( !el.querySelectorAll( "a#" + expando + "+*" ).length ) { - rbuggyQSA.push( ".#.+[+~]" ); - } - - // Support: Firefox <=3.6 - 5 only - // Old Firefox doesn't throw on a badly-escaped identifier. - el.querySelectorAll( "\\\f" ); - rbuggyQSA.push( "[\\r\\n\\f]" ); - } ); - - assert( function( el ) { - el.innerHTML = "" + - ""; - - // Support: Windows 8 Native Apps - // The type and name attributes are restricted during .innerHTML assignment - var input = document.createElement( "input" ); - input.setAttribute( "type", "hidden" ); - el.appendChild( input ).setAttribute( "name", "D" ); - - // Support: IE8 - // Enforce case-sensitivity of name attribute - if ( el.querySelectorAll( "[name=d]" ).length ) { - rbuggyQSA.push( "name" + whitespace + "*[*^$|!~]?=" ); - } - - // FF 3.5 - :enabled/:disabled and hidden elements (hidden elements are still enabled) - // IE8 throws error here and will not see later tests - if ( el.querySelectorAll( ":enabled" ).length !== 2 ) { - rbuggyQSA.push( ":enabled", ":disabled" ); - } - - // Support: IE9-11+ - // IE's :disabled selector does not pick up the children of disabled fieldsets - docElem.appendChild( el ).disabled = true; - if ( el.querySelectorAll( ":disabled" ).length !== 2 ) { - rbuggyQSA.push( ":enabled", ":disabled" ); - } - - // Support: Opera 10 - 11 only - // Opera 10-11 does not throw on post-comma invalid pseudos - el.querySelectorAll( "*,:x" ); - rbuggyQSA.push( ",.*:" ); - } ); - } - - if ( ( support.matchesSelector = rnative.test( ( matches = docElem.matches || - docElem.webkitMatchesSelector || - docElem.mozMatchesSelector || - docElem.oMatchesSelector || - docElem.msMatchesSelector ) ) ) ) { - - assert( function( el ) { - - // Check to see if it's possible to do matchesSelector - // on a disconnected node (IE 9) - support.disconnectedMatch = matches.call( el, "*" ); - - // This should fail with an exception - // Gecko does not error, returns false instead - matches.call( el, "[s!='']:x" ); - rbuggyMatches.push( "!=", pseudos ); - } ); - } - - rbuggyQSA = rbuggyQSA.length && new RegExp( rbuggyQSA.join( "|" ) ); - rbuggyMatches = rbuggyMatches.length && new RegExp( rbuggyMatches.join( "|" ) ); - - /* Contains - ---------------------------------------------------------------------- */ - hasCompare = rnative.test( docElem.compareDocumentPosition ); - - // Element contains another - // Purposefully self-exclusive - // As in, an element does not contain itself - contains = hasCompare || rnative.test( docElem.contains ) ? - function( a, b ) { - var adown = a.nodeType === 9 ? a.documentElement : a, - bup = b && b.parentNode; - return a === bup || !!( bup && bup.nodeType === 1 && ( - adown.contains ? - adown.contains( bup ) : - a.compareDocumentPosition && a.compareDocumentPosition( bup ) & 16 - ) ); - } : - function( a, b ) { - if ( b ) { - while ( ( b = b.parentNode ) ) { - if ( b === a ) { - return true; - } - } - } - return false; - }; - - /* Sorting - ---------------------------------------------------------------------- */ - - // Document order sorting - sortOrder = hasCompare ? - function( a, b ) { - - // Flag for duplicate removal - if ( a === b ) { - hasDuplicate = true; - return 0; - } - - // Sort on method existence if only one input has compareDocumentPosition - var compare = !a.compareDocumentPosition - !b.compareDocumentPosition; - if ( compare ) { - return compare; - } - - // Calculate position if both inputs belong to the same document - // Support: IE 11+, Edge 17 - 18+ - // IE/Edge sometimes throw a "Permission denied" error when strict-comparing - // two documents; shallow comparisons work. - // eslint-disable-next-line eqeqeq - compare = ( a.ownerDocument || a ) == ( b.ownerDocument || b ) ? - a.compareDocumentPosition( b ) : - - // Otherwise we know they are disconnected - 1; - - // Disconnected nodes - if ( compare & 1 || - ( !support.sortDetached && b.compareDocumentPosition( a ) === compare ) ) { - - // Choose the first element that is related to our preferred document - // Support: IE 11+, Edge 17 - 18+ - // IE/Edge sometimes throw a "Permission denied" error when strict-comparing - // two documents; shallow comparisons work. - // eslint-disable-next-line eqeqeq - if ( a == document || a.ownerDocument == preferredDoc && - contains( preferredDoc, a ) ) { - return -1; - } - - // Support: IE 11+, Edge 17 - 18+ - // IE/Edge sometimes throw a "Permission denied" error when strict-comparing - // two documents; shallow comparisons work. - // eslint-disable-next-line eqeqeq - if ( b == document || b.ownerDocument == preferredDoc && - contains( preferredDoc, b ) ) { - return 1; - } - - // Maintain original order - return sortInput ? - ( indexOf( sortInput, a ) - indexOf( sortInput, b ) ) : - 0; - } - - return compare & 4 ? -1 : 1; - } : - function( a, b ) { - - // Exit early if the nodes are identical - if ( a === b ) { - hasDuplicate = true; - return 0; - } - - var cur, - i = 0, - aup = a.parentNode, - bup = b.parentNode, - ap = [ a ], - bp = [ b ]; - - // Parentless nodes are either documents or disconnected - if ( !aup || !bup ) { - - // Support: IE 11+, Edge 17 - 18+ - // IE/Edge sometimes throw a "Permission denied" error when strict-comparing - // two documents; shallow comparisons work. - /* eslint-disable eqeqeq */ - return a == document ? -1 : - b == document ? 1 : - /* eslint-enable eqeqeq */ - aup ? -1 : - bup ? 1 : - sortInput ? - ( indexOf( sortInput, a ) - indexOf( sortInput, b ) ) : - 0; - - // If the nodes are siblings, we can do a quick check - } else if ( aup === bup ) { - return siblingCheck( a, b ); - } - - // Otherwise we need full lists of their ancestors for comparison - cur = a; - while ( ( cur = cur.parentNode ) ) { - ap.unshift( cur ); - } - cur = b; - while ( ( cur = cur.parentNode ) ) { - bp.unshift( cur ); - } - - // Walk down the tree looking for a discrepancy - while ( ap[ i ] === bp[ i ] ) { - i++; - } - - return i ? - - // Do a sibling check if the nodes have a common ancestor - siblingCheck( ap[ i ], bp[ i ] ) : - - // Otherwise nodes in our document sort first - // Support: IE 11+, Edge 17 - 18+ - // IE/Edge sometimes throw a "Permission denied" error when strict-comparing - // two documents; shallow comparisons work. - /* eslint-disable eqeqeq */ - ap[ i ] == preferredDoc ? -1 : - bp[ i ] == preferredDoc ? 1 : - /* eslint-enable eqeqeq */ - 0; - }; - - return document; -}; - -Sizzle.matches = function( expr, elements ) { - return Sizzle( expr, null, null, elements ); -}; - -Sizzle.matchesSelector = function( elem, expr ) { - setDocument( elem ); - - if ( support.matchesSelector && documentIsHTML && - !nonnativeSelectorCache[ expr + " " ] && - ( !rbuggyMatches || !rbuggyMatches.test( expr ) ) && - ( !rbuggyQSA || !rbuggyQSA.test( expr ) ) ) { - - try { - var ret = matches.call( elem, expr ); - - // IE 9's matchesSelector returns false on disconnected nodes - if ( ret || support.disconnectedMatch || - - // As well, disconnected nodes are said to be in a document - // fragment in IE 9 - elem.document && elem.document.nodeType !== 11 ) { - return ret; - } - } catch ( e ) { - nonnativeSelectorCache( expr, true ); - } - } - - return Sizzle( expr, document, null, [ elem ] ).length > 0; -}; - -Sizzle.contains = function( context, elem ) { - - // Set document vars if needed - // Support: IE 11+, Edge 17 - 18+ - // IE/Edge sometimes throw a "Permission denied" error when strict-comparing - // two documents; shallow comparisons work. - // eslint-disable-next-line eqeqeq - if ( ( context.ownerDocument || context ) != document ) { - setDocument( context ); - } - return contains( context, elem ); -}; - -Sizzle.attr = function( elem, name ) { - - // Set document vars if needed - // Support: IE 11+, Edge 17 - 18+ - // IE/Edge sometimes throw a "Permission denied" error when strict-comparing - // two documents; shallow comparisons work. - // eslint-disable-next-line eqeqeq - if ( ( elem.ownerDocument || elem ) != document ) { - setDocument( elem ); - } - - var fn = Expr.attrHandle[ name.toLowerCase() ], - - // Don't get fooled by Object.prototype properties (jQuery #13807) - val = fn && hasOwn.call( Expr.attrHandle, name.toLowerCase() ) ? - fn( elem, name, !documentIsHTML ) : - undefined; - - return val !== undefined ? - val : - support.attributes || !documentIsHTML ? - elem.getAttribute( name ) : - ( val = elem.getAttributeNode( name ) ) && val.specified ? - val.value : - null; -}; - -Sizzle.escape = function( sel ) { - return ( sel + "" ).replace( rcssescape, fcssescape ); -}; - -Sizzle.error = function( msg ) { - throw new Error( "Syntax error, unrecognized expression: " + msg ); -}; - -/** - * Document sorting and removing duplicates - * @param {ArrayLike} results - */ -Sizzle.uniqueSort = function( results ) { - var elem, - duplicates = [], - j = 0, - i = 0; - - // Unless we *know* we can detect duplicates, assume their presence - hasDuplicate = !support.detectDuplicates; - sortInput = !support.sortStable && results.slice( 0 ); - results.sort( sortOrder ); - - if ( hasDuplicate ) { - while ( ( elem = results[ i++ ] ) ) { - if ( elem === results[ i ] ) { - j = duplicates.push( i ); - } - } - while ( j-- ) { - results.splice( duplicates[ j ], 1 ); - } - } - - // Clear input after sorting to release objects - // See https://github.com/jquery/sizzle/pull/225 - sortInput = null; - - return results; -}; - -/** - * Utility function for retrieving the text value of an array of DOM nodes - * @param {Array|Element} elem - */ -getText = Sizzle.getText = function( elem ) { - var node, - ret = "", - i = 0, - nodeType = elem.nodeType; - - if ( !nodeType ) { - - // If no nodeType, this is expected to be an array - while ( ( node = elem[ i++ ] ) ) { - - // Do not traverse comment nodes - ret += getText( node ); - } - } else if ( nodeType === 1 || nodeType === 9 || nodeType === 11 ) { - - // Use textContent for elements - // innerText usage removed for consistency of new lines (jQuery #11153) - if ( typeof elem.textContent === "string" ) { - return elem.textContent; - } else { - - // Traverse its children - for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) { - ret += getText( elem ); - } - } - } else if ( nodeType === 3 || nodeType === 4 ) { - return elem.nodeValue; - } - - // Do not include comment or processing instruction nodes - - return ret; -}; - -Expr = Sizzle.selectors = { - - // Can be adjusted by the user - cacheLength: 50, - - createPseudo: markFunction, - - match: matchExpr, - - attrHandle: {}, - - find: {}, - - relative: { - ">": { dir: "parentNode", first: true }, - " ": { dir: "parentNode" }, - "+": { dir: "previousSibling", first: true }, - "~": { dir: "previousSibling" } - }, - - preFilter: { - "ATTR": function( match ) { - match[ 1 ] = match[ 1 ].replace( runescape, funescape ); - - // Move the given value to match[3] whether quoted or unquoted - match[ 3 ] = ( match[ 3 ] || match[ 4 ] || - match[ 5 ] || "" ).replace( runescape, funescape ); - - if ( match[ 2 ] === "~=" ) { - match[ 3 ] = " " + match[ 3 ] + " "; - } - - return match.slice( 0, 4 ); - }, - - "CHILD": function( match ) { - - /* matches from matchExpr["CHILD"] - 1 type (only|nth|...) - 2 what (child|of-type) - 3 argument (even|odd|\d*|\d*n([+-]\d+)?|...) - 4 xn-component of xn+y argument ([+-]?\d*n|) - 5 sign of xn-component - 6 x of xn-component - 7 sign of y-component - 8 y of y-component - */ - match[ 1 ] = match[ 1 ].toLowerCase(); - - if ( match[ 1 ].slice( 0, 3 ) === "nth" ) { - - // nth-* requires argument - if ( !match[ 3 ] ) { - Sizzle.error( match[ 0 ] ); - } - - // numeric x and y parameters for Expr.filter.CHILD - // remember that false/true cast respectively to 0/1 - match[ 4 ] = +( match[ 4 ] ? - match[ 5 ] + ( match[ 6 ] || 1 ) : - 2 * ( match[ 3 ] === "even" || match[ 3 ] === "odd" ) ); - match[ 5 ] = +( ( match[ 7 ] + match[ 8 ] ) || match[ 3 ] === "odd" ); - - // other types prohibit arguments - } else if ( match[ 3 ] ) { - Sizzle.error( match[ 0 ] ); - } - - return match; - }, - - "PSEUDO": function( match ) { - var excess, - unquoted = !match[ 6 ] && match[ 2 ]; - - if ( matchExpr[ "CHILD" ].test( match[ 0 ] ) ) { - return null; - } - - // Accept quoted arguments as-is - if ( match[ 3 ] ) { - match[ 2 ] = match[ 4 ] || match[ 5 ] || ""; - - // Strip excess characters from unquoted arguments - } else if ( unquoted && rpseudo.test( unquoted ) && - - // Get excess from tokenize (recursively) - ( excess = tokenize( unquoted, true ) ) && - - // advance to the next closing parenthesis - ( excess = unquoted.indexOf( ")", unquoted.length - excess ) - unquoted.length ) ) { - - // excess is a negative index - match[ 0 ] = match[ 0 ].slice( 0, excess ); - match[ 2 ] = unquoted.slice( 0, excess ); - } - - // Return only captures needed by the pseudo filter method (type and argument) - return match.slice( 0, 3 ); - } - }, - - filter: { - - "TAG": function( nodeNameSelector ) { - var nodeName = nodeNameSelector.replace( runescape, funescape ).toLowerCase(); - return nodeNameSelector === "*" ? - function() { - return true; - } : - function( elem ) { - return elem.nodeName && elem.nodeName.toLowerCase() === nodeName; - }; - }, - - "CLASS": function( className ) { - var pattern = classCache[ className + " " ]; - - return pattern || - ( pattern = new RegExp( "(^|" + whitespace + - ")" + className + "(" + whitespace + "|$)" ) ) && classCache( - className, function( elem ) { - return pattern.test( - typeof elem.className === "string" && elem.className || - typeof elem.getAttribute !== "undefined" && - elem.getAttribute( "class" ) || - "" - ); - } ); - }, - - "ATTR": function( name, operator, check ) { - return function( elem ) { - var result = Sizzle.attr( elem, name ); - - if ( result == null ) { - return operator === "!="; - } - if ( !operator ) { - return true; - } - - result += ""; - - /* eslint-disable max-len */ - - return operator === "=" ? result === check : - operator === "!=" ? result !== check : - operator === "^=" ? check && result.indexOf( check ) === 0 : - operator === "*=" ? check && result.indexOf( check ) > -1 : - operator === "$=" ? check && result.slice( -check.length ) === check : - operator === "~=" ? ( " " + result.replace( rwhitespace, " " ) + " " ).indexOf( check ) > -1 : - operator === "|=" ? result === check || result.slice( 0, check.length + 1 ) === check + "-" : - false; - /* eslint-enable max-len */ - - }; - }, - - "CHILD": function( type, what, _argument, first, last ) { - var simple = type.slice( 0, 3 ) !== "nth", - forward = type.slice( -4 ) !== "last", - ofType = what === "of-type"; - - return first === 1 && last === 0 ? - - // Shortcut for :nth-*(n) - function( elem ) { - return !!elem.parentNode; - } : - - function( elem, _context, xml ) { - var cache, uniqueCache, outerCache, node, nodeIndex, start, - dir = simple !== forward ? "nextSibling" : "previousSibling", - parent = elem.parentNode, - name = ofType && elem.nodeName.toLowerCase(), - useCache = !xml && !ofType, - diff = false; - - if ( parent ) { - - // :(first|last|only)-(child|of-type) - if ( simple ) { - while ( dir ) { - node = elem; - while ( ( node = node[ dir ] ) ) { - if ( ofType ? - node.nodeName.toLowerCase() === name : - node.nodeType === 1 ) { - - return false; - } - } - - // Reverse direction for :only-* (if we haven't yet done so) - start = dir = type === "only" && !start && "nextSibling"; - } - return true; - } - - start = [ forward ? parent.firstChild : parent.lastChild ]; - - // non-xml :nth-child(...) stores cache data on `parent` - if ( forward && useCache ) { - - // Seek `elem` from a previously-cached index - - // ...in a gzip-friendly way - node = parent; - outerCache = node[ expando ] || ( node[ expando ] = {} ); - - // Support: IE <9 only - // Defend against cloned attroperties (jQuery gh-1709) - uniqueCache = outerCache[ node.uniqueID ] || - ( outerCache[ node.uniqueID ] = {} ); - - cache = uniqueCache[ type ] || []; - nodeIndex = cache[ 0 ] === dirruns && cache[ 1 ]; - diff = nodeIndex && cache[ 2 ]; - node = nodeIndex && parent.childNodes[ nodeIndex ]; - - while ( ( node = ++nodeIndex && node && node[ dir ] || - - // Fallback to seeking `elem` from the start - ( diff = nodeIndex = 0 ) || start.pop() ) ) { - - // When found, cache indexes on `parent` and break - if ( node.nodeType === 1 && ++diff && node === elem ) { - uniqueCache[ type ] = [ dirruns, nodeIndex, diff ]; - break; - } - } - - } else { - - // Use previously-cached element index if available - if ( useCache ) { - - // ...in a gzip-friendly way - node = elem; - outerCache = node[ expando ] || ( node[ expando ] = {} ); - - // Support: IE <9 only - // Defend against cloned attroperties (jQuery gh-1709) - uniqueCache = outerCache[ node.uniqueID ] || - ( outerCache[ node.uniqueID ] = {} ); - - cache = uniqueCache[ type ] || []; - nodeIndex = cache[ 0 ] === dirruns && cache[ 1 ]; - diff = nodeIndex; - } - - // xml :nth-child(...) - // or :nth-last-child(...) or :nth(-last)?-of-type(...) - if ( diff === false ) { - - // Use the same loop as above to seek `elem` from the start - while ( ( node = ++nodeIndex && node && node[ dir ] || - ( diff = nodeIndex = 0 ) || start.pop() ) ) { - - if ( ( ofType ? - node.nodeName.toLowerCase() === name : - node.nodeType === 1 ) && - ++diff ) { - - // Cache the index of each encountered element - if ( useCache ) { - outerCache = node[ expando ] || - ( node[ expando ] = {} ); - - // Support: IE <9 only - // Defend against cloned attroperties (jQuery gh-1709) - uniqueCache = outerCache[ node.uniqueID ] || - ( outerCache[ node.uniqueID ] = {} ); - - uniqueCache[ type ] = [ dirruns, diff ]; - } - - if ( node === elem ) { - break; - } - } - } - } - } - - // Incorporate the offset, then check against cycle size - diff -= last; - return diff === first || ( diff % first === 0 && diff / first >= 0 ); - } - }; - }, - - "PSEUDO": function( pseudo, argument ) { - - // pseudo-class names are case-insensitive - // http://www.w3.org/TR/selectors/#pseudo-classes - // Prioritize by case sensitivity in case custom pseudos are added with uppercase letters - // Remember that setFilters inherits from pseudos - var args, - fn = Expr.pseudos[ pseudo ] || Expr.setFilters[ pseudo.toLowerCase() ] || - Sizzle.error( "unsupported pseudo: " + pseudo ); - - // The user may use createPseudo to indicate that - // arguments are needed to create the filter function - // just as Sizzle does - if ( fn[ expando ] ) { - return fn( argument ); - } - - // But maintain support for old signatures - if ( fn.length > 1 ) { - args = [ pseudo, pseudo, "", argument ]; - return Expr.setFilters.hasOwnProperty( pseudo.toLowerCase() ) ? - markFunction( function( seed, matches ) { - var idx, - matched = fn( seed, argument ), - i = matched.length; - while ( i-- ) { - idx = indexOf( seed, matched[ i ] ); - seed[ idx ] = !( matches[ idx ] = matched[ i ] ); - } - } ) : - function( elem ) { - return fn( elem, 0, args ); - }; - } - - return fn; - } - }, - - pseudos: { - - // Potentially complex pseudos - "not": markFunction( function( selector ) { - - // Trim the selector passed to compile - // to avoid treating leading and trailing - // spaces as combinators - var input = [], - results = [], - matcher = compile( selector.replace( rtrim, "$1" ) ); - - return matcher[ expando ] ? - markFunction( function( seed, matches, _context, xml ) { - var elem, - unmatched = matcher( seed, null, xml, [] ), - i = seed.length; - - // Match elements unmatched by `matcher` - while ( i-- ) { - if ( ( elem = unmatched[ i ] ) ) { - seed[ i ] = !( matches[ i ] = elem ); - } - } - } ) : - function( elem, _context, xml ) { - input[ 0 ] = elem; - matcher( input, null, xml, results ); - - // Don't keep the element (issue #299) - input[ 0 ] = null; - return !results.pop(); - }; - } ), - - "has": markFunction( function( selector ) { - return function( elem ) { - return Sizzle( selector, elem ).length > 0; - }; - } ), - - "contains": markFunction( function( text ) { - text = text.replace( runescape, funescape ); - return function( elem ) { - return ( elem.textContent || getText( elem ) ).indexOf( text ) > -1; - }; - } ), - - // "Whether an element is represented by a :lang() selector - // is based solely on the element's language value - // being equal to the identifier C, - // or beginning with the identifier C immediately followed by "-". - // The matching of C against the element's language value is performed case-insensitively. - // The identifier C does not have to be a valid language name." - // http://www.w3.org/TR/selectors/#lang-pseudo - "lang": markFunction( function( lang ) { - - // lang value must be a valid identifier - if ( !ridentifier.test( lang || "" ) ) { - Sizzle.error( "unsupported lang: " + lang ); - } - lang = lang.replace( runescape, funescape ).toLowerCase(); - return function( elem ) { - var elemLang; - do { - if ( ( elemLang = documentIsHTML ? - elem.lang : - elem.getAttribute( "xml:lang" ) || elem.getAttribute( "lang" ) ) ) { - - elemLang = elemLang.toLowerCase(); - return elemLang === lang || elemLang.indexOf( lang + "-" ) === 0; - } - } while ( ( elem = elem.parentNode ) && elem.nodeType === 1 ); - return false; - }; - } ), - - // Miscellaneous - "target": function( elem ) { - var hash = window.location && window.location.hash; - return hash && hash.slice( 1 ) === elem.id; - }, - - "root": function( elem ) { - return elem === docElem; - }, - - "focus": function( elem ) { - return elem === document.activeElement && - ( !document.hasFocus || document.hasFocus() ) && - !!( elem.type || elem.href || ~elem.tabIndex ); - }, - - // Boolean properties - "enabled": createDisabledPseudo( false ), - "disabled": createDisabledPseudo( true ), - - "checked": function( elem ) { - - // In CSS3, :checked should return both checked and selected elements - // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked - var nodeName = elem.nodeName.toLowerCase(); - return ( nodeName === "input" && !!elem.checked ) || - ( nodeName === "option" && !!elem.selected ); - }, - - "selected": function( elem ) { - - // Accessing this property makes selected-by-default - // options in Safari work properly - if ( elem.parentNode ) { - // eslint-disable-next-line no-unused-expressions - elem.parentNode.selectedIndex; - } - - return elem.selected === true; - }, - - // Contents - "empty": function( elem ) { - - // http://www.w3.org/TR/selectors/#empty-pseudo - // :empty is negated by element (1) or content nodes (text: 3; cdata: 4; entity ref: 5), - // but not by others (comment: 8; processing instruction: 7; etc.) - // nodeType < 6 works because attributes (2) do not appear as children - for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) { - if ( elem.nodeType < 6 ) { - return false; - } - } - return true; - }, - - "parent": function( elem ) { - return !Expr.pseudos[ "empty" ]( elem ); - }, - - // Element/input types - "header": function( elem ) { - return rheader.test( elem.nodeName ); - }, - - "input": function( elem ) { - return rinputs.test( elem.nodeName ); - }, - - "button": function( elem ) { - var name = elem.nodeName.toLowerCase(); - return name === "input" && elem.type === "button" || name === "button"; - }, - - "text": function( elem ) { - var attr; - return elem.nodeName.toLowerCase() === "input" && - elem.type === "text" && - - // Support: IE<8 - // New HTML5 attribute values (e.g., "search") appear with elem.type === "text" - ( ( attr = elem.getAttribute( "type" ) ) == null || - attr.toLowerCase() === "text" ); - }, - - // Position-in-collection - "first": createPositionalPseudo( function() { - return [ 0 ]; - } ), - - "last": createPositionalPseudo( function( _matchIndexes, length ) { - return [ length - 1 ]; - } ), - - "eq": createPositionalPseudo( function( _matchIndexes, length, argument ) { - return [ argument < 0 ? argument + length : argument ]; - } ), - - "even": createPositionalPseudo( function( matchIndexes, length ) { - var i = 0; - for ( ; i < length; i += 2 ) { - matchIndexes.push( i ); - } - return matchIndexes; - } ), - - "odd": createPositionalPseudo( function( matchIndexes, length ) { - var i = 1; - for ( ; i < length; i += 2 ) { - matchIndexes.push( i ); - } - return matchIndexes; - } ), - - "lt": createPositionalPseudo( function( matchIndexes, length, argument ) { - var i = argument < 0 ? - argument + length : - argument > length ? - length : - argument; - for ( ; --i >= 0; ) { - matchIndexes.push( i ); - } - return matchIndexes; - } ), - - "gt": createPositionalPseudo( function( matchIndexes, length, argument ) { - var i = argument < 0 ? argument + length : argument; - for ( ; ++i < length; ) { - matchIndexes.push( i ); - } - return matchIndexes; - } ) - } -}; - -Expr.pseudos[ "nth" ] = Expr.pseudos[ "eq" ]; - -// Add button/input type pseudos -for ( i in { radio: true, checkbox: true, file: true, password: true, image: true } ) { - Expr.pseudos[ i ] = createInputPseudo( i ); -} -for ( i in { submit: true, reset: true } ) { - Expr.pseudos[ i ] = createButtonPseudo( i ); -} - -// Easy API for creating new setFilters -function setFilters() {} -setFilters.prototype = Expr.filters = Expr.pseudos; -Expr.setFilters = new setFilters(); - -tokenize = Sizzle.tokenize = function( selector, parseOnly ) { - var matched, match, tokens, type, - soFar, groups, preFilters, - cached = tokenCache[ selector + " " ]; - - if ( cached ) { - return parseOnly ? 0 : cached.slice( 0 ); - } - - soFar = selector; - groups = []; - preFilters = Expr.preFilter; - - while ( soFar ) { - - // Comma and first run - if ( !matched || ( match = rcomma.exec( soFar ) ) ) { - if ( match ) { - - // Don't consume trailing commas as valid - soFar = soFar.slice( match[ 0 ].length ) || soFar; - } - groups.push( ( tokens = [] ) ); - } - - matched = false; - - // Combinators - if ( ( match = rcombinators.exec( soFar ) ) ) { - matched = match.shift(); - tokens.push( { - value: matched, - - // Cast descendant combinators to space - type: match[ 0 ].replace( rtrim, " " ) - } ); - soFar = soFar.slice( matched.length ); - } - - // Filters - for ( type in Expr.filter ) { - if ( ( match = matchExpr[ type ].exec( soFar ) ) && ( !preFilters[ type ] || - ( match = preFilters[ type ]( match ) ) ) ) { - matched = match.shift(); - tokens.push( { - value: matched, - type: type, - matches: match - } ); - soFar = soFar.slice( matched.length ); - } - } - - if ( !matched ) { - break; - } - } - - // Return the length of the invalid excess - // if we're just parsing - // Otherwise, throw an error or return tokens - return parseOnly ? - soFar.length : - soFar ? - Sizzle.error( selector ) : - - // Cache the tokens - tokenCache( selector, groups ).slice( 0 ); -}; - -function toSelector( tokens ) { - var i = 0, - len = tokens.length, - selector = ""; - for ( ; i < len; i++ ) { - selector += tokens[ i ].value; - } - return selector; -} - -function addCombinator( matcher, combinator, base ) { - var dir = combinator.dir, - skip = combinator.next, - key = skip || dir, - checkNonElements = base && key === "parentNode", - doneName = done++; - - return combinator.first ? - - // Check against closest ancestor/preceding element - function( elem, context, xml ) { - while ( ( elem = elem[ dir ] ) ) { - if ( elem.nodeType === 1 || checkNonElements ) { - return matcher( elem, context, xml ); - } - } - return false; - } : - - // Check against all ancestor/preceding elements - function( elem, context, xml ) { - var oldCache, uniqueCache, outerCache, - newCache = [ dirruns, doneName ]; - - // We can't set arbitrary data on XML nodes, so they don't benefit from combinator caching - if ( xml ) { - while ( ( elem = elem[ dir ] ) ) { - if ( elem.nodeType === 1 || checkNonElements ) { - if ( matcher( elem, context, xml ) ) { - return true; - } - } - } - } else { - while ( ( elem = elem[ dir ] ) ) { - if ( elem.nodeType === 1 || checkNonElements ) { - outerCache = elem[ expando ] || ( elem[ expando ] = {} ); - - // Support: IE <9 only - // Defend against cloned attroperties (jQuery gh-1709) - uniqueCache = outerCache[ elem.uniqueID ] || - ( outerCache[ elem.uniqueID ] = {} ); - - if ( skip && skip === elem.nodeName.toLowerCase() ) { - elem = elem[ dir ] || elem; - } else if ( ( oldCache = uniqueCache[ key ] ) && - oldCache[ 0 ] === dirruns && oldCache[ 1 ] === doneName ) { - - // Assign to newCache so results back-propagate to previous elements - return ( newCache[ 2 ] = oldCache[ 2 ] ); - } else { - - // Reuse newcache so results back-propagate to previous elements - uniqueCache[ key ] = newCache; - - // A match means we're done; a fail means we have to keep checking - if ( ( newCache[ 2 ] = matcher( elem, context, xml ) ) ) { - return true; - } - } - } - } - } - return false; - }; -} - -function elementMatcher( matchers ) { - return matchers.length > 1 ? - function( elem, context, xml ) { - var i = matchers.length; - while ( i-- ) { - if ( !matchers[ i ]( elem, context, xml ) ) { - return false; - } - } - return true; - } : - matchers[ 0 ]; -} - -function multipleContexts( selector, contexts, results ) { - var i = 0, - len = contexts.length; - for ( ; i < len; i++ ) { - Sizzle( selector, contexts[ i ], results ); - } - return results; -} - -function condense( unmatched, map, filter, context, xml ) { - var elem, - newUnmatched = [], - i = 0, - len = unmatched.length, - mapped = map != null; - - for ( ; i < len; i++ ) { - if ( ( elem = unmatched[ i ] ) ) { - if ( !filter || filter( elem, context, xml ) ) { - newUnmatched.push( elem ); - if ( mapped ) { - map.push( i ); - } - } - } - } - - return newUnmatched; -} - -function setMatcher( preFilter, selector, matcher, postFilter, postFinder, postSelector ) { - if ( postFilter && !postFilter[ expando ] ) { - postFilter = setMatcher( postFilter ); - } - if ( postFinder && !postFinder[ expando ] ) { - postFinder = setMatcher( postFinder, postSelector ); - } - return markFunction( function( seed, results, context, xml ) { - var temp, i, elem, - preMap = [], - postMap = [], - preexisting = results.length, - - // Get initial elements from seed or context - elems = seed || multipleContexts( - selector || "*", - context.nodeType ? [ context ] : context, - [] - ), - - // Prefilter to get matcher input, preserving a map for seed-results synchronization - matcherIn = preFilter && ( seed || !selector ) ? - condense( elems, preMap, preFilter, context, xml ) : - elems, - - matcherOut = matcher ? - - // If we have a postFinder, or filtered seed, or non-seed postFilter or preexisting results, - postFinder || ( seed ? preFilter : preexisting || postFilter ) ? - - // ...intermediate processing is necessary - [] : - - // ...otherwise use results directly - results : - matcherIn; - - // Find primary matches - if ( matcher ) { - matcher( matcherIn, matcherOut, context, xml ); - } - - // Apply postFilter - if ( postFilter ) { - temp = condense( matcherOut, postMap ); - postFilter( temp, [], context, xml ); - - // Un-match failing elements by moving them back to matcherIn - i = temp.length; - while ( i-- ) { - if ( ( elem = temp[ i ] ) ) { - matcherOut[ postMap[ i ] ] = !( matcherIn[ postMap[ i ] ] = elem ); - } - } - } - - if ( seed ) { - if ( postFinder || preFilter ) { - if ( postFinder ) { - - // Get the final matcherOut by condensing this intermediate into postFinder contexts - temp = []; - i = matcherOut.length; - while ( i-- ) { - if ( ( elem = matcherOut[ i ] ) ) { - - // Restore matcherIn since elem is not yet a final match - temp.push( ( matcherIn[ i ] = elem ) ); - } - } - postFinder( null, ( matcherOut = [] ), temp, xml ); - } - - // Move matched elements from seed to results to keep them synchronized - i = matcherOut.length; - while ( i-- ) { - if ( ( elem = matcherOut[ i ] ) && - ( temp = postFinder ? indexOf( seed, elem ) : preMap[ i ] ) > -1 ) { - - seed[ temp ] = !( results[ temp ] = elem ); - } - } - } - - // Add elements to results, through postFinder if defined - } else { - matcherOut = condense( - matcherOut === results ? - matcherOut.splice( preexisting, matcherOut.length ) : - matcherOut - ); - if ( postFinder ) { - postFinder( null, results, matcherOut, xml ); - } else { - push.apply( results, matcherOut ); - } - } - } ); -} - -function matcherFromTokens( tokens ) { - var checkContext, matcher, j, - len = tokens.length, - leadingRelative = Expr.relative[ tokens[ 0 ].type ], - implicitRelative = leadingRelative || Expr.relative[ " " ], - i = leadingRelative ? 1 : 0, - - // The foundational matcher ensures that elements are reachable from top-level context(s) - matchContext = addCombinator( function( elem ) { - return elem === checkContext; - }, implicitRelative, true ), - matchAnyContext = addCombinator( function( elem ) { - return indexOf( checkContext, elem ) > -1; - }, implicitRelative, true ), - matchers = [ function( elem, context, xml ) { - var ret = ( !leadingRelative && ( xml || context !== outermostContext ) ) || ( - ( checkContext = context ).nodeType ? - matchContext( elem, context, xml ) : - matchAnyContext( elem, context, xml ) ); - - // Avoid hanging onto element (issue #299) - checkContext = null; - return ret; - } ]; - - for ( ; i < len; i++ ) { - if ( ( matcher = Expr.relative[ tokens[ i ].type ] ) ) { - matchers = [ addCombinator( elementMatcher( matchers ), matcher ) ]; - } else { - matcher = Expr.filter[ tokens[ i ].type ].apply( null, tokens[ i ].matches ); - - // Return special upon seeing a positional matcher - if ( matcher[ expando ] ) { - - // Find the next relative operator (if any) for proper handling - j = ++i; - for ( ; j < len; j++ ) { - if ( Expr.relative[ tokens[ j ].type ] ) { - break; - } - } - return setMatcher( - i > 1 && elementMatcher( matchers ), - i > 1 && toSelector( - - // If the preceding token was a descendant combinator, insert an implicit any-element `*` - tokens - .slice( 0, i - 1 ) - .concat( { value: tokens[ i - 2 ].type === " " ? "*" : "" } ) - ).replace( rtrim, "$1" ), - matcher, - i < j && matcherFromTokens( tokens.slice( i, j ) ), - j < len && matcherFromTokens( ( tokens = tokens.slice( j ) ) ), - j < len && toSelector( tokens ) - ); - } - matchers.push( matcher ); - } - } - - return elementMatcher( matchers ); -} - -function matcherFromGroupMatchers( elementMatchers, setMatchers ) { - var bySet = setMatchers.length > 0, - byElement = elementMatchers.length > 0, - superMatcher = function( seed, context, xml, results, outermost ) { - var elem, j, matcher, - matchedCount = 0, - i = "0", - unmatched = seed && [], - setMatched = [], - contextBackup = outermostContext, - - // We must always have either seed elements or outermost context - elems = seed || byElement && Expr.find[ "TAG" ]( "*", outermost ), - - // Use integer dirruns iff this is the outermost matcher - dirrunsUnique = ( dirruns += contextBackup == null ? 1 : Math.random() || 0.1 ), - len = elems.length; - - if ( outermost ) { - - // Support: IE 11+, Edge 17 - 18+ - // IE/Edge sometimes throw a "Permission denied" error when strict-comparing - // two documents; shallow comparisons work. - // eslint-disable-next-line eqeqeq - outermostContext = context == document || context || outermost; - } - - // Add elements passing elementMatchers directly to results - // Support: IE<9, Safari - // Tolerate NodeList properties (IE: "length"; Safari: ) matching elements by id - for ( ; i !== len && ( elem = elems[ i ] ) != null; i++ ) { - if ( byElement && elem ) { - j = 0; - - // Support: IE 11+, Edge 17 - 18+ - // IE/Edge sometimes throw a "Permission denied" error when strict-comparing - // two documents; shallow comparisons work. - // eslint-disable-next-line eqeqeq - if ( !context && elem.ownerDocument != document ) { - setDocument( elem ); - xml = !documentIsHTML; - } - while ( ( matcher = elementMatchers[ j++ ] ) ) { - if ( matcher( elem, context || document, xml ) ) { - results.push( elem ); - break; - } - } - if ( outermost ) { - dirruns = dirrunsUnique; - } - } - - // Track unmatched elements for set filters - if ( bySet ) { - - // They will have gone through all possible matchers - if ( ( elem = !matcher && elem ) ) { - matchedCount--; - } - - // Lengthen the array for every element, matched or not - if ( seed ) { - unmatched.push( elem ); - } - } - } - - // `i` is now the count of elements visited above, and adding it to `matchedCount` - // makes the latter nonnegative. - matchedCount += i; - - // Apply set filters to unmatched elements - // NOTE: This can be skipped if there are no unmatched elements (i.e., `matchedCount` - // equals `i`), unless we didn't visit _any_ elements in the above loop because we have - // no element matchers and no seed. - // Incrementing an initially-string "0" `i` allows `i` to remain a string only in that - // case, which will result in a "00" `matchedCount` that differs from `i` but is also - // numerically zero. - if ( bySet && i !== matchedCount ) { - j = 0; - while ( ( matcher = setMatchers[ j++ ] ) ) { - matcher( unmatched, setMatched, context, xml ); - } - - if ( seed ) { - - // Reintegrate element matches to eliminate the need for sorting - if ( matchedCount > 0 ) { - while ( i-- ) { - if ( !( unmatched[ i ] || setMatched[ i ] ) ) { - setMatched[ i ] = pop.call( results ); - } - } - } - - // Discard index placeholder values to get only actual matches - setMatched = condense( setMatched ); - } - - // Add matches to results - push.apply( results, setMatched ); - - // Seedless set matches succeeding multiple successful matchers stipulate sorting - if ( outermost && !seed && setMatched.length > 0 && - ( matchedCount + setMatchers.length ) > 1 ) { - - Sizzle.uniqueSort( results ); - } - } - - // Override manipulation of globals by nested matchers - if ( outermost ) { - dirruns = dirrunsUnique; - outermostContext = contextBackup; - } - - return unmatched; - }; - - return bySet ? - markFunction( superMatcher ) : - superMatcher; -} - -compile = Sizzle.compile = function( selector, match /* Internal Use Only */ ) { - var i, - setMatchers = [], - elementMatchers = [], - cached = compilerCache[ selector + " " ]; - - if ( !cached ) { - - // Generate a function of recursive functions that can be used to check each element - if ( !match ) { - match = tokenize( selector ); - } - i = match.length; - while ( i-- ) { - cached = matcherFromTokens( match[ i ] ); - if ( cached[ expando ] ) { - setMatchers.push( cached ); - } else { - elementMatchers.push( cached ); - } - } - - // Cache the compiled function - cached = compilerCache( - selector, - matcherFromGroupMatchers( elementMatchers, setMatchers ) - ); - - // Save selector and tokenization - cached.selector = selector; - } - return cached; -}; - -/** - * A low-level selection function that works with Sizzle's compiled - * selector functions - * @param {String|Function} selector A selector or a pre-compiled - * selector function built with Sizzle.compile - * @param {Element} context - * @param {Array} [results] - * @param {Array} [seed] A set of elements to match against - */ -select = Sizzle.select = function( selector, context, results, seed ) { - var i, tokens, token, type, find, - compiled = typeof selector === "function" && selector, - match = !seed && tokenize( ( selector = compiled.selector || selector ) ); - - results = results || []; - - // Try to minimize operations if there is only one selector in the list and no seed - // (the latter of which guarantees us context) - if ( match.length === 1 ) { - - // Reduce context if the leading compound selector is an ID - tokens = match[ 0 ] = match[ 0 ].slice( 0 ); - if ( tokens.length > 2 && ( token = tokens[ 0 ] ).type === "ID" && - context.nodeType === 9 && documentIsHTML && Expr.relative[ tokens[ 1 ].type ] ) { - - context = ( Expr.find[ "ID" ]( token.matches[ 0 ] - .replace( runescape, funescape ), context ) || [] )[ 0 ]; - if ( !context ) { - return results; - - // Precompiled matchers will still verify ancestry, so step up a level - } else if ( compiled ) { - context = context.parentNode; - } - - selector = selector.slice( tokens.shift().value.length ); - } - - // Fetch a seed set for right-to-left matching - i = matchExpr[ "needsContext" ].test( selector ) ? 0 : tokens.length; - while ( i-- ) { - token = tokens[ i ]; - - // Abort if we hit a combinator - if ( Expr.relative[ ( type = token.type ) ] ) { - break; - } - if ( ( find = Expr.find[ type ] ) ) { - - // Search, expanding context for leading sibling combinators - if ( ( seed = find( - token.matches[ 0 ].replace( runescape, funescape ), - rsibling.test( tokens[ 0 ].type ) && testContext( context.parentNode ) || - context - ) ) ) { - - // If seed is empty or no tokens remain, we can return early - tokens.splice( i, 1 ); - selector = seed.length && toSelector( tokens ); - if ( !selector ) { - push.apply( results, seed ); - return results; - } - - break; - } - } - } - } - - // Compile and execute a filtering function if one is not provided - // Provide `match` to avoid retokenization if we modified the selector above - ( compiled || compile( selector, match ) )( - seed, - context, - !documentIsHTML, - results, - !context || rsibling.test( selector ) && testContext( context.parentNode ) || context - ); - return results; -}; - -// One-time assignments - -// Sort stability -support.sortStable = expando.split( "" ).sort( sortOrder ).join( "" ) === expando; - -// Support: Chrome 14-35+ -// Always assume duplicates if they aren't passed to the comparison function -support.detectDuplicates = !!hasDuplicate; - -// Initialize against the default document -setDocument(); - -// Support: Webkit<537.32 - Safari 6.0.3/Chrome 25 (fixed in Chrome 27) -// Detached nodes confoundingly follow *each other* -support.sortDetached = assert( function( el ) { - - // Should return 1, but returns 4 (following) - return el.compareDocumentPosition( document.createElement( "fieldset" ) ) & 1; -} ); - -// Support: IE<8 -// Prevent attribute/property "interpolation" -// https://msdn.microsoft.com/en-us/library/ms536429%28VS.85%29.aspx -if ( !assert( function( el ) { - el.innerHTML = ""; - return el.firstChild.getAttribute( "href" ) === "#"; -} ) ) { - addHandle( "type|href|height|width", function( elem, name, isXML ) { - if ( !isXML ) { - return elem.getAttribute( name, name.toLowerCase() === "type" ? 1 : 2 ); - } - } ); -} - -// Support: IE<9 -// Use defaultValue in place of getAttribute("value") -if ( !support.attributes || !assert( function( el ) { - el.innerHTML = ""; - el.firstChild.setAttribute( "value", "" ); - return el.firstChild.getAttribute( "value" ) === ""; -} ) ) { - addHandle( "value", function( elem, _name, isXML ) { - if ( !isXML && elem.nodeName.toLowerCase() === "input" ) { - return elem.defaultValue; - } - } ); -} - -// Support: IE<9 -// Use getAttributeNode to fetch booleans when getAttribute lies -if ( !assert( function( el ) { - return el.getAttribute( "disabled" ) == null; -} ) ) { - addHandle( booleans, function( elem, name, isXML ) { - var val; - if ( !isXML ) { - return elem[ name ] === true ? name.toLowerCase() : - ( val = elem.getAttributeNode( name ) ) && val.specified ? - val.value : - null; - } - } ); -} - -return Sizzle; - -} )( window ); - - - -jQuery.find = Sizzle; -jQuery.expr = Sizzle.selectors; - -// Deprecated -jQuery.expr[ ":" ] = jQuery.expr.pseudos; -jQuery.uniqueSort = jQuery.unique = Sizzle.uniqueSort; -jQuery.text = Sizzle.getText; -jQuery.isXMLDoc = Sizzle.isXML; -jQuery.contains = Sizzle.contains; -jQuery.escapeSelector = Sizzle.escape; - - - - -var dir = function( elem, dir, until ) { - var matched = [], - truncate = until !== undefined; - - while ( ( elem = elem[ dir ] ) && elem.nodeType !== 9 ) { - if ( elem.nodeType === 1 ) { - if ( truncate && jQuery( elem ).is( until ) ) { - break; - } - matched.push( elem ); - } - } - return matched; -}; - - -var siblings = function( n, elem ) { - var matched = []; - - for ( ; n; n = n.nextSibling ) { - if ( n.nodeType === 1 && n !== elem ) { - matched.push( n ); - } - } - - return matched; -}; - - -var rneedsContext = jQuery.expr.match.needsContext; - - - -function nodeName( elem, name ) { - - return elem.nodeName && elem.nodeName.toLowerCase() === name.toLowerCase(); - -}; -var rsingleTag = ( /^<([a-z][^\/\0>:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i ); - - - -// Implement the identical functionality for filter and not -function winnow( elements, qualifier, not ) { - if ( isFunction( qualifier ) ) { - return jQuery.grep( elements, function( elem, i ) { - return !!qualifier.call( elem, i, elem ) !== not; - } ); - } - - // Single element - if ( qualifier.nodeType ) { - return jQuery.grep( elements, function( elem ) { - return ( elem === qualifier ) !== not; - } ); - } - - // Arraylike of elements (jQuery, arguments, Array) - if ( typeof qualifier !== "string" ) { - return jQuery.grep( elements, function( elem ) { - return ( indexOf.call( qualifier, elem ) > -1 ) !== not; - } ); - } - - // Filtered directly for both simple and complex selectors - return jQuery.filter( qualifier, elements, not ); -} - -jQuery.filter = function( expr, elems, not ) { - var elem = elems[ 0 ]; - - if ( not ) { - expr = ":not(" + expr + ")"; - } - - if ( elems.length === 1 && elem.nodeType === 1 ) { - return jQuery.find.matchesSelector( elem, expr ) ? [ elem ] : []; - } - - return jQuery.find.matches( expr, jQuery.grep( elems, function( elem ) { - return elem.nodeType === 1; - } ) ); -}; - -jQuery.fn.extend( { - find: function( selector ) { - var i, ret, - len = this.length, - self = this; - - if ( typeof selector !== "string" ) { - return this.pushStack( jQuery( selector ).filter( function() { - for ( i = 0; i < len; i++ ) { - if ( jQuery.contains( self[ i ], this ) ) { - return true; - } - } - } ) ); - } - - ret = this.pushStack( [] ); - - for ( i = 0; i < len; i++ ) { - jQuery.find( selector, self[ i ], ret ); - } - - return len > 1 ? jQuery.uniqueSort( ret ) : ret; - }, - filter: function( selector ) { - return this.pushStack( winnow( this, selector || [], false ) ); - }, - not: function( selector ) { - return this.pushStack( winnow( this, selector || [], true ) ); - }, - is: function( selector ) { - return !!winnow( - this, - - // If this is a positional/relative selector, check membership in the returned set - // so $("p:first").is("p:last") won't return true for a doc with two "p". - typeof selector === "string" && rneedsContext.test( selector ) ? - jQuery( selector ) : - selector || [], - false - ).length; - } -} ); - - -// Initialize a jQuery object - - -// A central reference to the root jQuery(document) -var rootjQuery, - - // A simple way to check for HTML strings - // Prioritize #id over to avoid XSS via location.hash (#9521) - // Strict HTML recognition (#11290: must start with <) - // Shortcut simple #id case for speed - rquickExpr = /^(?:\s*(<[\w\W]+>)[^>]*|#([\w-]+))$/, - - init = jQuery.fn.init = function( selector, context, root ) { - var match, elem; - - // HANDLE: $(""), $(null), $(undefined), $(false) - if ( !selector ) { - return this; - } - - // Method init() accepts an alternate rootjQuery - // so migrate can support jQuery.sub (gh-2101) - root = root || rootjQuery; - - // Handle HTML strings - if ( typeof selector === "string" ) { - if ( selector[ 0 ] === "<" && - selector[ selector.length - 1 ] === ">" && - selector.length >= 3 ) { - - // Assume that strings that start and end with <> are HTML and skip the regex check - match = [ null, selector, null ]; - - } else { - match = rquickExpr.exec( selector ); - } - - // Match html or make sure no context is specified for #id - if ( match && ( match[ 1 ] || !context ) ) { - - // HANDLE: $(html) -> $(array) - if ( match[ 1 ] ) { - context = context instanceof jQuery ? context[ 0 ] : context; - - // Option to run scripts is true for back-compat - // Intentionally let the error be thrown if parseHTML is not present - jQuery.merge( this, jQuery.parseHTML( - match[ 1 ], - context && context.nodeType ? context.ownerDocument || context : document, - true - ) ); - - // HANDLE: $(html, props) - if ( rsingleTag.test( match[ 1 ] ) && jQuery.isPlainObject( context ) ) { - for ( match in context ) { - - // Properties of context are called as methods if possible - if ( isFunction( this[ match ] ) ) { - this[ match ]( context[ match ] ); - - // ...and otherwise set as attributes - } else { - this.attr( match, context[ match ] ); - } - } - } - - return this; - - // HANDLE: $(#id) - } else { - elem = document.getElementById( match[ 2 ] ); - - if ( elem ) { - - // Inject the element directly into the jQuery object - this[ 0 ] = elem; - this.length = 1; - } - return this; - } - - // HANDLE: $(expr, $(...)) - } else if ( !context || context.jquery ) { - return ( context || root ).find( selector ); - - // HANDLE: $(expr, context) - // (which is just equivalent to: $(context).find(expr) - } else { - return this.constructor( context ).find( selector ); - } - - // HANDLE: $(DOMElement) - } else if ( selector.nodeType ) { - this[ 0 ] = selector; - this.length = 1; - return this; - - // HANDLE: $(function) - // Shortcut for document ready - } else if ( isFunction( selector ) ) { - return root.ready !== undefined ? - root.ready( selector ) : - - // Execute immediately if ready is not present - selector( jQuery ); - } - - return jQuery.makeArray( selector, this ); - }; - -// Give the init function the jQuery prototype for later instantiation -init.prototype = jQuery.fn; - -// Initialize central reference -rootjQuery = jQuery( document ); - - -var rparentsprev = /^(?:parents|prev(?:Until|All))/, - - // Methods guaranteed to produce a unique set when starting from a unique set - guaranteedUnique = { - children: true, - contents: true, - next: true, - prev: true - }; - -jQuery.fn.extend( { - has: function( target ) { - var targets = jQuery( target, this ), - l = targets.length; - - return this.filter( function() { - var i = 0; - for ( ; i < l; i++ ) { - if ( jQuery.contains( this, targets[ i ] ) ) { - return true; - } - } - } ); - }, - - closest: function( selectors, context ) { - var cur, - i = 0, - l = this.length, - matched = [], - targets = typeof selectors !== "string" && jQuery( selectors ); - - // Positional selectors never match, since there's no _selection_ context - if ( !rneedsContext.test( selectors ) ) { - for ( ; i < l; i++ ) { - for ( cur = this[ i ]; cur && cur !== context; cur = cur.parentNode ) { - - // Always skip document fragments - if ( cur.nodeType < 11 && ( targets ? - targets.index( cur ) > -1 : - - // Don't pass non-elements to Sizzle - cur.nodeType === 1 && - jQuery.find.matchesSelector( cur, selectors ) ) ) { - - matched.push( cur ); - break; - } - } - } - } - - return this.pushStack( matched.length > 1 ? jQuery.uniqueSort( matched ) : matched ); - }, - - // Determine the position of an element within the set - index: function( elem ) { - - // No argument, return index in parent - if ( !elem ) { - return ( this[ 0 ] && this[ 0 ].parentNode ) ? this.first().prevAll().length : -1; - } - - // Index in selector - if ( typeof elem === "string" ) { - return indexOf.call( jQuery( elem ), this[ 0 ] ); - } - - // Locate the position of the desired element - return indexOf.call( this, - - // If it receives a jQuery object, the first element is used - elem.jquery ? elem[ 0 ] : elem - ); - }, - - add: function( selector, context ) { - return this.pushStack( - jQuery.uniqueSort( - jQuery.merge( this.get(), jQuery( selector, context ) ) - ) - ); - }, - - addBack: function( selector ) { - return this.add( selector == null ? - this.prevObject : this.prevObject.filter( selector ) - ); - } -} ); - -function sibling( cur, dir ) { - while ( ( cur = cur[ dir ] ) && cur.nodeType !== 1 ) {} - return cur; -} - -jQuery.each( { - parent: function( elem ) { - var parent = elem.parentNode; - return parent && parent.nodeType !== 11 ? parent : null; - }, - parents: function( elem ) { - return dir( elem, "parentNode" ); - }, - parentsUntil: function( elem, _i, until ) { - return dir( elem, "parentNode", until ); - }, - next: function( elem ) { - return sibling( elem, "nextSibling" ); - }, - prev: function( elem ) { - return sibling( elem, "previousSibling" ); - }, - nextAll: function( elem ) { - return dir( elem, "nextSibling" ); - }, - prevAll: function( elem ) { - return dir( elem, "previousSibling" ); - }, - nextUntil: function( elem, _i, until ) { - return dir( elem, "nextSibling", until ); - }, - prevUntil: function( elem, _i, until ) { - return dir( elem, "previousSibling", until ); - }, - siblings: function( elem ) { - return siblings( ( elem.parentNode || {} ).firstChild, elem ); - }, - children: function( elem ) { - return siblings( elem.firstChild ); - }, - contents: function( elem ) { - if ( elem.contentDocument != null && - - // Support: IE 11+ - // elements with no `data` attribute has an object - // `contentDocument` with a `null` prototype. - getProto( elem.contentDocument ) ) { - - return elem.contentDocument; - } - - // Support: IE 9 - 11 only, iOS 7 only, Android Browser <=4.3 only - // Treat the template element as a regular one in browsers that - // don't support it. - if ( nodeName( elem, "template" ) ) { - elem = elem.content || elem; - } - - return jQuery.merge( [], elem.childNodes ); - } -}, function( name, fn ) { - jQuery.fn[ name ] = function( until, selector ) { - var matched = jQuery.map( this, fn, until ); - - if ( name.slice( -5 ) !== "Until" ) { - selector = until; - } - - if ( selector && typeof selector === "string" ) { - matched = jQuery.filter( selector, matched ); - } - - if ( this.length > 1 ) { - - // Remove duplicates - if ( !guaranteedUnique[ name ] ) { - jQuery.uniqueSort( matched ); - } - - // Reverse order for parents* and prev-derivatives - if ( rparentsprev.test( name ) ) { - matched.reverse(); - } - } - - return this.pushStack( matched ); - }; -} ); -var rnothtmlwhite = ( /[^\x20\t\r\n\f]+/g ); - - - -// Convert String-formatted options into Object-formatted ones -function createOptions( options ) { - var object = {}; - jQuery.each( options.match( rnothtmlwhite ) || [], function( _, flag ) { - object[ flag ] = true; - } ); - return object; -} - -/* - * Create a callback list using the following parameters: - * - * options: an optional list of space-separated options that will change how - * the callback list behaves or a more traditional option object - * - * By default a callback list will act like an event callback list and can be - * "fired" multiple times. - * - * Possible options: - * - * once: will ensure the callback list can only be fired once (like a Deferred) - * - * memory: will keep track of previous values and will call any callback added - * after the list has been fired right away with the latest "memorized" - * values (like a Deferred) - * - * unique: will ensure a callback can only be added once (no duplicate in the list) - * - * stopOnFalse: interrupt callings when a callback returns false - * - */ -jQuery.Callbacks = function( options ) { - - // Convert options from String-formatted to Object-formatted if needed - // (we check in cache first) - options = typeof options === "string" ? - createOptions( options ) : - jQuery.extend( {}, options ); - - var // Flag to know if list is currently firing - firing, - - // Last fire value for non-forgettable lists - memory, - - // Flag to know if list was already fired - fired, - - // Flag to prevent firing - locked, - - // Actual callback list - list = [], - - // Queue of execution data for repeatable lists - queue = [], - - // Index of currently firing callback (modified by add/remove as needed) - firingIndex = -1, - - // Fire callbacks - fire = function() { - - // Enforce single-firing - locked = locked || options.once; - - // Execute callbacks for all pending executions, - // respecting firingIndex overrides and runtime changes - fired = firing = true; - for ( ; queue.length; firingIndex = -1 ) { - memory = queue.shift(); - while ( ++firingIndex < list.length ) { - - // Run callback and check for early termination - if ( list[ firingIndex ].apply( memory[ 0 ], memory[ 1 ] ) === false && - options.stopOnFalse ) { - - // Jump to end and forget the data so .add doesn't re-fire - firingIndex = list.length; - memory = false; - } - } - } - - // Forget the data if we're done with it - if ( !options.memory ) { - memory = false; - } - - firing = false; - - // Clean up if we're done firing for good - if ( locked ) { - - // Keep an empty list if we have data for future add calls - if ( memory ) { - list = []; - - // Otherwise, this object is spent - } else { - list = ""; - } - } - }, - - // Actual Callbacks object - self = { - - // Add a callback or a collection of callbacks to the list - add: function() { - if ( list ) { - - // If we have memory from a past run, we should fire after adding - if ( memory && !firing ) { - firingIndex = list.length - 1; - queue.push( memory ); - } - - ( function add( args ) { - jQuery.each( args, function( _, arg ) { - if ( isFunction( arg ) ) { - if ( !options.unique || !self.has( arg ) ) { - list.push( arg ); - } - } else if ( arg && arg.length && toType( arg ) !== "string" ) { - - // Inspect recursively - add( arg ); - } - } ); - } )( arguments ); - - if ( memory && !firing ) { - fire(); - } - } - return this; - }, - - // Remove a callback from the list - remove: function() { - jQuery.each( arguments, function( _, arg ) { - var index; - while ( ( index = jQuery.inArray( arg, list, index ) ) > -1 ) { - list.splice( index, 1 ); - - // Handle firing indexes - if ( index <= firingIndex ) { - firingIndex--; - } - } - } ); - return this; - }, - - // Check if a given callback is in the list. - // If no argument is given, return whether or not list has callbacks attached. - has: function( fn ) { - return fn ? - jQuery.inArray( fn, list ) > -1 : - list.length > 0; - }, - - // Remove all callbacks from the list - empty: function() { - if ( list ) { - list = []; - } - return this; - }, - - // Disable .fire and .add - // Abort any current/pending executions - // Clear all callbacks and values - disable: function() { - locked = queue = []; - list = memory = ""; - return this; - }, - disabled: function() { - return !list; - }, - - // Disable .fire - // Also disable .add unless we have memory (since it would have no effect) - // Abort any pending executions - lock: function() { - locked = queue = []; - if ( !memory && !firing ) { - list = memory = ""; - } - return this; - }, - locked: function() { - return !!locked; - }, - - // Call all callbacks with the given context and arguments - fireWith: function( context, args ) { - if ( !locked ) { - args = args || []; - args = [ context, args.slice ? args.slice() : args ]; - queue.push( args ); - if ( !firing ) { - fire(); - } - } - return this; - }, - - // Call all the callbacks with the given arguments - fire: function() { - self.fireWith( this, arguments ); - return this; - }, - - // To know if the callbacks have already been called at least once - fired: function() { - return !!fired; - } - }; - - return self; -}; - - -function Identity( v ) { - return v; -} -function Thrower( ex ) { - throw ex; -} - -function adoptValue( value, resolve, reject, noValue ) { - var method; - - try { - - // Check for promise aspect first to privilege synchronous behavior - if ( value && isFunction( ( method = value.promise ) ) ) { - method.call( value ).done( resolve ).fail( reject ); - - // Other thenables - } else if ( value && isFunction( ( method = value.then ) ) ) { - method.call( value, resolve, reject ); - - // Other non-thenables - } else { - - // Control `resolve` arguments by letting Array#slice cast boolean `noValue` to integer: - // * false: [ value ].slice( 0 ) => resolve( value ) - // * true: [ value ].slice( 1 ) => resolve() - resolve.apply( undefined, [ value ].slice( noValue ) ); - } - - // For Promises/A+, convert exceptions into rejections - // Since jQuery.when doesn't unwrap thenables, we can skip the extra checks appearing in - // Deferred#then to conditionally suppress rejection. - } catch ( value ) { - - // Support: Android 4.0 only - // Strict mode functions invoked without .call/.apply get global-object context - reject.apply( undefined, [ value ] ); - } -} - -jQuery.extend( { - - Deferred: function( func ) { - var tuples = [ - - // action, add listener, callbacks, - // ... .then handlers, argument index, [final state] - [ "notify", "progress", jQuery.Callbacks( "memory" ), - jQuery.Callbacks( "memory" ), 2 ], - [ "resolve", "done", jQuery.Callbacks( "once memory" ), - jQuery.Callbacks( "once memory" ), 0, "resolved" ], - [ "reject", "fail", jQuery.Callbacks( "once memory" ), - jQuery.Callbacks( "once memory" ), 1, "rejected" ] - ], - state = "pending", - promise = { - state: function() { - return state; - }, - always: function() { - deferred.done( arguments ).fail( arguments ); - return this; - }, - "catch": function( fn ) { - return promise.then( null, fn ); - }, - - // Keep pipe for back-compat - pipe: function( /* fnDone, fnFail, fnProgress */ ) { - var fns = arguments; - - return jQuery.Deferred( function( newDefer ) { - jQuery.each( tuples, function( _i, tuple ) { - - // Map tuples (progress, done, fail) to arguments (done, fail, progress) - var fn = isFunction( fns[ tuple[ 4 ] ] ) && fns[ tuple[ 4 ] ]; - - // deferred.progress(function() { bind to newDefer or newDefer.notify }) - // deferred.done(function() { bind to newDefer or newDefer.resolve }) - // deferred.fail(function() { bind to newDefer or newDefer.reject }) - deferred[ tuple[ 1 ] ]( function() { - var returned = fn && fn.apply( this, arguments ); - if ( returned && isFunction( returned.promise ) ) { - returned.promise() - .progress( newDefer.notify ) - .done( newDefer.resolve ) - .fail( newDefer.reject ); - } else { - newDefer[ tuple[ 0 ] + "With" ]( - this, - fn ? [ returned ] : arguments - ); - } - } ); - } ); - fns = null; - } ).promise(); - }, - then: function( onFulfilled, onRejected, onProgress ) { - var maxDepth = 0; - function resolve( depth, deferred, handler, special ) { - return function() { - var that = this, - args = arguments, - mightThrow = function() { - var returned, then; - - // Support: Promises/A+ section 2.3.3.3.3 - // https://promisesaplus.com/#point-59 - // Ignore double-resolution attempts - if ( depth < maxDepth ) { - return; - } - - returned = handler.apply( that, args ); - - // Support: Promises/A+ section 2.3.1 - // https://promisesaplus.com/#point-48 - if ( returned === deferred.promise() ) { - throw new TypeError( "Thenable self-resolution" ); - } - - // Support: Promises/A+ sections 2.3.3.1, 3.5 - // https://promisesaplus.com/#point-54 - // https://promisesaplus.com/#point-75 - // Retrieve `then` only once - then = returned && - - // Support: Promises/A+ section 2.3.4 - // https://promisesaplus.com/#point-64 - // Only check objects and functions for thenability - ( typeof returned === "object" || - typeof returned === "function" ) && - returned.then; - - // Handle a returned thenable - if ( isFunction( then ) ) { - - // Special processors (notify) just wait for resolution - if ( special ) { - then.call( - returned, - resolve( maxDepth, deferred, Identity, special ), - resolve( maxDepth, deferred, Thrower, special ) - ); - - // Normal processors (resolve) also hook into progress - } else { - - // ...and disregard older resolution values - maxDepth++; - - then.call( - returned, - resolve( maxDepth, deferred, Identity, special ), - resolve( maxDepth, deferred, Thrower, special ), - resolve( maxDepth, deferred, Identity, - deferred.notifyWith ) - ); - } - - // Handle all other returned values - } else { - - // Only substitute handlers pass on context - // and multiple values (non-spec behavior) - if ( handler !== Identity ) { - that = undefined; - args = [ returned ]; - } - - // Process the value(s) - // Default process is resolve - ( special || deferred.resolveWith )( that, args ); - } - }, - - // Only normal processors (resolve) catch and reject exceptions - process = special ? - mightThrow : - function() { - try { - mightThrow(); - } catch ( e ) { - - if ( jQuery.Deferred.exceptionHook ) { - jQuery.Deferred.exceptionHook( e, - process.stackTrace ); - } - - // Support: Promises/A+ section 2.3.3.3.4.1 - // https://promisesaplus.com/#point-61 - // Ignore post-resolution exceptions - if ( depth + 1 >= maxDepth ) { - - // Only substitute handlers pass on context - // and multiple values (non-spec behavior) - if ( handler !== Thrower ) { - that = undefined; - args = [ e ]; - } - - deferred.rejectWith( that, args ); - } - } - }; - - // Support: Promises/A+ section 2.3.3.3.1 - // https://promisesaplus.com/#point-57 - // Re-resolve promises immediately to dodge false rejection from - // subsequent errors - if ( depth ) { - process(); - } else { - - // Call an optional hook to record the stack, in case of exception - // since it's otherwise lost when execution goes async - if ( jQuery.Deferred.getStackHook ) { - process.stackTrace = jQuery.Deferred.getStackHook(); - } - window.setTimeout( process ); - } - }; - } - - return jQuery.Deferred( function( newDefer ) { - - // progress_handlers.add( ... ) - tuples[ 0 ][ 3 ].add( - resolve( - 0, - newDefer, - isFunction( onProgress ) ? - onProgress : - Identity, - newDefer.notifyWith - ) - ); - - // fulfilled_handlers.add( ... ) - tuples[ 1 ][ 3 ].add( - resolve( - 0, - newDefer, - isFunction( onFulfilled ) ? - onFulfilled : - Identity - ) - ); - - // rejected_handlers.add( ... ) - tuples[ 2 ][ 3 ].add( - resolve( - 0, - newDefer, - isFunction( onRejected ) ? - onRejected : - Thrower - ) - ); - } ).promise(); - }, - - // Get a promise for this deferred - // If obj is provided, the promise aspect is added to the object - promise: function( obj ) { - return obj != null ? jQuery.extend( obj, promise ) : promise; - } - }, - deferred = {}; - - // Add list-specific methods - jQuery.each( tuples, function( i, tuple ) { - var list = tuple[ 2 ], - stateString = tuple[ 5 ]; - - // promise.progress = list.add - // promise.done = list.add - // promise.fail = list.add - promise[ tuple[ 1 ] ] = list.add; - - // Handle state - if ( stateString ) { - list.add( - function() { - - // state = "resolved" (i.e., fulfilled) - // state = "rejected" - state = stateString; - }, - - // rejected_callbacks.disable - // fulfilled_callbacks.disable - tuples[ 3 - i ][ 2 ].disable, - - // rejected_handlers.disable - // fulfilled_handlers.disable - tuples[ 3 - i ][ 3 ].disable, - - // progress_callbacks.lock - tuples[ 0 ][ 2 ].lock, - - // progress_handlers.lock - tuples[ 0 ][ 3 ].lock - ); - } - - // progress_handlers.fire - // fulfilled_handlers.fire - // rejected_handlers.fire - list.add( tuple[ 3 ].fire ); - - // deferred.notify = function() { deferred.notifyWith(...) } - // deferred.resolve = function() { deferred.resolveWith(...) } - // deferred.reject = function() { deferred.rejectWith(...) } - deferred[ tuple[ 0 ] ] = function() { - deferred[ tuple[ 0 ] + "With" ]( this === deferred ? undefined : this, arguments ); - return this; - }; - - // deferred.notifyWith = list.fireWith - // deferred.resolveWith = list.fireWith - // deferred.rejectWith = list.fireWith - deferred[ tuple[ 0 ] + "With" ] = list.fireWith; - } ); - - // Make the deferred a promise - promise.promise( deferred ); - - // Call given func if any - if ( func ) { - func.call( deferred, deferred ); - } - - // All done! - return deferred; - }, - - // Deferred helper - when: function( singleValue ) { - var - - // count of uncompleted subordinates - remaining = arguments.length, - - // count of unprocessed arguments - i = remaining, - - // subordinate fulfillment data - resolveContexts = Array( i ), - resolveValues = slice.call( arguments ), - - // the master Deferred - master = jQuery.Deferred(), - - // subordinate callback factory - updateFunc = function( i ) { - return function( value ) { - resolveContexts[ i ] = this; - resolveValues[ i ] = arguments.length > 1 ? slice.call( arguments ) : value; - if ( !( --remaining ) ) { - master.resolveWith( resolveContexts, resolveValues ); - } - }; - }; - - // Single- and empty arguments are adopted like Promise.resolve - if ( remaining <= 1 ) { - adoptValue( singleValue, master.done( updateFunc( i ) ).resolve, master.reject, - !remaining ); - - // Use .then() to unwrap secondary thenables (cf. gh-3000) - if ( master.state() === "pending" || - isFunction( resolveValues[ i ] && resolveValues[ i ].then ) ) { - - return master.then(); - } - } - - // Multiple arguments are aggregated like Promise.all array elements - while ( i-- ) { - adoptValue( resolveValues[ i ], updateFunc( i ), master.reject ); - } - - return master.promise(); - } -} ); - - -// These usually indicate a programmer mistake during development, -// warn about them ASAP rather than swallowing them by default. -var rerrorNames = /^(Eval|Internal|Range|Reference|Syntax|Type|URI)Error$/; - -jQuery.Deferred.exceptionHook = function( error, stack ) { - - // Support: IE 8 - 9 only - // Console exists when dev tools are open, which can happen at any time - if ( window.console && window.console.warn && error && rerrorNames.test( error.name ) ) { - window.console.warn( "jQuery.Deferred exception: " + error.message, error.stack, stack ); - } -}; - - - - -jQuery.readyException = function( error ) { - window.setTimeout( function() { - throw error; - } ); -}; - - - - -// The deferred used on DOM ready -var readyList = jQuery.Deferred(); - -jQuery.fn.ready = function( fn ) { - - readyList - .then( fn ) - - // Wrap jQuery.readyException in a function so that the lookup - // happens at the time of error handling instead of callback - // registration. - .catch( function( error ) { - jQuery.readyException( error ); - } ); - - return this; -}; - -jQuery.extend( { - - // Is the DOM ready to be used? Set to true once it occurs. - isReady: false, - - // A counter to track how many items to wait for before - // the ready event fires. See #6781 - readyWait: 1, - - // Handle when the DOM is ready - ready: function( wait ) { - - // Abort if there are pending holds or we're already ready - if ( wait === true ? --jQuery.readyWait : jQuery.isReady ) { - return; - } - - // Remember that the DOM is ready - jQuery.isReady = true; - - // If a normal DOM Ready event fired, decrement, and wait if need be - if ( wait !== true && --jQuery.readyWait > 0 ) { - return; - } - - // If there are functions bound, to execute - readyList.resolveWith( document, [ jQuery ] ); - } -} ); - -jQuery.ready.then = readyList.then; - -// The ready event handler and self cleanup method -function completed() { - document.removeEventListener( "DOMContentLoaded", completed ); - window.removeEventListener( "load", completed ); - jQuery.ready(); -} - -// Catch cases where $(document).ready() is called -// after the browser event has already occurred. -// Support: IE <=9 - 10 only -// Older IE sometimes signals "interactive" too soon -if ( document.readyState === "complete" || - ( document.readyState !== "loading" && !document.documentElement.doScroll ) ) { - - // Handle it asynchronously to allow scripts the opportunity to delay ready - window.setTimeout( jQuery.ready ); - -} else { - - // Use the handy event callback - document.addEventListener( "DOMContentLoaded", completed ); - - // A fallback to window.onload, that will always work - window.addEventListener( "load", completed ); -} - - - - -// Multifunctional method to get and set values of a collection -// The value/s can optionally be executed if it's a function -var access = function( elems, fn, key, value, chainable, emptyGet, raw ) { - var i = 0, - len = elems.length, - bulk = key == null; - - // Sets many values - if ( toType( key ) === "object" ) { - chainable = true; - for ( i in key ) { - access( elems, fn, i, key[ i ], true, emptyGet, raw ); - } - - // Sets one value - } else if ( value !== undefined ) { - chainable = true; - - if ( !isFunction( value ) ) { - raw = true; - } - - if ( bulk ) { - - // Bulk operations run against the entire set - if ( raw ) { - fn.call( elems, value ); - fn = null; - - // ...except when executing function values - } else { - bulk = fn; - fn = function( elem, _key, value ) { - return bulk.call( jQuery( elem ), value ); - }; - } - } - - if ( fn ) { - for ( ; i < len; i++ ) { - fn( - elems[ i ], key, raw ? - value : - value.call( elems[ i ], i, fn( elems[ i ], key ) ) - ); - } - } - } - - if ( chainable ) { - return elems; - } - - // Gets - if ( bulk ) { - return fn.call( elems ); - } - - return len ? fn( elems[ 0 ], key ) : emptyGet; -}; - - -// Matches dashed string for camelizing -var rmsPrefix = /^-ms-/, - rdashAlpha = /-([a-z])/g; - -// Used by camelCase as callback to replace() -function fcamelCase( _all, letter ) { - return letter.toUpperCase(); -} - -// Convert dashed to camelCase; used by the css and data modules -// Support: IE <=9 - 11, Edge 12 - 15 -// Microsoft forgot to hump their vendor prefix (#9572) -function camelCase( string ) { - return string.replace( rmsPrefix, "ms-" ).replace( rdashAlpha, fcamelCase ); -} -var acceptData = function( owner ) { - - // Accepts only: - // - Node - // - Node.ELEMENT_NODE - // - Node.DOCUMENT_NODE - // - Object - // - Any - return owner.nodeType === 1 || owner.nodeType === 9 || !( +owner.nodeType ); -}; - - - - -function Data() { - this.expando = jQuery.expando + Data.uid++; -} - -Data.uid = 1; - -Data.prototype = { - - cache: function( owner ) { - - // Check if the owner object already has a cache - var value = owner[ this.expando ]; - - // If not, create one - if ( !value ) { - value = {}; - - // We can accept data for non-element nodes in modern browsers, - // but we should not, see #8335. - // Always return an empty object. - if ( acceptData( owner ) ) { - - // If it is a node unlikely to be stringify-ed or looped over - // use plain assignment - if ( owner.nodeType ) { - owner[ this.expando ] = value; - - // Otherwise secure it in a non-enumerable property - // configurable must be true to allow the property to be - // deleted when data is removed - } else { - Object.defineProperty( owner, this.expando, { - value: value, - configurable: true - } ); - } - } - } - - return value; - }, - set: function( owner, data, value ) { - var prop, - cache = this.cache( owner ); - - // Handle: [ owner, key, value ] args - // Always use camelCase key (gh-2257) - if ( typeof data === "string" ) { - cache[ camelCase( data ) ] = value; - - // Handle: [ owner, { properties } ] args - } else { - - // Copy the properties one-by-one to the cache object - for ( prop in data ) { - cache[ camelCase( prop ) ] = data[ prop ]; - } - } - return cache; - }, - get: function( owner, key ) { - return key === undefined ? - this.cache( owner ) : - - // Always use camelCase key (gh-2257) - owner[ this.expando ] && owner[ this.expando ][ camelCase( key ) ]; - }, - access: function( owner, key, value ) { - - // In cases where either: - // - // 1. No key was specified - // 2. A string key was specified, but no value provided - // - // Take the "read" path and allow the get method to determine - // which value to return, respectively either: - // - // 1. The entire cache object - // 2. The data stored at the key - // - if ( key === undefined || - ( ( key && typeof key === "string" ) && value === undefined ) ) { - - return this.get( owner, key ); - } - - // When the key is not a string, or both a key and value - // are specified, set or extend (existing objects) with either: - // - // 1. An object of properties - // 2. A key and value - // - this.set( owner, key, value ); - - // Since the "set" path can have two possible entry points - // return the expected data based on which path was taken[*] - return value !== undefined ? value : key; - }, - remove: function( owner, key ) { - var i, - cache = owner[ this.expando ]; - - if ( cache === undefined ) { - return; - } - - if ( key !== undefined ) { - - // Support array or space separated string of keys - if ( Array.isArray( key ) ) { - - // If key is an array of keys... - // We always set camelCase keys, so remove that. - key = key.map( camelCase ); - } else { - key = camelCase( key ); - - // If a key with the spaces exists, use it. - // Otherwise, create an array by matching non-whitespace - key = key in cache ? - [ key ] : - ( key.match( rnothtmlwhite ) || [] ); - } - - i = key.length; - - while ( i-- ) { - delete cache[ key[ i ] ]; - } - } - - // Remove the expando if there's no more data - if ( key === undefined || jQuery.isEmptyObject( cache ) ) { - - // Support: Chrome <=35 - 45 - // Webkit & Blink performance suffers when deleting properties - // from DOM nodes, so set to undefined instead - // https://bugs.chromium.org/p/chromium/issues/detail?id=378607 (bug restricted) - if ( owner.nodeType ) { - owner[ this.expando ] = undefined; - } else { - delete owner[ this.expando ]; - } - } - }, - hasData: function( owner ) { - var cache = owner[ this.expando ]; - return cache !== undefined && !jQuery.isEmptyObject( cache ); - } -}; -var dataPriv = new Data(); - -var dataUser = new Data(); - - - -// Implementation Summary -// -// 1. Enforce API surface and semantic compatibility with 1.9.x branch -// 2. Improve the module's maintainability by reducing the storage -// paths to a single mechanism. -// 3. Use the same single mechanism to support "private" and "user" data. -// 4. _Never_ expose "private" data to user code (TODO: Drop _data, _removeData) -// 5. Avoid exposing implementation details on user objects (eg. expando properties) -// 6. Provide a clear path for implementation upgrade to WeakMap in 2014 - -var rbrace = /^(?:\{[\w\W]*\}|\[[\w\W]*\])$/, - rmultiDash = /[A-Z]/g; - -function getData( data ) { - if ( data === "true" ) { - return true; - } - - if ( data === "false" ) { - return false; - } - - if ( data === "null" ) { - return null; - } - - // Only convert to a number if it doesn't change the string - if ( data === +data + "" ) { - return +data; - } - - if ( rbrace.test( data ) ) { - return JSON.parse( data ); - } - - return data; -} - -function dataAttr( elem, key, data ) { - var name; - - // If nothing was found internally, try to fetch any - // data from the HTML5 data-* attribute - if ( data === undefined && elem.nodeType === 1 ) { - name = "data-" + key.replace( rmultiDash, "-$&" ).toLowerCase(); - data = elem.getAttribute( name ); - - if ( typeof data === "string" ) { - try { - data = getData( data ); - } catch ( e ) {} - - // Make sure we set the data so it isn't changed later - dataUser.set( elem, key, data ); - } else { - data = undefined; - } - } - return data; -} - -jQuery.extend( { - hasData: function( elem ) { - return dataUser.hasData( elem ) || dataPriv.hasData( elem ); - }, - - data: function( elem, name, data ) { - return dataUser.access( elem, name, data ); - }, - - removeData: function( elem, name ) { - dataUser.remove( elem, name ); - }, - - // TODO: Now that all calls to _data and _removeData have been replaced - // with direct calls to dataPriv methods, these can be deprecated. - _data: function( elem, name, data ) { - return dataPriv.access( elem, name, data ); - }, - - _removeData: function( elem, name ) { - dataPriv.remove( elem, name ); - } -} ); - -jQuery.fn.extend( { - data: function( key, value ) { - var i, name, data, - elem = this[ 0 ], - attrs = elem && elem.attributes; - - // Gets all values - if ( key === undefined ) { - if ( this.length ) { - data = dataUser.get( elem ); - - if ( elem.nodeType === 1 && !dataPriv.get( elem, "hasDataAttrs" ) ) { - i = attrs.length; - while ( i-- ) { - - // Support: IE 11 only - // The attrs elements can be null (#14894) - if ( attrs[ i ] ) { - name = attrs[ i ].name; - if ( name.indexOf( "data-" ) === 0 ) { - name = camelCase( name.slice( 5 ) ); - dataAttr( elem, name, data[ name ] ); - } - } - } - dataPriv.set( elem, "hasDataAttrs", true ); - } - } - - return data; - } - - // Sets multiple values - if ( typeof key === "object" ) { - return this.each( function() { - dataUser.set( this, key ); - } ); - } - - return access( this, function( value ) { - var data; - - // The calling jQuery object (element matches) is not empty - // (and therefore has an element appears at this[ 0 ]) and the - // `value` parameter was not undefined. An empty jQuery object - // will result in `undefined` for elem = this[ 0 ] which will - // throw an exception if an attempt to read a data cache is made. - if ( elem && value === undefined ) { - - // Attempt to get data from the cache - // The key will always be camelCased in Data - data = dataUser.get( elem, key ); - if ( data !== undefined ) { - return data; - } - - // Attempt to "discover" the data in - // HTML5 custom data-* attrs - data = dataAttr( elem, key ); - if ( data !== undefined ) { - return data; - } - - // We tried really hard, but the data doesn't exist. - return; - } - - // Set the data... - this.each( function() { - - // We always store the camelCased key - dataUser.set( this, key, value ); - } ); - }, null, value, arguments.length > 1, null, true ); - }, - - removeData: function( key ) { - return this.each( function() { - dataUser.remove( this, key ); - } ); - } -} ); - - -jQuery.extend( { - queue: function( elem, type, data ) { - var queue; - - if ( elem ) { - type = ( type || "fx" ) + "queue"; - queue = dataPriv.get( elem, type ); - - // Speed up dequeue by getting out quickly if this is just a lookup - if ( data ) { - if ( !queue || Array.isArray( data ) ) { - queue = dataPriv.access( elem, type, jQuery.makeArray( data ) ); - } else { - queue.push( data ); - } - } - return queue || []; - } - }, - - dequeue: function( elem, type ) { - type = type || "fx"; - - var queue = jQuery.queue( elem, type ), - startLength = queue.length, - fn = queue.shift(), - hooks = jQuery._queueHooks( elem, type ), - next = function() { - jQuery.dequeue( elem, type ); - }; - - // If the fx queue is dequeued, always remove the progress sentinel - if ( fn === "inprogress" ) { - fn = queue.shift(); - startLength--; - } - - if ( fn ) { - - // Add a progress sentinel to prevent the fx queue from being - // automatically dequeued - if ( type === "fx" ) { - queue.unshift( "inprogress" ); - } - - // Clear up the last queue stop function - delete hooks.stop; - fn.call( elem, next, hooks ); - } - - if ( !startLength && hooks ) { - hooks.empty.fire(); - } - }, - - // Not public - generate a queueHooks object, or return the current one - _queueHooks: function( elem, type ) { - var key = type + "queueHooks"; - return dataPriv.get( elem, key ) || dataPriv.access( elem, key, { - empty: jQuery.Callbacks( "once memory" ).add( function() { - dataPriv.remove( elem, [ type + "queue", key ] ); - } ) - } ); - } -} ); - -jQuery.fn.extend( { - queue: function( type, data ) { - var setter = 2; - - if ( typeof type !== "string" ) { - data = type; - type = "fx"; - setter--; - } - - if ( arguments.length < setter ) { - return jQuery.queue( this[ 0 ], type ); - } - - return data === undefined ? - this : - this.each( function() { - var queue = jQuery.queue( this, type, data ); - - // Ensure a hooks for this queue - jQuery._queueHooks( this, type ); - - if ( type === "fx" && queue[ 0 ] !== "inprogress" ) { - jQuery.dequeue( this, type ); - } - } ); - }, - dequeue: function( type ) { - return this.each( function() { - jQuery.dequeue( this, type ); - } ); - }, - clearQueue: function( type ) { - return this.queue( type || "fx", [] ); - }, - - // Get a promise resolved when queues of a certain type - // are emptied (fx is the type by default) - promise: function( type, obj ) { - var tmp, - count = 1, - defer = jQuery.Deferred(), - elements = this, - i = this.length, - resolve = function() { - if ( !( --count ) ) { - defer.resolveWith( elements, [ elements ] ); - } - }; - - if ( typeof type !== "string" ) { - obj = type; - type = undefined; - } - type = type || "fx"; - - while ( i-- ) { - tmp = dataPriv.get( elements[ i ], type + "queueHooks" ); - if ( tmp && tmp.empty ) { - count++; - tmp.empty.add( resolve ); - } - } - resolve(); - return defer.promise( obj ); - } -} ); -var pnum = ( /[+-]?(?:\d*\.|)\d+(?:[eE][+-]?\d+|)/ ).source; - -var rcssNum = new RegExp( "^(?:([+-])=|)(" + pnum + ")([a-z%]*)$", "i" ); - - -var cssExpand = [ "Top", "Right", "Bottom", "Left" ]; - -var documentElement = document.documentElement; - - - - var isAttached = function( elem ) { - return jQuery.contains( elem.ownerDocument, elem ); - }, - composed = { composed: true }; - - // Support: IE 9 - 11+, Edge 12 - 18+, iOS 10.0 - 10.2 only - // Check attachment across shadow DOM boundaries when possible (gh-3504) - // Support: iOS 10.0-10.2 only - // Early iOS 10 versions support `attachShadow` but not `getRootNode`, - // leading to errors. We need to check for `getRootNode`. - if ( documentElement.getRootNode ) { - isAttached = function( elem ) { - return jQuery.contains( elem.ownerDocument, elem ) || - elem.getRootNode( composed ) === elem.ownerDocument; - }; - } -var isHiddenWithinTree = function( elem, el ) { - - // isHiddenWithinTree might be called from jQuery#filter function; - // in that case, element will be second argument - elem = el || elem; - - // Inline style trumps all - return elem.style.display === "none" || - elem.style.display === "" && - - // Otherwise, check computed style - // Support: Firefox <=43 - 45 - // Disconnected elements can have computed display: none, so first confirm that elem is - // in the document. - isAttached( elem ) && - - jQuery.css( elem, "display" ) === "none"; - }; - - - -function adjustCSS( elem, prop, valueParts, tween ) { - var adjusted, scale, - maxIterations = 20, - currentValue = tween ? - function() { - return tween.cur(); - } : - function() { - return jQuery.css( elem, prop, "" ); - }, - initial = currentValue(), - unit = valueParts && valueParts[ 3 ] || ( jQuery.cssNumber[ prop ] ? "" : "px" ), - - // Starting value computation is required for potential unit mismatches - initialInUnit = elem.nodeType && - ( jQuery.cssNumber[ prop ] || unit !== "px" && +initial ) && - rcssNum.exec( jQuery.css( elem, prop ) ); - - if ( initialInUnit && initialInUnit[ 3 ] !== unit ) { - - // Support: Firefox <=54 - // Halve the iteration target value to prevent interference from CSS upper bounds (gh-2144) - initial = initial / 2; - - // Trust units reported by jQuery.css - unit = unit || initialInUnit[ 3 ]; - - // Iteratively approximate from a nonzero starting point - initialInUnit = +initial || 1; - - while ( maxIterations-- ) { - - // Evaluate and update our best guess (doubling guesses that zero out). - // Finish if the scale equals or crosses 1 (making the old*new product non-positive). - jQuery.style( elem, prop, initialInUnit + unit ); - if ( ( 1 - scale ) * ( 1 - ( scale = currentValue() / initial || 0.5 ) ) <= 0 ) { - maxIterations = 0; - } - initialInUnit = initialInUnit / scale; - - } - - initialInUnit = initialInUnit * 2; - jQuery.style( elem, prop, initialInUnit + unit ); - - // Make sure we update the tween properties later on - valueParts = valueParts || []; - } - - if ( valueParts ) { - initialInUnit = +initialInUnit || +initial || 0; - - // Apply relative offset (+=/-=) if specified - adjusted = valueParts[ 1 ] ? - initialInUnit + ( valueParts[ 1 ] + 1 ) * valueParts[ 2 ] : - +valueParts[ 2 ]; - if ( tween ) { - tween.unit = unit; - tween.start = initialInUnit; - tween.end = adjusted; - } - } - return adjusted; -} - - -var defaultDisplayMap = {}; - -function getDefaultDisplay( elem ) { - var temp, - doc = elem.ownerDocument, - nodeName = elem.nodeName, - display = defaultDisplayMap[ nodeName ]; - - if ( display ) { - return display; - } - - temp = doc.body.appendChild( doc.createElement( nodeName ) ); - display = jQuery.css( temp, "display" ); - - temp.parentNode.removeChild( temp ); - - if ( display === "none" ) { - display = "block"; - } - defaultDisplayMap[ nodeName ] = display; - - return display; -} - -function showHide( elements, show ) { - var display, elem, - values = [], - index = 0, - length = elements.length; - - // Determine new display value for elements that need to change - for ( ; index < length; index++ ) { - elem = elements[ index ]; - if ( !elem.style ) { - continue; - } - - display = elem.style.display; - if ( show ) { - - // Since we force visibility upon cascade-hidden elements, an immediate (and slow) - // check is required in this first loop unless we have a nonempty display value (either - // inline or about-to-be-restored) - if ( display === "none" ) { - values[ index ] = dataPriv.get( elem, "display" ) || null; - if ( !values[ index ] ) { - elem.style.display = ""; - } - } - if ( elem.style.display === "" && isHiddenWithinTree( elem ) ) { - values[ index ] = getDefaultDisplay( elem ); - } - } else { - if ( display !== "none" ) { - values[ index ] = "none"; - - // Remember what we're overwriting - dataPriv.set( elem, "display", display ); - } - } - } - - // Set the display of the elements in a second loop to avoid constant reflow - for ( index = 0; index < length; index++ ) { - if ( values[ index ] != null ) { - elements[ index ].style.display = values[ index ]; - } - } - - return elements; -} - -jQuery.fn.extend( { - show: function() { - return showHide( this, true ); - }, - hide: function() { - return showHide( this ); - }, - toggle: function( state ) { - if ( typeof state === "boolean" ) { - return state ? this.show() : this.hide(); - } - - return this.each( function() { - if ( isHiddenWithinTree( this ) ) { - jQuery( this ).show(); - } else { - jQuery( this ).hide(); - } - } ); - } -} ); -var rcheckableType = ( /^(?:checkbox|radio)$/i ); - -var rtagName = ( /<([a-z][^\/\0>\x20\t\r\n\f]*)/i ); - -var rscriptType = ( /^$|^module$|\/(?:java|ecma)script/i ); - - - -( function() { - var fragment = document.createDocumentFragment(), - div = fragment.appendChild( document.createElement( "div" ) ), - input = document.createElement( "input" ); - - // Support: Android 4.0 - 4.3 only - // Check state lost if the name is set (#11217) - // Support: Windows Web Apps (WWA) - // `name` and `type` must use .setAttribute for WWA (#14901) - input.setAttribute( "type", "radio" ); - input.setAttribute( "checked", "checked" ); - input.setAttribute( "name", "t" ); - - div.appendChild( input ); - - // Support: Android <=4.1 only - // Older WebKit doesn't clone checked state correctly in fragments - support.checkClone = div.cloneNode( true ).cloneNode( true ).lastChild.checked; - - // Support: IE <=11 only - // Make sure textarea (and checkbox) defaultValue is properly cloned - div.innerHTML = ""; - support.noCloneChecked = !!div.cloneNode( true ).lastChild.defaultValue; - - // Support: IE <=9 only - // IE <=9 replaces "; - support.option = !!div.lastChild; -} )(); - - -// We have to close these tags to support XHTML (#13200) -var wrapMap = { - - // XHTML parsers do not magically insert elements in the - // same way that tag soup parsers do. So we cannot shorten - // this by omitting or other required elements. - thead: [ 1, "", "
" ], - col: [ 2, "", "
" ], - tr: [ 2, "", "
" ], - td: [ 3, "", "
" ], - - _default: [ 0, "", "" ] -}; - -wrapMap.tbody = wrapMap.tfoot = wrapMap.colgroup = wrapMap.caption = wrapMap.thead; -wrapMap.th = wrapMap.td; - -// Support: IE <=9 only -if ( !support.option ) { - wrapMap.optgroup = wrapMap.option = [ 1, "" ]; -} - - -function getAll( context, tag ) { - - // Support: IE <=9 - 11 only - // Use typeof to avoid zero-argument method invocation on host objects (#15151) - var ret; - - if ( typeof context.getElementsByTagName !== "undefined" ) { - ret = context.getElementsByTagName( tag || "*" ); - - } else if ( typeof context.querySelectorAll !== "undefined" ) { - ret = context.querySelectorAll( tag || "*" ); - - } else { - ret = []; - } - - if ( tag === undefined || tag && nodeName( context, tag ) ) { - return jQuery.merge( [ context ], ret ); - } - - return ret; -} - - -// Mark scripts as having already been evaluated -function setGlobalEval( elems, refElements ) { - var i = 0, - l = elems.length; - - for ( ; i < l; i++ ) { - dataPriv.set( - elems[ i ], - "globalEval", - !refElements || dataPriv.get( refElements[ i ], "globalEval" ) - ); - } -} - - -var rhtml = /<|&#?\w+;/; - -function buildFragment( elems, context, scripts, selection, ignored ) { - var elem, tmp, tag, wrap, attached, j, - fragment = context.createDocumentFragment(), - nodes = [], - i = 0, - l = elems.length; - - for ( ; i < l; i++ ) { - elem = elems[ i ]; - - if ( elem || elem === 0 ) { - - // Add nodes directly - if ( toType( elem ) === "object" ) { - - // Support: Android <=4.0 only, PhantomJS 1 only - // push.apply(_, arraylike) throws on ancient WebKit - jQuery.merge( nodes, elem.nodeType ? [ elem ] : elem ); - - // Convert non-html into a text node - } else if ( !rhtml.test( elem ) ) { - nodes.push( context.createTextNode( elem ) ); - - // Convert html into DOM nodes - } else { - tmp = tmp || fragment.appendChild( context.createElement( "div" ) ); - - // Deserialize a standard representation - tag = ( rtagName.exec( elem ) || [ "", "" ] )[ 1 ].toLowerCase(); - wrap = wrapMap[ tag ] || wrapMap._default; - tmp.innerHTML = wrap[ 1 ] + jQuery.htmlPrefilter( elem ) + wrap[ 2 ]; - - // Descend through wrappers to the right content - j = wrap[ 0 ]; - while ( j-- ) { - tmp = tmp.lastChild; - } - - // Support: Android <=4.0 only, PhantomJS 1 only - // push.apply(_, arraylike) throws on ancient WebKit - jQuery.merge( nodes, tmp.childNodes ); - - // Remember the top-level container - tmp = fragment.firstChild; - - // Ensure the created nodes are orphaned (#12392) - tmp.textContent = ""; - } - } - } - - // Remove wrapper from fragment - fragment.textContent = ""; - - i = 0; - while ( ( elem = nodes[ i++ ] ) ) { - - // Skip elements already in the context collection (trac-4087) - if ( selection && jQuery.inArray( elem, selection ) > -1 ) { - if ( ignored ) { - ignored.push( elem ); - } - continue; - } - - attached = isAttached( elem ); - - // Append to fragment - tmp = getAll( fragment.appendChild( elem ), "script" ); - - // Preserve script evaluation history - if ( attached ) { - setGlobalEval( tmp ); - } - - // Capture executables - if ( scripts ) { - j = 0; - while ( ( elem = tmp[ j++ ] ) ) { - if ( rscriptType.test( elem.type || "" ) ) { - scripts.push( elem ); - } - } - } - } - - return fragment; -} - - -var - rkeyEvent = /^key/, - rmouseEvent = /^(?:mouse|pointer|contextmenu|drag|drop)|click/, - rtypenamespace = /^([^.]*)(?:\.(.+)|)/; - -function returnTrue() { - return true; -} - -function returnFalse() { - return false; -} - -// Support: IE <=9 - 11+ -// focus() and blur() are asynchronous, except when they are no-op. -// So expect focus to be synchronous when the element is already active, -// and blur to be synchronous when the element is not already active. -// (focus and blur are always synchronous in other supported browsers, -// this just defines when we can count on it). -function expectSync( elem, type ) { - return ( elem === safeActiveElement() ) === ( type === "focus" ); -} - -// Support: IE <=9 only -// Accessing document.activeElement can throw unexpectedly -// https://bugs.jquery.com/ticket/13393 -function safeActiveElement() { - try { - return document.activeElement; - } catch ( err ) { } -} - -function on( elem, types, selector, data, fn, one ) { - var origFn, type; - - // Types can be a map of types/handlers - if ( typeof types === "object" ) { - - // ( types-Object, selector, data ) - if ( typeof selector !== "string" ) { - - // ( types-Object, data ) - data = data || selector; - selector = undefined; - } - for ( type in types ) { - on( elem, type, selector, data, types[ type ], one ); - } - return elem; - } - - if ( data == null && fn == null ) { - - // ( types, fn ) - fn = selector; - data = selector = undefined; - } else if ( fn == null ) { - if ( typeof selector === "string" ) { - - // ( types, selector, fn ) - fn = data; - data = undefined; - } else { - - // ( types, data, fn ) - fn = data; - data = selector; - selector = undefined; - } - } - if ( fn === false ) { - fn = returnFalse; - } else if ( !fn ) { - return elem; - } - - if ( one === 1 ) { - origFn = fn; - fn = function( event ) { - - // Can use an empty set, since event contains the info - jQuery().off( event ); - return origFn.apply( this, arguments ); - }; - - // Use same guid so caller can remove using origFn - fn.guid = origFn.guid || ( origFn.guid = jQuery.guid++ ); - } - return elem.each( function() { - jQuery.event.add( this, types, fn, data, selector ); - } ); -} - -/* - * Helper functions for managing events -- not part of the public interface. - * Props to Dean Edwards' addEvent library for many of the ideas. - */ -jQuery.event = { - - global: {}, - - add: function( elem, types, handler, data, selector ) { - - var handleObjIn, eventHandle, tmp, - events, t, handleObj, - special, handlers, type, namespaces, origType, - elemData = dataPriv.get( elem ); - - // Only attach events to objects that accept data - if ( !acceptData( elem ) ) { - return; - } - - // Caller can pass in an object of custom data in lieu of the handler - if ( handler.handler ) { - handleObjIn = handler; - handler = handleObjIn.handler; - selector = handleObjIn.selector; - } - - // Ensure that invalid selectors throw exceptions at attach time - // Evaluate against documentElement in case elem is a non-element node (e.g., document) - if ( selector ) { - jQuery.find.matchesSelector( documentElement, selector ); - } - - // Make sure that the handler has a unique ID, used to find/remove it later - if ( !handler.guid ) { - handler.guid = jQuery.guid++; - } - - // Init the element's event structure and main handler, if this is the first - if ( !( events = elemData.events ) ) { - events = elemData.events = Object.create( null ); - } - if ( !( eventHandle = elemData.handle ) ) { - eventHandle = elemData.handle = function( e ) { - - // Discard the second event of a jQuery.event.trigger() and - // when an event is called after a page has unloaded - return typeof jQuery !== "undefined" && jQuery.event.triggered !== e.type ? - jQuery.event.dispatch.apply( elem, arguments ) : undefined; - }; - } - - // Handle multiple events separated by a space - types = ( types || "" ).match( rnothtmlwhite ) || [ "" ]; - t = types.length; - while ( t-- ) { - tmp = rtypenamespace.exec( types[ t ] ) || []; - type = origType = tmp[ 1 ]; - namespaces = ( tmp[ 2 ] || "" ).split( "." ).sort(); - - // There *must* be a type, no attaching namespace-only handlers - if ( !type ) { - continue; - } - - // If event changes its type, use the special event handlers for the changed type - special = jQuery.event.special[ type ] || {}; - - // If selector defined, determine special event api type, otherwise given type - type = ( selector ? special.delegateType : special.bindType ) || type; - - // Update special based on newly reset type - special = jQuery.event.special[ type ] || {}; - - // handleObj is passed to all event handlers - handleObj = jQuery.extend( { - type: type, - origType: origType, - data: data, - handler: handler, - guid: handler.guid, - selector: selector, - needsContext: selector && jQuery.expr.match.needsContext.test( selector ), - namespace: namespaces.join( "." ) - }, handleObjIn ); - - // Init the event handler queue if we're the first - if ( !( handlers = events[ type ] ) ) { - handlers = events[ type ] = []; - handlers.delegateCount = 0; - - // Only use addEventListener if the special events handler returns false - if ( !special.setup || - special.setup.call( elem, data, namespaces, eventHandle ) === false ) { - - if ( elem.addEventListener ) { - elem.addEventListener( type, eventHandle ); - } - } - } - - if ( special.add ) { - special.add.call( elem, handleObj ); - - if ( !handleObj.handler.guid ) { - handleObj.handler.guid = handler.guid; - } - } - - // Add to the element's handler list, delegates in front - if ( selector ) { - handlers.splice( handlers.delegateCount++, 0, handleObj ); - } else { - handlers.push( handleObj ); - } - - // Keep track of which events have ever been used, for event optimization - jQuery.event.global[ type ] = true; - } - - }, - - // Detach an event or set of events from an element - remove: function( elem, types, handler, selector, mappedTypes ) { - - var j, origCount, tmp, - events, t, handleObj, - special, handlers, type, namespaces, origType, - elemData = dataPriv.hasData( elem ) && dataPriv.get( elem ); - - if ( !elemData || !( events = elemData.events ) ) { - return; - } - - // Once for each type.namespace in types; type may be omitted - types = ( types || "" ).match( rnothtmlwhite ) || [ "" ]; - t = types.length; - while ( t-- ) { - tmp = rtypenamespace.exec( types[ t ] ) || []; - type = origType = tmp[ 1 ]; - namespaces = ( tmp[ 2 ] || "" ).split( "." ).sort(); - - // Unbind all events (on this namespace, if provided) for the element - if ( !type ) { - for ( type in events ) { - jQuery.event.remove( elem, type + types[ t ], handler, selector, true ); - } - continue; - } - - special = jQuery.event.special[ type ] || {}; - type = ( selector ? special.delegateType : special.bindType ) || type; - handlers = events[ type ] || []; - tmp = tmp[ 2 ] && - new RegExp( "(^|\\.)" + namespaces.join( "\\.(?:.*\\.|)" ) + "(\\.|$)" ); - - // Remove matching events - origCount = j = handlers.length; - while ( j-- ) { - handleObj = handlers[ j ]; - - if ( ( mappedTypes || origType === handleObj.origType ) && - ( !handler || handler.guid === handleObj.guid ) && - ( !tmp || tmp.test( handleObj.namespace ) ) && - ( !selector || selector === handleObj.selector || - selector === "**" && handleObj.selector ) ) { - handlers.splice( j, 1 ); - - if ( handleObj.selector ) { - handlers.delegateCount--; - } - if ( special.remove ) { - special.remove.call( elem, handleObj ); - } - } - } - - // Remove generic event handler if we removed something and no more handlers exist - // (avoids potential for endless recursion during removal of special event handlers) - if ( origCount && !handlers.length ) { - if ( !special.teardown || - special.teardown.call( elem, namespaces, elemData.handle ) === false ) { - - jQuery.removeEvent( elem, type, elemData.handle ); - } - - delete events[ type ]; - } - } - - // Remove data and the expando if it's no longer used - if ( jQuery.isEmptyObject( events ) ) { - dataPriv.remove( elem, "handle events" ); - } - }, - - dispatch: function( nativeEvent ) { - - var i, j, ret, matched, handleObj, handlerQueue, - args = new Array( arguments.length ), - - // Make a writable jQuery.Event from the native event object - event = jQuery.event.fix( nativeEvent ), - - handlers = ( - dataPriv.get( this, "events" ) || Object.create( null ) - )[ event.type ] || [], - special = jQuery.event.special[ event.type ] || {}; - - // Use the fix-ed jQuery.Event rather than the (read-only) native event - args[ 0 ] = event; - - for ( i = 1; i < arguments.length; i++ ) { - args[ i ] = arguments[ i ]; - } - - event.delegateTarget = this; - - // Call the preDispatch hook for the mapped type, and let it bail if desired - if ( special.preDispatch && special.preDispatch.call( this, event ) === false ) { - return; - } - - // Determine handlers - handlerQueue = jQuery.event.handlers.call( this, event, handlers ); - - // Run delegates first; they may want to stop propagation beneath us - i = 0; - while ( ( matched = handlerQueue[ i++ ] ) && !event.isPropagationStopped() ) { - event.currentTarget = matched.elem; - - j = 0; - while ( ( handleObj = matched.handlers[ j++ ] ) && - !event.isImmediatePropagationStopped() ) { - - // If the event is namespaced, then each handler is only invoked if it is - // specially universal or its namespaces are a superset of the event's. - if ( !event.rnamespace || handleObj.namespace === false || - event.rnamespace.test( handleObj.namespace ) ) { - - event.handleObj = handleObj; - event.data = handleObj.data; - - ret = ( ( jQuery.event.special[ handleObj.origType ] || {} ).handle || - handleObj.handler ).apply( matched.elem, args ); - - if ( ret !== undefined ) { - if ( ( event.result = ret ) === false ) { - event.preventDefault(); - event.stopPropagation(); - } - } - } - } - } - - // Call the postDispatch hook for the mapped type - if ( special.postDispatch ) { - special.postDispatch.call( this, event ); - } - - return event.result; - }, - - handlers: function( event, handlers ) { - var i, handleObj, sel, matchedHandlers, matchedSelectors, - handlerQueue = [], - delegateCount = handlers.delegateCount, - cur = event.target; - - // Find delegate handlers - if ( delegateCount && - - // Support: IE <=9 - // Black-hole SVG instance trees (trac-13180) - cur.nodeType && - - // Support: Firefox <=42 - // Suppress spec-violating clicks indicating a non-primary pointer button (trac-3861) - // https://www.w3.org/TR/DOM-Level-3-Events/#event-type-click - // Support: IE 11 only - // ...but not arrow key "clicks" of radio inputs, which can have `button` -1 (gh-2343) - !( event.type === "click" && event.button >= 1 ) ) { - - for ( ; cur !== this; cur = cur.parentNode || this ) { - - // Don't check non-elements (#13208) - // Don't process clicks on disabled elements (#6911, #8165, #11382, #11764) - if ( cur.nodeType === 1 && !( event.type === "click" && cur.disabled === true ) ) { - matchedHandlers = []; - matchedSelectors = {}; - for ( i = 0; i < delegateCount; i++ ) { - handleObj = handlers[ i ]; - - // Don't conflict with Object.prototype properties (#13203) - sel = handleObj.selector + " "; - - if ( matchedSelectors[ sel ] === undefined ) { - matchedSelectors[ sel ] = handleObj.needsContext ? - jQuery( sel, this ).index( cur ) > -1 : - jQuery.find( sel, this, null, [ cur ] ).length; - } - if ( matchedSelectors[ sel ] ) { - matchedHandlers.push( handleObj ); - } - } - if ( matchedHandlers.length ) { - handlerQueue.push( { elem: cur, handlers: matchedHandlers } ); - } - } - } - } - - // Add the remaining (directly-bound) handlers - cur = this; - if ( delegateCount < handlers.length ) { - handlerQueue.push( { elem: cur, handlers: handlers.slice( delegateCount ) } ); - } - - return handlerQueue; - }, - - addProp: function( name, hook ) { - Object.defineProperty( jQuery.Event.prototype, name, { - enumerable: true, - configurable: true, - - get: isFunction( hook ) ? - function() { - if ( this.originalEvent ) { - return hook( this.originalEvent ); - } - } : - function() { - if ( this.originalEvent ) { - return this.originalEvent[ name ]; - } - }, - - set: function( value ) { - Object.defineProperty( this, name, { - enumerable: true, - configurable: true, - writable: true, - value: value - } ); - } - } ); - }, - - fix: function( originalEvent ) { - return originalEvent[ jQuery.expando ] ? - originalEvent : - new jQuery.Event( originalEvent ); - }, - - special: { - load: { - - // Prevent triggered image.load events from bubbling to window.load - noBubble: true - }, - click: { - - // Utilize native event to ensure correct state for checkable inputs - setup: function( data ) { - - // For mutual compressibility with _default, replace `this` access with a local var. - // `|| data` is dead code meant only to preserve the variable through minification. - var el = this || data; - - // Claim the first handler - if ( rcheckableType.test( el.type ) && - el.click && nodeName( el, "input" ) ) { - - // dataPriv.set( el, "click", ... ) - leverageNative( el, "click", returnTrue ); - } - - // Return false to allow normal processing in the caller - return false; - }, - trigger: function( data ) { - - // For mutual compressibility with _default, replace `this` access with a local var. - // `|| data` is dead code meant only to preserve the variable through minification. - var el = this || data; - - // Force setup before triggering a click - if ( rcheckableType.test( el.type ) && - el.click && nodeName( el, "input" ) ) { - - leverageNative( el, "click" ); - } - - // Return non-false to allow normal event-path propagation - return true; - }, - - // For cross-browser consistency, suppress native .click() on links - // Also prevent it if we're currently inside a leveraged native-event stack - _default: function( event ) { - var target = event.target; - return rcheckableType.test( target.type ) && - target.click && nodeName( target, "input" ) && - dataPriv.get( target, "click" ) || - nodeName( target, "a" ); - } - }, - - beforeunload: { - postDispatch: function( event ) { - - // Support: Firefox 20+ - // Firefox doesn't alert if the returnValue field is not set. - if ( event.result !== undefined && event.originalEvent ) { - event.originalEvent.returnValue = event.result; - } - } - } - } -}; - -// Ensure the presence of an event listener that handles manually-triggered -// synthetic events by interrupting progress until reinvoked in response to -// *native* events that it fires directly, ensuring that state changes have -// already occurred before other listeners are invoked. -function leverageNative( el, type, expectSync ) { - - // Missing expectSync indicates a trigger call, which must force setup through jQuery.event.add - if ( !expectSync ) { - if ( dataPriv.get( el, type ) === undefined ) { - jQuery.event.add( el, type, returnTrue ); - } - return; - } - - // Register the controller as a special universal handler for all event namespaces - dataPriv.set( el, type, false ); - jQuery.event.add( el, type, { - namespace: false, - handler: function( event ) { - var notAsync, result, - saved = dataPriv.get( this, type ); - - if ( ( event.isTrigger & 1 ) && this[ type ] ) { - - // Interrupt processing of the outer synthetic .trigger()ed event - // Saved data should be false in such cases, but might be a leftover capture object - // from an async native handler (gh-4350) - if ( !saved.length ) { - - // Store arguments for use when handling the inner native event - // There will always be at least one argument (an event object), so this array - // will not be confused with a leftover capture object. - saved = slice.call( arguments ); - dataPriv.set( this, type, saved ); - - // Trigger the native event and capture its result - // Support: IE <=9 - 11+ - // focus() and blur() are asynchronous - notAsync = expectSync( this, type ); - this[ type ](); - result = dataPriv.get( this, type ); - if ( saved !== result || notAsync ) { - dataPriv.set( this, type, false ); - } else { - result = {}; - } - if ( saved !== result ) { - - // Cancel the outer synthetic event - event.stopImmediatePropagation(); - event.preventDefault(); - return result.value; - } - - // If this is an inner synthetic event for an event with a bubbling surrogate - // (focus or blur), assume that the surrogate already propagated from triggering the - // native event and prevent that from happening again here. - // This technically gets the ordering wrong w.r.t. to `.trigger()` (in which the - // bubbling surrogate propagates *after* the non-bubbling base), but that seems - // less bad than duplication. - } else if ( ( jQuery.event.special[ type ] || {} ).delegateType ) { - event.stopPropagation(); - } - - // If this is a native event triggered above, everything is now in order - // Fire an inner synthetic event with the original arguments - } else if ( saved.length ) { - - // ...and capture the result - dataPriv.set( this, type, { - value: jQuery.event.trigger( - - // Support: IE <=9 - 11+ - // Extend with the prototype to reset the above stopImmediatePropagation() - jQuery.extend( saved[ 0 ], jQuery.Event.prototype ), - saved.slice( 1 ), - this - ) - } ); - - // Abort handling of the native event - event.stopImmediatePropagation(); - } - } - } ); -} - -jQuery.removeEvent = function( elem, type, handle ) { - - // This "if" is needed for plain objects - if ( elem.removeEventListener ) { - elem.removeEventListener( type, handle ); - } -}; - -jQuery.Event = function( src, props ) { - - // Allow instantiation without the 'new' keyword - if ( !( this instanceof jQuery.Event ) ) { - return new jQuery.Event( src, props ); - } - - // Event object - if ( src && src.type ) { - this.originalEvent = src; - this.type = src.type; - - // Events bubbling up the document may have been marked as prevented - // by a handler lower down the tree; reflect the correct value. - this.isDefaultPrevented = src.defaultPrevented || - src.defaultPrevented === undefined && - - // Support: Android <=2.3 only - src.returnValue === false ? - returnTrue : - returnFalse; - - // Create target properties - // Support: Safari <=6 - 7 only - // Target should not be a text node (#504, #13143) - this.target = ( src.target && src.target.nodeType === 3 ) ? - src.target.parentNode : - src.target; - - this.currentTarget = src.currentTarget; - this.relatedTarget = src.relatedTarget; - - // Event type - } else { - this.type = src; - } - - // Put explicitly provided properties onto the event object - if ( props ) { - jQuery.extend( this, props ); - } - - // Create a timestamp if incoming event doesn't have one - this.timeStamp = src && src.timeStamp || Date.now(); - - // Mark it as fixed - this[ jQuery.expando ] = true; -}; - -// jQuery.Event is based on DOM3 Events as specified by the ECMAScript Language Binding -// https://www.w3.org/TR/2003/WD-DOM-Level-3-Events-20030331/ecma-script-binding.html -jQuery.Event.prototype = { - constructor: jQuery.Event, - isDefaultPrevented: returnFalse, - isPropagationStopped: returnFalse, - isImmediatePropagationStopped: returnFalse, - isSimulated: false, - - preventDefault: function() { - var e = this.originalEvent; - - this.isDefaultPrevented = returnTrue; - - if ( e && !this.isSimulated ) { - e.preventDefault(); - } - }, - stopPropagation: function() { - var e = this.originalEvent; - - this.isPropagationStopped = returnTrue; - - if ( e && !this.isSimulated ) { - e.stopPropagation(); - } - }, - stopImmediatePropagation: function() { - var e = this.originalEvent; - - this.isImmediatePropagationStopped = returnTrue; - - if ( e && !this.isSimulated ) { - e.stopImmediatePropagation(); - } - - this.stopPropagation(); - } -}; - -// Includes all common event props including KeyEvent and MouseEvent specific props -jQuery.each( { - altKey: true, - bubbles: true, - cancelable: true, - changedTouches: true, - ctrlKey: true, - detail: true, - eventPhase: true, - metaKey: true, - pageX: true, - pageY: true, - shiftKey: true, - view: true, - "char": true, - code: true, - charCode: true, - key: true, - keyCode: true, - button: true, - buttons: true, - clientX: true, - clientY: true, - offsetX: true, - offsetY: true, - pointerId: true, - pointerType: true, - screenX: true, - screenY: true, - targetTouches: true, - toElement: true, - touches: true, - - which: function( event ) { - var button = event.button; - - // Add which for key events - if ( event.which == null && rkeyEvent.test( event.type ) ) { - return event.charCode != null ? event.charCode : event.keyCode; - } - - // Add which for click: 1 === left; 2 === middle; 3 === right - if ( !event.which && button !== undefined && rmouseEvent.test( event.type ) ) { - if ( button & 1 ) { - return 1; - } - - if ( button & 2 ) { - return 3; - } - - if ( button & 4 ) { - return 2; - } - - return 0; - } - - return event.which; - } -}, jQuery.event.addProp ); - -jQuery.each( { focus: "focusin", blur: "focusout" }, function( type, delegateType ) { - jQuery.event.special[ type ] = { - - // Utilize native event if possible so blur/focus sequence is correct - setup: function() { - - // Claim the first handler - // dataPriv.set( this, "focus", ... ) - // dataPriv.set( this, "blur", ... ) - leverageNative( this, type, expectSync ); - - // Return false to allow normal processing in the caller - return false; - }, - trigger: function() { - - // Force setup before trigger - leverageNative( this, type ); - - // Return non-false to allow normal event-path propagation - return true; - }, - - delegateType: delegateType - }; -} ); - -// Create mouseenter/leave events using mouseover/out and event-time checks -// so that event delegation works in jQuery. -// Do the same for pointerenter/pointerleave and pointerover/pointerout -// -// Support: Safari 7 only -// Safari sends mouseenter too often; see: -// https://bugs.chromium.org/p/chromium/issues/detail?id=470258 -// for the description of the bug (it existed in older Chrome versions as well). -jQuery.each( { - mouseenter: "mouseover", - mouseleave: "mouseout", - pointerenter: "pointerover", - pointerleave: "pointerout" -}, function( orig, fix ) { - jQuery.event.special[ orig ] = { - delegateType: fix, - bindType: fix, - - handle: function( event ) { - var ret, - target = this, - related = event.relatedTarget, - handleObj = event.handleObj; - - // For mouseenter/leave call the handler if related is outside the target. - // NB: No relatedTarget if the mouse left/entered the browser window - if ( !related || ( related !== target && !jQuery.contains( target, related ) ) ) { - event.type = handleObj.origType; - ret = handleObj.handler.apply( this, arguments ); - event.type = fix; - } - return ret; - } - }; -} ); - -jQuery.fn.extend( { - - on: function( types, selector, data, fn ) { - return on( this, types, selector, data, fn ); - }, - one: function( types, selector, data, fn ) { - return on( this, types, selector, data, fn, 1 ); - }, - off: function( types, selector, fn ) { - var handleObj, type; - if ( types && types.preventDefault && types.handleObj ) { - - // ( event ) dispatched jQuery.Event - handleObj = types.handleObj; - jQuery( types.delegateTarget ).off( - handleObj.namespace ? - handleObj.origType + "." + handleObj.namespace : - handleObj.origType, - handleObj.selector, - handleObj.handler - ); - return this; - } - if ( typeof types === "object" ) { - - // ( types-object [, selector] ) - for ( type in types ) { - this.off( type, selector, types[ type ] ); - } - return this; - } - if ( selector === false || typeof selector === "function" ) { - - // ( types [, fn] ) - fn = selector; - selector = undefined; - } - if ( fn === false ) { - fn = returnFalse; - } - return this.each( function() { - jQuery.event.remove( this, types, fn, selector ); - } ); - } -} ); - - -var - - // Support: IE <=10 - 11, Edge 12 - 13 only - // In IE/Edge using regex groups here causes severe slowdowns. - // See https://connect.microsoft.com/IE/feedback/details/1736512/ - rnoInnerhtml = /\s*$/g; - -// Prefer a tbody over its parent table for containing new rows -function manipulationTarget( elem, content ) { - if ( nodeName( elem, "table" ) && - nodeName( content.nodeType !== 11 ? content : content.firstChild, "tr" ) ) { - - return jQuery( elem ).children( "tbody" )[ 0 ] || elem; - } - - return elem; -} - -// Replace/restore the type attribute of script elements for safe DOM manipulation -function disableScript( elem ) { - elem.type = ( elem.getAttribute( "type" ) !== null ) + "/" + elem.type; - return elem; -} -function restoreScript( elem ) { - if ( ( elem.type || "" ).slice( 0, 5 ) === "true/" ) { - elem.type = elem.type.slice( 5 ); - } else { - elem.removeAttribute( "type" ); - } - - return elem; -} - -function cloneCopyEvent( src, dest ) { - var i, l, type, pdataOld, udataOld, udataCur, events; - - if ( dest.nodeType !== 1 ) { - return; - } - - // 1. Copy private data: events, handlers, etc. - if ( dataPriv.hasData( src ) ) { - pdataOld = dataPriv.get( src ); - events = pdataOld.events; - - if ( events ) { - dataPriv.remove( dest, "handle events" ); - - for ( type in events ) { - for ( i = 0, l = events[ type ].length; i < l; i++ ) { - jQuery.event.add( dest, type, events[ type ][ i ] ); - } - } - } - } - - // 2. Copy user data - if ( dataUser.hasData( src ) ) { - udataOld = dataUser.access( src ); - udataCur = jQuery.extend( {}, udataOld ); - - dataUser.set( dest, udataCur ); - } -} - -// Fix IE bugs, see support tests -function fixInput( src, dest ) { - var nodeName = dest.nodeName.toLowerCase(); - - // Fails to persist the checked state of a cloned checkbox or radio button. - if ( nodeName === "input" && rcheckableType.test( src.type ) ) { - dest.checked = src.checked; - - // Fails to return the selected option to the default selected state when cloning options - } else if ( nodeName === "input" || nodeName === "textarea" ) { - dest.defaultValue = src.defaultValue; - } -} - -function domManip( collection, args, callback, ignored ) { - - // Flatten any nested arrays - args = flat( args ); - - var fragment, first, scripts, hasScripts, node, doc, - i = 0, - l = collection.length, - iNoClone = l - 1, - value = args[ 0 ], - valueIsFunction = isFunction( value ); - - // We can't cloneNode fragments that contain checked, in WebKit - if ( valueIsFunction || - ( l > 1 && typeof value === "string" && - !support.checkClone && rchecked.test( value ) ) ) { - return collection.each( function( index ) { - var self = collection.eq( index ); - if ( valueIsFunction ) { - args[ 0 ] = value.call( this, index, self.html() ); - } - domManip( self, args, callback, ignored ); - } ); - } - - if ( l ) { - fragment = buildFragment( args, collection[ 0 ].ownerDocument, false, collection, ignored ); - first = fragment.firstChild; - - if ( fragment.childNodes.length === 1 ) { - fragment = first; - } - - // Require either new content or an interest in ignored elements to invoke the callback - if ( first || ignored ) { - scripts = jQuery.map( getAll( fragment, "script" ), disableScript ); - hasScripts = scripts.length; - - // Use the original fragment for the last item - // instead of the first because it can end up - // being emptied incorrectly in certain situations (#8070). - for ( ; i < l; i++ ) { - node = fragment; - - if ( i !== iNoClone ) { - node = jQuery.clone( node, true, true ); - - // Keep references to cloned scripts for later restoration - if ( hasScripts ) { - - // Support: Android <=4.0 only, PhantomJS 1 only - // push.apply(_, arraylike) throws on ancient WebKit - jQuery.merge( scripts, getAll( node, "script" ) ); - } - } - - callback.call( collection[ i ], node, i ); - } - - if ( hasScripts ) { - doc = scripts[ scripts.length - 1 ].ownerDocument; - - // Reenable scripts - jQuery.map( scripts, restoreScript ); - - // Evaluate executable scripts on first document insertion - for ( i = 0; i < hasScripts; i++ ) { - node = scripts[ i ]; - if ( rscriptType.test( node.type || "" ) && - !dataPriv.access( node, "globalEval" ) && - jQuery.contains( doc, node ) ) { - - if ( node.src && ( node.type || "" ).toLowerCase() !== "module" ) { - - // Optional AJAX dependency, but won't run scripts if not present - if ( jQuery._evalUrl && !node.noModule ) { - jQuery._evalUrl( node.src, { - nonce: node.nonce || node.getAttribute( "nonce" ) - }, doc ); - } - } else { - DOMEval( node.textContent.replace( rcleanScript, "" ), node, doc ); - } - } - } - } - } - } - - return collection; -} - -function remove( elem, selector, keepData ) { - var node, - nodes = selector ? jQuery.filter( selector, elem ) : elem, - i = 0; - - for ( ; ( node = nodes[ i ] ) != null; i++ ) { - if ( !keepData && node.nodeType === 1 ) { - jQuery.cleanData( getAll( node ) ); - } - - if ( node.parentNode ) { - if ( keepData && isAttached( node ) ) { - setGlobalEval( getAll( node, "script" ) ); - } - node.parentNode.removeChild( node ); - } - } - - return elem; -} - -jQuery.extend( { - htmlPrefilter: function( html ) { - return html; - }, - - clone: function( elem, dataAndEvents, deepDataAndEvents ) { - var i, l, srcElements, destElements, - clone = elem.cloneNode( true ), - inPage = isAttached( elem ); - - // Fix IE cloning issues - if ( !support.noCloneChecked && ( elem.nodeType === 1 || elem.nodeType === 11 ) && - !jQuery.isXMLDoc( elem ) ) { - - // We eschew Sizzle here for performance reasons: https://jsperf.com/getall-vs-sizzle/2 - destElements = getAll( clone ); - srcElements = getAll( elem ); - - for ( i = 0, l = srcElements.length; i < l; i++ ) { - fixInput( srcElements[ i ], destElements[ i ] ); - } - } - - // Copy the events from the original to the clone - if ( dataAndEvents ) { - if ( deepDataAndEvents ) { - srcElements = srcElements || getAll( elem ); - destElements = destElements || getAll( clone ); - - for ( i = 0, l = srcElements.length; i < l; i++ ) { - cloneCopyEvent( srcElements[ i ], destElements[ i ] ); - } - } else { - cloneCopyEvent( elem, clone ); - } - } - - // Preserve script evaluation history - destElements = getAll( clone, "script" ); - if ( destElements.length > 0 ) { - setGlobalEval( destElements, !inPage && getAll( elem, "script" ) ); - } - - // Return the cloned set - return clone; - }, - - cleanData: function( elems ) { - var data, elem, type, - special = jQuery.event.special, - i = 0; - - for ( ; ( elem = elems[ i ] ) !== undefined; i++ ) { - if ( acceptData( elem ) ) { - if ( ( data = elem[ dataPriv.expando ] ) ) { - if ( data.events ) { - for ( type in data.events ) { - if ( special[ type ] ) { - jQuery.event.remove( elem, type ); - - // This is a shortcut to avoid jQuery.event.remove's overhead - } else { - jQuery.removeEvent( elem, type, data.handle ); - } - } - } - - // Support: Chrome <=35 - 45+ - // Assign undefined instead of using delete, see Data#remove - elem[ dataPriv.expando ] = undefined; - } - if ( elem[ dataUser.expando ] ) { - - // Support: Chrome <=35 - 45+ - // Assign undefined instead of using delete, see Data#remove - elem[ dataUser.expando ] = undefined; - } - } - } - } -} ); - -jQuery.fn.extend( { - detach: function( selector ) { - return remove( this, selector, true ); - }, - - remove: function( selector ) { - return remove( this, selector ); - }, - - text: function( value ) { - return access( this, function( value ) { - return value === undefined ? - jQuery.text( this ) : - this.empty().each( function() { - if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { - this.textContent = value; - } - } ); - }, null, value, arguments.length ); - }, - - append: function() { - return domManip( this, arguments, function( elem ) { - if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { - var target = manipulationTarget( this, elem ); - target.appendChild( elem ); - } - } ); - }, - - prepend: function() { - return domManip( this, arguments, function( elem ) { - if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { - var target = manipulationTarget( this, elem ); - target.insertBefore( elem, target.firstChild ); - } - } ); - }, - - before: function() { - return domManip( this, arguments, function( elem ) { - if ( this.parentNode ) { - this.parentNode.insertBefore( elem, this ); - } - } ); - }, - - after: function() { - return domManip( this, arguments, function( elem ) { - if ( this.parentNode ) { - this.parentNode.insertBefore( elem, this.nextSibling ); - } - } ); - }, - - empty: function() { - var elem, - i = 0; - - for ( ; ( elem = this[ i ] ) != null; i++ ) { - if ( elem.nodeType === 1 ) { - - // Prevent memory leaks - jQuery.cleanData( getAll( elem, false ) ); - - // Remove any remaining nodes - elem.textContent = ""; - } - } - - return this; - }, - - clone: function( dataAndEvents, deepDataAndEvents ) { - dataAndEvents = dataAndEvents == null ? false : dataAndEvents; - deepDataAndEvents = deepDataAndEvents == null ? dataAndEvents : deepDataAndEvents; - - return this.map( function() { - return jQuery.clone( this, dataAndEvents, deepDataAndEvents ); - } ); - }, - - html: function( value ) { - return access( this, function( value ) { - var elem = this[ 0 ] || {}, - i = 0, - l = this.length; - - if ( value === undefined && elem.nodeType === 1 ) { - return elem.innerHTML; - } - - // See if we can take a shortcut and just use innerHTML - if ( typeof value === "string" && !rnoInnerhtml.test( value ) && - !wrapMap[ ( rtagName.exec( value ) || [ "", "" ] )[ 1 ].toLowerCase() ] ) { - - value = jQuery.htmlPrefilter( value ); - - try { - for ( ; i < l; i++ ) { - elem = this[ i ] || {}; - - // Remove element nodes and prevent memory leaks - if ( elem.nodeType === 1 ) { - jQuery.cleanData( getAll( elem, false ) ); - elem.innerHTML = value; - } - } - - elem = 0; - - // If using innerHTML throws an exception, use the fallback method - } catch ( e ) {} - } - - if ( elem ) { - this.empty().append( value ); - } - }, null, value, arguments.length ); - }, - - replaceWith: function() { - var ignored = []; - - // Make the changes, replacing each non-ignored context element with the new content - return domManip( this, arguments, function( elem ) { - var parent = this.parentNode; - - if ( jQuery.inArray( this, ignored ) < 0 ) { - jQuery.cleanData( getAll( this ) ); - if ( parent ) { - parent.replaceChild( elem, this ); - } - } - - // Force callback invocation - }, ignored ); - } -} ); - -jQuery.each( { - appendTo: "append", - prependTo: "prepend", - insertBefore: "before", - insertAfter: "after", - replaceAll: "replaceWith" -}, function( name, original ) { - jQuery.fn[ name ] = function( selector ) { - var elems, - ret = [], - insert = jQuery( selector ), - last = insert.length - 1, - i = 0; - - for ( ; i <= last; i++ ) { - elems = i === last ? this : this.clone( true ); - jQuery( insert[ i ] )[ original ]( elems ); - - // Support: Android <=4.0 only, PhantomJS 1 only - // .get() because push.apply(_, arraylike) throws on ancient WebKit - push.apply( ret, elems.get() ); - } - - return this.pushStack( ret ); - }; -} ); -var rnumnonpx = new RegExp( "^(" + pnum + ")(?!px)[a-z%]+$", "i" ); - -var getStyles = function( elem ) { - - // Support: IE <=11 only, Firefox <=30 (#15098, #14150) - // IE throws on elements created in popups - // FF meanwhile throws on frame elements through "defaultView.getComputedStyle" - var view = elem.ownerDocument.defaultView; - - if ( !view || !view.opener ) { - view = window; - } - - return view.getComputedStyle( elem ); - }; - -var swap = function( elem, options, callback ) { - var ret, name, - old = {}; - - // Remember the old values, and insert the new ones - for ( name in options ) { - old[ name ] = elem.style[ name ]; - elem.style[ name ] = options[ name ]; - } - - ret = callback.call( elem ); - - // Revert the old values - for ( name in options ) { - elem.style[ name ] = old[ name ]; - } - - return ret; -}; - - -var rboxStyle = new RegExp( cssExpand.join( "|" ), "i" ); - - - -( function() { - - // Executing both pixelPosition & boxSizingReliable tests require only one layout - // so they're executed at the same time to save the second computation. - function computeStyleTests() { - - // This is a singleton, we need to execute it only once - if ( !div ) { - return; - } - - container.style.cssText = "position:absolute;left:-11111px;width:60px;" + - "margin-top:1px;padding:0;border:0"; - div.style.cssText = - "position:relative;display:block;box-sizing:border-box;overflow:scroll;" + - "margin:auto;border:1px;padding:1px;" + - "width:60%;top:1%"; - documentElement.appendChild( container ).appendChild( div ); - - var divStyle = window.getComputedStyle( div ); - pixelPositionVal = divStyle.top !== "1%"; - - // Support: Android 4.0 - 4.3 only, Firefox <=3 - 44 - reliableMarginLeftVal = roundPixelMeasures( divStyle.marginLeft ) === 12; - - // Support: Android 4.0 - 4.3 only, Safari <=9.1 - 10.1, iOS <=7.0 - 9.3 - // Some styles come back with percentage values, even though they shouldn't - div.style.right = "60%"; - pixelBoxStylesVal = roundPixelMeasures( divStyle.right ) === 36; - - // Support: IE 9 - 11 only - // Detect misreporting of content dimensions for box-sizing:border-box elements - boxSizingReliableVal = roundPixelMeasures( divStyle.width ) === 36; - - // Support: IE 9 only - // Detect overflow:scroll screwiness (gh-3699) - // Support: Chrome <=64 - // Don't get tricked when zoom affects offsetWidth (gh-4029) - div.style.position = "absolute"; - scrollboxSizeVal = roundPixelMeasures( div.offsetWidth / 3 ) === 12; - - documentElement.removeChild( container ); - - // Nullify the div so it wouldn't be stored in the memory and - // it will also be a sign that checks already performed - div = null; - } - - function roundPixelMeasures( measure ) { - return Math.round( parseFloat( measure ) ); - } - - var pixelPositionVal, boxSizingReliableVal, scrollboxSizeVal, pixelBoxStylesVal, - reliableTrDimensionsVal, reliableMarginLeftVal, - container = document.createElement( "div" ), - div = document.createElement( "div" ); - - // Finish early in limited (non-browser) environments - if ( !div.style ) { - return; - } - - // Support: IE <=9 - 11 only - // Style of cloned element affects source element cloned (#8908) - div.style.backgroundClip = "content-box"; - div.cloneNode( true ).style.backgroundClip = ""; - support.clearCloneStyle = div.style.backgroundClip === "content-box"; - - jQuery.extend( support, { - boxSizingReliable: function() { - computeStyleTests(); - return boxSizingReliableVal; - }, - pixelBoxStyles: function() { - computeStyleTests(); - return pixelBoxStylesVal; - }, - pixelPosition: function() { - computeStyleTests(); - return pixelPositionVal; - }, - reliableMarginLeft: function() { - computeStyleTests(); - return reliableMarginLeftVal; - }, - scrollboxSize: function() { - computeStyleTests(); - return scrollboxSizeVal; - }, - - // Support: IE 9 - 11+, Edge 15 - 18+ - // IE/Edge misreport `getComputedStyle` of table rows with width/height - // set in CSS while `offset*` properties report correct values. - // Behavior in IE 9 is more subtle than in newer versions & it passes - // some versions of this test; make sure not to make it pass there! - reliableTrDimensions: function() { - var table, tr, trChild, trStyle; - if ( reliableTrDimensionsVal == null ) { - table = document.createElement( "table" ); - tr = document.createElement( "tr" ); - trChild = document.createElement( "div" ); - - table.style.cssText = "position:absolute;left:-11111px"; - tr.style.height = "1px"; - trChild.style.height = "9px"; - - documentElement - .appendChild( table ) - .appendChild( tr ) - .appendChild( trChild ); - - trStyle = window.getComputedStyle( tr ); - reliableTrDimensionsVal = parseInt( trStyle.height ) > 3; - - documentElement.removeChild( table ); - } - return reliableTrDimensionsVal; - } - } ); -} )(); - - -function curCSS( elem, name, computed ) { - var width, minWidth, maxWidth, ret, - - // Support: Firefox 51+ - // Retrieving style before computed somehow - // fixes an issue with getting wrong values - // on detached elements - style = elem.style; - - computed = computed || getStyles( elem ); - - // getPropertyValue is needed for: - // .css('filter') (IE 9 only, #12537) - // .css('--customProperty) (#3144) - if ( computed ) { - ret = computed.getPropertyValue( name ) || computed[ name ]; - - if ( ret === "" && !isAttached( elem ) ) { - ret = jQuery.style( elem, name ); - } - - // A tribute to the "awesome hack by Dean Edwards" - // Android Browser returns percentage for some values, - // but width seems to be reliably pixels. - // This is against the CSSOM draft spec: - // https://drafts.csswg.org/cssom/#resolved-values - if ( !support.pixelBoxStyles() && rnumnonpx.test( ret ) && rboxStyle.test( name ) ) { - - // Remember the original values - width = style.width; - minWidth = style.minWidth; - maxWidth = style.maxWidth; - - // Put in the new values to get a computed value out - style.minWidth = style.maxWidth = style.width = ret; - ret = computed.width; - - // Revert the changed values - style.width = width; - style.minWidth = minWidth; - style.maxWidth = maxWidth; - } - } - - return ret !== undefined ? - - // Support: IE <=9 - 11 only - // IE returns zIndex value as an integer. - ret + "" : - ret; -} - - -function addGetHookIf( conditionFn, hookFn ) { - - // Define the hook, we'll check on the first run if it's really needed. - return { - get: function() { - if ( conditionFn() ) { - - // Hook not needed (or it's not possible to use it due - // to missing dependency), remove it. - delete this.get; - return; - } - - // Hook needed; redefine it so that the support test is not executed again. - return ( this.get = hookFn ).apply( this, arguments ); - } - }; -} - - -var cssPrefixes = [ "Webkit", "Moz", "ms" ], - emptyStyle = document.createElement( "div" ).style, - vendorProps = {}; - -// Return a vendor-prefixed property or undefined -function vendorPropName( name ) { - - // Check for vendor prefixed names - var capName = name[ 0 ].toUpperCase() + name.slice( 1 ), - i = cssPrefixes.length; - - while ( i-- ) { - name = cssPrefixes[ i ] + capName; - if ( name in emptyStyle ) { - return name; - } - } -} - -// Return a potentially-mapped jQuery.cssProps or vendor prefixed property -function finalPropName( name ) { - var final = jQuery.cssProps[ name ] || vendorProps[ name ]; - - if ( final ) { - return final; - } - if ( name in emptyStyle ) { - return name; - } - return vendorProps[ name ] = vendorPropName( name ) || name; -} - - -var - - // Swappable if display is none or starts with table - // except "table", "table-cell", or "table-caption" - // See here for display values: https://developer.mozilla.org/en-US/docs/CSS/display - rdisplayswap = /^(none|table(?!-c[ea]).+)/, - rcustomProp = /^--/, - cssShow = { position: "absolute", visibility: "hidden", display: "block" }, - cssNormalTransform = { - letterSpacing: "0", - fontWeight: "400" - }; - -function setPositiveNumber( _elem, value, subtract ) { - - // Any relative (+/-) values have already been - // normalized at this point - var matches = rcssNum.exec( value ); - return matches ? - - // Guard against undefined "subtract", e.g., when used as in cssHooks - Math.max( 0, matches[ 2 ] - ( subtract || 0 ) ) + ( matches[ 3 ] || "px" ) : - value; -} - -function boxModelAdjustment( elem, dimension, box, isBorderBox, styles, computedVal ) { - var i = dimension === "width" ? 1 : 0, - extra = 0, - delta = 0; - - // Adjustment may not be necessary - if ( box === ( isBorderBox ? "border" : "content" ) ) { - return 0; - } - - for ( ; i < 4; i += 2 ) { - - // Both box models exclude margin - if ( box === "margin" ) { - delta += jQuery.css( elem, box + cssExpand[ i ], true, styles ); - } - - // If we get here with a content-box, we're seeking "padding" or "border" or "margin" - if ( !isBorderBox ) { - - // Add padding - delta += jQuery.css( elem, "padding" + cssExpand[ i ], true, styles ); - - // For "border" or "margin", add border - if ( box !== "padding" ) { - delta += jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); - - // But still keep track of it otherwise - } else { - extra += jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); - } - - // If we get here with a border-box (content + padding + border), we're seeking "content" or - // "padding" or "margin" - } else { - - // For "content", subtract padding - if ( box === "content" ) { - delta -= jQuery.css( elem, "padding" + cssExpand[ i ], true, styles ); - } - - // For "content" or "padding", subtract border - if ( box !== "margin" ) { - delta -= jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); - } - } - } - - // Account for positive content-box scroll gutter when requested by providing computedVal - if ( !isBorderBox && computedVal >= 0 ) { - - // offsetWidth/offsetHeight is a rounded sum of content, padding, scroll gutter, and border - // Assuming integer scroll gutter, subtract the rest and round down - delta += Math.max( 0, Math.ceil( - elem[ "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ) ] - - computedVal - - delta - - extra - - 0.5 - - // If offsetWidth/offsetHeight is unknown, then we can't determine content-box scroll gutter - // Use an explicit zero to avoid NaN (gh-3964) - ) ) || 0; - } - - return delta; -} - -function getWidthOrHeight( elem, dimension, extra ) { - - // Start with computed style - var styles = getStyles( elem ), - - // To avoid forcing a reflow, only fetch boxSizing if we need it (gh-4322). - // Fake content-box until we know it's needed to know the true value. - boxSizingNeeded = !support.boxSizingReliable() || extra, - isBorderBox = boxSizingNeeded && - jQuery.css( elem, "boxSizing", false, styles ) === "border-box", - valueIsBorderBox = isBorderBox, - - val = curCSS( elem, dimension, styles ), - offsetProp = "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ); - - // Support: Firefox <=54 - // Return a confounding non-pixel value or feign ignorance, as appropriate. - if ( rnumnonpx.test( val ) ) { - if ( !extra ) { - return val; - } - val = "auto"; - } - - - // Support: IE 9 - 11 only - // Use offsetWidth/offsetHeight for when box sizing is unreliable. - // In those cases, the computed value can be trusted to be border-box. - if ( ( !support.boxSizingReliable() && isBorderBox || - - // Support: IE 10 - 11+, Edge 15 - 18+ - // IE/Edge misreport `getComputedStyle` of table rows with width/height - // set in CSS while `offset*` properties report correct values. - // Interestingly, in some cases IE 9 doesn't suffer from this issue. - !support.reliableTrDimensions() && nodeName( elem, "tr" ) || - - // Fall back to offsetWidth/offsetHeight when value is "auto" - // This happens for inline elements with no explicit setting (gh-3571) - val === "auto" || - - // Support: Android <=4.1 - 4.3 only - // Also use offsetWidth/offsetHeight for misreported inline dimensions (gh-3602) - !parseFloat( val ) && jQuery.css( elem, "display", false, styles ) === "inline" ) && - - // Make sure the element is visible & connected - elem.getClientRects().length ) { - - isBorderBox = jQuery.css( elem, "boxSizing", false, styles ) === "border-box"; - - // Where available, offsetWidth/offsetHeight approximate border box dimensions. - // Where not available (e.g., SVG), assume unreliable box-sizing and interpret the - // retrieved value as a content box dimension. - valueIsBorderBox = offsetProp in elem; - if ( valueIsBorderBox ) { - val = elem[ offsetProp ]; - } - } - - // Normalize "" and auto - val = parseFloat( val ) || 0; - - // Adjust for the element's box model - return ( val + - boxModelAdjustment( - elem, - dimension, - extra || ( isBorderBox ? "border" : "content" ), - valueIsBorderBox, - styles, - - // Provide the current computed size to request scroll gutter calculation (gh-3589) - val - ) - ) + "px"; -} - -jQuery.extend( { - - // Add in style property hooks for overriding the default - // behavior of getting and setting a style property - cssHooks: { - opacity: { - get: function( elem, computed ) { - if ( computed ) { - - // We should always get a number back from opacity - var ret = curCSS( elem, "opacity" ); - return ret === "" ? "1" : ret; - } - } - } - }, - - // Don't automatically add "px" to these possibly-unitless properties - cssNumber: { - "animationIterationCount": true, - "columnCount": true, - "fillOpacity": true, - "flexGrow": true, - "flexShrink": true, - "fontWeight": true, - "gridArea": true, - "gridColumn": true, - "gridColumnEnd": true, - "gridColumnStart": true, - "gridRow": true, - "gridRowEnd": true, - "gridRowStart": true, - "lineHeight": true, - "opacity": true, - "order": true, - "orphans": true, - "widows": true, - "zIndex": true, - "zoom": true - }, - - // Add in properties whose names you wish to fix before - // setting or getting the value - cssProps: {}, - - // Get and set the style property on a DOM Node - style: function( elem, name, value, extra ) { - - // Don't set styles on text and comment nodes - if ( !elem || elem.nodeType === 3 || elem.nodeType === 8 || !elem.style ) { - return; - } - - // Make sure that we're working with the right name - var ret, type, hooks, - origName = camelCase( name ), - isCustomProp = rcustomProp.test( name ), - style = elem.style; - - // Make sure that we're working with the right name. We don't - // want to query the value if it is a CSS custom property - // since they are user-defined. - if ( !isCustomProp ) { - name = finalPropName( origName ); - } - - // Gets hook for the prefixed version, then unprefixed version - hooks = jQuery.cssHooks[ name ] || jQuery.cssHooks[ origName ]; - - // Check if we're setting a value - if ( value !== undefined ) { - type = typeof value; - - // Convert "+=" or "-=" to relative numbers (#7345) - if ( type === "string" && ( ret = rcssNum.exec( value ) ) && ret[ 1 ] ) { - value = adjustCSS( elem, name, ret ); - - // Fixes bug #9237 - type = "number"; - } - - // Make sure that null and NaN values aren't set (#7116) - if ( value == null || value !== value ) { - return; - } - - // If a number was passed in, add the unit (except for certain CSS properties) - // The isCustomProp check can be removed in jQuery 4.0 when we only auto-append - // "px" to a few hardcoded values. - if ( type === "number" && !isCustomProp ) { - value += ret && ret[ 3 ] || ( jQuery.cssNumber[ origName ] ? "" : "px" ); - } - - // background-* props affect original clone's values - if ( !support.clearCloneStyle && value === "" && name.indexOf( "background" ) === 0 ) { - style[ name ] = "inherit"; - } - - // If a hook was provided, use that value, otherwise just set the specified value - if ( !hooks || !( "set" in hooks ) || - ( value = hooks.set( elem, value, extra ) ) !== undefined ) { - - if ( isCustomProp ) { - style.setProperty( name, value ); - } else { - style[ name ] = value; - } - } - - } else { - - // If a hook was provided get the non-computed value from there - if ( hooks && "get" in hooks && - ( ret = hooks.get( elem, false, extra ) ) !== undefined ) { - - return ret; - } - - // Otherwise just get the value from the style object - return style[ name ]; - } - }, - - css: function( elem, name, extra, styles ) { - var val, num, hooks, - origName = camelCase( name ), - isCustomProp = rcustomProp.test( name ); - - // Make sure that we're working with the right name. We don't - // want to modify the value if it is a CSS custom property - // since they are user-defined. - if ( !isCustomProp ) { - name = finalPropName( origName ); - } - - // Try prefixed name followed by the unprefixed name - hooks = jQuery.cssHooks[ name ] || jQuery.cssHooks[ origName ]; - - // If a hook was provided get the computed value from there - if ( hooks && "get" in hooks ) { - val = hooks.get( elem, true, extra ); - } - - // Otherwise, if a way to get the computed value exists, use that - if ( val === undefined ) { - val = curCSS( elem, name, styles ); - } - - // Convert "normal" to computed value - if ( val === "normal" && name in cssNormalTransform ) { - val = cssNormalTransform[ name ]; - } - - // Make numeric if forced or a qualifier was provided and val looks numeric - if ( extra === "" || extra ) { - num = parseFloat( val ); - return extra === true || isFinite( num ) ? num || 0 : val; - } - - return val; - } -} ); - -jQuery.each( [ "height", "width" ], function( _i, dimension ) { - jQuery.cssHooks[ dimension ] = { - get: function( elem, computed, extra ) { - if ( computed ) { - - // Certain elements can have dimension info if we invisibly show them - // but it must have a current display style that would benefit - return rdisplayswap.test( jQuery.css( elem, "display" ) ) && - - // Support: Safari 8+ - // Table columns in Safari have non-zero offsetWidth & zero - // getBoundingClientRect().width unless display is changed. - // Support: IE <=11 only - // Running getBoundingClientRect on a disconnected node - // in IE throws an error. - ( !elem.getClientRects().length || !elem.getBoundingClientRect().width ) ? - swap( elem, cssShow, function() { - return getWidthOrHeight( elem, dimension, extra ); - } ) : - getWidthOrHeight( elem, dimension, extra ); - } - }, - - set: function( elem, value, extra ) { - var matches, - styles = getStyles( elem ), - - // Only read styles.position if the test has a chance to fail - // to avoid forcing a reflow. - scrollboxSizeBuggy = !support.scrollboxSize() && - styles.position === "absolute", - - // To avoid forcing a reflow, only fetch boxSizing if we need it (gh-3991) - boxSizingNeeded = scrollboxSizeBuggy || extra, - isBorderBox = boxSizingNeeded && - jQuery.css( elem, "boxSizing", false, styles ) === "border-box", - subtract = extra ? - boxModelAdjustment( - elem, - dimension, - extra, - isBorderBox, - styles - ) : - 0; - - // Account for unreliable border-box dimensions by comparing offset* to computed and - // faking a content-box to get border and padding (gh-3699) - if ( isBorderBox && scrollboxSizeBuggy ) { - subtract -= Math.ceil( - elem[ "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ) ] - - parseFloat( styles[ dimension ] ) - - boxModelAdjustment( elem, dimension, "border", false, styles ) - - 0.5 - ); - } - - // Convert to pixels if value adjustment is needed - if ( subtract && ( matches = rcssNum.exec( value ) ) && - ( matches[ 3 ] || "px" ) !== "px" ) { - - elem.style[ dimension ] = value; - value = jQuery.css( elem, dimension ); - } - - return setPositiveNumber( elem, value, subtract ); - } - }; -} ); - -jQuery.cssHooks.marginLeft = addGetHookIf( support.reliableMarginLeft, - function( elem, computed ) { - if ( computed ) { - return ( parseFloat( curCSS( elem, "marginLeft" ) ) || - elem.getBoundingClientRect().left - - swap( elem, { marginLeft: 0 }, function() { - return elem.getBoundingClientRect().left; - } ) - ) + "px"; - } - } -); - -// These hooks are used by animate to expand properties -jQuery.each( { - margin: "", - padding: "", - border: "Width" -}, function( prefix, suffix ) { - jQuery.cssHooks[ prefix + suffix ] = { - expand: function( value ) { - var i = 0, - expanded = {}, - - // Assumes a single number if not a string - parts = typeof value === "string" ? value.split( " " ) : [ value ]; - - for ( ; i < 4; i++ ) { - expanded[ prefix + cssExpand[ i ] + suffix ] = - parts[ i ] || parts[ i - 2 ] || parts[ 0 ]; - } - - return expanded; - } - }; - - if ( prefix !== "margin" ) { - jQuery.cssHooks[ prefix + suffix ].set = setPositiveNumber; - } -} ); - -jQuery.fn.extend( { - css: function( name, value ) { - return access( this, function( elem, name, value ) { - var styles, len, - map = {}, - i = 0; - - if ( Array.isArray( name ) ) { - styles = getStyles( elem ); - len = name.length; - - for ( ; i < len; i++ ) { - map[ name[ i ] ] = jQuery.css( elem, name[ i ], false, styles ); - } - - return map; - } - - return value !== undefined ? - jQuery.style( elem, name, value ) : - jQuery.css( elem, name ); - }, name, value, arguments.length > 1 ); - } -} ); - - -function Tween( elem, options, prop, end, easing ) { - return new Tween.prototype.init( elem, options, prop, end, easing ); -} -jQuery.Tween = Tween; - -Tween.prototype = { - constructor: Tween, - init: function( elem, options, prop, end, easing, unit ) { - this.elem = elem; - this.prop = prop; - this.easing = easing || jQuery.easing._default; - this.options = options; - this.start = this.now = this.cur(); - this.end = end; - this.unit = unit || ( jQuery.cssNumber[ prop ] ? "" : "px" ); - }, - cur: function() { - var hooks = Tween.propHooks[ this.prop ]; - - return hooks && hooks.get ? - hooks.get( this ) : - Tween.propHooks._default.get( this ); - }, - run: function( percent ) { - var eased, - hooks = Tween.propHooks[ this.prop ]; - - if ( this.options.duration ) { - this.pos = eased = jQuery.easing[ this.easing ]( - percent, this.options.duration * percent, 0, 1, this.options.duration - ); - } else { - this.pos = eased = percent; - } - this.now = ( this.end - this.start ) * eased + this.start; - - if ( this.options.step ) { - this.options.step.call( this.elem, this.now, this ); - } - - if ( hooks && hooks.set ) { - hooks.set( this ); - } else { - Tween.propHooks._default.set( this ); - } - return this; - } -}; - -Tween.prototype.init.prototype = Tween.prototype; - -Tween.propHooks = { - _default: { - get: function( tween ) { - var result; - - // Use a property on the element directly when it is not a DOM element, - // or when there is no matching style property that exists. - if ( tween.elem.nodeType !== 1 || - tween.elem[ tween.prop ] != null && tween.elem.style[ tween.prop ] == null ) { - return tween.elem[ tween.prop ]; - } - - // Passing an empty string as a 3rd parameter to .css will automatically - // attempt a parseFloat and fallback to a string if the parse fails. - // Simple values such as "10px" are parsed to Float; - // complex values such as "rotate(1rad)" are returned as-is. - result = jQuery.css( tween.elem, tween.prop, "" ); - - // Empty strings, null, undefined and "auto" are converted to 0. - return !result || result === "auto" ? 0 : result; - }, - set: function( tween ) { - - // Use step hook for back compat. - // Use cssHook if its there. - // Use .style if available and use plain properties where available. - if ( jQuery.fx.step[ tween.prop ] ) { - jQuery.fx.step[ tween.prop ]( tween ); - } else if ( tween.elem.nodeType === 1 && ( - jQuery.cssHooks[ tween.prop ] || - tween.elem.style[ finalPropName( tween.prop ) ] != null ) ) { - jQuery.style( tween.elem, tween.prop, tween.now + tween.unit ); - } else { - tween.elem[ tween.prop ] = tween.now; - } - } - } -}; - -// Support: IE <=9 only -// Panic based approach to setting things on disconnected nodes -Tween.propHooks.scrollTop = Tween.propHooks.scrollLeft = { - set: function( tween ) { - if ( tween.elem.nodeType && tween.elem.parentNode ) { - tween.elem[ tween.prop ] = tween.now; - } - } -}; - -jQuery.easing = { - linear: function( p ) { - return p; - }, - swing: function( p ) { - return 0.5 - Math.cos( p * Math.PI ) / 2; - }, - _default: "swing" -}; - -jQuery.fx = Tween.prototype.init; - -// Back compat <1.8 extension point -jQuery.fx.step = {}; - - - - -var - fxNow, inProgress, - rfxtypes = /^(?:toggle|show|hide)$/, - rrun = /queueHooks$/; - -function schedule() { - if ( inProgress ) { - if ( document.hidden === false && window.requestAnimationFrame ) { - window.requestAnimationFrame( schedule ); - } else { - window.setTimeout( schedule, jQuery.fx.interval ); - } - - jQuery.fx.tick(); - } -} - -// Animations created synchronously will run synchronously -function createFxNow() { - window.setTimeout( function() { - fxNow = undefined; - } ); - return ( fxNow = Date.now() ); -} - -// Generate parameters to create a standard animation -function genFx( type, includeWidth ) { - var which, - i = 0, - attrs = { height: type }; - - // If we include width, step value is 1 to do all cssExpand values, - // otherwise step value is 2 to skip over Left and Right - includeWidth = includeWidth ? 1 : 0; - for ( ; i < 4; i += 2 - includeWidth ) { - which = cssExpand[ i ]; - attrs[ "margin" + which ] = attrs[ "padding" + which ] = type; - } - - if ( includeWidth ) { - attrs.opacity = attrs.width = type; - } - - return attrs; -} - -function createTween( value, prop, animation ) { - var tween, - collection = ( Animation.tweeners[ prop ] || [] ).concat( Animation.tweeners[ "*" ] ), - index = 0, - length = collection.length; - for ( ; index < length; index++ ) { - if ( ( tween = collection[ index ].call( animation, prop, value ) ) ) { - - // We're done with this property - return tween; - } - } -} - -function defaultPrefilter( elem, props, opts ) { - var prop, value, toggle, hooks, oldfire, propTween, restoreDisplay, display, - isBox = "width" in props || "height" in props, - anim = this, - orig = {}, - style = elem.style, - hidden = elem.nodeType && isHiddenWithinTree( elem ), - dataShow = dataPriv.get( elem, "fxshow" ); - - // Queue-skipping animations hijack the fx hooks - if ( !opts.queue ) { - hooks = jQuery._queueHooks( elem, "fx" ); - if ( hooks.unqueued == null ) { - hooks.unqueued = 0; - oldfire = hooks.empty.fire; - hooks.empty.fire = function() { - if ( !hooks.unqueued ) { - oldfire(); - } - }; - } - hooks.unqueued++; - - anim.always( function() { - - // Ensure the complete handler is called before this completes - anim.always( function() { - hooks.unqueued--; - if ( !jQuery.queue( elem, "fx" ).length ) { - hooks.empty.fire(); - } - } ); - } ); - } - - // Detect show/hide animations - for ( prop in props ) { - value = props[ prop ]; - if ( rfxtypes.test( value ) ) { - delete props[ prop ]; - toggle = toggle || value === "toggle"; - if ( value === ( hidden ? "hide" : "show" ) ) { - - // Pretend to be hidden if this is a "show" and - // there is still data from a stopped show/hide - if ( value === "show" && dataShow && dataShow[ prop ] !== undefined ) { - hidden = true; - - // Ignore all other no-op show/hide data - } else { - continue; - } - } - orig[ prop ] = dataShow && dataShow[ prop ] || jQuery.style( elem, prop ); - } - } - - // Bail out if this is a no-op like .hide().hide() - propTween = !jQuery.isEmptyObject( props ); - if ( !propTween && jQuery.isEmptyObject( orig ) ) { - return; - } - - // Restrict "overflow" and "display" styles during box animations - if ( isBox && elem.nodeType === 1 ) { - - // Support: IE <=9 - 11, Edge 12 - 15 - // Record all 3 overflow attributes because IE does not infer the shorthand - // from identically-valued overflowX and overflowY and Edge just mirrors - // the overflowX value there. - opts.overflow = [ style.overflow, style.overflowX, style.overflowY ]; - - // Identify a display type, preferring old show/hide data over the CSS cascade - restoreDisplay = dataShow && dataShow.display; - if ( restoreDisplay == null ) { - restoreDisplay = dataPriv.get( elem, "display" ); - } - display = jQuery.css( elem, "display" ); - if ( display === "none" ) { - if ( restoreDisplay ) { - display = restoreDisplay; - } else { - - // Get nonempty value(s) by temporarily forcing visibility - showHide( [ elem ], true ); - restoreDisplay = elem.style.display || restoreDisplay; - display = jQuery.css( elem, "display" ); - showHide( [ elem ] ); - } - } - - // Animate inline elements as inline-block - if ( display === "inline" || display === "inline-block" && restoreDisplay != null ) { - if ( jQuery.css( elem, "float" ) === "none" ) { - - // Restore the original display value at the end of pure show/hide animations - if ( !propTween ) { - anim.done( function() { - style.display = restoreDisplay; - } ); - if ( restoreDisplay == null ) { - display = style.display; - restoreDisplay = display === "none" ? "" : display; - } - } - style.display = "inline-block"; - } - } - } - - if ( opts.overflow ) { - style.overflow = "hidden"; - anim.always( function() { - style.overflow = opts.overflow[ 0 ]; - style.overflowX = opts.overflow[ 1 ]; - style.overflowY = opts.overflow[ 2 ]; - } ); - } - - // Implement show/hide animations - propTween = false; - for ( prop in orig ) { - - // General show/hide setup for this element animation - if ( !propTween ) { - if ( dataShow ) { - if ( "hidden" in dataShow ) { - hidden = dataShow.hidden; - } - } else { - dataShow = dataPriv.access( elem, "fxshow", { display: restoreDisplay } ); - } - - // Store hidden/visible for toggle so `.stop().toggle()` "reverses" - if ( toggle ) { - dataShow.hidden = !hidden; - } - - // Show elements before animating them - if ( hidden ) { - showHide( [ elem ], true ); - } - - /* eslint-disable no-loop-func */ - - anim.done( function() { - - /* eslint-enable no-loop-func */ - - // The final step of a "hide" animation is actually hiding the element - if ( !hidden ) { - showHide( [ elem ] ); - } - dataPriv.remove( elem, "fxshow" ); - for ( prop in orig ) { - jQuery.style( elem, prop, orig[ prop ] ); - } - } ); - } - - // Per-property setup - propTween = createTween( hidden ? dataShow[ prop ] : 0, prop, anim ); - if ( !( prop in dataShow ) ) { - dataShow[ prop ] = propTween.start; - if ( hidden ) { - propTween.end = propTween.start; - propTween.start = 0; - } - } - } -} - -function propFilter( props, specialEasing ) { - var index, name, easing, value, hooks; - - // camelCase, specialEasing and expand cssHook pass - for ( index in props ) { - name = camelCase( index ); - easing = specialEasing[ name ]; - value = props[ index ]; - if ( Array.isArray( value ) ) { - easing = value[ 1 ]; - value = props[ index ] = value[ 0 ]; - } - - if ( index !== name ) { - props[ name ] = value; - delete props[ index ]; - } - - hooks = jQuery.cssHooks[ name ]; - if ( hooks && "expand" in hooks ) { - value = hooks.expand( value ); - delete props[ name ]; - - // Not quite $.extend, this won't overwrite existing keys. - // Reusing 'index' because we have the correct "name" - for ( index in value ) { - if ( !( index in props ) ) { - props[ index ] = value[ index ]; - specialEasing[ index ] = easing; - } - } - } else { - specialEasing[ name ] = easing; - } - } -} - -function Animation( elem, properties, options ) { - var result, - stopped, - index = 0, - length = Animation.prefilters.length, - deferred = jQuery.Deferred().always( function() { - - // Don't match elem in the :animated selector - delete tick.elem; - } ), - tick = function() { - if ( stopped ) { - return false; - } - var currentTime = fxNow || createFxNow(), - remaining = Math.max( 0, animation.startTime + animation.duration - currentTime ), - - // Support: Android 2.3 only - // Archaic crash bug won't allow us to use `1 - ( 0.5 || 0 )` (#12497) - temp = remaining / animation.duration || 0, - percent = 1 - temp, - index = 0, - length = animation.tweens.length; - - for ( ; index < length; index++ ) { - animation.tweens[ index ].run( percent ); - } - - deferred.notifyWith( elem, [ animation, percent, remaining ] ); - - // If there's more to do, yield - if ( percent < 1 && length ) { - return remaining; - } - - // If this was an empty animation, synthesize a final progress notification - if ( !length ) { - deferred.notifyWith( elem, [ animation, 1, 0 ] ); - } - - // Resolve the animation and report its conclusion - deferred.resolveWith( elem, [ animation ] ); - return false; - }, - animation = deferred.promise( { - elem: elem, - props: jQuery.extend( {}, properties ), - opts: jQuery.extend( true, { - specialEasing: {}, - easing: jQuery.easing._default - }, options ), - originalProperties: properties, - originalOptions: options, - startTime: fxNow || createFxNow(), - duration: options.duration, - tweens: [], - createTween: function( prop, end ) { - var tween = jQuery.Tween( elem, animation.opts, prop, end, - animation.opts.specialEasing[ prop ] || animation.opts.easing ); - animation.tweens.push( tween ); - return tween; - }, - stop: function( gotoEnd ) { - var index = 0, - - // If we are going to the end, we want to run all the tweens - // otherwise we skip this part - length = gotoEnd ? animation.tweens.length : 0; - if ( stopped ) { - return this; - } - stopped = true; - for ( ; index < length; index++ ) { - animation.tweens[ index ].run( 1 ); - } - - // Resolve when we played the last frame; otherwise, reject - if ( gotoEnd ) { - deferred.notifyWith( elem, [ animation, 1, 0 ] ); - deferred.resolveWith( elem, [ animation, gotoEnd ] ); - } else { - deferred.rejectWith( elem, [ animation, gotoEnd ] ); - } - return this; - } - } ), - props = animation.props; - - propFilter( props, animation.opts.specialEasing ); - - for ( ; index < length; index++ ) { - result = Animation.prefilters[ index ].call( animation, elem, props, animation.opts ); - if ( result ) { - if ( isFunction( result.stop ) ) { - jQuery._queueHooks( animation.elem, animation.opts.queue ).stop = - result.stop.bind( result ); - } - return result; - } - } - - jQuery.map( props, createTween, animation ); - - if ( isFunction( animation.opts.start ) ) { - animation.opts.start.call( elem, animation ); - } - - // Attach callbacks from options - animation - .progress( animation.opts.progress ) - .done( animation.opts.done, animation.opts.complete ) - .fail( animation.opts.fail ) - .always( animation.opts.always ); - - jQuery.fx.timer( - jQuery.extend( tick, { - elem: elem, - anim: animation, - queue: animation.opts.queue - } ) - ); - - return animation; -} - -jQuery.Animation = jQuery.extend( Animation, { - - tweeners: { - "*": [ function( prop, value ) { - var tween = this.createTween( prop, value ); - adjustCSS( tween.elem, prop, rcssNum.exec( value ), tween ); - return tween; - } ] - }, - - tweener: function( props, callback ) { - if ( isFunction( props ) ) { - callback = props; - props = [ "*" ]; - } else { - props = props.match( rnothtmlwhite ); - } - - var prop, - index = 0, - length = props.length; - - for ( ; index < length; index++ ) { - prop = props[ index ]; - Animation.tweeners[ prop ] = Animation.tweeners[ prop ] || []; - Animation.tweeners[ prop ].unshift( callback ); - } - }, - - prefilters: [ defaultPrefilter ], - - prefilter: function( callback, prepend ) { - if ( prepend ) { - Animation.prefilters.unshift( callback ); - } else { - Animation.prefilters.push( callback ); - } - } -} ); - -jQuery.speed = function( speed, easing, fn ) { - var opt = speed && typeof speed === "object" ? jQuery.extend( {}, speed ) : { - complete: fn || !fn && easing || - isFunction( speed ) && speed, - duration: speed, - easing: fn && easing || easing && !isFunction( easing ) && easing - }; - - // Go to the end state if fx are off - if ( jQuery.fx.off ) { - opt.duration = 0; - - } else { - if ( typeof opt.duration !== "number" ) { - if ( opt.duration in jQuery.fx.speeds ) { - opt.duration = jQuery.fx.speeds[ opt.duration ]; - - } else { - opt.duration = jQuery.fx.speeds._default; - } - } - } - - // Normalize opt.queue - true/undefined/null -> "fx" - if ( opt.queue == null || opt.queue === true ) { - opt.queue = "fx"; - } - - // Queueing - opt.old = opt.complete; - - opt.complete = function() { - if ( isFunction( opt.old ) ) { - opt.old.call( this ); - } - - if ( opt.queue ) { - jQuery.dequeue( this, opt.queue ); - } - }; - - return opt; -}; - -jQuery.fn.extend( { - fadeTo: function( speed, to, easing, callback ) { - - // Show any hidden elements after setting opacity to 0 - return this.filter( isHiddenWithinTree ).css( "opacity", 0 ).show() - - // Animate to the value specified - .end().animate( { opacity: to }, speed, easing, callback ); - }, - animate: function( prop, speed, easing, callback ) { - var empty = jQuery.isEmptyObject( prop ), - optall = jQuery.speed( speed, easing, callback ), - doAnimation = function() { - - // Operate on a copy of prop so per-property easing won't be lost - var anim = Animation( this, jQuery.extend( {}, prop ), optall ); - - // Empty animations, or finishing resolves immediately - if ( empty || dataPriv.get( this, "finish" ) ) { - anim.stop( true ); - } - }; - doAnimation.finish = doAnimation; - - return empty || optall.queue === false ? - this.each( doAnimation ) : - this.queue( optall.queue, doAnimation ); - }, - stop: function( type, clearQueue, gotoEnd ) { - var stopQueue = function( hooks ) { - var stop = hooks.stop; - delete hooks.stop; - stop( gotoEnd ); - }; - - if ( typeof type !== "string" ) { - gotoEnd = clearQueue; - clearQueue = type; - type = undefined; - } - if ( clearQueue ) { - this.queue( type || "fx", [] ); - } - - return this.each( function() { - var dequeue = true, - index = type != null && type + "queueHooks", - timers = jQuery.timers, - data = dataPriv.get( this ); - - if ( index ) { - if ( data[ index ] && data[ index ].stop ) { - stopQueue( data[ index ] ); - } - } else { - for ( index in data ) { - if ( data[ index ] && data[ index ].stop && rrun.test( index ) ) { - stopQueue( data[ index ] ); - } - } - } - - for ( index = timers.length; index--; ) { - if ( timers[ index ].elem === this && - ( type == null || timers[ index ].queue === type ) ) { - - timers[ index ].anim.stop( gotoEnd ); - dequeue = false; - timers.splice( index, 1 ); - } - } - - // Start the next in the queue if the last step wasn't forced. - // Timers currently will call their complete callbacks, which - // will dequeue but only if they were gotoEnd. - if ( dequeue || !gotoEnd ) { - jQuery.dequeue( this, type ); - } - } ); - }, - finish: function( type ) { - if ( type !== false ) { - type = type || "fx"; - } - return this.each( function() { - var index, - data = dataPriv.get( this ), - queue = data[ type + "queue" ], - hooks = data[ type + "queueHooks" ], - timers = jQuery.timers, - length = queue ? queue.length : 0; - - // Enable finishing flag on private data - data.finish = true; - - // Empty the queue first - jQuery.queue( this, type, [] ); - - if ( hooks && hooks.stop ) { - hooks.stop.call( this, true ); - } - - // Look for any active animations, and finish them - for ( index = timers.length; index--; ) { - if ( timers[ index ].elem === this && timers[ index ].queue === type ) { - timers[ index ].anim.stop( true ); - timers.splice( index, 1 ); - } - } - - // Look for any animations in the old queue and finish them - for ( index = 0; index < length; index++ ) { - if ( queue[ index ] && queue[ index ].finish ) { - queue[ index ].finish.call( this ); - } - } - - // Turn off finishing flag - delete data.finish; - } ); - } -} ); - -jQuery.each( [ "toggle", "show", "hide" ], function( _i, name ) { - var cssFn = jQuery.fn[ name ]; - jQuery.fn[ name ] = function( speed, easing, callback ) { - return speed == null || typeof speed === "boolean" ? - cssFn.apply( this, arguments ) : - this.animate( genFx( name, true ), speed, easing, callback ); - }; -} ); - -// Generate shortcuts for custom animations -jQuery.each( { - slideDown: genFx( "show" ), - slideUp: genFx( "hide" ), - slideToggle: genFx( "toggle" ), - fadeIn: { opacity: "show" }, - fadeOut: { opacity: "hide" }, - fadeToggle: { opacity: "toggle" } -}, function( name, props ) { - jQuery.fn[ name ] = function( speed, easing, callback ) { - return this.animate( props, speed, easing, callback ); - }; -} ); - -jQuery.timers = []; -jQuery.fx.tick = function() { - var timer, - i = 0, - timers = jQuery.timers; - - fxNow = Date.now(); - - for ( ; i < timers.length; i++ ) { - timer = timers[ i ]; - - // Run the timer and safely remove it when done (allowing for external removal) - if ( !timer() && timers[ i ] === timer ) { - timers.splice( i--, 1 ); - } - } - - if ( !timers.length ) { - jQuery.fx.stop(); - } - fxNow = undefined; -}; - -jQuery.fx.timer = function( timer ) { - jQuery.timers.push( timer ); - jQuery.fx.start(); -}; - -jQuery.fx.interval = 13; -jQuery.fx.start = function() { - if ( inProgress ) { - return; - } - - inProgress = true; - schedule(); -}; - -jQuery.fx.stop = function() { - inProgress = null; -}; - -jQuery.fx.speeds = { - slow: 600, - fast: 200, - - // Default speed - _default: 400 -}; - - -// Based off of the plugin by Clint Helfers, with permission. -// https://web.archive.org/web/20100324014747/http://blindsignals.com/index.php/2009/07/jquery-delay/ -jQuery.fn.delay = function( time, type ) { - time = jQuery.fx ? jQuery.fx.speeds[ time ] || time : time; - type = type || "fx"; - - return this.queue( type, function( next, hooks ) { - var timeout = window.setTimeout( next, time ); - hooks.stop = function() { - window.clearTimeout( timeout ); - }; - } ); -}; - - -( function() { - var input = document.createElement( "input" ), - select = document.createElement( "select" ), - opt = select.appendChild( document.createElement( "option" ) ); - - input.type = "checkbox"; - - // Support: Android <=4.3 only - // Default value for a checkbox should be "on" - support.checkOn = input.value !== ""; - - // Support: IE <=11 only - // Must access selectedIndex to make default options select - support.optSelected = opt.selected; - - // Support: IE <=11 only - // An input loses its value after becoming a radio - input = document.createElement( "input" ); - input.value = "t"; - input.type = "radio"; - support.radioValue = input.value === "t"; -} )(); - - -var boolHook, - attrHandle = jQuery.expr.attrHandle; - -jQuery.fn.extend( { - attr: function( name, value ) { - return access( this, jQuery.attr, name, value, arguments.length > 1 ); - }, - - removeAttr: function( name ) { - return this.each( function() { - jQuery.removeAttr( this, name ); - } ); - } -} ); - -jQuery.extend( { - attr: function( elem, name, value ) { - var ret, hooks, - nType = elem.nodeType; - - // Don't get/set attributes on text, comment and attribute nodes - if ( nType === 3 || nType === 8 || nType === 2 ) { - return; - } - - // Fallback to prop when attributes are not supported - if ( typeof elem.getAttribute === "undefined" ) { - return jQuery.prop( elem, name, value ); - } - - // Attribute hooks are determined by the lowercase version - // Grab necessary hook if one is defined - if ( nType !== 1 || !jQuery.isXMLDoc( elem ) ) { - hooks = jQuery.attrHooks[ name.toLowerCase() ] || - ( jQuery.expr.match.bool.test( name ) ? boolHook : undefined ); - } - - if ( value !== undefined ) { - if ( value === null ) { - jQuery.removeAttr( elem, name ); - return; - } - - if ( hooks && "set" in hooks && - ( ret = hooks.set( elem, value, name ) ) !== undefined ) { - return ret; - } - - elem.setAttribute( name, value + "" ); - return value; - } - - if ( hooks && "get" in hooks && ( ret = hooks.get( elem, name ) ) !== null ) { - return ret; - } - - ret = jQuery.find.attr( elem, name ); - - // Non-existent attributes return null, we normalize to undefined - return ret == null ? undefined : ret; - }, - - attrHooks: { - type: { - set: function( elem, value ) { - if ( !support.radioValue && value === "radio" && - nodeName( elem, "input" ) ) { - var val = elem.value; - elem.setAttribute( "type", value ); - if ( val ) { - elem.value = val; - } - return value; - } - } - } - }, - - removeAttr: function( elem, value ) { - var name, - i = 0, - - // Attribute names can contain non-HTML whitespace characters - // https://html.spec.whatwg.org/multipage/syntax.html#attributes-2 - attrNames = value && value.match( rnothtmlwhite ); - - if ( attrNames && elem.nodeType === 1 ) { - while ( ( name = attrNames[ i++ ] ) ) { - elem.removeAttribute( name ); - } - } - } -} ); - -// Hooks for boolean attributes -boolHook = { - set: function( elem, value, name ) { - if ( value === false ) { - - // Remove boolean attributes when set to false - jQuery.removeAttr( elem, name ); - } else { - elem.setAttribute( name, name ); - } - return name; - } -}; - -jQuery.each( jQuery.expr.match.bool.source.match( /\w+/g ), function( _i, name ) { - var getter = attrHandle[ name ] || jQuery.find.attr; - - attrHandle[ name ] = function( elem, name, isXML ) { - var ret, handle, - lowercaseName = name.toLowerCase(); - - if ( !isXML ) { - - // Avoid an infinite loop by temporarily removing this function from the getter - handle = attrHandle[ lowercaseName ]; - attrHandle[ lowercaseName ] = ret; - ret = getter( elem, name, isXML ) != null ? - lowercaseName : - null; - attrHandle[ lowercaseName ] = handle; - } - return ret; - }; -} ); - - - - -var rfocusable = /^(?:input|select|textarea|button)$/i, - rclickable = /^(?:a|area)$/i; - -jQuery.fn.extend( { - prop: function( name, value ) { - return access( this, jQuery.prop, name, value, arguments.length > 1 ); - }, - - removeProp: function( name ) { - return this.each( function() { - delete this[ jQuery.propFix[ name ] || name ]; - } ); - } -} ); - -jQuery.extend( { - prop: function( elem, name, value ) { - var ret, hooks, - nType = elem.nodeType; - - // Don't get/set properties on text, comment and attribute nodes - if ( nType === 3 || nType === 8 || nType === 2 ) { - return; - } - - if ( nType !== 1 || !jQuery.isXMLDoc( elem ) ) { - - // Fix name and attach hooks - name = jQuery.propFix[ name ] || name; - hooks = jQuery.propHooks[ name ]; - } - - if ( value !== undefined ) { - if ( hooks && "set" in hooks && - ( ret = hooks.set( elem, value, name ) ) !== undefined ) { - return ret; - } - - return ( elem[ name ] = value ); - } - - if ( hooks && "get" in hooks && ( ret = hooks.get( elem, name ) ) !== null ) { - return ret; - } - - return elem[ name ]; - }, - - propHooks: { - tabIndex: { - get: function( elem ) { - - // Support: IE <=9 - 11 only - // elem.tabIndex doesn't always return the - // correct value when it hasn't been explicitly set - // https://web.archive.org/web/20141116233347/http://fluidproject.org/blog/2008/01/09/getting-setting-and-removing-tabindex-values-with-javascript/ - // Use proper attribute retrieval(#12072) - var tabindex = jQuery.find.attr( elem, "tabindex" ); - - if ( tabindex ) { - return parseInt( tabindex, 10 ); - } - - if ( - rfocusable.test( elem.nodeName ) || - rclickable.test( elem.nodeName ) && - elem.href - ) { - return 0; - } - - return -1; - } - } - }, - - propFix: { - "for": "htmlFor", - "class": "className" - } -} ); - -// Support: IE <=11 only -// Accessing the selectedIndex property -// forces the browser to respect setting selected -// on the option -// The getter ensures a default option is selected -// when in an optgroup -// eslint rule "no-unused-expressions" is disabled for this code -// since it considers such accessions noop -if ( !support.optSelected ) { - jQuery.propHooks.selected = { - get: function( elem ) { - - /* eslint no-unused-expressions: "off" */ - - var parent = elem.parentNode; - if ( parent && parent.parentNode ) { - parent.parentNode.selectedIndex; - } - return null; - }, - set: function( elem ) { - - /* eslint no-unused-expressions: "off" */ - - var parent = elem.parentNode; - if ( parent ) { - parent.selectedIndex; - - if ( parent.parentNode ) { - parent.parentNode.selectedIndex; - } - } - } - }; -} - -jQuery.each( [ - "tabIndex", - "readOnly", - "maxLength", - "cellSpacing", - "cellPadding", - "rowSpan", - "colSpan", - "useMap", - "frameBorder", - "contentEditable" -], function() { - jQuery.propFix[ this.toLowerCase() ] = this; -} ); - - - - - // Strip and collapse whitespace according to HTML spec - // https://infra.spec.whatwg.org/#strip-and-collapse-ascii-whitespace - function stripAndCollapse( value ) { - var tokens = value.match( rnothtmlwhite ) || []; - return tokens.join( " " ); - } - - -function getClass( elem ) { - return elem.getAttribute && elem.getAttribute( "class" ) || ""; -} - -function classesToArray( value ) { - if ( Array.isArray( value ) ) { - return value; - } - if ( typeof value === "string" ) { - return value.match( rnothtmlwhite ) || []; - } - return []; -} - -jQuery.fn.extend( { - addClass: function( value ) { - var classes, elem, cur, curValue, clazz, j, finalValue, - i = 0; - - if ( isFunction( value ) ) { - return this.each( function( j ) { - jQuery( this ).addClass( value.call( this, j, getClass( this ) ) ); - } ); - } - - classes = classesToArray( value ); - - if ( classes.length ) { - while ( ( elem = this[ i++ ] ) ) { - curValue = getClass( elem ); - cur = elem.nodeType === 1 && ( " " + stripAndCollapse( curValue ) + " " ); - - if ( cur ) { - j = 0; - while ( ( clazz = classes[ j++ ] ) ) { - if ( cur.indexOf( " " + clazz + " " ) < 0 ) { - cur += clazz + " "; - } - } - - // Only assign if different to avoid unneeded rendering. - finalValue = stripAndCollapse( cur ); - if ( curValue !== finalValue ) { - elem.setAttribute( "class", finalValue ); - } - } - } - } - - return this; - }, - - removeClass: function( value ) { - var classes, elem, cur, curValue, clazz, j, finalValue, - i = 0; - - if ( isFunction( value ) ) { - return this.each( function( j ) { - jQuery( this ).removeClass( value.call( this, j, getClass( this ) ) ); - } ); - } - - if ( !arguments.length ) { - return this.attr( "class", "" ); - } - - classes = classesToArray( value ); - - if ( classes.length ) { - while ( ( elem = this[ i++ ] ) ) { - curValue = getClass( elem ); - - // This expression is here for better compressibility (see addClass) - cur = elem.nodeType === 1 && ( " " + stripAndCollapse( curValue ) + " " ); - - if ( cur ) { - j = 0; - while ( ( clazz = classes[ j++ ] ) ) { - - // Remove *all* instances - while ( cur.indexOf( " " + clazz + " " ) > -1 ) { - cur = cur.replace( " " + clazz + " ", " " ); - } - } - - // Only assign if different to avoid unneeded rendering. - finalValue = stripAndCollapse( cur ); - if ( curValue !== finalValue ) { - elem.setAttribute( "class", finalValue ); - } - } - } - } - - return this; - }, - - toggleClass: function( value, stateVal ) { - var type = typeof value, - isValidValue = type === "string" || Array.isArray( value ); - - if ( typeof stateVal === "boolean" && isValidValue ) { - return stateVal ? this.addClass( value ) : this.removeClass( value ); - } - - if ( isFunction( value ) ) { - return this.each( function( i ) { - jQuery( this ).toggleClass( - value.call( this, i, getClass( this ), stateVal ), - stateVal - ); - } ); - } - - return this.each( function() { - var className, i, self, classNames; - - if ( isValidValue ) { - - // Toggle individual class names - i = 0; - self = jQuery( this ); - classNames = classesToArray( value ); - - while ( ( className = classNames[ i++ ] ) ) { - - // Check each className given, space separated list - if ( self.hasClass( className ) ) { - self.removeClass( className ); - } else { - self.addClass( className ); - } - } - - // Toggle whole class name - } else if ( value === undefined || type === "boolean" ) { - className = getClass( this ); - if ( className ) { - - // Store className if set - dataPriv.set( this, "__className__", className ); - } - - // If the element has a class name or if we're passed `false`, - // then remove the whole classname (if there was one, the above saved it). - // Otherwise bring back whatever was previously saved (if anything), - // falling back to the empty string if nothing was stored. - if ( this.setAttribute ) { - this.setAttribute( "class", - className || value === false ? - "" : - dataPriv.get( this, "__className__" ) || "" - ); - } - } - } ); - }, - - hasClass: function( selector ) { - var className, elem, - i = 0; - - className = " " + selector + " "; - while ( ( elem = this[ i++ ] ) ) { - if ( elem.nodeType === 1 && - ( " " + stripAndCollapse( getClass( elem ) ) + " " ).indexOf( className ) > -1 ) { - return true; - } - } - - return false; - } -} ); - - - - -var rreturn = /\r/g; - -jQuery.fn.extend( { - val: function( value ) { - var hooks, ret, valueIsFunction, - elem = this[ 0 ]; - - if ( !arguments.length ) { - if ( elem ) { - hooks = jQuery.valHooks[ elem.type ] || - jQuery.valHooks[ elem.nodeName.toLowerCase() ]; - - if ( hooks && - "get" in hooks && - ( ret = hooks.get( elem, "value" ) ) !== undefined - ) { - return ret; - } - - ret = elem.value; - - // Handle most common string cases - if ( typeof ret === "string" ) { - return ret.replace( rreturn, "" ); - } - - // Handle cases where value is null/undef or number - return ret == null ? "" : ret; - } - - return; - } - - valueIsFunction = isFunction( value ); - - return this.each( function( i ) { - var val; - - if ( this.nodeType !== 1 ) { - return; - } - - if ( valueIsFunction ) { - val = value.call( this, i, jQuery( this ).val() ); - } else { - val = value; - } - - // Treat null/undefined as ""; convert numbers to string - if ( val == null ) { - val = ""; - - } else if ( typeof val === "number" ) { - val += ""; - - } else if ( Array.isArray( val ) ) { - val = jQuery.map( val, function( value ) { - return value == null ? "" : value + ""; - } ); - } - - hooks = jQuery.valHooks[ this.type ] || jQuery.valHooks[ this.nodeName.toLowerCase() ]; - - // If set returns undefined, fall back to normal setting - if ( !hooks || !( "set" in hooks ) || hooks.set( this, val, "value" ) === undefined ) { - this.value = val; - } - } ); - } -} ); - -jQuery.extend( { - valHooks: { - option: { - get: function( elem ) { - - var val = jQuery.find.attr( elem, "value" ); - return val != null ? - val : - - // Support: IE <=10 - 11 only - // option.text throws exceptions (#14686, #14858) - // Strip and collapse whitespace - // https://html.spec.whatwg.org/#strip-and-collapse-whitespace - stripAndCollapse( jQuery.text( elem ) ); - } - }, - select: { - get: function( elem ) { - var value, option, i, - options = elem.options, - index = elem.selectedIndex, - one = elem.type === "select-one", - values = one ? null : [], - max = one ? index + 1 : options.length; - - if ( index < 0 ) { - i = max; - - } else { - i = one ? index : 0; - } - - // Loop through all the selected options - for ( ; i < max; i++ ) { - option = options[ i ]; - - // Support: IE <=9 only - // IE8-9 doesn't update selected after form reset (#2551) - if ( ( option.selected || i === index ) && - - // Don't return options that are disabled or in a disabled optgroup - !option.disabled && - ( !option.parentNode.disabled || - !nodeName( option.parentNode, "optgroup" ) ) ) { - - // Get the specific value for the option - value = jQuery( option ).val(); - - // We don't need an array for one selects - if ( one ) { - return value; - } - - // Multi-Selects return an array - values.push( value ); - } - } - - return values; - }, - - set: function( elem, value ) { - var optionSet, option, - options = elem.options, - values = jQuery.makeArray( value ), - i = options.length; - - while ( i-- ) { - option = options[ i ]; - - /* eslint-disable no-cond-assign */ - - if ( option.selected = - jQuery.inArray( jQuery.valHooks.option.get( option ), values ) > -1 - ) { - optionSet = true; - } - - /* eslint-enable no-cond-assign */ - } - - // Force browsers to behave consistently when non-matching value is set - if ( !optionSet ) { - elem.selectedIndex = -1; - } - return values; - } - } - } -} ); - -// Radios and checkboxes getter/setter -jQuery.each( [ "radio", "checkbox" ], function() { - jQuery.valHooks[ this ] = { - set: function( elem, value ) { - if ( Array.isArray( value ) ) { - return ( elem.checked = jQuery.inArray( jQuery( elem ).val(), value ) > -1 ); - } - } - }; - if ( !support.checkOn ) { - jQuery.valHooks[ this ].get = function( elem ) { - return elem.getAttribute( "value" ) === null ? "on" : elem.value; - }; - } -} ); - - - - -// Return jQuery for attributes-only inclusion - - -support.focusin = "onfocusin" in window; - - -var rfocusMorph = /^(?:focusinfocus|focusoutblur)$/, - stopPropagationCallback = function( e ) { - e.stopPropagation(); - }; - -jQuery.extend( jQuery.event, { - - trigger: function( event, data, elem, onlyHandlers ) { - - var i, cur, tmp, bubbleType, ontype, handle, special, lastElement, - eventPath = [ elem || document ], - type = hasOwn.call( event, "type" ) ? event.type : event, - namespaces = hasOwn.call( event, "namespace" ) ? event.namespace.split( "." ) : []; - - cur = lastElement = tmp = elem = elem || document; - - // Don't do events on text and comment nodes - if ( elem.nodeType === 3 || elem.nodeType === 8 ) { - return; - } - - // focus/blur morphs to focusin/out; ensure we're not firing them right now - if ( rfocusMorph.test( type + jQuery.event.triggered ) ) { - return; - } - - if ( type.indexOf( "." ) > -1 ) { - - // Namespaced trigger; create a regexp to match event type in handle() - namespaces = type.split( "." ); - type = namespaces.shift(); - namespaces.sort(); - } - ontype = type.indexOf( ":" ) < 0 && "on" + type; - - // Caller can pass in a jQuery.Event object, Object, or just an event type string - event = event[ jQuery.expando ] ? - event : - new jQuery.Event( type, typeof event === "object" && event ); - - // Trigger bitmask: & 1 for native handlers; & 2 for jQuery (always true) - event.isTrigger = onlyHandlers ? 2 : 3; - event.namespace = namespaces.join( "." ); - event.rnamespace = event.namespace ? - new RegExp( "(^|\\.)" + namespaces.join( "\\.(?:.*\\.|)" ) + "(\\.|$)" ) : - null; - - // Clean up the event in case it is being reused - event.result = undefined; - if ( !event.target ) { - event.target = elem; - } - - // Clone any incoming data and prepend the event, creating the handler arg list - data = data == null ? - [ event ] : - jQuery.makeArray( data, [ event ] ); - - // Allow special events to draw outside the lines - special = jQuery.event.special[ type ] || {}; - if ( !onlyHandlers && special.trigger && special.trigger.apply( elem, data ) === false ) { - return; - } - - // Determine event propagation path in advance, per W3C events spec (#9951) - // Bubble up to document, then to window; watch for a global ownerDocument var (#9724) - if ( !onlyHandlers && !special.noBubble && !isWindow( elem ) ) { - - bubbleType = special.delegateType || type; - if ( !rfocusMorph.test( bubbleType + type ) ) { - cur = cur.parentNode; - } - for ( ; cur; cur = cur.parentNode ) { - eventPath.push( cur ); - tmp = cur; - } - - // Only add window if we got to document (e.g., not plain obj or detached DOM) - if ( tmp === ( elem.ownerDocument || document ) ) { - eventPath.push( tmp.defaultView || tmp.parentWindow || window ); - } - } - - // Fire handlers on the event path - i = 0; - while ( ( cur = eventPath[ i++ ] ) && !event.isPropagationStopped() ) { - lastElement = cur; - event.type = i > 1 ? - bubbleType : - special.bindType || type; - - // jQuery handler - handle = ( - dataPriv.get( cur, "events" ) || Object.create( null ) - )[ event.type ] && - dataPriv.get( cur, "handle" ); - if ( handle ) { - handle.apply( cur, data ); - } - - // Native handler - handle = ontype && cur[ ontype ]; - if ( handle && handle.apply && acceptData( cur ) ) { - event.result = handle.apply( cur, data ); - if ( event.result === false ) { - event.preventDefault(); - } - } - } - event.type = type; - - // If nobody prevented the default action, do it now - if ( !onlyHandlers && !event.isDefaultPrevented() ) { - - if ( ( !special._default || - special._default.apply( eventPath.pop(), data ) === false ) && - acceptData( elem ) ) { - - // Call a native DOM method on the target with the same name as the event. - // Don't do default actions on window, that's where global variables be (#6170) - if ( ontype && isFunction( elem[ type ] ) && !isWindow( elem ) ) { - - // Don't re-trigger an onFOO event when we call its FOO() method - tmp = elem[ ontype ]; - - if ( tmp ) { - elem[ ontype ] = null; - } - - // Prevent re-triggering of the same event, since we already bubbled it above - jQuery.event.triggered = type; - - if ( event.isPropagationStopped() ) { - lastElement.addEventListener( type, stopPropagationCallback ); - } - - elem[ type ](); - - if ( event.isPropagationStopped() ) { - lastElement.removeEventListener( type, stopPropagationCallback ); - } - - jQuery.event.triggered = undefined; - - if ( tmp ) { - elem[ ontype ] = tmp; - } - } - } - } - - return event.result; - }, - - // Piggyback on a donor event to simulate a different one - // Used only for `focus(in | out)` events - simulate: function( type, elem, event ) { - var e = jQuery.extend( - new jQuery.Event(), - event, - { - type: type, - isSimulated: true - } - ); - - jQuery.event.trigger( e, null, elem ); - } - -} ); - -jQuery.fn.extend( { - - trigger: function( type, data ) { - return this.each( function() { - jQuery.event.trigger( type, data, this ); - } ); - }, - triggerHandler: function( type, data ) { - var elem = this[ 0 ]; - if ( elem ) { - return jQuery.event.trigger( type, data, elem, true ); - } - } -} ); - - -// Support: Firefox <=44 -// Firefox doesn't have focus(in | out) events -// Related ticket - https://bugzilla.mozilla.org/show_bug.cgi?id=687787 -// -// Support: Chrome <=48 - 49, Safari <=9.0 - 9.1 -// focus(in | out) events fire after focus & blur events, -// which is spec violation - http://www.w3.org/TR/DOM-Level-3-Events/#events-focusevent-event-order -// Related ticket - https://bugs.chromium.org/p/chromium/issues/detail?id=449857 -if ( !support.focusin ) { - jQuery.each( { focus: "focusin", blur: "focusout" }, function( orig, fix ) { - - // Attach a single capturing handler on the document while someone wants focusin/focusout - var handler = function( event ) { - jQuery.event.simulate( fix, event.target, jQuery.event.fix( event ) ); - }; - - jQuery.event.special[ fix ] = { - setup: function() { - - // Handle: regular nodes (via `this.ownerDocument`), window - // (via `this.document`) & document (via `this`). - var doc = this.ownerDocument || this.document || this, - attaches = dataPriv.access( doc, fix ); - - if ( !attaches ) { - doc.addEventListener( orig, handler, true ); - } - dataPriv.access( doc, fix, ( attaches || 0 ) + 1 ); - }, - teardown: function() { - var doc = this.ownerDocument || this.document || this, - attaches = dataPriv.access( doc, fix ) - 1; - - if ( !attaches ) { - doc.removeEventListener( orig, handler, true ); - dataPriv.remove( doc, fix ); - - } else { - dataPriv.access( doc, fix, attaches ); - } - } - }; - } ); -} -var location = window.location; - -var nonce = { guid: Date.now() }; - -var rquery = ( /\?/ ); - - - -// Cross-browser xml parsing -jQuery.parseXML = function( data ) { - var xml; - if ( !data || typeof data !== "string" ) { - return null; - } - - // Support: IE 9 - 11 only - // IE throws on parseFromString with invalid input. - try { - xml = ( new window.DOMParser() ).parseFromString( data, "text/xml" ); - } catch ( e ) { - xml = undefined; - } - - if ( !xml || xml.getElementsByTagName( "parsererror" ).length ) { - jQuery.error( "Invalid XML: " + data ); - } - return xml; -}; - - -var - rbracket = /\[\]$/, - rCRLF = /\r?\n/g, - rsubmitterTypes = /^(?:submit|button|image|reset|file)$/i, - rsubmittable = /^(?:input|select|textarea|keygen)/i; - -function buildParams( prefix, obj, traditional, add ) { - var name; - - if ( Array.isArray( obj ) ) { - - // Serialize array item. - jQuery.each( obj, function( i, v ) { - if ( traditional || rbracket.test( prefix ) ) { - - // Treat each array item as a scalar. - add( prefix, v ); - - } else { - - // Item is non-scalar (array or object), encode its numeric index. - buildParams( - prefix + "[" + ( typeof v === "object" && v != null ? i : "" ) + "]", - v, - traditional, - add - ); - } - } ); - - } else if ( !traditional && toType( obj ) === "object" ) { - - // Serialize object item. - for ( name in obj ) { - buildParams( prefix + "[" + name + "]", obj[ name ], traditional, add ); - } - - } else { - - // Serialize scalar item. - add( prefix, obj ); - } -} - -// Serialize an array of form elements or a set of -// key/values into a query string -jQuery.param = function( a, traditional ) { - var prefix, - s = [], - add = function( key, valueOrFunction ) { - - // If value is a function, invoke it and use its return value - var value = isFunction( valueOrFunction ) ? - valueOrFunction() : - valueOrFunction; - - s[ s.length ] = encodeURIComponent( key ) + "=" + - encodeURIComponent( value == null ? "" : value ); - }; - - if ( a == null ) { - return ""; - } - - // If an array was passed in, assume that it is an array of form elements. - if ( Array.isArray( a ) || ( a.jquery && !jQuery.isPlainObject( a ) ) ) { - - // Serialize the form elements - jQuery.each( a, function() { - add( this.name, this.value ); - } ); - - } else { - - // If traditional, encode the "old" way (the way 1.3.2 or older - // did it), otherwise encode params recursively. - for ( prefix in a ) { - buildParams( prefix, a[ prefix ], traditional, add ); - } - } - - // Return the resulting serialization - return s.join( "&" ); -}; - -jQuery.fn.extend( { - serialize: function() { - return jQuery.param( this.serializeArray() ); - }, - serializeArray: function() { - return this.map( function() { - - // Can add propHook for "elements" to filter or add form elements - var elements = jQuery.prop( this, "elements" ); - return elements ? jQuery.makeArray( elements ) : this; - } ) - .filter( function() { - var type = this.type; - - // Use .is( ":disabled" ) so that fieldset[disabled] works - return this.name && !jQuery( this ).is( ":disabled" ) && - rsubmittable.test( this.nodeName ) && !rsubmitterTypes.test( type ) && - ( this.checked || !rcheckableType.test( type ) ); - } ) - .map( function( _i, elem ) { - var val = jQuery( this ).val(); - - if ( val == null ) { - return null; - } - - if ( Array.isArray( val ) ) { - return jQuery.map( val, function( val ) { - return { name: elem.name, value: val.replace( rCRLF, "\r\n" ) }; - } ); - } - - return { name: elem.name, value: val.replace( rCRLF, "\r\n" ) }; - } ).get(); - } -} ); - - -var - r20 = /%20/g, - rhash = /#.*$/, - rantiCache = /([?&])_=[^&]*/, - rheaders = /^(.*?):[ \t]*([^\r\n]*)$/mg, - - // #7653, #8125, #8152: local protocol detection - rlocalProtocol = /^(?:about|app|app-storage|.+-extension|file|res|widget):$/, - rnoContent = /^(?:GET|HEAD)$/, - rprotocol = /^\/\//, - - /* Prefilters - * 1) They are useful to introduce custom dataTypes (see ajax/jsonp.js for an example) - * 2) These are called: - * - BEFORE asking for a transport - * - AFTER param serialization (s.data is a string if s.processData is true) - * 3) key is the dataType - * 4) the catchall symbol "*" can be used - * 5) execution will start with transport dataType and THEN continue down to "*" if needed - */ - prefilters = {}, - - /* Transports bindings - * 1) key is the dataType - * 2) the catchall symbol "*" can be used - * 3) selection will start with transport dataType and THEN go to "*" if needed - */ - transports = {}, - - // Avoid comment-prolog char sequence (#10098); must appease lint and evade compression - allTypes = "*/".concat( "*" ), - - // Anchor tag for parsing the document origin - originAnchor = document.createElement( "a" ); - originAnchor.href = location.href; - -// Base "constructor" for jQuery.ajaxPrefilter and jQuery.ajaxTransport -function addToPrefiltersOrTransports( structure ) { - - // dataTypeExpression is optional and defaults to "*" - return function( dataTypeExpression, func ) { - - if ( typeof dataTypeExpression !== "string" ) { - func = dataTypeExpression; - dataTypeExpression = "*"; - } - - var dataType, - i = 0, - dataTypes = dataTypeExpression.toLowerCase().match( rnothtmlwhite ) || []; - - if ( isFunction( func ) ) { - - // For each dataType in the dataTypeExpression - while ( ( dataType = dataTypes[ i++ ] ) ) { - - // Prepend if requested - if ( dataType[ 0 ] === "+" ) { - dataType = dataType.slice( 1 ) || "*"; - ( structure[ dataType ] = structure[ dataType ] || [] ).unshift( func ); - - // Otherwise append - } else { - ( structure[ dataType ] = structure[ dataType ] || [] ).push( func ); - } - } - } - }; -} - -// Base inspection function for prefilters and transports -function inspectPrefiltersOrTransports( structure, options, originalOptions, jqXHR ) { - - var inspected = {}, - seekingTransport = ( structure === transports ); - - function inspect( dataType ) { - var selected; - inspected[ dataType ] = true; - jQuery.each( structure[ dataType ] || [], function( _, prefilterOrFactory ) { - var dataTypeOrTransport = prefilterOrFactory( options, originalOptions, jqXHR ); - if ( typeof dataTypeOrTransport === "string" && - !seekingTransport && !inspected[ dataTypeOrTransport ] ) { - - options.dataTypes.unshift( dataTypeOrTransport ); - inspect( dataTypeOrTransport ); - return false; - } else if ( seekingTransport ) { - return !( selected = dataTypeOrTransport ); - } - } ); - return selected; - } - - return inspect( options.dataTypes[ 0 ] ) || !inspected[ "*" ] && inspect( "*" ); -} - -// A special extend for ajax options -// that takes "flat" options (not to be deep extended) -// Fixes #9887 -function ajaxExtend( target, src ) { - var key, deep, - flatOptions = jQuery.ajaxSettings.flatOptions || {}; - - for ( key in src ) { - if ( src[ key ] !== undefined ) { - ( flatOptions[ key ] ? target : ( deep || ( deep = {} ) ) )[ key ] = src[ key ]; - } - } - if ( deep ) { - jQuery.extend( true, target, deep ); - } - - return target; -} - -/* Handles responses to an ajax request: - * - finds the right dataType (mediates between content-type and expected dataType) - * - returns the corresponding response - */ -function ajaxHandleResponses( s, jqXHR, responses ) { - - var ct, type, finalDataType, firstDataType, - contents = s.contents, - dataTypes = s.dataTypes; - - // Remove auto dataType and get content-type in the process - while ( dataTypes[ 0 ] === "*" ) { - dataTypes.shift(); - if ( ct === undefined ) { - ct = s.mimeType || jqXHR.getResponseHeader( "Content-Type" ); - } - } - - // Check if we're dealing with a known content-type - if ( ct ) { - for ( type in contents ) { - if ( contents[ type ] && contents[ type ].test( ct ) ) { - dataTypes.unshift( type ); - break; - } - } - } - - // Check to see if we have a response for the expected dataType - if ( dataTypes[ 0 ] in responses ) { - finalDataType = dataTypes[ 0 ]; - } else { - - // Try convertible dataTypes - for ( type in responses ) { - if ( !dataTypes[ 0 ] || s.converters[ type + " " + dataTypes[ 0 ] ] ) { - finalDataType = type; - break; - } - if ( !firstDataType ) { - firstDataType = type; - } - } - - // Or just use first one - finalDataType = finalDataType || firstDataType; - } - - // If we found a dataType - // We add the dataType to the list if needed - // and return the corresponding response - if ( finalDataType ) { - if ( finalDataType !== dataTypes[ 0 ] ) { - dataTypes.unshift( finalDataType ); - } - return responses[ finalDataType ]; - } -} - -/* Chain conversions given the request and the original response - * Also sets the responseXXX fields on the jqXHR instance - */ -function ajaxConvert( s, response, jqXHR, isSuccess ) { - var conv2, current, conv, tmp, prev, - converters = {}, - - // Work with a copy of dataTypes in case we need to modify it for conversion - dataTypes = s.dataTypes.slice(); - - // Create converters map with lowercased keys - if ( dataTypes[ 1 ] ) { - for ( conv in s.converters ) { - converters[ conv.toLowerCase() ] = s.converters[ conv ]; - } - } - - current = dataTypes.shift(); - - // Convert to each sequential dataType - while ( current ) { - - if ( s.responseFields[ current ] ) { - jqXHR[ s.responseFields[ current ] ] = response; - } - - // Apply the dataFilter if provided - if ( !prev && isSuccess && s.dataFilter ) { - response = s.dataFilter( response, s.dataType ); - } - - prev = current; - current = dataTypes.shift(); - - if ( current ) { - - // There's only work to do if current dataType is non-auto - if ( current === "*" ) { - - current = prev; - - // Convert response if prev dataType is non-auto and differs from current - } else if ( prev !== "*" && prev !== current ) { - - // Seek a direct converter - conv = converters[ prev + " " + current ] || converters[ "* " + current ]; - - // If none found, seek a pair - if ( !conv ) { - for ( conv2 in converters ) { - - // If conv2 outputs current - tmp = conv2.split( " " ); - if ( tmp[ 1 ] === current ) { - - // If prev can be converted to accepted input - conv = converters[ prev + " " + tmp[ 0 ] ] || - converters[ "* " + tmp[ 0 ] ]; - if ( conv ) { - - // Condense equivalence converters - if ( conv === true ) { - conv = converters[ conv2 ]; - - // Otherwise, insert the intermediate dataType - } else if ( converters[ conv2 ] !== true ) { - current = tmp[ 0 ]; - dataTypes.unshift( tmp[ 1 ] ); - } - break; - } - } - } - } - - // Apply converter (if not an equivalence) - if ( conv !== true ) { - - // Unless errors are allowed to bubble, catch and return them - if ( conv && s.throws ) { - response = conv( response ); - } else { - try { - response = conv( response ); - } catch ( e ) { - return { - state: "parsererror", - error: conv ? e : "No conversion from " + prev + " to " + current - }; - } - } - } - } - } - } - - return { state: "success", data: response }; -} - -jQuery.extend( { - - // Counter for holding the number of active queries - active: 0, - - // Last-Modified header cache for next request - lastModified: {}, - etag: {}, - - ajaxSettings: { - url: location.href, - type: "GET", - isLocal: rlocalProtocol.test( location.protocol ), - global: true, - processData: true, - async: true, - contentType: "application/x-www-form-urlencoded; charset=UTF-8", - - /* - timeout: 0, - data: null, - dataType: null, - username: null, - password: null, - cache: null, - throws: false, - traditional: false, - headers: {}, - */ - - accepts: { - "*": allTypes, - text: "text/plain", - html: "text/html", - xml: "application/xml, text/xml", - json: "application/json, text/javascript" - }, - - contents: { - xml: /\bxml\b/, - html: /\bhtml/, - json: /\bjson\b/ - }, - - responseFields: { - xml: "responseXML", - text: "responseText", - json: "responseJSON" - }, - - // Data converters - // Keys separate source (or catchall "*") and destination types with a single space - converters: { - - // Convert anything to text - "* text": String, - - // Text to html (true = no transformation) - "text html": true, - - // Evaluate text as a json expression - "text json": JSON.parse, - - // Parse text as xml - "text xml": jQuery.parseXML - }, - - // For options that shouldn't be deep extended: - // you can add your own custom options here if - // and when you create one that shouldn't be - // deep extended (see ajaxExtend) - flatOptions: { - url: true, - context: true - } - }, - - // Creates a full fledged settings object into target - // with both ajaxSettings and settings fields. - // If target is omitted, writes into ajaxSettings. - ajaxSetup: function( target, settings ) { - return settings ? - - // Building a settings object - ajaxExtend( ajaxExtend( target, jQuery.ajaxSettings ), settings ) : - - // Extending ajaxSettings - ajaxExtend( jQuery.ajaxSettings, target ); - }, - - ajaxPrefilter: addToPrefiltersOrTransports( prefilters ), - ajaxTransport: addToPrefiltersOrTransports( transports ), - - // Main method - ajax: function( url, options ) { - - // If url is an object, simulate pre-1.5 signature - if ( typeof url === "object" ) { - options = url; - url = undefined; - } - - // Force options to be an object - options = options || {}; - - var transport, - - // URL without anti-cache param - cacheURL, - - // Response headers - responseHeadersString, - responseHeaders, - - // timeout handle - timeoutTimer, - - // Url cleanup var - urlAnchor, - - // Request state (becomes false upon send and true upon completion) - completed, - - // To know if global events are to be dispatched - fireGlobals, - - // Loop variable - i, - - // uncached part of the url - uncached, - - // Create the final options object - s = jQuery.ajaxSetup( {}, options ), - - // Callbacks context - callbackContext = s.context || s, - - // Context for global events is callbackContext if it is a DOM node or jQuery collection - globalEventContext = s.context && - ( callbackContext.nodeType || callbackContext.jquery ) ? - jQuery( callbackContext ) : - jQuery.event, - - // Deferreds - deferred = jQuery.Deferred(), - completeDeferred = jQuery.Callbacks( "once memory" ), - - // Status-dependent callbacks - statusCode = s.statusCode || {}, - - // Headers (they are sent all at once) - requestHeaders = {}, - requestHeadersNames = {}, - - // Default abort message - strAbort = "canceled", - - // Fake xhr - jqXHR = { - readyState: 0, - - // Builds headers hashtable if needed - getResponseHeader: function( key ) { - var match; - if ( completed ) { - if ( !responseHeaders ) { - responseHeaders = {}; - while ( ( match = rheaders.exec( responseHeadersString ) ) ) { - responseHeaders[ match[ 1 ].toLowerCase() + " " ] = - ( responseHeaders[ match[ 1 ].toLowerCase() + " " ] || [] ) - .concat( match[ 2 ] ); - } - } - match = responseHeaders[ key.toLowerCase() + " " ]; - } - return match == null ? null : match.join( ", " ); - }, - - // Raw string - getAllResponseHeaders: function() { - return completed ? responseHeadersString : null; - }, - - // Caches the header - setRequestHeader: function( name, value ) { - if ( completed == null ) { - name = requestHeadersNames[ name.toLowerCase() ] = - requestHeadersNames[ name.toLowerCase() ] || name; - requestHeaders[ name ] = value; - } - return this; - }, - - // Overrides response content-type header - overrideMimeType: function( type ) { - if ( completed == null ) { - s.mimeType = type; - } - return this; - }, - - // Status-dependent callbacks - statusCode: function( map ) { - var code; - if ( map ) { - if ( completed ) { - - // Execute the appropriate callbacks - jqXHR.always( map[ jqXHR.status ] ); - } else { - - // Lazy-add the new callbacks in a way that preserves old ones - for ( code in map ) { - statusCode[ code ] = [ statusCode[ code ], map[ code ] ]; - } - } - } - return this; - }, - - // Cancel the request - abort: function( statusText ) { - var finalText = statusText || strAbort; - if ( transport ) { - transport.abort( finalText ); - } - done( 0, finalText ); - return this; - } - }; - - // Attach deferreds - deferred.promise( jqXHR ); - - // Add protocol if not provided (prefilters might expect it) - // Handle falsy url in the settings object (#10093: consistency with old signature) - // We also use the url parameter if available - s.url = ( ( url || s.url || location.href ) + "" ) - .replace( rprotocol, location.protocol + "//" ); - - // Alias method option to type as per ticket #12004 - s.type = options.method || options.type || s.method || s.type; - - // Extract dataTypes list - s.dataTypes = ( s.dataType || "*" ).toLowerCase().match( rnothtmlwhite ) || [ "" ]; - - // A cross-domain request is in order when the origin doesn't match the current origin. - if ( s.crossDomain == null ) { - urlAnchor = document.createElement( "a" ); - - // Support: IE <=8 - 11, Edge 12 - 15 - // IE throws exception on accessing the href property if url is malformed, - // e.g. http://example.com:80x/ - try { - urlAnchor.href = s.url; - - // Support: IE <=8 - 11 only - // Anchor's host property isn't correctly set when s.url is relative - urlAnchor.href = urlAnchor.href; - s.crossDomain = originAnchor.protocol + "//" + originAnchor.host !== - urlAnchor.protocol + "//" + urlAnchor.host; - } catch ( e ) { - - // If there is an error parsing the URL, assume it is crossDomain, - // it can be rejected by the transport if it is invalid - s.crossDomain = true; - } - } - - // Convert data if not already a string - if ( s.data && s.processData && typeof s.data !== "string" ) { - s.data = jQuery.param( s.data, s.traditional ); - } - - // Apply prefilters - inspectPrefiltersOrTransports( prefilters, s, options, jqXHR ); - - // If request was aborted inside a prefilter, stop there - if ( completed ) { - return jqXHR; - } - - // We can fire global events as of now if asked to - // Don't fire events if jQuery.event is undefined in an AMD-usage scenario (#15118) - fireGlobals = jQuery.event && s.global; - - // Watch for a new set of requests - if ( fireGlobals && jQuery.active++ === 0 ) { - jQuery.event.trigger( "ajaxStart" ); - } - - // Uppercase the type - s.type = s.type.toUpperCase(); - - // Determine if request has content - s.hasContent = !rnoContent.test( s.type ); - - // Save the URL in case we're toying with the If-Modified-Since - // and/or If-None-Match header later on - // Remove hash to simplify url manipulation - cacheURL = s.url.replace( rhash, "" ); - - // More options handling for requests with no content - if ( !s.hasContent ) { - - // Remember the hash so we can put it back - uncached = s.url.slice( cacheURL.length ); - - // If data is available and should be processed, append data to url - if ( s.data && ( s.processData || typeof s.data === "string" ) ) { - cacheURL += ( rquery.test( cacheURL ) ? "&" : "?" ) + s.data; - - // #9682: remove data so that it's not used in an eventual retry - delete s.data; - } - - // Add or update anti-cache param if needed - if ( s.cache === false ) { - cacheURL = cacheURL.replace( rantiCache, "$1" ); - uncached = ( rquery.test( cacheURL ) ? "&" : "?" ) + "_=" + ( nonce.guid++ ) + - uncached; - } - - // Put hash and anti-cache on the URL that will be requested (gh-1732) - s.url = cacheURL + uncached; - - // Change '%20' to '+' if this is encoded form body content (gh-2658) - } else if ( s.data && s.processData && - ( s.contentType || "" ).indexOf( "application/x-www-form-urlencoded" ) === 0 ) { - s.data = s.data.replace( r20, "+" ); - } - - // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode. - if ( s.ifModified ) { - if ( jQuery.lastModified[ cacheURL ] ) { - jqXHR.setRequestHeader( "If-Modified-Since", jQuery.lastModified[ cacheURL ] ); - } - if ( jQuery.etag[ cacheURL ] ) { - jqXHR.setRequestHeader( "If-None-Match", jQuery.etag[ cacheURL ] ); - } - } - - // Set the correct header, if data is being sent - if ( s.data && s.hasContent && s.contentType !== false || options.contentType ) { - jqXHR.setRequestHeader( "Content-Type", s.contentType ); - } - - // Set the Accepts header for the server, depending on the dataType - jqXHR.setRequestHeader( - "Accept", - s.dataTypes[ 0 ] && s.accepts[ s.dataTypes[ 0 ] ] ? - s.accepts[ s.dataTypes[ 0 ] ] + - ( s.dataTypes[ 0 ] !== "*" ? ", " + allTypes + "; q=0.01" : "" ) : - s.accepts[ "*" ] - ); - - // Check for headers option - for ( i in s.headers ) { - jqXHR.setRequestHeader( i, s.headers[ i ] ); - } - - // Allow custom headers/mimetypes and early abort - if ( s.beforeSend && - ( s.beforeSend.call( callbackContext, jqXHR, s ) === false || completed ) ) { - - // Abort if not done already and return - return jqXHR.abort(); - } - - // Aborting is no longer a cancellation - strAbort = "abort"; - - // Install callbacks on deferreds - completeDeferred.add( s.complete ); - jqXHR.done( s.success ); - jqXHR.fail( s.error ); - - // Get transport - transport = inspectPrefiltersOrTransports( transports, s, options, jqXHR ); - - // If no transport, we auto-abort - if ( !transport ) { - done( -1, "No Transport" ); - } else { - jqXHR.readyState = 1; - - // Send global event - if ( fireGlobals ) { - globalEventContext.trigger( "ajaxSend", [ jqXHR, s ] ); - } - - // If request was aborted inside ajaxSend, stop there - if ( completed ) { - return jqXHR; - } - - // Timeout - if ( s.async && s.timeout > 0 ) { - timeoutTimer = window.setTimeout( function() { - jqXHR.abort( "timeout" ); - }, s.timeout ); - } - - try { - completed = false; - transport.send( requestHeaders, done ); - } catch ( e ) { - - // Rethrow post-completion exceptions - if ( completed ) { - throw e; - } - - // Propagate others as results - done( -1, e ); - } - } - - // Callback for when everything is done - function done( status, nativeStatusText, responses, headers ) { - var isSuccess, success, error, response, modified, - statusText = nativeStatusText; - - // Ignore repeat invocations - if ( completed ) { - return; - } - - completed = true; - - // Clear timeout if it exists - if ( timeoutTimer ) { - window.clearTimeout( timeoutTimer ); - } - - // Dereference transport for early garbage collection - // (no matter how long the jqXHR object will be used) - transport = undefined; - - // Cache response headers - responseHeadersString = headers || ""; - - // Set readyState - jqXHR.readyState = status > 0 ? 4 : 0; - - // Determine if successful - isSuccess = status >= 200 && status < 300 || status === 304; - - // Get response data - if ( responses ) { - response = ajaxHandleResponses( s, jqXHR, responses ); - } - - // Use a noop converter for missing script - if ( !isSuccess && jQuery.inArray( "script", s.dataTypes ) > -1 ) { - s.converters[ "text script" ] = function() {}; - } - - // Convert no matter what (that way responseXXX fields are always set) - response = ajaxConvert( s, response, jqXHR, isSuccess ); - - // If successful, handle type chaining - if ( isSuccess ) { - - // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode. - if ( s.ifModified ) { - modified = jqXHR.getResponseHeader( "Last-Modified" ); - if ( modified ) { - jQuery.lastModified[ cacheURL ] = modified; - } - modified = jqXHR.getResponseHeader( "etag" ); - if ( modified ) { - jQuery.etag[ cacheURL ] = modified; - } - } - - // if no content - if ( status === 204 || s.type === "HEAD" ) { - statusText = "nocontent"; - - // if not modified - } else if ( status === 304 ) { - statusText = "notmodified"; - - // If we have data, let's convert it - } else { - statusText = response.state; - success = response.data; - error = response.error; - isSuccess = !error; - } - } else { - - // Extract error from statusText and normalize for non-aborts - error = statusText; - if ( status || !statusText ) { - statusText = "error"; - if ( status < 0 ) { - status = 0; - } - } - } - - // Set data for the fake xhr object - jqXHR.status = status; - jqXHR.statusText = ( nativeStatusText || statusText ) + ""; - - // Success/Error - if ( isSuccess ) { - deferred.resolveWith( callbackContext, [ success, statusText, jqXHR ] ); - } else { - deferred.rejectWith( callbackContext, [ jqXHR, statusText, error ] ); - } - - // Status-dependent callbacks - jqXHR.statusCode( statusCode ); - statusCode = undefined; - - if ( fireGlobals ) { - globalEventContext.trigger( isSuccess ? "ajaxSuccess" : "ajaxError", - [ jqXHR, s, isSuccess ? success : error ] ); - } - - // Complete - completeDeferred.fireWith( callbackContext, [ jqXHR, statusText ] ); - - if ( fireGlobals ) { - globalEventContext.trigger( "ajaxComplete", [ jqXHR, s ] ); - - // Handle the global AJAX counter - if ( !( --jQuery.active ) ) { - jQuery.event.trigger( "ajaxStop" ); - } - } - } - - return jqXHR; - }, - - getJSON: function( url, data, callback ) { - return jQuery.get( url, data, callback, "json" ); - }, - - getScript: function( url, callback ) { - return jQuery.get( url, undefined, callback, "script" ); - } -} ); - -jQuery.each( [ "get", "post" ], function( _i, method ) { - jQuery[ method ] = function( url, data, callback, type ) { - - // Shift arguments if data argument was omitted - if ( isFunction( data ) ) { - type = type || callback; - callback = data; - data = undefined; - } - - // The url can be an options object (which then must have .url) - return jQuery.ajax( jQuery.extend( { - url: url, - type: method, - dataType: type, - data: data, - success: callback - }, jQuery.isPlainObject( url ) && url ) ); - }; -} ); - -jQuery.ajaxPrefilter( function( s ) { - var i; - for ( i in s.headers ) { - if ( i.toLowerCase() === "content-type" ) { - s.contentType = s.headers[ i ] || ""; - } - } -} ); - - -jQuery._evalUrl = function( url, options, doc ) { - return jQuery.ajax( { - url: url, - - // Make this explicit, since user can override this through ajaxSetup (#11264) - type: "GET", - dataType: "script", - cache: true, - async: false, - global: false, - - // Only evaluate the response if it is successful (gh-4126) - // dataFilter is not invoked for failure responses, so using it instead - // of the default converter is kludgy but it works. - converters: { - "text script": function() {} - }, - dataFilter: function( response ) { - jQuery.globalEval( response, options, doc ); - } - } ); -}; - - -jQuery.fn.extend( { - wrapAll: function( html ) { - var wrap; - - if ( this[ 0 ] ) { - if ( isFunction( html ) ) { - html = html.call( this[ 0 ] ); - } - - // The elements to wrap the target around - wrap = jQuery( html, this[ 0 ].ownerDocument ).eq( 0 ).clone( true ); - - if ( this[ 0 ].parentNode ) { - wrap.insertBefore( this[ 0 ] ); - } - - wrap.map( function() { - var elem = this; - - while ( elem.firstElementChild ) { - elem = elem.firstElementChild; - } - - return elem; - } ).append( this ); - } - - return this; - }, - - wrapInner: function( html ) { - if ( isFunction( html ) ) { - return this.each( function( i ) { - jQuery( this ).wrapInner( html.call( this, i ) ); - } ); - } - - return this.each( function() { - var self = jQuery( this ), - contents = self.contents(); - - if ( contents.length ) { - contents.wrapAll( html ); - - } else { - self.append( html ); - } - } ); - }, - - wrap: function( html ) { - var htmlIsFunction = isFunction( html ); - - return this.each( function( i ) { - jQuery( this ).wrapAll( htmlIsFunction ? html.call( this, i ) : html ); - } ); - }, - - unwrap: function( selector ) { - this.parent( selector ).not( "body" ).each( function() { - jQuery( this ).replaceWith( this.childNodes ); - } ); - return this; - } -} ); - - -jQuery.expr.pseudos.hidden = function( elem ) { - return !jQuery.expr.pseudos.visible( elem ); -}; -jQuery.expr.pseudos.visible = function( elem ) { - return !!( elem.offsetWidth || elem.offsetHeight || elem.getClientRects().length ); -}; - - - - -jQuery.ajaxSettings.xhr = function() { - try { - return new window.XMLHttpRequest(); - } catch ( e ) {} -}; - -var xhrSuccessStatus = { - - // File protocol always yields status code 0, assume 200 - 0: 200, - - // Support: IE <=9 only - // #1450: sometimes IE returns 1223 when it should be 204 - 1223: 204 - }, - xhrSupported = jQuery.ajaxSettings.xhr(); - -support.cors = !!xhrSupported && ( "withCredentials" in xhrSupported ); -support.ajax = xhrSupported = !!xhrSupported; - -jQuery.ajaxTransport( function( options ) { - var callback, errorCallback; - - // Cross domain only allowed if supported through XMLHttpRequest - if ( support.cors || xhrSupported && !options.crossDomain ) { - return { - send: function( headers, complete ) { - var i, - xhr = options.xhr(); - - xhr.open( - options.type, - options.url, - options.async, - options.username, - options.password - ); - - // Apply custom fields if provided - if ( options.xhrFields ) { - for ( i in options.xhrFields ) { - xhr[ i ] = options.xhrFields[ i ]; - } - } - - // Override mime type if needed - if ( options.mimeType && xhr.overrideMimeType ) { - xhr.overrideMimeType( options.mimeType ); - } - - // X-Requested-With header - // For cross-domain requests, seeing as conditions for a preflight are - // akin to a jigsaw puzzle, we simply never set it to be sure. - // (it can always be set on a per-request basis or even using ajaxSetup) - // For same-domain requests, won't change header if already provided. - if ( !options.crossDomain && !headers[ "X-Requested-With" ] ) { - headers[ "X-Requested-With" ] = "XMLHttpRequest"; - } - - // Set headers - for ( i in headers ) { - xhr.setRequestHeader( i, headers[ i ] ); - } - - // Callback - callback = function( type ) { - return function() { - if ( callback ) { - callback = errorCallback = xhr.onload = - xhr.onerror = xhr.onabort = xhr.ontimeout = - xhr.onreadystatechange = null; - - if ( type === "abort" ) { - xhr.abort(); - } else if ( type === "error" ) { - - // Support: IE <=9 only - // On a manual native abort, IE9 throws - // errors on any property access that is not readyState - if ( typeof xhr.status !== "number" ) { - complete( 0, "error" ); - } else { - complete( - - // File: protocol always yields status 0; see #8605, #14207 - xhr.status, - xhr.statusText - ); - } - } else { - complete( - xhrSuccessStatus[ xhr.status ] || xhr.status, - xhr.statusText, - - // Support: IE <=9 only - // IE9 has no XHR2 but throws on binary (trac-11426) - // For XHR2 non-text, let the caller handle it (gh-2498) - ( xhr.responseType || "text" ) !== "text" || - typeof xhr.responseText !== "string" ? - { binary: xhr.response } : - { text: xhr.responseText }, - xhr.getAllResponseHeaders() - ); - } - } - }; - }; - - // Listen to events - xhr.onload = callback(); - errorCallback = xhr.onerror = xhr.ontimeout = callback( "error" ); - - // Support: IE 9 only - // Use onreadystatechange to replace onabort - // to handle uncaught aborts - if ( xhr.onabort !== undefined ) { - xhr.onabort = errorCallback; - } else { - xhr.onreadystatechange = function() { - - // Check readyState before timeout as it changes - if ( xhr.readyState === 4 ) { - - // Allow onerror to be called first, - // but that will not handle a native abort - // Also, save errorCallback to a variable - // as xhr.onerror cannot be accessed - window.setTimeout( function() { - if ( callback ) { - errorCallback(); - } - } ); - } - }; - } - - // Create the abort callback - callback = callback( "abort" ); - - try { - - // Do send the request (this may raise an exception) - xhr.send( options.hasContent && options.data || null ); - } catch ( e ) { - - // #14683: Only rethrow if this hasn't been notified as an error yet - if ( callback ) { - throw e; - } - } - }, - - abort: function() { - if ( callback ) { - callback(); - } - } - }; - } -} ); - - - - -// Prevent auto-execution of scripts when no explicit dataType was provided (See gh-2432) -jQuery.ajaxPrefilter( function( s ) { - if ( s.crossDomain ) { - s.contents.script = false; - } -} ); - -// Install script dataType -jQuery.ajaxSetup( { - accepts: { - script: "text/javascript, application/javascript, " + - "application/ecmascript, application/x-ecmascript" - }, - contents: { - script: /\b(?:java|ecma)script\b/ - }, - converters: { - "text script": function( text ) { - jQuery.globalEval( text ); - return text; - } - } -} ); - -// Handle cache's special case and crossDomain -jQuery.ajaxPrefilter( "script", function( s ) { - if ( s.cache === undefined ) { - s.cache = false; - } - if ( s.crossDomain ) { - s.type = "GET"; - } -} ); - -// Bind script tag hack transport -jQuery.ajaxTransport( "script", function( s ) { - - // This transport only deals with cross domain or forced-by-attrs requests - if ( s.crossDomain || s.scriptAttrs ) { - var script, callback; - return { - send: function( _, complete ) { - script = jQuery( "\r\n"; - -// inject VBScript -document.write(IEBinaryToArray_ByteStr_Script); - -global.JSZipUtils._getBinaryFromXHR = function (xhr) { - var binary = xhr.responseBody; - var byteMapping = {}; - for ( var i = 0; i < 256; i++ ) { - for ( var j = 0; j < 256; j++ ) { - byteMapping[ String.fromCharCode( i + (j << 8) ) ] = - String.fromCharCode(i) + String.fromCharCode(j); - } - } - var rawBytes = IEBinaryToArray_ByteStr(binary); - var lastChr = IEBinaryToArray_ByteStr_Last(binary); - return rawBytes.replace(/[\s\S]/g, function( match ) { - return byteMapping[match]; - }) + lastChr; -}; - -// enforcing Stuk's coding style -// vim: set shiftwidth=4 softtabstop=4: - -},{}]},{},[1]) -; diff --git a/cdi/4.1/apidocs/jquery/jszip-utils/dist/jszip-utils-ie.min.js b/cdi/4.1/apidocs/jquery/jszip-utils/dist/jszip-utils-ie.min.js deleted file mode 100644 index 93d8bc8ef2..0000000000 --- a/cdi/4.1/apidocs/jquery/jszip-utils/dist/jszip-utils-ie.min.js +++ /dev/null @@ -1,10 +0,0 @@ -/*! - -JSZipUtils - A collection of cross-browser utilities to go along with JSZip. - - -(c) 2014 Stuart Knightley, David Duponchel -Dual licenced under the MIT license or GPLv3. See https://raw.github.com/Stuk/jszip-utils/master/LICENSE.markdown. - -*/ -!function a(b,c,d){function e(g,h){if(!c[g]){if(!b[g]){var i="function"==typeof require&&require;if(!h&&i)return i(g,!0);if(f)return f(g,!0);throw new Error("Cannot find module '"+g+"'")}var j=c[g]={exports:{}};b[g][0].call(j.exports,function(a){var c=b[g][1][a];return e(c?c:a)},j,j.exports,a,b,c,d)}return c[g].exports}for(var f="function"==typeof require&&require,g=0;g\r\n";document.write(b),a.JSZipUtils._getBinaryFromXHR=function(a){for(var b=a.responseBody,c={},d=0;256>d;d++)for(var e=0;256>e;e++)c[String.fromCharCode(d+(e<<8))]=String.fromCharCode(d)+String.fromCharCode(e);var f=IEBinaryToArray_ByteStr(b),g=IEBinaryToArray_ByteStr_Last(b);return f.replace(/[\s\S]/g,function(a){return c[a]})+g}},{}]},{},[1]); diff --git a/cdi/4.1/apidocs/jquery/jszip-utils/dist/jszip-utils.js b/cdi/4.1/apidocs/jquery/jszip-utils/dist/jszip-utils.js deleted file mode 100644 index 775895ec92..0000000000 --- a/cdi/4.1/apidocs/jquery/jszip-utils/dist/jszip-utils.js +++ /dev/null @@ -1,118 +0,0 @@ -/*! - -JSZipUtils - A collection of cross-browser utilities to go along with JSZip. - - -(c) 2014 Stuart Knightley, David Duponchel -Dual licenced under the MIT license or GPLv3. See https://raw.github.com/Stuk/jszip-utils/master/LICENSE.markdown. - -*/ -!function(e){"object"==typeof exports?module.exports=e():"function"==typeof define&&define.amd?define(e):"undefined"!=typeof window?window.JSZipUtils=e():"undefined"!=typeof global?global.JSZipUtils=e():"undefined"!=typeof self&&(self.JSZipUtils=e())}(function(){var define,module,exports;return (function e(t,n,r){function s(o,u){if(!n[o]){if(!t[o]){var a=typeof require=="function"&&require;if(!u&&a)return a(o,!0);if(i)return i(o,!0);throw new Error("Cannot find module '"+o+"'")}var f=n[o]={exports:{}};t[o][0].call(f.exports,function(e){var n=t[o][1][e];return s(n?n:e)},f,f.exports,e,t,n,r)}return n[o].exports}var i=typeof require=="function"&&require;for(var o=0;o - -(c) 2014 Stuart Knightley, David Duponchel -Dual licenced under the MIT license or GPLv3. See https://raw.github.com/Stuk/jszip-utils/master/LICENSE.markdown. - -*/ -!function(a){"object"==typeof exports?module.exports=a():"function"==typeof define&&define.amd?define(a):"undefined"!=typeof window?window.JSZipUtils=a():"undefined"!=typeof global?global.JSZipUtils=a():"undefined"!=typeof self&&(self.JSZipUtils=a())}(function(){return function a(b,c,d){function e(g,h){if(!c[g]){if(!b[g]){var i="function"==typeof require&&require;if(!h&&i)return i(g,!0);if(f)return f(g,!0);throw new Error("Cannot find module '"+g+"'")}var j=c[g]={exports:{}};b[g][0].call(j.exports,function(a){var c=b[g][1][a];return e(c?c:a)},j,j.exports,a,b,c,d)}return c[g].exports}for(var f="function"==typeof require&&require,g=0;g - -(c) 2009-2016 Stuart Knightley -Dual licenced under the MIT license or GPLv3. See https://raw.github.com/Stuk/jszip/master/LICENSE.markdown. - -JSZip uses the library pako released under the MIT license : -https://github.com/nodeca/pako/blob/master/LICENSE -*/ - -(function(f){if(typeof exports==="object"&&typeof module!=="undefined"){module.exports=f()}else if(typeof define==="function"&&define.amd){define([],f)}else{var g;if(typeof window!=="undefined"){g=window}else if(typeof global!=="undefined"){g=global}else if(typeof self!=="undefined"){g=self}else{g=this}g.JSZip = f()}})(function(){var define,module,exports;return (function e(t,n,r){function s(o,u){if(!n[o]){if(!t[o]){var a=typeof require=="function"&&require;if(!u&&a)return a(o,!0);if(i)return i(o,!0);var f=new Error("Cannot find module '"+o+"'");throw f.code="MODULE_NOT_FOUND",f}var l=n[o]={exports:{}};t[o][0].call(l.exports,function(e){var n=t[o][1][e];return s(n?n:e)},l,l.exports,e,t,n,r)}return n[o].exports}var i=typeof require=="function"&&require;for(var o=0;o> 2; - enc2 = ((chr1 & 3) << 4) | (chr2 >> 4); - enc3 = remainingBytes > 1 ? (((chr2 & 15) << 2) | (chr3 >> 6)) : 64; - enc4 = remainingBytes > 2 ? (chr3 & 63) : 64; - - output.push(_keyStr.charAt(enc1) + _keyStr.charAt(enc2) + _keyStr.charAt(enc3) + _keyStr.charAt(enc4)); - - } - - return output.join(""); -}; - -// public method for decoding -exports.decode = function(input) { - var chr1, chr2, chr3; - var enc1, enc2, enc3, enc4; - var i = 0, resultIndex = 0; - - var dataUrlPrefix = "data:"; - - if (input.substr(0, dataUrlPrefix.length) === dataUrlPrefix) { - // This is a common error: people give a data url - // (data:image/png;base64,iVBOR...) with a {base64: true} and - // wonders why things don't work. - // We can detect that the string input looks like a data url but we - // *can't* be sure it is one: removing everything up to the comma would - // be too dangerous. - throw new Error("Invalid base64 input, it looks like a data url."); - } - - input = input.replace(/[^A-Za-z0-9\+\/\=]/g, ""); - - var totalLength = input.length * 3 / 4; - if(input.charAt(input.length - 1) === _keyStr.charAt(64)) { - totalLength--; - } - if(input.charAt(input.length - 2) === _keyStr.charAt(64)) { - totalLength--; - } - if (totalLength % 1 !== 0) { - // totalLength is not an integer, the length does not match a valid - // base64 content. That can happen if: - // - the input is not a base64 content - // - the input is *almost* a base64 content, with a extra chars at the - // beginning or at the end - // - the input uses a base64 variant (base64url for example) - throw new Error("Invalid base64 input, bad content length."); - } - var output; - if (support.uint8array) { - output = new Uint8Array(totalLength|0); - } else { - output = new Array(totalLength|0); - } - - while (i < input.length) { - - enc1 = _keyStr.indexOf(input.charAt(i++)); - enc2 = _keyStr.indexOf(input.charAt(i++)); - enc3 = _keyStr.indexOf(input.charAt(i++)); - enc4 = _keyStr.indexOf(input.charAt(i++)); - - chr1 = (enc1 << 2) | (enc2 >> 4); - chr2 = ((enc2 & 15) << 4) | (enc3 >> 2); - chr3 = ((enc3 & 3) << 6) | enc4; - - output[resultIndex++] = chr1; - - if (enc3 !== 64) { - output[resultIndex++] = chr2; - } - if (enc4 !== 64) { - output[resultIndex++] = chr3; - } - - } - - return output; -}; - -},{"./support":30,"./utils":32}],2:[function(require,module,exports){ -'use strict'; - -var external = require("./external"); -var DataWorker = require('./stream/DataWorker'); -var Crc32Probe = require('./stream/Crc32Probe'); -var DataLengthProbe = require('./stream/DataLengthProbe'); - -/** - * Represent a compressed object, with everything needed to decompress it. - * @constructor - * @param {number} compressedSize the size of the data compressed. - * @param {number} uncompressedSize the size of the data after decompression. - * @param {number} crc32 the crc32 of the decompressed file. - * @param {object} compression the type of compression, see lib/compressions.js. - * @param {String|ArrayBuffer|Uint8Array|Buffer} data the compressed data. - */ -function CompressedObject(compressedSize, uncompressedSize, crc32, compression, data) { - this.compressedSize = compressedSize; - this.uncompressedSize = uncompressedSize; - this.crc32 = crc32; - this.compression = compression; - this.compressedContent = data; -} - -CompressedObject.prototype = { - /** - * Create a worker to get the uncompressed content. - * @return {GenericWorker} the worker. - */ - getContentWorker: function () { - var worker = new DataWorker(external.Promise.resolve(this.compressedContent)) - .pipe(this.compression.uncompressWorker()) - .pipe(new DataLengthProbe("data_length")); - - var that = this; - worker.on("end", function () { - if (this.streamInfo['data_length'] !== that.uncompressedSize) { - throw new Error("Bug : uncompressed data size mismatch"); - } - }); - return worker; - }, - /** - * Create a worker to get the compressed content. - * @return {GenericWorker} the worker. - */ - getCompressedWorker: function () { - return new DataWorker(external.Promise.resolve(this.compressedContent)) - .withStreamInfo("compressedSize", this.compressedSize) - .withStreamInfo("uncompressedSize", this.uncompressedSize) - .withStreamInfo("crc32", this.crc32) - .withStreamInfo("compression", this.compression) - ; - } -}; - -/** - * Chain the given worker with other workers to compress the content with the - * given compression. - * @param {GenericWorker} uncompressedWorker the worker to pipe. - * @param {Object} compression the compression object. - * @param {Object} compressionOptions the options to use when compressing. - * @return {GenericWorker} the new worker compressing the content. - */ -CompressedObject.createWorkerFrom = function (uncompressedWorker, compression, compressionOptions) { - return uncompressedWorker - .pipe(new Crc32Probe()) - .pipe(new DataLengthProbe("uncompressedSize")) - .pipe(compression.compressWorker(compressionOptions)) - .pipe(new DataLengthProbe("compressedSize")) - .withStreamInfo("compression", compression); -}; - -module.exports = CompressedObject; - -},{"./external":6,"./stream/Crc32Probe":25,"./stream/DataLengthProbe":26,"./stream/DataWorker":27}],3:[function(require,module,exports){ -'use strict'; - -var GenericWorker = require("./stream/GenericWorker"); - -exports.STORE = { - magic: "\x00\x00", - compressWorker : function (compressionOptions) { - return new GenericWorker("STORE compression"); - }, - uncompressWorker : function () { - return new GenericWorker("STORE decompression"); - } -}; -exports.DEFLATE = require('./flate'); - -},{"./flate":7,"./stream/GenericWorker":28}],4:[function(require,module,exports){ -'use strict'; - -var utils = require('./utils'); - -/** - * The following functions come from pako, from pako/lib/zlib/crc32.js - * released under the MIT license, see pako https://github.com/nodeca/pako/ - */ - -// Use ordinary array, since untyped makes no boost here -function makeTable() { - var c, table = []; - - for(var n =0; n < 256; n++){ - c = n; - for(var k =0; k < 8; k++){ - c = ((c&1) ? (0xEDB88320 ^ (c >>> 1)) : (c >>> 1)); - } - table[n] = c; - } - - return table; -} - -// Create table on load. Just 255 signed longs. Not a problem. -var crcTable = makeTable(); - - -function crc32(crc, buf, len, pos) { - var t = crcTable, end = pos + len; - - crc = crc ^ (-1); - - for (var i = pos; i < end; i++ ) { - crc = (crc >>> 8) ^ t[(crc ^ buf[i]) & 0xFF]; - } - - return (crc ^ (-1)); // >>> 0; -} - -// That's all for the pako functions. - -/** - * Compute the crc32 of a string. - * This is almost the same as the function crc32, but for strings. Using the - * same function for the two use cases leads to horrible performances. - * @param {Number} crc the starting value of the crc. - * @param {String} str the string to use. - * @param {Number} len the length of the string. - * @param {Number} pos the starting position for the crc32 computation. - * @return {Number} the computed crc32. - */ -function crc32str(crc, str, len, pos) { - var t = crcTable, end = pos + len; - - crc = crc ^ (-1); - - for (var i = pos; i < end; i++ ) { - crc = (crc >>> 8) ^ t[(crc ^ str.charCodeAt(i)) & 0xFF]; - } - - return (crc ^ (-1)); // >>> 0; -} - -module.exports = function crc32wrapper(input, crc) { - if (typeof input === "undefined" || !input.length) { - return 0; - } - - var isArray = utils.getTypeOf(input) !== "string"; - - if(isArray) { - return crc32(crc|0, input, input.length, 0); - } else { - return crc32str(crc|0, input, input.length, 0); - } -}; - -},{"./utils":32}],5:[function(require,module,exports){ -'use strict'; -exports.base64 = false; -exports.binary = false; -exports.dir = false; -exports.createFolders = true; -exports.date = null; -exports.compression = null; -exports.compressionOptions = null; -exports.comment = null; -exports.unixPermissions = null; -exports.dosPermissions = null; - -},{}],6:[function(require,module,exports){ -/* global Promise */ -'use strict'; - -// load the global object first: -// - it should be better integrated in the system (unhandledRejection in node) -// - the environment may have a custom Promise implementation (see zone.js) -var ES6Promise = null; -if (typeof Promise !== "undefined") { - ES6Promise = Promise; -} else { - ES6Promise = require("lie"); -} - -/** - * Let the user use/change some implementations. - */ -module.exports = { - Promise: ES6Promise -}; - -},{"lie":37}],7:[function(require,module,exports){ -'use strict'; -var USE_TYPEDARRAY = (typeof Uint8Array !== 'undefined') && (typeof Uint16Array !== 'undefined') && (typeof Uint32Array !== 'undefined'); - -var pako = require("pako"); -var utils = require("./utils"); -var GenericWorker = require("./stream/GenericWorker"); - -var ARRAY_TYPE = USE_TYPEDARRAY ? "uint8array" : "array"; - -exports.magic = "\x08\x00"; - -/** - * Create a worker that uses pako to inflate/deflate. - * @constructor - * @param {String} action the name of the pako function to call : either "Deflate" or "Inflate". - * @param {Object} options the options to use when (de)compressing. - */ -function FlateWorker(action, options) { - GenericWorker.call(this, "FlateWorker/" + action); - - this._pako = null; - this._pakoAction = action; - this._pakoOptions = options; - // the `meta` object from the last chunk received - // this allow this worker to pass around metadata - this.meta = {}; -} - -utils.inherits(FlateWorker, GenericWorker); - -/** - * @see GenericWorker.processChunk - */ -FlateWorker.prototype.processChunk = function (chunk) { - this.meta = chunk.meta; - if (this._pako === null) { - this._createPako(); - } - this._pako.push(utils.transformTo(ARRAY_TYPE, chunk.data), false); -}; - -/** - * @see GenericWorker.flush - */ -FlateWorker.prototype.flush = function () { - GenericWorker.prototype.flush.call(this); - if (this._pako === null) { - this._createPako(); - } - this._pako.push([], true); -}; -/** - * @see GenericWorker.cleanUp - */ -FlateWorker.prototype.cleanUp = function () { - GenericWorker.prototype.cleanUp.call(this); - this._pako = null; -}; - -/** - * Create the _pako object. - * TODO: lazy-loading this object isn't the best solution but it's the - * quickest. The best solution is to lazy-load the worker list. See also the - * issue #446. - */ -FlateWorker.prototype._createPako = function () { - this._pako = new pako[this._pakoAction]({ - raw: true, - level: this._pakoOptions.level || -1 // default compression - }); - var self = this; - this._pako.onData = function(data) { - self.push({ - data : data, - meta : self.meta - }); - }; -}; - -exports.compressWorker = function (compressionOptions) { - return new FlateWorker("Deflate", compressionOptions); -}; -exports.uncompressWorker = function () { - return new FlateWorker("Inflate", {}); -}; - -},{"./stream/GenericWorker":28,"./utils":32,"pako":38}],8:[function(require,module,exports){ -'use strict'; - -var utils = require('../utils'); -var GenericWorker = require('../stream/GenericWorker'); -var utf8 = require('../utf8'); -var crc32 = require('../crc32'); -var signature = require('../signature'); - -/** - * Transform an integer into a string in hexadecimal. - * @private - * @param {number} dec the number to convert. - * @param {number} bytes the number of bytes to generate. - * @returns {string} the result. - */ -var decToHex = function(dec, bytes) { - var hex = "", i; - for (i = 0; i < bytes; i++) { - hex += String.fromCharCode(dec & 0xff); - dec = dec >>> 8; - } - return hex; -}; - -/** - * Generate the UNIX part of the external file attributes. - * @param {Object} unixPermissions the unix permissions or null. - * @param {Boolean} isDir true if the entry is a directory, false otherwise. - * @return {Number} a 32 bit integer. - * - * adapted from http://unix.stackexchange.com/questions/14705/the-zip-formats-external-file-attribute : - * - * TTTTsstrwxrwxrwx0000000000ADVSHR - * ^^^^____________________________ file type, see zipinfo.c (UNX_*) - * ^^^_________________________ setuid, setgid, sticky - * ^^^^^^^^^________________ permissions - * ^^^^^^^^^^______ not used ? - * ^^^^^^ DOS attribute bits : Archive, Directory, Volume label, System file, Hidden, Read only - */ -var generateUnixExternalFileAttr = function (unixPermissions, isDir) { - - var result = unixPermissions; - if (!unixPermissions) { - // I can't use octal values in strict mode, hence the hexa. - // 040775 => 0x41fd - // 0100664 => 0x81b4 - result = isDir ? 0x41fd : 0x81b4; - } - return (result & 0xFFFF) << 16; -}; - -/** - * Generate the DOS part of the external file attributes. - * @param {Object} dosPermissions the dos permissions or null. - * @param {Boolean} isDir true if the entry is a directory, false otherwise. - * @return {Number} a 32 bit integer. - * - * Bit 0 Read-Only - * Bit 1 Hidden - * Bit 2 System - * Bit 3 Volume Label - * Bit 4 Directory - * Bit 5 Archive - */ -var generateDosExternalFileAttr = function (dosPermissions, isDir) { - - // the dir flag is already set for compatibility - return (dosPermissions || 0) & 0x3F; -}; - -/** - * Generate the various parts used in the construction of the final zip file. - * @param {Object} streamInfo the hash with information about the compressed file. - * @param {Boolean} streamedContent is the content streamed ? - * @param {Boolean} streamingEnded is the stream finished ? - * @param {number} offset the current offset from the start of the zip file. - * @param {String} platform let's pretend we are this platform (change platform dependents fields) - * @param {Function} encodeFileName the function to encode the file name / comment. - * @return {Object} the zip parts. - */ -var generateZipParts = function(streamInfo, streamedContent, streamingEnded, offset, platform, encodeFileName) { - var file = streamInfo['file'], - compression = streamInfo['compression'], - useCustomEncoding = encodeFileName !== utf8.utf8encode, - encodedFileName = utils.transformTo("string", encodeFileName(file.name)), - utfEncodedFileName = utils.transformTo("string", utf8.utf8encode(file.name)), - comment = file.comment, - encodedComment = utils.transformTo("string", encodeFileName(comment)), - utfEncodedComment = utils.transformTo("string", utf8.utf8encode(comment)), - useUTF8ForFileName = utfEncodedFileName.length !== file.name.length, - useUTF8ForComment = utfEncodedComment.length !== comment.length, - dosTime, - dosDate, - extraFields = "", - unicodePathExtraField = "", - unicodeCommentExtraField = "", - dir = file.dir, - date = file.date; - - - var dataInfo = { - crc32 : 0, - compressedSize : 0, - uncompressedSize : 0 - }; - - // if the content is streamed, the sizes/crc32 are only available AFTER - // the end of the stream. - if (!streamedContent || streamingEnded) { - dataInfo.crc32 = streamInfo['crc32']; - dataInfo.compressedSize = streamInfo['compressedSize']; - dataInfo.uncompressedSize = streamInfo['uncompressedSize']; - } - - var bitflag = 0; - if (streamedContent) { - // Bit 3: the sizes/crc32 are set to zero in the local header. - // The correct values are put in the data descriptor immediately - // following the compressed data. - bitflag |= 0x0008; - } - if (!useCustomEncoding && (useUTF8ForFileName || useUTF8ForComment)) { - // Bit 11: Language encoding flag (EFS). - bitflag |= 0x0800; - } - - - var extFileAttr = 0; - var versionMadeBy = 0; - if (dir) { - // dos or unix, we set the dos dir flag - extFileAttr |= 0x00010; - } - if(platform === "UNIX") { - versionMadeBy = 0x031E; // UNIX, version 3.0 - extFileAttr |= generateUnixExternalFileAttr(file.unixPermissions, dir); - } else { // DOS or other, fallback to DOS - versionMadeBy = 0x0014; // DOS, version 2.0 - extFileAttr |= generateDosExternalFileAttr(file.dosPermissions, dir); - } - - // date - // @see http://www.delorie.com/djgpp/doc/rbinter/it/52/13.html - // @see http://www.delorie.com/djgpp/doc/rbinter/it/65/16.html - // @see http://www.delorie.com/djgpp/doc/rbinter/it/66/16.html - - dosTime = date.getUTCHours(); - dosTime = dosTime << 6; - dosTime = dosTime | date.getUTCMinutes(); - dosTime = dosTime << 5; - dosTime = dosTime | date.getUTCSeconds() / 2; - - dosDate = date.getUTCFullYear() - 1980; - dosDate = dosDate << 4; - dosDate = dosDate | (date.getUTCMonth() + 1); - dosDate = dosDate << 5; - dosDate = dosDate | date.getUTCDate(); - - if (useUTF8ForFileName) { - // set the unicode path extra field. unzip needs at least one extra - // field to correctly handle unicode path, so using the path is as good - // as any other information. This could improve the situation with - // other archive managers too. - // This field is usually used without the utf8 flag, with a non - // unicode path in the header (winrar, winzip). This helps (a bit) - // with the messy Windows' default compressed folders feature but - // breaks on p7zip which doesn't seek the unicode path extra field. - // So for now, UTF-8 everywhere ! - unicodePathExtraField = - // Version - decToHex(1, 1) + - // NameCRC32 - decToHex(crc32(encodedFileName), 4) + - // UnicodeName - utfEncodedFileName; - - extraFields += - // Info-ZIP Unicode Path Extra Field - "\x75\x70" + - // size - decToHex(unicodePathExtraField.length, 2) + - // content - unicodePathExtraField; - } - - if(useUTF8ForComment) { - - unicodeCommentExtraField = - // Version - decToHex(1, 1) + - // CommentCRC32 - decToHex(crc32(encodedComment), 4) + - // UnicodeName - utfEncodedComment; - - extraFields += - // Info-ZIP Unicode Path Extra Field - "\x75\x63" + - // size - decToHex(unicodeCommentExtraField.length, 2) + - // content - unicodeCommentExtraField; - } - - var header = ""; - - // version needed to extract - header += "\x0A\x00"; - // general purpose bit flag - header += decToHex(bitflag, 2); - // compression method - header += compression.magic; - // last mod file time - header += decToHex(dosTime, 2); - // last mod file date - header += decToHex(dosDate, 2); - // crc-32 - header += decToHex(dataInfo.crc32, 4); - // compressed size - header += decToHex(dataInfo.compressedSize, 4); - // uncompressed size - header += decToHex(dataInfo.uncompressedSize, 4); - // file name length - header += decToHex(encodedFileName.length, 2); - // extra field length - header += decToHex(extraFields.length, 2); - - - var fileRecord = signature.LOCAL_FILE_HEADER + header + encodedFileName + extraFields; - - var dirRecord = signature.CENTRAL_FILE_HEADER + - // version made by (00: DOS) - decToHex(versionMadeBy, 2) + - // file header (common to file and central directory) - header + - // file comment length - decToHex(encodedComment.length, 2) + - // disk number start - "\x00\x00" + - // internal file attributes TODO - "\x00\x00" + - // external file attributes - decToHex(extFileAttr, 4) + - // relative offset of local header - decToHex(offset, 4) + - // file name - encodedFileName + - // extra field - extraFields + - // file comment - encodedComment; - - return { - fileRecord: fileRecord, - dirRecord: dirRecord - }; -}; - -/** - * Generate the EOCD record. - * @param {Number} entriesCount the number of entries in the zip file. - * @param {Number} centralDirLength the length (in bytes) of the central dir. - * @param {Number} localDirLength the length (in bytes) of the local dir. - * @param {String} comment the zip file comment as a binary string. - * @param {Function} encodeFileName the function to encode the comment. - * @return {String} the EOCD record. - */ -var generateCentralDirectoryEnd = function (entriesCount, centralDirLength, localDirLength, comment, encodeFileName) { - var dirEnd = ""; - var encodedComment = utils.transformTo("string", encodeFileName(comment)); - - // end of central dir signature - dirEnd = signature.CENTRAL_DIRECTORY_END + - // number of this disk - "\x00\x00" + - // number of the disk with the start of the central directory - "\x00\x00" + - // total number of entries in the central directory on this disk - decToHex(entriesCount, 2) + - // total number of entries in the central directory - decToHex(entriesCount, 2) + - // size of the central directory 4 bytes - decToHex(centralDirLength, 4) + - // offset of start of central directory with respect to the starting disk number - decToHex(localDirLength, 4) + - // .ZIP file comment length - decToHex(encodedComment.length, 2) + - // .ZIP file comment - encodedComment; - - return dirEnd; -}; - -/** - * Generate data descriptors for a file entry. - * @param {Object} streamInfo the hash generated by a worker, containing information - * on the file entry. - * @return {String} the data descriptors. - */ -var generateDataDescriptors = function (streamInfo) { - var descriptor = ""; - descriptor = signature.DATA_DESCRIPTOR + - // crc-32 4 bytes - decToHex(streamInfo['crc32'], 4) + - // compressed size 4 bytes - decToHex(streamInfo['compressedSize'], 4) + - // uncompressed size 4 bytes - decToHex(streamInfo['uncompressedSize'], 4); - - return descriptor; -}; - - -/** - * A worker to concatenate other workers to create a zip file. - * @param {Boolean} streamFiles `true` to stream the content of the files, - * `false` to accumulate it. - * @param {String} comment the comment to use. - * @param {String} platform the platform to use, "UNIX" or "DOS". - * @param {Function} encodeFileName the function to encode file names and comments. - */ -function ZipFileWorker(streamFiles, comment, platform, encodeFileName) { - GenericWorker.call(this, "ZipFileWorker"); - // The number of bytes written so far. This doesn't count accumulated chunks. - this.bytesWritten = 0; - // The comment of the zip file - this.zipComment = comment; - // The platform "generating" the zip file. - this.zipPlatform = platform; - // the function to encode file names and comments. - this.encodeFileName = encodeFileName; - // Should we stream the content of the files ? - this.streamFiles = streamFiles; - // If `streamFiles` is false, we will need to accumulate the content of the - // files to calculate sizes / crc32 (and write them *before* the content). - // This boolean indicates if we are accumulating chunks (it will change a lot - // during the lifetime of this worker). - this.accumulate = false; - // The buffer receiving chunks when accumulating content. - this.contentBuffer = []; - // The list of generated directory records. - this.dirRecords = []; - // The offset (in bytes) from the beginning of the zip file for the current source. - this.currentSourceOffset = 0; - // The total number of entries in this zip file. - this.entriesCount = 0; - // the name of the file currently being added, null when handling the end of the zip file. - // Used for the emitted metadata. - this.currentFile = null; - - - - this._sources = []; -} -utils.inherits(ZipFileWorker, GenericWorker); - -/** - * @see GenericWorker.push - */ -ZipFileWorker.prototype.push = function (chunk) { - - var currentFilePercent = chunk.meta.percent || 0; - var entriesCount = this.entriesCount; - var remainingFiles = this._sources.length; - - if(this.accumulate) { - this.contentBuffer.push(chunk); - } else { - this.bytesWritten += chunk.data.length; - - GenericWorker.prototype.push.call(this, { - data : chunk.data, - meta : { - currentFile : this.currentFile, - percent : entriesCount ? (currentFilePercent + 100 * (entriesCount - remainingFiles - 1)) / entriesCount : 100 - } - }); - } -}; - -/** - * The worker started a new source (an other worker). - * @param {Object} streamInfo the streamInfo object from the new source. - */ -ZipFileWorker.prototype.openedSource = function (streamInfo) { - this.currentSourceOffset = this.bytesWritten; - this.currentFile = streamInfo['file'].name; - - var streamedContent = this.streamFiles && !streamInfo['file'].dir; - - // don't stream folders (because they don't have any content) - if(streamedContent) { - var record = generateZipParts(streamInfo, streamedContent, false, this.currentSourceOffset, this.zipPlatform, this.encodeFileName); - this.push({ - data : record.fileRecord, - meta : {percent:0} - }); - } else { - // we need to wait for the whole file before pushing anything - this.accumulate = true; - } -}; - -/** - * The worker finished a source (an other worker). - * @param {Object} streamInfo the streamInfo object from the finished source. - */ -ZipFileWorker.prototype.closedSource = function (streamInfo) { - this.accumulate = false; - var streamedContent = this.streamFiles && !streamInfo['file'].dir; - var record = generateZipParts(streamInfo, streamedContent, true, this.currentSourceOffset, this.zipPlatform, this.encodeFileName); - - this.dirRecords.push(record.dirRecord); - if(streamedContent) { - // after the streamed file, we put data descriptors - this.push({ - data : generateDataDescriptors(streamInfo), - meta : {percent:100} - }); - } else { - // the content wasn't streamed, we need to push everything now - // first the file record, then the content - this.push({ - data : record.fileRecord, - meta : {percent:0} - }); - while(this.contentBuffer.length) { - this.push(this.contentBuffer.shift()); - } - } - this.currentFile = null; -}; - -/** - * @see GenericWorker.flush - */ -ZipFileWorker.prototype.flush = function () { - - var localDirLength = this.bytesWritten; - for(var i = 0; i < this.dirRecords.length; i++) { - this.push({ - data : this.dirRecords[i], - meta : {percent:100} - }); - } - var centralDirLength = this.bytesWritten - localDirLength; - - var dirEnd = generateCentralDirectoryEnd(this.dirRecords.length, centralDirLength, localDirLength, this.zipComment, this.encodeFileName); - - this.push({ - data : dirEnd, - meta : {percent:100} - }); -}; - -/** - * Prepare the next source to be read. - */ -ZipFileWorker.prototype.prepareNextSource = function () { - this.previous = this._sources.shift(); - this.openedSource(this.previous.streamInfo); - if (this.isPaused) { - this.previous.pause(); - } else { - this.previous.resume(); - } -}; - -/** - * @see GenericWorker.registerPrevious - */ -ZipFileWorker.prototype.registerPrevious = function (previous) { - this._sources.push(previous); - var self = this; - - previous.on('data', function (chunk) { - self.processChunk(chunk); - }); - previous.on('end', function () { - self.closedSource(self.previous.streamInfo); - if(self._sources.length) { - self.prepareNextSource(); - } else { - self.end(); - } - }); - previous.on('error', function (e) { - self.error(e); - }); - return this; -}; - -/** - * @see GenericWorker.resume - */ -ZipFileWorker.prototype.resume = function () { - if(!GenericWorker.prototype.resume.call(this)) { - return false; - } - - if (!this.previous && this._sources.length) { - this.prepareNextSource(); - return true; - } - if (!this.previous && !this._sources.length && !this.generatedError) { - this.end(); - return true; - } -}; - -/** - * @see GenericWorker.error - */ -ZipFileWorker.prototype.error = function (e) { - var sources = this._sources; - if(!GenericWorker.prototype.error.call(this, e)) { - return false; - } - for(var i = 0; i < sources.length; i++) { - try { - sources[i].error(e); - } catch(e) { - // the `error` exploded, nothing to do - } - } - return true; -}; - -/** - * @see GenericWorker.lock - */ -ZipFileWorker.prototype.lock = function () { - GenericWorker.prototype.lock.call(this); - var sources = this._sources; - for(var i = 0; i < sources.length; i++) { - sources[i].lock(); - } -}; - -module.exports = ZipFileWorker; - -},{"../crc32":4,"../signature":23,"../stream/GenericWorker":28,"../utf8":31,"../utils":32}],9:[function(require,module,exports){ -'use strict'; - -var compressions = require('../compressions'); -var ZipFileWorker = require('./ZipFileWorker'); - -/** - * Find the compression to use. - * @param {String} fileCompression the compression defined at the file level, if any. - * @param {String} zipCompression the compression defined at the load() level. - * @return {Object} the compression object to use. - */ -var getCompression = function (fileCompression, zipCompression) { - - var compressionName = fileCompression || zipCompression; - var compression = compressions[compressionName]; - if (!compression) { - throw new Error(compressionName + " is not a valid compression method !"); - } - return compression; -}; - -/** - * Create a worker to generate a zip file. - * @param {JSZip} zip the JSZip instance at the right root level. - * @param {Object} options to generate the zip file. - * @param {String} comment the comment to use. - */ -exports.generateWorker = function (zip, options, comment) { - - var zipFileWorker = new ZipFileWorker(options.streamFiles, comment, options.platform, options.encodeFileName); - var entriesCount = 0; - try { - - zip.forEach(function (relativePath, file) { - entriesCount++; - var compression = getCompression(file.options.compression, options.compression); - var compressionOptions = file.options.compressionOptions || options.compressionOptions || {}; - var dir = file.dir, date = file.date; - - file._compressWorker(compression, compressionOptions) - .withStreamInfo("file", { - name : relativePath, - dir : dir, - date : date, - comment : file.comment || "", - unixPermissions : file.unixPermissions, - dosPermissions : file.dosPermissions - }) - .pipe(zipFileWorker); - }); - zipFileWorker.entriesCount = entriesCount; - } catch (e) { - zipFileWorker.error(e); - } - - return zipFileWorker; -}; - -},{"../compressions":3,"./ZipFileWorker":8}],10:[function(require,module,exports){ -'use strict'; - -/** - * Representation a of zip file in js - * @constructor - */ -function JSZip() { - // if this constructor is used without `new`, it adds `new` before itself: - if(!(this instanceof JSZip)) { - return new JSZip(); - } - - if(arguments.length) { - throw new Error("The constructor with parameters has been removed in JSZip 3.0, please check the upgrade guide."); - } - - // object containing the files : - // { - // "folder/" : {...}, - // "folder/data.txt" : {...} - // } - // NOTE: we use a null prototype because we do not - // want filenames like "toString" coming from a zip file - // to overwrite methods and attributes in a normal Object. - this.files = Object.create(null); - - this.comment = null; - - // Where we are in the hierarchy - this.root = ""; - this.clone = function() { - var newObj = new JSZip(); - for (var i in this) { - if (typeof this[i] !== "function") { - newObj[i] = this[i]; - } - } - return newObj; - }; -} -JSZip.prototype = require('./object'); -JSZip.prototype.loadAsync = require('./load'); -JSZip.support = require('./support'); -JSZip.defaults = require('./defaults'); - -// TODO find a better way to handle this version, -// a require('package.json').version doesn't work with webpack, see #327 -JSZip.version = "3.7.1"; - -JSZip.loadAsync = function (content, options) { - return new JSZip().loadAsync(content, options); -}; - -JSZip.external = require("./external"); -module.exports = JSZip; - -},{"./defaults":5,"./external":6,"./load":11,"./object":15,"./support":30}],11:[function(require,module,exports){ -'use strict'; -var utils = require('./utils'); -var external = require("./external"); -var utf8 = require('./utf8'); -var ZipEntries = require('./zipEntries'); -var Crc32Probe = require('./stream/Crc32Probe'); -var nodejsUtils = require("./nodejsUtils"); - -/** - * Check the CRC32 of an entry. - * @param {ZipEntry} zipEntry the zip entry to check. - * @return {Promise} the result. - */ -function checkEntryCRC32(zipEntry) { - return new external.Promise(function (resolve, reject) { - var worker = zipEntry.decompressed.getContentWorker().pipe(new Crc32Probe()); - worker.on("error", function (e) { - reject(e); - }) - .on("end", function () { - if (worker.streamInfo.crc32 !== zipEntry.decompressed.crc32) { - reject(new Error("Corrupted zip : CRC32 mismatch")); - } else { - resolve(); - } - }) - .resume(); - }); -} - -module.exports = function (data, options) { - var zip = this; - options = utils.extend(options || {}, { - base64: false, - checkCRC32: false, - optimizedBinaryString: false, - createFolders: false, - decodeFileName: utf8.utf8decode - }); - - if (nodejsUtils.isNode && nodejsUtils.isStream(data)) { - return external.Promise.reject(new Error("JSZip can't accept a stream when loading a zip file.")); - } - - return utils.prepareContent("the loaded zip file", data, true, options.optimizedBinaryString, options.base64) - .then(function (data) { - var zipEntries = new ZipEntries(options); - zipEntries.load(data); - return zipEntries; - }).then(function checkCRC32(zipEntries) { - var promises = [external.Promise.resolve(zipEntries)]; - var files = zipEntries.files; - if (options.checkCRC32) { - for (var i = 0; i < files.length; i++) { - promises.push(checkEntryCRC32(files[i])); - } - } - return external.Promise.all(promises); - }).then(function addFiles(results) { - var zipEntries = results.shift(); - var files = zipEntries.files; - for (var i = 0; i < files.length; i++) { - var input = files[i]; - zip.file(input.fileNameStr, input.decompressed, { - binary: true, - optimizedBinaryString: true, - date: input.date, - dir: input.dir, - comment: input.fileCommentStr.length ? input.fileCommentStr : null, - unixPermissions: input.unixPermissions, - dosPermissions: input.dosPermissions, - createFolders: options.createFolders - }); - } - if (zipEntries.zipComment.length) { - zip.comment = zipEntries.zipComment; - } - - return zip; - }); -}; - -},{"./external":6,"./nodejsUtils":14,"./stream/Crc32Probe":25,"./utf8":31,"./utils":32,"./zipEntries":33}],12:[function(require,module,exports){ -"use strict"; - -var utils = require('../utils'); -var GenericWorker = require('../stream/GenericWorker'); - -/** - * A worker that use a nodejs stream as source. - * @constructor - * @param {String} filename the name of the file entry for this stream. - * @param {Readable} stream the nodejs stream. - */ -function NodejsStreamInputAdapter(filename, stream) { - GenericWorker.call(this, "Nodejs stream input adapter for " + filename); - this._upstreamEnded = false; - this._bindStream(stream); -} - -utils.inherits(NodejsStreamInputAdapter, GenericWorker); - -/** - * Prepare the stream and bind the callbacks on it. - * Do this ASAP on node 0.10 ! A lazy binding doesn't always work. - * @param {Stream} stream the nodejs stream to use. - */ -NodejsStreamInputAdapter.prototype._bindStream = function (stream) { - var self = this; - this._stream = stream; - stream.pause(); - stream - .on("data", function (chunk) { - self.push({ - data: chunk, - meta : { - percent : 0 - } - }); - }) - .on("error", function (e) { - if(self.isPaused) { - this.generatedError = e; - } else { - self.error(e); - } - }) - .on("end", function () { - if(self.isPaused) { - self._upstreamEnded = true; - } else { - self.end(); - } - }); -}; -NodejsStreamInputAdapter.prototype.pause = function () { - if(!GenericWorker.prototype.pause.call(this)) { - return false; - } - this._stream.pause(); - return true; -}; -NodejsStreamInputAdapter.prototype.resume = function () { - if(!GenericWorker.prototype.resume.call(this)) { - return false; - } - - if(this._upstreamEnded) { - this.end(); - } else { - this._stream.resume(); - } - - return true; -}; - -module.exports = NodejsStreamInputAdapter; - -},{"../stream/GenericWorker":28,"../utils":32}],13:[function(require,module,exports){ -'use strict'; - -var Readable = require('readable-stream').Readable; - -var utils = require('../utils'); -utils.inherits(NodejsStreamOutputAdapter, Readable); - -/** -* A nodejs stream using a worker as source. -* @see the SourceWrapper in http://nodejs.org/api/stream.html -* @constructor -* @param {StreamHelper} helper the helper wrapping the worker -* @param {Object} options the nodejs stream options -* @param {Function} updateCb the update callback. -*/ -function NodejsStreamOutputAdapter(helper, options, updateCb) { - Readable.call(this, options); - this._helper = helper; - - var self = this; - helper.on("data", function (data, meta) { - if (!self.push(data)) { - self._helper.pause(); - } - if(updateCb) { - updateCb(meta); - } - }) - .on("error", function(e) { - self.emit('error', e); - }) - .on("end", function () { - self.push(null); - }); -} - - -NodejsStreamOutputAdapter.prototype._read = function() { - this._helper.resume(); -}; - -module.exports = NodejsStreamOutputAdapter; - -},{"../utils":32,"readable-stream":16}],14:[function(require,module,exports){ -'use strict'; - -module.exports = { - /** - * True if this is running in Nodejs, will be undefined in a browser. - * In a browser, browserify won't include this file and the whole module - * will be resolved an empty object. - */ - isNode : typeof Buffer !== "undefined", - /** - * Create a new nodejs Buffer from an existing content. - * @param {Object} data the data to pass to the constructor. - * @param {String} encoding the encoding to use. - * @return {Buffer} a new Buffer. - */ - newBufferFrom: function(data, encoding) { - if (Buffer.from && Buffer.from !== Uint8Array.from) { - return Buffer.from(data, encoding); - } else { - if (typeof data === "number") { - // Safeguard for old Node.js versions. On newer versions, - // Buffer.from(number) / Buffer(number, encoding) already throw. - throw new Error("The \"data\" argument must not be a number"); - } - return new Buffer(data, encoding); - } - }, - /** - * Create a new nodejs Buffer with the specified size. - * @param {Integer} size the size of the buffer. - * @return {Buffer} a new Buffer. - */ - allocBuffer: function (size) { - if (Buffer.alloc) { - return Buffer.alloc(size); - } else { - var buf = new Buffer(size); - buf.fill(0); - return buf; - } - }, - /** - * Find out if an object is a Buffer. - * @param {Object} b the object to test. - * @return {Boolean} true if the object is a Buffer, false otherwise. - */ - isBuffer : function(b){ - return Buffer.isBuffer(b); - }, - - isStream : function (obj) { - return obj && - typeof obj.on === "function" && - typeof obj.pause === "function" && - typeof obj.resume === "function"; - } -}; - -},{}],15:[function(require,module,exports){ -'use strict'; -var utf8 = require('./utf8'); -var utils = require('./utils'); -var GenericWorker = require('./stream/GenericWorker'); -var StreamHelper = require('./stream/StreamHelper'); -var defaults = require('./defaults'); -var CompressedObject = require('./compressedObject'); -var ZipObject = require('./zipObject'); -var generate = require("./generate"); -var nodejsUtils = require("./nodejsUtils"); -var NodejsStreamInputAdapter = require("./nodejs/NodejsStreamInputAdapter"); - - -/** - * Add a file in the current folder. - * @private - * @param {string} name the name of the file - * @param {String|ArrayBuffer|Uint8Array|Buffer} data the data of the file - * @param {Object} originalOptions the options of the file - * @return {Object} the new file. - */ -var fileAdd = function(name, data, originalOptions) { - // be sure sub folders exist - var dataType = utils.getTypeOf(data), - parent; - - - /* - * Correct options. - */ - - var o = utils.extend(originalOptions || {}, defaults); - o.date = o.date || new Date(); - if (o.compression !== null) { - o.compression = o.compression.toUpperCase(); - } - - if (typeof o.unixPermissions === "string") { - o.unixPermissions = parseInt(o.unixPermissions, 8); - } - - // UNX_IFDIR 0040000 see zipinfo.c - if (o.unixPermissions && (o.unixPermissions & 0x4000)) { - o.dir = true; - } - // Bit 4 Directory - if (o.dosPermissions && (o.dosPermissions & 0x0010)) { - o.dir = true; - } - - if (o.dir) { - name = forceTrailingSlash(name); - } - if (o.createFolders && (parent = parentFolder(name))) { - folderAdd.call(this, parent, true); - } - - var isUnicodeString = dataType === "string" && o.binary === false && o.base64 === false; - if (!originalOptions || typeof originalOptions.binary === "undefined") { - o.binary = !isUnicodeString; - } - - - var isCompressedEmpty = (data instanceof CompressedObject) && data.uncompressedSize === 0; - - if (isCompressedEmpty || o.dir || !data || data.length === 0) { - o.base64 = false; - o.binary = true; - data = ""; - o.compression = "STORE"; - dataType = "string"; - } - - /* - * Convert content to fit. - */ - - var zipObjectContent = null; - if (data instanceof CompressedObject || data instanceof GenericWorker) { - zipObjectContent = data; - } else if (nodejsUtils.isNode && nodejsUtils.isStream(data)) { - zipObjectContent = new NodejsStreamInputAdapter(name, data); - } else { - zipObjectContent = utils.prepareContent(name, data, o.binary, o.optimizedBinaryString, o.base64); - } - - var object = new ZipObject(name, zipObjectContent, o); - this.files[name] = object; - /* - TODO: we can't throw an exception because we have async promises - (we can have a promise of a Date() for example) but returning a - promise is useless because file(name, data) returns the JSZip - object for chaining. Should we break that to allow the user - to catch the error ? - - return external.Promise.resolve(zipObjectContent) - .then(function () { - return object; - }); - */ -}; - -/** - * Find the parent folder of the path. - * @private - * @param {string} path the path to use - * @return {string} the parent folder, or "" - */ -var parentFolder = function (path) { - if (path.slice(-1) === '/') { - path = path.substring(0, path.length - 1); - } - var lastSlash = path.lastIndexOf('/'); - return (lastSlash > 0) ? path.substring(0, lastSlash) : ""; -}; - -/** - * Returns the path with a slash at the end. - * @private - * @param {String} path the path to check. - * @return {String} the path with a trailing slash. - */ -var forceTrailingSlash = function(path) { - // Check the name ends with a / - if (path.slice(-1) !== "/") { - path += "/"; // IE doesn't like substr(-1) - } - return path; -}; - -/** - * Add a (sub) folder in the current folder. - * @private - * @param {string} name the folder's name - * @param {boolean=} [createFolders] If true, automatically create sub - * folders. Defaults to false. - * @return {Object} the new folder. - */ -var folderAdd = function(name, createFolders) { - createFolders = (typeof createFolders !== 'undefined') ? createFolders : defaults.createFolders; - - name = forceTrailingSlash(name); - - // Does this folder already exist? - if (!this.files[name]) { - fileAdd.call(this, name, null, { - dir: true, - createFolders: createFolders - }); - } - return this.files[name]; -}; - -/** -* Cross-window, cross-Node-context regular expression detection -* @param {Object} object Anything -* @return {Boolean} true if the object is a regular expression, -* false otherwise -*/ -function isRegExp(object) { - return Object.prototype.toString.call(object) === "[object RegExp]"; -} - -// return the actual prototype of JSZip -var out = { - /** - * @see loadAsync - */ - load: function() { - throw new Error("This method has been removed in JSZip 3.0, please check the upgrade guide."); - }, - - - /** - * Call a callback function for each entry at this folder level. - * @param {Function} cb the callback function: - * function (relativePath, file) {...} - * It takes 2 arguments : the relative path and the file. - */ - forEach: function(cb) { - var filename, relativePath, file; - /* jshint ignore:start */ - // ignore warning about unwanted properties because this.files is a null prototype object - for (filename in this.files) { - file = this.files[filename]; - relativePath = filename.slice(this.root.length, filename.length); - if (relativePath && filename.slice(0, this.root.length) === this.root) { // the file is in the current root - cb(relativePath, file); // TODO reverse the parameters ? need to be clean AND consistent with the filter search fn... - } - } - /* jshint ignore:end */ - }, - - /** - * Filter nested files/folders with the specified function. - * @param {Function} search the predicate to use : - * function (relativePath, file) {...} - * It takes 2 arguments : the relative path and the file. - * @return {Array} An array of matching elements. - */ - filter: function(search) { - var result = []; - this.forEach(function (relativePath, entry) { - if (search(relativePath, entry)) { // the file matches the function - result.push(entry); - } - - }); - return result; - }, - - /** - * Add a file to the zip file, or search a file. - * @param {string|RegExp} name The name of the file to add (if data is defined), - * the name of the file to find (if no data) or a regex to match files. - * @param {String|ArrayBuffer|Uint8Array|Buffer} data The file data, either raw or base64 encoded - * @param {Object} o File options - * @return {JSZip|Object|Array} this JSZip object (when adding a file), - * a file (when searching by string) or an array of files (when searching by regex). - */ - file: function(name, data, o) { - if (arguments.length === 1) { - if (isRegExp(name)) { - var regexp = name; - return this.filter(function(relativePath, file) { - return !file.dir && regexp.test(relativePath); - }); - } - else { // text - var obj = this.files[this.root + name]; - if (obj && !obj.dir) { - return obj; - } else { - return null; - } - } - } - else { // more than one argument : we have data ! - name = this.root + name; - fileAdd.call(this, name, data, o); - } - return this; - }, - - /** - * Add a directory to the zip file, or search. - * @param {String|RegExp} arg The name of the directory to add, or a regex to search folders. - * @return {JSZip} an object with the new directory as the root, or an array containing matching folders. - */ - folder: function(arg) { - if (!arg) { - return this; - } - - if (isRegExp(arg)) { - return this.filter(function(relativePath, file) { - return file.dir && arg.test(relativePath); - }); - } - - // else, name is a new folder - var name = this.root + arg; - var newFolder = folderAdd.call(this, name); - - // Allow chaining by returning a new object with this folder as the root - var ret = this.clone(); - ret.root = newFolder.name; - return ret; - }, - - /** - * Delete a file, or a directory and all sub-files, from the zip - * @param {string} name the name of the file to delete - * @return {JSZip} this JSZip object - */ - remove: function(name) { - name = this.root + name; - var file = this.files[name]; - if (!file) { - // Look for any folders - if (name.slice(-1) !== "/") { - name += "/"; - } - file = this.files[name]; - } - - if (file && !file.dir) { - // file - delete this.files[name]; - } else { - // maybe a folder, delete recursively - var kids = this.filter(function(relativePath, file) { - return file.name.slice(0, name.length) === name; - }); - for (var i = 0; i < kids.length; i++) { - delete this.files[kids[i].name]; - } - } - - return this; - }, - - /** - * Generate the complete zip file - * @param {Object} options the options to generate the zip file : - * - compression, "STORE" by default. - * - type, "base64" by default. Values are : string, base64, uint8array, arraybuffer, blob. - * @return {String|Uint8Array|ArrayBuffer|Buffer|Blob} the zip file - */ - generate: function(options) { - throw new Error("This method has been removed in JSZip 3.0, please check the upgrade guide."); - }, - - /** - * Generate the complete zip file as an internal stream. - * @param {Object} options the options to generate the zip file : - * - compression, "STORE" by default. - * - type, "base64" by default. Values are : string, base64, uint8array, arraybuffer, blob. - * @return {StreamHelper} the streamed zip file. - */ - generateInternalStream: function(options) { - var worker, opts = {}; - try { - opts = utils.extend(options || {}, { - streamFiles: false, - compression: "STORE", - compressionOptions : null, - type: "", - platform: "DOS", - comment: null, - mimeType: 'application/zip', - encodeFileName: utf8.utf8encode - }); - - opts.type = opts.type.toLowerCase(); - opts.compression = opts.compression.toUpperCase(); - - // "binarystring" is preferred but the internals use "string". - if(opts.type === "binarystring") { - opts.type = "string"; - } - - if (!opts.type) { - throw new Error("No output type specified."); - } - - utils.checkSupport(opts.type); - - // accept nodejs `process.platform` - if( - opts.platform === 'darwin' || - opts.platform === 'freebsd' || - opts.platform === 'linux' || - opts.platform === 'sunos' - ) { - opts.platform = "UNIX"; - } - if (opts.platform === 'win32') { - opts.platform = "DOS"; - } - - var comment = opts.comment || this.comment || ""; - worker = generate.generateWorker(this, opts, comment); - } catch (e) { - worker = new GenericWorker("error"); - worker.error(e); - } - return new StreamHelper(worker, opts.type || "string", opts.mimeType); - }, - /** - * Generate the complete zip file asynchronously. - * @see generateInternalStream - */ - generateAsync: function(options, onUpdate) { - return this.generateInternalStream(options).accumulate(onUpdate); - }, - /** - * Generate the complete zip file asynchronously. - * @see generateInternalStream - */ - generateNodeStream: function(options, onUpdate) { - options = options || {}; - if (!options.type) { - options.type = "nodebuffer"; - } - return this.generateInternalStream(options).toNodejsStream(onUpdate); - } -}; -module.exports = out; - -},{"./compressedObject":2,"./defaults":5,"./generate":9,"./nodejs/NodejsStreamInputAdapter":12,"./nodejsUtils":14,"./stream/GenericWorker":28,"./stream/StreamHelper":29,"./utf8":31,"./utils":32,"./zipObject":35}],16:[function(require,module,exports){ -/* - * This file is used by module bundlers (browserify/webpack/etc) when - * including a stream implementation. We use "readable-stream" to get a - * consistent behavior between nodejs versions but bundlers often have a shim - * for "stream". Using this shim greatly improve the compatibility and greatly - * reduce the final size of the bundle (only one stream implementation, not - * two). - */ -module.exports = require("stream"); - -},{"stream":undefined}],17:[function(require,module,exports){ -'use strict'; -var DataReader = require('./DataReader'); -var utils = require('../utils'); - -function ArrayReader(data) { - DataReader.call(this, data); - for(var i = 0; i < this.data.length; i++) { - data[i] = data[i] & 0xFF; - } -} -utils.inherits(ArrayReader, DataReader); -/** - * @see DataReader.byteAt - */ -ArrayReader.prototype.byteAt = function(i) { - return this.data[this.zero + i]; -}; -/** - * @see DataReader.lastIndexOfSignature - */ -ArrayReader.prototype.lastIndexOfSignature = function(sig) { - var sig0 = sig.charCodeAt(0), - sig1 = sig.charCodeAt(1), - sig2 = sig.charCodeAt(2), - sig3 = sig.charCodeAt(3); - for (var i = this.length - 4; i >= 0; --i) { - if (this.data[i] === sig0 && this.data[i + 1] === sig1 && this.data[i + 2] === sig2 && this.data[i + 3] === sig3) { - return i - this.zero; - } - } - - return -1; -}; -/** - * @see DataReader.readAndCheckSignature - */ -ArrayReader.prototype.readAndCheckSignature = function (sig) { - var sig0 = sig.charCodeAt(0), - sig1 = sig.charCodeAt(1), - sig2 = sig.charCodeAt(2), - sig3 = sig.charCodeAt(3), - data = this.readData(4); - return sig0 === data[0] && sig1 === data[1] && sig2 === data[2] && sig3 === data[3]; -}; -/** - * @see DataReader.readData - */ -ArrayReader.prototype.readData = function(size) { - this.checkOffset(size); - if(size === 0) { - return []; - } - var result = this.data.slice(this.zero + this.index, this.zero + this.index + size); - this.index += size; - return result; -}; -module.exports = ArrayReader; - -},{"../utils":32,"./DataReader":18}],18:[function(require,module,exports){ -'use strict'; -var utils = require('../utils'); - -function DataReader(data) { - this.data = data; // type : see implementation - this.length = data.length; - this.index = 0; - this.zero = 0; -} -DataReader.prototype = { - /** - * Check that the offset will not go too far. - * @param {string} offset the additional offset to check. - * @throws {Error} an Error if the offset is out of bounds. - */ - checkOffset: function(offset) { - this.checkIndex(this.index + offset); - }, - /** - * Check that the specified index will not be too far. - * @param {string} newIndex the index to check. - * @throws {Error} an Error if the index is out of bounds. - */ - checkIndex: function(newIndex) { - if (this.length < this.zero + newIndex || newIndex < 0) { - throw new Error("End of data reached (data length = " + this.length + ", asked index = " + (newIndex) + "). Corrupted zip ?"); - } - }, - /** - * Change the index. - * @param {number} newIndex The new index. - * @throws {Error} if the new index is out of the data. - */ - setIndex: function(newIndex) { - this.checkIndex(newIndex); - this.index = newIndex; - }, - /** - * Skip the next n bytes. - * @param {number} n the number of bytes to skip. - * @throws {Error} if the new index is out of the data. - */ - skip: function(n) { - this.setIndex(this.index + n); - }, - /** - * Get the byte at the specified index. - * @param {number} i the index to use. - * @return {number} a byte. - */ - byteAt: function(i) { - // see implementations - }, - /** - * Get the next number with a given byte size. - * @param {number} size the number of bytes to read. - * @return {number} the corresponding number. - */ - readInt: function(size) { - var result = 0, - i; - this.checkOffset(size); - for (i = this.index + size - 1; i >= this.index; i--) { - result = (result << 8) + this.byteAt(i); - } - this.index += size; - return result; - }, - /** - * Get the next string with a given byte size. - * @param {number} size the number of bytes to read. - * @return {string} the corresponding string. - */ - readString: function(size) { - return utils.transformTo("string", this.readData(size)); - }, - /** - * Get raw data without conversion, bytes. - * @param {number} size the number of bytes to read. - * @return {Object} the raw data, implementation specific. - */ - readData: function(size) { - // see implementations - }, - /** - * Find the last occurrence of a zip signature (4 bytes). - * @param {string} sig the signature to find. - * @return {number} the index of the last occurrence, -1 if not found. - */ - lastIndexOfSignature: function(sig) { - // see implementations - }, - /** - * Read the signature (4 bytes) at the current position and compare it with sig. - * @param {string} sig the expected signature - * @return {boolean} true if the signature matches, false otherwise. - */ - readAndCheckSignature: function(sig) { - // see implementations - }, - /** - * Get the next date. - * @return {Date} the date. - */ - readDate: function() { - var dostime = this.readInt(4); - return new Date(Date.UTC( - ((dostime >> 25) & 0x7f) + 1980, // year - ((dostime >> 21) & 0x0f) - 1, // month - (dostime >> 16) & 0x1f, // day - (dostime >> 11) & 0x1f, // hour - (dostime >> 5) & 0x3f, // minute - (dostime & 0x1f) << 1)); // second - } -}; -module.exports = DataReader; - -},{"../utils":32}],19:[function(require,module,exports){ -'use strict'; -var Uint8ArrayReader = require('./Uint8ArrayReader'); -var utils = require('../utils'); - -function NodeBufferReader(data) { - Uint8ArrayReader.call(this, data); -} -utils.inherits(NodeBufferReader, Uint8ArrayReader); - -/** - * @see DataReader.readData - */ -NodeBufferReader.prototype.readData = function(size) { - this.checkOffset(size); - var result = this.data.slice(this.zero + this.index, this.zero + this.index + size); - this.index += size; - return result; -}; -module.exports = NodeBufferReader; - -},{"../utils":32,"./Uint8ArrayReader":21}],20:[function(require,module,exports){ -'use strict'; -var DataReader = require('./DataReader'); -var utils = require('../utils'); - -function StringReader(data) { - DataReader.call(this, data); -} -utils.inherits(StringReader, DataReader); -/** - * @see DataReader.byteAt - */ -StringReader.prototype.byteAt = function(i) { - return this.data.charCodeAt(this.zero + i); -}; -/** - * @see DataReader.lastIndexOfSignature - */ -StringReader.prototype.lastIndexOfSignature = function(sig) { - return this.data.lastIndexOf(sig) - this.zero; -}; -/** - * @see DataReader.readAndCheckSignature - */ -StringReader.prototype.readAndCheckSignature = function (sig) { - var data = this.readData(4); - return sig === data; -}; -/** - * @see DataReader.readData - */ -StringReader.prototype.readData = function(size) { - this.checkOffset(size); - // this will work because the constructor applied the "& 0xff" mask. - var result = this.data.slice(this.zero + this.index, this.zero + this.index + size); - this.index += size; - return result; -}; -module.exports = StringReader; - -},{"../utils":32,"./DataReader":18}],21:[function(require,module,exports){ -'use strict'; -var ArrayReader = require('./ArrayReader'); -var utils = require('../utils'); - -function Uint8ArrayReader(data) { - ArrayReader.call(this, data); -} -utils.inherits(Uint8ArrayReader, ArrayReader); -/** - * @see DataReader.readData - */ -Uint8ArrayReader.prototype.readData = function(size) { - this.checkOffset(size); - if(size === 0) { - // in IE10, when using subarray(idx, idx), we get the array [0x00] instead of []. - return new Uint8Array(0); - } - var result = this.data.subarray(this.zero + this.index, this.zero + this.index + size); - this.index += size; - return result; -}; -module.exports = Uint8ArrayReader; - -},{"../utils":32,"./ArrayReader":17}],22:[function(require,module,exports){ -'use strict'; - -var utils = require('../utils'); -var support = require('../support'); -var ArrayReader = require('./ArrayReader'); -var StringReader = require('./StringReader'); -var NodeBufferReader = require('./NodeBufferReader'); -var Uint8ArrayReader = require('./Uint8ArrayReader'); - -/** - * Create a reader adapted to the data. - * @param {String|ArrayBuffer|Uint8Array|Buffer} data the data to read. - * @return {DataReader} the data reader. - */ -module.exports = function (data) { - var type = utils.getTypeOf(data); - utils.checkSupport(type); - if (type === "string" && !support.uint8array) { - return new StringReader(data); - } - if (type === "nodebuffer") { - return new NodeBufferReader(data); - } - if (support.uint8array) { - return new Uint8ArrayReader(utils.transformTo("uint8array", data)); - } - return new ArrayReader(utils.transformTo("array", data)); -}; - -},{"../support":30,"../utils":32,"./ArrayReader":17,"./NodeBufferReader":19,"./StringReader":20,"./Uint8ArrayReader":21}],23:[function(require,module,exports){ -'use strict'; -exports.LOCAL_FILE_HEADER = "PK\x03\x04"; -exports.CENTRAL_FILE_HEADER = "PK\x01\x02"; -exports.CENTRAL_DIRECTORY_END = "PK\x05\x06"; -exports.ZIP64_CENTRAL_DIRECTORY_LOCATOR = "PK\x06\x07"; -exports.ZIP64_CENTRAL_DIRECTORY_END = "PK\x06\x06"; -exports.DATA_DESCRIPTOR = "PK\x07\x08"; - -},{}],24:[function(require,module,exports){ -'use strict'; - -var GenericWorker = require('./GenericWorker'); -var utils = require('../utils'); - -/** - * A worker which convert chunks to a specified type. - * @constructor - * @param {String} destType the destination type. - */ -function ConvertWorker(destType) { - GenericWorker.call(this, "ConvertWorker to " + destType); - this.destType = destType; -} -utils.inherits(ConvertWorker, GenericWorker); - -/** - * @see GenericWorker.processChunk - */ -ConvertWorker.prototype.processChunk = function (chunk) { - this.push({ - data : utils.transformTo(this.destType, chunk.data), - meta : chunk.meta - }); -}; -module.exports = ConvertWorker; - -},{"../utils":32,"./GenericWorker":28}],25:[function(require,module,exports){ -'use strict'; - -var GenericWorker = require('./GenericWorker'); -var crc32 = require('../crc32'); -var utils = require('../utils'); - -/** - * A worker which calculate the crc32 of the data flowing through. - * @constructor - */ -function Crc32Probe() { - GenericWorker.call(this, "Crc32Probe"); - this.withStreamInfo("crc32", 0); -} -utils.inherits(Crc32Probe, GenericWorker); - -/** - * @see GenericWorker.processChunk - */ -Crc32Probe.prototype.processChunk = function (chunk) { - this.streamInfo.crc32 = crc32(chunk.data, this.streamInfo.crc32 || 0); - this.push(chunk); -}; -module.exports = Crc32Probe; - -},{"../crc32":4,"../utils":32,"./GenericWorker":28}],26:[function(require,module,exports){ -'use strict'; - -var utils = require('../utils'); -var GenericWorker = require('./GenericWorker'); - -/** - * A worker which calculate the total length of the data flowing through. - * @constructor - * @param {String} propName the name used to expose the length - */ -function DataLengthProbe(propName) { - GenericWorker.call(this, "DataLengthProbe for " + propName); - this.propName = propName; - this.withStreamInfo(propName, 0); -} -utils.inherits(DataLengthProbe, GenericWorker); - -/** - * @see GenericWorker.processChunk - */ -DataLengthProbe.prototype.processChunk = function (chunk) { - if(chunk) { - var length = this.streamInfo[this.propName] || 0; - this.streamInfo[this.propName] = length + chunk.data.length; - } - GenericWorker.prototype.processChunk.call(this, chunk); -}; -module.exports = DataLengthProbe; - - -},{"../utils":32,"./GenericWorker":28}],27:[function(require,module,exports){ -'use strict'; - -var utils = require('../utils'); -var GenericWorker = require('./GenericWorker'); - -// the size of the generated chunks -// TODO expose this as a public variable -var DEFAULT_BLOCK_SIZE = 16 * 1024; - -/** - * A worker that reads a content and emits chunks. - * @constructor - * @param {Promise} dataP the promise of the data to split - */ -function DataWorker(dataP) { - GenericWorker.call(this, "DataWorker"); - var self = this; - this.dataIsReady = false; - this.index = 0; - this.max = 0; - this.data = null; - this.type = ""; - - this._tickScheduled = false; - - dataP.then(function (data) { - self.dataIsReady = true; - self.data = data; - self.max = data && data.length || 0; - self.type = utils.getTypeOf(data); - if(!self.isPaused) { - self._tickAndRepeat(); - } - }, function (e) { - self.error(e); - }); -} - -utils.inherits(DataWorker, GenericWorker); - -/** - * @see GenericWorker.cleanUp - */ -DataWorker.prototype.cleanUp = function () { - GenericWorker.prototype.cleanUp.call(this); - this.data = null; -}; - -/** - * @see GenericWorker.resume - */ -DataWorker.prototype.resume = function () { - if(!GenericWorker.prototype.resume.call(this)) { - return false; - } - - if (!this._tickScheduled && this.dataIsReady) { - this._tickScheduled = true; - utils.delay(this._tickAndRepeat, [], this); - } - return true; -}; - -/** - * Trigger a tick a schedule an other call to this function. - */ -DataWorker.prototype._tickAndRepeat = function() { - this._tickScheduled = false; - if(this.isPaused || this.isFinished) { - return; - } - this._tick(); - if(!this.isFinished) { - utils.delay(this._tickAndRepeat, [], this); - this._tickScheduled = true; - } -}; - -/** - * Read and push a chunk. - */ -DataWorker.prototype._tick = function() { - - if(this.isPaused || this.isFinished) { - return false; - } - - var size = DEFAULT_BLOCK_SIZE; - var data = null, nextIndex = Math.min(this.max, this.index + size); - if (this.index >= this.max) { - // EOF - return this.end(); - } else { - switch(this.type) { - case "string": - data = this.data.substring(this.index, nextIndex); - break; - case "uint8array": - data = this.data.subarray(this.index, nextIndex); - break; - case "array": - case "nodebuffer": - data = this.data.slice(this.index, nextIndex); - break; - } - this.index = nextIndex; - return this.push({ - data : data, - meta : { - percent : this.max ? this.index / this.max * 100 : 0 - } - }); - } -}; - -module.exports = DataWorker; - -},{"../utils":32,"./GenericWorker":28}],28:[function(require,module,exports){ -'use strict'; - -/** - * A worker that does nothing but passing chunks to the next one. This is like - * a nodejs stream but with some differences. On the good side : - * - it works on IE 6-9 without any issue / polyfill - * - it weights less than the full dependencies bundled with browserify - * - it forwards errors (no need to declare an error handler EVERYWHERE) - * - * A chunk is an object with 2 attributes : `meta` and `data`. The former is an - * object containing anything (`percent` for example), see each worker for more - * details. The latter is the real data (String, Uint8Array, etc). - * - * @constructor - * @param {String} name the name of the stream (mainly used for debugging purposes) - */ -function GenericWorker(name) { - // the name of the worker - this.name = name || "default"; - // an object containing metadata about the workers chain - this.streamInfo = {}; - // an error which happened when the worker was paused - this.generatedError = null; - // an object containing metadata to be merged by this worker into the general metadata - this.extraStreamInfo = {}; - // true if the stream is paused (and should not do anything), false otherwise - this.isPaused = true; - // true if the stream is finished (and should not do anything), false otherwise - this.isFinished = false; - // true if the stream is locked to prevent further structure updates (pipe), false otherwise - this.isLocked = false; - // the event listeners - this._listeners = { - 'data':[], - 'end':[], - 'error':[] - }; - // the previous worker, if any - this.previous = null; -} - -GenericWorker.prototype = { - /** - * Push a chunk to the next workers. - * @param {Object} chunk the chunk to push - */ - push : function (chunk) { - this.emit("data", chunk); - }, - /** - * End the stream. - * @return {Boolean} true if this call ended the worker, false otherwise. - */ - end : function () { - if (this.isFinished) { - return false; - } - - this.flush(); - try { - this.emit("end"); - this.cleanUp(); - this.isFinished = true; - } catch (e) { - this.emit("error", e); - } - return true; - }, - /** - * End the stream with an error. - * @param {Error} e the error which caused the premature end. - * @return {Boolean} true if this call ended the worker with an error, false otherwise. - */ - error : function (e) { - if (this.isFinished) { - return false; - } - - if(this.isPaused) { - this.generatedError = e; - } else { - this.isFinished = true; - - this.emit("error", e); - - // in the workers chain exploded in the middle of the chain, - // the error event will go downward but we also need to notify - // workers upward that there has been an error. - if(this.previous) { - this.previous.error(e); - } - - this.cleanUp(); - } - return true; - }, - /** - * Add a callback on an event. - * @param {String} name the name of the event (data, end, error) - * @param {Function} listener the function to call when the event is triggered - * @return {GenericWorker} the current object for chainability - */ - on : function (name, listener) { - this._listeners[name].push(listener); - return this; - }, - /** - * Clean any references when a worker is ending. - */ - cleanUp : function () { - this.streamInfo = this.generatedError = this.extraStreamInfo = null; - this._listeners = []; - }, - /** - * Trigger an event. This will call registered callback with the provided arg. - * @param {String} name the name of the event (data, end, error) - * @param {Object} arg the argument to call the callback with. - */ - emit : function (name, arg) { - if (this._listeners[name]) { - for(var i = 0; i < this._listeners[name].length; i++) { - this._listeners[name][i].call(this, arg); - } - } - }, - /** - * Chain a worker with an other. - * @param {Worker} next the worker receiving events from the current one. - * @return {worker} the next worker for chainability - */ - pipe : function (next) { - return next.registerPrevious(this); - }, - /** - * Same as `pipe` in the other direction. - * Using an API with `pipe(next)` is very easy. - * Implementing the API with the point of view of the next one registering - * a source is easier, see the ZipFileWorker. - * @param {Worker} previous the previous worker, sending events to this one - * @return {Worker} the current worker for chainability - */ - registerPrevious : function (previous) { - if (this.isLocked) { - throw new Error("The stream '" + this + "' has already been used."); - } - - // sharing the streamInfo... - this.streamInfo = previous.streamInfo; - // ... and adding our own bits - this.mergeStreamInfo(); - this.previous = previous; - var self = this; - previous.on('data', function (chunk) { - self.processChunk(chunk); - }); - previous.on('end', function () { - self.end(); - }); - previous.on('error', function (e) { - self.error(e); - }); - return this; - }, - /** - * Pause the stream so it doesn't send events anymore. - * @return {Boolean} true if this call paused the worker, false otherwise. - */ - pause : function () { - if(this.isPaused || this.isFinished) { - return false; - } - this.isPaused = true; - - if(this.previous) { - this.previous.pause(); - } - return true; - }, - /** - * Resume a paused stream. - * @return {Boolean} true if this call resumed the worker, false otherwise. - */ - resume : function () { - if(!this.isPaused || this.isFinished) { - return false; - } - this.isPaused = false; - - // if true, the worker tried to resume but failed - var withError = false; - if(this.generatedError) { - this.error(this.generatedError); - withError = true; - } - if(this.previous) { - this.previous.resume(); - } - - return !withError; - }, - /** - * Flush any remaining bytes as the stream is ending. - */ - flush : function () {}, - /** - * Process a chunk. This is usually the method overridden. - * @param {Object} chunk the chunk to process. - */ - processChunk : function(chunk) { - this.push(chunk); - }, - /** - * Add a key/value to be added in the workers chain streamInfo once activated. - * @param {String} key the key to use - * @param {Object} value the associated value - * @return {Worker} the current worker for chainability - */ - withStreamInfo : function (key, value) { - this.extraStreamInfo[key] = value; - this.mergeStreamInfo(); - return this; - }, - /** - * Merge this worker's streamInfo into the chain's streamInfo. - */ - mergeStreamInfo : function () { - for(var key in this.extraStreamInfo) { - if (!this.extraStreamInfo.hasOwnProperty(key)) { - continue; - } - this.streamInfo[key] = this.extraStreamInfo[key]; - } - }, - - /** - * Lock the stream to prevent further updates on the workers chain. - * After calling this method, all calls to pipe will fail. - */ - lock: function () { - if (this.isLocked) { - throw new Error("The stream '" + this + "' has already been used."); - } - this.isLocked = true; - if (this.previous) { - this.previous.lock(); - } - }, - - /** - * - * Pretty print the workers chain. - */ - toString : function () { - var me = "Worker " + this.name; - if (this.previous) { - return this.previous + " -> " + me; - } else { - return me; - } - } -}; - -module.exports = GenericWorker; - -},{}],29:[function(require,module,exports){ -'use strict'; - -var utils = require('../utils'); -var ConvertWorker = require('./ConvertWorker'); -var GenericWorker = require('./GenericWorker'); -var base64 = require('../base64'); -var support = require("../support"); -var external = require("../external"); - -var NodejsStreamOutputAdapter = null; -if (support.nodestream) { - try { - NodejsStreamOutputAdapter = require('../nodejs/NodejsStreamOutputAdapter'); - } catch(e) {} -} - -/** - * Apply the final transformation of the data. If the user wants a Blob for - * example, it's easier to work with an U8intArray and finally do the - * ArrayBuffer/Blob conversion. - * @param {String} type the name of the final type - * @param {String|Uint8Array|Buffer} content the content to transform - * @param {String} mimeType the mime type of the content, if applicable. - * @return {String|Uint8Array|ArrayBuffer|Buffer|Blob} the content in the right format. - */ -function transformZipOutput(type, content, mimeType) { - switch(type) { - case "blob" : - return utils.newBlob(utils.transformTo("arraybuffer", content), mimeType); - case "base64" : - return base64.encode(content); - default : - return utils.transformTo(type, content); - } -} - -/** - * Concatenate an array of data of the given type. - * @param {String} type the type of the data in the given array. - * @param {Array} dataArray the array containing the data chunks to concatenate - * @return {String|Uint8Array|Buffer} the concatenated data - * @throws Error if the asked type is unsupported - */ -function concat (type, dataArray) { - var i, index = 0, res = null, totalLength = 0; - for(i = 0; i < dataArray.length; i++) { - totalLength += dataArray[i].length; - } - switch(type) { - case "string": - return dataArray.join(""); - case "array": - return Array.prototype.concat.apply([], dataArray); - case "uint8array": - res = new Uint8Array(totalLength); - for(i = 0; i < dataArray.length; i++) { - res.set(dataArray[i], index); - index += dataArray[i].length; - } - return res; - case "nodebuffer": - return Buffer.concat(dataArray); - default: - throw new Error("concat : unsupported type '" + type + "'"); - } -} - -/** - * Listen a StreamHelper, accumulate its content and concatenate it into a - * complete block. - * @param {StreamHelper} helper the helper to use. - * @param {Function} updateCallback a callback called on each update. Called - * with one arg : - * - the metadata linked to the update received. - * @return Promise the promise for the accumulation. - */ -function accumulate(helper, updateCallback) { - return new external.Promise(function (resolve, reject){ - var dataArray = []; - var chunkType = helper._internalType, - resultType = helper._outputType, - mimeType = helper._mimeType; - helper - .on('data', function (data, meta) { - dataArray.push(data); - if(updateCallback) { - updateCallback(meta); - } - }) - .on('error', function(err) { - dataArray = []; - reject(err); - }) - .on('end', function (){ - try { - var result = transformZipOutput(resultType, concat(chunkType, dataArray), mimeType); - resolve(result); - } catch (e) { - reject(e); - } - dataArray = []; - }) - .resume(); - }); -} - -/** - * An helper to easily use workers outside of JSZip. - * @constructor - * @param {Worker} worker the worker to wrap - * @param {String} outputType the type of data expected by the use - * @param {String} mimeType the mime type of the content, if applicable. - */ -function StreamHelper(worker, outputType, mimeType) { - var internalType = outputType; - switch(outputType) { - case "blob": - case "arraybuffer": - internalType = "uint8array"; - break; - case "base64": - internalType = "string"; - break; - } - - try { - // the type used internally - this._internalType = internalType; - // the type used to output results - this._outputType = outputType; - // the mime type - this._mimeType = mimeType; - utils.checkSupport(internalType); - this._worker = worker.pipe(new ConvertWorker(internalType)); - // the last workers can be rewired without issues but we need to - // prevent any updates on previous workers. - worker.lock(); - } catch(e) { - this._worker = new GenericWorker("error"); - this._worker.error(e); - } -} - -StreamHelper.prototype = { - /** - * Listen a StreamHelper, accumulate its content and concatenate it into a - * complete block. - * @param {Function} updateCb the update callback. - * @return Promise the promise for the accumulation. - */ - accumulate : function (updateCb) { - return accumulate(this, updateCb); - }, - /** - * Add a listener on an event triggered on a stream. - * @param {String} evt the name of the event - * @param {Function} fn the listener - * @return {StreamHelper} the current helper. - */ - on : function (evt, fn) { - var self = this; - - if(evt === "data") { - this._worker.on(evt, function (chunk) { - fn.call(self, chunk.data, chunk.meta); - }); - } else { - this._worker.on(evt, function () { - utils.delay(fn, arguments, self); - }); - } - return this; - }, - /** - * Resume the flow of chunks. - * @return {StreamHelper} the current helper. - */ - resume : function () { - utils.delay(this._worker.resume, [], this._worker); - return this; - }, - /** - * Pause the flow of chunks. - * @return {StreamHelper} the current helper. - */ - pause : function () { - this._worker.pause(); - return this; - }, - /** - * Return a nodejs stream for this helper. - * @param {Function} updateCb the update callback. - * @return {NodejsStreamOutputAdapter} the nodejs stream. - */ - toNodejsStream : function (updateCb) { - utils.checkSupport("nodestream"); - if (this._outputType !== "nodebuffer") { - // an object stream containing blob/arraybuffer/uint8array/string - // is strange and I don't know if it would be useful. - // I you find this comment and have a good usecase, please open a - // bug report ! - throw new Error(this._outputType + " is not supported by this method"); - } - - return new NodejsStreamOutputAdapter(this, { - objectMode : this._outputType !== "nodebuffer" - }, updateCb); - } -}; - - -module.exports = StreamHelper; - -},{"../base64":1,"../external":6,"../nodejs/NodejsStreamOutputAdapter":13,"../support":30,"../utils":32,"./ConvertWorker":24,"./GenericWorker":28}],30:[function(require,module,exports){ -'use strict'; - -exports.base64 = true; -exports.array = true; -exports.string = true; -exports.arraybuffer = typeof ArrayBuffer !== "undefined" && typeof Uint8Array !== "undefined"; -exports.nodebuffer = typeof Buffer !== "undefined"; -// contains true if JSZip can read/generate Uint8Array, false otherwise. -exports.uint8array = typeof Uint8Array !== "undefined"; - -if (typeof ArrayBuffer === "undefined") { - exports.blob = false; -} -else { - var buffer = new ArrayBuffer(0); - try { - exports.blob = new Blob([buffer], { - type: "application/zip" - }).size === 0; - } - catch (e) { - try { - var Builder = self.BlobBuilder || self.WebKitBlobBuilder || self.MozBlobBuilder || self.MSBlobBuilder; - var builder = new Builder(); - builder.append(buffer); - exports.blob = builder.getBlob('application/zip').size === 0; - } - catch (e) { - exports.blob = false; - } - } -} - -try { - exports.nodestream = !!require('readable-stream').Readable; -} catch(e) { - exports.nodestream = false; -} - -},{"readable-stream":16}],31:[function(require,module,exports){ -'use strict'; - -var utils = require('./utils'); -var support = require('./support'); -var nodejsUtils = require('./nodejsUtils'); -var GenericWorker = require('./stream/GenericWorker'); - -/** - * The following functions come from pako, from pako/lib/utils/strings - * released under the MIT license, see pako https://github.com/nodeca/pako/ - */ - -// Table with utf8 lengths (calculated by first byte of sequence) -// Note, that 5 & 6-byte values and some 4-byte values can not be represented in JS, -// because max possible codepoint is 0x10ffff -var _utf8len = new Array(256); -for (var i=0; i<256; i++) { - _utf8len[i] = (i >= 252 ? 6 : i >= 248 ? 5 : i >= 240 ? 4 : i >= 224 ? 3 : i >= 192 ? 2 : 1); -} -_utf8len[254]=_utf8len[254]=1; // Invalid sequence start - -// convert string to array (typed, when possible) -var string2buf = function (str) { - var buf, c, c2, m_pos, i, str_len = str.length, buf_len = 0; - - // count binary size - for (m_pos = 0; m_pos < str_len; m_pos++) { - c = str.charCodeAt(m_pos); - if ((c & 0xfc00) === 0xd800 && (m_pos+1 < str_len)) { - c2 = str.charCodeAt(m_pos+1); - if ((c2 & 0xfc00) === 0xdc00) { - c = 0x10000 + ((c - 0xd800) << 10) + (c2 - 0xdc00); - m_pos++; - } - } - buf_len += c < 0x80 ? 1 : c < 0x800 ? 2 : c < 0x10000 ? 3 : 4; - } - - // allocate buffer - if (support.uint8array) { - buf = new Uint8Array(buf_len); - } else { - buf = new Array(buf_len); - } - - // convert - for (i=0, m_pos = 0; i < buf_len; m_pos++) { - c = str.charCodeAt(m_pos); - if ((c & 0xfc00) === 0xd800 && (m_pos+1 < str_len)) { - c2 = str.charCodeAt(m_pos+1); - if ((c2 & 0xfc00) === 0xdc00) { - c = 0x10000 + ((c - 0xd800) << 10) + (c2 - 0xdc00); - m_pos++; - } - } - if (c < 0x80) { - /* one byte */ - buf[i++] = c; - } else if (c < 0x800) { - /* two bytes */ - buf[i++] = 0xC0 | (c >>> 6); - buf[i++] = 0x80 | (c & 0x3f); - } else if (c < 0x10000) { - /* three bytes */ - buf[i++] = 0xE0 | (c >>> 12); - buf[i++] = 0x80 | (c >>> 6 & 0x3f); - buf[i++] = 0x80 | (c & 0x3f); - } else { - /* four bytes */ - buf[i++] = 0xf0 | (c >>> 18); - buf[i++] = 0x80 | (c >>> 12 & 0x3f); - buf[i++] = 0x80 | (c >>> 6 & 0x3f); - buf[i++] = 0x80 | (c & 0x3f); - } - } - - return buf; -}; - -// Calculate max possible position in utf8 buffer, -// that will not break sequence. If that's not possible -// - (very small limits) return max size as is. -// -// buf[] - utf8 bytes array -// max - length limit (mandatory); -var utf8border = function(buf, max) { - var pos; - - max = max || buf.length; - if (max > buf.length) { max = buf.length; } - - // go back from last position, until start of sequence found - pos = max-1; - while (pos >= 0 && (buf[pos] & 0xC0) === 0x80) { pos--; } - - // Fuckup - very small and broken sequence, - // return max, because we should return something anyway. - if (pos < 0) { return max; } - - // If we came to start of buffer - that means vuffer is too small, - // return max too. - if (pos === 0) { return max; } - - return (pos + _utf8len[buf[pos]] > max) ? pos : max; -}; - -// convert array to string -var buf2string = function (buf) { - var str, i, out, c, c_len; - var len = buf.length; - - // Reserve max possible length (2 words per char) - // NB: by unknown reasons, Array is significantly faster for - // String.fromCharCode.apply than Uint16Array. - var utf16buf = new Array(len*2); - - for (out=0, i=0; i 4) { utf16buf[out++] = 0xfffd; i += c_len-1; continue; } - - // apply mask on first byte - c &= c_len === 2 ? 0x1f : c_len === 3 ? 0x0f : 0x07; - // join the rest - while (c_len > 1 && i < len) { - c = (c << 6) | (buf[i++] & 0x3f); - c_len--; - } - - // terminated by end of string? - if (c_len > 1) { utf16buf[out++] = 0xfffd; continue; } - - if (c < 0x10000) { - utf16buf[out++] = c; - } else { - c -= 0x10000; - utf16buf[out++] = 0xd800 | ((c >> 10) & 0x3ff); - utf16buf[out++] = 0xdc00 | (c & 0x3ff); - } - } - - // shrinkBuf(utf16buf, out) - if (utf16buf.length !== out) { - if(utf16buf.subarray) { - utf16buf = utf16buf.subarray(0, out); - } else { - utf16buf.length = out; - } - } - - // return String.fromCharCode.apply(null, utf16buf); - return utils.applyFromCharCode(utf16buf); -}; - - -// That's all for the pako functions. - - -/** - * Transform a javascript string into an array (typed if possible) of bytes, - * UTF-8 encoded. - * @param {String} str the string to encode - * @return {Array|Uint8Array|Buffer} the UTF-8 encoded string. - */ -exports.utf8encode = function utf8encode(str) { - if (support.nodebuffer) { - return nodejsUtils.newBufferFrom(str, "utf-8"); - } - - return string2buf(str); -}; - - -/** - * Transform a bytes array (or a representation) representing an UTF-8 encoded - * string into a javascript string. - * @param {Array|Uint8Array|Buffer} buf the data de decode - * @return {String} the decoded string. - */ -exports.utf8decode = function utf8decode(buf) { - if (support.nodebuffer) { - return utils.transformTo("nodebuffer", buf).toString("utf-8"); - } - - buf = utils.transformTo(support.uint8array ? "uint8array" : "array", buf); - - return buf2string(buf); -}; - -/** - * A worker to decode utf8 encoded binary chunks into string chunks. - * @constructor - */ -function Utf8DecodeWorker() { - GenericWorker.call(this, "utf-8 decode"); - // the last bytes if a chunk didn't end with a complete codepoint. - this.leftOver = null; -} -utils.inherits(Utf8DecodeWorker, GenericWorker); - -/** - * @see GenericWorker.processChunk - */ -Utf8DecodeWorker.prototype.processChunk = function (chunk) { - - var data = utils.transformTo(support.uint8array ? "uint8array" : "array", chunk.data); - - // 1st step, re-use what's left of the previous chunk - if (this.leftOver && this.leftOver.length) { - if(support.uint8array) { - var previousData = data; - data = new Uint8Array(previousData.length + this.leftOver.length); - data.set(this.leftOver, 0); - data.set(previousData, this.leftOver.length); - } else { - data = this.leftOver.concat(data); - } - this.leftOver = null; - } - - var nextBoundary = utf8border(data); - var usableData = data; - if (nextBoundary !== data.length) { - if (support.uint8array) { - usableData = data.subarray(0, nextBoundary); - this.leftOver = data.subarray(nextBoundary, data.length); - } else { - usableData = data.slice(0, nextBoundary); - this.leftOver = data.slice(nextBoundary, data.length); - } - } - - this.push({ - data : exports.utf8decode(usableData), - meta : chunk.meta - }); -}; - -/** - * @see GenericWorker.flush - */ -Utf8DecodeWorker.prototype.flush = function () { - if(this.leftOver && this.leftOver.length) { - this.push({ - data : exports.utf8decode(this.leftOver), - meta : {} - }); - this.leftOver = null; - } -}; -exports.Utf8DecodeWorker = Utf8DecodeWorker; - -/** - * A worker to endcode string chunks into utf8 encoded binary chunks. - * @constructor - */ -function Utf8EncodeWorker() { - GenericWorker.call(this, "utf-8 encode"); -} -utils.inherits(Utf8EncodeWorker, GenericWorker); - -/** - * @see GenericWorker.processChunk - */ -Utf8EncodeWorker.prototype.processChunk = function (chunk) { - this.push({ - data : exports.utf8encode(chunk.data), - meta : chunk.meta - }); -}; -exports.Utf8EncodeWorker = Utf8EncodeWorker; - -},{"./nodejsUtils":14,"./stream/GenericWorker":28,"./support":30,"./utils":32}],32:[function(require,module,exports){ -'use strict'; - -var support = require('./support'); -var base64 = require('./base64'); -var nodejsUtils = require('./nodejsUtils'); -var setImmediate = require('set-immediate-shim'); -var external = require("./external"); - - -/** - * Convert a string that pass as a "binary string": it should represent a byte - * array but may have > 255 char codes. Be sure to take only the first byte - * and returns the byte array. - * @param {String} str the string to transform. - * @return {Array|Uint8Array} the string in a binary format. - */ -function string2binary(str) { - var result = null; - if (support.uint8array) { - result = new Uint8Array(str.length); - } else { - result = new Array(str.length); - } - return stringToArrayLike(str, result); -} - -/** - * Create a new blob with the given content and the given type. - * @param {String|ArrayBuffer} part the content to put in the blob. DO NOT use - * an Uint8Array because the stock browser of android 4 won't accept it (it - * will be silently converted to a string, "[object Uint8Array]"). - * - * Use only ONE part to build the blob to avoid a memory leak in IE11 / Edge: - * when a large amount of Array is used to create the Blob, the amount of - * memory consumed is nearly 100 times the original data amount. - * - * @param {String} type the mime type of the blob. - * @return {Blob} the created blob. - */ -exports.newBlob = function(part, type) { - exports.checkSupport("blob"); - - try { - // Blob constructor - return new Blob([part], { - type: type - }); - } - catch (e) { - - try { - // deprecated, browser only, old way - var Builder = self.BlobBuilder || self.WebKitBlobBuilder || self.MozBlobBuilder || self.MSBlobBuilder; - var builder = new Builder(); - builder.append(part); - return builder.getBlob(type); - } - catch (e) { - - // well, fuck ?! - throw new Error("Bug : can't construct the Blob."); - } - } - - -}; -/** - * The identity function. - * @param {Object} input the input. - * @return {Object} the same input. - */ -function identity(input) { - return input; -} - -/** - * Fill in an array with a string. - * @param {String} str the string to use. - * @param {Array|ArrayBuffer|Uint8Array|Buffer} array the array to fill in (will be mutated). - * @return {Array|ArrayBuffer|Uint8Array|Buffer} the updated array. - */ -function stringToArrayLike(str, array) { - for (var i = 0; i < str.length; ++i) { - array[i] = str.charCodeAt(i) & 0xFF; - } - return array; -} - -/** - * An helper for the function arrayLikeToString. - * This contains static information and functions that - * can be optimized by the browser JIT compiler. - */ -var arrayToStringHelper = { - /** - * Transform an array of int into a string, chunk by chunk. - * See the performances notes on arrayLikeToString. - * @param {Array|ArrayBuffer|Uint8Array|Buffer} array the array to transform. - * @param {String} type the type of the array. - * @param {Integer} chunk the chunk size. - * @return {String} the resulting string. - * @throws Error if the chunk is too big for the stack. - */ - stringifyByChunk: function(array, type, chunk) { - var result = [], k = 0, len = array.length; - // shortcut - if (len <= chunk) { - return String.fromCharCode.apply(null, array); - } - while (k < len) { - if (type === "array" || type === "nodebuffer") { - result.push(String.fromCharCode.apply(null, array.slice(k, Math.min(k + chunk, len)))); - } - else { - result.push(String.fromCharCode.apply(null, array.subarray(k, Math.min(k + chunk, len)))); - } - k += chunk; - } - return result.join(""); - }, - /** - * Call String.fromCharCode on every item in the array. - * This is the naive implementation, which generate A LOT of intermediate string. - * This should be used when everything else fail. - * @param {Array|ArrayBuffer|Uint8Array|Buffer} array the array to transform. - * @return {String} the result. - */ - stringifyByChar: function(array){ - var resultStr = ""; - for(var i = 0; i < array.length; i++) { - resultStr += String.fromCharCode(array[i]); - } - return resultStr; - }, - applyCanBeUsed : { - /** - * true if the browser accepts to use String.fromCharCode on Uint8Array - */ - uint8array : (function () { - try { - return support.uint8array && String.fromCharCode.apply(null, new Uint8Array(1)).length === 1; - } catch (e) { - return false; - } - })(), - /** - * true if the browser accepts to use String.fromCharCode on nodejs Buffer. - */ - nodebuffer : (function () { - try { - return support.nodebuffer && String.fromCharCode.apply(null, nodejsUtils.allocBuffer(1)).length === 1; - } catch (e) { - return false; - } - })() - } -}; - -/** - * Transform an array-like object to a string. - * @param {Array|ArrayBuffer|Uint8Array|Buffer} array the array to transform. - * @return {String} the result. - */ -function arrayLikeToString(array) { - // Performances notes : - // -------------------- - // String.fromCharCode.apply(null, array) is the fastest, see - // see http://jsperf.com/converting-a-uint8array-to-a-string/2 - // but the stack is limited (and we can get huge arrays !). - // - // result += String.fromCharCode(array[i]); generate too many strings ! - // - // This code is inspired by http://jsperf.com/arraybuffer-to-string-apply-performance/2 - // TODO : we now have workers that split the work. Do we still need that ? - var chunk = 65536, - type = exports.getTypeOf(array), - canUseApply = true; - if (type === "uint8array") { - canUseApply = arrayToStringHelper.applyCanBeUsed.uint8array; - } else if (type === "nodebuffer") { - canUseApply = arrayToStringHelper.applyCanBeUsed.nodebuffer; - } - - if (canUseApply) { - while (chunk > 1) { - try { - return arrayToStringHelper.stringifyByChunk(array, type, chunk); - } catch (e) { - chunk = Math.floor(chunk / 2); - } - } - } - - // no apply or chunk error : slow and painful algorithm - // default browser on android 4.* - return arrayToStringHelper.stringifyByChar(array); -} - -exports.applyFromCharCode = arrayLikeToString; - - -/** - * Copy the data from an array-like to an other array-like. - * @param {Array|ArrayBuffer|Uint8Array|Buffer} arrayFrom the origin array. - * @param {Array|ArrayBuffer|Uint8Array|Buffer} arrayTo the destination array which will be mutated. - * @return {Array|ArrayBuffer|Uint8Array|Buffer} the updated destination array. - */ -function arrayLikeToArrayLike(arrayFrom, arrayTo) { - for (var i = 0; i < arrayFrom.length; i++) { - arrayTo[i] = arrayFrom[i]; - } - return arrayTo; -} - -// a matrix containing functions to transform everything into everything. -var transform = {}; - -// string to ? -transform["string"] = { - "string": identity, - "array": function(input) { - return stringToArrayLike(input, new Array(input.length)); - }, - "arraybuffer": function(input) { - return transform["string"]["uint8array"](input).buffer; - }, - "uint8array": function(input) { - return stringToArrayLike(input, new Uint8Array(input.length)); - }, - "nodebuffer": function(input) { - return stringToArrayLike(input, nodejsUtils.allocBuffer(input.length)); - } -}; - -// array to ? -transform["array"] = { - "string": arrayLikeToString, - "array": identity, - "arraybuffer": function(input) { - return (new Uint8Array(input)).buffer; - }, - "uint8array": function(input) { - return new Uint8Array(input); - }, - "nodebuffer": function(input) { - return nodejsUtils.newBufferFrom(input); - } -}; - -// arraybuffer to ? -transform["arraybuffer"] = { - "string": function(input) { - return arrayLikeToString(new Uint8Array(input)); - }, - "array": function(input) { - return arrayLikeToArrayLike(new Uint8Array(input), new Array(input.byteLength)); - }, - "arraybuffer": identity, - "uint8array": function(input) { - return new Uint8Array(input); - }, - "nodebuffer": function(input) { - return nodejsUtils.newBufferFrom(new Uint8Array(input)); - } -}; - -// uint8array to ? -transform["uint8array"] = { - "string": arrayLikeToString, - "array": function(input) { - return arrayLikeToArrayLike(input, new Array(input.length)); - }, - "arraybuffer": function(input) { - return input.buffer; - }, - "uint8array": identity, - "nodebuffer": function(input) { - return nodejsUtils.newBufferFrom(input); - } -}; - -// nodebuffer to ? -transform["nodebuffer"] = { - "string": arrayLikeToString, - "array": function(input) { - return arrayLikeToArrayLike(input, new Array(input.length)); - }, - "arraybuffer": function(input) { - return transform["nodebuffer"]["uint8array"](input).buffer; - }, - "uint8array": function(input) { - return arrayLikeToArrayLike(input, new Uint8Array(input.length)); - }, - "nodebuffer": identity -}; - -/** - * Transform an input into any type. - * The supported output type are : string, array, uint8array, arraybuffer, nodebuffer. - * If no output type is specified, the unmodified input will be returned. - * @param {String} outputType the output type. - * @param {String|Array|ArrayBuffer|Uint8Array|Buffer} input the input to convert. - * @throws {Error} an Error if the browser doesn't support the requested output type. - */ -exports.transformTo = function(outputType, input) { - if (!input) { - // undefined, null, etc - // an empty string won't harm. - input = ""; - } - if (!outputType) { - return input; - } - exports.checkSupport(outputType); - var inputType = exports.getTypeOf(input); - var result = transform[inputType][outputType](input); - return result; -}; - -/** - * Return the type of the input. - * The type will be in a format valid for JSZip.utils.transformTo : string, array, uint8array, arraybuffer. - * @param {Object} input the input to identify. - * @return {String} the (lowercase) type of the input. - */ -exports.getTypeOf = function(input) { - if (typeof input === "string") { - return "string"; - } - if (Object.prototype.toString.call(input) === "[object Array]") { - return "array"; - } - if (support.nodebuffer && nodejsUtils.isBuffer(input)) { - return "nodebuffer"; - } - if (support.uint8array && input instanceof Uint8Array) { - return "uint8array"; - } - if (support.arraybuffer && input instanceof ArrayBuffer) { - return "arraybuffer"; - } -}; - -/** - * Throw an exception if the type is not supported. - * @param {String} type the type to check. - * @throws {Error} an Error if the browser doesn't support the requested type. - */ -exports.checkSupport = function(type) { - var supported = support[type.toLowerCase()]; - if (!supported) { - throw new Error(type + " is not supported by this platform"); - } -}; - -exports.MAX_VALUE_16BITS = 65535; -exports.MAX_VALUE_32BITS = -1; // well, "\xFF\xFF\xFF\xFF\xFF\xFF\xFF\xFF" is parsed as -1 - -/** - * Prettify a string read as binary. - * @param {string} str the string to prettify. - * @return {string} a pretty string. - */ -exports.pretty = function(str) { - var res = '', - code, i; - for (i = 0; i < (str || "").length; i++) { - code = str.charCodeAt(i); - res += '\\x' + (code < 16 ? "0" : "") + code.toString(16).toUpperCase(); - } - return res; -}; - -/** - * Defer the call of a function. - * @param {Function} callback the function to call asynchronously. - * @param {Array} args the arguments to give to the callback. - */ -exports.delay = function(callback, args, self) { - setImmediate(function () { - callback.apply(self || null, args || []); - }); -}; - -/** - * Extends a prototype with an other, without calling a constructor with - * side effects. Inspired by nodejs' `utils.inherits` - * @param {Function} ctor the constructor to augment - * @param {Function} superCtor the parent constructor to use - */ -exports.inherits = function (ctor, superCtor) { - var Obj = function() {}; - Obj.prototype = superCtor.prototype; - ctor.prototype = new Obj(); -}; - -/** - * Merge the objects passed as parameters into a new one. - * @private - * @param {...Object} var_args All objects to merge. - * @return {Object} a new object with the data of the others. - */ -exports.extend = function() { - var result = {}, i, attr; - for (i = 0; i < arguments.length; i++) { // arguments is not enumerable in some browsers - for (attr in arguments[i]) { - if (arguments[i].hasOwnProperty(attr) && typeof result[attr] === "undefined") { - result[attr] = arguments[i][attr]; - } - } - } - return result; -}; - -/** - * Transform arbitrary content into a Promise. - * @param {String} name a name for the content being processed. - * @param {Object} inputData the content to process. - * @param {Boolean} isBinary true if the content is not an unicode string - * @param {Boolean} isOptimizedBinaryString true if the string content only has one byte per character. - * @param {Boolean} isBase64 true if the string content is encoded with base64. - * @return {Promise} a promise in a format usable by JSZip. - */ -exports.prepareContent = function(name, inputData, isBinary, isOptimizedBinaryString, isBase64) { - - // if inputData is already a promise, this flatten it. - var promise = external.Promise.resolve(inputData).then(function(data) { - - - var isBlob = support.blob && (data instanceof Blob || ['[object File]', '[object Blob]'].indexOf(Object.prototype.toString.call(data)) !== -1); - - if (isBlob && typeof FileReader !== "undefined") { - return new external.Promise(function (resolve, reject) { - var reader = new FileReader(); - - reader.onload = function(e) { - resolve(e.target.result); - }; - reader.onerror = function(e) { - reject(e.target.error); - }; - reader.readAsArrayBuffer(data); - }); - } else { - return data; - } - }); - - return promise.then(function(data) { - var dataType = exports.getTypeOf(data); - - if (!dataType) { - return external.Promise.reject( - new Error("Can't read the data of '" + name + "'. Is it " + - "in a supported JavaScript type (String, Blob, ArrayBuffer, etc) ?") - ); - } - // special case : it's way easier to work with Uint8Array than with ArrayBuffer - if (dataType === "arraybuffer") { - data = exports.transformTo("uint8array", data); - } else if (dataType === "string") { - if (isBase64) { - data = base64.decode(data); - } - else if (isBinary) { - // optimizedBinaryString === true means that the file has already been filtered with a 0xFF mask - if (isOptimizedBinaryString !== true) { - // this is a string, not in a base64 format. - // Be sure that this is a correct "binary string" - data = string2binary(data); - } - } - } - return data; - }); -}; - -},{"./base64":1,"./external":6,"./nodejsUtils":14,"./support":30,"set-immediate-shim":54}],33:[function(require,module,exports){ -'use strict'; -var readerFor = require('./reader/readerFor'); -var utils = require('./utils'); -var sig = require('./signature'); -var ZipEntry = require('./zipEntry'); -var utf8 = require('./utf8'); -var support = require('./support'); -// class ZipEntries {{{ -/** - * All the entries in the zip file. - * @constructor - * @param {Object} loadOptions Options for loading the stream. - */ -function ZipEntries(loadOptions) { - this.files = []; - this.loadOptions = loadOptions; -} -ZipEntries.prototype = { - /** - * Check that the reader is on the specified signature. - * @param {string} expectedSignature the expected signature. - * @throws {Error} if it is an other signature. - */ - checkSignature: function(expectedSignature) { - if (!this.reader.readAndCheckSignature(expectedSignature)) { - this.reader.index -= 4; - var signature = this.reader.readString(4); - throw new Error("Corrupted zip or bug: unexpected signature " + "(" + utils.pretty(signature) + ", expected " + utils.pretty(expectedSignature) + ")"); - } - }, - /** - * Check if the given signature is at the given index. - * @param {number} askedIndex the index to check. - * @param {string} expectedSignature the signature to expect. - * @return {boolean} true if the signature is here, false otherwise. - */ - isSignature: function(askedIndex, expectedSignature) { - var currentIndex = this.reader.index; - this.reader.setIndex(askedIndex); - var signature = this.reader.readString(4); - var result = signature === expectedSignature; - this.reader.setIndex(currentIndex); - return result; - }, - /** - * Read the end of the central directory. - */ - readBlockEndOfCentral: function() { - this.diskNumber = this.reader.readInt(2); - this.diskWithCentralDirStart = this.reader.readInt(2); - this.centralDirRecordsOnThisDisk = this.reader.readInt(2); - this.centralDirRecords = this.reader.readInt(2); - this.centralDirSize = this.reader.readInt(4); - this.centralDirOffset = this.reader.readInt(4); - - this.zipCommentLength = this.reader.readInt(2); - // warning : the encoding depends of the system locale - // On a linux machine with LANG=en_US.utf8, this field is utf8 encoded. - // On a windows machine, this field is encoded with the localized windows code page. - var zipComment = this.reader.readData(this.zipCommentLength); - var decodeParamType = support.uint8array ? "uint8array" : "array"; - // To get consistent behavior with the generation part, we will assume that - // this is utf8 encoded unless specified otherwise. - var decodeContent = utils.transformTo(decodeParamType, zipComment); - this.zipComment = this.loadOptions.decodeFileName(decodeContent); - }, - /** - * Read the end of the Zip 64 central directory. - * Not merged with the method readEndOfCentral : - * The end of central can coexist with its Zip64 brother, - * I don't want to read the wrong number of bytes ! - */ - readBlockZip64EndOfCentral: function() { - this.zip64EndOfCentralSize = this.reader.readInt(8); - this.reader.skip(4); - // this.versionMadeBy = this.reader.readString(2); - // this.versionNeeded = this.reader.readInt(2); - this.diskNumber = this.reader.readInt(4); - this.diskWithCentralDirStart = this.reader.readInt(4); - this.centralDirRecordsOnThisDisk = this.reader.readInt(8); - this.centralDirRecords = this.reader.readInt(8); - this.centralDirSize = this.reader.readInt(8); - this.centralDirOffset = this.reader.readInt(8); - - this.zip64ExtensibleData = {}; - var extraDataSize = this.zip64EndOfCentralSize - 44, - index = 0, - extraFieldId, - extraFieldLength, - extraFieldValue; - while (index < extraDataSize) { - extraFieldId = this.reader.readInt(2); - extraFieldLength = this.reader.readInt(4); - extraFieldValue = this.reader.readData(extraFieldLength); - this.zip64ExtensibleData[extraFieldId] = { - id: extraFieldId, - length: extraFieldLength, - value: extraFieldValue - }; - } - }, - /** - * Read the end of the Zip 64 central directory locator. - */ - readBlockZip64EndOfCentralLocator: function() { - this.diskWithZip64CentralDirStart = this.reader.readInt(4); - this.relativeOffsetEndOfZip64CentralDir = this.reader.readInt(8); - this.disksCount = this.reader.readInt(4); - if (this.disksCount > 1) { - throw new Error("Multi-volumes zip are not supported"); - } - }, - /** - * Read the local files, based on the offset read in the central part. - */ - readLocalFiles: function() { - var i, file; - for (i = 0; i < this.files.length; i++) { - file = this.files[i]; - this.reader.setIndex(file.localHeaderOffset); - this.checkSignature(sig.LOCAL_FILE_HEADER); - file.readLocalPart(this.reader); - file.handleUTF8(); - file.processAttributes(); - } - }, - /** - * Read the central directory. - */ - readCentralDir: function() { - var file; - - this.reader.setIndex(this.centralDirOffset); - while (this.reader.readAndCheckSignature(sig.CENTRAL_FILE_HEADER)) { - file = new ZipEntry({ - zip64: this.zip64 - }, this.loadOptions); - file.readCentralPart(this.reader); - this.files.push(file); - } - - if (this.centralDirRecords !== this.files.length) { - if (this.centralDirRecords !== 0 && this.files.length === 0) { - // We expected some records but couldn't find ANY. - // This is really suspicious, as if something went wrong. - throw new Error("Corrupted zip or bug: expected " + this.centralDirRecords + " records in central dir, got " + this.files.length); - } else { - // We found some records but not all. - // Something is wrong but we got something for the user: no error here. - // console.warn("expected", this.centralDirRecords, "records in central dir, got", this.files.length); - } - } - }, - /** - * Read the end of central directory. - */ - readEndOfCentral: function() { - var offset = this.reader.lastIndexOfSignature(sig.CENTRAL_DIRECTORY_END); - if (offset < 0) { - // Check if the content is a truncated zip or complete garbage. - // A "LOCAL_FILE_HEADER" is not required at the beginning (auto - // extractible zip for example) but it can give a good hint. - // If an ajax request was used without responseType, we will also - // get unreadable data. - var isGarbage = !this.isSignature(0, sig.LOCAL_FILE_HEADER); - - if (isGarbage) { - throw new Error("Can't find end of central directory : is this a zip file ? " + - "If it is, see https://stuk.github.io/jszip/documentation/howto/read_zip.html"); - } else { - throw new Error("Corrupted zip: can't find end of central directory"); - } - - } - this.reader.setIndex(offset); - var endOfCentralDirOffset = offset; - this.checkSignature(sig.CENTRAL_DIRECTORY_END); - this.readBlockEndOfCentral(); - - - /* extract from the zip spec : - 4) If one of the fields in the end of central directory - record is too small to hold required data, the field - should be set to -1 (0xFFFF or 0xFFFFFFFF) and the - ZIP64 format record should be created. - 5) The end of central directory record and the - Zip64 end of central directory locator record must - reside on the same disk when splitting or spanning - an archive. - */ - if (this.diskNumber === utils.MAX_VALUE_16BITS || this.diskWithCentralDirStart === utils.MAX_VALUE_16BITS || this.centralDirRecordsOnThisDisk === utils.MAX_VALUE_16BITS || this.centralDirRecords === utils.MAX_VALUE_16BITS || this.centralDirSize === utils.MAX_VALUE_32BITS || this.centralDirOffset === utils.MAX_VALUE_32BITS) { - this.zip64 = true; - - /* - Warning : the zip64 extension is supported, but ONLY if the 64bits integer read from - the zip file can fit into a 32bits integer. This cannot be solved : JavaScript represents - all numbers as 64-bit double precision IEEE 754 floating point numbers. - So, we have 53bits for integers and bitwise operations treat everything as 32bits. - see https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Operators/Bitwise_Operators - and http://www.ecma-international.org/publications/files/ECMA-ST/ECMA-262.pdf section 8.5 - */ - - // should look for a zip64 EOCD locator - offset = this.reader.lastIndexOfSignature(sig.ZIP64_CENTRAL_DIRECTORY_LOCATOR); - if (offset < 0) { - throw new Error("Corrupted zip: can't find the ZIP64 end of central directory locator"); - } - this.reader.setIndex(offset); - this.checkSignature(sig.ZIP64_CENTRAL_DIRECTORY_LOCATOR); - this.readBlockZip64EndOfCentralLocator(); - - // now the zip64 EOCD record - if (!this.isSignature(this.relativeOffsetEndOfZip64CentralDir, sig.ZIP64_CENTRAL_DIRECTORY_END)) { - // console.warn("ZIP64 end of central directory not where expected."); - this.relativeOffsetEndOfZip64CentralDir = this.reader.lastIndexOfSignature(sig.ZIP64_CENTRAL_DIRECTORY_END); - if (this.relativeOffsetEndOfZip64CentralDir < 0) { - throw new Error("Corrupted zip: can't find the ZIP64 end of central directory"); - } - } - this.reader.setIndex(this.relativeOffsetEndOfZip64CentralDir); - this.checkSignature(sig.ZIP64_CENTRAL_DIRECTORY_END); - this.readBlockZip64EndOfCentral(); - } - - var expectedEndOfCentralDirOffset = this.centralDirOffset + this.centralDirSize; - if (this.zip64) { - expectedEndOfCentralDirOffset += 20; // end of central dir 64 locator - expectedEndOfCentralDirOffset += 12 /* should not include the leading 12 bytes */ + this.zip64EndOfCentralSize; - } - - var extraBytes = endOfCentralDirOffset - expectedEndOfCentralDirOffset; - - if (extraBytes > 0) { - // console.warn(extraBytes, "extra bytes at beginning or within zipfile"); - if (this.isSignature(endOfCentralDirOffset, sig.CENTRAL_FILE_HEADER)) { - // The offsets seem wrong, but we have something at the specified offset. - // So… we keep it. - } else { - // the offset is wrong, update the "zero" of the reader - // this happens if data has been prepended (crx files for example) - this.reader.zero = extraBytes; - } - } else if (extraBytes < 0) { - throw new Error("Corrupted zip: missing " + Math.abs(extraBytes) + " bytes."); - } - }, - prepareReader: function(data) { - this.reader = readerFor(data); - }, - /** - * Read a zip file and create ZipEntries. - * @param {String|ArrayBuffer|Uint8Array|Buffer} data the binary string representing a zip file. - */ - load: function(data) { - this.prepareReader(data); - this.readEndOfCentral(); - this.readCentralDir(); - this.readLocalFiles(); - } -}; -// }}} end of ZipEntries -module.exports = ZipEntries; - -},{"./reader/readerFor":22,"./signature":23,"./support":30,"./utf8":31,"./utils":32,"./zipEntry":34}],34:[function(require,module,exports){ -'use strict'; -var readerFor = require('./reader/readerFor'); -var utils = require('./utils'); -var CompressedObject = require('./compressedObject'); -var crc32fn = require('./crc32'); -var utf8 = require('./utf8'); -var compressions = require('./compressions'); -var support = require('./support'); - -var MADE_BY_DOS = 0x00; -var MADE_BY_UNIX = 0x03; - -/** - * Find a compression registered in JSZip. - * @param {string} compressionMethod the method magic to find. - * @return {Object|null} the JSZip compression object, null if none found. - */ -var findCompression = function(compressionMethod) { - for (var method in compressions) { - if (!compressions.hasOwnProperty(method)) { - continue; - } - if (compressions[method].magic === compressionMethod) { - return compressions[method]; - } - } - return null; -}; - -// class ZipEntry {{{ -/** - * An entry in the zip file. - * @constructor - * @param {Object} options Options of the current file. - * @param {Object} loadOptions Options for loading the stream. - */ -function ZipEntry(options, loadOptions) { - this.options = options; - this.loadOptions = loadOptions; -} -ZipEntry.prototype = { - /** - * say if the file is encrypted. - * @return {boolean} true if the file is encrypted, false otherwise. - */ - isEncrypted: function() { - // bit 1 is set - return (this.bitFlag & 0x0001) === 0x0001; - }, - /** - * say if the file has utf-8 filename/comment. - * @return {boolean} true if the filename/comment is in utf-8, false otherwise. - */ - useUTF8: function() { - // bit 11 is set - return (this.bitFlag & 0x0800) === 0x0800; - }, - /** - * Read the local part of a zip file and add the info in this object. - * @param {DataReader} reader the reader to use. - */ - readLocalPart: function(reader) { - var compression, localExtraFieldsLength; - - // we already know everything from the central dir ! - // If the central dir data are false, we are doomed. - // On the bright side, the local part is scary : zip64, data descriptors, both, etc. - // The less data we get here, the more reliable this should be. - // Let's skip the whole header and dash to the data ! - reader.skip(22); - // in some zip created on windows, the filename stored in the central dir contains \ instead of /. - // Strangely, the filename here is OK. - // I would love to treat these zip files as corrupted (see http://www.info-zip.org/FAQ.html#backslashes - // or APPNOTE#4.4.17.1, "All slashes MUST be forward slashes '/'") but there are a lot of bad zip generators... - // Search "unzip mismatching "local" filename continuing with "central" filename version" on - // the internet. - // - // I think I see the logic here : the central directory is used to display - // content and the local directory is used to extract the files. Mixing / and \ - // may be used to display \ to windows users and use / when extracting the files. - // Unfortunately, this lead also to some issues : http://seclists.org/fulldisclosure/2009/Sep/394 - this.fileNameLength = reader.readInt(2); - localExtraFieldsLength = reader.readInt(2); // can't be sure this will be the same as the central dir - // the fileName is stored as binary data, the handleUTF8 method will take care of the encoding. - this.fileName = reader.readData(this.fileNameLength); - reader.skip(localExtraFieldsLength); - - if (this.compressedSize === -1 || this.uncompressedSize === -1) { - throw new Error("Bug or corrupted zip : didn't get enough information from the central directory " + "(compressedSize === -1 || uncompressedSize === -1)"); - } - - compression = findCompression(this.compressionMethod); - if (compression === null) { // no compression found - throw new Error("Corrupted zip : compression " + utils.pretty(this.compressionMethod) + " unknown (inner file : " + utils.transformTo("string", this.fileName) + ")"); - } - this.decompressed = new CompressedObject(this.compressedSize, this.uncompressedSize, this.crc32, compression, reader.readData(this.compressedSize)); - }, - - /** - * Read the central part of a zip file and add the info in this object. - * @param {DataReader} reader the reader to use. - */ - readCentralPart: function(reader) { - this.versionMadeBy = reader.readInt(2); - reader.skip(2); - // this.versionNeeded = reader.readInt(2); - this.bitFlag = reader.readInt(2); - this.compressionMethod = reader.readString(2); - this.date = reader.readDate(); - this.crc32 = reader.readInt(4); - this.compressedSize = reader.readInt(4); - this.uncompressedSize = reader.readInt(4); - var fileNameLength = reader.readInt(2); - this.extraFieldsLength = reader.readInt(2); - this.fileCommentLength = reader.readInt(2); - this.diskNumberStart = reader.readInt(2); - this.internalFileAttributes = reader.readInt(2); - this.externalFileAttributes = reader.readInt(4); - this.localHeaderOffset = reader.readInt(4); - - if (this.isEncrypted()) { - throw new Error("Encrypted zip are not supported"); - } - - // will be read in the local part, see the comments there - reader.skip(fileNameLength); - this.readExtraFields(reader); - this.parseZIP64ExtraField(reader); - this.fileComment = reader.readData(this.fileCommentLength); - }, - - /** - * Parse the external file attributes and get the unix/dos permissions. - */ - processAttributes: function () { - this.unixPermissions = null; - this.dosPermissions = null; - var madeBy = this.versionMadeBy >> 8; - - // Check if we have the DOS directory flag set. - // We look for it in the DOS and UNIX permissions - // but some unknown platform could set it as a compatibility flag. - this.dir = this.externalFileAttributes & 0x0010 ? true : false; - - if(madeBy === MADE_BY_DOS) { - // first 6 bits (0 to 5) - this.dosPermissions = this.externalFileAttributes & 0x3F; - } - - if(madeBy === MADE_BY_UNIX) { - this.unixPermissions = (this.externalFileAttributes >> 16) & 0xFFFF; - // the octal permissions are in (this.unixPermissions & 0x01FF).toString(8); - } - - // fail safe : if the name ends with a / it probably means a folder - if (!this.dir && this.fileNameStr.slice(-1) === '/') { - this.dir = true; - } - }, - - /** - * Parse the ZIP64 extra field and merge the info in the current ZipEntry. - * @param {DataReader} reader the reader to use. - */ - parseZIP64ExtraField: function(reader) { - - if (!this.extraFields[0x0001]) { - return; - } - - // should be something, preparing the extra reader - var extraReader = readerFor(this.extraFields[0x0001].value); - - // I really hope that these 64bits integer can fit in 32 bits integer, because js - // won't let us have more. - if (this.uncompressedSize === utils.MAX_VALUE_32BITS) { - this.uncompressedSize = extraReader.readInt(8); - } - if (this.compressedSize === utils.MAX_VALUE_32BITS) { - this.compressedSize = extraReader.readInt(8); - } - if (this.localHeaderOffset === utils.MAX_VALUE_32BITS) { - this.localHeaderOffset = extraReader.readInt(8); - } - if (this.diskNumberStart === utils.MAX_VALUE_32BITS) { - this.diskNumberStart = extraReader.readInt(4); - } - }, - /** - * Read the central part of a zip file and add the info in this object. - * @param {DataReader} reader the reader to use. - */ - readExtraFields: function(reader) { - var end = reader.index + this.extraFieldsLength, - extraFieldId, - extraFieldLength, - extraFieldValue; - - if (!this.extraFields) { - this.extraFields = {}; - } - - while (reader.index + 4 < end) { - extraFieldId = reader.readInt(2); - extraFieldLength = reader.readInt(2); - extraFieldValue = reader.readData(extraFieldLength); - - this.extraFields[extraFieldId] = { - id: extraFieldId, - length: extraFieldLength, - value: extraFieldValue - }; - } - - reader.setIndex(end); - }, - /** - * Apply an UTF8 transformation if needed. - */ - handleUTF8: function() { - var decodeParamType = support.uint8array ? "uint8array" : "array"; - if (this.useUTF8()) { - this.fileNameStr = utf8.utf8decode(this.fileName); - this.fileCommentStr = utf8.utf8decode(this.fileComment); - } else { - var upath = this.findExtraFieldUnicodePath(); - if (upath !== null) { - this.fileNameStr = upath; - } else { - // ASCII text or unsupported code page - var fileNameByteArray = utils.transformTo(decodeParamType, this.fileName); - this.fileNameStr = this.loadOptions.decodeFileName(fileNameByteArray); - } - - var ucomment = this.findExtraFieldUnicodeComment(); - if (ucomment !== null) { - this.fileCommentStr = ucomment; - } else { - // ASCII text or unsupported code page - var commentByteArray = utils.transformTo(decodeParamType, this.fileComment); - this.fileCommentStr = this.loadOptions.decodeFileName(commentByteArray); - } - } - }, - - /** - * Find the unicode path declared in the extra field, if any. - * @return {String} the unicode path, null otherwise. - */ - findExtraFieldUnicodePath: function() { - var upathField = this.extraFields[0x7075]; - if (upathField) { - var extraReader = readerFor(upathField.value); - - // wrong version - if (extraReader.readInt(1) !== 1) { - return null; - } - - // the crc of the filename changed, this field is out of date. - if (crc32fn(this.fileName) !== extraReader.readInt(4)) { - return null; - } - - return utf8.utf8decode(extraReader.readData(upathField.length - 5)); - } - return null; - }, - - /** - * Find the unicode comment declared in the extra field, if any. - * @return {String} the unicode comment, null otherwise. - */ - findExtraFieldUnicodeComment: function() { - var ucommentField = this.extraFields[0x6375]; - if (ucommentField) { - var extraReader = readerFor(ucommentField.value); - - // wrong version - if (extraReader.readInt(1) !== 1) { - return null; - } - - // the crc of the comment changed, this field is out of date. - if (crc32fn(this.fileComment) !== extraReader.readInt(4)) { - return null; - } - - return utf8.utf8decode(extraReader.readData(ucommentField.length - 5)); - } - return null; - } -}; -module.exports = ZipEntry; - -},{"./compressedObject":2,"./compressions":3,"./crc32":4,"./reader/readerFor":22,"./support":30,"./utf8":31,"./utils":32}],35:[function(require,module,exports){ -'use strict'; - -var StreamHelper = require('./stream/StreamHelper'); -var DataWorker = require('./stream/DataWorker'); -var utf8 = require('./utf8'); -var CompressedObject = require('./compressedObject'); -var GenericWorker = require('./stream/GenericWorker'); - -/** - * A simple object representing a file in the zip file. - * @constructor - * @param {string} name the name of the file - * @param {String|ArrayBuffer|Uint8Array|Buffer} data the data - * @param {Object} options the options of the file - */ -var ZipObject = function(name, data, options) { - this.name = name; - this.dir = options.dir; - this.date = options.date; - this.comment = options.comment; - this.unixPermissions = options.unixPermissions; - this.dosPermissions = options.dosPermissions; - - this._data = data; - this._dataBinary = options.binary; - // keep only the compression - this.options = { - compression : options.compression, - compressionOptions : options.compressionOptions - }; -}; - -ZipObject.prototype = { - /** - * Create an internal stream for the content of this object. - * @param {String} type the type of each chunk. - * @return StreamHelper the stream. - */ - internalStream: function (type) { - var result = null, outputType = "string"; - try { - if (!type) { - throw new Error("No output type specified."); - } - outputType = type.toLowerCase(); - var askUnicodeString = outputType === "string" || outputType === "text"; - if (outputType === "binarystring" || outputType === "text") { - outputType = "string"; - } - result = this._decompressWorker(); - - var isUnicodeString = !this._dataBinary; - - if (isUnicodeString && !askUnicodeString) { - result = result.pipe(new utf8.Utf8EncodeWorker()); - } - if (!isUnicodeString && askUnicodeString) { - result = result.pipe(new utf8.Utf8DecodeWorker()); - } - } catch (e) { - result = new GenericWorker("error"); - result.error(e); - } - - return new StreamHelper(result, outputType, ""); - }, - - /** - * Prepare the content in the asked type. - * @param {String} type the type of the result. - * @param {Function} onUpdate a function to call on each internal update. - * @return Promise the promise of the result. - */ - async: function (type, onUpdate) { - return this.internalStream(type).accumulate(onUpdate); - }, - - /** - * Prepare the content as a nodejs stream. - * @param {String} type the type of each chunk. - * @param {Function} onUpdate a function to call on each internal update. - * @return Stream the stream. - */ - nodeStream: function (type, onUpdate) { - return this.internalStream(type || "nodebuffer").toNodejsStream(onUpdate); - }, - - /** - * Return a worker for the compressed content. - * @private - * @param {Object} compression the compression object to use. - * @param {Object} compressionOptions the options to use when compressing. - * @return Worker the worker. - */ - _compressWorker: function (compression, compressionOptions) { - if ( - this._data instanceof CompressedObject && - this._data.compression.magic === compression.magic - ) { - return this._data.getCompressedWorker(); - } else { - var result = this._decompressWorker(); - if(!this._dataBinary) { - result = result.pipe(new utf8.Utf8EncodeWorker()); - } - return CompressedObject.createWorkerFrom(result, compression, compressionOptions); - } - }, - /** - * Return a worker for the decompressed content. - * @private - * @return Worker the worker. - */ - _decompressWorker : function () { - if (this._data instanceof CompressedObject) { - return this._data.getContentWorker(); - } else if (this._data instanceof GenericWorker) { - return this._data; - } else { - return new DataWorker(this._data); - } - } -}; - -var removedMethods = ["asText", "asBinary", "asNodeBuffer", "asUint8Array", "asArrayBuffer"]; -var removedFn = function () { - throw new Error("This method has been removed in JSZip 3.0, please check the upgrade guide."); -}; - -for(var i = 0; i < removedMethods.length; i++) { - ZipObject.prototype[removedMethods[i]] = removedFn; -} -module.exports = ZipObject; - -},{"./compressedObject":2,"./stream/DataWorker":27,"./stream/GenericWorker":28,"./stream/StreamHelper":29,"./utf8":31}],36:[function(require,module,exports){ -(function (global){ -'use strict'; -var Mutation = global.MutationObserver || global.WebKitMutationObserver; - -var scheduleDrain; - -{ - if (Mutation) { - var called = 0; - var observer = new Mutation(nextTick); - var element = global.document.createTextNode(''); - observer.observe(element, { - characterData: true - }); - scheduleDrain = function () { - element.data = (called = ++called % 2); - }; - } else if (!global.setImmediate && typeof global.MessageChannel !== 'undefined') { - var channel = new global.MessageChannel(); - channel.port1.onmessage = nextTick; - scheduleDrain = function () { - channel.port2.postMessage(0); - }; - } else if ('document' in global && 'onreadystatechange' in global.document.createElement('script')) { - scheduleDrain = function () { - - // Create a - - - +