クラス MappingJackson2MessageConverter

メソッドの詳細

• setObjectMapper

  public void setObjectMapper(com.fasterxml.jackson.databind.ObjectMapper objectMapper)

  非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

  このコンバーターの ObjectMapper を設定します。

  設定されていない場合は、デフォルトの ObjectMapper が使用されます。

  カスタム構成の ObjectMapper を設定することは、JSON 直列化プロセスをさらに制御する方法の一つです。たとえば、特定の型に対してカスタムシリアライザーを提供する拡張 SerializerFactory を設定できます。直列化プロセスを洗練させるもう一つの方法は、直列化対象の型に Jackson が提供するアノテーションを使用することです。この場合、カスタム構成の ObjectMapper は不要です。

• getObjectMapper

  public com.fasterxml.jackson.databind.ObjectMapper getObjectMapper()

  非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

  このコンバーターの基になる ObjectMapper を返します。

• setPrettyPrint

  public void setPrettyPrint(boolean prettyPrint)

  非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

  JSON を書き込むときに DefaultPrettyPrinter を使用するかどうか。

  これは、次のように ObjectMapper をセットアップするためのショートカットです。

   ObjectMapper mapper = new ObjectMapper();
   mapper.configure(SerializationFeature.INDENT_OUTPUT, true);
   converter.setObjectMapper(mapper);
   

• canConvertFrom

  protected boolean canConvertFrom(Message<?> message, @Nullable ClassSE<?> targetClass)

  非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

  オーバーライド:

  クラス AbstractMessageConverter の canConvertFrom 

• canConvertTo

  protected boolean canConvertTo(ObjectSE payload, @Nullable MessageHeaders headers)

  非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

  オーバーライド:

  クラス AbstractMessageConverter の canConvertTo 

• logWarningIfNecessary

  protected void logWarningIfNecessary(TypeSE type, @Nullable ThrowableSE cause)

  非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

  ObjectMapper.canDeserialize(com.fasterxml.jackson.databind.JavaType) / ObjectMapper.canSerialize(java.lang.Class<?>) チェックから発生した特定の例外をログに記録するかどうかを決定します。

  パラメーター:

  type - Jackson が（非）直列化可能性についてテストしたクラス

  cause - 評価する Jackson 投げ例外 (通常は JsonMappingException)

  導入:

  4.3

• supports

  protected boolean supports(ClassSE<?> clazz)

  非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

  クラスからコピーされた説明: AbstractMessageConverter

  指定されたクラスがこのコンバーターでサポートされているかどうか。

  次で指定:

  クラス AbstractMessageConverter の supports 

  パラメーター:

  clazz - サポートをテストするクラス

  戻り値:

  サポートされている場合は true。それ以外の場合は false 

• convertFromInternal

  protected @Nullable ObjectSE convertFromInternal(Message<?> message, ClassSE<?> targetClass, @Nullable ObjectSE conversionHint)

  非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

  クラスからコピーされた説明: AbstractMessageConverter

  メッセージペイロードを直列化された形式からオブジェクトに変換します。

  オーバーライド:

  クラス AbstractMessageConverter の convertFromInternal 

  パラメーター:

  message - 入力メッセージ

  targetClass - 変換のターゲットクラス

  conversionHint - MessageConverter に渡される追加オブジェクト（たとえば、関連する MethodParameter） (null かもしれない)

  戻り値:

  変換の結果、またはコンバーターが変換を実行できない場合は null 

• convertToInternal

  protected @Nullable ObjectSE convertToInternal(ObjectSE payload, @Nullable MessageHeaders headers, @Nullable ObjectSE conversionHint)

  非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

  クラスからコピーされた説明: AbstractMessageConverter

  ペイロードオブジェクトを直列化された形式に変換します。

  オーバーライド:

  クラス AbstractMessageConverter の convertToInternal 

  パラメーター:

  payload - 変換するオブジェクト

  headers - メッセージのオプションのヘッダー (null の場合があります)

  conversionHint - MessageConverter に渡される追加オブジェクト（たとえば、関連する MethodParameter） (null かもしれない)

  戻り値:

  メッセージの結果のペイロード、またはコンバーターが変換を実行できない場合は null 

• getSerializationView

  protected @Nullable ClassSE<?> getSerializationView(@Nullable ObjectSE conversionHint)

  非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

  指定された変換ヒントに基づいて、Jackson 直列化ビューを決定します。

  パラメーター:

  conversionHint - 現在の変換の試行のためにコンバーターに渡される変換ヒントオブジェクト

  戻り値:

  直列化ビュークラス、または存在しない場合は null 

  導入:

  4.2

• getJsonEncoding

  protected com.fasterxml.jackson.core.JsonEncoding getJsonEncoding(@Nullable MimeType contentType)

  非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

  指定されたコンテンツ型に使用する JSON エンコーディングを決定します。

  パラメーター:

  contentType - MessageHeaders からの MIME 型（存在する場合）

  戻り値:

  使用する JSON エンコード (非 null)