クラス ProblemDetail
properties
マップが含まれています。 拡張レスポンスの場合、アプリケーションは properties
マップに追加できます。Jackson ライブラリを使用する場合、properties
マップは ProblemDetailJacksonMixin
を介して最上位の JSON プロパティとして展開されます。
拡張レスポンスの場合、アプリケーションは追加のプロパティを持つサブクラスを作成することもできます。サブクラスは、保護されたコピーコンストラクターを使用して、既存の ProblemDetail
インスタンスをサブクラスとして再作成できます。ResponseEntityExceptionHandler
などの @ControllerAdvice
から。
- 導入:
- 6.0
- 作成者:
- Rossen Stoyanchev
- 関連事項:
コンストラクターのサマリー
コンストラクター修飾子コンストラクター説明protected
逆直列化のための引数なしのコンストラクター。protected
ProblemDetail
(int rawStatusCode) サブクラスの protected コンストラクター。protected
ProblemDetail
(ProblemDetail other) サブクラスが追加のプロパティでProblemDetail
を再作成および拡張するために使用できるコピーコンストラクター。メソッドのサマリー
修飾子と型メソッド説明static ProblemDetail
forStatus
(int status) 指定されたステータス値でProblemDetail
インスタンスを作成します。static ProblemDetail
forStatus
(HttpStatusCode status) 指定されたステータスコードでProblemDetail
インスタンスを作成します。static ProblemDetail
forStatusAndDetail
(HttpStatusCode status, StringSE detail) 指定されたステータスと詳細でProblemDetail
インスタンスを作成します。設定されたproblem detail
を返します。設定されたproblem instance
を返します。事前に知られていないプロパティの一般的なマップを返します。プロパティが追加されていない場合は、おそらくnull
です。int
コンストラクターに提供されるか、setStatus(int)
を介して構成された、問題に関連するステータスを返します。getTitle()
設定されたproblem title
を返します。getType()
設定されたproblem type
を返します。protected StringSE
ProblemDetail
フィールドの文字列表現を返します。void
problem detail
の Setter。void
setInstance
(URISE instance) problem instance
の Setter。void
setProperty
(StringSE name, ObjectSE value) ジェネリクスproperties map
に追加される「動的」プロパティを設定します。void
setStatus
(int status) problem status
の Setter。void
setStatus
(HttpStatus httpStatus) problem status
の Setter。void
problem title
の Setter。void
problem type
の Setter。toString()
コンストラクターの詳細
ProblemDetail
protected ProblemDetail(int rawStatusCode) サブクラスの protected コンストラクター。ProblemDetail
インスタンスを作成するには、静的ファクトリメソッドforStatus(HttpStatusCode)
またはforStatus(int)
を使用します。- パラメーター:
rawStatusCode
- 使用するレスポンスステータス
ProblemDetail
サブクラスが追加のプロパティでProblemDetail
を再作成および拡張するために使用できるコピーコンストラクター。ProblemDetail
protected ProblemDetail()逆直列化のための引数なしのコンストラクター。
メソッドの詳細
setType
problem type
の Setter。デフォルトでは、これは
BLANK_TYPE
です。- パラメーター:
type
- 問題の種類
setTitle
problem title
の Setter。デフォルトでは、明示的に設定されておらず、ステータスがよく知られている場合、これは
HttpStatus.getReasonPhrase()
から取得されます。- パラメーター:
title
- 問題のタイトル
setStatus
problem status
の Setter。- パラメーター:
httpStatus
- 問題の状態
setStatus
public void setStatus(int status) problem status
の Setter。- パラメーター:
status
- 問題の状態
setDetail
problem detail
の Setter。デフォルトでは、これは設定されていません。
- パラメーター:
detail
- 問題の詳細
setInstance
problem instance
の Setter。デフォルトでは、
ProblemDetail
が@ExceptionHandler
メソッドから返されると、これはリクエストパスに初期化されます。- パラメーター:
instance
- 問題のインスタンス
setProperty
ジェネリクスproperties map
に追加される「動的」プロパティを設定します。Jackson JSON がクラスパスに存在する場合、ここで設定されたすべてのプロパティは、出力 JSON で最上位のキーと値のペアとしてレンダリングされます。それ以外の場合は、
"properties"
サブマップとしてレンダリングされます。- パラメーター:
name
- プロパティ名value
- プロパティ値- 関連事項:
getType
設定されたproblem type
を返します。getTitle
設定されたproblem title
を返します。getStatus
public int getStatus()コンストラクターに提供されるか、setStatus(int)
を介して構成された、問題に関連するステータスを返します。getDetail
設定されたproblem detail
を返します。getInstance
設定されたproblem instance
を返します。getProperties
事前に知られていないプロパティの一般的なマップを返します。プロパティが追加されていない場合は、おそらくnull
です。プロパティを追加するには、setProperty(String, Object)
を使用します。Jackson JSON がクラスパスに存在する場合、このマップのコンテンツはアンラップされ、出力 JSON の最上位のキーと値のペアとしてレンダリングされます。それ以外の場合は、
"properties"
サブマップとしてレンダリングされます。toString
initToStringContent
ProblemDetail
フィールドの文字列表現を返します。サブクラスはこれをオーバーライドして、追加のフィールドを追加できます。forStatus
指定されたステータスコードでProblemDetail
インスタンスを作成します。forStatus
指定されたステータス値でProblemDetail
インスタンスを作成します。forStatusAndDetail
指定されたステータスと詳細でProblemDetail
インスタンスを作成します。