File: FormatString.md

package info (click to toggle)
error-prone-java 2.18.0-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, forky, sid, trixie
  • size: 23,204 kB
  • sloc: java: 222,992; xml: 1,319; sh: 25; makefile: 7
file content (93 lines) | stat: -rw-r--r-- 1,640 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
Format strings for the printf family of functions must follow the specification
in the documentation for [java.util.Formatter][formatter].

[formatter]: https://docs.oracle.com/javase/8/docs/api/java/util/Formatter.html

The syntax for format specifiers is:

```
%[argument_index$][flags][width][.precision]conversion
```

Format strings can have the following errors:

## DuplicateFormatFlags

Duplicate flags are provided in the format specifier:

```java
String.format("e = %++10.4f", Math.E);
```

## FormatFlagsConversionMismatch

A conversion and flag are incompatible:

```java
String.format("%#b", Math.E);
```

## IllegalFormatCodePoint

The argument is a character with an invalid Unicode code point.

```java
String.format("%c", 0x110000);
```

## IllegalFormatConversion

The argument corresponding to the format specifier is of an incompatible type:

```java
String.format("%f", "abcd");
```

## IllegalFormatFlags

An illegal combination of flags is given:

```java
String.format("%-010d", 5);
```

## IllegalFormatPrecision

The conversion does not support a precision:

```java
String.format("%.c", 'c');
```

## IllegalFormatWidth

The conversion does not support a width:

```java
String.format("%1n");
```

## MissingFormatArgument

There is a format specifier which does not have a corresponding argument or if
an argument index refers to an argument that does not exist:

```java
String.format("%<s", "test");
```

## MissingFormatWidth

The format width is required:

```java
String.format("e = %-f", Math.E);
```

## UnknownFormatConversion

An unknown conversion is given:

```java
String.format("%r", "hello");
```