Spring Framework 6.1.4 · org.springframework.http.server.DefaultRequestPath

Modifier and Type	Field and Description
private final PathContainer	contextPath
private final PathContainer	fullPath
private final PathContainer	pathWithinApplication

Access	Constructor and Description
pack-priv	DefaultRequestPath(String rawPath, String contextPath)
private	DefaultRequestPath(RequestPath requestPath, String contextPath)

Method Summary

Modifier and Type	Method and Description
public PathContainer	contextPath() Implements org.springframework.http.server.RequestPath.contextPath. Returns the portion of the URL path that represents the application.
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.
private static PathContainer	extractPathWithinApplication(PathContainer fullPath, PathContainer contextPath)
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
private static PathContainer	initContextPath(PathContainer path, String contextPath)
public RequestPath	modifyContextPath(String the new context path contextPath) Implements org.springframework.http.server.RequestPath.modifyContextPath. Return a new `RequestPath` instance with a modified context path.
public PathContainer	pathWithinApplication() Implements org.springframework.http.server.RequestPath.pathWithinApplication. The portion of the request path after the context path which is typically used for request mapping within the application.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
private static void	validateContextPath(String fullPath, String contextPath)
public String	value() Implements org.springframework.http.server.PathContainer.value. The original path from which this instance was parsed.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

contextPath	back to summary
private final PathContainer contextPath

fullPath	back to summary
private final PathContainer fullPath

pathWithinApplication	back to summary
private final PathContainer pathWithinApplication

DefaultRequestPath	back to summary
pack-priv DefaultRequestPath(String rawPath, String contextPath)

DefaultRequestPath	back to summary
private DefaultRequestPath(RequestPath requestPath, String contextPath)

Method Detail

contextPath back to summary

contextPath	back to summary
public PathContainer contextPath() Implements org.springframework.http.server.RequestPath.contextPath. Doc from org.springframework.http.server.RequestPath.contextPath. Returns the portion of the URL path that represents the application. The context path is always at the beginning of the path and starts but does not end with "/". It is shared for URLs of the same application. The context path may come from the underlying runtime API such as when deploying as a WAR to a Servlet container or it may be assigned in a WebFlux application through the use of `ContextPathCompositeHandler`. Annotations @Override

public PathContainer contextPath()

Implements org.springframework.http.server.RequestPath.contextPath.

Doc from org.springframework.http.server.RequestPath.contextPath.

Returns the portion of the URL path that represents the application. The context path is always at the beginning of the path and starts but does not end with "/". It is shared for URLs of the same application.

The context path may come from the underlying runtime API such as when deploying as a WAR to a Servlet container or it may be assigned in a WebFlux application through the use of ContextPathCompositeHandler.

Annotations

@Override

elements back to summary

elements	back 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

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

equals back to summary

equals	back 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

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

extractPathWithinApplication	back to summary
private static PathContainer extractPathWithinApplication(PathContainer fullPath, PathContainer contextPath)

hashCode back to summary

hashCode	back 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

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

initContextPath	back to summary
private static PathContainer initContextPath(PathContainer path, String contextPath)

modifyContextPath back to summary

modifyContextPath	back to summary
public RequestPath modifyContextPath(String contextPath) Implements org.springframework.http.server.RequestPath.modifyContextPath. Doc from org.springframework.http.server.RequestPath.modifyContextPath. Return a new `RequestPath` instance with a modified context path. The new context path must match 0 or more path segments at the start. Parameters contextPath:String the new context path Returns:RequestPath a new `RequestPath` instance Annotations @Override

public RequestPath modifyContextPath(String contextPath)

Implements org.springframework.http.server.RequestPath.modifyContextPath.

Doc from org.springframework.http.server.RequestPath.modifyContextPath.

Return a new RequestPath instance with a modified context path. The new context path must match 0 or more path segments at the start.

Parameters

contextPath:String: the new context path

Returns:RequestPath

a new RequestPath instance

Annotations

@Override

pathWithinApplication	back to summary
public PathContainer pathWithinApplication() Implements org.springframework.http.server.RequestPath.pathWithinApplication. Doc from org.springframework.http.server.RequestPath.pathWithinApplication. The portion of the request path after the context path which is typically used for request mapping within the application. Annotations @Override

pathWithinApplication

back to summary

public PathContainer pathWithinApplication()

Implements org.springframework.http.server.RequestPath.pathWithinApplication.

Doc from org.springframework.http.server.RequestPath.pathWithinApplication.

The portion of the request path after the context path which is typically used for request mapping within the application.

Annotations

@Override

toString back to summary

toString	back 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

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

validateContextPath	back to summary
private static void validateContextPath(String fullPath, String contextPath)

value	back 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

value

back 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

pack-priv Class DefaultRequestPath

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail