Top Description Fields Constructors Methods
org.springframework.messaging.simp

public Class SimpMessageMappingInfo

extends Object
implements MessageCondition<SimpMessageMappingInfo>
Class Inheritance
All Implemented Interfaces
org.springframework.messaging.handler.MessageCondition
Imports
org.springframework.lang.Nullable, org.springframework.messaging.Message, org.springframework.messaging.handler.CompositeMessageCondition, .DestinationPatternsMessageCondition, .MessageCondition

MessageCondition for SImple Messaging Protocols. Encapsulates the following request mapping conditions:
  1. SimpMessageTypeMessageCondition
  2. DestinationPatternsMessageCondition
Author
Rossen Stoyanchev
Since
4.0

Field Summary

Modifier and TypeField and Description
private final CompositeMessageCondition

Constructor Summary

AccessConstructor and Description
public
private

Method Summary

Modifier and TypeMethod and Description
public SimpMessageMappingInfo
combine(SimpMessageMappingInfo
the condition to combine with
other
)

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

Define the rules for combining this condition with another.

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

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

Compare this condition to another in the context of a specific message.

public boolean
equals(Object
the reference object with which to compare.
other
)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

public DestinationPatternsMessageCondition
public SimpMessageMappingInfo
getMatchingCondition(Message<?> message)

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

Check if this condition matches the given Message and returns a potentially new condition with content tailored to the current message.

public SimpMessageTypeMessageCondition
public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

delegateback to summary
private final CompositeMessageCondition delegate

Constructor Detail

SimpMessageMappingInfoback to summary
public SimpMessageMappingInfo(SimpMessageTypeMessageCondition messageTypeMessageCondition, DestinationPatternsMessageCondition destinationConditions)
SimpMessageMappingInfoback to summary
private SimpMessageMappingInfo(CompositeMessageCondition delegate)

Method Detail

combineback to summary
public SimpMessageMappingInfo combine(SimpMessageMappingInfo other)

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

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

Define the rules for combining this condition with another. For example combining type- and method-level conditions.

Parameters
other:SimpMessageMappingInfo

the condition to combine with

Returns:SimpMessageMappingInfo

the resulting message condition

Annotations
@Override
compareToback to summary
public int compareTo(SimpMessageMappingInfo other, Message<?> message)

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

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

Compare this condition to another in the context of a specific message. It is assumed both instances have been obtained via getMatchingCondition(Message) to ensure they have content relevant to current message only.

Annotations
@Override
equalsback to summary
public boolean equals(Object other)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
other:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
getDestinationConditionsback to summary
public DestinationPatternsMessageCondition getDestinationConditions()
getMatchingConditionback to summary
public SimpMessageMappingInfo getMatchingCondition(Message<?> message)

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

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

Check if this condition matches the given Message and returns a potentially new condition with content tailored to the current message. For example a condition with destination patterns might return a new condition with sorted, matching patterns only.

Returns:SimpMessageMappingInfo

a condition instance in case of a match; or null if there is no match.

Annotations
@Override
@Nullable
getMessageTypeMessageConditionback to summary
public SimpMessageTypeMessageCondition getMessageTypeMessageCondition()
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object

Annotations
@Override
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations
@Override