Skip to content

Commit

Permalink
Replace E.g. with For example
Browse files Browse the repository at this point in the history
Latin abbreviation is not friendly for english-native speakers.
  • Loading branch information
quaff committed Sep 10, 2024
1 parent cc3f4b8 commit dc6ae5c
Show file tree
Hide file tree
Showing 16 changed files with 24 additions and 24 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
*
* <p>The user should implement the {@link
* #construct(ConstructorInvocation)} method to modify the original
* behavior. E.g. the following class implements a singleton
* behavior. For example the following class implements a singleton
* interceptor (allows only one unique instance for the intercepted
* class):
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
* are nested "on top" of the target.
*
* <p>The user should implement the {@link #invoke(MethodInvocation)}
* method to modify the original behavior. E.g. the following class
* method to modify the original behavior. For example the following class
* implements a tracing interceptor (traces all the calls on the
* intercepted method(s)):
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -194,7 +194,7 @@ public static boolean isFinalizeMethod(@Nullable Method method) {
/**
* Given a method, which may come from an interface, and a target class used
* in the current AOP invocation, find the corresponding target method if there
* is one. E.g. the method may be {@code IFoo.bar()} and the target class
* is one. For example the method may be {@code IFoo.bar()} and the target class
* may be {@code DefaultFoo}. In this case, the method may be
* {@code DefaultFoo.bar()}. This enables attributes on that method to be found.
* <p><b>NOTE:</b> In contrast to {@link org.springframework.util.ClassUtils#getMostSpecificMethod},
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ public interface Scope {

/**
* Resolve the contextual object for the given key, if any.
* E.g. the HttpServletRequest object for key "request".
* For example the HttpServletRequest object for key "request".
* @param key the contextual key
* @return the corresponding object, or {@code null} if none found
* @throws IllegalStateException if the underlying scope is not currently active
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ public abstract class YamlProcessor {
* A map of document matchers allowing callers to selectively use only
* some of the documents in a YAML resource. In YAML documents are
* separated by {@code ---} lines, and each document is converted
* to properties before the match is made. E.g.
* to properties before the match is made. For example
* <pre class="code">
* environment: dev
* url: https://dev.bar.com
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -821,7 +821,7 @@ protected Class<?> getTypeForFactoryMethod(String beanName, RootBeanDefinition m
return cachedReturnType.resolve();
}
catch (LinkageError err) {
// E.g. a NoClassDefFoundError for a generic method return type
// For example a NoClassDefFoundError for a generic method return type
if (logger.isDebugEnabled()) {
logger.debug("Failed to resolve type for factory method of bean '" + beanName + "': " +
(uniqueCandidate != null ? uniqueCandidate : commonType), err);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ public ThemeSource getParentThemeSource() {
/**
* Set the prefix that gets applied to the ResourceBundle basenames,
* i.e. the theme names.
* E.g.: basenamePrefix="test.", themeName="theme" &rarr; basename="test.theme".
* For example: basenamePrefix="test.", themeName="theme" &rarr; basename="test.theme".
* <p>Note that ResourceBundle names are effectively classpath locations: As a
* consequence, the JDK's standard ResourceBundle treats dots as package separators.
* This means that "test.theme" is effectively equivalent to "test/theme",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@
* their parameters and/or on their return value (in the latter case specified at
* the method level, typically as inline annotation).
*
* <p>E.g.: {@code public @NotNull Object myValidMethod(@NotNull String arg1, @Max(10) int arg2)}
* <p>For example: {@code public @NotNull Object myValidMethod(@NotNull String arg1, @Max(10) int arg2)}
*
* <p>In case of validation errors, the interceptor can raise
* {@link ConstraintViolationException}, or adapt the violations to
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -481,7 +481,7 @@ public static String delete(String inString, String pattern) {
* Delete any character in a given {@code String}.
* @param inString the original {@code String}
* @param charsToDelete a set of characters to delete.
* E.g. "az\n" will delete 'a's, 'z's and new lines.
* For example "az\n" will delete 'a's, 'z's and new lines.
* @return the resulting {@code String}
*/
public static String deleteAny(String inString, @Nullable String charsToDelete) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -217,7 +217,7 @@ protected DataAccessException doTranslate(String task, @Nullable String sql, SQL
}
else {
// Try to find SQLException with actual error code, looping through the causes.
// E.g. applicable to java.sql.DataTruncation as of JDK 1.6.
// For example applicable to java.sql.DataTruncation as of JDK 1.6.
SQLException current = sqlEx;
while (current.getErrorCode() == 0 && current.getCause() instanceof SQLException sqlException) {
current = sqlException;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -259,7 +259,7 @@ protected boolean receiveAndExecute(
catch (RuntimeException ex) {
// Typically a late persistence exception from a listener-used resource
// -> handle it as listener exception, not as an infrastructure problem.
// E.g. a database locking failure should not lead to listener shutdown.
// For example a database locking failure should not lead to listener shutdown.
handleListenerException(ex);
}
return messageReceived;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -284,11 +284,11 @@ public String getPathWithinServletMapping(HttpServletRequest request) {
* i.e. the part of the request's URL beyond the part that called the servlet,
* or "" if the whole URL has been used to identify the servlet.
* <p>Detects include request URL if called within a RequestDispatcher include.
* <p>E.g.: servlet mapping = "/*"; request URI = "/test/a" &rarr; "/test/a".
* <p>E.g.: servlet mapping = "/"; request URI = "/test/a" &rarr; "/test/a".
* <p>E.g.: servlet mapping = "/test/*"; request URI = "/test/a" &rarr; "/a".
* <p>E.g.: servlet mapping = "/test"; request URI = "/test" &rarr; "".
* <p>E.g.: servlet mapping = "/*.test"; request URI = "/a.test" &rarr; "".
* <p>For example: servlet mapping = "/*"; request URI = "/test/a" &rarr; "/test/a".
* <p>For example: servlet mapping = "/"; request URI = "/test/a" &rarr; "/test/a".
* <p>For example: servlet mapping = "/test/*"; request URI = "/test/a" &rarr; "/a".
* <p>For example: servlet mapping = "/test"; request URI = "/test" &rarr; "".
* <p>For example: servlet mapping = "/*.test"; request URI = "/a.test" &rarr; "".
* @param request current HTTP request
* @param pathWithinApp a precomputed path within the application
* @return the path within the servlet mapping, or ""
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@
* "templates/test.ftl"
*
* <p>As a special feature, redirect URLs can be specified via the "redirect:"
* prefix. E.g.: "redirect:myAction" will trigger a redirect to the given
* prefix. For example: "redirect:myAction" will trigger a redirect to the given
* URL, rather than resolution as standard view name. This is typically used
* for redirecting to a controller URL after finishing a form workflow.
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@
* <td>path</td>
* <td>true</td>
* <td>true</td>
* <td>Set the path that this tag should apply. E.g. 'customer' to allow bind
* <td>Set the path that this tag should apply. For example 'customer' to allow bind
* paths like 'address.street' rather than 'customer.address.street'.</td>
* </tr>
* </tbody>
Expand Down Expand Up @@ -78,7 +78,7 @@ public class NestedPathTag extends TagSupport implements TryCatchFinally {

/**
* Set the path that this tag should apply.
* <p>E.g. "customer" to allow bind paths like "address.street"
* <p>For example "customer" to allow bind paths like "address.street"
* rather than "customer.address.street".
* @see BindTag#setPath
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -53,12 +53,12 @@
* "/WEB-INF/jsp/test.jsp"
*
* <p>As a special feature, redirect URLs can be specified via the "redirect:"
* prefix. E.g.: "redirect:myAction" will trigger a redirect to the given
* prefix. For example: "redirect:myAction" will trigger a redirect to the given
* URL, rather than resolution as standard view name. This is typically used
* for redirecting to a controller URL after finishing a form workflow.
*
* <p>Furthermore, forward URLs can be specified via the "forward:" prefix.
* E.g.: "forward:myAction" will trigger a forward to the given URL, rather than
* For example: "forward:myAction" will trigger a forward to the given URL, rather than
* resolution as standard view name. This is typically used for controller URLs;
* it is not supposed to be used for JSP URLs - use logical view names there.
*
Expand Down Expand Up @@ -221,7 +221,7 @@ protected String getContentType() {
* interpreted as relative to the web application root, i.e. the context
* path will be prepended to the URL.
* <p><b>Redirect URLs can be specified via the "redirect:" prefix.</b>
* E.g.: "redirect:myAction"
* For example: "redirect:myAction"
* @see RedirectView#setContextRelative
* @see #REDIRECT_URL_PREFIX
*/
Expand All @@ -248,7 +248,7 @@ protected boolean isRedirectContextRelative() {
* difference. However, some clients depend on 303 when redirecting
* after a POST request; turn this flag off in such a scenario.
* <p><b>Redirect URLs can be specified via the "redirect:" prefix.</b>
* E.g.: "redirect:myAction"
* For example: "redirect:myAction"
* @see RedirectView#setHttp10Compatible
* @see #REDIRECT_URL_PREFIX
*/
Expand Down
2 changes: 1 addition & 1 deletion spring-webmvc/src/main/resources/META-INF/spring.tld
Original file line number Diff line number Diff line change
Expand Up @@ -257,7 +257,7 @@
<variable-class>java.lang.String</variable-class>
</variable>
<attribute>
<description>Set the path that this tag should apply. E.g. 'customer'
<description>Set the path that this tag should apply. For example 'customer'
to allow bind paths like 'address.street' rather than
'customer.address.street'.</description>
<name>path</name>
Expand Down

0 comments on commit dc6ae5c

Please sign in to comment.