Interface ResultCodeProvider

public interface ResultCodeProvider
Result Code Provider SPI 响应码提供者SPI

Service Provider Interface for custom result codes.

自定义响应码的服务提供者接口。

Usage | 使用方式:

// Implement custom provider
public class MyResultCodeProvider implements ResultCodeProvider {
    @Override
    public Collection<ResultCode> getResultCodes() {
        return Arrays.asList(MyResultCode.values());
    }
}

// Register via META-INF/services

Features | 主要功能:

  • SPI for custom result code registration - 自定义响应码注册SPI
  • Code lookup by string - 按字符串查找响应码
  • Priority ordering support - 优先级排序支持

Usage Examples | 使用示例:

public class MyProvider implements ResultCodeProvider {
    public Collection<ResultCode> getResultCodes() {
        return List.of(MyResultCode.values());
    }
}

Security | 安全性:

  • Thread-safe: Implementation-dependent - 取决于实现
  • Null-safe: No (code should not be null) - 否（代码不应为null）
Since:
JDK 25, opencode-base-web V1.0.0
Author:
Leon Soo www.LeonSoo.com
See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    default Optional<ResultCode>
    getByCode(String code)
    Get result code by code string 通过代码字符串获取响应码
    default int
    getOrder()
    Get the provider order 获取提供者顺序
    Collection<ResultCode>
    getResultCodes()
    Get all result codes 获取所有响应码
    default boolean
    supports(String code)
    Check if this provider supports the code 检查此提供者是否支持该代码

  • Method Details

    • getResultCodes

      Collection<ResultCode> getResultCodes()
      Get all result codes 获取所有响应码
      Returns:
      the result codes | 响应码集合

    • getByCode

      default Optional<ResultCode> getByCode(String code)
      Get result code by code string 通过代码字符串获取响应码
      Parameters:
      code - the code string | 代码字符串
      Returns:
      the result code if found | 如果找到返回响应码

    • getOrder

      default int getOrder()
      Get the provider order 获取提供者顺序

      Lower values have higher priority.

      值越小优先级越高。

      Returns:
      the order | 顺序

    • supports

      default boolean supports(String code)
      Check if this provider supports the code 检查此提供者是否支持该代码
      Parameters:
      code - the code to check | 要检查的代码
      Returns:
      true if supported | 如果支持返回true