1 /*
2 com.puppycrawl.tools.checkstyle.meta.JavadocMetadataScraper
3 writeXmlOutput = false
4
5
6 */
7
8 package com.puppycrawl.tools.checkstyle.meta.javadocmetadatascraper;
9
10 import java.util.Arrays;
11 import java.util.Locale;
12
13
14 import com.puppycrawl.tools.checkstyle.StatelessCheck;
15 import com.puppycrawl.tools.checkstyle.api.AbstractCheck;
16
17
18
19
20
21
22 /**
23 * <p>
24 * Checks the placement of right curly braces ({@code '}'}) for code blocks. This check supports
25 * if-else, try-catch-finally blocks, while-loops, for-loops,
26 * method definitions, class definitions, constructor definitions,
27 * instance, static initialization blocks, annotation definitions and enum definitions.
28 * For right curly brace of expression blocks of arrays, lambdas and class instances
29 * please follow issue
30 * <a href="https://github.com/checkstyle/checkstyle/issues/5945">#5945</a>.
31 * For right curly brace of enum constant please follow issue
32 * <a href="https://github.com/checkstyle/checkstyle/issues/7519">#7519</a>.
33 * </p>
34 * <ul>
35 * <li>
36 * Property {@code option} - Specify the policy on placement of a right curly brace
37 * (<code>'}'</code>).
38 * Type is {@code com.puppycrawl.tools.checkstyle.checks.blocks.RightCurlyOption}.
39 * Default value is {@code same}.
40 * </li>
41 * <li>
42 * Property {@code tokens} - tokens to check
43 * Type is {@code java.lang.String[]}.
44 * Validation type is {@code tokenSet}.
45 * Default value is:
46 * <a href="https://checkstyle.org/apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#LITERAL_TRY">
47 * LITERAL_TRY</a>,
48 * <a href="https://checkstyle.org/apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#LITERAL_CATCH">
49 * LITERAL_CATCH</a>,
50 * <a href="https://checkstyle.org/apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#LITERAL_FINALLY">
51 * LITERAL_FINALLY</a>,
52 * <a href="https://checkstyle.org/apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#LITERAL_IF">
53 * LITERAL_IF</a>,
54 * <a href="https://checkstyle.org/apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#LITERAL_ELSE">
55 * LITERAL_ELSE</a>.
56 * </li>
57 * </ul>
58 * <p>
59 * To configure the check:
60 * </p>
61 * <pre>
62 * skipped as not relevant for UTs
63 * </pre>
64 * <p>
65 * Parent is {@code com.puppycrawl.tools.checkstyle.TreeWalker}
66 * </p>
67 * <p>
68 * Violation Message Keys:
69 * </p>
70 * <ul>
71 * <li>
72 * {@code line.alone}
73 * </li>
74 * <li>
75 * {@code line.break.before}
76 * </li>
77 * <li>
78 * {@code line.same}
79 * </li>
80 * </ul>
81 *
82 * @since 3.0
83 */
84 @StatelessCheck
85 public abstract class InputJavadocMetadataScraperRightCurlyCheck extends AbstractCheck {
86
87 }