# HG changeset patch # User darcy # Date 1233348027 28800 # Node ID 5153d540b7a84d2f4cc9e82130a65dbc160f8217 # Parent 23526f724210120e6081dfe7f06284471fbe936a 6799343: (fmt) java.util.Formatter uses plainlink instead of linkplain Reviewed-by: alanb diff -r 23526f724210 -r 5153d540b7a8 jdk/src/share/classes/java/util/Formatter.java --- a/jdk/src/share/classes/java/util/Formatter.java Thu Jan 29 13:04:44 2009 -0800 +++ b/jdk/src/share/classes/java/util/Formatter.java Fri Jan 30 12:40:27 2009 -0800 @@ -59,7 +59,7 @@ * An interpreter for printf-style format strings. This class provides support * for layout justification and alignment, common formats for numeric, string, * and date/time data, and locale-specific output. Common Java types such as - * byte, {@link java.math.BigDecimal BigDecimal}, and {@link Calendar} + * {@code byte}, {@link java.math.BigDecimal BigDecimal}, and {@link Calendar} * are supported. Limited formatting customization for arbitrary user types is * provided through the {@link Formattable} interface. * @@ -68,7 +68,7 @@ * class. * *

Formatted printing for the Java language is heavily inspired by C's - * printf. Although the format strings are similar to C, some + * {@code printf}. Although the format strings are similar to C, some * customizations have been made to accommodate the Java language and exploit * some of its features. Also, Java formatting is more strict than C's; for * example, if a conversion is incompatible with a flag, an exception will be @@ -115,7 +115,7 @@ * // -> "Unable to open file 'food': No such file or directory" * * - *

Like C's sprintf(3), Strings may be formatted using the static + *

Like C's {@code sprintf(3)}, Strings may be formatted using the static * method {@link String#format(String,Object...) String.format}: * *

@@ -157,16 +157,16 @@
  *   String s = String.format("Duke's Birthday: %1$tm %1$te,%1$tY", c);
  *

* - * This format string is the first argument to the format method. It - * contains three format specifiers "%1$tm", "%1$te", and - * "%1$tY" which indicate how the arguments should be processed and + * This format string is the first argument to the {@code format} method. It + * contains three format specifiers "{@code %1$tm}", "{@code %1$te}", and + * "{@code %1$tY}" which indicate how the arguments should be processed and * where they should be inserted in the text. The remaining portions of the - * format string are fixed text including "Dukes Birthday: " and any + * format string are fixed text including {@code "Dukes Birthday: "} and any * other spaces or punctuation. * * The argument list consists of all arguments passed to the method after the * format string. In the above example, the argument list is of size one and - * consists of the {@link java.util.Calendar Calendar} object c. + * consists of the {@link java.util.Calendar Calendar} object {@code c}. * *

The optional argument_index is a decimal integer indicating the * position of the argument in the argument list. The first argument is - * referenced by "1$", the second by "2$", etc. + * referenced by "{@code 1$}", the second by "{@code 2$}", etc. * *

The optional flags is a set of characters that modify the output * format. The set of valid flags depends on the conversion. @@ -206,10 +206,10 @@ * defined as above. * *

The required conversion is a two character sequence. The first - * character is 't' or 'T'. The second character indicates + * character is {@code 't'} or {@code 'T'}. The second character indicates * the format to be used. These characters are similar to but not completely - * identical to those defined by GNU date and POSIX - * strftime(3c). + * identical to those defined by GNU {@code date} and POSIX + * {@code strftime(3c)}. * *

The format specifiers which do not correspond to arguments have the * following syntax: @@ -235,31 +235,31 @@ * type * *
Character - may be applied to basic types which represent - * Unicode characters: char, {@link Character}, byte, {@link - * Byte}, short, and {@link Short}. This conversion may also be - * applied to the types int and {@link Integer} when {@link - * Character#isValidCodePoint} returns true + * Unicode characters: {@code char}, {@link Character}, {@code byte}, {@link + * Byte}, {@code short}, and {@link Short}. This conversion may also be + * applied to the types {@code int} and {@link Integer} when {@link + * Character#isValidCodePoint} returns {@code true} * *
Numeric * *
1. Integral - may be applied to Java integral types: byte, - * {@link Byte}, short, {@link Short}, int and {@link - * Integer}, long, {@link Long}, and {@link java.math.BigInteger + *
2. Integral - may be applied to Java integral types: {@code byte}, + * {@link Byte}, {@code short}, {@link Short}, {@code int} and {@link + * Integer}, {@code long}, {@link Long}, and {@link java.math.BigInteger * BigInteger} * *
3. Floating Point - may be applied to Java floating-point types: - * float, {@link Float}, double, {@link Double}, and {@link + * {@code float}, {@link Float}, {@code double}, {@link Double}, and {@link * java.math.BigDecimal BigDecimal} * *
* *
Date/Time - may be applied to Java types which are capable of - * encoding a date or time: long, {@link Long}, {@link Calendar}, and + * encoding a date or time: {@code long}, {@link Long}, {@link Calendar}, and * {@link Date}. * - *
Percent - produces a literal '%' + *
Percent - produces a literal {@code '%'} * ('\u0025') * *

Line Separator - produces the platform-specific line separator @@ -267,9 +267,9 @@ * * *

The following table summarizes the supported conversions. Conversions - * denoted by an upper-case character (i.e. 'B', 'H', - * 'S', 'C', 'X', 'E', 'G', - * 'A', and 'T') are the same as those for the corresponding + * denoted by an upper-case character (i.e. {@code 'B'}, {@code 'H'}, + * {@code 'S'}, {@code 'C'}, {@code 'X'}, {@code 'E'}, {@code 'G'}, + * {@code 'A'}, and {@code 'T'}) are the same as those for the corresponding * lower-case conversion characters except that the result is converted to * upper case according to the rules of the prevailing {@link java.util.Locale * Locale}. The result is equivalent to the following invocation of {@link @@ -284,72 +284,72 @@ * Argument Category * Description * - * 'b', 'B' + * {@code 'b'}, {@code 'B'} * general - * If the argument arg is null, then the result is - * "false". If arg is a boolean or {@link + * If the argument arg is {@code null}, then the result is + * "{@code false}". If arg is a {@code boolean} or {@link * Boolean}, then the result is the string returned by {@link * String#valueOf(boolean) String.valueOf(arg)}. Otherwise, the result is * "true". * - * 'h', 'H' + * {@code 'h'}, {@code 'H'} * general - * If the argument arg is null, then the result is - * "null". Otherwise, the result is obtained by invoking - * Integer.toHexString(arg.hashCode()). - * - * 's', 'S' + * If the argument arg is {@code null}, then the result is + * "{@code null}". Otherwise, the result is obtained by invoking + * {@code Integer.toHexString(arg.hashCode())}. + * + * {@code 's'}, {@code 'S'} * general - * If the argument arg is null, then the result is - * "null". If arg implements {@link Formattable}, then + * If the argument arg is {@code null}, then the result is + * "{@code null}". If arg implements {@link Formattable}, then * {@link Formattable#formatTo arg.formatTo} is invoked. Otherwise, the - * result is obtained by invoking arg.toString(). - * - * 'c', 'C' + * result is obtained by invoking {@code arg.toString()}. + * + * {@code 'c'}, {@code 'C'} * character * The result is a Unicode character * - * 'd' + * {@code 'd'} * integral * The result is formatted as a decimal integer * - * 'o' + * {@code 'o'} * integral * The result is formatted as an octal integer * - * 'x', 'X' + * {@code 'x'}, {@code 'X'} * integral * The result is formatted as a hexadecimal integer * - * 'e', 'E' + * {@code 'e'}, {@code 'E'} * floating point * The result is formatted as a decimal number in computerized * scientific notation * - * 'f' + * {@code 'f'} * floating point * The result is formatted as a decimal number * - * 'g', 'G' + * {@code 'g'}, {@code 'G'} * floating point * The result is formatted using computerized scientific notation or * decimal format, depending on the precision and the value after rounding. * - * 'a', 'A' + * {@code 'a'}, {@code 'A'} * floating point * The result is formatted as a hexadecimal floating-point number with * a significand and an exponent * - * 't', 'T' + * {@code 't'}, {@code 'T'} * date/time * Prefix for date and time conversion characters. See Date/Time Conversions. * - * '%' + * {@code '%'} * percent - * The result is a literal '%' ('\u0025') - * - * 'n' + * The result is a literal {@code '%'} ('\u0025') + * + * {@code 'n'} * line separator * The result is the platform-specific line separator * @@ -361,78 +361,78 @@ *

Date/Time Conversions

* *

The following date and time conversion suffix characters are defined for - * the 't' and 'T' conversions. The types are similar to but - * not completely identical to those defined by GNU date and POSIX - * strftime(3c). Additional conversion types are provided to access - * Java-specific functionality (e.g. 'L' for milliseconds within the + * the {@code 't'} and {@code 'T'} conversions. The types are similar to but + * not completely identical to those defined by GNU {@code date} and POSIX + * {@code strftime(3c)}. Additional conversion types are provided to access + * Java-specific functionality (e.g. {@code 'L'} for milliseconds within the * second). * *

The following conversion characters are used for formatting times: * * * - *
'H' + *
{@code 'H'} * Hour of the day for the 24-hour clock, formatted as two digits with - * a leading zero as necessary i.e. 00 - 23. - * - *
'I' + * a leading zero as necessary i.e. {@code 00 - 23}. + * + *
{@code 'I'} * Hour for the 12-hour clock, formatted as two digits with a leading - * zero as necessary, i.e. 01 - 12. - * - *
'k' - * Hour of the day for the 24-hour clock, i.e. 0 - 23. - * - *
'l' - * Hour for the 12-hour clock, i.e. 1 - 12. - * - *
'M' + * zero as necessary, i.e. {@code 01 - 12}. + * + *
{@code 'k'} + * Hour of the day for the 24-hour clock, i.e. {@code 0 - 23}. + * + *
{@code 'l'} + * Hour for the 12-hour clock, i.e. {@code 1 - 12}. + * + *
{@code 'M'} * Minute within the hour formatted as two digits with a leading zero - * as necessary, i.e. 00 - 59. - * - *
'S' + * as necessary, i.e. {@code 00 - 59}. + * + *
{@code 'S'} * Seconds within the minute, formatted as two digits with a leading - * zero as necessary, i.e. 00 - 60 ("60" is a special + * zero as necessary, i.e. {@code 00 - 60} ("{@code 60}" is a special * value required to support leap seconds). * - *
'L' + *
{@code 'L'} * Millisecond within the second formatted as three digits with - * leading zeros as necessary, i.e. 000 - 999. - * - *
'N' + * leading zeros as necessary, i.e. {@code 000 - 999}. + * + *
{@code 'N'} * Nanosecond within the second, formatted as nine digits with leading - * zeros as necessary, i.e. 000000000 - 999999999. - * - *
'p' + * zeros as necessary, i.e. {@code 000000000 - 999999999}. + * + *
{@code 'p'} * Locale-specific {@linkplain * java.text.DateFormatSymbols#getAmPmStrings morning or afternoon} marker - * in lower case, e.g."am" or "pm". Use of the conversion - * prefix 'T' forces this output to upper case. - * - *
'z' + * in lower case, e.g."{@code am}" or "{@code pm}". Use of the conversion + * prefix {@code 'T'} forces this output to upper case. + * + *
{@code 'z'} * RFC 822 - * style numeric time zone offset from GMT, e.g. -0800. This + * style numeric time zone offset from GMT, e.g. {@code -0800}. This * value will be adjusted as necessary for Daylight Saving Time. For - * long, {@link Long}, and {@link Date} the time zone used is - * the {@plainlink TimeZone#getDefault() default time zone} for this + * {@code long}, {@link Long}, and {@link Date} the time zone used is + * the {@linkplain TimeZone#getDefault() default time zone} for this * instance of the Java virtual machine. * - *
'Z' + *
{@code 'Z'} * A string representing the abbreviation for the time zone. This * value will be adjusted as necessary for Daylight Saving Time. For - * long, {@link Long}, and {@link Date} the time zone used is - * the {@plainlink TimeZone#getDefault() default time zone} for this + * {@code long}, {@link Long}, and {@link Date} the time zone used is + * the {@linkplain TimeZone#getDefault() default time zone} for this * instance of the Java virtual machine. The Formatter's locale will * supersede the locale of the argument (if any). * - *
's' + *
{@code 's'} * Seconds since the beginning of the epoch starting at 1 January 1970 - * 00:00:00 UTC, i.e. Long.MIN_VALUE/1000 to - * Long.MAX_VALUE/1000. - * - *
'Q' + * {@code 00:00:00} UTC, i.e. {@code Long.MIN_VALUE/1000} to + * {@code Long.MAX_VALUE/1000}. + * + *
{@code 'Q'} * Milliseconds since the beginning of the epoch starting at 1 January - * 1970 00:00:00 UTC, i.e. Long.MIN_VALUE to - * Long.MAX_VALUE. + * 1970 {@code 00:00:00} UTC, i.e. {@code Long.MIN_VALUE} to + * {@code Long.MAX_VALUE}. * *
* @@ -440,55 +440,55 @@ * * * - *
'B' + *
{@code 'B'} * Locale-specific {@linkplain java.text.DateFormatSymbols#getMonths - * full month name}, e.g. "January", "February". - * - *
'b' + * full month name}, e.g. {@code "January"}, {@code "February"}. + * + *
{@code 'b'} * Locale-specific {@linkplain * java.text.DateFormatSymbols#getShortMonths abbreviated month name}, - * e.g. "Jan", "Feb". - * - *
'h' - * Same as 'b'. - * - *
'A' + * e.g. {@code "Jan"}, {@code "Feb"}. + * + *
{@code 'h'} + * Same as {@code 'b'}. + * + *
{@code 'A'} * Locale-specific full name of the {@linkplain * java.text.DateFormatSymbols#getWeekdays day of the week}, - * e.g. "Sunday", "Monday" - * - *
'a' + * e.g. {@code "Sunday"}, {@code "Monday"} + * + *
{@code 'a'} * Locale-specific short name of the {@linkplain * java.text.DateFormatSymbols#getShortWeekdays day of the week}, - * e.g. "Sun", "Mon" - * - *
'C' - * Four-digit year divided by 100, formatted as two digits - * with leading zero as necessary, i.e. 00 - 99 - * - *
'Y' + * e.g. {@code "Sun"}, {@code "Mon"} + * + *
{@code 'C'} + * Four-digit year divided by {@code 100}, formatted as two digits + * with leading zero as necessary, i.e. {@code 00 - 99} + * + *
{@code 'Y'} * Year, formatted as at least four digits with leading zeros as - * necessary, e.g. 0092 equals 92 CE for the Gregorian + * necessary, e.g. {@code 0092} equals {@code 92} CE for the Gregorian * calendar. * - *
'y' + *
{@code 'y'} * Last two digits of the year, formatted with leading zeros as - * necessary, i.e. 00 - 99. - * - *
'j' + * necessary, i.e. {@code 00 - 99}. + * + *
{@code 'j'} * Day of year, formatted as three digits with leading zeros as - * necessary, e.g. 001 - 366 for the Gregorian calendar. - * - *
'm' + * necessary, e.g. {@code 001 - 366} for the Gregorian calendar. + * + *
{@code 'm'} * Month, formatted as two digits with leading zeros as necessary, - * i.e. 01 - 13. - * - *
'd' + * i.e. {@code 01 - 13}. + * + *
{@code 'd'} * Day of month, formatted as two digits with leading zeros as - * necessary, i.e. 01 - 31 - * - *
'e' - * Day of month, formatted as two digits, i.e. 1 - 31. + * necessary, i.e. {@code 01 - 31} + * + *
{@code 'e'} + * Day of month, formatted as two digits, i.e. {@code 1 - 31}. * *
* @@ -497,27 +497,27 @@ * * * - *
'R' - * Time formatted for the 24-hour clock as "%tH:%tM" - * - *
'T' - * Time formatted for the 24-hour clock as "%tH:%tM:%tS". - * - *
'r' - * Time formatted for the 12-hour clock as "%tI:%tM:%tS %Tp". - * The location of the morning or afternoon marker ('%Tp') may be + *
{@code 'R'} + * Time formatted for the 24-hour clock as {@code "%tH:%tM"} + * + *
{@code 'T'} + * Time formatted for the 24-hour clock as {@code "%tH:%tM:%tS"}. + * + *
{@code 'r'} + * Time formatted for the 12-hour clock as {@code "%tI:%tM:%tS %Tp"}. + * The location of the morning or afternoon marker ({@code '%Tp'}) may be * locale-dependent. * - *
'D' - * Date formatted as "%tm/%td/%ty". - * - *
'F' + *
{@code 'D'} + * Date formatted as {@code "%tm/%td/%ty"}. + * + *
{@code 'F'} * ISO 8601 - * complete date formatted as "%tY-%tm-%td". - * - *
'c' - * Date and time formatted as "%ta %tb %td %tT %tZ %tY", - * e.g. "Sun Jul 20 16:17:00 EDT 1969". + * complete date formatted as {@code "%tY-%tm-%td"}. + * + *
{@code 'c'} + * Date and time formatted as {@code "%ta %tb %td %tT %tZ %tY"}, + * e.g. {@code "Sun Jul 20 16:17:00 EDT 1969"}. * *
* @@ -591,18 +591,18 @@ * *

¹ Depends on the definition of {@link Formattable}. * - *

² For 'd' conversion only. - * - *

³ For 'o', 'x', and 'X' + *

² For {@code 'd'} conversion only. + * + *

³ For {@code 'o'}, {@code 'x'}, and {@code 'X'} * conversions only. * - *

⁴ For 'd', 'o', 'x', and - * 'X' conversions applied to {@link java.math.BigInteger BigInteger} - * or 'd' applied to byte, {@link Byte}, short, {@link - * Short}, int and {@link Integer}, long, and {@link Long}. - * - *

⁵ For 'e', 'E', 'f', - * 'g', and 'G' conversions only. + *

⁴ For {@code 'd'}, {@code 'o'}, {@code 'x'}, and + * {@code 'X'} conversions applied to {@link java.math.BigInteger BigInteger} + * or {@code 'd'} applied to {@code byte}, {@link Byte}, {@code short}, {@link + * Short}, {@code int} and {@link Integer}, {@code long}, and {@link Long}. + * + *

⁵ For {@code 'e'}, {@code 'E'}, {@code 'f'}, + * {@code 'g'}, and {@code 'G'} conversions only. * *

Any characters not explicitly defined as flags are illegal and are * reserved for future extensions. @@ -618,11 +618,11 @@ *

For general argument types, the precision is the maximum number of * characters to be written to the output. * - *

For the floating-point conversions 'e', 'E', and - * 'f' the precision is the number of digits after the decimal - * separator. If the conversion is 'g' or 'G', then the + *

For the floating-point conversions {@code 'e'}, {@code 'E'}, and + * {@code 'f'} the precision is the number of digits after the decimal + * separator. If the conversion is {@code 'g'} or {@code 'G'}, then the * precision is the total number of digits in the resulting magnitude after - * rounding. If the conversion is 'a' or 'A', then the + * rounding. If the conversion is {@code 'a'} or {@code 'A'}, then the * precision must not be specified. * *

For character, integral, and date/time argument types and the percent @@ -633,10 +633,10 @@ * *

The argument index is a decimal integer indicating the position of the * argument in the argument list. The first argument is referenced by - * "1$", the second by "2$", etc. + * "{@code 1$}", the second by "{@code 2$}", etc. * *

Another way to reference arguments by position is to use the - * '<' ('\u003c') flag, which causes the argument for + * {@code '<'} ('\u003c') flag, which causes the argument for * the previous format specifier to be re-used. For example, the following two * statements would produce identical strings: * @@ -670,14 +670,14 @@ * applicable to the corresponding argument, then an {@link * IllegalFormatConversionException} will be thrown. * - *

All specified exceptions may be thrown by any of the format - * methods of Formatter as well as by any format convenience + *

All specified exceptions may be thrown by any of the {@code format} + * methods of {@code Formatter} as well as by any {@code format} convenience * methods such as {@link String#format(String,Object...) String.format} and * {@link java.io.PrintStream#printf(String,Object...) PrintStream.printf}. * - *

Conversions denoted by an upper-case character (i.e. 'B', - * 'H', 'S', 'C', 'X', 'E', - * 'G', 'A', and 'T') are the same as those for the + *

Conversions denoted by an upper-case character (i.e. {@code 'B'}, + * {@code 'H'}, {@code 'S'}, {@code 'C'}, {@code 'X'}, {@code 'E'}, + * {@code 'G'}, {@code 'A'}, and {@code 'T'}) are the same as those for the * corresponding lower-case conversion characters except that the result is * converted to upper case according to the rules of the prevailing {@link * java.util.Locale Locale}. The result is equivalent to the following @@ -692,56 +692,56 @@ * * * - *
'b' + *
{@code 'b'} * '\u0062' - * Produces either "true" or "false" as returned by + * Produces either "{@code true}" or "{@code false}" as returned by * {@link Boolean#toString(boolean)}. * - *
If the argument is null, then the result is - * "false". If the argument is a boolean or {@link + *
If the argument is {@code null}, then the result is + * "{@code false}". If the argument is a {@code boolean} or {@link * Boolean}, then the result is the string returned by {@link * String#valueOf(boolean) String.valueOf()}. Otherwise, the result is - * "true". - * - *
If the '#' flag is given, then a {@link + * "{@code true}". + * + *
If the {@code '#'} flag is given, then a {@link * FormatFlagsConversionMismatchException} will be thrown. * - *
'B' + *
{@code 'B'} * '\u0042' - * The upper-case variant of 'b'. - * - *
'h' + * The upper-case variant of {@code 'b'}. + * + *
{@code 'h'} * '\u0068' * Produces a string representing the hash code value of the object. * - *
If the argument, arg is null, then the - * result is "null". Otherwise, the result is obtained - * by invoking Integer.toHexString(arg.hashCode()). - * - *
If the '#' flag is given, then a {@link + *
If the argument, arg is {@code null}, then the + * result is "{@code null}". Otherwise, the result is obtained + * by invoking {@code Integer.toHexString(arg.hashCode())}. + * + *
If the {@code '#'} flag is given, then a {@link * FormatFlagsConversionMismatchException} will be thrown. * - *
'H' + *
{@code 'H'} * '\u0048' - * The upper-case variant of 'h'. - * - *
's' + * The upper-case variant of {@code 'h'}. + * + *
{@code 's'} * '\u0073' * Produces a string. * - *
If the argument is null, then the result is - * "null". If the argument implements {@link Formattable}, then + *
If the argument is {@code null}, then the result is + * "{@code null}". If the argument implements {@link Formattable}, then * its {@link Formattable#formatTo formatTo} method is invoked. * Otherwise, the result is obtained by invoking the argument's - * toString() method. - * - *
If the '#' flag is given and the argument is not a {@link + * {@code toString()} method. + * + *
If the {@code '#'} flag is given and the argument is not a {@link * Formattable} , then a {@link FormatFlagsConversionMismatchException} * will be thrown. * - *
'S' + *
{@code 'S'} * '\u0053' - * The upper-case variant of 's'. + * The upper-case variant of {@code 's'}. * *
* @@ -749,7 +749,7 @@ * * * - *
'-' + *
{@code '-'} * '\u002d' * Left justifies the output. Spaces ('\u0020') will be * added at the end of the converted value as required to fill the minimum @@ -757,7 +757,7 @@ * MissingFormatWidthException} will be thrown. If this flag is not given * then the output will be right-justified. * - *
'#' + *
{@code '#'} * '\u0023' * Requires the output use an alternate form. The definition of the * form is specified by the conversion. @@ -767,47 +767,47 @@ *
The width is the minimum number of characters to * be written to the * output. If the length of the converted value is less than the width then - * the output will be padded by '  ' (\u0020') + * the output will be padded by '  ' ('\u0020') * until the total number of characters equals the width. The padding is on - * the left by default. If the '-' flag is given, then the padding + * the left by default. If the {@code '-'} flag is given, then the padding * will be on the right. If the width is not specified then there is no * minimum. * *
The precision is the maximum number of characters to be written to the * output. The precision is applied before the width, thus the output will be - * truncated to precision characters even if the width is greater than + * truncated to {@code precision} characters even if the width is greater than * the precision. If the precision is not specified then there is no explicit * limit on the number of characters. * *
Character
* - * This conversion may be applied to char and {@link Character}. It - * may also be applied to the types byte, {@link Byte}, - * short, and {@link Short}, int and {@link Integer} when - * {@link Character#isValidCodePoint} returns true. If it returns - * false then an {@link IllegalFormatCodePointException} will be + * This conversion may be applied to {@code char} and {@link Character}. It + * may also be applied to the types {@code byte}, {@link Byte}, + * {@code short}, and {@link Short}, {@code int} and {@link Integer} when + * {@link Character#isValidCodePoint} returns {@code true}. If it returns + * {@code false} then an {@link IllegalFormatCodePointException} will be * thrown. * * * - *
'c' + *
{@code 'c'} * '\u0063' * Formats the argument as a Unicode character as described in Unicode Character - * Representation. This may be more than one 16-bit char in + * Representation. This may be more than one 16-bit {@code char} in * the case where the argument represents a supplementary character. * - *
If the '#' flag is given, then a {@link + *
If the {@code '#'} flag is given, then a {@link * FormatFlagsConversionMismatchException} will be thrown. * - *
'C' + *
{@code 'C'} * '\u0043' - * The upper-case variant of 'c'. + * The upper-case variant of {@code 'c'}. * *
* - *
The '-' flag defined for General - * conversions applies. If the '#' flag is given, then a {@link + *
The {@code '-'} flag defined for General + * conversions applies. If the {@code '#'} flag is given, then a {@link * FormatFlagsConversionMismatchException} will be thrown. * *
The width is defined as for General conversions. @@ -844,14 +844,14 @@ *
Each digit character d in the string is replaced by a * locale-specific digit computed relative to the current locale's * {@linkplain java.text.DecimalFormatSymbols#getZeroDigit() zero digit} - * z; that is d - '0' + * z; that is d - {@code '0'} * + z. * *
If a decimal separator is present, a locale-specific {@linkplain * java.text.DecimalFormatSymbols#getDecimalSeparator decimal separator} is * substituted. * - *
If the ',' ('\u002c') + *
If the {@code ','} ('\u002c') * flag is given, then the locale-specific {@linkplain * java.text.DecimalFormatSymbols#getGroupingSeparator grouping separator} is * inserted by scanning the integer part of the string from least significant @@ -859,111 +859,111 @@ * the locale's {@linkplain java.text.DecimalFormat#getGroupingSize() grouping * size}. * - *
If the '0' flag is given, then the locale-specific {@linkplain + *
If the {@code '0'} flag is given, then the locale-specific {@linkplain * java.text.DecimalFormatSymbols#getZeroDigit() zero digits} are inserted * after the sign character, if any, and before the first non-zero digit, until * the length of the string is equal to the requested field width. * - *
If the value is negative and the '(' flag is given, then a - * '(' ('\u0028') is prepended and a ')' + *
If the value is negative and the {@code '('} flag is given, then a + * {@code '('} ('\u0028') is prepended and a {@code ')'} * ('\u0029') is appended. * *
If the value is negative (or floating-point negative zero) and - * '(' flag is not given, then a '-' ('\u002d') + * {@code '('} flag is not given, then a {@code '-'} ('\u002d') * is prepended. * - *
If the '+' flag is given and the value is positive or zero (or - * floating-point positive zero), then a '+' ('\u002b') + *
If the {@code '+'} flag is given and the value is positive or zero (or + * floating-point positive zero), then a {@code '+'} ('\u002b') * will be prepended. * * * *
If the value is NaN or positive infinity the literal strings "NaN" or * "Infinity" respectively, will be output. If the value is negative infinity, - * then the output will be "(Infinity)" if the '(' flag is given + * then the output will be "(Infinity)" if the {@code '('} flag is given * otherwise the output will be "-Infinity". These values are not localized. * *
Byte, Short, Integer, and Long * - *
The following conversions may be applied to byte, {@link Byte}, - * short, {@link Short}, int and {@link Integer}, - * long, and {@link Long}. + *
The following conversions may be applied to {@code byte}, {@link Byte}, + * {@code short}, {@link Short}, {@code int} and {@link Integer}, + * {@code long}, and {@link Long}. * * * - *
'd' + *
{@code 'd'} * '\u0054' * Formats the argument as a decimal integer. The localization algorithm is applied. * - *
If the '0' flag is given and the value is negative, then + *
If the {@code '0'} flag is given and the value is negative, then * the zero padding will occur after the sign. * - *
If the '#' flag is given then a {@link + *
If the {@code '#'} flag is given then a {@link * FormatFlagsConversionMismatchException} will be thrown. * - *
'o' + *
{@code 'o'} * '\u006f' * Formats the argument as an integer in base eight. No localization * is applied. * *
If x is negative then the result will be an unsigned value - * generated by adding 2ⁿ to the value where n is the - * number of bits in the type as returned by the static SIZE field + * generated by adding 2ⁿ to the value where {@code n} is the + * number of bits in the type as returned by the static {@code SIZE} field * in the {@linkplain Byte#SIZE Byte}, {@linkplain Short#SIZE Short}, * {@linkplain Integer#SIZE Integer}, or {@linkplain Long#SIZE Long} * classes as appropriate. * - *
If the '#' flag is given then the output will always begin - * with the radix indicator '0'. - * - *
If the '0' flag is given then the output will be padded + *
If the {@code '#'} flag is given then the output will always begin + * with the radix indicator {@code '0'}. + * + *
If the {@code '0'} flag is given then the output will be padded * with leading zeros to the field width following any indication of sign. * - *
If '(', '+', '  ', or ',' flags + *
If {@code '('}, {@code '+'}, '  ', or {@code ','} flags * are given then a {@link FormatFlagsConversionMismatchException} will be * thrown. * - *
'x' + *
{@code 'x'} * '\u0078' * Formats the argument as an integer in base sixteen. No * localization is applied. * *
If x is negative then the result will be an unsigned value - * generated by adding 2ⁿ to the value where n is the - * number of bits in the type as returned by the static SIZE field + * generated by adding 2ⁿ to the value where {@code n} is the + * number of bits in the type as returned by the static {@code SIZE} field * in the {@linkplain Byte#SIZE Byte}, {@linkplain Short#SIZE Short}, * {@linkplain Integer#SIZE Integer}, or {@linkplain Long#SIZE Long} * classes as appropriate. * - *
If the '#' flag is given then the output will always begin - * with the radix indicator "0x". - * - *
If the '0' flag is given then the output will be padded to + *
If the {@code '#'} flag is given then the output will always begin + * with the radix indicator {@code "0x"}. + * + *
If the {@code '0'} flag is given then the output will be padded to * the field width with leading zeros after the radix indicator or sign (if * present). * - *
If '(', '  ', '+', or - * ',' flags are given then a {@link + *
If {@code '('}, '  ', {@code '+'}, or + * {@code ','} flags are given then a {@link * FormatFlagsConversionMismatchException} will be thrown. * - *
'X' + *
{@code 'X'} * '\u0058' - * The upper-case variant of 'x'. The entire string + * The upper-case variant of {@code 'x'}. The entire string * representing the number will be converted to {@linkplain - * String#toUpperCase upper case} including the 'x' (if any) and - * all hexadecimal digits 'a' - 'f' + * String#toUpperCase upper case} including the {@code 'x'} (if any) and + * all hexadecimal digits {@code 'a'} - {@code 'f'} * ('\u0061' - '\u0066'). * *
* - *
If the conversion is 'o', 'x', or 'X' and - * both the '#' and the '0' flags are given, then result will - * contain the radix indicator ('0' for octal and "0x" or - * "0X" for hexadecimal), some number of zeros (based on the width), + *
If the conversion is {@code 'o'}, {@code 'x'}, or {@code 'X'} and + * both the {@code '#'} and the {@code '0'} flags are given, then result will + * contain the radix indicator ({@code '0'} for octal and {@code "0x"} or + * {@code "0X"} for hexadecimal), some number of zeros (based on the width), * and the value. * - *
If the '-' flag is not given, then the space padding will occur + *
If the {@code '-'} flag is not given, then the space padding will occur * before the sign. * *
The following flags apply to numeric integral @@ -971,13 +971,13 @@ * * * - *
'+' + *
{@code '+'} * '\u002b' * Requires the output to include a positive sign for all positive * numbers. If this flag is not given then only negative values will * include a sign. * - *
If both the '+' and '  ' flags are given + *
If both the {@code '+'} and '  ' flags are given * then an {@link IllegalFormatFlagsException} will be thrown. * *
'  ' @@ -985,10 +985,10 @@ * Requires the output to include a single extra space * ('\u0020') for non-negative values. * - *
If both the '+' and '  ' flags are given + *
If both the {@code '+'} and '  ' flags are given * then an {@link IllegalFormatFlagsException} will be thrown. * - *
'0' + *
{@code '0'} * '\u0030' * Requires the output to be padded with leading {@linkplain * java.text.DecimalFormatSymbols#getZeroDigit zeros} to the minimum field @@ -996,20 +996,20 @@ * or infinity. If the width is not provided, then a {@link * MissingFormatWidthException} will be thrown. * - *
If both the '-' and '0' flags are given then an + *
If both the {@code '-'} and {@code '0'} flags are given then an * {@link IllegalFormatFlagsException} will be thrown. * - *
',' + *
{@code ','} * '\u002c' * Requires the output to include the locale-specific {@linkplain * java.text.DecimalFormatSymbols#getGroupingSeparator group separators} as * described in the "group" section of the * localization algorithm. * - *
'(' + *
{@code '('} * '\u0028' - * Requires the output to prepend a '(' - * ('\u0028') and append a ')' + * Requires the output to prepend a {@code '('} + * ('\u0028') and append a {@code ')'} * ('\u0029') to negative values. * *
@@ -1019,9 +1019,9 @@ * *
* - *
The output is right-justified within the width - * - *
Negative numbers begin with a '-' ('\u002d') + *
The output is right-justified within the {@code width} + * + *
Negative numbers begin with a {@code '-'} ('\u002d') * *
Positive numbers and zero do not include a sign or extra leading * space @@ -1035,7 +1035,7 @@ * separators, radix indicator, and parentheses. If the length of the * converted value is less than the width then the output will be padded by * spaces ('\u0020') until the total number of characters equals - * width. The padding is on the left by default. If '-' flag is + * width. The padding is on the left by default. If {@code '-'} flag is * given then the padding will be on the right. If width is not specified then * there is no minimum. * @@ -1049,81 +1049,81 @@ * * * - *
'd' + *
{@code 'd'} * '\u0054' * Requires the output to be formatted as a decimal integer. The localization algorithm is applied. * - *
If the '#' flag is given {@link + *
If the {@code '#'} flag is given {@link * FormatFlagsConversionMismatchException} will be thrown. * - *
'o' + *
{@code 'o'} * '\u006f' * Requires the output to be formatted as an integer in base eight. * No localization is applied. * *
If x is negative then the result will be a signed value - * beginning with '-' ('\u002d'). Signed output is + * beginning with {@code '-'} ('\u002d'). Signed output is * allowed for this type because unlike the primitive types it is not * possible to create an unsigned equivalent without assuming an explicit * data-type size. * - *
If x is positive or zero and the '+' flag is given - * then the result will begin with '+' ('\u002b'). - * - *
If the '#' flag is given then the output will always begin - * with '0' prefix. - * - *
If the '0' flag is given then the output will be padded + *
If x is positive or zero and the {@code '+'} flag is given + * then the result will begin with {@code '+'} ('\u002b'). + * + *
If the {@code '#'} flag is given then the output will always begin + * with {@code '0'} prefix. + * + *
If the {@code '0'} flag is given then the output will be padded * with leading zeros to the field width following any indication of sign. * - *
If the ',' flag is given then a {@link + *
If the {@code ','} flag is given then a {@link * FormatFlagsConversionMismatchException} will be thrown. * - *
'x' + *
{@code 'x'} * '\u0078' * Requires the output to be formatted as an integer in base * sixteen. No localization is applied. * *
If x is negative then the result will be a signed value - * beginning with '-' ('\u002d'). Signed output is + * beginning with {@code '-'} ('\u002d'). Signed output is * allowed for this type because unlike the primitive types it is not * possible to create an unsigned equivalent without assuming an explicit * data-type size. * - *
If x is positive or zero and the '+' flag is given - * then the result will begin with '+' ('\u002b'). - * - *
If the '#' flag is given then the output will always begin - * with the radix indicator "0x". - * - *
If the '0' flag is given then the output will be padded to + *
If x is positive or zero and the {@code '+'} flag is given + * then the result will begin with {@code '+'} ('\u002b'). + * + *
If the {@code '#'} flag is given then the output will always begin + * with the radix indicator {@code "0x"}. + * + *
If the {@code '0'} flag is given then the output will be padded to * the field width with leading zeros after the radix indicator or sign (if * present). * - *
If the ',' flag is given then a {@link + *
If the {@code ','} flag is given then a {@link * FormatFlagsConversionMismatchException} will be thrown. * - *
'X' + *
{@code 'X'} * '\u0058' - * The upper-case variant of 'x'. The entire string + * The upper-case variant of {@code 'x'}. The entire string * representing the number will be converted to {@linkplain - * String#toUpperCase upper case} including the 'x' (if any) and - * all hexadecimal digits 'a' - 'f' + * String#toUpperCase upper case} including the {@code 'x'} (if any) and + * all hexadecimal digits {@code 'a'} - {@code 'f'} * ('\u0061' - '\u0066'). * *
* - *
If the conversion is 'o', 'x', or 'X' and - * both the '#' and the '0' flags are given, then result will - * contain the base indicator ('0' for octal and "0x" or - * "0X" for hexadecimal), some number of zeros (based on the width), + *
If the conversion is {@code 'o'}, {@code 'x'}, or {@code 'X'} and + * both the {@code '#'} and the {@code '0'} flags are given, then result will + * contain the base indicator ({@code '0'} for octal and {@code "0x"} or + * {@code "0X"} for hexadecimal), some number of zeros (based on the width), * and the value. * - *
If the '0' flag is given and the value is negative, then the + *
If the {@code '0'} flag is given and the value is negative, then the * zero padding will occur after the sign. * - *
If the '-' flag is not given, then the space padding will occur + *
If the {@code '-'} flag is not given, then the space padding will occur * before the sign. * *
All flags defined for Byte, Short, Integer, and @@ -1138,12 +1138,12 @@ * *
Float and Double * - *
The following conversions may be applied to float, {@link - * Float}, double and {@link Double}. + *
The following conversions may be applied to {@code float}, {@link + * Float}, {@code double} and {@link Double}. * * * - *
'e' + *
{@code 'e'} * '\u0065' * Requires the output to be formatted using computerized scientific notation. The If m is positive-zero or negative-zero, then the exponent - * will be "+00". + * will be {@code "+00"}. * *
Otherwise, the result is a string that represents the sign and * magnitude (absolute value) of the argument. The formatting of the sign @@ -1170,7 +1170,7 @@ * that 1 <= a < 10. The magnitude is then represented as the * integer part of a, as a single decimal digit, followed by the * decimal separator followed by decimal digits representing the fractional - * part of a, followed by the exponent symbol 'e' + * part of a, followed by the exponent symbol {@code 'e'} * ('\u0065'), followed by the sign of the exponent, followed * by a representation of n as a decimal integer, as produced by the * method {@link Long#toString(long, int)}, and zero-padded to include at @@ -1178,7 +1178,7 @@ * *
The number of digits in the result for the fractional part of * m or a is equal to the precision. If the precision is not - * specified then the default value is 6. If the precision is less + * specified then the default value is {@code 6}. If the precision is less * than the number of digits which would appear after the decimal point in * the string returned by {@link Float#toString(float)} or {@link * Double#toString(double)} respectively, then the value will be rounded @@ -1188,15 +1188,15 @@ * Float#toString(float)} or {@link Double#toString(double)} as * appropriate. * - *
If the ',' flag is given, then an {@link + *
If the {@code ','} flag is given, then an {@link * FormatFlagsConversionMismatchException} will be thrown. * - *
'E' + *
{@code 'E'} * '\u0045' - * The upper-case variant of 'e'. The exponent symbol - * will be 'E' ('\u0045'). - * - *
'g' + * The upper-case variant of {@code 'e'}. The exponent symbol + * will be {@code 'E'} ('\u0045'). + * + *
{@code 'g'} * '\u0067' * Requires the output to be formatted in general scientific notation * as described below. The localization @@ -1215,17 +1215,17 @@ * *
The total number of significant digits in m is equal to the * precision. If the precision is not specified, then the default value is - * 6. If the precision is 0, then it is taken to be - * 1. - * - *
If the '#' flag is given then an {@link + * {@code 6}. If the precision is {@code 0}, then it is taken to be + * {@code 1}. + * + *
If the {@code '#'} flag is given then an {@link * FormatFlagsConversionMismatchException} will be thrown. * - *
'G' + *
{@code 'G'} * '\u0047' - * The upper-case variant of 'g'. - * - *
'f' + * The upper-case variant of {@code 'g'}. + * + *
{@code 'f'} * '\u0066' * Requires the output to be formatted using decimal * format. The localization algorithm is @@ -1247,7 +1247,7 @@ * *
The number of digits in the result for the fractional part of * m or a is equal to the precision. If the precision is not - * specified then the default value is 6. If the precision is less + * specified then the default value is {@code 6}. If the precision is less * than the number of digits which would appear after the decimal point in * the string returned by {@link Float#toString(float)} or {@link * Double#toString(double)} respectively, then the value will be rounded @@ -1257,7 +1257,7 @@ * Float#toString(float)} or {@link Double#toString(double)} as * appropriate. * - *
'a' + *
{@code 'a'} * '\u0061' * Requires the output to be formatted in hexadecimal exponential * form. No localization is applied. @@ -1266,10 +1266,10 @@ * (absolute value) of the argument x. * *
If x is negative or a negative-zero value then the result - * will begin with '-' ('\u002d'). + * will begin with {@code '-'} ('\u002d'). * *
If x is positive or a positive-zero value and the - * '+' flag is given then the result will begin with '+' + * {@code '+'} flag is given then the result will begin with {@code '+'} * ('\u002b'). * *
The formatting of the magnitude m depends upon its value. @@ -1280,43 +1280,43 @@ * "Infinity", respectively, will be output. * *
If m is zero then it is represented by the string - * "0x0.0p0". - * - *
If m is a double value with a normalized + * {@code "0x0.0p0"}. + * + *
If m is a {@code double} value with a normalized * representation then substrings are used to represent the significand and * exponent fields. The significand is represented by the characters - * "0x1." followed by the hexadecimal representation of the rest + * {@code "0x1."} followed by the hexadecimal representation of the rest * of the significand as a fraction. The exponent is represented by - * 'p' ('\u0070') followed by a decimal string of the + * {@code 'p'} ('\u0070') followed by a decimal string of the * unbiased exponent as if produced by invoking {@link * Integer#toString(int) Integer.toString} on the exponent value. * - *
If m is a double value with a subnormal + *
If m is a {@code double} value with a subnormal * representation then the significand is represented by the characters - * '0x0.' followed by the hexadecimal representation of the rest + * {@code '0x0.'} followed by the hexadecimal representation of the rest * of the significand as a fraction. The exponent is represented by - * 'p-1022'. Note that there must be at least one nonzero digit + * {@code 'p-1022'}. Note that there must be at least one nonzero digit * in a subnormal significand. * * * - *
If the '(' or ',' flags are given, then a {@link + *
If the {@code '('} or {@code ','} flags are given, then a {@link * FormatFlagsConversionMismatchException} will be thrown. * - *
'A' + *
{@code 'A'} * '\u0041' - * The upper-case variant of 'a'. The entire string + * The upper-case variant of {@code 'a'}. The entire string * representing the number will be converted to upper case including the - * 'x' ('\u0078') and 'p' - * ('\u0070' and all hexadecimal digits 'a' - - * 'f' ('\u0061' - '\u0066'). + * {@code 'x'} ('\u0078') and {@code 'p'} + * ('\u0070' and all hexadecimal digits {@code 'a'} - + * {@code 'f'} ('\u0061' - '\u0066'). * *
* *
All flags defined for Byte, Short, Integer, and * Long apply. * - *
If the '#' flag is given, then the decimal separator will + *
If the {@code '#'} flag is given, then the decimal separator will * always be present. * *
If no flags are given the default formatting @@ -1324,9 +1324,9 @@ * *
* - *
The output is right-justified within the width - * - *
Negative numbers begin with a '-' + *
The output is right-justified within the {@code width} + * + *
Negative numbers begin with a {@code '-'} * *
Positive numbers and positive zero do not include a sign or extra * leading space @@ -1344,21 +1344,21 @@ * the length of the converted value is less than the width then the output * will be padded by spaces ('\u0020') until the total number of * characters equals width. The padding is on the left by default. If the - * '-' flag is given then the padding will be on the right. If width + * {@code '-'} flag is given then the padding will be on the right. If width * is not specified then there is no minimum. * - *
If the conversion is 'e', - * 'E' or 'f', then the precision is the number of digits + *
If the conversion is {@code 'e'}, + * {@code 'E'} or {@code 'f'}, then the precision is the number of digits * after the decimal separator. If the precision is not specified, then it is - * assumed to be 6. - * - *
If the conversion is 'g' or 'G', then the precision is + * assumed to be {@code 6}. + * + *
If the conversion is {@code 'g'} or {@code 'G'}, then the precision is * the total number of significant digits in the resulting magnitude after * rounding. If the precision is not specified, then the default value is - * 6. If the precision is 0, then it is taken to be - * 1. - * - *
If the conversion is 'a' or 'A', then the precision + * {@code 6}. If the precision is {@code 0}, then it is taken to be + * {@code 1}. + * + *
If the conversion is {@code 'a'} or {@code 'A'}, then the precision * is the number of hexadecimal digits after the decimal separator. If the * precision is not provided, then all of the digits as returned by {@link * Double#toHexString(double)} will be output. @@ -1370,7 +1370,7 @@ * * * - *
'e' + *
{@code 'e'} * '\u0065' * Requires the output to be formatted using computerized scientific notation. The The formatting of the magnitude m depends upon its value. * *
If m is positive-zero or negative-zero, then the exponent - * will be "+00". + * will be {@code "+00"}. * *
Otherwise, the result is a string that represents the sign and * magnitude (absolute value) of the argument. The formatting of the sign @@ -1393,7 +1393,7 @@ * that 1 <= a < 10. The magnitude is then represented as the * integer part of a, as a single decimal digit, followed by the * decimal separator followed by decimal digits representing the fractional - * part of a, followed by the exponent symbol 'e' + * part of a, followed by the exponent symbol {@code 'e'} * ('\u0065'), followed by the sign of the exponent, followed * by a representation of n as a decimal integer, as produced by the * method {@link Long#toString(long, int)}, and zero-padded to include at @@ -1401,7 +1401,7 @@ * *
The number of digits in the result for the fractional part of * m or a is equal to the precision. If the precision is not - * specified then the default value is 6. If the precision is + * specified then the default value is {@code 6}. If the precision is * less than the number of digits which would appear after the decimal * point in the string returned by {@link Float#toString(float)} or {@link * Double#toString(double)} respectively, then the value will be rounded @@ -1410,15 +1410,15 @@ * For a canonical representation of the value, use {@link * BigDecimal#toString()}. * - *
If the ',' flag is given, then an {@link + *
If the {@code ','} flag is given, then an {@link * FormatFlagsConversionMismatchException} will be thrown. * - *
'E' + *
{@code 'E'} * '\u0045' - * The upper-case variant of 'e'. The exponent symbol - * will be 'E' ('\u0045'). - * - *
'g' + * The upper-case variant of {@code 'e'}. The exponent symbol + * will be {@code 'E'} ('\u0045'). + * + *
{@code 'g'} * '\u0067' * Requires the output to be formatted in general scientific notation * as described below. The localization @@ -1437,17 +1437,17 @@ * *
The total number of significant digits in m is equal to the * precision. If the precision is not specified, then the default value is - * 6. If the precision is 0, then it is taken to be - * 1. - * - *
If the '#' flag is given then an {@link + * {@code 6}. If the precision is {@code 0}, then it is taken to be + * {@code 1}. + * + *
If the {@code '#'} flag is given then an {@link * FormatFlagsConversionMismatchException} will be thrown. * - *
'G' + *
{@code 'G'} * '\u0047' - * The upper-case variant of 'g'. - * - *
'f' + * The upper-case variant of {@code 'g'}. + * + *
{@code 'f'} * '\u0066' * Requires the output to be formatted using decimal * format. The localization algorithm is @@ -1465,7 +1465,7 @@ * *
The number of digits in the result for the fractional part of * m or a is equal to the precision. If the precision is not - * specified then the default value is 6. If the precision is + * specified then the default value is {@code 6}. If the precision is * less than the number of digits which would appear after the decimal * point in the string returned by {@link Float#toString(float)} or {@link * Double#toString(double)} respectively, then the value will be rounded @@ -1479,7 +1479,7 @@ *
All flags defined for Byte, Short, Integer, and * Long apply. * - *
If the '#' flag is given, then the decimal separator will + *
If the {@code '#'} flag is given, then the decimal separator will * always be present. * *
The default behavior when no flags are @@ -1491,114 +1491,114 @@ * *
Date/Time
* - *
This conversion may be applied to long, {@link Long}, {@link + *
This conversion may be applied to {@code long}, {@link Long}, {@link * Calendar}, and {@link Date}. * * * - *
't' + *
{@code 't'} * '\u0074' * Prefix for date and time conversion characters. - *
'T' + *
{@code 'T'} * '\u0054' - * The upper-case variant of 't'. + * The upper-case variant of {@code 't'}. * *
* *
The following date and time conversion character suffixes are defined - * for the 't' and 'T' conversions. The types are similar to - * but not completely identical to those defined by GNU date and - * POSIX strftime(3c). Additional conversion types are provided to - * access Java-specific functionality (e.g. 'L' for milliseconds + * for the {@code 't'} and {@code 'T'} conversions. The types are similar to + * but not completely identical to those defined by GNU {@code date} and + * POSIX {@code strftime(3c)}. Additional conversion types are provided to + * access Java-specific functionality (e.g. {@code 'L'} for milliseconds * within the second). * *
The following conversion characters are used for formatting times: * * * - *
'H' + *
{@code 'H'} * '\u0048' * Hour of the day for the 24-hour clock, formatted as two digits with - * a leading zero as necessary i.e. 00 - 23. 00 + * a leading zero as necessary i.e. {@code 00 - 23}. {@code 00} * corresponds to midnight. * - *
'I' + *
{@code 'I'} * '\u0049' * Hour for the 12-hour clock, formatted as two digits with a leading - * zero as necessary, i.e. 01 - 12. 01 corresponds to + * zero as necessary, i.e. {@code 01 - 12}. {@code 01} corresponds to * one o'clock (either morning or afternoon). * - *
'k' + *
{@code 'k'} * '\u006b' - * Hour of the day for the 24-hour clock, i.e. 0 - 23. - * 0 corresponds to midnight. - * - *
'l' + * Hour of the day for the 24-hour clock, i.e. {@code 0 - 23}. + * {@code 0} corresponds to midnight. + * + *
{@code 'l'} * '\u006c' - * Hour for the 12-hour clock, i.e. 1 - 12. 1 + * Hour for the 12-hour clock, i.e. {@code 1 - 12}. {@code 1} * corresponds to one o'clock (either morning or afternoon). * - *
'M' + *
{@code 'M'} * '\u004d' * Minute within the hour formatted as two digits with a leading zero - * as necessary, i.e. 00 - 59. - * - *
'S' + * as necessary, i.e. {@code 00 - 59}. + * + *
{@code 'S'} * '\u0053' * Seconds within the minute, formatted as two digits with a leading - * zero as necessary, i.e. 00 - 60 ("60" is a special + * zero as necessary, i.e. {@code 00 - 60} ("{@code 60}" is a special * value required to support leap seconds). * - *
'L' + *
{@code 'L'} * '\u004c' * Millisecond within the second formatted as three digits with - * leading zeros as necessary, i.e. 000 - 999. - * - *
'N' + * leading zeros as necessary, i.e. {@code 000 - 999}. + * + *
{@code 'N'} * '\u004e' * Nanosecond within the second, formatted as nine digits with leading - * zeros as necessary, i.e. 000000000 - 999999999. The precision + * zeros as necessary, i.e. {@code 000000000 - 999999999}. The precision * of this value is limited by the resolution of the underlying operating * system or hardware. * - *
'p' + *
{@code 'p'} * '\u0070' * Locale-specific {@linkplain * java.text.DateFormatSymbols#getAmPmStrings morning or afternoon} marker - * in lower case, e.g."am" or "pm". Use of the - * conversion prefix 'T' forces this output to upper case. (Note - * that 'p' produces lower-case output. This is different from - * GNU date and POSIX strftime(3c) which produce + * in lower case, e.g."{@code am}" or "{@code pm}". Use of the + * conversion prefix {@code 'T'} forces this output to upper case. (Note + * that {@code 'p'} produces lower-case output. This is different from + * GNU {@code date} and POSIX {@code strftime(3c)} which produce * upper-case output.) * - *
'z' + *
{@code 'z'} * '\u007a' * RFC 822 - * style numeric time zone offset from GMT, e.g. -0800. This + * style numeric time zone offset from GMT, e.g. {@code -0800}. This * value will be adjusted as necessary for Daylight Saving Time. For - * long, {@link Long}, and {@link Date} the time zone used is - * the {@plainlink TimeZone#getDefault() default time zone} for this + * {@code long}, {@link Long}, and {@link Date} the time zone used is + * the {@linkplain TimeZone#getDefault() default time zone} for this * instance of the Java virtual machine. * - *
'Z' + *
{@code 'Z'} * A string representing the abbreviation for the time zone. This * value will be adjusted as necessary for Daylight Saving Time. For - * long, {@link Long}, and {@link Date} the time zone used is - * the {@plainlink TimeZone#getDefault() default time zone} for this + * {@code long}, {@link Long}, and {@link Date} the time zone used is + * the {@linkplain TimeZone#getDefault() default time zone} for this * instance of the Java virtual machine. The Formatter's locale will * supersede the locale of the argument (if any). * - *
's' + *
{@code 's'} * '\u0073' * Seconds since the beginning of the epoch starting at 1 January 1970 - * 00:00:00 UTC, i.e. Long.MIN_VALUE/1000 to - * Long.MAX_VALUE/1000. - * - *
'Q' + * {@code 00:00:00} UTC, i.e. {@code Long.MIN_VALUE/1000} to + * {@code Long.MAX_VALUE/1000}. + * + *
{@code 'Q'} * '\u004f' * Milliseconds since the beginning of the epoch starting at 1 January - * 1970 00:00:00 UTC, i.e. Long.MIN_VALUE to - * Long.MAX_VALUE. The precision of this value is limited by + * 1970 {@code 00:00:00} UTC, i.e. {@code Long.MIN_VALUE} to + * {@code Long.MAX_VALUE}. The precision of this value is limited by * the resolution of the underlying operating system or hardware. * *
@@ -1607,71 +1607,71 @@ * * * - *
'B' + *
{@code 'B'} * '\u0042' * Locale-specific {@linkplain java.text.DateFormatSymbols#getMonths - * full month name}, e.g. "January", "February". - * - *
'b' + * full month name}, e.g. {@code "January"}, {@code "February"}. + * + *
{@code 'b'} * '\u0062' * Locale-specific {@linkplain * java.text.DateFormatSymbols#getShortMonths abbreviated month name}, - * e.g. "Jan", "Feb". - * - *
'h' + * e.g. {@code "Jan"}, {@code "Feb"}. + * + *
{@code 'h'} * '\u0068' - * Same as 'b'. - * - *
'A' + * Same as {@code 'b'}. + * + *
{@code 'A'} * '\u0041' * Locale-specific full name of the {@linkplain * java.text.DateFormatSymbols#getWeekdays day of the week}, - * e.g. "Sunday", "Monday" - * - *
'a' + * e.g. {@code "Sunday"}, {@code "Monday"} + * + *
{@code 'a'} * '\u0061' * Locale-specific short name of the {@linkplain * java.text.DateFormatSymbols#getShortWeekdays day of the week}, - * e.g. "Sun", "Mon" - * - *
'C' + * e.g. {@code "Sun"}, {@code "Mon"} + * + *
{@code 'C'} * '\u0043' - * Four-digit year divided by 100, formatted as two digits - * with leading zero as necessary, i.e. 00 - 99 - * - *
'Y' + * Four-digit year divided by {@code 100}, formatted as two digits + * with leading zero as necessary, i.e. {@code 00 - 99} + * + *
{@code 'Y'} * '\u0059' Year, formatted to at least - * four digits with leading zeros as necessary, e.g. 0092 equals - * 92 CE for the Gregorian calendar. - * - *
'y' + * four digits with leading zeros as necessary, e.g. {@code 0092} equals + * {@code 92} CE for the Gregorian calendar. + * + *
{@code 'y'} * '\u0079' * Last two digits of the year, formatted with leading zeros as - * necessary, i.e. 00 - 99. - * - *
'j' + * necessary, i.e. {@code 00 - 99}. + * + *
{@code 'j'} * '\u006a' * Day of year, formatted as three digits with leading zeros as - * necessary, e.g. 001 - 366 for the Gregorian calendar. - * 001 corresponds to the first day of the year. - * - *
'm' + * necessary, e.g. {@code 001 - 366} for the Gregorian calendar. + * {@code 001} corresponds to the first day of the year. + * + *
{@code 'm'} * '\u006d' * Month, formatted as two digits with leading zeros as necessary, - * i.e. 01 - 13, where "01" is the first month of the - * year and ("13" is a special value required to support lunar + * i.e. {@code 01 - 13}, where "{@code 01}" is the first month of the + * year and ("{@code 13}" is a special value required to support lunar * calendars). * - *
'd' + *
{@code 'd'} * '\u0064' * Day of month, formatted as two digits with leading zeros as - * necessary, i.e. 01 - 31, where "01" is the first day + * necessary, i.e. {@code 01 - 31}, where "{@code 01}" is the first day * of the month. * - *
'e' + *
{@code 'e'} * '\u0065' - * Day of month, formatted as two digits, i.e. 1 - 31 where - * "1" is the first day of the month. + * Day of month, formatted as two digits, i.e. {@code 1 - 31} where + * "{@code 1}" is the first day of the month. * *
* @@ -1680,45 +1680,45 @@ * * * - *
'R' + *
{@code 'R'} * '\u0052' - * Time formatted for the 24-hour clock as "%tH:%tM" - * - *
'T' + * Time formatted for the 24-hour clock as {@code "%tH:%tM"} + * + *
{@code 'T'} * '\u0054' - * Time formatted for the 24-hour clock as "%tH:%tM:%tS". - * - *
'r' + * Time formatted for the 24-hour clock as {@code "%tH:%tM:%tS"}. + * + *
{@code 'r'} * '\u0072' - * Time formatted for the 12-hour clock as "%tI:%tM:%tS - * %Tp". The location of the morning or afternoon marker - * ('%Tp') may be locale-dependent. - * - *
'D' + * Time formatted for the 12-hour clock as {@code "%tI:%tM:%tS + * %Tp"}. The location of the morning or afternoon marker + * ({@code '%Tp'}) may be locale-dependent. + * + *
{@code 'D'} * '\u0044' - * Date formatted as "%tm/%td/%ty". - * - *
'F' + * Date formatted as {@code "%tm/%td/%ty"}. + * + *
{@code 'F'} * '\u0046' * ISO 8601 - * complete date formatted as "%tY-%tm-%td". - * - *
'c' + * complete date formatted as {@code "%tY-%tm-%td"}. + * + *
{@code 'c'} * '\u0063' - * Date and time formatted as "%ta %tb %td %tT %tZ %tY", - * e.g. "Sun Jul 20 16:17:00 EDT 1969". + * Date and time formatted as {@code "%ta %tb %td %tT %tZ %tY"}, + * e.g. {@code "Sun Jul 20 16:17:00 EDT 1969"}. * *
* - *
The '-' flag defined for General - * conversions applies. If the '#' flag is given, then a {@link + *
The {@code '-'} flag defined for General + * conversions applies. If the {@code '#'} flag is given, then a {@link * FormatFlagsConversionMismatchException} will be thrown. * *
The width is the minimum number of characters to * be written to the output. If the length of the converted value is less than - * the width then the output will be padded by spaces + * the {@code width} then the output will be padded by spaces * ('\u0020') until the total number of characters equals width. - * The padding is on the left by default. If the '-' flag is given + * The padding is on the left by default. If the {@code '-'} flag is given * then the padding will be on the right. If width is not specified then there * is no minimum. * @@ -1731,17 +1731,17 @@ * * * - *
'%' - * The result is a literal '%' ('\u0025') + *
{@code '%'} + * The result is a literal {@code '%'} ('\u0025') * *
The width is the minimum number of characters to - * be written to the output including the '%'. If the length of the - * converted value is less than the width then the output will be + * be written to the output including the {@code '%'}. If the length of the + * converted value is less than the {@code width} then the output will be * padded by spaces ('\u0020') until the total number of * characters equals width. The padding is on the left. If width is not - * specified then just the '%' is output. - * - *
The '-' flag defined for General + * specified then just the {@code '%'} is output. + * + *
The {@code '-'} flag defined for General * conversions applies. If any other flags are provided, then a * {@link FormatFlagsConversionMismatchException} will be thrown. * @@ -1756,7 +1756,7 @@ * * * - *
'n' + *
{@code 'n'} * the platform-specific line separator as returned by {@link * System#getProperty System.getProperty("line.separator")}. * @@ -1775,7 +1775,7 @@ *
Explicit indexing is used when the format specifier contains an * argument index. The argument index is a decimal integer indicating the * position of the argument in the argument list. The first argument is - * referenced by "1$", the second by "2$", etc. An argument + * referenced by "{@code 1$}", the second by "{@code 2$}", etc. An argument * may be referenced more than once. * *
For example: @@ -1787,7 +1787,7 @@ * * *
Relative indexing is used when the format specifier contains a - * '<' ('\u003c') flag which causes the argument for + * {@code '<'} ('\u003c') flag which causes the argument for * the previous format specifier to be re-used. If there is no previous * argument, then a {@link MissingFormatArgumentException} is thrown. * @@ -1798,7 +1798,7 @@ * * *
Ordinary indexing is used when the format specifier contains - * neither an argument index nor a '<' flag. Each format specifier + * neither an argument index nor a {@code '<'} flag. Each format specifier * which uses ordinary indexing is assigned a sequential implicit index into * argument list which is independent of the indices used by explicit or * relative indexing. @@ -1828,7 +1828,7 @@ *
If there are more arguments than format specifiers, the extra arguments * are ignored. * - *
Unless otherwise specified, passing a null argument to any + *
Unless otherwise specified, passing a {@code null} argument to any * method or constructor in this class will cause a {@link * NullPointerException} to be thrown. * @@ -1876,8 +1876,8 @@ * locale} for this instance of the Java virtual machine. * * @param a - * Destination for the formatted output. If a is - * null then a {@link StringBuilder} will be created. + * Destination for the formatted output. If {@code a} is + * {@code null} then a {@link StringBuilder} will be created. */ public Formatter(Appendable a) { if (a == null) @@ -1895,7 +1895,7 @@ * * @param l * The {@linkplain java.util.Locale locale} to apply during - * formatting. If l is null then no localization + * formatting. If {@code l} is {@code null} then no localization * is applied. */ public Formatter(Locale l) { @@ -1906,12 +1906,12 @@ * Constructs a new formatter with the specified destination and locale. * * @param a - * Destination for the formatted output. If a is - * null then a {@link StringBuilder} will be created. + * Destination for the formatted output. If {@code a} is + * {@code null} then a {@link StringBuilder} will be created. * * @param l * The {@linkplain java.util.Locale locale} to apply during - * formatting. If l is null then no localization + * formatting. If {@code l} is {@code null} then no localization * is applied. */ public Formatter(Appendable a, Locale l) { @@ -2004,7 +2004,7 @@ * * @param l * The {@linkplain java.util.Locale locale} to apply during - * formatting. If l is null then no localization + * formatting. If {@code l} is {@code null} then no localization * is applied. * * @throws FileNotFoundException @@ -2112,7 +2112,7 @@ * * @param l * The {@linkplain java.util.Locale locale} to apply during - * formatting. If l is null then no localization + * formatting. If {@code l} is {@code null} then no localization * is applied. * * @throws FileNotFoundException @@ -2212,7 +2212,7 @@ * * @param l * The {@linkplain java.util.Locale locale} to apply during - * formatting. If l is null then no localization + * formatting. If {@code l} is {@code null} then no localization * is applied. * * @throws UnsupportedEncodingException @@ -2237,7 +2237,7 @@ *
The {@link #format(java.util.Locale,String,Object...) format} method * for this object which has a locale argument does not change this value. * - * @return null if no localization is applied, otherwise a + * @return {@code null} if no localization is applied, otherwise a * locale * * @throws FormatterClosedException @@ -2264,7 +2264,7 @@ } /** - * Returns the result of invoking toString() on the destination + * Returns the result of invoking {@code toString()} on the destination * for the output. For example, the following code formats text into a * {@link StringBuilder} then retrieves the resultant string: * @@ -2281,13 +2281,13 @@ *
* out().toString()
* - *
Depending on the specification of toString for the {@link + *
Depending on the specification of {@code toString} for the {@link * Appendable}, the returned string may or may not contain the characters * written to the destination. For instance, buffers typically return - * their contents in toString(), but streams cannot since the + * their contents in {@code toString()}, but streams cannot since the * data is discarded. * - * @return The result of invoking toString() on the destination + * @return The result of invoking {@code toString()} on the destination * for the output * * @throws FormatterClosedException @@ -2301,7 +2301,7 @@ /** * Flushes this formatter. If the destination implements the {@link - * java.io.Flushable} interface, its flush method will be invoked. + * java.io.Flushable} interface, its {@code flush} method will be invoked. * *
Flushing a formatter writes any buffered output in the destination * to the underlying stream. @@ -2323,7 +2323,7 @@ /** * Closes this formatter. If the destination implements the {@link - * java.io.Closeable} interface, its close method will be invoked. + * java.io.Closeable} interface, its {@code close} method will be invoked. * *
Closing a formatter allows it to release resources it may be holding * (such as open files). If the formatter is already closed, then invoking @@ -2352,13 +2352,13 @@ } /** - * Returns the IOException last thrown by this formatter's {@link + * Returns the {@code IOException} last thrown by this formatter's {@link * Appendable}. * - *
If the destination's append() method never throws - * IOException, then this method will always return null. + *
If the destination's {@code append()} method never throws + * {@code IOException}, then this method will always return {@code null}. * - * @return The last exception thrown by the Appendable or null if + * @return The last exception thrown by the Appendable or {@code null} if * no such exception exists. */ public IOException ioException() { @@ -2406,7 +2406,7 @@ * * @param l * The {@linkplain java.util.Locale locale} to apply during - * formatting. If l is null then no localization + * formatting. If {@code l} is {@code null} then no localization * is applied. This does not change this object's locale that was * set during construction. * @@ -4196,7 +4196,7 @@ } } - // Returns a string representation of the current Flags. + // Returns a string representation of the current {@code Flags}. public static String toString(Flags f) { return f.toString(); }

`'H'` + *
{@code 'H'} *	Hour of the day for the 24-hour clock, formatted as two digits with - * a leading zero as necessary i.e. `00 - 23`. - * - *
`'I'` + * a leading zero as necessary i.e. {@code 00 - 23}. + * + *
{@code 'I'} *	Hour for the 12-hour clock, formatted as two digits with a leading - * zero as necessary, i.e. `01 - 12`. - * - *
`'k'` - *	Hour of the day for the 24-hour clock, i.e. `0 - 23`. - * - *
`'l'` - *	Hour for the 12-hour clock, i.e. `1 - 12`. - * - *
`'M'` + * zero as necessary, i.e. {@code 01 - 12}. + * + *
{@code 'k'} + *	Hour of the day for the 24-hour clock, i.e. {@code 0 - 23}. + * + *
{@code 'l'} + *	Hour for the 12-hour clock, i.e. {@code 1 - 12}. + * + *
{@code 'M'} *	Minute within the hour formatted as two digits with a leading zero - * as necessary, i.e. `00 - 59`. - * - *
`'S'` + * as necessary, i.e. {@code 00 - 59}. + * + *
{@code 'S'} *	Seconds within the minute, formatted as two digits with a leading - * zero as necessary, i.e. `00 - 60` ("`60`" is a special + * zero as necessary, i.e. {@code 00 - 60} ("{@code 60}" is a special * value required to support leap seconds). * - *
`'L'` + *
{@code 'L'} *	Millisecond within the second formatted as three digits with - * leading zeros as necessary, i.e. `000 - 999`. - * - *
`'N'` + * leading zeros as necessary, i.e. {@code 000 - 999}. + * + *
{@code 'N'} *	Nanosecond within the second, formatted as nine digits with leading - * zeros as necessary, i.e. `000000000 - 999999999`. - * - *
`'p'` + * zeros as necessary, i.e. {@code 000000000 - 999999999}. + * + *
{@code 'p'} *	Locale-specific {@linkplain * java.text.DateFormatSymbols#getAmPmStrings morning or afternoon} marker - * in lower case, e.g."`am`" or "`pm`". Use of the conversion - * prefix `'T'` forces this output to upper case. - * - *
`'z'` + * in lower case, e.g."{@code am}" or "{@code pm}". Use of the conversion + * prefix {@code 'T'} forces this output to upper case. + * + *
{@code 'z'} *	RFC 822 - * style numeric time zone offset from GMT, e.g. `-0800`. This + * style numeric time zone offset from GMT, e.g. {@code -0800}. This * value will be adjusted as necessary for Daylight Saving Time. For - * `long`, {@link Long}, and {@link Date} the time zone used is - * the {@plainlink TimeZone#getDefault() default time zone} for this + * {@code long}, {@link Long}, and {@link Date} the time zone used is + * the {@linkplain TimeZone#getDefault() default time zone} for this * instance of the Java virtual machine. * - *
`'Z'` + *
{@code 'Z'} *	A string representing the abbreviation for the time zone. This * value will be adjusted as necessary for Daylight Saving Time. For - * `long`, {@link Long}, and {@link Date} the time zone used is - * the {@plainlink TimeZone#getDefault() default time zone} for this + * {@code long}, {@link Long}, and {@link Date} the time zone used is + * the {@linkplain TimeZone#getDefault() default time zone} for this * instance of the Java virtual machine. The Formatter's locale will * supersede the locale of the argument (if any). * - *
`'s'` + *
{@code 's'} *	Seconds since the beginning of the epoch starting at 1 January 1970 - * `00:00:00` UTC, i.e. `Long.MIN_VALUE/1000` to - * `Long.MAX_VALUE/1000`. - * - *
`'Q'` + * {@code 00:00:00} UTC, i.e. {@code Long.MIN_VALUE/1000} to + * {@code Long.MAX_VALUE/1000}. + * + *
{@code 'Q'} *	Milliseconds since the beginning of the epoch starting at 1 January - * 1970 `00:00:00` UTC, i.e. `Long.MIN_VALUE` to - * `Long.MAX_VALUE`. + * 1970 {@code 00:00:00} UTC, i.e. {@code Long.MIN_VALUE} to + * {@code Long.MAX_VALUE}. * *

`'B'` + *
{@code 'B'} *	Locale-specific {@linkplain java.text.DateFormatSymbols#getMonths - * full month name}, e.g. `"January"`, `"February"`. - * - *
`'b'` + * full month name}, e.g. {@code "January"}, {@code "February"}. + * + *
{@code 'b'} *	Locale-specific {@linkplain * java.text.DateFormatSymbols#getShortMonths abbreviated month name}, - * e.g. `"Jan"`, `"Feb"`. - * - *
`'h'` - *	Same as `'b'`. - * - *
`'A'` + * e.g. {@code "Jan"}, {@code "Feb"}. + * + *
{@code 'h'} + *	Same as {@code 'b'}. + * + *
{@code 'A'} *	Locale-specific full name of the {@linkplain * java.text.DateFormatSymbols#getWeekdays day of the week}, - * e.g. `"Sunday"`, `"Monday"` - * - *
`'a'` + * e.g. {@code "Sunday"}, {@code "Monday"} + * + *
{@code 'a'} *	Locale-specific short name of the {@linkplain * java.text.DateFormatSymbols#getShortWeekdays day of the week}, - * e.g. `"Sun"`, `"Mon"` - * - *
`'C'` - *	Four-digit year divided by `100`, formatted as two digits - * with leading zero as necessary, i.e. `00 - 99` - * - *
`'Y'` + * e.g. {@code "Sun"}, {@code "Mon"} + * + *
{@code 'C'} + *	Four-digit year divided by {@code 100}, formatted as two digits + * with leading zero as necessary, i.e. {@code 00 - 99} + * + *
{@code 'Y'} *	Year, formatted as at least four digits with leading zeros as - * necessary, e.g. `0092` equals `92` CE for the Gregorian + * necessary, e.g. {@code 0092} equals {@code 92} CE for the Gregorian * calendar. * - *
`'y'` + *
{@code 'y'} *	Last two digits of the year, formatted with leading zeros as - * necessary, i.e. `00 - 99`. - * - *
`'j'` + * necessary, i.e. {@code 00 - 99}. + * + *
{@code 'j'} *	Day of year, formatted as three digits with leading zeros as - * necessary, e.g. `001 - 366` for the Gregorian calendar. - * - *
`'m'` + * necessary, e.g. {@code 001 - 366} for the Gregorian calendar. + * + *
{@code 'm'} *	Month, formatted as two digits with leading zeros as necessary, - * i.e. `01 - 13`. - * - *
`'d'` + * i.e. {@code 01 - 13}. + * + *
{@code 'd'} *	Day of month, formatted as two digits with leading zeros as - * necessary, i.e. `01 - 31` - * - *
`'e'` - *	Day of month, formatted as two digits, i.e. `1 - 31`. + * necessary, i.e. {@code 01 - 31} + * + *
{@code 'e'} + *	Day of month, formatted as two digits, i.e. {@code 1 - 31}. * *

`'R'` - *	Time formatted for the 24-hour clock as `"%tH:%tM"` - * - *
`'T'` - *	Time formatted for the 24-hour clock as `"%tH:%tM:%tS"`. - * - *
`'r'` - *	Time formatted for the 12-hour clock as `"%tI:%tM:%tS %Tp"`. - * The location of the morning or afternoon marker (`'%Tp'`) may be + *
{@code 'R'} + *	Time formatted for the 24-hour clock as {@code "%tH:%tM"} + * + *
{@code 'T'} + *	Time formatted for the 24-hour clock as {@code "%tH:%tM:%tS"}. + * + *
{@code 'r'} + *	Time formatted for the 12-hour clock as {@code "%tI:%tM:%tS %Tp"}. + * The location of the morning or afternoon marker ({@code '%Tp'}) may be * locale-dependent. * - *
`'D'` - *	Date formatted as `"%tm/%td/%ty"`. - * - *
`'F'` + *
{@code 'D'} + *	Date formatted as {@code "%tm/%td/%ty"}. + * + *
{@code 'F'} *	ISO 8601 - * complete date formatted as `"%tY-%tm-%td"`. - * - *
`'c'` - *	Date and time formatted as `"%ta %tb %td %tT %tZ %tY"`, - * e.g. `"Sun Jul 20 16:17:00 EDT 1969"`. + * complete date formatted as {@code "%tY-%tm-%td"}. + * + *
{@code 'c'} + *	Date and time formatted as {@code "%ta %tb %td %tT %tZ %tY"}, + * e.g. {@code "Sun Jul 20 16:17:00 EDT 1969"}. * *

`'b'` + *
{@code 'b'} *	`'\u0062'` - *	Produces either "`true`" or "`false`" as returned by + *	Produces either "{@code true}" or "{@code false}" as returned by * {@link Boolean#toString(boolean)}. * - * If the argument is `null`, then the result is - * "`false`". If the argument is a `boolean` or {@link + * If the argument is {@code null}, then the result is + * "{@code false}". If the argument is a {@code boolean} or {@link * Boolean}, then the result is the string returned by {@link * String#valueOf(boolean) String.valueOf()}. Otherwise, the result is - * "`true`". - * - * If the `'#'` flag is given, then a {@link + * "{@code true}". + * + * If the {@code '#'} flag is given, then a {@link * FormatFlagsConversionMismatchException} will be thrown. * - *
`'B'` + *
{@code 'B'} *	`'\u0042'` - *	The upper-case variant of `'b'`. - * - *
`'h'` + *	The upper-case variant of {@code 'b'}. + * + *
{@code 'h'} *	`'\u0068'` *	Produces a string representing the hash code value of the object. * - * If the argument, arg is `null`, then the - * result is "`null`". Otherwise, the result is obtained - * by invoking `Integer.toHexString(arg.hashCode())`. - * - * If the `'#'` flag is given, then a {@link + * If the argument, arg is {@code null}, then the + * result is "{@code null}". Otherwise, the result is obtained + * by invoking {@code Integer.toHexString(arg.hashCode())}. + * + * If the {@code '#'} flag is given, then a {@link * FormatFlagsConversionMismatchException} will be thrown. * - *
`'H'` + *
{@code 'H'} *	`'\u0048'` - *	The upper-case variant of `'h'`. - * - *
`'s'` + *	The upper-case variant of {@code 'h'}. + * + *
{@code 's'} *	`'\u0073'` *	Produces a string. * - * If the argument is `null`, then the result is - * "`null`". If the argument implements {@link Formattable}, then + * If the argument is {@code null}, then the result is + * "{@code null}". If the argument implements {@link Formattable}, then * its {@link Formattable#formatTo formatTo} method is invoked. * Otherwise, the result is obtained by invoking the argument's - * `toString()` method. - * - * If the `'#'` flag is given and the argument is not a {@link + * {@code toString()} method. + * + * If the {@code '#'} flag is given and the argument is not a {@link * Formattable} , then a {@link FormatFlagsConversionMismatchException} * will be thrown. * - *
`'S'` + *
{@code 'S'} *	`'\u0053'` - *	The upper-case variant of `'s'`. + *	The upper-case variant of {@code 's'}. * *