docs/dev/developers/java/development.html - arrow-site - Git at Google


 <!DOCTYPE html>


 <html lang="en" data-content_root="../../" >

   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />

     <title>Development Guidelines &#8212; Apache Arrow v23.0.0.dev39</title>


   <script data-cfasync="false">
     document.documentElement.dataset.mode = localStorage.getItem("mode") || "";
     document.documentElement.dataset.theme = localStorage.getItem("theme") || "";
   </script>
   <!--
     this give us a css class that will be invisible only if js is disabled
   -->
   <noscript>
     <style>
       .pst-js-only { display: none !important; }

     </style>
   </noscript>

   <!-- Loaded before other Sphinx assets -->
   <link href="../../_static/styles/theme.css?digest=8878045cc6db502f8baf" rel="stylesheet" />
 <link href="../../_static/styles/pydata-sphinx-theme.css?digest=8878045cc6db502f8baf" rel="stylesheet" />

     <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=03e43079" />
     <link rel="stylesheet" type="text/css" href="../../_static/copybutton.css?v=76b2166b" />
     <link rel="stylesheet" type="text/css" href="../../_static/sphinx-design.min.css?v=95c83b7e" />
     <link rel="stylesheet" type="text/css" href="../../_static/theme_overrides.css?v=8dcd28dc" />

   <!-- So that users can add custom icons -->
   <script src="../../_static/scripts/fontawesome.js?digest=8878045cc6db502f8baf"></script>
   <!-- Pre-loaded scripts that we'll load fully later -->
   <link rel="preload" as="script" href="../../_static/scripts/bootstrap.js?digest=8878045cc6db502f8baf" />
 <link rel="preload" as="script" href="../../_static/scripts/pydata-sphinx-theme.js?digest=8878045cc6db502f8baf" />

     <script src="../../_static/documentation_options.js?v=d3a452a1"></script>
     <script src="../../_static/doctools.js?v=9bcbadda"></script>
     <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../_static/clipboard.min.js?v=a7894cd8"></script>
     <script src="../../_static/copybutton.js?v=3bb21c8c"></script>
     <script src="../../_static/design-tabs.js?v=f930bc37"></script>
     <script>DOCUMENTATION_OPTIONS.pagename = 'developers/java/development';</script>
     <script>
         DOCUMENTATION_OPTIONS.theme_version = '0.16.1';
         DOCUMENTATION_OPTIONS.theme_switcher_json_url = '/docs/_static/versions.json';
         DOCUMENTATION_OPTIONS.theme_switcher_version_match = 'dev/';
         DOCUMENTATION_OPTIONS.show_version_warning_banner =
             true;
         </script>
     <link rel="canonical" href="https://arrow.apache.org/docs/developers/java/development.html" />
     <link rel="icon" href="../../_static/favicon.ico"/>
     <link rel="index" title="Index" href="../../genindex.html" />
     <link rel="search" title="Search" href="../../search.html" />
     <link rel="next" title="Python Development" href="../python/index.html" />
     <link rel="prev" title="Building Arrow Java" href="building.html" />

   <meta name="viewport" content="width=device-width, initial-scale=1"/>
   <meta name="docsearch:language" content="en"/>
   <meta name="docsearch:version" content="23.0.0.dev39" />

   <!-- Matomo -->
   <script>
     var _paq = window._paq = window._paq || [];
     /* tracker methods like "setCustomDimension" should be called before "trackPageView" */
     /* We explicitly disable cookie tracking to avoid privacy issues */
     _paq.push(['disableCookies']);
     _paq.push(['trackPageView']);
     _paq.push(['enableLinkTracking']);
     (function() {
       var u="https://analytics.apache.org/";
       _paq.push(['setTrackerUrl', u+'matomo.php']);
       _paq.push(['setSiteId', '20']);
       var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0];
       g.async=true; g.src=u+'matomo.js'; s.parentNode.insertBefore(g,s);
     })();
   </script>
   <!-- End Matomo Code -->

   </head>


   <body data-bs-spy="scroll" data-bs-target=".bd-toc-nav" data-offset="180" data-bs-root-margin="0px 0px -60%" data-default-mode="">


   <div id="pst-skip-link" class="skip-link d-print-none"><a href="#main-content">Skip to main content</a></div>

   <div id="pst-scroll-pixel-helper"></div>

   <button type="button" class="btn rounded-pill" id="pst-back-to-top">
     <i class="fa-solid fa-arrow-up"></i>Back to top</button>


   <dialog id="pst-search-dialog">

 <form class="bd-search d-flex align-items-center"
       action="../../search.html"
       method="get">
   <i class="fa-solid fa-magnifying-glass"></i>
   <input type="search"
          class="form-control"
          name="q"
          placeholder="Search the docs ..."
          aria-label="Search the docs ..."
          autocomplete="off"
          autocorrect="off"
          autocapitalize="off"
          spellcheck="false"/>
   <span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd>K</kbd></span>
 </form>
   </dialog>

   <div class="pst-async-banner-revealer d-none">
   <aside id="bd-header-version-warning" class="d-none d-print-none" aria-label="Version warning"></aside>
 </div>


     <header class="bd-header navbar navbar-expand-lg bd-navbar d-print-none">
 <div class="bd-header__inner bd-page-width">
   <button class="pst-navbar-icon sidebar-toggle primary-toggle" aria-label="Site navigation">
     <span class="fa-solid fa-bars"></span>
   </button>


   <div class=" navbar-header-items__start">

       <div class="navbar-item">


 <a class="navbar-brand logo" href="../../index.html">


     <img src="../../_static/arrow.png" class="logo__image only-light" alt="Apache Arrow v23.0.0.dev39 - Home"/>
     <img src="../../_static/arrow-dark.png" class="logo__image only-dark pst-js-only" alt="Apache Arrow v23.0.0.dev39 - Home"/>


 </a></div>

   </div>

   <div class=" navbar-header-items">

     <div class="me-auto navbar-header-items__center">

         <div class="navbar-item">
 <nav>
   <ul class="bd-navbar-elements navbar-nav">

 <li class="nav-item ">
   <a class="nav-link nav-internal" href="../../format/index.html">
     Specifications
   </a>
 </li>


 <li class="nav-item current active">
   <a class="nav-link nav-internal" href="../index.html">
     Development
   </a>
 </li>


 <li class="nav-item ">
   <a class="nav-link nav-internal" href="../../implementations.html">
     Implementations
   </a>
 </li>

   </ul>
 </nav></div>

     </div>


     <div class="navbar-header-items__end">

         <div class="navbar-item navbar-persistent--container">


 <button class="btn search-button-field search-button__button pst-js-only" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
  <i class="fa-solid fa-magnifying-glass"></i>
  <span class="search-button__default-text">Search</span>
  <span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd class="kbd-shortcut__modifier">K</kbd></span>
 </button>
         </div>


         <div class="navbar-item"><div class="kapa-ai-bot">
     <script
         async
         src="https://widget.kapa.ai/kapa-widget.bundle.js"
         data-website-id="9db461d5-ac77-4b3f-a5c5-75efa78339d2"
         data-project-name="Apache Arrow"
         data-project-color="#000000"
         data-project-logo="https://arrow.apache.org/img/arrow-logo_chevrons_white-txt_black-bg.png"
         data-modal-disclaimer="This is a custom LLM with access to all [Arrow documentation](https://arrow.apache.org/docs/). Please include the language you are using in your question, e.g., Python, C++, Java, R, etc."
         data-consent-required="true"
         data-user-analytics-cookie-enabled="false"
         data-consent-screen-disclaimer="By clicking &quot;I agree, let's chat&quot;, you consent to the use of the AI assistant in accordance with kapa.ai's [Privacy Policy](https://www.kapa.ai/content/privacy-policy). This service uses reCAPTCHA, which requires your consent to Google's [Privacy Policy](https://policies.google.com/privacy) and [Terms of Service](https://policies.google.com/terms). By proceeding, you explicitly agree to both kapa.ai's and Google's privacy policies."
     ></script>

 </div>

 </div>

         <div class="navbar-item">
 <div class="version-switcher__container dropdown pst-js-only">
   <button id="pst-version-switcher-button-2"
     type="button"
     class="version-switcher__button btn btn-sm dropdown-toggle"
     data-bs-toggle="dropdown"
     aria-haspopup="listbox"
     aria-controls="pst-version-switcher-list-2"
     aria-label="Version switcher list"
   >
     Choose version  <!-- this text may get changed later by javascript -->
     <span class="caret"></span>
   </button>
   <div id="pst-version-switcher-list-2"
     class="version-switcher__menu dropdown-menu list-group-flush py-0"
     role="listbox" aria-labelledby="pst-version-switcher-button-2">
     <!-- dropdown will be populated by javascript on page load -->
   </div>
 </div></div>

         <div class="navbar-item">

 <button class="btn btn-sm nav-link pst-navbar-icon theme-switch-button pst-js-only" aria-label="Color mode" data-bs-title="Color mode"  data-bs-placement="bottom" data-bs-toggle="tooltip">
   <i class="theme-switch fa-solid fa-sun                fa-lg" data-mode="light" title="Light"></i>
   <i class="theme-switch fa-solid fa-moon               fa-lg" data-mode="dark"  title="Dark"></i>
   <i class="theme-switch fa-solid fa-circle-half-stroke fa-lg" data-mode="auto"  title="System Settings"></i>
 </button></div>

         <div class="navbar-item"><ul class="navbar-icon-links"
     aria-label="Icon Links">
         <li class="nav-item">


           <a href="https://github.com/apache/arrow" title="GitHub" class="nav-link pst-navbar-icon" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><i class="fa-brands fa-square-github fa-lg" aria-hidden="true"></i>
             <span class="sr-only">GitHub</span></a>
         </li>
         <li class="nav-item">


           <a href="https://www.linkedin.com/company/apache-arrow/" title="LinkedIn" class="nav-link pst-navbar-icon" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><i class="fa-brands fa-linkedin fa-lg" aria-hidden="true"></i>
             <span class="sr-only">LinkedIn</span></a>
         </li>
         <li class="nav-item">


           <a href="https://bsky.app/profile/arrow.apache.org" title="BlueSky" class="nav-link pst-navbar-icon" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><i class="fa-brands fa-bluesky fa-lg" aria-hidden="true"></i>
             <span class="sr-only">BlueSky</span></a>
         </li>
 </ul></div>

     </div>

   </div>


     <div class="navbar-persistent--mobile">

 <button class="btn search-button-field search-button__button pst-js-only" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
  <i class="fa-solid fa-magnifying-glass"></i>
  <span class="search-button__default-text">Search</span>
  <span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd class="kbd-shortcut__modifier">K</kbd></span>
 </button>
     </div>


     <button class="pst-navbar-icon sidebar-toggle secondary-toggle" aria-label="On this page">
       <span class="fa-solid fa-outdent"></span>
     </button>

 </div>

     </header>


   <div class="bd-container">
     <div class="bd-container__inner bd-page-width">


       <dialog id="pst-primary-sidebar-modal"></dialog>
       <div id="pst-primary-sidebar" class="bd-sidebar-primary bd-sidebar">


   <div class="sidebar-header-items sidebar-primary__section">


       <div class="sidebar-header-items__center">


             <div class="navbar-item">
 <nav>
   <ul class="bd-navbar-elements navbar-nav">

 <li class="nav-item ">
   <a class="nav-link nav-internal" href="../../format/index.html">
     Specifications
   </a>
 </li>


 <li class="nav-item current active">
   <a class="nav-link nav-internal" href="../index.html">
     Development
   </a>
 </li>


 <li class="nav-item ">
   <a class="nav-link nav-internal" href="../../implementations.html">
     Implementations
   </a>
 </li>

   </ul>
 </nav></div>


       </div>


       <div class="sidebar-header-items__end">

           <div class="navbar-item"><div class="kapa-ai-bot">
     <script
         async
         src="https://widget.kapa.ai/kapa-widget.bundle.js"
         data-website-id="9db461d5-ac77-4b3f-a5c5-75efa78339d2"
         data-project-name="Apache Arrow"
         data-project-color="#000000"
         data-project-logo="https://arrow.apache.org/img/arrow-logo_chevrons_white-txt_black-bg.png"
         data-modal-disclaimer="This is a custom LLM with access to all [Arrow documentation](https://arrow.apache.org/docs/). Please include the language you are using in your question, e.g., Python, C++, Java, R, etc."
         data-consent-required="true"
         data-user-analytics-cookie-enabled="false"
         data-consent-screen-disclaimer="By clicking &quot;I agree, let's chat&quot;, you consent to the use of the AI assistant in accordance with kapa.ai's [Privacy Policy](https://www.kapa.ai/content/privacy-policy). This service uses reCAPTCHA, which requires your consent to Google's [Privacy Policy](https://policies.google.com/privacy) and [Terms of Service](https://policies.google.com/terms). By proceeding, you explicitly agree to both kapa.ai's and Google's privacy policies."
     ></script>

 </div>

 </div>

           <div class="navbar-item">
 <div class="version-switcher__container dropdown pst-js-only">
   <button id="pst-version-switcher-button-3"
     type="button"
     class="version-switcher__button btn btn-sm dropdown-toggle"
     data-bs-toggle="dropdown"
     aria-haspopup="listbox"
     aria-controls="pst-version-switcher-list-3"
     aria-label="Version switcher list"
   >
     Choose version  <!-- this text may get changed later by javascript -->
     <span class="caret"></span>
   </button>
   <div id="pst-version-switcher-list-3"
     class="version-switcher__menu dropdown-menu list-group-flush py-0"
     role="listbox" aria-labelledby="pst-version-switcher-button-3">
     <!-- dropdown will be populated by javascript on page load -->
   </div>
 </div></div>

           <div class="navbar-item">

 <button class="btn btn-sm nav-link pst-navbar-icon theme-switch-button pst-js-only" aria-label="Color mode" data-bs-title="Color mode"  data-bs-placement="bottom" data-bs-toggle="tooltip">
   <i class="theme-switch fa-solid fa-sun                fa-lg" data-mode="light" title="Light"></i>
   <i class="theme-switch fa-solid fa-moon               fa-lg" data-mode="dark"  title="Dark"></i>
   <i class="theme-switch fa-solid fa-circle-half-stroke fa-lg" data-mode="auto"  title="System Settings"></i>
 </button></div>

           <div class="navbar-item"><ul class="navbar-icon-links"
     aria-label="Icon Links">
         <li class="nav-item">


           <a href="https://github.com/apache/arrow" title="GitHub" class="nav-link pst-navbar-icon" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><i class="fa-brands fa-square-github fa-lg" aria-hidden="true"></i>
             <span class="sr-only">GitHub</span></a>
         </li>
         <li class="nav-item">


           <a href="https://www.linkedin.com/company/apache-arrow/" title="LinkedIn" class="nav-link pst-navbar-icon" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><i class="fa-brands fa-linkedin fa-lg" aria-hidden="true"></i>
             <span class="sr-only">LinkedIn</span></a>
         </li>
         <li class="nav-item">


           <a href="https://bsky.app/profile/arrow.apache.org" title="BlueSky" class="nav-link pst-navbar-icon" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><i class="fa-brands fa-bluesky fa-lg" aria-hidden="true"></i>
             <span class="sr-only">BlueSky</span></a>
         </li>
 </ul></div>

       </div>

   </div>

     <div class="sidebar-primary-items__start sidebar-primary__section">
         <div class="sidebar-primary-item">
 <nav class="bd-docs-nav bd-links"
      aria-label="Section Navigation">
   <p class="bd-links__title" role="heading" aria-level="1">Section Navigation</p>
   <div class="bd-toc-item navbar-nav"><ul class="current nav bd-sidenav">
 <li class="toctree-l1"><a class="reference internal" href="../bug_reports.html">Bug reports and feature requests</a></li>
 <li class="toctree-l1 has-children"><a class="reference internal" href="../guide/index.html">New Contributor’s Guide</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
 <li class="toctree-l2"><a class="reference internal" href="../guide/architectural_overview.html">Architectural Overview</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../guide/communication.html">Communication</a></li>
 <li class="toctree-l2 has-children"><a class="reference internal" href="../guide/step_by_step/index.html">Steps in making your first PR</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
 <li class="toctree-l3"><a class="reference internal" href="../guide/step_by_step/set_up.html">Set up</a></li>
 <li class="toctree-l3"><a class="reference internal" href="../guide/step_by_step/building.html">Building the Arrow libraries 🏋🏿‍♀️</a></li>
 <li class="toctree-l3"><a class="reference internal" href="../guide/step_by_step/finding_issues.html">Finding good first issues 🔎</a></li>
 <li class="toctree-l3"><a class="reference internal" href="../guide/step_by_step/arrow_codebase.html">Working on the Arrow codebase 🧐</a></li>
 <li class="toctree-l3"><a class="reference internal" href="../guide/step_by_step/testing.html">Testing 🧪</a></li>
 <li class="toctree-l3"><a class="reference internal" href="../guide/step_by_step/styling.html">Styling 😎</a></li>
 <li class="toctree-l3"><a class="reference internal" href="../guide/step_by_step/pr_lifecycle.html">Lifecycle of a pull request</a></li>
 </ul>
 </details></li>
 <li class="toctree-l2"><a class="reference internal" href="../guide/documentation.html">Helping with documentation</a></li>
 <li class="toctree-l2 has-children"><a class="reference internal" href="../guide/tutorials/index.html">Tutorials</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
 <li class="toctree-l3"><a class="reference internal" href="../guide/tutorials/python_tutorial.html">Python tutorial</a></li>
 <li class="toctree-l3"><a class="reference internal" href="../guide/tutorials/r_tutorial.html">R tutorials</a></li>
 </ul>
 </details></li>
 <li class="toctree-l2"><a class="reference internal" href="../guide/resources.html">Additional information and resources</a></li>
 </ul>
 </details></li>
 <li class="toctree-l1"><a class="reference internal" href="../overview.html">Contributing Overview</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../reviewing.html">Reviewing contributions</a></li>
 <li class="toctree-l1 has-children"><a class="reference internal" href="../cpp/index.html">C++ Development</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
 <li class="toctree-l2"><a class="reference internal" href="../cpp/building.html">Building Arrow C++</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../cpp/development.html">Development Guidelines</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../cpp/windows.html">Developing on Windows</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../cpp/emscripten.html">Cross compiling for WebAssembly with Emscripten</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../cpp/conventions.html">Conventions</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../cpp/fuzzing.html">Fuzzing Arrow C++</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../cpp/compute.html">Developing Arrow C++ Compute</a></li>
 <li class="toctree-l2 has-children"><a class="reference internal" href="../cpp/acero.html">Developing Acero</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
 <li class="toctree-l3"><a class="reference internal" href="../cpp/acero/swiss_table.html">Swiss Table</a></li>
 </ul>
 </details></li>
 </ul>
 </details></li>
 <li class="toctree-l1 current active has-children"><a class="reference internal" href="index.html">Java Development</a><details open="open"><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul class="current">
 <li class="toctree-l2"><a class="reference internal" href="building.html">Building Arrow Java</a></li>
 <li class="toctree-l2 current active"><a class="current reference internal" href="#">Development Guidelines</a></li>
 </ul>
 </details></li>
 <li class="toctree-l1 has-children"><a class="reference internal" href="../python/index.html">Python Development</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
 <li class="toctree-l2"><a class="reference internal" href="../python/building.html">Building PyArrow</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../python/development.html">Developing PyArrow</a></li>
 </ul>
 </details></li>
 <li class="toctree-l1 has-children"><a class="reference internal" href="../continuous_integration/index.html">Continuous Integration</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
 <li class="toctree-l2"><a class="reference internal" href="../continuous_integration/overview.html">Continuous Integration</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../continuous_integration/docker.html">Running Docker Builds</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../continuous_integration/archery.html">Daily Development using Archery</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../continuous_integration/crossbow.html">Packaging and Testing with Crossbow</a></li>
 </ul>
 </details></li>
 <li class="toctree-l1"><a class="reference internal" href="../benchmarks.html">Benchmarks</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../documentation.html">Building the Documentation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../release.html">Release Management Guide</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../release_verification.html">Release Verification Process</a></li>
 </ul>
 </div>
 </nav></div>
     </div>


   <div class="sidebar-primary-items__end sidebar-primary__section">
       <div class="sidebar-primary-item">
 <div id="ethical-ad-placement"
       class="flat"
       data-ea-publisher="readthedocs"
       data-ea-type="readthedocs-sidebar"
       data-ea-manual="true">
 </div></div>
   </div>


       </div>

       <main id="main-content" class="bd-main" role="main">


           <div class="bd-content">
             <div class="bd-article-container">

               <div class="bd-header-article d-print-none">
 <div class="header-article-items header-article__inner">

     <div class="header-article-items__start">

         <div class="header-article-item">

 <nav aria-label="Breadcrumb" class="d-print-none">
   <ul class="bd-breadcrumbs">

     <li class="breadcrumb-item breadcrumb-home">
       <a href="../../index.html" class="nav-link" aria-label="Home">
         <i class="fa-solid fa-home"></i>
       </a>
     </li>

     <li class="breadcrumb-item"><a href="../index.html" class="nav-link">Development</a></li>


     <li class="breadcrumb-item"><a href="index.html" class="nav-link">Java Development</a></li>

     <li class="breadcrumb-item active" aria-current="page"><span class="ellipsis">Development Guidelines</span></li>
   </ul>
 </nav>
 </div>

     </div>


 </div>
 </div>


 <div id="searchbox"></div>
                 <article class="bd-article">

   <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=&lt;absolute path to your java home&gt;</span>
 <span class="go">    --src=&lt;absolute path to your arrow project&gt;</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 internal" href="../../format/Integration.html#running-integration-tests"><span class="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">&#39;mvn spotless:apply&#39;</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>


                 <footer class="prev-next-footer d-print-none">

 <div class="prev-next-area">
     <a class="left-prev"
        href="building.html"
        title="previous page">
       <i class="fa-solid fa-angle-left"></i>
       <div class="prev-next-info">
         <p class="prev-next-subtitle">previous</p>
         <p class="prev-next-title">Building Arrow Java</p>
       </div>
     </a>
     <a class="right-next"
        href="../python/index.html"
        title="next page">
       <div class="prev-next-info">
         <p class="prev-next-subtitle">next</p>
         <p class="prev-next-title">Python Development</p>
       </div>
       <i class="fa-solid fa-angle-right"></i>
     </a>
 </div>
                 </footer>

             </div>


                 <dialog id="pst-secondary-sidebar-modal"></dialog>
                 <div id="pst-secondary-sidebar" class="bd-sidebar-secondary bd-toc"><div class="sidebar-secondary-items sidebar-secondary__inner">


   <div class="sidebar-secondary-item">
 <div
     id="pst-page-navigation-heading-2"
     class="page-toc tocsection onthispage">
     <i class="fa-solid fa-list"></i> On this page
   </div>
   <nav class="bd-toc-nav page-toc" aria-labelledby="pst-page-navigation-heading-2">
     <ul class="visible nav section-nav flex-column">
 <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#logger-abstraction">Logger Abstraction</a></li>
 <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#unit-testing">Unit Testing</a></li>
 <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#performance-testing">Performance Testing</a></li>
 <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#integration-testing">Integration Testing</a></li>
 <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#code-style">Code Style</a><ul class="visible nav section-nav flex-column">
 <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#automatically-fixing-code-style-issues">Automatically fixing code style issues</a></li>
 <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#code-formatter-for-intellij-idea-and-eclipse">Code Formatter for Intellij IDEA and Eclipse</a></li>
 <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#checkstyle">Checkstyle</a></li>
 </ul>
 </li>
 <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#build-caching">Build Caching</a></li>
 <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#errorprone">ErrorProne</a></li>
 </ul>
   </nav></div>

   <div class="sidebar-secondary-item">


   <div class="tocsection editthispage">
     <a href="https://github.com/apache/arrow/edit/main/docs/source/developers/java/development.rst">
       <i class="fa-solid fa-pencil"></i>


           Edit on GitHub


     </a>
   </div>
 </div>

 </div></div>


           </div>
           <footer class="bd-footer-content">

           </footer>

       </main>
     </div>
   </div>

   <!-- Scripts loaded after <body> so the DOM is not blocked -->
   <script defer src="../../_static/scripts/bootstrap.js?digest=8878045cc6db502f8baf"></script>
 <script defer src="../../_static/scripts/pydata-sphinx-theme.js?digest=8878045cc6db502f8baf"></script>

   <footer class="bd-footer">
 <div class="bd-footer__inner bd-page-width">

     <div class="footer-items__start">

         <div class="footer-item">

   <p class="copyright">

       © Copyright 2016-2025 Apache Software Foundation.
 Apache Arrow, Arrow, Apache, the Apache logo, and the Apache Arrow project logo are either registered trademarks or trademarks of The Apache Software Foundation in the United States and other countries.
       <br/>

   </p>
 </div>

         <div class="footer-item">

   <p class="sphinx-version">
     Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.2.3.
     <br/>
   </p>
 </div>

     </div>


     <div class="footer-items__end">

         <div class="footer-item">
 <p class="theme-version">
   <!-- # L10n: Setting the PST URL as an argument as this does not need to be localized -->
   Built with the <a href="https://pydata-sphinx-theme.readthedocs.io/en/stable/index.html">PyData Sphinx Theme</a> 0.16.1.
 </p></div>

     </div>

 </div>

   </footer>
   </body>
 </html>