AbstractMessageConverter (Spring Framework 5.2.8.RELEASE API)

java.lang.ObjectSE
- org.springframework.messaging.converter.AbstractMessageConverter

実装されているすべてのインターフェース:
MessageConverter, SmartMessageConverter
既知の直属サブクラス
ByteArrayMessageConverter, MappingJackson2MessageConverter, MarshallingMessageConverter, ProtobufMessageConverter, StringMessageConverter
```
public abstract class AbstractMessageConverter
extends ObjectSE
implements SmartMessageConverter
```
主にコンバーターがペイロードクラスと MIME 型に基づいた変換をサポートするかどうかを確認するための、共通プロパティのサポートと変換メソッドの部分的な実装を含む SmartMessageConverter 実装の抽象基本クラス。
導入:
4.0
作成者:
Rossen Stoyanchev, Sebastien Deleuze, Juergen Hoeller

フィールドのサマリー
フィールド
修飾子と型フィールドと説明
protected Log logger

フィールド
修飾子と型	フィールドと説明
`protected Log`	`logger`

コンストラクターの概要

コンストラクター
修飾子	コンストラクターと説明
`protected`	`AbstractMessageConverter(CollectionSE<MimeType> supportedMimeTypes)` MIME 型のコレクションを持つコンストラクター。
`protected`	`AbstractMessageConverter(MimeType... supportedMimeTypes)` vararg を介した 1 つ以上の MIME 型を持つコンストラクター。
`protected`	`AbstractMessageConverter(MimeType supportedMimeType)` 単一の MIME 型を持つコンストラクター。

メソッドのサマリー

すべてのメソッドインスタンスメソッド抽象メソッド具象メソッド
修飾子と型	メソッドと説明
`protected void`	`addSupportedMimeTypes(MimeType... supportedMimeTypes)` サブクラスがサポートされる MIME 型をさらに追加できるようにします。
`protected boolean`	`canConvertFrom(Message<?> message, ClassSE<?> targetClass)`
`protected boolean`	`canConvertTo(ObjectSE payload, MessageHeaders headers)`
`protected ObjectSE`	`convertFromInternal(Message<?> message, ClassSE<?> targetClass, ObjectSE conversionHint)` メッセージペイロードを直列化された形式からオブジェクトに変換します。
`protected ObjectSE`	`convertToInternal(ObjectSE payload, MessageHeaders headers, ObjectSE conversionHint)` ペイロードオブジェクトを直列化された形式に変換します。
`ObjectSE`	`fromMessage(Message<?> message, ClassSE<?> targetClass)` `Message` のペイロードを、直列化された形式から、指定されたターゲットクラスの型付きオブジェクトに変換します。
`ObjectSE`	`fromMessage(Message<?> message, ClassSE<?> targetClass, ObjectSE conversionHint)` 引数として追加の変換コンテキストをとる `MessageConverter.fromMessage(Message, Class)` のバリアント。
`ContentTypeResolver`	`getContentTypeResolver()` 設定された `ContentTypeResolver` を返します。
`protected MimeType`	`getDefaultContentType(ObjectSE payload)` ペイロードのデフォルトのコンテンツ型を返します。
`protected MimeType`	`getMimeType(MessageHeaders headers)`
`ClassSE<?>`	`getSerializedPayloadClass()` 設定された優先シリアライゼーションペイロードクラスを返します。
`ListSE<MimeType>`	`getSupportedMimeTypes()` サポートされている MIME 型を返します。
`boolean`	`isStrictContentTypeMatch()` コンテンツ型の解決で、サポートされている MIME 型のいずれかに一致する値を生成する必要があるかどうか。
`void`	`setContentTypeResolver(ContentTypeResolver resolver)` 入力メッセージのコンテンツ型を解決するために使用する `ContentTypeResolver` を構成します。
`void`	`setSerializedPayloadClass(ClassSE<?> payloadClass)` オブジェクトペイロードを `Message` に変換するときに使用する優先直列化クラス（byte[] または String）を構成します。
`void`	`setStrictContentTypeMatch(boolean strictContentTypeMatch)` このコンバーターが、構成された `ContentTypeResolver` を通じてコンテンツ型を解決できないメッセージを変換するかどうか。
`protected abstract boolean`	`supports(ClassSE<?> clazz)` 指定されたクラスがこのコンバーターでサポートされているかどうか。
`protected boolean`	`supportsMimeType(MessageHeaders headers)`
`Message<?>`	`toMessage(ObjectSE payload, MessageHeaders headers)` ペイロードが特定のペイロードオブジェクトを直列化された形式に変換した結果である `Message` を作成します。
`Message<?>`	`toMessage(ObjectSE payload, MessageHeaders headers, ObjectSE conversionHint)` 引数として追加の変換コンテキストをとる `MessageConverter.toMessage(Object, MessageHeaders)` のバリアント。

クラス java.lang.ObjectSE から継承されたメソッド
cloneSE, equalsSE, finalizeSE, getClassSE, hashCodeSE, notifySE, notifyAllSE, toStringSE, waitSE, waitSE, waitSE

- フィールドの詳細
  - logger
```
protected final Log logger
```
- コンストラクターの詳細
  - AbstractMessageConverter
```
protected AbstractMessageConverter(MimeType supportedMimeType)
```
    単一の MIME 型を持つコンストラクター。
    パラメーター:
    supportedMimeType - サポートされている MIME 型
  - AbstractMessageConverter
```
protected AbstractMessageConverter(MimeType... supportedMimeTypes)
```
    vararg を介した 1 つ以上の MIME 型を持つコンストラクター。
    パラメーター:
    supportedMimeTypes - サポートされている MIME 型
    導入:
    5.2.2
  - AbstractMessageConverter
```
protected AbstractMessageConverter(CollectionSE<MimeType> supportedMimeTypes)
```
    MIME 型のコレクションを持つコンストラクター。
    パラメーター:
    supportedMimeTypes - サポートされている MIME 型
- メソッドの詳細
  - getSupportedMimeTypes
```
public ListSE<MimeType> getSupportedMimeTypes()
```
    サポートされている MIME 型を返します。
  - addSupportedMimeTypes
```
protected void addSupportedMimeTypes(MimeType... supportedMimeTypes)
```
    サブクラスがサポートされる MIME 型をさらに追加できるようにします。
    導入:
    5.2.2
  - setContentTypeResolver
```
public void setContentTypeResolver(@Nullable
                                   ContentTypeResolver resolver)
```
    入力メッセージのコンテンツ型を解決するために使用する ContentTypeResolver を構成します。
    リゾルバーが構成されていない場合、strictContentTypeMatch は false （デフォルト）のままにする必要があります。そうしないと、このコンバーターはすべてのメッセージを無視します。
    デフォルトでは、DefaultContentTypeResolver インスタンスが使用されます。
  - getContentTypeResolver
```
@Nullable
public ContentTypeResolver getContentTypeResolver()
```
    設定された ContentTypeResolver を返します。
  - setStrictContentTypeMatch
```
public void setStrictContentTypeMatch(boolean strictContentTypeMatch)
```
    このコンバーターが、構成された ContentTypeResolver を通じてコンテンツ型を解決できないメッセージを変換するかどうか。
    contentTypeResolver が構成されていて、supportedMimeTypes のリストが空でない場合にのみ、コンバーターを厳密に構成できます。
    このフラグが true に設定されている場合、contentTypeResolver が定義されていない場合、content-type ヘッダーが存在しない場合、supportsMimeType(MessageHeaders) は false を返します。
  - isStrictContentTypeMatch
```
public boolean isStrictContentTypeMatch()
```
    コンテンツ型の解決で、サポートされている MIME 型のいずれかに一致する値を生成する必要があるかどうか。
  - setSerializedPayloadClass
```
public void setSerializedPayloadClass(ClassSE<?> payloadClass)
```
    オブジェクトペイロードを Message に変換するときに使用する優先直列化クラス（byte[] または String）を構成します。
    デフォルト値は byte[] です。
    パラメーター:
    payloadClass - byte[] または String のいずれか
  - getSerializedPayloadClass
```
public ClassSE<?> getSerializedPayloadClass()
```
    設定された優先シリアライゼーションペイロードクラスを返します。
  - getDefaultContentType
```
@Nullable
protected MimeType getDefaultContentType(ObjectSE payload)
```
    ペイロードのデフォルトのコンテンツ型を返します。メッセージヘッダーなしで、またはコンテンツ型ヘッダーなしで toMessage(Object, MessageHeaders) が呼び出されたときに呼び出されます。
    デフォルトでは、これは supportedMimeTypes の最初の要素があればそれを返します。サブクラスでオーバーライドできます。
    パラメーター:
    payload - メッセージに変換されるペイロード
    戻り値:
    コンテンツ型、または不明の場合は null
  - fromMessage
```
@Nullable
public final ObjectSE fromMessage(Message<?> message,
                                          ClassSE<?> targetClass)
```
    インターフェースからコピーされた説明: MessageConverter
    Message のペイロードを、直列化された形式から、指定されたターゲットクラスの型指定されたオブジェクトに変換します。MessageHeaders.CONTENT_TYPE ヘッダーは、変換元の MIME 型を示す必要があります。
    コンバーターが指定されたメディア型をサポートしていないか、変換を実行できない場合は、null を返します。
    次で指定:
    インターフェース MessageConverter の fromMessage
    パラメーター:
    message - 入力メッセージ
    targetClass - 変換のターゲットクラス
    戻り値:
    変換の結果、またはコンバーターが変換を実行できない場合は null
  - fromMessage
```
@Nullable
public final ObjectSE fromMessage(Message<?> message,
                                          ClassSE<?> targetClass,
                                          @Nullable
                                          ObjectSE conversionHint)
```
    インターフェースからコピーされた説明: SmartMessageConverter
    引数として追加の変換コンテキストをとる MessageConverter.fromMessage(Message, Class) のバリアント。ペイロードパラメーターのアノテーションを考慮します。
    次で指定:
    インターフェース SmartMessageConverter の fromMessage
    パラメーター:
    message - 入力メッセージ
    targetClass - 変換のターゲットクラス
    conversionHint - MessageConverter に渡される追加のオブジェクト。関連する MethodParameter （null の場合があります。}
    戻り値:
    変換の結果、またはコンバーターが変換を実行できない場合は null
    関連事項:
    MessageConverter.fromMessage(Message, Class)
  - canConvertFrom
```
protected boolean canConvertFrom(Message<?> message,
                                 ClassSE<?> targetClass)
```
  - toMessage
```
@Nullable
public final Message<?> toMessage(ObjectSE payload,
                                            @Nullable
                                            MessageHeaders headers)
```
    インターフェースからコピーされた説明: MessageConverter
    ペイロードが指定されたペイロードオブジェクトを直列化された形式に変換した結果である Message を作成します。オプションの MessageHeaders パラメーターには、変換のターゲットメディア型を指定する MessageHeaders.CONTENT_TYPE ヘッダーを含めることができ、メッセージに追加する追加のヘッダーを含めることができます。
    コンバーターが指定されたメディア型をサポートしていないか、変換を実行できない場合は、null を返します。
    次で指定:
    インターフェース MessageConverter の toMessage
    パラメーター:
    payload - 変換するオブジェクト
    headers - メッセージのオプションのヘッダー (null の場合があります)
    戻り値:
    新しいメッセージ、またはコンバーターがオブジェクト型またはターゲットメディア型をサポートしていない場合は null
  - toMessage
```
@Nullable
public final Message<?> toMessage(ObjectSE payload,
                                            @Nullable
                                            MessageHeaders headers,
                                            @Nullable
                                            ObjectSE conversionHint)
```
    インターフェースからコピーされた説明: SmartMessageConverter
    引数として追加の変換コンテキストを使用する MessageConverter.toMessage(Object, MessageHeaders) のバリアント。たとえば、戻り値型のアノテーションが考慮されます。
    次で指定:
    インターフェース SmartMessageConverter の toMessage
    パラメーター:
    payload - 変換するオブジェクト
    headers - メッセージのオプションのヘッダー (null の場合があります)
    conversionHint - MessageConverter に渡される追加のオブジェクト。関連する MethodParameter （null の場合があります。}
    戻り値:
    新しいメッセージ、またはコンバーターがオブジェクト型またはターゲットメディア型をサポートしていない場合は null
    関連事項:
    MessageConverter.toMessage(Object, MessageHeaders)
  - canConvertTo
```
protected boolean canConvertTo(ObjectSE payload,
                               @Nullable
                               MessageHeaders headers)
```
  - supportsMimeType
```
protected boolean supportsMimeType(@Nullable
                                   MessageHeaders headers)
```
  - getMimeType
```
@Nullable
protected MimeType getMimeType(@Nullable
                                         MessageHeaders headers)
```
  - supports
```
protected abstract boolean supports(ClassSE<?> clazz)
```
    指定されたクラスがこのコンバーターでサポートされているかどうか。
    パラメーター:
    clazz - サポートをテストするクラス
    戻り値:
    サポートされている場合は true。それ以外の場合は false
  - convertFromInternal
```
@Nullable
protected ObjectSE convertFromInternal(Message<?> message,
                                               ClassSE<?> targetClass,
                                               @Nullable
                                               ObjectSE conversionHint)
```
    メッセージペイロードを直列化された形式からオブジェクトに変換します。
    パラメーター:
    message - 入力メッセージ
    targetClass - 変換のターゲットクラス
    conversionHint - MessageConverter に渡される追加のオブジェクト。関連する MethodParameter （null の場合があります。}
    戻り値:
    変換の結果、またはコンバーターが変換を実行できない場合は null
    導入:
    4.2
  - convertToInternal
```
@Nullable
protected ObjectSE convertToInternal(ObjectSE payload,
                                             @Nullable
                                             MessageHeaders headers,
                                             @Nullable
                                             ObjectSE conversionHint)
```
    ペイロードオブジェクトを直列化された形式に変換します。
    パラメーター:
    payload - 変換するオブジェクト
    headers - メッセージのオプションのヘッダー (null の場合があります)
    conversionHint - MessageConverter に渡される追加のオブジェクト。関連する MethodParameter （null の場合があります。}
    戻り値:
    メッセージの結果のペイロード、またはコンバーターが変換を実行できない場合は null
    導入:
    4.2

クラス AbstractMessageConverter

フィールドのサマリー

コンストラクターの概要

メソッドのサマリー

クラス java.lang.ObjectSE から継承されたメソッド

フィールドの詳細

logger

コンストラクターの詳細

AbstractMessageConverter

AbstractMessageConverter

AbstractMessageConverter

メソッドの詳細

getSupportedMimeTypes

addSupportedMimeTypes

setContentTypeResolver

getContentTypeResolver

setStrictContentTypeMatch

isStrictContentTypeMatch

setSerializedPayloadClass

getSerializedPayloadClass

getDefaultContentType

fromMessage

fromMessage

canConvertFrom

toMessage

toMessage

canConvertTo

supportsMimeType

getMimeType

supports

convertFromInternal

convertToInternal