インターフェース ConversionService

すべての既知のサブインターフェース:
ConfigurableConversionService
すべての既知の実装クラス:
DefaultConversionServiceDefaultFormattingConversionServiceFormattingConversionServiceGenericConversionService

public interface ConversionService
型変換のためのサービスインターフェース。これは、変換システムへのエントリポイントです。convert(Object, Class) を呼び出して、このシステムを使用してスレッドセーフな型変換を実行します。
導入:
3.0
作成者:
Keith Donald, Phillip Webb
  • メソッドのサマリー

    修飾子と型
    メソッド
    説明
    boolean
    canConvert(ClassSE<?> sourceType, ClassSE<?> targetType)
    sourceType のオブジェクトを targetType に変換できる場合は、true を返します。
    boolean
    canConvert(TypeDescriptor sourceType, TypeDescriptor targetType)
    sourceType のオブジェクトを targetType に変換できる場合は、true を返します。
    <T> T
    convert(ObjectSE source, ClassSE<T> targetType)
    指定された source を指定された targetType に変換します。
    default ObjectSE
    convert(ObjectSE source, TypeDescriptor targetType)
    指定された source を指定された targetType に変換します。
    convert(ObjectSE source, TypeDescriptor sourceType, TypeDescriptor targetType)
    指定された source を指定された targetType に変換します。
  • メソッドの詳細

    • canConvert

      boolean canConvert(@Nullable ClassSE<?> sourceType, ClassSE<?> targetType)
      sourceType のオブジェクトを targetType に変換できる場合は、true を返します。

      このメソッドが true を返す場合、convert(Object, Class) が sourceType のインスタンスを targetType に変換できることを意味します。

      コレクション、配列、マップ型に関する特記事項: コレクション、配列、マップ型間の変換では、基礎となる要素が変換可能でない場合に変換呼び出しが ConversionException を生成する場合でも、このメソッドは true を返します。呼び出し元は、コレクションとマップを操作するときにこの例外的なケースを処理することが期待されています。

      パラメーター:
      sourceType - 変換元のソース型 (ソースが null の場合、null になる場合があります)
      targetType - 変換するターゲット型 (必須)
      戻り値:
      変換を実行できる場合は true、そうでない場合は false 
      例外:
      IllegalArgumentExceptionSE - targetType が null の場合
    • canConvert

      boolean canConvert(@Nullable TypeDescriptor sourceType, TypeDescriptor targetType)
      sourceType のオブジェクトを targetType に変換できる場合は、true を返します。TypeDescriptors は、変換が発生するソースとターゲットの場所(多くの場合、オブジェクトフィールドまたはプロパティの場所)に関する追加のコンテキストを提供します。

      このメソッドが true を返す場合、convert(Object, TypeDescriptor, TypeDescriptor) が sourceType のインスタンスを targetType に変換できることを意味します。

      コレクション、配列、マップ型に関する特記事項: コレクション、配列、マップ型間の変換では、基礎となる要素が変換可能でない場合に変換呼び出しが ConversionException を生成する場合でも、このメソッドは true を返します。呼び出し元は、コレクションとマップを操作するときにこの例外的なケースを処理することが期待されています。

      パラメーター:
      sourceType - 変換元のソース型に関するコンテキスト (ソースが null の場合、null になる場合があります)
      targetType - 変換するターゲット型に関するコンテキスト (必須)
      戻り値:
      ソース型とターゲット型の間で変換を実行できる場合は true、そうでない場合は false 
      例外:
      IllegalArgumentExceptionSE - targetType が null の場合
    • convert

      @Nullable <T> T convert(@Nullable ObjectSE source, ClassSE<T> targetType)
      指定された source を指定された targetType に変換します。
      パラメーター:
      source - 変換するソースオブジェクト (null の場合があります)
      targetType - 変換するターゲット型 (必須)
      戻り値:
      変換されたオブジェクト、targetType のインスタンス
      例外:
      ConversionException - 変換例外が発生した場合
      IllegalArgumentExceptionSE - targetType が null の場合
    • convert

      @Nullable default ObjectSE convert(@Nullable ObjectSE source, TypeDescriptor targetType)
      指定された source を指定された targetType に変換します。

      convert(Object, TypeDescriptor, TypeDescriptor) に委譲し、TypeDescriptor.forObject(Object) を使用してソース型記述子の構築をカプセル化します。

      パラメーター:
      source - ソースオブジェクト
      targetType - ターゲット型
      戻り値:
      変換された値
      例外:
      ConversionException - 変換例外が発生した場合
      IllegalArgumentExceptionSE - targetType が null の場合
      導入:
      6.1
    • convert

      @Nullable ObjectSE convert(@Nullable ObjectSE source, @Nullable TypeDescriptor sourceType, TypeDescriptor targetType)
      指定された source を指定された targetType に変換します。TypeDescriptors は、変換が発生するソースおよびターゲットの場所(多くの場合、オブジェクトフィールドまたはプロパティの場所)に関する追加のコンテキストを提供します。
      パラメーター:
      source - 変換するソースオブジェクト (null の場合があります)
      sourceType - 変換元のソース型に関するコンテキスト (ソースが null の場合、null になる場合があります)
      targetType - 変換するターゲット型に関するコンテキスト (必須)
      戻り値:
      変換されたオブジェクト、targetType のインスタンス
      例外:
      ConversionException - 変換例外が発生した場合
      IllegalArgumentExceptionSE - targetType が null、または sourceType が null であるが、ソースが null でない場合