Skip to content

io microsphere i18n spring boot condition ConditionalOnI18nAvailable

github-actions[bot] edited this page Jul 9, 2026 · 2 revisions

ConditionalOnI18nAvailable

Type: Annotation | Module: microsphere-i18n-spring-boot | Package: io.microsphere.i18n.spring.boot.condition | Since: 1.0.0

Source: microsphere-i18n-spring-boot/src/main/java/io/microsphere/i18n/spring/boot/condition/ConditionalOnI18nAvailable.java

Overview

Conditional @Conditional that checks whether I18n is available. Combines class presence checks and property condition (microsphere.i18n.enabled).

Example Usage

{@code

### Declaration

```java
public @interface ConditionalOnI18nAvailable
```

**Author:** Mercy

## Version Information

- **Introduced in:** `1.0.0`
- **Current Project Version:** `0.2.17-SNAPSHOT`

## Version Compatibility

This component is tested and compatible with the following Java versions:

| Java Version | Status |
|:---:|:---:|
| Java 17 | ✅ Compatible |
| Java 21 | ✅ Compatible |
| Java 25 | ✅ Compatible |

## Examples

```java
@ConditionalOnI18nAvailable
  @Configuration
  public class MyI18nConfig {
      // Only activated when i18n core and spring modules are on classpath
      // and microsphere.i18n.enabled is true (default)
  }
```

## Usage

### Maven Dependency

Add the following dependency to your `pom.xml`:

```xml

    io.github.microsphere-projects
    microsphere-i18n-spring-boot
    ${microsphere-i18n.version}

```

> **Tip:** Use the BOM (`microsphere-i18n-dependencies`) for consistent version management. See the [Getting Started](https://github.com/microsphere-projects/microsphere-i18n#getting-started) guide.

### Import

```java
import io.microsphere.i18n.spring.boot.condition.ConditionalOnI18nAvailable;
```

---

*This documentation was auto-generated from the source code of [microsphere-i18n](https://github.com/microsphere-projects/microsphere-i18n).*

Clone this wiki locally