Package io.quarkus.arc.deployment
Class AdditionalBeanBuildItem
- java.lang.Object
-
- io.quarkus.builder.item.BuildItem
-
- io.quarkus.builder.item.MultiBuildItem
-
- io.quarkus.arc.deployment.AdditionalBeanBuildItem
-
public final class AdditionalBeanBuildItem extends io.quarkus.builder.item.MultiBuildItem
This build item is used to specify one or more additional bean classes to be analyzed during bean discovery.By default, the resulting beans may be removed if they are considered unused and
ArcConfig.removeUnusedBeans
is enabled. You can change the default behavior by setting theremovable
tofalse
and viaAdditionalBeanBuildItem.Builder.setUnremovable()
.An additional bean may have the scope defaulted via
defaultScope
andAdditionalBeanBuildItem.Builder.setDefaultScope(DotName)
. The default scope is only used if there is no scope declared on the bean class. The default scope should be used in cases where a bean class source is not controlled by the extension and the scope annotation cannot be declared directly on the class.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
AdditionalBeanBuildItem.Builder
-
Constructor Summary
Constructors Constructor Description AdditionalBeanBuildItem(Class<?>... beanClasses)
AdditionalBeanBuildItem(String... beanClasses)
AdditionalBeanBuildItem(List<String> beanClasses, boolean removable, org.jboss.jandex.DotName defaultScope)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static AdditionalBeanBuildItem.Builder
builder()
boolean
contains(String beanClass)
List<String>
getBeanClasses()
org.jboss.jandex.DotName
getDefaultScope()
boolean
isRemovable()
static AdditionalBeanBuildItem
unremovableOf(Class<?> beanClass)
Convenient factory method to create an unremovable build item for a single bean class.static AdditionalBeanBuildItem
unremovableOf(String beanClass)
Convenient factory method to create an unremovable build item for a single bean class.
-
-
-
Method Detail
-
builder
public static AdditionalBeanBuildItem.Builder builder()
-
unremovableOf
public static AdditionalBeanBuildItem unremovableOf(Class<?> beanClass)
Convenient factory method to create an unremovable build item for a single bean class.- Parameters:
beanClass
-- Returns:
- a new build item
-
unremovableOf
public static AdditionalBeanBuildItem unremovableOf(String beanClass)
Convenient factory method to create an unremovable build item for a single bean class.- Parameters:
beanClass
-- Returns:
- a new build item
-
contains
public boolean contains(String beanClass)
-
isRemovable
public boolean isRemovable()
-
getDefaultScope
public org.jboss.jandex.DotName getDefaultScope()
-
-