(doc) Update generated rule documentation

This commit is contained in:
Andreas Dangel committed 2019-06-08 17:30:54 +02:00
1 parent 427b5003a3
commit 89bb73fc99
3 files changed
+46 -12

No files matched your search

+2 -2
View File
@@ -1468,7 +1468,7 @@ public class Something {
|Name|Default Value|Description|Multivalued|
|----|-------------|-----------|-----------|
|ignoredAnnotations|lombok.Setter \| lombok.Getter \| lombok.Builder \| lombok.Data \| lombok.RequiredArgsConstructor \| lombok.AllArgsConstructor \| lombok.Value \| lombok.NoArgsConstructor \| java.lang.Deprecated \| javafx.fxml.FXML|Fully qualified names of the annotation types that should be ignored by this rule|yes. Delimiter is '\|'.|
|ignoredAnnotations|lombok.Setter \| lombok.Getter \| lombok.Builder \| lombok.Data \| lombok.RequiredArgsConstructor \| lombok.AllArgsConstructor \| lombok.Value \| lombok.NoArgsConstructor \| java.lang.Deprecated \| javafx.fxml.FXML \| lombok.experimental.Delegate|Fully qualified names of the annotation types that should be ignored by this rule|yes. Delimiter is '\|'.|
**Use this rule with the default properties by just referencing it:**
``` xml
@@ -1479,7 +1479,7 @@ public class Something {
``` xml
<rule ref="category/java/bestpractices.xml/UnusedPrivateField">
<properties>
<property name="ignoredAnnotations" value="lombok.Setter|lombok.Getter|lombok.Builder|lombok.Data|lombok.RequiredArgsConstructor|lombok.AllArgsConstructor|lombok.Value|lombok.NoArgsConstructor|java.lang.Deprecated|javafx.fxml.FXML" />
<property name="ignoredAnnotations" value="lombok.Setter|lombok.Getter|lombok.Builder|lombok.Data|lombok.RequiredArgsConstructor|lombok.AllArgsConstructor|lombok.Value|lombok.NoArgsConstructor|java.lang.Deprecated|javafx.fxml.FXML|lombok.experimental.Delegate" />
</properties>
</rule>
```
+2 -2
View File
@@ -1779,7 +1779,7 @@ public class Foo {
|Name|Default Value|Description|Multivalued|
|----|-------------|-----------|-----------|
|ignoredAnnotations|lombok.Setter \| lombok.Getter \| lombok.Builder \| lombok.Data \| lombok.RequiredArgsConstructor \| lombok.AllArgsConstructor \| lombok.Value \| lombok.NoArgsConstructor|Fully qualified names of the annotation types that should be ignored by this rule|yes. Delimiter is '\|'.|
|ignoredAnnotations|lombok.Setter \| lombok.Getter \| lombok.Builder \| lombok.Data \| lombok.RequiredArgsConstructor \| lombok.AllArgsConstructor \| lombok.Value \| lombok.NoArgsConstructor \| lombok.experimental.Delegate|Fully qualified names of the annotation types that should be ignored by this rule|yes. Delimiter is '\|'.|
|checkInnerClasses|false|Check inner classes|no|
|disallowNotAssignment|false|Disallow violations where the first usage is not an assignment|no|
@@ -1792,7 +1792,7 @@ public class Foo {
``` xml
<rule ref="category/java/design.xml/SingularField">
<properties>
<property name="ignoredAnnotations" value="lombok.Setter|lombok.Getter|lombok.Builder|lombok.Data|lombok.RequiredArgsConstructor|lombok.AllArgsConstructor|lombok.Value|lombok.NoArgsConstructor" />
<property name="ignoredAnnotations" value="lombok.Setter|lombok.Getter|lombok.Builder|lombok.Data|lombok.RequiredArgsConstructor|lombok.AllArgsConstructor|lombok.Value|lombok.NoArgsConstructor|lombok.experimental.Delegate" />
<property name="checkInnerClasses" value="false" />
<property name="disallowNotAssignment" value="false" />
</properties>
+42 -8
View File
@@ -293,7 +293,7 @@ public static Foo getFoo() {
SimpleDateFormat instances are not synchronized. Sun recommends using separate format instances
for each thread. If multiple threads must access a static formatter, the formatter must be
synchronized either on method or block level.
synchronized on block level.
This rule has been deprecated in favor of the rule {% rule UnsynchronizedStaticFormatter %}.
@@ -307,17 +307,34 @@ public class Foo {
void bar() {
sdf.format(); // poor, no thread-safety
}
static synchronized void foo() {
sdf.format(); // preferred
void foo() {
synchronized (sdf) { // preferred
sdf.format();
}
}
}
```
**Use this rule by referencing it:**
**This rule has the following properties:**
|Name|Default Value|Description|Multivalued|
|----|-------------|-----------|-----------|
|allowMethodLevelSynchronization|false|If true, method level synchronization is allowed as well as synchronized block. Otherwise only synchronized blocks are allowed.|no|
**Use this rule with the default properties by just referencing it:**
``` xml
<rule ref="category/java/multithreading.xml/UnsynchronizedStaticDateFormatter" />
```
**Use this rule and customize it:**
``` xml
<rule ref="category/java/multithreading.xml/UnsynchronizedStaticDateFormatter">
<properties>
<property name="allowMethodLevelSynchronization" value="false" />
</properties>
</rule>
```
## UnsynchronizedStaticFormatter
**Since:** PMD 6.11.0
@@ -327,7 +344,7 @@ public class Foo {
Instances of `java.text.Format` are generally not synchronized.
Sun recommends using separate format instances for each thread.
If multiple threads must access a static formatter, the formatter must be
synchronized either on method or block level.
synchronized on block level.
**This rule is defined by the following Java class:** [net.sourceforge.pmd.lang.java.rule.multithreading.UnsynchronizedStaticFormatterRule](https://github.com/pmd/pmd/blob/master/pmd-java/src/main/java/net/sourceforge/pmd/lang/java/rule/multithreading/UnsynchronizedStaticFormatterRule.java)
@@ -339,17 +356,34 @@ public class Foo {
void bar() {
sdf.format(); // poor, no thread-safety
}
static synchronized void foo() {
sdf.format(); // preferred
void foo() {
synchronized (sdf) { // preferred
sdf.format();
}
}
}
```
**Use this rule by referencing it:**
**This rule has the following properties:**
|Name|Default Value|Description|Multivalued|
|----|-------------|-----------|-----------|
|allowMethodLevelSynchronization|false|If true, method level synchronization is allowed as well as synchronized block. Otherwise only synchronized blocks are allowed.|no|
**Use this rule with the default properties by just referencing it:**
``` xml
<rule ref="category/java/multithreading.xml/UnsynchronizedStaticFormatter" />
```
**Use this rule and customize it:**
``` xml
<rule ref="category/java/multithreading.xml/UnsynchronizedStaticFormatter">
<properties>
<property name="allowMethodLevelSynchronization" value="false" />
</properties>
</rule>
```
## UseConcurrentHashMap
**Since:** PMD 4.2.6