Package io.quarkus.arc.deployment

Class BuildExclusionsBuildItem

java.lang.Object

io.quarkus.builder.item.BuildItem

io.quarkus.builder.item.SimpleBuildItem

io.quarkus.arc.deployment.BuildExclusionsBuildItem

public final class BuildExclusionsBuildItem
extends io.quarkus.builder.item.SimpleBuildItem

A type of build item that contains only declaring classes, methods and fields that have been annotated with unsuccessful build time conditions. It aims to be used to manage the exclusion of the annotations thanks to the build time conditions also known as IfBuildProfile, UnlessBuildProfile, IfBuildProperty and UnlessBuildProperty

See Also:

io.quarkus.arc.deployment.PreAdditionalBeanBuildTimeConditionBuildItem, IfBuildProfile, UnlessBuildProfile, IfBuildProperty, UnlessBuildProperty

Constructor Summary

Constructors

Constructor	Description
BuildExclusionsBuildItem(Set<String> excludedDeclaringClasses, Set<String> excludedMethods, Set<String> excludedFields)

Method Summary

Modifier and Type	Method	Description
Set<String>	getExcludedDeclaringClasses()
Set<String>	getExcludedFields()
Set<String>	getExcludedMethods()
boolean	isExcluded(org.jboss.jandex.AnnotationTarget target)	Indicates whether the given target is excluded following the next rules:
static String	targetMapper(org.jboss.jandex.AnnotationTarget target)	Converts the given target into a String unique representation.

Methods inherited from class java.lang.Object

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

Constructor Detail

BuildExclusionsBuildItem

public BuildExclusionsBuildItem(Set<String> excludedDeclaringClasses,
                                Set<String> excludedMethods,
                                Set<String> excludedFields)

Method Detail

getExcludedDeclaringClasses

public Set<String> getExcludedDeclaringClasses()

getExcludedMethods

public Set<String> getExcludedMethods()

getExcludedFields

public Set<String> getExcludedFields()

isExcluded

public boolean isExcluded(org.jboss.jandex.AnnotationTarget target)

Indicates whether the given target is excluded following the next rules:

• In case of a class it will check if it is part of the excluded classes
• In case of a method it will check if it is part of the excluded methods and if its declaring class is excluded
• In case of a method parameter it will check if its corresponding method is part of the excluded methods and if its declaring class is excluded
• In case of a field it will check if it is part of the excluded field and if its declaring class is excluded
• In all other cases, it is not excluded

Parameters:

target - the target to check.

Returns:

true if the target is excluded, false otherwise.

targetMapper

public static String targetMapper(org.jboss.jandex.AnnotationTarget target)

Converts the given target into a String unique representation.

Parameters:

target - the target to convert.

Returns:

a unique representation as a String of the target