Deprecated API

Contents

• Deprecated Classes
• Deprecated Fields
• Deprecated Methods
• Deprecated Constructors

Deprecated Classes

Class and Description
com.puppycrawl.tools.checkstyle.checks.metrics.AbstractComplexityCheck Checkstyle will not support abstract checks anymore. Use AbstractCheck instead.
com.puppycrawl.tools.checkstyle.checks.AbstractDeclarationCollector Checkstyle will not support abstract checks anymore. Use AbstractCheck instead.
com.puppycrawl.tools.checkstyle.checks.AbstractFormatCheck Checkstyle will not support abstract checks anymore. Use AbstractCheck instead.
com.puppycrawl.tools.checkstyle.checks.coding.AbstractIllegalCheck Checkstyle will not support abstract checks anymore. Use AbstractCheck instead.
com.puppycrawl.tools.checkstyle.checks.coding.AbstractIllegalMethodCheck Checkstyle will not support abstract checks anymore. Use AbstractCheck instead.
com.puppycrawl.tools.checkstyle.checks.coding.AbstractNestedDepthCheck Checkstyle will not support abstract checks anymore. Use AbstractCheck instead.
com.puppycrawl.tools.checkstyle.checks.AbstractOptionCheck Checkstyle will not support abstract checks anymore. Use AbstractCheck instead.
com.puppycrawl.tools.checkstyle.checks.AbstractTypeAwareCheck Checkstyle is not type aware tool and all Checks derived from this class are potentially unstable.
com.puppycrawl.tools.checkstyle.checks.naming.AbstractTypeParameterNameCheck Checkstyle will not support abstract checks anymore. Use AbstractNameCheck instead.

Deprecated Fields

Field and Description
com.puppycrawl.tools.checkstyle.grammars.javadoc.JavadocParser.tokenNames Use JavadocParser.VOCABULARY instead.
com.puppycrawl.tools.checkstyle.grammars.javadoc.JavadocLexer.tokenNames Use JavadocLexer.VOCABULARY instead.

Deprecated Methods

Method and Description
com.puppycrawl.tools.checkstyle.api.FileContents.getCComments() Use FileContents.getBlockComments() instead.
com.puppycrawl.tools.checkstyle.checks.FileContentsHolder.getContents() use getCurrentFileContents() instead.
com.puppycrawl.tools.checkstyle.api.FileContents.getCppComments() Use FileContents.getSingleLineComments() instead.
com.puppycrawl.tools.checkstyle.grammars.javadoc.JavadocParser.getTokenNames()
com.puppycrawl.tools.checkstyle.grammars.javadoc.JavadocLexer.getTokenNames()
com.puppycrawl.tools.checkstyle.ConfigurationLoader.loadConfiguration(InputStream, PropertyResolver, boolean) As this method does not provide a valid system ID, preventing resolution of external entities, a version using an InputSource should be used instead
com.puppycrawl.tools.checkstyle.api.FileContents.reportCComment(int, int, int, int) Use FileContents.reportBlockComment(int, int, int, int) instead.
com.puppycrawl.tools.checkstyle.api.FileContents.reportCppComment(int, int) Use FileContents.reportSingleLineComment(int, int) instead.
com.puppycrawl.tools.checkstyle.TreeWalker.setCacheFile(String) Use Checker.setCacheFile(java.lang.String) instead. It does not do anything now. We just keep the setter for transition period to the same option in Checker. The method will be completely removed in Checkstyle 8.0. See issue#2883
com.puppycrawl.tools.checkstyle.checks.blocks.LeftCurlyCheck.setMaxLineLength(int) since 6.10 release, option is not required for the Check.
com.puppycrawl.tools.checkstyle.checks.imports.ImportControlCheck.setUrl(URI) use ImportControlCheck.setFile(URI uri) to load URLs instead

Deprecated Constructors

Constructor and Description
com.puppycrawl.tools.checkstyle.api.FileContents(String, String...) Use FileContents.FileContents(FileText) instead in order to preserve the original line breaks where possible.