+ * detailAst.getText().equals(TokenUtil.getTokenName(detailAst.getType())) + *+ * For example: + *
+ * //MODIFIERS[@text='MODIFIERS'] + * //OBJBLOCK[@text='OBJBLOCK'] + *+ * These tokens do not match required criteria because their values do not carry any + * information, they do not affect the xpath requests and do not help to get more accurate + * results. The values of these nodes are useless. No matter which class you analyze, these + * values are always the same. + * In addition, they make xpath queries more complex, less readable and less obvious. + * 2. Tokens for which the values differ from token names, but values are always constant. + * For example: + *
+ * //LITERAL_VOID[@text='void'] + * //RCURLY[@text='}'] + *+ * These tokens are not used for the same reasons as were described in the previous part. + * 3. Tokens for which values are not constant. The values of these nodes are closely related + * to a concrete class, method, variable and so on. + * For example: + *
+ * String greeting = "HelloWorld"; + * //STRING_LITERAL[@text='HelloWorld'] + *+ *
+ * int year = 2017; + * //NUM_INT[@text=2017] + *+ *
+ * int age = 23; + * //NUM_INT[@text=23] + *+ * As you can see same {@code NUM_INT} token type can have different values, depending on + * context. + *
+ * public class MyClass {}
+ * //IDENT[@text='MyClass']
+ *
+ * Only these tokens support value attribute because they make our xpath queries more accurate.
+ * These token types are listed below.
+ * */
+ private static final List
+ Currently, xpath queries support one type of attribute @text.
+ @text - addresses to the value of the node. For example: variable value,
+ annotation value, text content and etc.
+ Only the following token types support @text attribute:
+ TokenTypes.IDENT, TokenTypes.STRING_LITERAL,
+ TokenTypes.CHAR_LITERAL, TokenTypes.NUM_LONG,
+ TokenTypes.NUM_INT, TokenTypes.NUM_DOUBLE,
+ TokenTypes.NUM_FLOAT.
+ These token types were selected because only their values are useful and can be used
+ in xpath queries for more accurate results.
+ Other token types always have constant values.
+
@@ -925,8 +938,8 @@ public class UserService { Suppress checks for certain methods:
Suppress checks for variable testVariable inside testMethod method @@ -934,23 +947,24 @@ public class UserService {
In the following sample, violations for LeftCurly check will be suppressed
for classes with name Main or for methods with name calculate.
The following example demonstrates how to suppress RequireThis violations for
variable age inside changeAge method.
Some elements can be suppressed by different ways.
+ For example, to suppress violation on variable wordCount in following code:
+
You need to look at AST of such code by our CLI tool:
+The easiest way is to suppress by variable name. As you can see VARIABLE_DEF
+ node refers to variable declaration statement and has child node with token type
+ IDENT which is used for storing class, method, variable names.
The following example demonstrates how variable can be queried by its name:
+Another way is to suppress by variable value. Again, if you look at the printed AST tree
+ above, you will notice that one of the grandchildren of VARIABLE_DEF node is
+ responsible for storing variable value - NUM_INT with value 11.
The following example demonstrates how variable can be queried by its value, same
+ approach applies to String, char, float, double, int, long data types:
Next example is about suppressing method with certain annotation by its value.
+First of all we need to look at AST tree printed by our CLI tool:
+AST node ANNOTATION -> ANNOTATION [6:4] has direct child
+ IDENT -> Generated [6:5], therefore can be queried by IDENT value:
+
The problem with query above that it will suppress violations for all methods with
+ annotation @Generated. In order to suppress methods with
+ @Generated("second") annotations only, you need to look at AST tree again.
+ Value of the ANNOTATION node is stored inside sub-node with token type
+ STRING_LITERAL. Use the following query to suppress methods with
+ @Generated("second") annotation: