Java – How to disable a particular checkstyle rule for a particular line of code

checkstylejava

Yes, I saw this question:

How to disable a particular checkstyle rule for a particular line of code?

But I can not comment and I wanted to ask if it is possible to do what the OP asked:

How to disable one particular rule for a line of code

I also saw this:
Is there a way to force Checkstyle to ignore particular warning in the source code?

I guess the answer to my question is to use
SuppressWithNearbyCommentFilter

I just don't understand what my comments in java should look like.

Say I have the following code:

public class MyDataContainer {
  /** the name */
  public String name;
}

and I want to get rid of the "Visibility Modifier" warning and only that warning.

What do I have to enable (using the eclipse–cs.sf.net plugin)?

And how do my comments have to look?

I managed to enable Suppresion Comment Filter and surround my whole class with

//CHECKSTYLE:OFF
//CHECKSTYLE:ON

but I don't really like this solution.

Best Answer

It is a bit late, for future reference:

you can use the SuppressWithNearbyCommentFilter this way:

<module name="SuppressWithNearbyCommentFilter">
   <property name="commentFormat" value="CHECKSTYLE DISABLE ([\w\|]+) FOR (-?\d+) LINES"/>
   <property name="checkFormat" value="$1"/>
   <property name="influenceFormat" value="$2"/>
</module>

On the line where you want to disable the warning you can write:

// CHECKSTYLE DISABLE <WarningName> FOR <# of lines> LINES

for example

// CHECKSTYLE DISABLE MagicNumber FOR 2 LINES

The number can also be negative (if the warning is in some automatically generated code that you cannot touch).

Related Solutions

Java – How does the Java ‘for each’ loop work

for (Iterator<String> i = someIterable.iterator(); i.hasNext();) {
    String item = i.next();
    System.out.println(item);
}

Note that if you need to use i.remove(); in your loop, or access the actual iterator in some way, you cannot use the for ( : ) idiom, since the actual iterator is merely inferred.

As was noted by Denis Bueno, this code works for any object that implements the Iterable interface.

Also, if the right-hand side of the for (:) idiom is an array rather than an Iterable object, the internal code uses an int index counter and checks against array.length instead. See the Java Language Specification.

Java – Access restriction on class due to restriction on required library rt.jar

There's another solution that also works.

Go to the Build Path settings in the project properties.
Remove the JRE System Library
Add it back; Select "Add Library" and select the JRE System Library. The default worked for me.

This works because you have multiple classes in different jar files. Removing and re-adding the JRE lib will make the right classes be first. If you want a fundamental solution make sure you exclude the jar files with the same classes.

For me I have: javax.xml.soap.SOAPPart in three different jars: axis-saaj-1.4.jar, saaj-api-1.3.jar and the rt.jar

Best Answer

Related Solutions

Java – How does the Java ‘for each’ loop work

Java – Access restriction on class due to restriction on required library rt.jar

Related Topic