クラス HalConfiguration
java.lang.ObjectSE
org.springframework.hateoas.mediatype.hal.HalConfiguration
HAL 固有の構成。
- 作成者:
- Greg Turnquist, Oliver Drotbohm
ネストされたクラスのサマリー
コンストラクターのサマリー
メソッドのサマリー
修飾子と型メソッド説明customize
(com.fasterxml.jackson.databind.ObjectMapper mapper) boolean
boolean
withApplyPropertyNamingStrategy
(boolean applyPropertyNamingStrategy) 属性をコピーし、applyProperNamingStrategy を置き換えて、新しいHalConfiguration
を作成します。withEnforceEmbeddedCollections
(boolean enforceEmbeddedCollections) 属性をコピーし、enforceEmbeddedCollections を置き換えて、新しいHalConfiguration
を作成します。withMediaType
(MediaType mediaType) MediaTypes.HAL_JSON
のエイリアスとなる追加のメディア型を登録します。withObjectMapperCustomizer
(ConsumerSE<com.fasterxml.jackson.databind.ObjectMapper> objectMapperCustomizer) すべての HAL 固有のセットアップで事前構成された後、インスタンスを微調整するようにObjectMapper
カスタマイザーを構成します。withRenderSingleLinks
(HalConfiguration.RenderSingleLinks renderSingleLinks) 属性をコピーし、renderSingleLinks を置き換えて、新しいHalConfiguration
を作成します。withRenderSingleLinksFor
(StringSE pattern, HalConfiguration.RenderSingleLinks renderSingleLinks) 指定されたリンク関係パターンの単一リンクをレンダリングする方法を構成します。つまり、これは固定リンク関係 (search
など) のいずれかであり、ワイルドカードを使用して、たとえば、特定のキュリー (acme:*
など) または完全な URI (https://api.acme.com/foo/**
など) のリンクに一致します。withRenderSingleLinksFor
(LinkRelation relation, HalConfiguration.RenderSingleLinks renderSingleLinks) 特定のLinkRelation
の単一リンクをレンダリングする方法を構成します。
コンストラクターの詳細
HalConfiguration
public HalConfiguration()直接のサブドキュメントとして単一リンクをレンダリングする新しいデフォルトHalConfiguration
を作成します。
メソッドの詳細
withRenderSingleLinksFor
public HalConfiguration withRenderSingleLinksFor(LinkRelation relation, HalConfiguration.RenderSingleLinks renderSingleLinks) 特定のLinkRelation
の単一リンクをレンダリングする方法を構成します。これは、その特定のリンク関係に対してwithRenderSingleLinks(RenderSingleLinks)
を介して構成されたものをオーバーライドします。- パラメーター:
relation
- null であってはなりません。renderSingleLinks
- null であってはなりません。- 戻り値:
withRenderSingleLinksFor
public HalConfiguration withRenderSingleLinksFor(StringSE pattern, HalConfiguration.RenderSingleLinks renderSingleLinks) 指定されたリンク関係パターンの単一リンクをレンダリングする方法を構成します。つまり、これは固定リンク関係 (search
など) のいずれかであり、ワイルドカードを使用して、たとえば、特定のキュリー (acme:*
など) または完全な URI (https://api.acme.com/foo/**
など) のリンクに一致します。- パラメーター:
pattern
- null または空であってはなりません。renderSingleLinks
- null であってはなりません。- 戻り値:
- 関連事項:
withRenderSingleLinks
属性をコピーし、renderSingleLinks を置き換えて、新しいHalConfiguration
を作成します。- パラメーター:
renderSingleLinks
- null であってはなりません。- 戻り値:
- null になることはありません。
withApplyPropertyNamingStrategy
属性をコピーし、applyProperNamingStrategy を置き換えて、新しいHalConfiguration
を作成します。- パラメーター:
applyPropertyNamingStrategy
-- 戻り値:
withEnforceEmbeddedCollections
属性をコピーし、enforceEmbeddedCollections を置き換えて、新しいHalConfiguration
を作成します。- パラメーター:
enforceEmbeddedCollections
-- 戻り値:
withObjectMapperCustomizer
public HalConfiguration withObjectMapperCustomizer(ConsumerSE<com.fasterxml.jackson.databind.ObjectMapper> objectMapperCustomizer) すべての HAL 固有のセットアップで事前構成された後、インスタンスを微調整するようにObjectMapper
カスタマイザーを構成します。- パラメーター:
objectMapperCustomizer
- null であってはなりません。- 戻り値:
- null になることはありません。
withMediaType
MediaTypes.HAL_JSON
のエイリアスとなる追加のメディア型を登録します。登録されたMediaType
は、デフォルトのものよりも優先されます。つまり、クライアントの受け入れヘッダーなどで最初にリストされます。- パラメーター:
mediaType
- null であってはなりません。- 戻り値:
- null になることはありません。
- 導入:
- 1.3
getRenderSingleLinks
isApplyPropertyNamingStrategy
public boolean isApplyPropertyNamingStrategy()isEnforceEmbeddedCollections
public boolean isEnforceEmbeddedCollections()customize