クラス PatternsRequestCondition

java.lang.ObjectSE
org.springframework.web.servlet.mvc.condition.AbstractRequestCondition<PatternsRequestCondition>
org.springframework.web.servlet.mvc.condition.PatternsRequestCondition
実装されているすべてのインターフェース:
RequestCondition<PatternsRequestCondition>
@DeprecatedSE(since="7.0", forRemoval=true) public class PatternsRequestCondition extends AbstractRequestCondition<PatternsRequestCondition>
非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
PathMatcher および UrlPathHelper の使用は、Web モジュールでの実行時の使用では非推奨となり、代わりに PathPatternParser による解析パターンが推奨されます。
一連の URL パスパターンに対するリクエストと一致する論理和（'| |'）リクエスト条件。

解析された PathPattern を使用する PathPatternsRequestCondition とは対照的に、この条件は AntPathMatcher を介して文字列パターンマッチングを実行します。

導入:
3.1
作成者:
Rossen Stoyanchev

  • コンストラクターの概要

    コンストラクター
    コンストラクター
    説明
    PatternsRequestCondition(StringSE... patterns)
    非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
    必要に応じて "/" が前に付いた URL パターンを持つコンストラクター。
    PatternsRequestCondition(StringSE[] patterns, @Nullable UrlPathHelper urlPathHelper, @Nullable PathMatcher pathMatcher)
    非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
    必要に応じて "/" が前に付いた URL パターンを持つコンストラクター。

  • 方法の概要

    修飾子と型
    メソッド
    説明
    PatternsRequestCondition
    combine(PatternsRequestCondition other)
    非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
    次のように、現在のインスタンスと他のインスタンスのパターンを組み合わせます。1 つのインスタンスだけにパターンがある場合は、使用します。
    int
    compareTo(PatternsRequestCondition other, jakarta.servlet.http.HttpServletRequest request)
    非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
    含まれている URL パターンに基づいて 2 つの条件を比較します。
    protected CollectionSE<StringSE>
    getContent()
    非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
    リクエスト条件を構成する個別のアイテムを返します。
    SetSE<StringSE>
    getDirectPaths()
    非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
    パターンではないマッピングパスを返します。
    @Nullable PatternsRequestCondition
    getMatchingCondition(jakarta.servlet.http.HttpServletRequest request)
    非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
    パターンのいずれかが指定されたリクエストと一致するかどうかを確認し、PathMatcher.getPatternComparator(String) でソートされた、一致するパターンを含むことが保証されているインスタンスを返します。
    ListSE<StringSE>
    getMatchingPatterns(StringSE lookupPath)
    非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
    指定されたルックアップパスに一致するパターンを検索します。
    SetSE<StringSE>
    getPatterns()
    非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
    protected StringSE
    getToStringInfix()
    非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
    コンテンツの個別のアイテムを出力するときに使用する表記。
    boolean
    isEmptyPathMapping()
    非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
    条件が ""（空のパス）マッピングであるかどうか。

    クラス AbstractRequestCondition から継承されたメソッド

    equals, hashCode, isEmpty, toString

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

    clone, finalize, getClass, notify, notifyAll, wait, waitSE, waitSE

  • コンストラクターの詳細

    • PatternsRequestCondition

      public PatternsRequestCondition(StringSE... patterns)
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      必要に応じて "/" が前に付いた URL パターンを持つコンストラクター。
      パラメーター:
      patterns - 0 個以上の URL パターン。パターンがない場合、すべてのリクエストに一致する空のパス "" マッピングが生成されます。

    • PatternsRequestCondition

      public PatternsRequestCondition(StringSE[] patterns, @Nullable UrlPathHelper urlPathHelper, @Nullable PathMatcher pathMatcher)
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      必要に応じて "/" が前に付いた URL パターンを持つコンストラクター。
      パラメーター:
      patterns - 0 個以上の URL パターン。パターンがない場合、すべてのリクエストに一致する空のパス "" マッピングが生成されます。
      導入:
      7.0

  • メソッドの詳細

    • getPatterns

      public SetSE<StringSE> getPatterns()
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

    • getContent

      protected CollectionSE<StringSE> getContent()
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      クラスからコピーされた説明: AbstractRequestCondition
      リクエスト条件を構成する個別のアイテムを返します。

      たとえば、URL パターン、HTTP リクエストメソッド、パラメーター式など。

      次で指定:
      クラス AbstractRequestCondition<PatternsRequestCondition> の getContent 
      戻り値:
      オブジェクトのコレクション (非 null)

    • getToStringInfix

      protected StringSE getToStringInfix()
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      クラスからコピーされた説明: AbstractRequestCondition
      コンテンツの個別のアイテムを出力するときに使用する表記。

      たとえば、URL パターンの " || " または param 式の " && "。

      次で指定:
      クラス AbstractRequestCondition<PatternsRequestCondition> の getToStringInfix 

    • isEmptyPathMapping

      public boolean isEmptyPathMapping()
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      条件が ""（空のパス）マッピングであるかどうか。

    • getDirectPaths

      public SetSE<StringSE> getDirectPaths()
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      パターンではないマッピングパスを返します。
      導入:
      5.3

    • combine

      public PatternsRequestCondition combine(PatternsRequestCondition other)
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      次のように、現在のインスタンスと他のインスタンスのパターンを組み合わせます。
      • 1 つのインスタンスのみにパターンがある場合は、使用します。
      • 両方にパターンがある場合は、"this" インスタンスのパターンを PathMatcher.combine(String, String) を介して他のインスタンスのパターンと結合します。
      • どちらにもパターンがない場合は、"" と "/" をルートパスパターンとして使用します。
      パラメーター:
      other - 組み合わせる条件。
      戻り値:
      2 つの条件インスタンスを組み合わせた結果であるリクエスト条件インスタンス。

    • getMatchingCondition

      public @Nullable PatternsRequestCondition getMatchingCondition(jakarta.servlet.http.HttpServletRequest request)
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      パターンのいずれかが指定されたリクエストと一致するかどうかを確認し、PathMatcher.getPatternComparator(String) でソートされた、一致するパターンを含むことが保証されているインスタンスを返します。

      一致するパターンは、次の順序でチェックを行うことによって取得されます。

      • 直接一致
      • パターンにまだ "." が含まれていない場合は、".*" を追加したパターンマッチ。
      • パターンマッチ
      • パターンが "/" で終わっていない場合、"/" を追加したパターンマッチ
      パラメーター:
      request - 現在のリクエスト
      戻り値:
      条件にパターンが含まれていない場合も同じインスタンス。または、ソートされた一致パターンを持つ新しい条件。一致するパターンがない場合は null。

    • getMatchingPatterns

      public ListSE<StringSE> getMatchingPatterns(StringSE lookupPath)
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      指定された検索パスに一致するパターンを検索します。このメソッドを呼び出すと、getMatchingCondition(HttpServletRequest) を呼び出した場合と同等の結果が返されます。このメソッドは、リクエストが利用できない場合に使用する代替手段として提供されています (たとえば、イントロスペクション、ツールなど)。
      パラメーター:
      lookupPath - 既存のパターンに一致するルックアップパス
      戻り値:
      最上位に最も近い一致でソートされた一致するパターンのコレクション

    • compareTo

      public int compareTo(PatternsRequestCondition other, jakarta.servlet.http.HttpServletRequest request)
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      含まれている URL パターンに基づいて 2 つの条件を比較します。パターンは PathMatcher.getPatternComparator(String) を介して上から下に一度に 1 つずつ比較されます。比較されたすべてのパターンが同等に一致するが、1 つのインスタンスにさらに多くのパターンがある場合、より近い一致と見なされます。

      両方のインスタンスが getMatchingCondition(HttpServletRequest) を介して取得され、リクエストに一致するパターンのみが含まれ、最も一致するものが上にソートされることを前提としています。