クラス HalFormsConfiguration
java.lang.ObjectSE
org.springframework.hateoas.mediatype.hal.forms.HalFormsConfiguration
HalConfiguration
の HAL-FORMS 固有の構成拡張。- 作成者:
- Greg Turnquist, Oliver Drotbohm
コンストラクターのサマリー
コンストラクター説明デフォルトのHalConfiguration
を基にした新しいHalFormsConfiguration
を作成します。HalFormsConfiguration
(HalConfiguration halConfiguration) 指定されたHalConfiguration
の新しいHalFormsConfiguration
を作成します。メソッドのサマリー
修飾子と型メソッド説明customize
(com.fasterxml.jackson.databind.ObjectMapper mapper) 登録されたコールバックで指定されたObjectMapper
をカスタマイズします。基本となるHalConfiguration
を返します。withMediaType
(MediaType mediaType) MediaTypes.HAL_FORMS_JSON
のエイリアスとなる追加のメディア型を登録します。withObjectMapperCustomizer
(ConsumerSE<com.fasterxml.jackson.databind.ObjectMapper> objectMapperCustomizer) 指定されたConsumer
SE を登録して、HAL ドキュメントのレンダリングに使用されるObjectMapper
に追加のカスタマイズを適用します。withOptions
(ClassSE<T> type, StringSE property, FunctionSE<AffordanceModel.PropertyMetadata, HalFormsOptions> creator) 指定された新しいHalFormsConfiguration
を返しますwithPattern
(ClassSE<?> type, StringSE pattern) 指定された型のフォームの説明に使用される正規表現パターンを登録します。
コンストラクターの詳細
HalFormsConfiguration
public HalFormsConfiguration()デフォルトのHalConfiguration
を基にした新しいHalFormsConfiguration
を作成します。HalFormsConfiguration
指定されたHalConfiguration
の新しいHalFormsConfiguration
を作成します。- パラメーター:
halConfiguration
- null であってはなりません。
メソッドの詳細
withPattern
指定された型のフォームの説明に使用される正規表現パターンを登録します。- パラメーター:
type
- null であってはなりません。pattern
- null または空であってはなりません。- 戻り値:
- null になることはありません。
withObjectMapperCustomizer
public HalFormsConfiguration withObjectMapperCustomizer(ConsumerSE<com.fasterxml.jackson.databind.ObjectMapper> objectMapperCustomizer) 指定されたConsumer
SE を登録して、HAL ドキュメントのレンダリングに使用されるObjectMapper
に追加のカスタマイズを適用します。- パラメーター:
objectMapperCustomizer
- null であってはなりません。- 戻り値:
- null になることはありません。
withMediaType
MediaTypes.HAL_FORMS_JSON
のエイリアスとなる追加のメディア型を登録します。登録されたMediaType
は、デフォルトのものよりも優先されます。つまり、クライアントの受け入れヘッダーなどで最初にリストされます。- パラメーター:
mediaType
- null であってはなりません。- 戻り値:
- null になることはありません。
- 導入:
- 1.4
customize
登録されたコールバックで指定されたObjectMapper
をカスタマイズします。- パラメーター:
mapper
- null であってはなりません。- 戻り値:
- 関連事項:
withOptions
public <T> HalFormsConfiguration withOptions(ClassSE<T> type, StringSE property, FunctionSE<AffordanceModel.PropertyMetadata, HalFormsOptions> creator) 指定された新しいHalFormsConfiguration
を返します- 型パラメーター:
T
-- パラメーター:
type
-property
-creator
-- 戻り値:
getHalConfiguration
基本となるHalConfiguration
を返します。- 戻り値:
- null になることはありません。