| <!doctype html> |
| <html class="no-js" lang="en" data-content_root="../"> |
| <head><meta charset="utf-8"/> |
| <meta name="viewport" content="width=device-width,initial-scale=1"/> |
| <meta name="color-scheme" content="light dark"><meta name="viewport" content="width=device-width, initial-scale=1" /> |
| <link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="Memory Management" href="../memory.html" /><link rel="prev" title="Building Arrow Java" href="building.html" /> |
| |
| <!-- Generated with Sphinx 8.1.3 and Furo 2024.08.06 --> |
| <title>Development Guidelines - arrow-java 18.1.0 documentation</title> |
| <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=8f2a1f02" /> |
| <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=354aac6f" /> |
| <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=302659d7" /> |
| |
| |
| |
| |
| <style> |
| body { |
| --color-code-background: #f8f8f8; |
| --color-code-foreground: black; |
| |
| } |
| @media not print { |
| body[data-theme="dark"] { |
| --color-code-background: #202020; |
| --color-code-foreground: #d0d0d0; |
| |
| } |
| @media (prefers-color-scheme: dark) { |
| body:not([data-theme="light"]) { |
| --color-code-background: #202020; |
| --color-code-foreground: #d0d0d0; |
| |
| } |
| } |
| } |
| </style></head> |
| <body> |
| |
| <script> |
| document.body.dataset.theme = localStorage.getItem("theme") || "auto"; |
| </script> |
| |
| |
| <svg xmlns="http://www.w3.org/2000/svg" style="display: none;"> |
| <symbol id="svg-toc" viewBox="0 0 24 24"> |
| <title>Contents</title> |
| <svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024"> |
| <path d="M408 442h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8zm-8 204c0 4.4 3.6 8 8 8h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56zm504-486H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zm0 632H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zM115.4 518.9L271.7 642c5.8 4.6 14.4.5 14.4-6.9V388.9c0-7.4-8.5-11.5-14.4-6.9L115.4 505.1a8.74 8.74 0 0 0 0 13.8z"/> |
| </svg> |
| </symbol> |
| <symbol id="svg-menu" viewBox="0 0 24 24"> |
| <title>Menu</title> |
| <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" |
| stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu"> |
| <line x1="3" y1="12" x2="21" y2="12"></line> |
| <line x1="3" y1="6" x2="21" y2="6"></line> |
| <line x1="3" y1="18" x2="21" y2="18"></line> |
| </svg> |
| </symbol> |
| <symbol id="svg-arrow-right" viewBox="0 0 24 24"> |
| <title>Expand</title> |
| <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" |
| stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right"> |
| <polyline points="9 18 15 12 9 6"></polyline> |
| </svg> |
| </symbol> |
| <symbol id="svg-sun" viewBox="0 0 24 24"> |
| <title>Light mode</title> |
| <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" |
| stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="feather-sun"> |
| <circle cx="12" cy="12" r="5"></circle> |
| <line x1="12" y1="1" x2="12" y2="3"></line> |
| <line x1="12" y1="21" x2="12" y2="23"></line> |
| <line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line> |
| <line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line> |
| <line x1="1" y1="12" x2="3" y2="12"></line> |
| <line x1="21" y1="12" x2="23" y2="12"></line> |
| <line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line> |
| <line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line> |
| </svg> |
| </symbol> |
| <symbol id="svg-moon" viewBox="0 0 24 24"> |
| <title>Dark mode</title> |
| <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" |
| stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon"> |
| <path stroke="none" d="M0 0h24v24H0z" fill="none" /> |
| <path d="M12 3c.132 0 .263 0 .393 0a7.5 7.5 0 0 0 7.92 12.446a9 9 0 1 1 -8.313 -12.454z" /> |
| </svg> |
| </symbol> |
| <symbol id="svg-sun-with-moon" viewBox="0 0 24 24"> |
| <title>Auto light/dark, in light mode</title> |
| <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" |
| stroke-width="1" stroke-linecap="round" stroke-linejoin="round" |
| class="icon-custom-derived-from-feather-sun-and-tabler-moon"> |
| <path style="opacity: 50%" d="M 5.411 14.504 C 5.471 14.504 5.532 14.504 5.591 14.504 C 3.639 16.319 4.383 19.569 6.931 20.352 C 7.693 20.586 8.512 20.551 9.25 20.252 C 8.023 23.207 4.056 23.725 2.11 21.184 C 0.166 18.642 1.702 14.949 4.874 14.536 C 5.051 14.512 5.231 14.5 5.411 14.5 L 5.411 14.504 Z"/> |
| <line x1="14.5" y1="3.25" x2="14.5" y2="1.25"/> |
| <line x1="14.5" y1="15.85" x2="14.5" y2="17.85"/> |
| <line x1="10.044" y1="5.094" x2="8.63" y2="3.68"/> |
| <line x1="19" y1="14.05" x2="20.414" y2="15.464"/> |
| <line x1="8.2" y1="9.55" x2="6.2" y2="9.55"/> |
| <line x1="20.8" y1="9.55" x2="22.8" y2="9.55"/> |
| <line x1="10.044" y1="14.006" x2="8.63" y2="15.42"/> |
| <line x1="19" y1="5.05" x2="20.414" y2="3.636"/> |
| <circle cx="14.5" cy="9.55" r="3.6"/> |
| </svg> |
| </symbol> |
| <symbol id="svg-moon-with-sun" viewBox="0 0 24 24"> |
| <title>Auto light/dark, in dark mode</title> |
| <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" |
| stroke-width="1" stroke-linecap="round" stroke-linejoin="round" |
| class="icon-custom-derived-from-feather-sun-and-tabler-moon"> |
| <path d="M 8.282 7.007 C 8.385 7.007 8.494 7.007 8.595 7.007 C 5.18 10.184 6.481 15.869 10.942 17.24 C 12.275 17.648 13.706 17.589 15 17.066 C 12.851 22.236 5.91 23.143 2.505 18.696 C -0.897 14.249 1.791 7.786 7.342 7.063 C 7.652 7.021 7.965 7 8.282 7 L 8.282 7.007 Z"/> |
| <line style="opacity: 50%" x1="18" y1="3.705" x2="18" y2="2.5"/> |
| <line style="opacity: 50%" x1="18" y1="11.295" x2="18" y2="12.5"/> |
| <line style="opacity: 50%" x1="15.316" y1="4.816" x2="14.464" y2="3.964"/> |
| <line style="opacity: 50%" x1="20.711" y1="10.212" x2="21.563" y2="11.063"/> |
| <line style="opacity: 50%" x1="14.205" y1="7.5" x2="13.001" y2="7.5"/> |
| <line style="opacity: 50%" x1="21.795" y1="7.5" x2="23" y2="7.5"/> |
| <line style="opacity: 50%" x1="15.316" y1="10.184" x2="14.464" y2="11.036"/> |
| <line style="opacity: 50%" x1="20.711" y1="4.789" x2="21.563" y2="3.937"/> |
| <circle style="opacity: 50%" cx="18" cy="7.5" r="2.169"/> |
| </svg> |
| </symbol> |
| <symbol id="svg-pencil" viewBox="0 0 24 24"> |
| <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" |
| stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-pencil-code"> |
| <path d="M4 20h4l10.5 -10.5a2.828 2.828 0 1 0 -4 -4l-10.5 10.5v4" /> |
| <path d="M13.5 6.5l4 4" /> |
| <path d="M20 21l2 -2l-2 -2" /> |
| <path d="M17 17l-2 2l2 2" /> |
| </svg> |
| </symbol> |
| <symbol id="svg-eye" viewBox="0 0 24 24"> |
| <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" |
| stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-eye-code"> |
| <path stroke="none" d="M0 0h24v24H0z" fill="none" /> |
| <path d="M10 12a2 2 0 1 0 4 0a2 2 0 0 0 -4 0" /> |
| <path |
| d="M11.11 17.958c-3.209 -.307 -5.91 -2.293 -8.11 -5.958c2.4 -4 5.4 -6 9 -6c3.6 0 6.6 2 9 6c-.21 .352 -.427 .688 -.647 1.008" /> |
| <path d="M20 21l2 -2l-2 -2" /> |
| <path d="M17 17l-2 2l2 2" /> |
| </svg> |
| </symbol> |
| </svg> |
| |
| <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation"> |
| <input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc"> |
| <label class="overlay sidebar-overlay" for="__navigation"> |
| <div class="visually-hidden">Hide navigation sidebar</div> |
| </label> |
| <label class="overlay toc-overlay" for="__toc"> |
| <div class="visually-hidden">Hide table of contents sidebar</div> |
| </label> |
| |
| <a class="skip-to-content muted-link" href="#furo-main-content">Skip to content</a> |
| |
| |
| |
| <div class="page"> |
| <header class="mobile-header"> |
| <div class="header-left"> |
| <label class="nav-overlay-icon" for="__navigation"> |
| <div class="visually-hidden">Toggle site navigation sidebar</div> |
| <i class="icon"><svg><use href="#svg-menu"></use></svg></i> |
| </label> |
| </div> |
| <div class="header-center"> |
| <a href="../index.html"><div class="brand">arrow-java 18.1.0 documentation</div></a> |
| </div> |
| <div class="header-right"> |
| <div class="theme-toggle-container theme-toggle-header"> |
| <button class="theme-toggle"> |
| <div class="visually-hidden">Toggle Light / Dark / Auto color theme</div> |
| <svg class="theme-icon-when-auto-light"><use href="#svg-sun-with-moon"></use></svg> |
| <svg class="theme-icon-when-auto-dark"><use href="#svg-moon-with-sun"></use></svg> |
| <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg> |
| <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg> |
| </button> |
| </div> |
| <label class="toc-overlay-icon toc-header-icon" for="__toc"> |
| <div class="visually-hidden">Toggle table of contents sidebar</div> |
| <i class="icon"><svg><use href="#svg-toc"></use></svg></i> |
| </label> |
| </div> |
| </header> |
| <aside class="sidebar-drawer"> |
| <div class="sidebar-container"> |
| |
| <div class="sidebar-sticky"><a class="sidebar-brand" href="../index.html"> |
| |
| |
| <span class="sidebar-brand-text">arrow-java 18.1.0 documentation</span> |
| |
| </a><form class="sidebar-search-container" method="get" action="../search.html" role="search"> |
| <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search"> |
| <input type="hidden" name="check_keywords" value="yes"> |
| <input type="hidden" name="area" value="default"> |
| </form> |
| <div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree"> |
| <ul class="current"> |
| <li class="toctree-l1"><a class="reference internal" href="../quickstartguide.html">Quick Start Guide</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../overview.html">High-Level Overview</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../install.html">Installing Java Modules</a></li> |
| <li class="toctree-l1 current has-children"><a class="reference internal" href="index.html">Java Development</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of Java Development</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="current"> |
| <li class="toctree-l2"><a class="reference internal" href="building.html">Building Arrow Java</a></li> |
| <li class="toctree-l2 current current-page"><a class="current reference internal" href="#">Development Guidelines</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="../memory.html">Memory Management</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../vector.html">ValueVector</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../vector_schema_root.html">Tabular Data</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../table.html">Table</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../ipc.html">Reading/Writing IPC formats</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../algorithm.html">Java Algorithms</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../flight.html">Arrow Flight RPC</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../flight_sql.html">Arrow Flight SQL</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../flight_sql_jdbc_driver.html">Arrow Flight SQL JDBC Driver</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../dataset.html">Dataset</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../substrait.html">Substrait</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../cdata.html">C Data Interface</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../jdbc.html">Arrow JDBC Adapter</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../reference/index.html">Reference (javadoc)</a></li> |
| <li class="toctree-l1"><a class="reference external" href="https://arrow.apache.org/cookbook/java/">Cookbook</a></li> |
| </ul> |
| |
| </div> |
| </div> |
| |
| </div> |
| |
| </div> |
| </aside> |
| <div class="main"> |
| <div class="content"> |
| <div class="article-container"> |
| <a href="#" class="back-to-top muted-link"> |
| <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"> |
| <path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path> |
| </svg> |
| <span>Back to top</span> |
| </a> |
| <div class="content-icon-container"> |
| <div class="view-this-page"> |
| <a class="muted-link" href="../_sources/developers/development.rst.txt" title="View this page"> |
| <svg><use href="#svg-eye"></use></svg> |
| <span class="visually-hidden">View this page</span> |
| </a> |
| </div> |
| <div class="theme-toggle-container theme-toggle-content"> |
| <button class="theme-toggle"> |
| <div class="visually-hidden">Toggle Light / Dark / Auto color theme</div> |
| <svg class="theme-icon-when-auto-light"><use href="#svg-sun-with-moon"></use></svg> |
| <svg class="theme-icon-when-auto-dark"><use href="#svg-moon-with-sun"></use></svg> |
| <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg> |
| <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg> |
| </button> |
| </div> |
| <label class="toc-overlay-icon toc-content-icon" for="__toc"> |
| <div class="visually-hidden">Toggle table of contents sidebar</div> |
| <i class="icon"><svg><use href="#svg-toc"></use></svg></i> |
| </label> |
| </div> |
| <article role="main" id="furo-main-content"> |
| <section id="development-guidelines"> |
| <h1><a class="toc-backref" href="#id2" role="doc-backlink">Development Guidelines</a><a class="headerlink" href="#development-guidelines" title="Link to this heading">¶</a></h1> |
| <nav class="contents" id="contents"> |
| <p class="topic-title">Contents</p> |
| <ul class="simple"> |
| <li><p><a class="reference internal" href="#development-guidelines" id="id2">Development Guidelines</a></p> |
| <ul> |
| <li><p><a class="reference internal" href="#logger-abstraction" id="id3">Logger Abstraction</a></p></li> |
| <li><p><a class="reference internal" href="#unit-testing" id="id4">Unit Testing</a></p></li> |
| <li><p><a class="reference internal" href="#performance-testing" id="id5">Performance Testing</a></p></li> |
| <li><p><a class="reference internal" href="#integration-testing" id="id6">Integration Testing</a></p></li> |
| <li><p><a class="reference internal" href="#code-style" id="id7">Code Style</a></p> |
| <ul> |
| <li><p><a class="reference internal" href="#automatically-fixing-code-style-issues" id="id8">Automatically fixing code style issues</a></p></li> |
| <li><p><a class="reference internal" href="#code-formatter-for-intellij-idea-and-eclipse" id="id9">Code Formatter for Intellij IDEA and Eclipse</a></p></li> |
| <li><p><a class="reference internal" href="#checkstyle" id="id10">Checkstyle</a></p></li> |
| </ul> |
| </li> |
| <li><p><a class="reference internal" href="#build-caching" id="id11">Build Caching</a></p></li> |
| <li><p><a class="reference internal" href="#errorprone" id="id12">ErrorProne</a></p></li> |
| </ul> |
| </li> |
| </ul> |
| </nav> |
| <section id="logger-abstraction"> |
| <h2><a class="toc-backref" href="#id3" role="doc-backlink">Logger Abstraction</a><a class="headerlink" href="#logger-abstraction" title="Link to this heading">¶</a></h2> |
| <p>Apache Arrow Java uses the SLF4J API, so please configure SLF4J to see logs (e.g. via Logback/Apache Log4j):</p> |
| <ol class="arabic simple"> |
| <li><p>If no jar dependencies are added by the user via Logback or Apache Log4j then SLF4J will default |
| to no-operation (NOP) logging.</p></li> |
| <li><p>If a user adds any dependencies via Logback or Apache Log4j but does not configure/add/define |
| logback.xml/log4j2.xml, then logs will default to DEBUG mode.</p></li> |
| <li><p>To disable debug logs, the user must define their own rules within their logback.xml/log4j2.xml |
| and define their own loggers.</p></li> |
| </ol> |
| </section> |
| <section id="unit-testing"> |
| <h2><a class="toc-backref" href="#id4" role="doc-backlink">Unit Testing</a><a class="headerlink" href="#unit-testing" title="Link to this heading">¶</a></h2> |
| <p>Unit tests are run by Maven during the build.</p> |
| <p>To speed up the build, you can skip them by passing -DskipTests.</p> |
| <div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$ </span><span class="nb">cd</span><span class="w"> </span>arrow/java |
| <span class="gp">$ </span>mvn<span class="w"> </span><span class="se">\</span> |
| <span class="w"> </span>-Darrow.cpp.build.dir<span class="o">=</span>../java-dist/lib<span class="w"> </span>-Parrow-jni<span class="w"> </span><span class="se">\</span> |
| <span class="w"> </span>-Darrow.c.jni.dist.dir<span class="o">=</span>../java-dist/lib<span class="w"> </span>-Parrow-c-data<span class="w"> </span><span class="se">\</span> |
| <span class="w"> </span>clean<span class="w"> </span>install |
| </pre></div> |
| </div> |
| </section> |
| <section id="performance-testing"> |
| <h2><a class="toc-backref" href="#id5" role="doc-backlink">Performance Testing</a><a class="headerlink" href="#performance-testing" title="Link to this heading">¶</a></h2> |
| <p>The <code class="docutils literal notranslate"><span class="pre">arrow-performance</span></code> module contains benchmarks.</p> |
| <p>Let’s configure our environment to run performance tests:</p> |
| <ul class="simple"> |
| <li><p>Install <a class="reference external" href="https://github.com/ursacomputing/benchmarks">benchmark</a></p></li> |
| <li><p>Install <a class="reference external" href="https://github.com/apache/arrow/blob/main/dev/conbench_envs/README.md#L188">archery</a></p></li> |
| </ul> |
| <p>In case you need to see your performance tests on the UI, then, configure (optional):</p> |
| <ul class="simple"> |
| <li><p>Install <a class="reference external" href="https://github.com/conbench/conbench">conbench</a></p></li> |
| </ul> |
| <p>Lets execute benchmark tests:</p> |
| <div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$ </span><span class="nb">cd</span><span class="w"> </span>benchmarks |
| <span class="gp">$ </span>conbench<span class="w"> </span>java-micro<span class="w"> </span>--help |
| <span class="gp">$ </span>conbench<span class="w"> </span>java-micro |
| <span class="go"> --iterations=1</span> |
| <span class="go"> --commit=e90472e35b40f58b17d408438bb8de1641bfe6ef</span> |
| <span class="go"> --java-home=<absolute path to your java home></span> |
| <span class="go"> --src=<absolute path to your arrow project></span> |
| <span class="go"> --benchmark-filter=org.apache.arrow.adapter.AvroAdapterBenchmarks.testAvroToArrow</span> |
| <span class="go">Benchmark Mode Cnt Score Error Units</span> |
| <span class="go">AvroAdapterBenchmarks.testAvroToArrow avgt 725545.783 ns/op</span> |
| <span class="go">Time to POST http://localhost:5000/api/login/ 0.14911699295043945</span> |
| <span class="go">Time to POST http://localhost:5000/api/benchmarks/ 0.06116318702697754</span> |
| </pre></div> |
| </div> |
| <p>Then go to: <a class="reference external" href="http://127.0.0.1:5000/">http://127.0.0.1:5000/</a> to see reports:</p> |
| <p>UI Home:</p> |
| <img alt="../_images/conbench_ui.png" src="../_images/conbench_ui.png" /> |
| <p>UI Runs:</p> |
| <img alt="../_images/conbench_runs.png" src="../_images/conbench_runs.png" /> |
| <p>UI Benchmark:</p> |
| <img alt="../_images/conbench_benchmark.png" src="../_images/conbench_benchmark.png" /> |
| </section> |
| <section id="integration-testing"> |
| <h2><a class="toc-backref" href="#id6" role="doc-backlink">Integration Testing</a><a class="headerlink" href="#integration-testing" title="Link to this heading">¶</a></h2> |
| <p>Integration tests can be run <a class="reference external" href="https://arrow.apache.org/docs/format/Integration.html#running-integration-tests" title="(in Apache Arrow v19.0.0)"><span class="xref std std-ref">via Archery</span></a>. |
| For example, assuming you only built Arrow Java and want to run the IPC |
| integration tests, you would do:</p> |
| <div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$ </span>archery<span class="w"> </span>integration<span class="w"> </span>--run-ipc<span class="w"> </span>--with-java<span class="w"> </span><span class="m">1</span> |
| </pre></div> |
| </div> |
| </section> |
| <section id="code-style"> |
| <h2><a class="toc-backref" href="#id7" role="doc-backlink">Code Style</a><a class="headerlink" href="#code-style" title="Link to this heading">¶</a></h2> |
| <p>The current Java code follows the <a class="reference external" href="https://google.github.io/styleguide/javaguide.html">Google Java Style</a> with Apache license headers.</p> |
| <p>Java code style is checked by <a class="reference external" href="https://github.com/diffplug/spotless">Spotless</a> during the build, and the continuous integration build will verify |
| that changes adhere to the style guide.</p> |
| <section id="automatically-fixing-code-style-issues"> |
| <h3><a class="toc-backref" href="#id8" role="doc-backlink">Automatically fixing code style issues</a><a class="headerlink" href="#automatically-fixing-code-style-issues" title="Link to this heading">¶</a></h3> |
| <ul class="simple"> |
| <li><p>You can check the style without building the project with <code class="docutils literal notranslate"><span class="pre">mvn</span> <span class="pre">spotless:check</span></code>.</p></li> |
| <li><p>You can autoformat the source with <code class="docutils literal notranslate"><span class="pre">mvn</span> <span class="pre">spotless:apply</span></code>.</p></li> |
| </ul> |
| <p>Example:</p> |
| <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>The<span class="w"> </span>following<span class="w"> </span>files<span class="w"> </span>had<span class="w"> </span>format<span class="w"> </span>violations: |
| <span class="w"> </span>src/main/java/org/apache/arrow/algorithm/rank/VectorRank.java |
| <span class="w"> </span>@@<span class="w"> </span>-15,7<span class="w"> </span>+15,6<span class="w"> </span>@@ |
| <span class="w"> </span>·*·limitations·under·the·License. |
| <span class="w"> </span>·*/ |
| |
| <span class="w"> </span>- |
| <span class="w"> </span>package·org.apache.arrow.algorithm.rank<span class="p">;</span> |
| |
| <span class="w"> </span>import·java.util.stream.IntStream<span class="p">;</span> |
| Run<span class="w"> </span><span class="s1">'mvn spotless:apply'</span><span class="w"> </span>to<span class="w"> </span>fix<span class="w"> </span>these<span class="w"> </span>violations. |
| </pre></div> |
| </div> |
| </section> |
| <section id="code-formatter-for-intellij-idea-and-eclipse"> |
| <h3><a class="toc-backref" href="#id9" role="doc-backlink">Code Formatter for Intellij IDEA and Eclipse</a><a class="headerlink" href="#code-formatter-for-intellij-idea-and-eclipse" title="Link to this heading">¶</a></h3> |
| <p>Follow the instructions to set up google-java-format for:</p> |
| <ul class="simple"> |
| <li><p><a class="reference external" href="https://github.com/google/google-java-format?tab=readme-ov-file#eclipse">Eclipse</a></p></li> |
| <li><p><a class="reference external" href="https://github.com/google/google-java-format?tab=readme-ov-file#intellij-android-studio-and-other-jetbrains-ides">IntelliJ</a></p></li> |
| </ul> |
| </section> |
| <section id="checkstyle"> |
| <h3><a class="toc-backref" href="#id10" role="doc-backlink">Checkstyle</a><a class="headerlink" href="#checkstyle" title="Link to this heading">¶</a></h3> |
| <p>Checkstyle is also used for general linting. The configuration is located at <a class="reference external" href="https://github.com/apache/arrow/blob/main/java/dev/checkstyle/checkstyle.xml">checkstyle</a>. |
| You can also just check the style without building the project. |
| This checks the code style of all source code under the current directory or from within an individual module.</p> |
| <div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$ </span>mvn<span class="w"> </span>checkstyle:check |
| </pre></div> |
| </div> |
| <p>Maven <code class="docutils literal notranslate"><span class="pre">pom.xml</span></code> style is enforced with Spotless using <a class="reference external" href="https://maven.apache.org/developers/conventions/code.html#pom-code-convention">Apache Maven pom.xml guidelines</a> |
| You can also just check the style without building the project. |
| This checks the style of all pom.xml files under the current directory or from within an individual module.</p> |
| <div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$ </span>mvn<span class="w"> </span>spotless:check |
| </pre></div> |
| </div> |
| <p>This applies the style to all pom.xml files under the current directory or from within an individual module.</p> |
| <div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$ </span>mvn<span class="w"> </span>spotless:apply |
| </pre></div> |
| </div> |
| </section> |
| </section> |
| <section id="build-caching"> |
| <h2><a class="toc-backref" href="#id11" role="doc-backlink">Build Caching</a><a class="headerlink" href="#build-caching" title="Link to this heading">¶</a></h2> |
| <p>Build caching is done through Develocity (formerly Maven Enterprise). To force |
| a build without the cache, run:</p> |
| <div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">mvn clean install -Ddevelocity.cache.local.enabled=false -Ddevelocity.cache.remote.enabled=false</span> |
| </pre></div> |
| </div> |
| <p>This can be useful to make sure you see all warnings from ErrorProne, for example.</p> |
| </section> |
| <section id="errorprone"> |
| <h2><a class="toc-backref" href="#id12" role="doc-backlink">ErrorProne</a><a class="headerlink" href="#errorprone" title="Link to this heading">¶</a></h2> |
| <p>ErrorProne should be disabled for generated code.</p> |
| </section> |
| </section> |
| |
| </article> |
| </div> |
| <footer> |
| |
| <div class="related-pages"> |
| <a class="next-page" href="../memory.html"> |
| <div class="page-info"> |
| <div class="context"> |
| <span>Next</span> |
| </div> |
| <div class="title">Memory Management</div> |
| </div> |
| <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg> |
| </a> |
| <a class="prev-page" href="building.html"> |
| <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg> |
| <div class="page-info"> |
| <div class="context"> |
| <span>Previous</span> |
| </div> |
| |
| <div class="title">Building Arrow Java</div> |
| |
| </div> |
| </a> |
| </div> |
| <div class="bottom-of-page"> |
| <div class="left-details"> |
| <div class="copyright"> |
| Copyright © 2025, Apache Arrow Developers |
| </div> |
| Made with <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s |
| |
| <a href="https://github.com/pradyunsg/furo">Furo</a> |
| |
| </div> |
| <div class="right-details"> |
| |
| </div> |
| </div> |
| |
| </footer> |
| </div> |
| <aside class="toc-drawer"> |
| |
| |
| <div class="toc-sticky toc-scroll"> |
| <div class="toc-title-container"> |
| <span class="toc-title"> |
| On this page |
| </span> |
| </div> |
| <div class="toc-tree-container"> |
| <div class="toc-tree"> |
| <ul> |
| <li><a class="reference internal" href="#">Development Guidelines</a><ul> |
| <li><a class="reference internal" href="#logger-abstraction">Logger Abstraction</a></li> |
| <li><a class="reference internal" href="#unit-testing">Unit Testing</a></li> |
| <li><a class="reference internal" href="#performance-testing">Performance Testing</a></li> |
| <li><a class="reference internal" href="#integration-testing">Integration Testing</a></li> |
| <li><a class="reference internal" href="#code-style">Code Style</a><ul> |
| <li><a class="reference internal" href="#automatically-fixing-code-style-issues">Automatically fixing code style issues</a></li> |
| <li><a class="reference internal" href="#code-formatter-for-intellij-idea-and-eclipse">Code Formatter for Intellij IDEA and Eclipse</a></li> |
| <li><a class="reference internal" href="#checkstyle">Checkstyle</a></li> |
| </ul> |
| </li> |
| <li><a class="reference internal" href="#build-caching">Build Caching</a></li> |
| <li><a class="reference internal" href="#errorprone">ErrorProne</a></li> |
| </ul> |
| </li> |
| </ul> |
| |
| </div> |
| </div> |
| </div> |
| |
| |
| </aside> |
| </div> |
| </div><script src="../_static/documentation_options.js?v=c4c92189"></script> |
| <script src="../_static/doctools.js?v=9bcbadda"></script> |
| <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> |
| <script src="../_static/scripts/furo.js?v=5fa4622c"></script> |
| </body> |
| </html> |
