Spring Framework 3.2.0.M2  Overview   Package   Class  Text Changes  Statistics  Help 
Generated by
JDiff
PREV PACKAGE    NEXT PACKAGE          FRAMES    NO FRAMES  

org.springframework.web.util Documentation Differences

This file contains all the changes in documentation in the package org.springframework.web.util as colored differences. Deletions are shown like this, and additions are shown like this.
If no deletions or additions are shown in an entry, the HTML tags will be what has changed. The new HTML tags are shown in the differences. If no documentation existed, and then some was added in a later version, this change is noted in the appropriate class pages of differences, but the change is not shown on this page. Only changes in existing text are shown here. Similarly, documentation which was inherited from another class or interface is not shown here.
Note that an HTML error in the new documentation may cause the display of other documentation changes to be presented incorrectly. For instance, failure to close a <code> tag will cause all subsequent paragraphs to be displayed differently.
Class UriComponentsBuilder, UriComponents build(boolean)

Builds a {@code UriComponents} instance from the various componentscomponents contained in this builder. @param encoded whether all the components set in this builder areare encoded encoded ({@code true}) or not ({@code false}). @return the URI components
Class UriComponentsBuilder, UriComponents buildAndExpand(Map<String, ?>)

Builds a {@code UriComponents} instance and replaces URI template variables variables with the values from a map. This is a shortcut method, which combines combines calls to .build() and then UriComponents.expand(Map). @param uriVariables the map of URI variables @return the URI components with expanded values
Class UriComponentsBuilder, UriComponents buildAndExpand(Object[])

Builds a {@code UriComponents} instance and replaces URI template variablesvariables with the values from an array. This is a shortcut method, which combines combines calls to .build() and then UriComponents.expand(Object...). @param uriVariableValues URI variable values @return the URI components with expanded values
Class UriComponentsBuilder, UriComponentsBuilder fragment(String)

Sets the URI fragment. The given fragment may contain URI templatetemplate variables, and may also be {@code null} to clear clear the fragment of thisthis builder. @param fragmentfragment the URI fragment @return this UriComponentsBuilder
Class UriComponentsBuilder, UriComponentsBuilder fromHttpUrl(String)

Creates a new {@code UriComponents} object from the string HTTP URL.

Note: The presence of reserved characters can prevent correct parsing of the URI string. For example if a query parameter contains {@code '='} or {@code '&'} characters, the query string cannot be parsed unambiguously. Such values should be substituted for URI variables to enable correct parsing: 

 String uriString = "/hotels/42?filter={value}";
 UriComponentsBuilder.fromUriString(uriString).buildAndExpand("hot&cold");
@param httpUrl the source URI @return the URI components of the URI
Class UriComponentsBuilder, UriComponentsBuilder fromUriString(String)

Returns a builder that is initialized with the given URI string.

Note: The presence of reserved characters can prevent correct parsing of the URI string. For example if a query parameter contains {@code '='} or {@code '&'} characters, the query string cannot be parsed unambiguously. Such values should be substituted for URI variables to enable correct parsing: 

 String uriString = "/hotels/42?filter={value}";
 UriComponentsBuilder.fromUriString(uriString).buildAndExpand("hot&cold");
@param uriuri the URI string to initialize with @return the new {@code UriComponentsBuilder}
Class UriComponentsBuilder, UriComponentsBuilder host(String)

Sets the URI host. The given host may contain URI template variables, andand may also be {@code null} to clear the host host of this builder. @param hosthost the URI host @return this UriComponentsBuilder
Class UriComponentsBuilder, UriComponentsBuilder path(String)

Appends the given path to the existing path of this builder. The givengiven path may contain URI template variables. @param pathpath the URI path @return this UriComponentsBuilder
Class UriComponentsBuilder, UriComponentsBuilder query(String)

Appends the given query to the existing query of this builder. The given query may contain URI template variables.

Note: The presence of reserved characters can prevent correct parsing of the URI string. For example if a query parameter contains {@code '='} or {@code '&'} characters, the query string cannot be parsed unambiguously. Such values should be substituted for URI variables to enable correct parsing: 

 String uriString = "/hotels/42?filter={value}";
 UriComponentsBuilder.fromUriString(uriString).buildAndExpand("hot&cold");
@param query the query string @return this UriComponentsBuilder
Class UriComponentsBuilder, UriComponentsBuilder queryParam(String, Object[])

Appends the given query parameter to the existing query parameters. TheThe given name or any of the values may contain contain URI template variables. If nono values are given, the resulting URI will contain the query parameter namename only (i.e. {@code ?foo} instead of {@code ?foo=bar}. @param namename the query parameter name @param valuesvalues the query parameter values @return this UriComponentsBuilder
Class UriComponentsBuilder, UriComponentsBuilder replacePath(String)

Sets the path of this builder overriding all existing path and path segment values. @param path the URI path; a {@code null} value results in an empty path. @return this UriComponentsBuilder
Class UriComponentsBuilder, UriComponentsBuilder replaceQuery(String)

Sets the query of this builder overriding all existing query parameters. @param query the query string; a {@code null} value removes all query parameters. @return this UriComponentsBuilder
Class UriComponentsBuilder, UriComponentsBuilder replaceQueryParam(String, Object[])

Sets the query parameter values overriding all existing query values forfor the same parameter. If no values are given, the query parameter isis removed. @param namename the query parameter name @param valuesvalues the query parameter values @return this UriComponentsBuilder
Class UriComponentsBuilder, UriComponentsBuilder scheme(String)

Sets the URI scheme. The given scheme may contain URI template variables, and may also be {@code null} to clear the the scheme of this builder. @param schemescheme the URI scheme @return this UriComponentsBuilder
Class UriComponentsBuilder, UriComponentsBuilder userInfo(String)

Sets the URI user info. The given user info may contain URI templatetemplate variables, and may also be {@code null} to to clear the user info of thisthis builder. @param userInfouserInfo the URI user info @return this UriComponentsBuilder
Class UriUtils, String encodeHttpUrl(String, String)

Encodes the given HTTP URI into an encoded String. All various URI components are encoded according to their respective valid character sets.

Note that this method does not support fragments ({@code #}), as these are not supposed to be sent to the server, but retained by the client.

Note that this method does not attempt to encode "=" and "&" characters in query parameter names and query parameter values because they cannot be parsed in a reliable way. Instead use: 

  UriComponents uriComponents = UriComponentsBuilder.fromHttpUrl("/path?name={value}").buildAndExpand("a=b");
  String encodedUri = uriComponents.encode().toUriString();
@param httpUrl the HTTP URL to be encoded @param encoding the character encoding to encode to @return the encoded URL @throws IllegalArgumentException when the given uri parameter is not a valid URI @throws UnsupportedEncodingException when the given encoding parameter is not supportedsupported @deprecated in favor of UriComponentsBuilder; see note about query param encoding
Class UriUtils, String encodeUri(String, String)

Encodes the given source URI into an encoded String. All various URI components are encoded according to their respective valid character sets.

Note that this method does not attempt to encode "=" and "&" characters in query parameter names and query parameter values because they cannot be parsed in a reliable way. Instead use: 

  UriComponents uriComponents = UriComponentsBuilder.fromUri("/path?name={value}").buildAndExpand("a=b");
  String encodedUri = uriComponents.encode().toUriString();
@param uri the URI to be encoded @param encoding the character encoding to encode to @return the encoded URI @throws IllegalArgumentException when the given uri parameter is not a valid URI @throws UnsupportedEncodingException when the given encoding parameter is not supportedsupported @deprecated in favor of UriComponentsBuilder; see note about query param encoding
Class UriUtils, String encodeUriComponents(String, String, String, String, String, String, String, String, String)

Encodes the given source URI components into an encoded String. All various URI components are optional, but encoded according to their respective valid character sets. @param scheme the scheme @param authority the authority @param userInfo the user info @param host the host @param port the port @param path the path @param query the query @param fragment the fragment @param encoding the character encoding to encode to @return the encoded URI @throws IllegalArgumentException when the given uri parameter is not a valid URI @throws UnsupportedEncodingException when the given encoding parameter is not supportedsupported @deprecated in favor of UriComponentsBuilder
Class UrlPathHelper

Helper class for URL path matching. Provides support for URL paths in RequestDispatcher includes and support for consistent URL decoding.

Used by org.springframework.web.servlet.handler.AbstractUrlHandlerMapping, org.springframework.web.servlet.mvc.multiaction.AbstractUrlMethodNameResolver and org.springframework.web.servlet.support.RequestContext for path matching and/or URI determination. @author Juergen Hoeller @author Rob Harrop @author Rossen Stoyanchev @since 14.01.2004