Class Results

java.lang.Object
cloud.opencode.base.web.Results
public final class Results extends Object
Results 响应构建工具类

Factory class for creating Result objects.

创建Result对象的工厂类。

Features | 主要功能:

  • Factory methods for success and failure results - 成功和失败结果的工厂方法
  • Page result creation - 分页结果创建
  • Exception to Result conversion - 异常到 Result 的转换
  • Builder pattern support - 构建器模式支持

Usage Examples | 使用示例:

// Success results
Result<String> result = Results.ok("Hello");
Result<User> result = Results.ok("Operation successful", user);

// Failure results
Result<?> result = Results.fail("B1001", "Business error");
Result<?> result = Results.fail(CommonResultCode.NOT_FOUND);

// Page results
Result<PageResult<User>> result = Results.page(users, 100, 1, 10);

Security | 安全性:

  • Thread-safe: Yes (stateless utility class) - 线程安全: 是（无状态工具类）
  • Null-safe: Yes (data can be null) - 空值安全: 是（数据可以为 null）
Since:
JDK 25, opencode-base-web V1.0.0
Author:
Leon Soo www.LeonSoo.com
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    Results.Builder<T>
    Result Builder 结果构建器

  • Method Summary

    Modifier and Type
    Method
    Description
    static <T> Results.Builder<T>
    builder()
    Create result builder 创建结果构建器
    static <T> Result<PageResult<T>>
    emptyPage()
    Create empty page result 创建空分页结果
    static <T> Result<PageResult<T>>
    emptyPage(int page, int size)
    Create empty page result with page info 创建带分页信息的空分页结果
    static <T> Result<T>
    fail(ResultCode resultCode)
    Create failure result with result code 使用响应码创建失败结果
    static <T> Result<T>
    fail(ResultCode resultCode, String message)
    Create failure result with result code and custom message 使用响应码和自定义消息创建失败结果
    static <T> Result<T>
    fail(String code, String message)
    Create failure result 创建失败结果
    static <T> Result<T>
    fail(String code, String message, T data)
    Create failure result with data 创建带数据的失败结果
    static <T> Result<T>
    fail(Throwable throwable)
    Create failure result from exception 从异常创建失败结果
    static <T> Result<T>
    ok()
    Create success result 创建成功结果
    static <T> Result<T>
    ok(ResultCode resultCode, T data)
    Create success result with result code 使用响应码创建成功结果
    static <T> Result<T>
    ok(String message, T data)
    Create success result with message and data 创建带消息和数据的成功结果
    static <T> Result<T>
    ok(T data)
    Create success result with data 创建带数据的成功结果
    static <T> Result<PageResult<T>>
    page(List<T> items, long total, int page, int size)
    Create page result 创建分页结果
    static <T> Result<PageResult<T>>
    page(List<T> items, PageInfo pageInfo)
    Create page result 创建分页结果

    Methods inherited from class Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Method Details

    • ok

      public static <T> Result<T> ok()
      Create success result 创建成功结果
      Type Parameters:
      T - the data type | 数据类型
      Returns:
      the result | 结果

    • ok

      public static <T> Result<T> ok(T data)
      Create success result with data 创建带数据的成功结果
      Type Parameters:
      T - the data type | 数据类型
      Parameters:
      data - the data | 数据
      Returns:
      the result | 结果

    • ok

      public static <T> Result<T> ok(String message, T data)
      Create success result with message and data 创建带消息和数据的成功结果
      Type Parameters:
      T - the data type | 数据类型
      Parameters:
      message - the message | 消息
      data - the data | 数据
      Returns:
      the result | 结果

    • ok

      public static <T> Result<T> ok(ResultCode resultCode, T data)
      Create success result with result code 使用响应码创建成功结果
      Type Parameters:
      T - the data type | 数据类型
      Parameters:
      resultCode - the result code | 响应码
      data - the data | 数据
      Returns:
      the result | 结果

    • fail

      public static <T> Result<T> fail(String code, String message)
      Create failure result 创建失败结果
      Type Parameters:
      T - the data type | 数据类型
      Parameters:
      code - the code | 代码
      message - the message | 消息
      Returns:
      the result | 结果

    • fail

      public static <T> Result<T> fail(ResultCode resultCode)
      Create failure result with result code 使用响应码创建失败结果
      Type Parameters:
      T - the data type | 数据类型
      Parameters:
      resultCode - the result code | 响应码
      Returns:
      the result | 结果

    • fail

      public static <T> Result<T> fail(ResultCode resultCode, String message)
      Create failure result with result code and custom message 使用响应码和自定义消息创建失败结果
      Type Parameters:
      T - the data type | 数据类型
      Parameters:
      resultCode - the result code | 响应码
      message - the custom message | 自定义消息
      Returns:
      the result | 结果

    • fail

      public static <T> Result<T> fail(Throwable throwable)
      Create failure result from exception 从异常创建失败结果
      Type Parameters:
      T - the data type | 数据类型
      Parameters:
      throwable - the exception | 异常
      Returns:
      the result | 结果

    • fail

      public static <T> Result<T> fail(String code, String message, T data)
      Create failure result with data 创建带数据的失败结果
      Type Parameters:
      T - the data type | 数据类型
      Parameters:
      code - the code | 代码
      message - the message | 消息
      data - the data | 数据
      Returns:
      the result | 结果

    • page

      public static <T> Result<PageResult<T>> page(List<T> items, PageInfo pageInfo)
      Create page result 创建分页结果
      Type Parameters:
      T - the item type | 项类型
      Parameters:
      items - the items | 项列表
      pageInfo - the page info | 分页信息
      Returns:
      the result | 结果

    • page

      public static <T> Result<PageResult<T>> page(List<T> items, long total, int page, int size)
      Create page result 创建分页结果
      Type Parameters:
      T - the item type | 项类型
      Parameters:
      items - the items | 项列表
      total - the total count | 总数
      page - the page number | 页码
      size - the page size | 页大小
      Returns:
      the result | 结果

    • emptyPage

      public static <T> Result<PageResult<T>> emptyPage()
      Create empty page result 创建空分页结果
      Type Parameters:
      T - the item type | 项类型
      Returns:
      the result | 结果

    • emptyPage

      public static <T> Result<PageResult<T>> emptyPage(int page, int size)
      Create empty page result with page info 创建带分页信息的空分页结果
      Type Parameters:
      T - the item type | 项类型
      Parameters:
      page - the page number | 页码
      size - the page size | 页大小
      Returns:
      the result | 结果

    • builder

      public static <T> Results.Builder<T> builder()
      Create result builder 创建结果构建器
      Type Parameters:
      T - the data type | 数据类型
      Returns:
      the builder | 构建器