2020-11-14 09:20:07 +00:00
<!DOCTYPE html>
< html >
< head >
< meta charset = "utf-8" >
< meta http-equiv = "X-UA-Compatible" content = "IE=edge" >
< meta name = "viewport" content = "width=device-width, initial-scale=1" >
< meta name = "description" content = "" >
< meta name = "keywords" content = "userdocstools, " >
< title > PMD Java API | PMD Source Code Analyzer< / title >
2023-03-03 20:15:41 +00:00
< link rel = "stylesheet" type = "text/css" href = "assets/fontawesome-free-5.14.0-web/css/all.min.css" >
< link rel = "stylesheet" type = "text/css" href = "assets/bootstrap-4.5.2-dist/css/bootstrap.min.css" >
2020-11-14 09:20:07 +00:00
2023-03-03 20:15:41 +00:00
< link rel = "stylesheet" type = "text/css" href = "css/syntax.css" >
< link rel = "stylesheet" type = "text/css" href = "css/modern-business.css" >
< link rel = "stylesheet" type = "text/css" href = "css/customstyles.css" >
< link rel = "stylesheet" type = "text/css" href = "css/theme-green.css" >
< link rel = "stylesheet" type = "text/css" href = "css/pmd-customstyles.css" >
2020-11-14 09:20:07 +00:00
< link rel = "shortcut icon" href = "images/favicon.ico" type = "image/x-icon" >
< link rel = "icon" href = "images/favicon.ico" type = "image/x-icon" >
2023-03-03 20:15:41 +00:00
< link rel = "alternate" type = "application/rss+xml" title = "" href = "feed.xml" >
2020-11-14 09:20:07 +00:00
< / head >
< body >
<!-- Content is offset by the height of the topnav bar. -->
<!-- There's already a padding - top rule in modern - business.css, but it apparently doesn't work on Firefox 60 and Chrome 67 -->
< div id = "topbar-content-offset" >
<!-- Navigation -->
2023-03-03 20:15:41 +00:00
< nav class = "navbar navbar-expand-lg fixed-top navbar-dark" >
2020-11-14 09:20:07 +00:00
< div class = "container topnavlinks" >
2023-03-03 20:15:41 +00:00
< a class = "navbar-brand fas fa-home fa-lg" href = "index.html" > < span class = "projectTitle" > PMD Source Code Analyzer Project< / span > < / a >
< button class = "navbar-toggler" type = "button" data-toggle = "collapse" data-target = "#navbarSupportedContent" aria-controls = "navbarSupportedContent" aria-expanded = "false" aria-label = "Toggle navigation" >
< span class = "navbar-toggler-icon" > < / span >
< / button >
< div class = "collapse navbar-collapse" id = "navbarSupportedContent" >
< ul class = "navbar-nav mr-auto mt-2 mt-lg-0" > < / ul >
< ul class = "navbar-nav" >
2020-11-14 09:20:07 +00:00
<!-- toggle sidebar button -->
2023-03-03 20:15:41 +00:00
< li class = "nav-item" > < a id = "tg-sb-link" class = "nav-link" href = "#" > < i id = "tg-sb-icon" class = "fas fa-toggle-on" > < / i > Nav< / a > < / li >
2020-11-14 09:20:07 +00:00
<!-- entries without drop - downs appear here -->
2023-03-03 20:15:41 +00:00
< li class = "nav-item" > < a class = "nav-link" href = "https://github.com/pmd/pmd/releases/latest" target = "_blank" > Download< / a > < / li >
< li class = "nav-item" > < a class = "nav-link" href = "https://github.com/pmd/pmd" target = "_blank" > Fork us on github< / a > < / li >
2020-11-14 09:20:07 +00:00
<!-- entries with drop - downs appear here -->
<!-- conditional logic to control which topnav appears for the audience defined in the configuration file. -->
< / ul >
2023-03-03 20:15:41 +00:00
< form class = "form-inline my-2 my-lg-0" >
< input class = "form-control mr-sm-2" type = "search" placeholder = "search..." id = "search-input" >
< ul id = "results-container" > < / ul >
< / form >
2020-11-14 09:20:07 +00:00
< / div >
2023-03-03 20:15:41 +00:00
< / div >
2020-11-14 09:20:07 +00:00
< / nav >
<!-- Page Content -->
2022-02-25 09:51:51 +00:00
< div class = "container-toc-wrapper" >
< div class = "container" >
< div class = "col-lg-12" > < / div >
<!-- Content Row -->
< div class = "row" >
2020-11-14 09:20:07 +00:00
2022-02-25 09:51:51 +00:00
<!-- Sidebar Column -->
< div class = "col-md-3" id = "tg-sb-sidebar" >
2020-11-14 09:20:07 +00:00
< ul id = "mysidebar" class = "nav" >
2023-03-03 20:15:41 +00:00
< li class = "sidebarTitle" > PMD 7.0.0-SNAPSHOT< / li >
< div class = "sidebarTitleDate" > Release date: ??-?????-2023< / div >
2020-11-14 09:20:07 +00:00
< li >
< a href = "#" > About< / a >
< ul >
< li > < a href = "index.html" > Home< / a > < / li >
2023-03-03 20:15:41 +00:00
< li > < a href = "pmd_release_notes7.html" > Release notes< / a > < / li >
2020-11-14 09:20:07 +00:00
< li > < a href = "pmd_next_major_development.html" > PMD 7.0.0 development< / a > < / li >
< li > < a href = "pmd_about_help.html" > Getting help< / a > < / li >
< / ul >
< / li >
< li >
< a href = "#" > User Documentation< / a >
< ul >
< li > < a href = "pmd_userdocs_installation.html" > Installation and basic CLI usage< / a > < / li >
< li > < a href = "pmd_userdocs_making_rulesets.html" > Making rulesets< / a > < / li >
< li > < a href = "pmd_userdocs_configuring_rules.html" > Configuring rules< / a > < / li >
< li > < a href = "pmd_userdocs_best_practices.html" > Best practices< / a > < / li >
< li > < a href = "pmd_userdocs_suppressing_warnings.html" > Suppressing warnings< / a > < / li >
< li > < a href = "pmd_userdocs_incremental_analysis.html" > Incremental analysis< / a > < / li >
< li > < a href = "pmd_userdocs_cli_reference.html" > PMD CLI reference< / a > < / li >
< li > < a href = "pmd_userdocs_report_formats.html" > PMD Report formats< / a > < / li >
2022-09-29 15:04:50 +00:00
< li > < a href = "pmd_userdocs_3rdpartyrulesets.html" > 3rd party rulesets< / a > < / li >
2020-11-14 09:20:07 +00:00
< li class = "subfolders" >
< a href = "#" > CPD reference< / a >
< ul >
< li > < a href = "pmd_userdocs_cpd.html" > Copy-paste detection< / a > < / li >
< li > < a href = "pmd_userdocs_cpd_report_formats.html" > CPD Report formats< / a > < / li >
< / ul >
< / li >
< li class = "subfolders" >
< a href = "#" > Extending PMD< / a >
< ul >
< li > < a href = "pmd_userdocs_extending_writing_rules_intro.html" > Introduction to writing rules< / a > < / li >
< li > < a href = "pmd_userdocs_extending_your_first_rule.html" > Your first rule< / a > < / li >
< li > < a href = "pmd_userdocs_extending_writing_xpath_rules.html" > XPath rules< / a > < / li >
< li > < a href = "pmd_userdocs_extending_writing_java_rules.html" > Java rules< / a > < / li >
< li > < a href = "pmd_userdocs_extending_designer_reference.html" > Rule designer reference< / a > < / li >
< li > < a href = "pmd_userdocs_extending_defining_properties.html" > Defining rule properties< / a > < / li >
< li > < a href = "pmd_userdocs_extending_rule_guidelines.html" > Rule guidelines< / a > < / li >
< li > < a href = "pmd_userdocs_extending_testing.html" > Testing your rules< / a > < / li >
< / ul >
< / li >
< li class = "subfolders" >
< a href = "#" > Tools / Integrations< / a >
< ul >
< li > < a href = "pmd_userdocs_tools_maven.html" > Maven PMD Plugin< / a > < / li >
< li > < a href = "pmd_userdocs_tools_gradle.html" > Gradle< / a > < / li >
< li > < a href = "pmd_userdocs_tools_ant.html" > Ant< / a > < / li >
< li class = "active" > < a href = "pmd_userdocs_tools_java_api.html" > PMD Java API< / a > < / li >
< li > < a href = "pmd_userdocs_tools_ci.html" > CI integrations< / a > < / li >
< li > < a href = "pmd_userdocs_tools.html" > Other Tools / Integrations< / a > < / li >
< / ul >
< / li >
< / ul >
< / li >
< li >
< a href = "#" > Rule Reference< / a >
< ul >
< li class = "subfolders" >
< a href = "#" > Apex Rules< / a >
< ul >
< li > < a href = "pmd_rules_apex.html" > Index< / a > < / li >
< li > < a href = "pmd_rules_apex_bestpractices.html" > Best Practices< / a > < / li >
< li > < a href = "pmd_rules_apex_codestyle.html" > Code Style< / a > < / li >
< li > < a href = "pmd_rules_apex_design.html" > Design< / a > < / li >
< li > < a href = "pmd_rules_apex_documentation.html" > Documentation< / a > < / li >
< li > < a href = "pmd_rules_apex_errorprone.html" > Error Prone< / a > < / li >
< li > < a href = "pmd_rules_apex_performance.html" > Performance< / a > < / li >
< li > < a href = "pmd_rules_apex_security.html" > Security< / a > < / li >
< / ul >
< / li >
2022-04-28 13:34:56 +00:00
< li class = "subfolders" >
< a href = "#" > HTML Rules< / a >
< ul >
< li > < a href = "pmd_rules_html.html" > Index< / a > < / li >
< li > < a href = "pmd_rules_html_bestpractices.html" > Best Practices< / a > < / li >
< / ul >
< / li >
2020-11-14 09:20:07 +00:00
< li class = "subfolders" >
< a href = "#" > Java Rules< / a >
< ul >
< li > < a href = "pmd_rules_java.html" > Index< / a > < / li >
< li > < a href = "pmd_rules_java_bestpractices.html" > Best Practices< / a > < / li >
< li > < a href = "pmd_rules_java_codestyle.html" > Code Style< / a > < / li >
< li > < a href = "pmd_rules_java_design.html" > Design< / a > < / li >
< li > < a href = "pmd_rules_java_documentation.html" > Documentation< / a > < / li >
< li > < a href = "pmd_rules_java_errorprone.html" > Error Prone< / a > < / li >
< li > < a href = "pmd_rules_java_multithreading.html" > Multithreading< / a > < / li >
< li > < a href = "pmd_rules_java_performance.html" > Performance< / a > < / li >
< li > < a href = "pmd_rules_java_security.html" > Security< / a > < / li >
< / ul >
< / li >
< li class = "subfolders" >
< a href = "#" > Java Server Pages Rules< / a >
< ul >
< li > < a href = "pmd_rules_jsp.html" > Index< / a > < / li >
< li > < a href = "pmd_rules_jsp_bestpractices.html" > Best Practices< / a > < / li >
< li > < a href = "pmd_rules_jsp_codestyle.html" > Code Style< / a > < / li >
< li > < a href = "pmd_rules_jsp_design.html" > Design< / a > < / li >
< li > < a href = "pmd_rules_jsp_errorprone.html" > Error Prone< / a > < / li >
< li > < a href = "pmd_rules_jsp_security.html" > Security< / a > < / li >
< / ul >
< / li >
2023-03-03 20:15:41 +00:00
< li class = "subfolders" >
< a href = "#" > JavaScript Rules< / a >
< ul >
< li > < a href = "pmd_rules_ecmascript.html" > Index< / a > < / li >
< li > < a href = "pmd_rules_ecmascript_bestpractices.html" > Best Practices< / a > < / li >
< li > < a href = "pmd_rules_ecmascript_codestyle.html" > Code Style< / a > < / li >
< li > < a href = "pmd_rules_ecmascript_errorprone.html" > Error Prone< / a > < / li >
< / ul >
< / li >
< li class = "subfolders" >
< a href = "#" > Kotlin Rules< / a >
< ul >
< li > < a href = "pmd_rules_kotlin.html" > Index< / a > < / li >
< li > < a href = "pmd_rules_kotlin_bestpractices.html" > Best Practices< / a > < / li >
< li > < a href = "pmd_rules_kotlin_errorprone.html" > Error Prone< / a > < / li >
< / ul >
< / li >
2020-11-14 09:20:07 +00:00
< li class = "subfolders" >
< a href = "#" > Maven POM Rules< / a >
< ul >
< li > < a href = "pmd_rules_pom.html" > Index< / a > < / li >
< li > < a href = "pmd_rules_pom_errorprone.html" > Error Prone< / a > < / li >
< / ul >
< / li >
< li class = "subfolders" >
< a href = "#" > Modelica Rules< / a >
< ul >
< li > < a href = "pmd_rules_modelica.html" > Index< / a > < / li >
< li > < a href = "pmd_rules_modelica_bestpractices.html" > Best Practices< / a > < / li >
< / ul >
< / li >
< li class = "subfolders" >
< a href = "#" > PLSQL Rules< / a >
< ul >
< li > < a href = "pmd_rules_plsql.html" > Index< / a > < / li >
< li > < a href = "pmd_rules_plsql_bestpractices.html" > Best Practices< / a > < / li >
< li > < a href = "pmd_rules_plsql_codestyle.html" > Code Style< / a > < / li >
< li > < a href = "pmd_rules_plsql_design.html" > Design< / a > < / li >
< li > < a href = "pmd_rules_plsql_errorprone.html" > Error Prone< / a > < / li >
< / ul >
< / li >
< li class = "subfolders" >
< a href = "#" > Salesforce VisualForce Rules< / a >
< ul >
< li > < a href = "pmd_rules_vf.html" > Index< / a > < / li >
< li > < a href = "pmd_rules_vf_security.html" > Security< / a > < / li >
< / ul >
< / li >
2022-11-18 15:25:16 +00:00
< li class = "subfolders" >
< a href = "#" > Scala Rules< / a >
< ul >
< li > < a href = "pmd_rules_scala.html" > Index< / a > < / li >
< / ul >
< / li >
2023-03-03 20:15:41 +00:00
< li class = "subfolders" >
< a href = "#" > Swift Rules< / a >
< ul >
< li > < a href = "pmd_rules_swift.html" > Index< / a > < / li >
< li > < a href = "pmd_rules_swift_bestpractices.html" > Best Practices< / a > < / li >
< li > < a href = "pmd_rules_swift_errorprone.html" > Error Prone< / a > < / li >
< / ul >
< / li >
2020-11-14 09:20:07 +00:00
< li class = "subfolders" >
< a href = "#" > VM Rules< / a >
< ul >
< li > < a href = "pmd_rules_vm.html" > Index< / a > < / li >
< li > < a href = "pmd_rules_vm_bestpractices.html" > Best Practices< / a > < / li >
< li > < a href = "pmd_rules_vm_design.html" > Design< / a > < / li >
< li > < a href = "pmd_rules_vm_errorprone.html" > Error Prone< / a > < / li >
< / ul >
< / li >
2022-11-18 15:25:16 +00:00
< li class = "subfolders" >
< a href = "#" > WSDL Rules< / a >
< ul >
< li > < a href = "pmd_rules_wsdl.html" > Index< / a > < / li >
< / ul >
< / li >
2020-11-14 09:20:07 +00:00
< li class = "subfolders" >
< a href = "#" > XML Rules< / a >
< ul >
< li > < a href = "pmd_rules_xml.html" > Index< / a > < / li >
< li > < a href = "pmd_rules_xml_errorprone.html" > Error Prone< / a > < / li >
< / ul >
< / li >
< li class = "subfolders" >
< a href = "#" > XSL Rules< / a >
< ul >
< li > < a href = "pmd_rules_xsl.html" > Index< / a > < / li >
< li > < a href = "pmd_rules_xsl_codestyle.html" > Code Style< / a > < / li >
< li > < a href = "pmd_rules_xsl_performance.html" > Performance< / a > < / li >
< / ul >
< / li >
< / ul >
< / li >
< li >
2023-03-03 20:15:41 +00:00
< a href = "#" > Language-Specific Documentation< / a >
2020-11-14 09:20:07 +00:00
< ul >
2023-03-03 20:15:41 +00:00
< li > < a href = "pmd_languages_configuration.html" > Language configuration< / a > < / li >
2020-11-14 09:20:07 +00:00
2023-03-03 20:15:41 +00:00
< li > < a href = "pmd_languages_apex.html" > Apex< / a > < / li >
2022-03-27 15:04:13 +00:00
2023-03-03 20:15:41 +00:00
< li > < a href = "pmd_languages_java.html" > Java< / a > < / li >
2022-03-27 15:04:13 +00:00
2023-03-03 20:15:41 +00:00
< li > < a href = "pmd_languages_jsp.html" > JSP< / a > < / li >
2020-11-14 09:20:07 +00:00
2023-03-03 20:15:41 +00:00
< li > < a href = "pmd_languages_kotlin.html" > Kotlin< / a > < / li >
2020-11-14 09:20:07 +00:00
2021-03-26 08:22:23 +00:00
< li > < a href = "pmd_languages_plsql.html" > PLSQL< / a > < / li >
2021-10-29 17:50:40 +00:00
< li > < a href = "pmd_languages_visualforce.html" > Visualforce< / a > < / li >
2022-03-25 07:44:53 +00:00
< li > < a href = "pmd_languages_xml.html" > XML and XML dialects< / a > < / li >
2022-04-28 13:34:56 +00:00
< li > < a href = "pmd_languages_html.html" > HTML< / a > < / li >
2022-07-01 07:55:16 +00:00
< li > < a href = "pmd_languages_gherkin.html" > Gherkin< / a > < / li >
2020-11-14 09:20:07 +00:00
< / ul >
< / li >
< li >
< a href = "#" > Developer Documentation< / a >
< ul >
< li > < a href = "pmd_devdocs_development.html" > Developer resources< / a > < / li >
< li > < a href = "pmd_devdocs_building.html" > Building PMD from source< / a > < / li >
< li > < a href = "https://github.com/pmd/pmd/blob/master/CONTRIBUTING.md" target = "_blank" > Contributing< / a > < / li >
< li > < a href = "pmd_devdocs_writing_documentation.html" > Writing documentation< / a > < / li >
< li > < a href = "pmd_devdocs_roadmap.html" > Roadmap< / a > < / li >
< li > < a href = "pmd_devdocs_how_pmd_works.html" > How PMD works< / a > < / li >
< li > < a href = "pmd_devdocs_pmdtester.html" > Pmdtester< / a > < / li >
< li > < a href = "pmd_devdocs_rule_deprecation_policy.html" > Rule Deprecation Policy< / a > < / li >
< li class = "subfolders" >
< a href = "#" > Major contributions< / a >
< ul >
2021-08-27 14:58:36 +00:00
< li > < a href = "pmd_devdocs_major_rule_guidelines.html" > Rule Guidelines< / a > < / li >
2023-03-03 20:15:41 +00:00
< li > < a href = "pmd_devdocs_major_adding_new_language_javacc.html" > Adding a new language (JavaCC)< / a > < / li >
2020-11-14 09:20:07 +00:00
2023-03-03 20:15:41 +00:00
< li > < a href = "pmd_devdocs_major_adding_new_language_antlr.html" > Adding a new language (Antlr)< / a > < / li >
2020-11-14 09:20:07 +00:00
2023-03-03 20:15:41 +00:00
< li > < a href = "pmd_devdocs_major_adding_new_cpd_language.html" > Adding a new CPD language< / a > < / li >
2020-11-14 09:20:07 +00:00
< / ul >
< / li >
< li class = "subfolders" >
< a href = "#" > Experimental features< / a >
< ul >
< li > < a href = "pmd_devdocs_experimental_ast_dump.html" > Creating (XML) dump of the AST< / a > < / li >
< / ul >
< / li >
< / ul >
< / li >
< li >
< a href = "#" > Project documentation< / a >
< ul >
< li class = "subfolders" >
< a href = "#" > Trivia about PMD< / a >
< ul >
< li > < a href = "pmd_projectdocs_trivia_news.html" > PMD in the press< / a > < / li >
< li > < a href = "pmd_projectdocs_trivia_products.html" > Products & books related to PMD< / a > < / li >
< li > < a href = "pmd_projectdocs_trivia_similarprojects.html" > Similar projects< / a > < / li >
< li > < a href = "pmd_projectdocs_trivia_meaning.html" > What does 'PMD' mean?< / a > < / li >
< / ul >
< / li >
2023-03-03 20:15:41 +00:00
< li > < a href = "pmd_projectdocs_logo.html" > Logo< / a > < / li >
2020-11-14 09:20:07 +00:00
< li > < a href = "pmd_projectdocs_faq.html" > FAQ< / a > < / li >
< li > < a href = "license.html" > License< / a > < / li >
< li > < a href = "pmd_projectdocs_credits.html" > Credits< / a > < / li >
< li > < a href = "pmd_release_notes_old.html" > Old release notes< / a > < / li >
2022-09-30 10:03:06 +00:00
< li > < a href = "pmd_projectdocs_decisions.html" > Decisions< / a > < / li >
2020-11-14 09:20:07 +00:00
< li class = "subfolders" >
< a href = "#" > Project management< / a >
< ul >
2021-04-23 20:35:51 +00:00
< li > < a href = "pmd_projectdocs_committers_infrastructure.html" > Infrastructure< / a > < / li >
2020-11-14 09:20:07 +00:00
< li > < a href = "pmd_projectdocs_committers_releasing.html" > Release process< / a > < / li >
< li > < a href = "pmd_projectdocs_committers_merging_pull_requests.html" > Merging pull requests< / a > < / li >
< li > < a href = "pmd_projectdocs_committers_main_landing_page.html" > Main Landing page< / a > < / li >
< / ul >
< / li >
< / ul >
< / li >
< / ul >
2022-02-25 09:51:51 +00:00
< / div >
2020-11-14 09:20:07 +00:00
2022-02-25 09:51:51 +00:00
<!-- Content Column -->
< div class = "col-md-9" id = "tg-sb-content" >
2022-03-24 11:42:13 +00:00
< header >
< div class = "row" >
< div class = "col-lg-12" >
< a href = "./" role = "button"
>< i class = "fa fa-home fa-lg" > < /i
>< / a >
» PMD Java API
< a
target="_blank"
href="https://github.com/pmd/pmd/blob/master/docs/pages/pmd/userdocs/tools/java-api.md"
2023-03-03 20:15:41 +00:00
class="float-right"
2022-03-24 11:42:13 +00:00
role="button"
>< i class = "fa fa-github fa-lg" > < / i > Edit on GitHub< /a
>
< / div >
< / div >
< hr / >
< / header >
< div class = "post-header" >
2020-11-14 09:20:07 +00:00
< h1 class = "post-title-main" > PMD Java API< / h1 >
< / div >
2022-03-24 11:42:13 +00:00
< div class = "post-content" data-github-edit-url = "https://github.com/pmd/pmd/blob/master/docs/pages/pmd/userdocs/tools/java-api.md" >
2020-11-14 09:20:07 +00:00
2022-02-25 09:51:51 +00:00
< div id = "inline-toc" > <!-- empty, move TOC here when screen size too small --> < / div >
2023-03-03 20:15:41 +00:00
2020-11-14 09:20:07 +00:00
< p > The easiest way to run PMD is to just use a build plugin in your favorite build tool
like < a href = "pmd_userdocs_tools_ant.html" > Apache Ant< / a > , < a href = "pmd_userdocs_tools_maven.html" > Apache Maven< / a > or
< a href = "pmd_userdocs_tools_gradle.html" > Gradle< / a > .< / p >
< p > There are also many integrations for IDEs available, see < a href = "pmd_userdocs_tools.html" > Tools< / a > .< / p >
< p > If you have your own build tool or want to integrate PMD in a different way, you can call PMD programmatically,
as described here.< / p >
< h2 id = "dependencies" > Dependencies< / h2 >
< p > You’
< code class = "language-plaintext highlighter-rouge" > net.sourceforge.pmd:pmd-java< / code > . If you use Maven, you can add a new (compile time) dependency like this:< / p >
< div class = "language-xml highlighter-rouge" > < div class = "highlight" > < pre class = "highlight" > < code > < span class = "nt" > < dependency> < / span >
< span class = "nt" > < groupId> < / span > net.sourceforge.pmd< span class = "nt" > < /groupId> < / span >
< span class = "nt" > < artifactId> < / span > pmd-java< span class = "nt" > < /artifactId> < / span >
< span class = "nt" > < version> < / span > ${pmdVersion}< span class = "nt" > < /version> < / span >
< span class = "nt" > < /dependency> < / span >
< / code > < / pre > < / div > < / div >
< p > Note: You’ < code class = "language-plaintext highlighter-rouge" > pmdVersion< / code > .< / p >
< p > This will transitively pull in the artifact < code class = "language-plaintext highlighter-rouge" > pmd-core< / code > which contains the API.< / p >
< h2 id = "command-line-interface" > Command line interface< / h2 >
< p > The easiest way is to call PMD with the same interface as from command line. The main class is
< code class = "language-plaintext highlighter-rouge" > net.sourceforge.pmd.PMD< / code > :< / p >
< div class = "language-java highlighter-rouge" > < div class = "highlight" > < pre class = "highlight" > < code > < span class = "kn" > import< / span > < span class = "nn" > net.sourceforge.pmd.PMD< / span > < span class = "o" > ;< / span >
< span class = "kd" > public< / span > < span class = "kd" > class< / span > < span class = "nc" > Example< / span > < span class = "o" > {< / span >
< span class = "kd" > public< / span > < span class = "kd" > static< / span > < span class = "kt" > void< / span > < span class = "nf" > main< / span > < span class = "o" > (< / span > < span class = "nc" > String< / span > < span class = "o" > []< / span > < span class = "n" > args< / span > < span class = "o" > )< / span > < span class = "o" > {< / span >
< span class = "nc" > String< / span > < span class = "o" > []< / span > < span class = "n" > pmdArgs< / span > < span class = "o" > =< / span > < span class = "o" > {< / span >
< span class = "s" > "-d"< / span > < span class = "o" > ,< / span > < span class = "s" > "/home/workspace/src/main/java/code"< / span > < span class = "o" > ,< / span >
< span class = "s" > "-R"< / span > < span class = "o" > ,< / span > < span class = "s" > "rulesets/java/quickstart.xml"< / span > < span class = "o" > ,< / span >
< span class = "s" > "-f"< / span > < span class = "o" > ,< / span > < span class = "s" > "xml"< / span > < span class = "o" > ,< / span >
< span class = "s" > "-r"< / span > < span class = "o" > ,< / span > < span class = "s" > "/home/workspace/pmd-report.xml"< / span >
< span class = "o" > };< / span >
< span class = "no" > PMD< / span > < span class = "o" > .< / span > < span class = "na" > main< / span > < span class = "o" > (< / span > < span class = "n" > pmdArgs< / span > < span class = "o" > );< / span >
< span class = "o" > }< / span >
< span class = "o" > }< / span >
< / code > < / pre > < / div > < / div >
< p > It uses the same options as described in < a href = "pmd_userdocs_cli_reference.html" > PMD CLI reference< / a > .< / p >
< h2 id = "programmatically-variant-1" > Programmatically, variant 1< / h2 >
< p > This is very similar:< / p >
< div class = "language-java highlighter-rouge" > < div class = "highlight" > < pre class = "highlight" > < code > < span class = "kn" > import< / span > < span class = "nn" > net.sourceforge.pmd.PMD< / span > < span class = "o" > ;< / span >
< span class = "kn" > import< / span > < span class = "nn" > net.sourceforge.pmd.PMDConfiguration< / span > < span class = "o" > ;< / span >
< span class = "kd" > public< / span > < span class = "kd" > class< / span > < span class = "nc" > PmdExample< / span > < span class = "o" > {< / span >
< span class = "kd" > public< / span > < span class = "kd" > static< / span > < span class = "kt" > void< / span > < span class = "nf" > main< / span > < span class = "o" > (< / span > < span class = "nc" > String< / span > < span class = "o" > []< / span > < span class = "n" > args< / span > < span class = "o" > )< / span > < span class = "o" > {< / span >
< span class = "nc" > PMDConfiguration< / span > < span class = "n" > configuration< / span > < span class = "o" > =< / span > < span class = "k" > new< / span > < span class = "nc" > PMDConfiguration< / span > < span class = "o" > ();< / span >
< span class = "n" > configuration< / span > < span class = "o" > .< / span > < span class = "na" > setInputPaths< / span > < span class = "o" > (< / span > < span class = "s" > "/home/workspace/src/main/java/code"< / span > < span class = "o" > );< / span >
2022-03-10 10:12:29 +00:00
< span class = "n" > configuration< / span > < span class = "o" > .< / span > < span class = "na" > addRuleSet< / span > < span class = "o" > (< / span > < span class = "s" > "rulesets/java/quickstart.xml"< / span > < span class = "o" > );< / span >
2020-11-14 09:20:07 +00:00
< span class = "n" > configuration< / span > < span class = "o" > .< / span > < span class = "na" > setReportFormat< / span > < span class = "o" > (< / span > < span class = "s" > "xml"< / span > < span class = "o" > );< / span >
< span class = "n" > configuration< / span > < span class = "o" > .< / span > < span class = "na" > setReportFile< / span > < span class = "o" > (< / span > < span class = "s" > "/home/workspace/pmd-report.xml"< / span > < span class = "o" > );< / span >
2022-03-03 16:46:13 +00:00
< span class = "no" > PMD< / span > < span class = "o" > .< / span > < span class = "na" > runPmd< / span > < span class = "o" > (< / span > < span class = "n" > configuration< / span > < span class = "o" > );< / span >
2020-11-14 09:20:07 +00:00
< span class = "o" > }< / span >
< span class = "o" > }< / span >
< / code > < / pre > < / div > < / div >
< h2 id = "programmatically-variant-2" > Programmatically, variant 2< / h2 >
< p > This gives you more control over which files are processed, but is also more complicated.
2021-05-27 09:02:51 +00:00
You can also provide your own custom renderers.< / p >
2020-11-14 09:20:07 +00:00
< ol >
< li >
2022-03-03 16:46:13 +00:00
< p > First we create a < code class = "language-plaintext highlighter-rouge" > PMDConfiguration< / code > and configure it, first the rules:< / p >
2020-11-14 09:20:07 +00:00
< div class = "language-java highlighter-rouge" > < div class = "highlight" > < pre class = "highlight" > < code > < span class = "nc" > PMDConfiguration< / span > < span class = "n" > configuration< / span > < span class = "o" > =< / span > < span class = "k" > new< / span > < span class = "nc" > PMDConfiguration< / span > < span class = "o" > ();< / span >
< span class = "n" > configuration< / span > < span class = "o" > .< / span > < span class = "na" > setMinimumPriority< / span > < span class = "o" > (< / span > < span class = "nc" > RulePriority< / span > < span class = "o" > .< / span > < span class = "na" > MEDIUM< / span > < span class = "o" > );< / span >
2022-03-10 10:12:29 +00:00
< span class = "n" > configuration< / span > < span class = "o" > .< / span > < span class = "na" > addRuleSet< / span > < span class = "o" > (< / span > < span class = "s" > "rulesets/java/quickstart.xml"< / span > < span class = "o" > );< / span >
2020-11-14 09:20:07 +00:00
< / code > < / pre > < / div > < / div >
< / li >
< li >
2022-03-03 16:46:13 +00:00
< p > Then we configure, which paths to analyze:< / p >
2020-11-14 09:20:07 +00:00
2022-03-03 16:46:13 +00:00
< div class = "language-java highlighter-rouge" > < div class = "highlight" > < pre class = "highlight" > < code > < span class = "n" > configuration< / span > < span class = "o" > .< / span > < span class = "na" > setInputPaths< / span > < span class = "o" > (< / span > < span class = "s" > "/home/workspace/src/main/java/code"< / span > < span class = "o" > );< / span >
2020-11-14 09:20:07 +00:00
< / code > < / pre > < / div > < / div >
< / li >
< li >
2022-03-03 16:46:13 +00:00
< p > The we configure the default language version for Java. And in order to support type resolution,
PMD needs to have access to the compiled classes and dependencies as well. This is called
“auxclasspath” and is also configured here.< / p >
2020-11-14 09:20:07 +00:00
2022-03-03 16:46:13 +00:00
< p > Note: you can specify multiple class paths separated by < code class = "language-plaintext highlighter-rouge" > :< / code > on Unix-systems or < code class = "language-plaintext highlighter-rouge" > ;< / code > under Windows.< / p >
< div class = "language-java highlighter-rouge" > < div class = "highlight" > < pre class = "highlight" > < code > < span class = "n" > configuration< / span > < span class = "o" > .< / span > < span class = "na" > setDefaultLanguageVersion< / span > < span class = "o" > (< / span > < span class = "nc" > LanguageRegistry< / span > < span class = "o" > .< / span > < span class = "na" > findLanguageByTerseName< / span > < span class = "o" > (< / span > < span class = "s" > "java"< / span > < span class = "o" > ).< / span > < span class = "na" > getVersion< / span > < span class = "o" > (< / span > < span class = "s" > "11"< / span > < span class = "o" > ));< / span >
< span class = "n" > configuration< / span > < span class = "o" > .< / span > < span class = "na" > prependAuxClasspath< / span > < span class = "o" > (< / span > < span class = "s" > "/home/workspace/target/classes:/home/.m2/repository/my/dependency.jar"< / span > < span class = "o" > );< / span >
2020-11-14 09:20:07 +00:00
< / code > < / pre > < / div > < / div >
< / li >
< li >
2022-03-03 16:46:13 +00:00
< p > Then we configure the reporting. Configuring the report file is optional. If not specified, the report
will be written to < code class = "language-plaintext highlighter-rouge" > stdout< / code > .< / p >
2020-11-14 09:20:07 +00:00
2022-03-03 16:46:13 +00:00
< div class = "language-java highlighter-rouge" > < div class = "highlight" > < pre class = "highlight" > < code > < span class = "n" > configuration< / span > < span class = "o" > .< / span > < span class = "na" > setReportFormat< / span > < span class = "o" > (< / span > < span class = "s" > "xml"< / span > < span class = "o" > );< / span >
< span class = "n" > configuration< / span > < span class = "o" > .< / span > < span class = "na" > setReportFile< / span > < span class = "o" > (< / span > < span class = "s" > "/home/workspace/pmd-report.xml"< / span > < span class = "o" > );< / span >
2020-11-14 09:20:07 +00:00
< / code > < / pre > < / div > < / div >
< / li >
< li >
2022-03-03 16:46:13 +00:00
< p > Now an optional step: If you want to use additional renderers as in the example, set them up before
calling PMD. You can use a built-in renderer, e.g. < code class = "language-plaintext highlighter-rouge" > XMLRenderer< / code > or a custom renderer implementing
< code class = "language-plaintext highlighter-rouge" > Renderer< / code > . Note, that you must manually initialize the renderer by setting a suitable < code class = "language-plaintext highlighter-rouge" > Writer< / code > :< / p >
< div class = "language-java highlighter-rouge" > < div class = "highlight" > < pre class = "highlight" > < code > < span class = "nc" > Writer< / span > < span class = "n" > rendererOutput< / span > < span class = "o" > =< / span > < span class = "k" > new< / span > < span class = "nc" > StringWriter< / span > < span class = "o" > ();< / span >
< span class = "nc" > Renderer< / span > < span class = "n" > renderer< / span > < span class = "o" > =< / span > < span class = "n" > createRenderer< / span > < span class = "o" > (< / span > < span class = "n" > rendererOutput< / span > < span class = "o" > );< / span >
2023-03-03 20:15:41 +00:00
2022-03-03 16:46:13 +00:00
< span class = "c1" > // ...< / span >
< span class = "kd" > private< / span > < span class = "kd" > static< / span > < span class = "nc" > Renderer< / span > < span class = "nf" > createRenderer< / span > < span class = "o" > (< / span > < span class = "nc" > Writer< / span > < span class = "n" > writer< / span > < span class = "o" > )< / span > < span class = "o" > {< / span >
< span class = "nc" > XMLRenderer< / span > < span class = "n" > xml< / span > < span class = "o" > =< / span > < span class = "k" > new< / span > < span class = "nc" > XMLRenderer< / span > < span class = "o" > (< / span > < span class = "s" > "UTF-8"< / span > < span class = "o" > );< / span >
< span class = "n" > xml< / span > < span class = "o" > .< / span > < span class = "na" > setWriter< / span > < span class = "o" > (< / span > < span class = "n" > writer< / span > < span class = "o" > );< / span >
< span class = "k" > return< / span > < span class = "n" > xml< / span > < span class = "o" > ;< / span >
< span class = "o" > }< / span >
2020-11-14 09:20:07 +00:00
< / code > < / pre > < / div > < / div >
< / li >
< li >
2022-03-03 16:46:13 +00:00
< p > Finally we can start the PMD analysis. There is the possibility to fine-tune the configuration
by adding additional files to analyze or adding additional rulesets or renderers:< / p >
< div class = "language-java highlighter-rouge" > < div class = "highlight" > < pre class = "highlight" > < code > < span class = "k" > try< / span > < span class = "o" > (< / span > < span class = "nc" > PmdAnalysis< / span > < span class = "n" > pmd< / span > < span class = "o" > =< / span > < span class = "nc" > PmdAnalysis< / span > < span class = "o" > .< / span > < span class = "na" > create< / span > < span class = "o" > (< / span > < span class = "n" > configuration< / span > < span class = "o" > ))< / span > < span class = "o" > {< / span >
< span class = "c1" > // optional: add more rulesets< / span >
2022-03-10 10:12:29 +00:00
< span class = "n" > pmd< / span > < span class = "o" > .< / span > < span class = "na" > addRuleSet< / span > < span class = "o" > (< / span > < span class = "n" > pmd< / span > < span class = "o" > .< / span > < span class = "na" > newRuleSetLoader< / span > < span class = "o" > ().< / span > < span class = "na" > loadFromResource< / span > < span class = "o" > (< / span > < span class = "s" > "custom-ruleset.xml"< / span > < span class = "o" > ));< / span >
2022-03-03 16:46:13 +00:00
< span class = "c1" > // optional: add more files< / span >
< span class = "n" > pmd< / span > < span class = "o" > .< / span > < span class = "na" > files< / span > < span class = "o" > ().< / span > < span class = "na" > addFile< / span > < span class = "o" > (< / span > < span class = "nc" > Paths< / span > < span class = "o" > .< / span > < span class = "na" > get< / span > < span class = "o" > (< / span > < span class = "s" > "src"< / span > < span class = "o" > ,< / span > < span class = "s" > "main"< / span > < span class = "o" > ,< / span > < span class = "s" > "more-java"< / span > < span class = "o" > ,< / span > < span class = "s" > "ExtraSource.java"< / span > < span class = "o" > ));< / span >
< span class = "c1" > // optional: add more renderers< / span >
< span class = "n" > pmd< / span > < span class = "o" > .< / span > < span class = "na" > addRenderer< / span > < span class = "o" > (< / span > < span class = "n" > renderer< / span > < span class = "o" > );< / span >
2023-03-03 20:15:41 +00:00
2022-03-03 16:46:13 +00:00
< span class = "c1" > // or just call PMD< / span >
< span class = "n" > pmd< / span > < span class = "o" > .< / span > < span class = "na" > performAnalysis< / span > < span class = "o" > ();< / span >
2020-11-14 09:20:07 +00:00
< span class = "o" > }< / span >
< / code > < / pre > < / div > < / div >
2022-03-03 16:46:13 +00:00
< p > The renderer will be automatically flushed and closed at the end of the analysis.< / p >
2020-11-14 09:20:07 +00:00
< / li >
< li >
2022-03-03 16:46:13 +00:00
< p > Then you can check the rendered output.< / p >
2020-11-14 09:20:07 +00:00
2022-03-03 16:46:13 +00:00
< div class = "language-java highlighter-rouge" > < div class = "highlight" > < pre class = "highlight" > < code > < span class = "nc" > System< / span > < span class = "o" > .< / span > < span class = "na" > out< / span > < span class = "o" > .< / span > < span class = "na" > println< / span > < span class = "o" > (< / span > < span class = "s" > "Rendered Report:"< / span > < span class = "o" > );< / span >
2020-11-14 09:20:07 +00:00
< span class = "nc" > System< / span > < span class = "o" > .< / span > < span class = "na" > out< / span > < span class = "o" > .< / span > < span class = "na" > println< / span > < span class = "o" > (< / span > < span class = "n" > rendererOutput< / span > < span class = "o" > .< / span > < span class = "na" > toString< / span > < span class = "o" > ());< / span >
< / code > < / pre > < / div > < / div >
< / li >
< / ol >
< p > Here is a complete example:< / p >
< div class = "language-java highlighter-rouge" > < div class = "highlight" > < pre class = "highlight" > < code > < span class = "kn" > import< / span > < span class = "nn" > java.io.IOException< / span > < span class = "o" > ;< / span >
< span class = "kn" > import< / span > < span class = "nn" > java.io.StringWriter< / span > < span class = "o" > ;< / span >
< span class = "kn" > import< / span > < span class = "nn" > java.io.Writer< / span > < span class = "o" > ;< / span >
2022-03-03 16:46:13 +00:00
< span class = "kn" > import< / span > < span class = "nn" > java.nio.file.Paths< / span > < span class = "o" > ;< / span >
2020-11-14 09:20:07 +00:00
< span class = "kn" > import< / span > < span class = "nn" > net.sourceforge.pmd.PMDConfiguration< / span > < span class = "o" > ;< / span >
2022-03-03 16:46:13 +00:00
< span class = "kn" > import< / span > < span class = "nn" > net.sourceforge.pmd.PmdAnalysis< / span > < span class = "o" > ;< / span >
2020-11-14 09:20:07 +00:00
< span class = "kn" > import< / span > < span class = "nn" > net.sourceforge.pmd.RulePriority< / span > < span class = "o" > ;< / span >
2022-03-03 16:46:13 +00:00
< span class = "kn" > import< / span > < span class = "nn" > net.sourceforge.pmd.lang.LanguageRegistry< / span > < span class = "o" > ;< / span >
2020-11-14 09:20:07 +00:00
< span class = "kn" > import< / span > < span class = "nn" > net.sourceforge.pmd.renderers.Renderer< / span > < span class = "o" > ;< / span >
< span class = "kn" > import< / span > < span class = "nn" > net.sourceforge.pmd.renderers.XMLRenderer< / span > < span class = "o" > ;< / span >
< span class = "kd" > public< / span > < span class = "kd" > class< / span > < span class = "nc" > PmdExample2< / span > < span class = "o" > {< / span >
< span class = "kd" > public< / span > < span class = "kd" > static< / span > < span class = "kt" > void< / span > < span class = "nf" > main< / span > < span class = "o" > (< / span > < span class = "nc" > String< / span > < span class = "o" > []< / span > < span class = "n" > args< / span > < span class = "o" > )< / span > < span class = "kd" > throws< / span > < span class = "nc" > IOException< / span > < span class = "o" > {< / span >
< span class = "nc" > PMDConfiguration< / span > < span class = "n" > configuration< / span > < span class = "o" > =< / span > < span class = "k" > new< / span > < span class = "nc" > PMDConfiguration< / span > < span class = "o" > ();< / span >
< span class = "n" > configuration< / span > < span class = "o" > .< / span > < span class = "na" > setMinimumPriority< / span > < span class = "o" > (< / span > < span class = "nc" > RulePriority< / span > < span class = "o" > .< / span > < span class = "na" > MEDIUM< / span > < span class = "o" > );< / span >
2022-03-10 10:12:29 +00:00
< span class = "n" > configuration< / span > < span class = "o" > .< / span > < span class = "na" > addRuleSet< / span > < span class = "o" > (< / span > < span class = "s" > "rulesets/java/quickstart.xml"< / span > < span class = "o" > );< / span >
2020-11-14 09:20:07 +00:00
2022-03-03 16:46:13 +00:00
< span class = "n" > configuration< / span > < span class = "o" > .< / span > < span class = "na" > setInputPaths< / span > < span class = "o" > (< / span > < span class = "s" > "/home/workspace/src/main/java/code"< / span > < span class = "o" > );< / span >
< span class = "n" > configuration< / span > < span class = "o" > .< / span > < span class = "na" > setDefaultLanguageVersion< / span > < span class = "o" > (< / span > < span class = "nc" > LanguageRegistry< / span > < span class = "o" > .< / span > < span class = "na" > findLanguageByTerseName< / span > < span class = "o" > (< / span > < span class = "s" > "java"< / span > < span class = "o" > ).< / span > < span class = "na" > getVersion< / span > < span class = "o" > (< / span > < span class = "s" > "11"< / span > < span class = "o" > ));< / span >
< span class = "n" > configuration< / span > < span class = "o" > .< / span > < span class = "na" > prependAuxClasspath< / span > < span class = "o" > (< / span > < span class = "s" > "/home/workspace/target/classes"< / span > < span class = "o" > );< / span >
< span class = "n" > configuration< / span > < span class = "o" > .< / span > < span class = "na" > setReportFormat< / span > < span class = "o" > (< / span > < span class = "s" > "xml"< / span > < span class = "o" > );< / span >
< span class = "n" > configuration< / span > < span class = "o" > .< / span > < span class = "na" > setReportFile< / span > < span class = "o" > (< / span > < span class = "s" > "/home/workspace/pmd-report.xml"< / span > < span class = "o" > );< / span >
2020-11-14 09:20:07 +00:00
< span class = "nc" > Writer< / span > < span class = "n" > rendererOutput< / span > < span class = "o" > =< / span > < span class = "k" > new< / span > < span class = "nc" > StringWriter< / span > < span class = "o" > ();< / span >
< span class = "nc" > Renderer< / span > < span class = "n" > renderer< / span > < span class = "o" > =< / span > < span class = "n" > createRenderer< / span > < span class = "o" > (< / span > < span class = "n" > rendererOutput< / span > < span class = "o" > );< / span >
2022-03-03 16:46:13 +00:00
< span class = "k" > try< / span > < span class = "o" > (< / span > < span class = "nc" > PmdAnalysis< / span > < span class = "n" > pmd< / span > < span class = "o" > =< / span > < span class = "nc" > PmdAnalysis< / span > < span class = "o" > .< / span > < span class = "na" > create< / span > < span class = "o" > (< / span > < span class = "n" > configuration< / span > < span class = "o" > ))< / span > < span class = "o" > {< / span >
< span class = "c1" > // optional: add more rulesets< / span >
2022-03-10 10:12:29 +00:00
< span class = "n" > pmd< / span > < span class = "o" > .< / span > < span class = "na" > addRuleSet< / span > < span class = "o" > (< / span > < span class = "n" > pmd< / span > < span class = "o" > .< / span > < span class = "na" > newRuleSetLoader< / span > < span class = "o" > ().< / span > < span class = "na" > loadFromResource< / span > < span class = "o" > (< / span > < span class = "s" > "custom-ruleset.xml"< / span > < span class = "o" > ));< / span >
2022-03-03 16:46:13 +00:00
< span class = "c1" > // optional: add more files< / span >
< span class = "n" > pmd< / span > < span class = "o" > .< / span > < span class = "na" > files< / span > < span class = "o" > ().< / span > < span class = "na" > addFile< / span > < span class = "o" > (< / span > < span class = "nc" > Paths< / span > < span class = "o" > .< / span > < span class = "na" > get< / span > < span class = "o" > (< / span > < span class = "s" > "src"< / span > < span class = "o" > ,< / span > < span class = "s" > "main"< / span > < span class = "o" > ,< / span > < span class = "s" > "more-java"< / span > < span class = "o" > ,< / span > < span class = "s" > "ExtraSource.java"< / span > < span class = "o" > ));< / span >
< span class = "c1" > // optional: add more renderers< / span >
< span class = "n" > pmd< / span > < span class = "o" > .< / span > < span class = "na" > addRenderer< / span > < span class = "o" > (< / span > < span class = "n" > renderer< / span > < span class = "o" > );< / span >
< span class = "c1" > // or just call PMD< / span >
< span class = "n" > pmd< / span > < span class = "o" > .< / span > < span class = "na" > performAnalysis< / span > < span class = "o" > ();< / span >
2020-11-14 09:20:07 +00:00
< span class = "o" > }< / span >
< span class = "nc" > System< / span > < span class = "o" > .< / span > < span class = "na" > out< / span > < span class = "o" > .< / span > < span class = "na" > println< / span > < span class = "o" > (< / span > < span class = "s" > "Rendered Report:"< / span > < span class = "o" > );< / span >
< span class = "nc" > System< / span > < span class = "o" > .< / span > < span class = "na" > out< / span > < span class = "o" > .< / span > < span class = "na" > println< / span > < span class = "o" > (< / span > < span class = "n" > rendererOutput< / span > < span class = "o" > .< / span > < span class = "na" > toString< / span > < span class = "o" > ());< / span >
< span class = "o" > }< / span >
< span class = "kd" > private< / span > < span class = "kd" > static< / span > < span class = "nc" > Renderer< / span > < span class = "nf" > createRenderer< / span > < span class = "o" > (< / span > < span class = "nc" > Writer< / span > < span class = "n" > writer< / span > < span class = "o" > )< / span > < span class = "o" > {< / span >
< span class = "nc" > XMLRenderer< / span > < span class = "n" > xml< / span > < span class = "o" > =< / span > < span class = "k" > new< / span > < span class = "nc" > XMLRenderer< / span > < span class = "o" > (< / span > < span class = "s" > "UTF-8"< / span > < span class = "o" > );< / span >
< span class = "n" > xml< / span > < span class = "o" > .< / span > < span class = "na" > setWriter< / span > < span class = "o" > (< / span > < span class = "n" > writer< / span > < span class = "o" > );< / span >
< span class = "k" > return< / span > < span class = "n" > xml< / span > < span class = "o" > ;< / span >
< span class = "o" > }< / span >
< span class = "o" > }< / span >
< / code > < / pre > < / div > < / div >
< div class = "tags" >
< b > Tags: < / b >
2023-03-03 20:15:41 +00:00
< a href = "tag_userdocs.html" class = "btn btn-outline-secondary navbar-btn cursorNorm" role = "button" > userdocs< / a >
2020-11-14 09:20:07 +00:00
2023-03-03 20:15:41 +00:00
< a href = "tag_tools.html" class = "btn btn-outline-secondary navbar-btn cursorNorm" role = "button" > tools< / a >
2020-11-14 09:20:07 +00:00
< / div >
< / div >
< footer >
2022-03-24 11:42:13 +00:00
< hr / >
< div >
This documentation is written in markdown. < br / >
If there is something missing or can be improved, edit this page on
github and create a PR:
< a
target="_blank"
href="https://github.com/pmd/pmd/blob/master/docs/pages/pmd/userdocs/tools/java-api.md"
role="button"
>< i class = "fa fa-github fa-lg" > < / i > Edit on GitHub< /a
>
< / div >
< hr / >
< div class = "row" >
< div class = "col-lg-12 footer" >
2023-01-01 04:26:09 +00:00
© 2023 PMD Open Source Project. All rights
2022-03-24 11:42:13 +00:00
reserved. < br / >
2023-03-04 21:22:12 +00:00
Site last generated: Mar 4, 2023 < br / >
2022-03-24 11:42:13 +00:00
< p >
2023-03-03 20:15:41 +00:00
< img src = "images/logo/pmd-logo-70px.png" alt = "PMD
2022-03-24 11:42:13 +00:00
logo"/>
< / p >
< / div >
< / div >
2020-11-14 09:20:07 +00:00
< / footer >
2022-02-25 09:51:51 +00:00
< / div >
<!-- /.row -->
2020-11-14 09:20:07 +00:00
< / div >
2022-02-25 09:51:51 +00:00
<!-- /.container -->
< / div >
<!-- Sticky TOC column -->
< div class = "toc-col" >
2022-03-24 11:42:13 +00:00
< div id = "toc" > < / div >
2020-11-14 09:20:07 +00:00
< / div >
2022-02-25 09:51:51 +00:00
<!-- /.toc - container - wrapper -->
2020-11-14 09:20:07 +00:00
< / div >
< / div >
2023-03-03 20:15:41 +00:00
< script type = "application/javascript" src = "assets/jquery-3.5.1/jquery-3.5.1.min.js" > < / script >
< script type = "application/javascript" src = "assets/anchorjs-4.2.2/anchor.min.js" > < / script >
< script type = "application/javascript" src = "assets/navgoco-0.2.1/src/jquery.navgoco.min.js" > < / script >
< script type = "application/javascript" src = "assets/bootstrap-4.5.2-dist/js/bootstrap.bundle.min.js" > < / script >
< script type = "application/javascript" src = "assets/Simple-Jekyll-Search-1.0.8/dest/jekyll-search.js" > < / script >
< script type = "application/javascript" src = "assets/jekyll-table-of-contents/toc.js" > < / script >
< script type = "application/javascript" src = "js/tabstate.js" > < / script >
< script type = "application/javascript" src = "js/customscripts.js" > < / script >
< / body >
2020-11-14 09:20:07 +00:00
< / html >
