Package cn.dinodev.spring.commons.response

Interface Status

All Known Implementing Classes:
Status.CODE
public interface Status
响应状态码及msg
Author:
Cody Lu

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static enum 
    Status.CODE
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static Status
    fail(int code, String msg)
    生成失败Status
    static Status
    fail(int code, String msg, Object... args)
    生成失败Status, 并对错误消息进行参数化，如：fail(-1, "参数{}不能为空", "name")
    static Status
    fail(String msg)
    生成失败Status，默认为 cn.dinodev.spring.commons.response.Status.CODE.ERROR
    static Status
    fail(String msg, Object... args)
    生成失败Status，默认为 cn.dinodev.spring.commons.response.Status.CODE.ERROR 如：fail("参数{}不能为空", "name")
    int
    getCode()
    获取状态码
    String
    getMsg()
    获取错误消息
    static Status
    invalidParam(String msg)
    生成参数错误Status
    static Status
    invalidParam(String msg, Object... args)
    生成失败Status, 并对错误消息进行参数化，如：invalidParam(-1, "参数{}不能为空", "name")
    static Status
    ok()
    生成成功Status
    static Status
    ok(String msg)
    生成成功Status
    Status
    withMsg(String msg)
    替换消息
    Status
    withMsg(String msg, Object... args)
    替换消息信息

  • Method Details

    • getCode

      int getCode()
      获取状态码
      Returns:

    • getMsg

      String getMsg()
      获取错误消息
      Returns:

    • withMsg

      Status withMsg(@Nonnull String msg)
      替换消息
      Parameters:
      msg - 消息信息
      Returns:

    • withMsg

      Status withMsg(@Nonnull String msg, Object... args)
      替换消息信息
      Parameters:
      msg - 消息模板，'{}'为参数占位符，例如："user {} not found"
      args - 消息模板的参数
      Returns:

    • ok

      static Status ok()
      生成成功Status
      Returns:

    • ok

      static Status ok(@Nonnull String msg)
      生成成功Status
      Parameters:
      msg - 错误消息
      Returns:

    • fail

      static Status fail(@Nonnull String msg)
      生成失败Status，默认为 cn.dinodev.spring.commons.response.Status.CODE.ERROR
      Parameters:
      msg - 错误消息
      Returns:

    • fail

      static Status fail(@Nonnull String msg, Object... args)
      生成失败Status，默认为 cn.dinodev.spring.commons.response.Status.CODE.ERROR 如：fail("参数{}不能为空", "name")
      Parameters:
      msg - 错误消息，用MessageFormatter 进行格式化
      args - 消息格式化参数
      Returns:

    • fail

      static Status fail(int code, @Nonnull String msg)
      生成失败Status
      Parameters:
      code - 状态码
      msg - 错误消息
      Returns:

    • fail

      static Status fail(int code, @Nonnull String msg, Object... args)
      生成失败Status, 并对错误消息进行参数化，如：fail(-1, "参数{}不能为空", "name")
      Parameters:
      code - 状态码
      msg - 错误消息，用MessageFormatter 进行格式化
      args - 消息格式化参数
      Returns:

    • invalidParam

      static Status invalidParam(@Nonnull String msg)
      生成参数错误Status
      Parameters:
      msg - 错误消息
      Returns:

    • invalidParam

      static Status invalidParam(@Nonnull String msg, Object... args)
      生成失败Status, 并对错误消息进行参数化，如：invalidParam(-1, "参数{}不能为空", "name")
      Parameters:
      msg - 错误消息，用MessageFormatter 进行格式化
      args - 消息格式化参数
      Returns: