org.apache.deltaspike.core.api.exclude

Annotation Type Exclude

@Retention(value=RUNTIME)
@Target(value=TYPE)
public @interface Exclude

Supported usages:

 @Exclude
 @Exclude(ifProjectStage=Production.class)
 @Exclude(exceptIfProjectStage=UnitTest.class)
 @Exclude(onExpression="myProperty==myValue")
 @Exclude(onExpression="[my custom expression syntax]", interpretedBy=CustomExpressionInterpreter.class)
 

examples:

the following bean gets excluded in any case

 @Exclude
 public class NoBean {}
 

the following bean gets excluded in case of project-stage development

 @Exclude(ifProjectStage = ProjectStage.Development.class)
 public class ProductionBean {}
 

the following bean gets excluded in every case except of project-stage development

 @Exclude(exceptIfProjectStage = ProjectStage.Development.class)
 public class DevBean {}
 

the following bean gets excluded if the expression evaluates to true. that means there is a configured property called 'myProper' with the value 'myValue'

 @Exclude(onExpression="myProperty==myValue")
 public class ProductionBean {}
 

the following bean gets excluded if the expression evaluates to true

@Exclude(onExpression="[my custom expression syntax]", interpretedBy=CustomExpressionInterpreter.class) public class ProductionBean {}

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
Class<? extends ProjectStage>[]	exceptIfProjectStage The ProjectStages which lead to activating this bean.
Class<? extends ProjectStage>[]	ifProjectStage The ProjectStages which lead to deactivating this bean.
Class<? extends ExpressionInterpreter>	interpretedBy
String	onExpression Expression which signals if the annotated bean should be deactivated or not

Element Detail

ifProjectStage

public abstract Class<? extends ProjectStage>[] ifProjectStage

The ProjectStages which lead to deactivating this bean. If the current ProjectStage is in this list, the bean will get vetoed.

Returns:

1-n project-stages which are not allowed for the annotated artifact

Default:

{}

exceptIfProjectStage

public abstract Class<? extends ProjectStage>[] exceptIfProjectStage

The ProjectStages which lead to activating this bean. If the current ProjectStage is not in this list, the bean will get vetoed.

Returns:

1-n project-stages which are allowed for the annotated artifact

Default:

{}

onExpression

public abstract String onExpression

Expression which signals if the annotated bean should be deactivated or not

Returns:

expression-string which will be interpreted

Default:

""

interpretedBy

public abstract Class<? extends ExpressionInterpreter> interpretedBy

Returns:

class of the interpreter which should be used (default leads to a simple config-property interpreter)

Default:

org.apache.deltaspike.core.api.interpreter.ExpressionInterpreter.class