Spring Framework 6.1.4 · org.springframework.messaging.handler.DestinationPatternsMessageCondition

Modifier and Type	Field and Description
public static final String	LOOKUP_DESTINATION_HEADER The name of the "lookup destination" header.
private final Set<String>	patterns
private final RouteMatcher	routeMatcher

Constructor Summary

Access	Constructor and Description
public	DestinationPatternsMessageCondition(String... the URL patterns to match to, or if 0 then always match patterns) Constructor with patterns only.
public	DestinationPatternsMessageCondition(String[] the URL patterns to match to, or if 0 then always match patterns, PathMatcher the `PathMatcher` to use matcher) Constructor with patterns and a `PathMatcher` instance.
public	DestinationPatternsMessageCondition(String[] the URL patterns to match to, or if 0 then always match patterns, RouteMatcher the `RouteMatcher` to use routeMatcher) Constructor with patterns and a `RouteMatcher` instance.
private	DestinationPatternsMessageCondition(Set<String> patterns, RouteMatcher routeMatcher)

Method Summary

Modifier and Type	Method and Description
public DestinationPatternsMessageCondition	combine(DestinationPatternsMessageCondition the condition to combine with other) Implements org.springframework.messaging.handler.MessageCondition.combine. Returns a new instance with URL patterns from the current instance ("this") and the "other" instance as follows: If there are patterns in both instances, combine the patterns in "this" with the patterns in "other" using `org.springframework.util.PathMatcher#combine(String, String)`. If only one instance has patterns, use them. If neither instance has patterns, use an empty String (i.e. "").
public int	compareTo(DestinationPatternsMessageCondition other, Message<?> message) Implements org.springframework.messaging.handler.MessageCondition.compareTo. Compare the two conditions based on the destination patterns they contain.
protected Collection<String>	getContent() Implements abstract org.springframework.messaging.handler.AbstractMessageCondition.getContent. Return the collection of objects the message condition is composed of (e.g. destination patterns), never `null`.
public DestinationPatternsMessageCondition	Returns: the same instance if the condition contains no patterns; or a new condition with sorted matching patterns; or `null` either if a destination can not be extracted or there is no match getMatchingCondition(Message<?> the message to match to message) Implements org.springframework.messaging.handler.MessageCondition.getMatchingCondition. Check if any of the patterns match the given Message destination and return an instance that is guaranteed to contain matching patterns, sorted via `org.springframework.util.PathMatcher#getPatternComparator(String)`.
private Comparator<String>	getPatternComparator(Object destination)
public Set<String>	getPatterns()
protected String	getToStringInfix() Implements abstract org.springframework.messaging.handler.AbstractMessageCondition.getToStringInfix. The notation to use when printing discrete items of content.
private boolean	matchPattern(String pattern, Object destination)
private static Set<String>	prependLeadingSlash(String[] patterns, RouteMatcher routeMatcher)

Inherited from org.springframework.messaging.handler.AbstractMessageCondition:: equals hashCode toString

Field Detail

LOOKUP_DESTINATION_HEADER	back to summary
public static final String LOOKUP_DESTINATION_HEADER The name of the "lookup destination" header.

patterns	back to summary
private final Set<String> patterns

routeMatcher	back to summary
private final RouteMatcher routeMatcher

Constructor Detail

DestinationPatternsMessageCondition back to summary

DestinationPatternsMessageCondition	back to summary
public DestinationPatternsMessageCondition(String... patterns) Constructor with patterns only. Creates and uses an instance of `AntPathMatcher` with default settings. Non-empty patterns that don't start with "/" are prepended with "/". Parameters patterns:String[] the URL patterns to match to, or if 0 then always match

public DestinationPatternsMessageCondition(String... patterns)

Constructor with patterns only. Creates and uses an instance of AntPathMatcher with default settings.

Non-empty patterns that don't start with "/" are prepended with "/".

Parameters

patterns:String[]: the URL patterns to match to, or if 0 then always match

DestinationPatternsMessageCondition back to summary

DestinationPatternsMessageCondition	back to summary
public DestinationPatternsMessageCondition(String[] patterns, PathMatcher matcher) Constructor with patterns and a `PathMatcher` instance. Parameters patterns:String[] the URL patterns to match to, or if 0 then always match matcher:PathMatcher the `PathMatcher` to use

public DestinationPatternsMessageCondition(String[] patterns, PathMatcher matcher)

Constructor with patterns and a PathMatcher instance.

Parameters

patterns:String[]: the URL patterns to match to, or if 0 then always match
matcher:PathMatcher: the PathMatcher to use

DestinationPatternsMessageCondition back to summary

DestinationPatternsMessageCondition	back to summary
public DestinationPatternsMessageCondition(String[] patterns, RouteMatcher routeMatcher) Constructor with patterns and a `RouteMatcher` instance. Parameters patterns:String[] the URL patterns to match to, or if 0 then always match routeMatcher:RouteMatcher the `RouteMatcher` to use Since 5.2

public DestinationPatternsMessageCondition(String[] patterns, RouteMatcher routeMatcher)

Constructor with patterns and a RouteMatcher instance.

Parameters

patterns:String[]: the URL patterns to match to, or if 0 then always match
routeMatcher:RouteMatcher: the RouteMatcher to use

Since

5.2

DestinationPatternsMessageCondition	back to summary
private DestinationPatternsMessageCondition(Set<String> patterns, RouteMatcher routeMatcher)

Method Detail

combine back to summary

combine	back to summary
public DestinationPatternsMessageCondition combine(DestinationPatternsMessageCondition other) Implements org.springframework.messaging.handler.MessageCondition.combine. Returns a new instance with URL patterns from the current instance ("this") and the "other" instance as follows: If there are patterns in both instances, combine the patterns in "this" with the patterns in "other" using `org.springframework.util.PathMatcher#combine(String, String)`. If only one instance has patterns, use them. If neither instance has patterns, use an empty String (i.e. ""). Parameters other:DestinationPatternsMessageCondition Doc from org.springframework.messaging.handler.MessageCondition.combine. the condition to combine with Returns:DestinationPatternsMessageCondition Doc from org.springframework.messaging.handler.MessageCondition.combine. the resulting message condition Annotations @Override

public DestinationPatternsMessageCondition combine(DestinationPatternsMessageCondition other)

Implements org.springframework.messaging.handler.MessageCondition.combine.

Returns a new instance with URL patterns from the current instance ("this") and the "other" instance as follows:

If there are patterns in both instances, combine the patterns in "this" with the patterns in "other" using org.springframework.util.PathMatcher#combine(String, String).
If only one instance has patterns, use them.
If neither instance has patterns, use an empty String (i.e. "").

Parameters

other:DestinationPatternsMessageCondition

Doc from org.springframework.messaging.handler.MessageCondition.combine.

the condition to combine with

Returns:DestinationPatternsMessageCondition

Doc from org.springframework.messaging.handler.MessageCondition.combine.

the resulting message condition

Annotations

@Override

compareTo back to summary

compareTo	back to summary
public int compareTo(DestinationPatternsMessageCondition other, Message<?> message) Implements org.springframework.messaging.handler.MessageCondition.compareTo. Compare the two conditions based on the destination patterns they contain. Patterns are compared one at a time, from top to bottom via `org.springframework.util.PathMatcher#getPatternComparator(String)`. If all compared patterns match equally, but one instance has more patterns, it is considered a closer match. It is assumed that both instances have been obtained via `getMatchingCondition(Message)` to ensure they contain only patterns that match the request and are sorted with the best matches on top. Annotations @Override

public int compareTo(DestinationPatternsMessageCondition other, Message<?> message)

Implements org.springframework.messaging.handler.MessageCondition.compareTo.

Compare the two conditions based on the destination patterns they contain. Patterns are compared one at a time, from top to bottom via org.springframework.util.PathMatcher#getPatternComparator(String). If all compared patterns match equally, but one instance has more patterns, it is considered a closer match.

It is assumed that both instances have been obtained via getMatchingCondition(Message) to ensure they contain only patterns that match the request and are sorted with the best matches on top.

Annotations

@Override

getContent back to summary

getContent	back to summary
protected Collection<String> getContent() Implements abstract org.springframework.messaging.handler.AbstractMessageCondition.getContent. Doc from org.springframework.messaging.handler.AbstractMessageCondition.getContent. Return the collection of objects the message condition is composed of (e.g. destination patterns), never `null`. Annotations @Override

protected Collection<String> getContent()

Implements abstract org.springframework.messaging.handler.AbstractMessageCondition.getContent.

Doc from org.springframework.messaging.handler.AbstractMessageCondition.getContent.

Return the collection of objects the message condition is composed of (e.g. destination patterns), never null.

Annotations

@Override

getMatchingCondition back to summary

getMatchingCondition	back to summary
public DestinationPatternsMessageCondition getMatchingCondition(Message<?> message) Implements org.springframework.messaging.handler.MessageCondition.getMatchingCondition. Check if any of the patterns match the given Message destination and return an instance that is guaranteed to contain matching patterns, sorted via `org.springframework.util.PathMatcher#getPatternComparator(String)`. Parameters message:Message<?> the message to match to Returns:DestinationPatternsMessageCondition the same instance if the condition contains no patterns; or a new condition with sorted matching patterns; or `null` either if a destination can not be extracted or there is no match Annotations @Override @Nullable

public DestinationPatternsMessageCondition getMatchingCondition(Message<?> message)

Implements org.springframework.messaging.handler.MessageCondition.getMatchingCondition.

Check if any of the patterns match the given Message destination and return an instance that is guaranteed to contain matching patterns, sorted via org.springframework.util.PathMatcher#getPatternComparator(String).

Parameters

message:Message<?>: the message to match to

Returns:DestinationPatternsMessageCondition

the same instance if the condition contains no patterns; or a new condition with sorted matching patterns; or null either if a destination can not be extracted or there is no match

Annotations

@Override
@Nullable

getPatternComparator	back to summary
private Comparator<String> getPatternComparator(Object destination)

getPatterns	back to summary
public Set<String> getPatterns()

getToStringInfix	back to summary
protected String getToStringInfix() Implements abstract org.springframework.messaging.handler.AbstractMessageCondition.getToStringInfix. Doc from org.springframework.messaging.handler.AbstractMessageCondition.getToStringInfix. The notation to use when printing discrete items of content. For example " \|\| " for URL patterns or " && " for param expressions. Annotations @Override

getToStringInfix

back to summary

protected String getToStringInfix()

Implements abstract org.springframework.messaging.handler.AbstractMessageCondition.getToStringInfix.

Doc from org.springframework.messaging.handler.AbstractMessageCondition.getToStringInfix.

The notation to use when printing discrete items of content. For example " || " for URL patterns or " && " for param expressions.

Annotations

@Override

matchPattern	back to summary
private boolean matchPattern(String pattern, Object destination)

prependLeadingSlash	back to summary
private static Set<String> prependLeadingSlash(String[] patterns, RouteMatcher routeMatcher)

public Class DestinationPatternsMessageCondition

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail