ConvertingEncoderDecoderSupport (Spring Framework API)

java.lang.ObjectSE
- org.springframework.web.socket.adapter.standard.ConvertingEncoderDecoderSupport<T,M>

型パラメーター:
T - 変換される型（エンコーダーの場合）または (デコーダ用)
M - WebSocket メッセージ型 ( StringSE または ByteBufferSE )
既知の直属サブクラス
ConvertingEncoderDecoderSupport.BinaryDecoder, ConvertingEncoderDecoderSupport.BinaryEncoder, ConvertingEncoderDecoderSupport.TextDecoder, ConvertingEncoderDecoderSupport.TextEncoder
```
public abstract class ConvertingEncoderDecoderSupport<T,M>
extends ObjectSE
```
標準の EncoderEE や DecoderEE を実装するために使用できる基本クラス。Spring ConversionService に委譲するエンコードおよびデコードメソッドの実装を提供します。
デフォルトでは、このクラスは active ApplicationContext に 'webSocketConversionService' という名前で登録されている ConversionService を検索します。これは、サーブレットコンテナー環境のクライアントエンドポイントとサーバーエンドポイントの両方で正常に機能します。サーブレットコンテナーで実行されていない場合、サブクラスは getConversionService() メソッドをオーバーライドして、代替ルックアップ戦略を提供する必要があります。
サブクラスはこのクラスを継承でき、EncoderEE および DecoderEE の一方または両方を実装する必要もあります。便宜上、ConvertingEncoderDecoderSupport.BinaryEncoder、ConvertingEncoderDecoderSupport.BinaryDecoder、ConvertingEncoderDecoderSupport.TextEncoder および ConvertingEncoderDecoderSupport.TextDecoder サブクラスが提供されています。
JSR-356 ではエンコーダー / デコーダーの型による登録のみが許可されているため、このクラスのインスタンスは WebSocket ランタイムによって管理され、Spring Bean として登録する必要はありません。ただし、@Autowire を介して Spring で管理された依存関係を注入できます。
type と String または ByteBuffer の間で変換するコンバーターを登録する必要があります。
導入:
4.0
作成者:
Phillip Webb
関連事項:
ConvertingEncoderDecoderSupport.BinaryEncoder, ConvertingEncoderDecoderSupport.BinaryDecoder, ConvertingEncoderDecoderSupport.TextEncoder, ConvertingEncoderDecoderSupport.TextDecoder

ネストされたクラスのサマリー

ネストされたクラス
修飾子と型	クラスと説明
`static class`	`ConvertingEncoderDecoderSupport.BinaryDecoder<T>` Spring の変換サービスに委譲するバイナリ `javax.websocket.Encoder`EE。
`static class`	`ConvertingEncoderDecoderSupport.BinaryEncoder<T>` Spring の変換サービスに委譲するバイナリ `javax.websocket.Encoder`EE。
`static class`	`ConvertingEncoderDecoderSupport.TextDecoder<T>` Spring の変換サービスに委譲するテキスト `javax.websocket.Encoder`EE。
`static class`	`ConvertingEncoderDecoderSupport.TextEncoder<T>` Spring の変換サービスに委譲するテキスト `javax.websocket.Encoder`EE。

コンストラクターのサマリー
コンストラクター
コンストラクターと説明
ConvertingEncoderDecoderSupport()

コンストラクター
コンストラクターと説明
`ConvertingEncoderDecoderSupport()`

メソッドのサマリー

すべてのメソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`T`	`decode(M message)` メッセージをオブジェクトにデコードします。
`void`	`destroy()` エンコーダー / デコーダーを破棄するために呼び出されます。
`M`	`encode(T object)` オブジェクトをメッセージにエンコードします。
`protected ApplicationContext`	`getApplicationContext()` アクティブな `ApplicationContext` を返します。
`protected ConversionService`	`getConversionService()` `ConversionService` を取得するために使用される戦略方法。
`protected TypeDescriptor`	`getMessageType()` WebSocket メッセージ型を返します。
`protected TypeDescriptor`	`getType()` 変換される型を返します。
`void`	`init(EndpointConfigEE config)` エンコーダー / デコーダーを初期化するために呼び出されます。
`boolean`	`willDecode(M bytes)` 特定のメッセージをデコードできるかどうかを判断します。

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

- コンストラクターの詳細
  - ConvertingEncoderDecoderSupport
```
public ConvertingEncoderDecoderSupport()
```
- メソッドの詳細
  - init
```
public void init(EndpointConfigEE config)
```
    エンコーダー / デコーダーを初期化するために呼び出されます。
    関連事項:
    Encoder.init(EndpointConfig)EE, Decoder.init(EndpointConfig)EE
  - destroy
```
public void destroy()
```
    エンコーダー / デコーダーを破棄するために呼び出されます。
    関連事項:
    Encoder.destroy()EE, Decoder.destroy()EE
  - getConversionService
```
protected ConversionService getConversionService()
```
    ConversionService を取得するために使用される戦略メソッド。デフォルトでは、このメソッドは active ApplicationContext に 'webSocketConversionService' という Bean を想定しています。
    戻り値:
    ConversionService (非 null)
  - getApplicationContext
```
@Nullable
protected ApplicationContext getApplicationContext()
```
    アクティブな ApplicationContext を返します。デフォルトでは、このメソッドは ContextLoader.getCurrentWebApplicationContext() を介してコンテキストを取得します。これは、ContextLoader を介してロードされた ApplicationContext を、通常はサーブレットコンテナー環境で見つけます。サーブレットコンテナーで実行しておらず、ContextLoader を使用していない場合は、このメソッドをオーバーライドする必要があります。
    戻り値:
    ApplicationContext または null
  - getType
```
protected TypeDescriptor getType()
```
    変換される型を返します。デフォルトでは、型はクラスのジェネリクス引数を使用して解決されます。
  - getMessageType
```
protected TypeDescriptor getMessageType()
```
    WebSocket メッセージ型を返します。デフォルトでは、型はクラスのジェネリクス引数を使用して解決されます。
  - encode
```
@Nullable
public M encode(T object)
                   throws EncodeExceptionEE
```
    オブジェクトをメッセージにエンコードします。
    例外:
    EncodeExceptionEE
    関連事項:
    Encoder.Text.encode(Object)EE, Encoder.Binary.encode(Object)EE
  - willDecode
```
public boolean willDecode(M bytes)
```
    特定のメッセージをデコードできるかどうかを判断します。
    関連事項:
    decode(Object), Decoder.Text.willDecode(String)EE, Decoder.Binary.willDecode(ByteBuffer)EE
  - decode
```
@Nullable
public T decode(M message)
                   throws DecodeExceptionEE
```
    メッセージをオブジェクトにデコードします。
    例外:
    DecodeExceptionEE
    関連事項:
    Decoder.Text.decode(String)EE, Decoder.Binary.decode(ByteBuffer)EE

クラス ConvertingEncoderDecoderSupport<T,M>

ネストされたクラスのサマリー

コンストラクターのサマリー

メソッドのサマリー

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

コンストラクターの詳細

ConvertingEncoderDecoderSupport

メソッドの詳細

init

destroy

getConversionService

getApplicationContext

getType

getMessageType

encode

willDecode

decode