Spring Framework 6.1.4 · org.springframework.web.util.HierarchicalUriComponents

Modifier and Type	Class and Description
private static enum	HierarchicalUriComponents.EncodeState
pack-priv static class	HierarchicalUriComponents.FullPathComponent Represents a path backed by a String.
pack-priv static interface	HierarchicalUriComponents.PathComponent Defines the contract for path (segments).
pack-priv static class	HierarchicalUriComponents.PathComponentComposite Represents a collection of PathComponents.
pack-priv static class	HierarchicalUriComponents.PathSegmentComponent Represents a path backed by a String list (i.e. path segments).
private static class	HierarchicalUriComponents.QueryUriTemplateVariables
pack-priv static enum	HierarchicalUriComponents.Type Enumeration used to identify the allowed characters per URI component.
private static class	HierarchicalUriComponents.UriTemplateEncoder

Modifier and Type	Field and Description
private static final MultiValueMap<String, String>	EMPTY_QUERY_PARAMS
private final HierarchicalUriComponents.EncodeState	encodeState
private final String	host
pack-priv static final HierarchicalUriComponents.PathComponent	NULL_PATH_COMPONENT Represents an empty path.
private final HierarchicalUriComponents.PathComponent	path
private static final char	PATH_DELIMITER
private static final String	PATH_DELIMITER_STRING
private final String	port
private final MultiValueMap<String, String>	queryParams
private final String	userInfo
private UnaryOperator<String>	variableEncoder

Access	Constructor and Description
pack-priv	HierarchicalUriComponents(String the scheme scheme, String the fragment fragment, String the user info userInfo, String the host host, String the port port, HierarchicalUriComponents.PathComponent the path path, MultiValueMap<String, String> the query parameters query, boolean whether the components are already encoded encoded) Package-private constructor.
private	HierarchicalUriComponents(String scheme, String fragment, String userInfo, String host, String port, HierarchicalUriComponents.PathComponent path, MultiValueMap<String, String> queryParams, HierarchicalUriComponents.EncodeState encodeState, UnaryOperator<String> variableEncoder)

Method Summary

Modifier and Type	Method and Description
protected void	copyToUriComponentsBuilder(UriComponentsBuilder builder) Implements abstract org.springframework.web.util.UriComponents.copyToUriComponentsBuilder. Set all components of the given UriComponentsBuilder.
public HierarchicalUriComponents	encode(Charset the charset to use for encoding charset) Implements abstract org.springframework.web.util.UriComponents.encode. A variant of `encode()` with a charset other than "UTF-8".
private MultiValueMap<String, String>	encodeQueryParams(BiFunction<String, HierarchicalUriComponents.Type, String> encoder)
pack-priv HierarchicalUriComponents	encodeTemplate(Charset charset) Identical to `encode()` but skipping over URI variable placeholders.
pack-priv static String	Returns: the encoded URI encodeUriComponent(String the source String source, String the encoding of the source String encoding, HierarchicalUriComponents.Type the URI component for the source type) Encode the given source into an encoded String using the rules specified by the given component and with the given options.
pack-priv static String	Returns: the encoded URI encodeUriComponent(String the source String source, Charset the encoding of the source String charset, HierarchicalUriComponents.Type the URI component for the source type) Encode the given source into an encoded String using the rules specified by the given component and with the given options.
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.
protected HierarchicalUriComponents	expandInternal(UriComponents.UriTemplateVariables the URI template values uriVariables) Implements abstract org.springframework.web.util.UriComponents.expandInternal. Replace all URI template variables with the values from the given `UriTemplateVariables`.
private MultiValueMap<String, String>	expandQueryParams(UriComponents.UriTemplateVariables variables)
public String	getHost() Implements abstract org.springframework.web.util.UriComponents.getHost. Return the host.
private HierarchicalUriComponents.Type	getHostType()
public String	getPath() Implements abstract org.springframework.web.util.UriComponents.getPath. Return the path.
public List<String>	getPathSegments() Implements abstract org.springframework.web.util.UriComponents.getPathSegments. Return the list of path segments.
public int	getPort() Implements abstract org.springframework.web.util.UriComponents.getPort. Return the port.
public String	getQuery() Implements abstract org.springframework.web.util.UriComponents.getQuery. Return the query.
public MultiValueMap<String, String>	getQueryParams() Implements abstract org.springframework.web.util.UriComponents.getQueryParams. Return the map of query parameters.
public String	getSchemeSpecificPart() Implements abstract org.springframework.web.util.UriComponents.getSchemeSpecificPart. Return the scheme specific part.
public String	getUserInfo() Implements abstract org.springframework.web.util.UriComponents.getUserInfo. Return the user info.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public UriComponents	normalize() Implements abstract org.springframework.web.util.UriComponents.normalize. Normalize the path removing sequences like "path/..".
public URI	toUri() Implements abstract org.springframework.web.util.UriComponents.toUri. Create a `URI` from this instance as follows: If the current instance is `encoded`, form the full URI String via `toUriString()`, and then pass it to the single argument `URI` constructor which preserves percent encoding.
public String	toUriString() Implements abstract org.springframework.web.util.UriComponents.toUriString. Concatenate all URI components to return the fully formed URI String.
private void	verify() Check if any of the URI components contain any illegal characters.
private static void	verifyUriComponent(String source, HierarchicalUriComponents.Type type)

Inherited from org.springframework.web.util.UriComponents:: encode expand expand expand expandUriComponent expandUriComponent getFragment getScheme toString

pack-priv final Class HierarchicalUriComponents

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary