クラス HalFormsConfiguration

java.lang.ObjectSE
org.springframework.hateoas.mediatype.hal.forms.HalFormsConfiguration

public class HalFormsConfiguration extends ObjectSE
HalConfiguration の HAL-FORMS 固有の構成拡張。
作成者:
Greg Turnquist, Oliver Drotbohm
  • コンストラクターの詳細

  • メソッドの詳細

    • withPattern

      public HalFormsConfiguration withPattern(ClassSE<?> type, StringSE pattern)
      指定された型のフォームの説明に使用される正規表現パターンを登録します。
      パラメーター:
      type - null であってはなりません。
      pattern - null または空であってはなりません。
      戻り値:
      null になることはありません。
    • withObjectMapperCustomizer

      public HalFormsConfiguration withObjectMapperCustomizer(ConsumerSE<com.fasterxml.jackson.databind.ObjectMapper> objectMapperCustomizer)
      指定された ConsumerSE を登録して、HAL ドキュメントのレンダリングに使用される ObjectMapper に追加のカスタマイズを適用します。
      パラメーター:
      objectMapperCustomizer - null であってはなりません。
      戻り値:
      null になることはありません。
    • withMediaType

      public HalFormsConfiguration withMediaType(MediaType mediaType)
      MediaTypes.HAL_FORMS_JSON のエイリアスとなる追加のメディア型を登録します。登録された MediaType は、デフォルトのものよりも優先されます。つまり、クライアントの受け入れヘッダーなどで最初にリストされます。
      パラメーター:
      mediaType - null であってはなりません。
      戻り値:
      null になることはありません。
      導入:
      1.4
    • customize

      public HalFormsConfiguration customize(com.fasterxml.jackson.databind.ObjectMapper mapper)
      登録されたコールバックで指定された ObjectMapper をカスタマイズします。
      パラメーター:
      mapper - null であってはなりません。
      戻り値:
      関連事項:
    • withOptions

      public <T> HalFormsConfiguration withOptions(ClassSE<T> type, StringSE property, FunctionSE<AffordanceModel.PropertyMetadata,HalFormsOptions> creator)
      指定された新しい HalFormsConfiguration を返します
      型パラメーター:
      T -
      パラメーター:
      type -
      property -
      creator -
      戻り値:
    • getHalConfiguration

      public HalConfiguration getHalConfiguration()
      基本となる HalConfiguration を返します。
      戻り値:
      null になることはありません。