Top Description Inners Fields Constructors Methods
org.springframework.http.server

pack-priv final Class DefaultPathContainer

extends Object
implements PathContainer
Class Inheritance
All Implemented Interfaces
org.springframework.http.server.PathContainer
Imports
java.nio.charset.Charset, .StandardCharsets, java.util.ArrayList, .Collections, .HashMap, .List, .Map, java.util.stream.Collectors, org.springframework.lang.Nullable, org.springframework.util.Assert, .CollectionUtils, .LinkedMultiValueMap, .MultiValueMap, .StringUtils
Default implementation of PathContainer.
Authors
Rossen Stoyanchev, Sam Brannen
Since
5.0

Nested and Inner Type Summary

Modifier and TypeClass and Description
private static class
DefaultPathContainer.DefaultPathSegment

private static class
DefaultPathContainer.DefaultSeparator

Field Summary

Modifier and TypeField and Description
private final List<PathContainer.Element>
elements

private static final PathContainer
EMPTY_PATH

private final String
path

private static final Map<Character, DefaultPathContainer.DefaultSeparator>
SEPARATORS

Constructor Summary

AccessConstructor and Description
private
DefaultPathContainer(String path, List<PathContainer.Element> elements)

Method Summary

Modifier and TypeMethod and Description
pack-priv static PathContainer
createFromUrlPath(String path, PathContainer.Options options)

private static PathContainer.PathSegment
decodeAndParsePathSegment(String segment)

public List<PathContainer.Element>
elements()

Implements org.springframework.http.server.PathContainer.elements.

The contained path elements, either Separator or PathSegment.
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 int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for the object.
private static MultiValueMap<String, String>
parsePathParams(String input, Charset charset)

private static void
parsePathParamValues(String input, Charset charset, MultiValueMap<String, String> output)

pack-priv static PathContainer
subPath(PathContainer container, int fromIndex, int toIndex)

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.
public String
value()

Implements org.springframework.http.server.PathContainer.value.

The original path from which this instance was parsed.
Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

elementsback to summary
private final List<PathContainer.Element> elements
EMPTY_PATHback to summary
private static final PathContainer EMPTY_PATH
pathback to summary
private final String path
SEPARATORSback to summary
private static final Map<Character, DefaultPathContainer.DefaultSeparator> SEPARATORS

Constructor Detail

DefaultPathContainerback to summary
private DefaultPathContainer(String path, List<PathContainer.Element> elements)

Method Detail

createFromUrlPathback to summary
pack-priv static PathContainer createFromUrlPath(String path, PathContainer.Options options)
decodeAndParsePathSegmentback to summary
private static PathContainer.PathSegment decodeAndParsePathSegment(String segment)
elementsback to summary
public List<PathContainer.Element> elements()

Implements org.springframework.http.server.PathContainer.elements.

Doc from org.springframework.http.server.PathContainer.elements.

The contained path elements, either Separator or PathSegment.

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
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the 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
parsePathParamsback to summary
private static MultiValueMap<String, String> parsePathParams(String input, Charset charset)
parsePathParamValuesback to summary
private static void parsePathParamValues(String input, Charset charset, MultiValueMap<String, String> output)
subPathback to summary
pack-priv static PathContainer subPath(PathContainer container, int fromIndex, int toIndex)
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations
@Override
valueback to summary
public String value()

Implements org.springframework.http.server.PathContainer.value.

Doc from org.springframework.http.server.PathContainer.value.

The original path from which this instance was parsed.

Annotations
@Override
org.springframework.http.server back to summary

private final Class DefaultPathContainer.DefaultPathSegment

extends Object
implements PathSegment
Class Inheritance
  • java.lang.Object
  • org.springframework.http.server.DefaultPathContainer.DefaultPathSegment
All Implemented Interfaces
org.springframework.http.server.PathContainer.PathSegment, org.springframework.http.server.PathContainer.Element

Field Summary

Modifier and TypeField and Description
private static final MultiValueMap<String, String>
EMPTY_PARAMS

private final MultiValueMap<String, String>
parameters

private final String
value

private final String
valueToMatch

Constructor Summary

AccessConstructor and Description
private
DefaultPathSegment(String value, String valueToMatch, MultiValueMap<String, String> params)

Method Summary

Modifier and TypeMethod and Description
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.
pack-priv static DefaultPathContainer.DefaultPathSegment
from(String value, DefaultPathContainer.DefaultSeparator separator)

Factory for segments without decoding and parsing.

pack-priv static DefaultPathContainer.DefaultPathSegment
from(String value, String valueToMatch)

Factory for decoded and parsed segments.

pack-priv static DefaultPathContainer.DefaultPathSegment
from(String value, String valueToMatch, MultiValueMap<String, String> params)

Factory for decoded and parsed segments.

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for the object.
public MultiValueMap<String, String>
parameters()

Implements org.springframework.http.server.PathContainer.PathSegment.parameters.

Path parameters associated with this path segment.
public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.
public String
value()

Implements org.springframework.http.server.PathContainer.Element.value.

The unmodified, original value of this element.
public String
valueToMatch()

Implements org.springframework.http.server.PathContainer.PathSegment.valueToMatch.

Return the path segment value, decoded and sanitized, for path matching.
public char[]
valueToMatchAsChars()

Implements org.springframework.http.server.PathContainer.PathSegment.valueToMatchAsChars.

Expose valueToMatch() as a character array.
Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

EMPTY_PARAMSback to summary
private static final MultiValueMap<String, String> EMPTY_PARAMS
parametersback to summary
private final MultiValueMap<String, String> parameters
valueback to summary
private final String value
valueToMatchback to summary
private final String valueToMatch

Constructor Detail

DefaultPathSegmentback to summary
private DefaultPathSegment(String value, String valueToMatch, MultiValueMap<String, String> params)

Method Detail

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
fromback to summary
pack-priv static DefaultPathContainer.DefaultPathSegment from(String value, DefaultPathContainer.DefaultSeparator separator)

Factory for segments without decoding and parsing.

fromback to summary
pack-priv static DefaultPathContainer.DefaultPathSegment from(String value, String valueToMatch)

Factory for decoded and parsed segments.

fromback to summary
pack-priv static DefaultPathContainer.DefaultPathSegment from(String value, String valueToMatch, MultiValueMap<String, String> params)

Factory for decoded and parsed segments.

hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the 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
parametersback to summary
public MultiValueMap<String, String> parameters()

Implements org.springframework.http.server.PathContainer.PathSegment.parameters.

Doc from org.springframework.http.server.PathContainer.PathSegment.parameters.

Path parameters associated with this path segment.

Returns:MultiValueMap<String, String>

an unmodifiable map containing the parameters

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.

Returns:String

a string representation of the object.

Annotations
@Override
valueback to summary
public String value()

Implements org.springframework.http.server.PathContainer.Element.value.

Doc from org.springframework.http.server.PathContainer.Element.value.

The unmodified, original value of this element.

Annotations
@Override
valueToMatchback to summary
public String valueToMatch()

Implements org.springframework.http.server.PathContainer.PathSegment.valueToMatch.

Doc from org.springframework.http.server.PathContainer.PathSegment.valueToMatch.

Return the path segment value, decoded and sanitized, for path matching.

Annotations
@Override
valueToMatchAsCharsback to summary
public char[] valueToMatchAsChars()

Implements org.springframework.http.server.PathContainer.PathSegment.valueToMatchAsChars.

Doc from org.springframework.http.server.PathContainer.PathSegment.valueToMatchAsChars.

Expose valueToMatch() as a character array.

Annotations
@Override
org.springframework.http.server back to summary

private Class DefaultPathContainer.DefaultSeparator

extends Object
implements Separator
Class Inheritance
  • java.lang.Object
  • org.springframework.http.server.DefaultPathContainer.DefaultSeparator
All Implemented Interfaces
org.springframework.http.server.PathContainer.Separator, org.springframework.http.server.PathContainer.Element

Field Summary

Modifier and TypeField and Description
private final String
encodedSequence

private final String
separator

Constructor Summary

AccessConstructor and Description
pack-priv
DefaultSeparator(char separator, String encodedSequence)

Method Summary

Modifier and TypeMethod and Description
public String
encodedSequence()

public String
value()

Implements org.springframework.http.server.PathContainer.Element.value.

The unmodified, original value of this element.
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

encodedSequenceback to summary
private final String encodedSequence
separatorback to summary
private final String separator

Constructor Detail

DefaultSeparatorback to summary
pack-priv DefaultSeparator(char separator, String encodedSequence)

Method Detail

encodedSequenceback to summary
public String encodedSequence()
valueback to summary
public String value()

Implements org.springframework.http.server.PathContainer.Element.value.

Doc from org.springframework.http.server.PathContainer.Element.value.

The unmodified, original value of this element.

Annotations
@Override