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