mirror of
https://github.com/openjdk/jdk.git
synced 2025-08-27 14:54:52 +02:00
8231186: Replace html tag <code>foo</code> with javadoc tag {@code foo} in java.base
Minor coding style update of javadoc tag in any file in java.base Reviewed-by: bchristi, lancea
This commit is contained in:
Julia Boes
parent
13d0bac294
commit
d15a57b842
139 changed files with 3499 additions and 3499 deletions
|
|
@ -190,9 +190,9 @@ public abstract class CalendarNameProvider extends LocaleServiceProvider {
|
|||
|
||||
/**
|
||||
* Returns the string representation (display name) of the calendar
|
||||
* <code>field value</code> in the given <code>style</code> and
|
||||
* <code>locale</code>. If no string representation is
|
||||
* applicable, <code>null</code> is returned.
|
||||
* {@code field value} in the given {@code style} and
|
||||
* {@code locale}. If no string representation is
|
||||
* applicable, {@code null} is returned.
|
||||
*
|
||||
* <p>{@code field} is a {@code Calendar} field index, such as {@link
|
||||
* Calendar#MONTH}. The time zone fields, {@link Calendar#ZONE_OFFSET} and
|
||||
|
|
|
|||
|
|
@ -63,10 +63,10 @@ public abstract class CurrencyNameProvider extends LocaleServiceProvider {
|
|||
* @param locale the desired locale
|
||||
* @return the symbol of the given currency code for the specified locale, or null if
|
||||
* the symbol is not available for the locale
|
||||
* @throws NullPointerException if <code>currencyCode</code> or
|
||||
* <code>locale</code> is null
|
||||
* @throws IllegalArgumentException if <code>currencyCode</code> is not in
|
||||
* the form of three upper-case letters, or <code>locale</code> isn't
|
||||
* @throws NullPointerException if {@code currencyCode} or
|
||||
* {@code locale} is null
|
||||
* @throws IllegalArgumentException if {@code currencyCode} is not in
|
||||
* the form of three upper-case letters, or {@code locale} isn't
|
||||
* one of the locales returned from
|
||||
* {@link java.util.spi.LocaleServiceProvider#getAvailableLocales()
|
||||
* getAvailableLocales()}.
|
||||
|
|
@ -84,13 +84,13 @@ public abstract class CurrencyNameProvider extends LocaleServiceProvider {
|
|||
* @param locale the desired locale
|
||||
* @return the name for the currency that is appropriate for display to the
|
||||
* user, or null if the name is not available for the locale
|
||||
* @throws IllegalArgumentException if <code>currencyCode</code> is not in
|
||||
* the form of three upper-case letters, or <code>locale</code> isn't
|
||||
* @throws IllegalArgumentException if {@code currencyCode} is not in
|
||||
* the form of three upper-case letters, or {@code locale} isn't
|
||||
* one of the locales returned from
|
||||
* {@link java.util.spi.LocaleServiceProvider#getAvailableLocales()
|
||||
* getAvailableLocales()}.
|
||||
* @throws NullPointerException if <code>currencyCode</code> or
|
||||
* <code>locale</code> is <code>null</code>
|
||||
* @throws NullPointerException if {@code currencyCode} or
|
||||
* {@code locale} is {@code null}
|
||||
* @since 1.7
|
||||
*/
|
||||
public String getDisplayName(String currencyCode, Locale locale) {
|
||||
|
|
|
|||
|
|
@ -48,10 +48,10 @@ public abstract class LocaleNameProvider extends LocaleServiceProvider {
|
|||
* Returns a localized name for the given <a href="http://www.rfc-editor.org/rfc/bcp/bcp47.txt">
|
||||
* IETF BCP47</a> language code and the given locale that is appropriate for
|
||||
* display to the user.
|
||||
* For example, if <code>languageCode</code> is "fr" and <code>locale</code>
|
||||
* is en_US, getDisplayLanguage() will return "French"; if <code>languageCode</code>
|
||||
* is "en" and <code>locale</code> is fr_FR, getDisplayLanguage() will return "anglais".
|
||||
* If the name returned cannot be localized according to <code>locale</code>,
|
||||
* For example, if {@code languageCode} is "fr" and {@code locale}
|
||||
* is en_US, getDisplayLanguage() will return "French"; if {@code languageCode}
|
||||
* is "en" and {@code locale} is fr_FR, getDisplayLanguage() will return "anglais".
|
||||
* If the name returned cannot be localized according to {@code locale},
|
||||
* (say, the provider does not have a Japanese name for Croatian),
|
||||
* this method returns null.
|
||||
* @param languageCode the language code string in the form of two to eight
|
||||
|
|
@ -59,9 +59,9 @@ public abstract class LocaleNameProvider extends LocaleServiceProvider {
|
|||
* @param locale the desired locale
|
||||
* @return the name of the given language code for the specified locale, or null if it's not
|
||||
* available.
|
||||
* @throws NullPointerException if <code>languageCode</code> or <code>locale</code> is null
|
||||
* @throws IllegalArgumentException if <code>languageCode</code> is not in the form of
|
||||
* two or three lower-case letters, or <code>locale</code> isn't
|
||||
* @throws NullPointerException if {@code languageCode} or {@code locale} is null
|
||||
* @throws IllegalArgumentException if {@code languageCode} is not in the form of
|
||||
* two or three lower-case letters, or {@code locale} isn't
|
||||
* one of the locales returned from
|
||||
* {@link java.util.spi.LocaleServiceProvider#getAvailableLocales()
|
||||
* getAvailableLocales()}.
|
||||
|
|
@ -73,10 +73,10 @@ public abstract class LocaleNameProvider extends LocaleServiceProvider {
|
|||
* Returns a localized name for the given <a href="http://www.rfc-editor.org/rfc/bcp/bcp47.txt">
|
||||
* IETF BCP47</a> script code and the given locale that is appropriate for
|
||||
* display to the user.
|
||||
* For example, if <code>scriptCode</code> is "Latn" and <code>locale</code>
|
||||
* is en_US, getDisplayScript() will return "Latin"; if <code>scriptCode</code>
|
||||
* is "Cyrl" and <code>locale</code> is fr_FR, getDisplayScript() will return "cyrillique".
|
||||
* If the name returned cannot be localized according to <code>locale</code>,
|
||||
* For example, if {@code scriptCode} is "Latn" and {@code locale}
|
||||
* is en_US, getDisplayScript() will return "Latin"; if {@code scriptCode}
|
||||
* is "Cyrl" and {@code locale} is fr_FR, getDisplayScript() will return "cyrillique".
|
||||
* If the name returned cannot be localized according to {@code locale},
|
||||
* (say, the provider does not have a Japanese name for Cyrillic),
|
||||
* this method returns null. The default implementation returns null.
|
||||
* @param scriptCode the four letter script code string in the form of title-case
|
||||
|
|
@ -86,9 +86,9 @@ public abstract class LocaleNameProvider extends LocaleServiceProvider {
|
|||
* @param locale the desired locale
|
||||
* @return the name of the given script code for the specified locale, or null if it's not
|
||||
* available.
|
||||
* @throws NullPointerException if <code>scriptCode</code> or <code>locale</code> is null
|
||||
* @throws IllegalArgumentException if <code>scriptCode</code> is not in the form of
|
||||
* four title case letters, or <code>locale</code> isn't
|
||||
* @throws NullPointerException if {@code scriptCode} or {@code locale} is null
|
||||
* @throws IllegalArgumentException if {@code scriptCode} is not in the form of
|
||||
* four title case letters, or {@code locale} isn't
|
||||
* one of the locales returned from
|
||||
* {@link java.util.spi.LocaleServiceProvider#getAvailableLocales()
|
||||
* getAvailableLocales()}.
|
||||
|
|
@ -103,10 +103,10 @@ public abstract class LocaleNameProvider extends LocaleServiceProvider {
|
|||
* Returns a localized name for the given <a href="http://www.rfc-editor.org/rfc/bcp/bcp47.txt">
|
||||
* IETF BCP47</a> region code (either ISO 3166 country code or UN M.49 area
|
||||
* codes) and the given locale that is appropriate for display to the user.
|
||||
* For example, if <code>countryCode</code> is "FR" and <code>locale</code>
|
||||
* is en_US, getDisplayCountry() will return "France"; if <code>countryCode</code>
|
||||
* is "US" and <code>locale</code> is fr_FR, getDisplayCountry() will return "Etats-Unis".
|
||||
* If the name returned cannot be localized according to <code>locale</code>,
|
||||
* For example, if {@code countryCode} is "FR" and {@code locale}
|
||||
* is en_US, getDisplayCountry() will return "France"; if {@code countryCode}
|
||||
* is "US" and {@code locale} is fr_FR, getDisplayCountry() will return "Etats-Unis".
|
||||
* If the name returned cannot be localized according to {@code locale},
|
||||
* (say, the provider does not have a Japanese name for Croatia),
|
||||
* this method returns null.
|
||||
* @param countryCode the country(region) code string in the form of two
|
||||
|
|
@ -115,9 +115,9 @@ public abstract class LocaleNameProvider extends LocaleServiceProvider {
|
|||
* @param locale the desired locale
|
||||
* @return the name of the given country code for the specified locale, or null if it's not
|
||||
* available.
|
||||
* @throws NullPointerException if <code>countryCode</code> or <code>locale</code> is null
|
||||
* @throws IllegalArgumentException if <code>countryCode</code> is not in the form of
|
||||
* two upper-case letters or three digit letters, or <code>locale</code> isn't
|
||||
* @throws NullPointerException if {@code countryCode} or {@code locale} is null
|
||||
* @throws IllegalArgumentException if {@code countryCode} is not in the form of
|
||||
* two upper-case letters or three digit letters, or {@code locale} isn't
|
||||
* one of the locales returned from
|
||||
* {@link java.util.spi.LocaleServiceProvider#getAvailableLocales()
|
||||
* getAvailableLocales()}.
|
||||
|
|
@ -128,14 +128,14 @@ public abstract class LocaleNameProvider extends LocaleServiceProvider {
|
|||
/**
|
||||
* Returns a localized name for the given variant code and the given locale that
|
||||
* is appropriate for display to the user.
|
||||
* If the name returned cannot be localized according to <code>locale</code>,
|
||||
* If the name returned cannot be localized according to {@code locale},
|
||||
* this method returns null.
|
||||
* @param variant the variant string
|
||||
* @param locale the desired locale
|
||||
* @return the name of the given variant string for the specified locale, or null if it's not
|
||||
* available.
|
||||
* @throws NullPointerException if <code>variant</code> or <code>locale</code> is null
|
||||
* @throws IllegalArgumentException if <code>locale</code> isn't
|
||||
* @throws NullPointerException if {@code variant} or {@code locale} is null
|
||||
* @throws IllegalArgumentException if {@code locale} isn't
|
||||
* one of the locales returned from
|
||||
* {@link java.util.spi.LocaleServiceProvider#getAvailableLocales()
|
||||
* getAvailableLocales()}.
|
||||
|
|
|
|||
|
|
@ -33,12 +33,12 @@ import java.util.Locale;
|
|||
* interfaces (SPIs).
|
||||
* <p>
|
||||
* Locale sensitive service provider interfaces are interfaces that
|
||||
* correspond to locale sensitive classes in the <code>java.text</code>
|
||||
* and <code>java.util</code> packages. The interfaces enable the
|
||||
* correspond to locale sensitive classes in the {@code java.text}
|
||||
* and {@code java.util} packages. The interfaces enable the
|
||||
* construction of locale sensitive objects and the retrieval of
|
||||
* localized names for these packages. Locale sensitive factory methods
|
||||
* and methods for name retrieval in the <code>java.text</code> and
|
||||
* <code>java.util</code> packages use implementations of the provider
|
||||
* and methods for name retrieval in the {@code java.text} and
|
||||
* {@code java.util} packages use implementations of the provider
|
||||
* interfaces to offer support for locales beyond the set of locales
|
||||
* supported by the Java runtime environment itself.
|
||||
*
|
||||
|
|
@ -68,17 +68,17 @@ import java.util.Locale;
|
|||
* <pre>
|
||||
* META-INF/services/java.text.spi.DateFormatProvider
|
||||
* </pre>
|
||||
* And the file <code>java.text.spi.DateFormatProvider</code> should have
|
||||
* And the file {@code java.text.spi.DateFormatProvider} should have
|
||||
* a line such as:
|
||||
* <pre>
|
||||
* <code>com.foo.DateFormatProviderImpl</code>
|
||||
* {@code com.foo.DateFormatProviderImpl}
|
||||
* </pre>
|
||||
* which is the fully qualified class name of the class implementing
|
||||
* <code>DateFormatProvider</code>.
|
||||
* {@code DateFormatProvider}.
|
||||
* <h3>Invocation of Locale Sensitive Services</h3>
|
||||
* <p>
|
||||
* Locale sensitive factory methods and methods for name retrieval in the
|
||||
* <code>java.text</code> and <code>java.util</code> packages invoke
|
||||
* {@code java.text} and {@code java.util} packages invoke
|
||||
* service provider methods when needed to support the requested locale.
|
||||
* The methods first check whether the Java runtime environment itself
|
||||
* supports the requested locale, and use its support if available.
|
||||
|
|
@ -93,7 +93,7 @@ import java.util.Locale;
|
|||
* supports the requested locale, the methods go through a list of candidate
|
||||
* locales and repeat the availability check for each until a match is found.
|
||||
* The algorithm used for creating a list of candidate locales is same as
|
||||
* the one used by <code>ResourceBundle</code> by default (see
|
||||
* the one used by {@code ResourceBundle} by default (see
|
||||
* {@link java.util.ResourceBundle.Control#getCandidateLocales getCandidateLocales}
|
||||
* for the details). Even if a locale is resolved from the candidate list,
|
||||
* methods that return requested objects or names are invoked with the original
|
||||
|
|
@ -104,7 +104,7 @@ import java.util.Locale;
|
|||
* Providers of names (but not providers of other objects) are allowed to
|
||||
* return null for some name requests even for locales that they claim to
|
||||
* support by including them in their return value for
|
||||
* <code>getAvailableLocales</code>. Similarly, the Java runtime
|
||||
* {@code getAvailableLocales}. Similarly, the Java runtime
|
||||
* environment itself may not have all names for all locales that it
|
||||
* supports. This is because the sets of objects for which names are
|
||||
* requested can be large and vary over time, so that it's not always
|
||||
|
|
|
|||
|
|
@ -57,7 +57,7 @@ public abstract class TimeZoneNameProvider extends LocaleServiceProvider {
|
|||
* "tzdata", and the specification of the data format is part of the zic.8
|
||||
* man page, which is contained in a file whose name starts with "tzcode".
|
||||
* <p>
|
||||
* If <code>daylight</code> is true, the method should return a name
|
||||
* If {@code daylight} is true, the method should return a name
|
||||
* appropriate for daylight saving time even if the specified time zone
|
||||
* has not observed daylight saving time in the past.
|
||||
*
|
||||
|
|
@ -68,11 +68,11 @@ public abstract class TimeZoneNameProvider extends LocaleServiceProvider {
|
|||
* @param locale the desired locale
|
||||
* @return the human-readable name of the given time zone in the
|
||||
* given locale, or null if it's not available.
|
||||
* @throws IllegalArgumentException if <code>style</code> is invalid,
|
||||
* or <code>locale</code> isn't one of the locales returned from
|
||||
* @throws IllegalArgumentException if {@code style} is invalid,
|
||||
* or {@code locale} isn't one of the locales returned from
|
||||
* {@link java.util.spi.LocaleServiceProvider#getAvailableLocales()
|
||||
* getAvailableLocales()}.
|
||||
* @throws NullPointerException if <code>ID</code> or <code>locale</code>
|
||||
* @throws NullPointerException if {@code ID} or {@code locale}
|
||||
* is null
|
||||
* @see java.util.TimeZone#getDisplayName(boolean, int, java.util.Locale)
|
||||
*/
|
||||
|
|
@ -96,11 +96,11 @@ public abstract class TimeZoneNameProvider extends LocaleServiceProvider {
|
|||
* @param locale the desired locale
|
||||
* @return the human-readable generic name of the given time zone in the
|
||||
* given locale, or {@code null} if it's not available.
|
||||
* @throws IllegalArgumentException if <code>style</code> is invalid,
|
||||
* or <code>locale</code> isn't one of the locales returned from
|
||||
* @throws IllegalArgumentException if {@code style} is invalid,
|
||||
* or {@code locale} isn't one of the locales returned from
|
||||
* {@link LocaleServiceProvider#getAvailableLocales()
|
||||
* getAvailableLocales()}.
|
||||
* @throws NullPointerException if <code>ID</code> or <code>locale</code>
|
||||
* @throws NullPointerException if {@code ID} or {@code locale}
|
||||
* is {@code null}
|
||||
* @since 1.8
|
||||
*/
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue