io microsphere spring context event OnceApplicationContextEventListener

OnceApplicationContextEventListener

Type: Class | Module: microsphere-spring-context | Package: io.microsphere.spring.context.event | Since: 1.0.0

Source: microsphere-spring-context/src/main/java/io/microsphere/spring/context/event/OnceApplicationContextEventListener.java

Overview

Abstract ApplicationListener base class for handling ApplicationContextEvent in a one-time execution manner.

This class ensures that the event is processed only once and prevents event propagation across hierarchical ApplicationContext instances.

Example Usage

{@code
public class MyApplicationContextEventListener
    extends OnceApplicationContextEventListener {

### Declaration

```java
public abstract class OnceApplicationContextEventListener implements ApplicationListener,
```

**Author:** Mercy

## Version Information

- **Introduced in:** `1.0.0`
- **Current Project Version:** `0.2.27-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
public class MyApplicationContextEventListener
    extends OnceApplicationContextEventListener {

    @Override
    protected void onApplicationContextEvent(ContextRefreshedEvent event) {
        // Handle the event only once in the original context
        System.out.println("Context refreshed: " + event.getApplicationContext());
    }
}
```

## Usage

### Maven Dependency

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

```xml

    io.github.microsphere-projects
    microsphere-spring-context
    ${microsphere-spring.version}

```

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

### Import

```java
import io.microsphere.spring.context.event.OnceApplicationContextEventListener;
```

## API Reference

### Public Methods

| Method | Description |
|--------|-------------|
| `onApplicationEvent` |  |
| `setApplicationContext` |  |
| `getApplicationContext` |  |

## See Also

- `ApplicationListener`
- `ApplicationContextEvent`

---

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