io microsphere io event FileChangedListener

FileChangedListener

Type: Interface | Module: microsphere-java-core | Package: io.microsphere.io.event | Since: 1.0.0

Source: microsphere-java-core/src/main/java/io/microsphere/io/event/FileChangedListener.java

Overview

A listener interface for receiving file change events.

This interface extends EventListener to handle FileChangedEvent instances, providing a more specific way to react to changes in files or directories. When implementing this interface, you can either override the general #onEvent(FileChangedEvent) method or selectively override the more specific methods like #onFileCreated(FileChangedEvent), #onFileModified(FileChangedEvent), and #onFileDeleted(FileChangedEvent).

Example Usage

Here's an example of how to implement this interface:

`public class MyFileChangeListener implements FileChangedListener {

    private final int priority;

    public MyFileChangeListener(int priority) {
        this.priority = priority;
    `

### Declaration

```java
public interface FileChangedListener extends EventListener
```

**Author:** Mercy

## Version Information

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

## Version Compatibility

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

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

## Examples

### Example 1

```java
public class MyFileChangeListener implements FileChangedListener {

    private final int priority;

    public MyFileChangeListener(int priority) {
        this.priority = priority;
    }

    @Override
    public void onFileCreated(FileChangedEvent event) {
        System.out.println("File created: " + event.getFile().getAbsolutePath());
    }

    @Override
    public void onFileModified(FileChangedEvent event) {
        System.out.println("File modified: " + event.getFile().getAbsolutePath());
    }

    @Override
    public void onFileDeleted(FileChangedEvent event) {
        System.out.println("File deleted: " + event.getFile().getAbsolutePath());
    }

    @Override
    public int getPriority() {
        return priority;
    }
}
```

### Example 2

```java
@Override
public void onEvent(FileChangedEvent event) {
    switch (event.getKind()) {
        case CREATED:
            // Handle file creation
            break;
        case MODIFIED:
            // Handle file modification
            break;
        case DELETED:
            // Handle file deletion
            break;
    }
}
```

## Usage

### Maven Dependency

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

```xml

    io.github.microsphere-projects
    microsphere-java-core
    ${microsphere-java.version}

```

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

### Import

```java
import io.microsphere.io.event.FileChangedListener;
```

## See Also

- `FileChangedEvent`
- `EventListener`
- `Event`

---

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