io microsphere convert AbstractConverter

AbstractConverter

Type: Class | Module: microsphere-java-core | Package: io.microsphere.convert | Since: 1.0.0

Source: microsphere-java-core/src/main/java/io/microsphere/convert/AbstractConverter.java

Overview

An abstract base class for implementing the Converter interface.

This class provides a default implementation for priority resolution based on the inheritance hierarchy depth of source and target types, ensuring more specific converters (those handling more derived types) receive higher priority. It also includes common functionality such as logging support, null safety in conversion, and proper equals and hashcode behavior.

Example Usage

`public class StringToIntegerConverter extends AbstractConverter {
    public boolean accept(Class sourceType, Class targetType) {
        return sourceType.isAssignableFrom(String.class) &&
               targetType.isAssignableFrom(Integer.class);
    `

    public Integer doConvert(String source) {
        return Integer.parseInt(source);
    }
}
}

Prioritized Behavior Example

`public class HighPriorityStringToIntegerConverter extends AbstractConverter {
    public boolean accept(Class sourceType, Class targetType) {
        return sourceType.isAssignableFrom(String.class) &&
               targetType.isAssignableFrom(Integer.class);
    `

    public Integer doConvert(String source) {
        return Integer.parseInt(source);
    }

### Declaration

```java
public abstract class AbstractConverter implements Converter
```

**Author:** Mercy

## Version Information

- **Introduced in:** `1.0.0`
- **Current Project Version:** `0.2.2-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 StringToIntegerConverter extends AbstractConverter {
    public boolean accept(Class> sourceType, Class> targetType) {
        return sourceType.isAssignableFrom(String.class) &&
               targetType.isAssignableFrom(Integer.class);
    }

    public Integer doConvert(String source) {
        return Integer.parseInt(source);
    }
}
```

### Example 2

```java
public class HighPriorityStringToIntegerConverter extends AbstractConverter {
    public boolean accept(Class> sourceType, Class> targetType) {
        return sourceType.isAssignableFrom(String.class) &&
               targetType.isAssignableFrom(Integer.class);
    }

    public Integer doConvert(String source) {
        return Integer.parseInt(source);
    }

    @Override
    public int getPriority() {
        return Prioritized.MAX_PRIORITY; // Highest priority
    }
}
```

## 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.convert.AbstractConverter;
```

## API Reference

### Public Methods

| Method | Description |
|--------|-------------|
| `convert` |  |
| `getPriority` |  |

## See Also

- `Converter`
- `Prioritized`

---

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