模块 linlang.api

程序包 api.linlang.audit.problem

类 LinProblem

java.lang.Object

api.linlang.audit.problem.LinProblem

public final class LinProblem
extends Object

由稳定代码、上下文和原始 Java 异常组成的问题记录。

问题记录不依赖语言文件。代码用于查询含义，上下文用于定位现场， cause 用于保存 Java 异常类型、堆栈和原因链。

嵌套类概要

嵌套类

修饰符和类型	类	说明
static final class	LinProblem.Builder	问题记录构建器。

方法概要

修饰符和类型	方法	说明
static LinProblem.Builder	builder(String code)	创建问题构建器。
Throwable	cause()	返回触发问题的原始 Java 异常。
String	code()	返回稳定的问题代码。
String	consoleSummary()	返回简短控制台摘要；不为空时控制台不附带问题堆栈。
Map<String,Object>	context()	返回用于定位现场的只读上下文。
static LinProblem	of(String code, Throwable cause, Object... context)	快速建立一条问题记录。
Instant	timestamp()	返回问题发生时间。

从类继承的方法 java.lang.Object

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

方法详细资料

builder

public static LinProblem.Builder builder(String code)

创建问题构建器。

参数:

code - 稳定的问题代码

返回:

构建器

of

public static LinProblem of(String code,
 Throwable cause,
 Object... context)

快速建立一条问题记录。

参数:

code - 稳定的问题代码

cause - 原始 Java 异常，可以为 null

context - 上下文字段，按照 key、value 顺序提供

返回:

问题记录

timestamp

public Instant timestamp()

返回问题发生时间。

返回:

问题发生时间

code

public String code()

返回稳定的问题代码。

返回:

已规范为大写的问题代码

context

public Map<String,Object> context()

返回用于定位现场的只读上下文。

返回:

上下文字段

cause

public Throwable cause()

返回触发问题的原始 Java 异常。

返回:

原始异常，可以为 null

consoleSummary

public String consoleSummary()

返回简短控制台摘要；不为空时控制台不附带问题堆栈。

返回:

摘要，未指定时为 null