io.micronaut.context.annotation

Annotation Type Requires

@Documented
 @Retention(value=RUNTIME)
 @Target(value={PACKAGE,TYPE,ANNOTATION_TYPE,METHOD,FIELD})
 @Repeatable(value=Requirements.class)
public @interface Requires

Expresses a requirement for a bean or Configuration.

Since:

1.0

Author:

Graeme Rocher

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
Class	bean Expresses that the bean the given class should be available for the bean or configuration to load.
String	beanProperty Used in combination with bean() to express that the given bean property should be set for the bean to load.
Class[]	beans Expresses that beans of the given types should be available for the bean or configuration to load.
Class[]	classes Expresses the given classes that should be present on the classpath for the bean or configuration to load.
Class<? extends Condition>	condition One ore more custom condition classes.
String	configuration Expresses the configurations that should be present for the bean or configuration to load.
String	defaultValue
Class<? extends Annotation>[]	entities Expresses that the configuration requires entities annotated with the given annotations to be available to the application via package scanning.
String[]	env Expresses that the configuration will only load within the given environments.
Class[]	missing Expresses the given classes that should be missing from the classpath for the bean or configuration to load.
Class[]	missingBeans Expresses the given beans that should be missing from the classpath for the bean or configuration to load.
String[]	missingClasses Expresses the given class names should be missing from the classpath for the bean configuration to load.
String[]	missingConfigurations Expresses the given configurations that should be missing from the classpath for the bean or configuration to load.
String	missingProperty Expresses that the bean or configuration will only be configured if the given property is missing.
String[]	notEnv Expresses that the configuration will not load within the given environments.
String	notEquals Constraint a property to not equal the given value.
Requires.Family[]	notOs Expresses the current operating system must not be one in the given list.
Requires.Family[]	os Expresses the current operating system must be one in the given list.
String	pattern Used in combination with property() to express the required pattern of the property.
String	property Expresses that the given property should be set for the bean to load.
String[]	resources Expresses the given resources should exist for the bean configuration to load.
Requires.Sdk	sdk Used to express an SDK requirement.
String	value Used in combination with property() to express the required value of the property.
String	version Used in combination with sdk(), configuration(), classes() or beans() to express a minimum version of the SDK, configuration or classes.

Element Detail

env

public abstract String[] env

Expresses that the configuration will only load within the given environments.

Returns:

The names of the environments this configuration will load in

Default:

{}

notEnv

public abstract String[] notEnv

Expresses that the configuration will not load within the given environments.

Returns:

The names of the environments this configuration will not load in

Default:

{}

property

public abstract String property

Expresses that the given property should be set for the bean to load.

Returns:

The property that should be set.

Default:

""

notEquals

public abstract String notEquals

Constraint a property to not equal the given value.

Returns:

The value to not equal

Default:

""

condition

@InstantiatedMember
public abstract Class<? extends Condition> condition

One ore more custom condition classes.

Returns:

The condition classes

Default:

io.micronaut.context.condition.TrueCondition.class

sdk

public abstract Requires.Sdk sdk

Used to express an SDK requirement. Typically used in combination with version() to specify a minimum version requirement.

Returns:

The SDK required

Default:

io.micronaut.context.annotation.Requires.Sdk.MICRONAUT

configuration

public abstract String configuration

Expresses the configurations that should be present for the bean or configuration to load.

Returns:

The configurations

Default:

""

value

public abstract String value

Used in combination with property() to express the required value of the property.

Returns:

The required value

Default:

""

defaultValue

public abstract String defaultValue

Returns:

The default value if no value is specified

Default:

""

pattern

public abstract String pattern

Used in combination with property() to express the required pattern of the property. The pattern will be evaluated with String.matches(String).

Returns:

The required pattern

Default:

""

version

public abstract String version

Used in combination with sdk(), configuration(), classes() or beans() to express a minimum version of the SDK, configuration or classes.

Returns:

The minimum version

Default:

""

classes

public abstract Class[] classes

Expresses the given classes that should be present on the classpath for the bean or configuration to load.

Returns:

The classes

Default:

{}

entities

public abstract Class<? extends Annotation>[] entities

Expresses that the configuration requires entities annotated with the given annotations to be available to the application via package scanning.

Returns:

The classes

Default:

{}

beans

public abstract Class[] beans

Expresses that beans of the given types should be available for the bean or configuration to load.

Returns:

The beans

Default:

{}

missing

public abstract Class[] missing

Expresses the given classes that should be missing from the classpath for the bean or configuration to load.

Returns:

The classes

Default:

{}

missingClasses

@AliasFor(member="missing")
public abstract String[] missingClasses

Expresses the given class names should be missing from the classpath for the bean configuration to load.

Returns:

The names of the classes that should be missing

Default:

{}

missingBeans

public abstract Class[] missingBeans

Expresses the given beans that should be missing from the classpath for the bean or configuration to load.

Returns:

The classes

Default:

{}

missingConfigurations

public abstract String[] missingConfigurations

Expresses the given configurations that should be missing from the classpath for the bean or configuration to load.

Returns:

The classes

Default:

{}

missingProperty

public abstract String missingProperty

Expresses that the bean or configuration will only be configured if the given property is missing.

Returns:

The property or properties that should be missing

Default:

""

resources

public abstract String[] resources

Expresses the given resources should exist for the bean configuration to load. Resources can be anything that ResourceResolver can read, eg:

  file:/path/to/file.txt
  classpath:com/mycompany/file.txt
 

Returns:

The file paths

Default:

{}

os

public abstract Requires.Family[] os

Expresses the current operating system must be one in the given list.

Returns:

The os families

Default:

{}

notOs

public abstract Requires.Family[] notOs

Expresses the current operating system must not be one in the given list.

Returns:

The os families

Default:

{}

bean

public abstract Class bean

Expresses that the bean the given class should be available for the bean or configuration to load. Can be used in combination with beanProperty() to specify the required bean property

Returns:

The configuration properties class

Since:

3.4.0

Default:

void.class

beanProperty

public abstract String beanProperty

Used in combination with bean() to express that the given bean property should be set for the bean to load.

Returns:

The configuration property that should be set.

Since:

3.4.0

Default:

""